Merge pull request #57 from binarapps/forcing-update

Forcing user to update app

Author: MateuszRostkowski

scripts/data/swagger-spec.json

@@ -6,17 +6,38 @@
  * API documentation for the starter-kit project in NestJS by BinarApps. The API allows management of users, sessions and offers various functions for logged in users. Contains examples of authentication, authorization, and CRUD for selected resources.
  * OpenAPI spec version: 1.0
  */
+import { faker } from '@faker-js/faker'
 import { HttpResponse, delay, http } from 'msw'
 
-export const getSystemControllerCheckForAppUpdateMockHandler = () => {
+import type { AppVersionStatusEntity } from '../../types'
+
+export const getSystemControllerCheckForAppUpdateResponseMock = (
+  overrideResponse: any = {}
+): AppVersionStatusEntity => ({
+  appId: faker.word.sample(),
+  currentVersionReleaseDate: `${faker.date.past().toISOString().split('.')[0]}Z`,
+  latestVersion: faker.word.sample(),
+  minimumVersion: faker.word.sample(),
+  updateRequired: faker.datatype.boolean(),
+  ...overrideResponse,
+})
+
+export const getSystemControllerCheckForAppUpdateMockHandler = (
+  overrideResponse?: AppVersionStatusEntity
+) => {
   return http.post('*/api/v1/system/app-updates/check', async () => {
     await delay(1000)
-    return new HttpResponse(null, {
-      status: 200,
-      headers: {
-        'Content-Type': 'application/json',
-      },
-    })
+    return new HttpResponse(
+      JSON.stringify(
+        overrideResponse ? overrideResponse : getSystemControllerCheckForAppUpdateResponseMock()
+      ),
+      {
+        status: 200,
+        headers: {
+          'Content-Type': 'application/json',
+        },
+      }
+    )
   })
 }
 export const getSystemMock = () => [getSystemControllerCheckForAppUpdateMockHandler()]

src/api/query/system/system.msw.ts

@@ -11,15 +11,21 @@ import type { MutationFunction, UseMutationOptions } from '@tanstack/react-query
 
 import { customInstance } from '../../axios/custom-instance'
 import type { ErrorType, BodyType } from '../../axios/custom-instance'
-import type { CheckUpdateDto } from '../../types'
+import type {
+  AppVersionStatusEntity,
+  CheckUpdateDto,
+  ErrorServerEntity,
+  ErrorTooManyRequestsEntity,
+  ErrorValidationEntity,
+} from '../../types'
 
 type SecondParameter<T extends (...args: any) => any> = Parameters<T>[1]
 
 export const systemControllerCheckForAppUpdate = (
   checkUpdateDto: BodyType<CheckUpdateDto>,
   options?: SecondParameter<typeof customInstance>
 ) => {
-  return customInstance<void>(
+  return customInstance<AppVersionStatusEntity>(
     {
       url: `/api/v1/system/app-updates/check`,
       method: 'POST',
@@ -31,7 +37,7 @@ export const systemControllerCheckForAppUpdate = (
 }
 
 export const getSystemControllerCheckForAppUpdateMutationOptions = <
-  TError = ErrorType<unknown>,
+  TError = ErrorType<void | ErrorValidationEntity | ErrorTooManyRequestsEntity | ErrorServerEntity>,
   TContext = unknown
 >(options?: {
   mutation?: UseMutationOptions<
@@ -65,10 +71,12 @@ export type SystemControllerCheckForAppUpdateMutationResult = NonNullable<
   Awaited<ReturnType<typeof systemControllerCheckForAppUpdate>>
 >
 export type SystemControllerCheckForAppUpdateMutationBody = BodyType<CheckUpdateDto>
-export type SystemControllerCheckForAppUpdateMutationError = ErrorType<unknown>
+export type SystemControllerCheckForAppUpdateMutationError = ErrorType<
+  void | ErrorValidationEntity | ErrorTooManyRequestsEntity | ErrorServerEntity
+>
 
 export const useSystemControllerCheckForAppUpdate = <
-  TError = ErrorType<unknown>,
+  TError = ErrorType<void | ErrorValidationEntity | ErrorTooManyRequestsEntity | ErrorServerEntity>,
   TContext = unknown
 >(options?: {
   mutation?: UseMutationOptions<

src/api/query/system/system.ts

@@ -0,0 +1,21 @@
+/* eslint-disable @typescript-eslint/no-explicit-any */
+/**
+ * Generated by orval 🍺
+ * Do not edit manually.
+ * API
+ * API documentation for the starter-kit project in NestJS by BinarApps. The API allows management of users, sessions and offers various functions for logged in users. Contains examples of authentication, authorization, and CRUD for selected resources.
+ * OpenAPI spec version: 1.0
+ */
+
+export interface AppVersionStatusEntity {
+  /** AppId of application in AppStore(AppStore Bundle ID) or PlayStore(Google Play Store app ID) */
+  appId: string
+  /** The current version of the app. */
+  currentVersionReleaseDate: string
+  /** The latest version of the app available in the app store. */
+  latestVersion: string
+  /** The minimum version of the app that still functions correctly without mandatory updates. */
+  minimumVersion: string
+  /** Indicates whether an update is required to continue using the app. */
+  updateRequired: boolean
+}

src/api/types/appVersionStatusEntity.ts

@@ -7,6 +7,7 @@
  * OpenAPI spec version: 1.0
  */
 
+export * from './appVersionStatusEntity'
 export * from './articleEntity'
 export * from './articlesControllerFindAllParams'
 export * from './articlesControllerFindDraftsParams'

src/api/types/index.ts

@@ -1,5 +1,6 @@
 import { Loader, Center } from '@baca/design-system/components'
 import { useCachedResources, useNavigationTheme } from '@baca/hooks'
+import { useCheckForAppUpdate } from '@baca/hooks/useCheckForAppUpdate'
 import { isSignedInAtom } from '@baca/store/auth'
 import * as SplashScreen from 'expo-splash-screen'
 import { useAtomValue } from 'jotai'
@@ -11,19 +12,18 @@ SplashScreen.preventAutoHideAsync()
 
 export const AppLoading: FC<PropsWithChildren> = ({ children }) => {
   const { navigationTheme } = useNavigationTheme()
-
   const isLoadingComplete = useCachedResources()
-
   const isSignedIn = useAtomValue(isSignedInAtom)
-  const [isLayoutReady, setIsLayoutReady] = useState<boolean>(false)
 
+  const [isLayoutReady, setIsLayoutReady] = useState<boolean>(false)
   const [isSplashHidden, setIsSplashHidden] = useState<boolean>(false)
+  const isUpdateLoading = useCheckForAppUpdate()
 
   const onLayout = useCallback(() => {
     setIsLayoutReady(true)
   }, [])
 
-  const isLoading = !isLoadingComplete || isSignedIn === null || !isLayoutReady
+  const isLoading = !isLoadingComplete || isSignedIn === null || !isLayoutReady || isUpdateLoading
 
   useEffect(() => {
     const hideSplashScreen = () => {

src/components/AppLoading.tsx

@@ -0,0 +1,2 @@
+export const APP_STORE_URL = `https://apps.apple.com/app/id`
+export const PLAY_STORE_URL = `https://play.google.com/store/apps/details?id=`

src/constants/links.ts

@@ -0,0 +1,51 @@
+import { useSystemControllerCheckForAppUpdate } from '@baca/api/query/system/system'
+import { APP_STORE_URL, PLAY_STORE_URL } from '@baca/constants/links'
+import { useTranslation } from '@baca/hooks'
+import * as Application from 'expo-application'
+import { useEffect, useState } from 'react'
+import { Platform, Alert, Linking } from 'react-native'
+
+const currentVersion = Application.nativeApplicationVersion || 'unknown'
+const { OS } = Platform
+
+export const useCheckForAppUpdate = () => {
+  const { t } = useTranslation()
+  const [isUpdateLoading, setIsUpdateLoading] = useState<boolean>(true)
+
+  const { mutate: checkForUpdate } = useSystemControllerCheckForAppUpdate()
+
+  useEffect(() => {
+    if (OS === 'ios' || OS === 'android') {
+      checkForUpdate(
+        {
+          data: {
+            currentVersion,
+            os: OS,
+          },
+        },
+        {
+          onSuccess: ({ updateRequired, appId }) => {
+            if (updateRequired) {
+              const storeUrl =
+                OS === 'ios' ? `${APP_STORE_URL}${appId}` : `${PLAY_STORE_URL}${appId}`
+              Alert.alert(t('update.alert_title'), t('update.alert_message'), [
+                { text: t('update.update_now'), onPress: () => Linking.openURL(storeUrl) },
+              ])
+            }
+          },
+          onError: (error) => {
+            console.error('Error checking for updates:', error)
+            // CONFIG: Add log to your analytics service, for example - sentry o crashlytics
+          },
+          onSettled: () => {
+            setIsUpdateLoading(false)
+          },
+        }
+      )
+    } else {
+      setIsUpdateLoading(false)
+    }
+  }, [checkForUpdate, t])
+
+  return isUpdateLoading
+}

src/hooks/useCheckForAppUpdate.ts

@@ -116,9 +116,9 @@
   "update": {
     "alert_message": "You will have to restart the application to have better experiences while using it",
     "alert_title": "New version available",
-    "restart": "Restart"
+    "restart": "Restart",
+    "update_now": "Update now"
   },
-
   "application_info_screen": {
     "navigation_info": "When you will try to go back it will double ask if you really want to leave \n"
   },
@@ -143,7 +143,6 @@
       "tertiary_gray": "Button tertiary gray",
       "with_icons": "Button with icons"
     },
-
     "loader_variants": {
       "bricks": "Bricks loader",
       "bubbles": "Bubbles loader",

src/i18n/translations/en.json

@@ -114,11 +114,11 @@
     "warning": {}
   },
   "update": {
-    "alert_message": "Będziesz musiał zrestartować aplikację, żeby mieć lepsze doświadczenia podczas jej używania",
+    "alert_message": "Musisz zrestartować aplikację, żeby mieć lepsze doświadczenia podczas jej używania",
     "alert_title": "Aktualizacja",
-    "restart": "Zrestartuj"
+    "restart": "Zrestartuj",
+    "update_now": "Aktualizuj teraz"
   },
-
   "application_info_screen": {
     "navigation_info": "Kiedy będziesz próbował cofnąć to zostaniesz podwójnie zapytany, czy na pewno tego chcesz \n"
   },