Merge pull request #28600 from software-mansion-labs/ts-migration/env…

…ironment-lib

[No QA] [TS migration] Migrate 'Environment' lib to TypeScript

src/libs/ApiUtils.ts

@@ -1,4 +1,5 @@
 import Onyx from 'react-native-onyx';
+import {ValueOf} from 'type-fest';
 import CONFIG from '@src/CONFIG';
 import CONST from '@src/CONST';
 import ONYXKEYS from '@src/ONYXKEYS';
@@ -8,7 +9,7 @@ import * as Environment from './Environment/Environment';
 
 // To avoid rebuilding native apps, native apps use production config for both staging and prod
 // We use the async environment check because it works on all platforms
-let ENV_NAME = CONST.ENVIRONMENT.PRODUCTION;
+let ENV_NAME: ValueOf<typeof CONST.ENVIRONMENT> = CONST.ENVIRONMENT.PRODUCTION;
 let shouldUseStagingServer = false;
 Environment.getEnvironment().then((envName) => {
     ENV_NAME = envName;

src/libs/Environment/Environment.js → src/libs/Environment/Environment.ts

@@ -1,4 +1,3 @@
-import lodashGet from 'lodash/get';
 import Config from 'react-native-config';
 import CONFIG from '@src/CONFIG';
 import CONST from '@src/CONST';
@@ -20,39 +19,31 @@ const OLDDOT_ENVIRONMENT_URLS = {
 
 /**
  * Are we running the app in development?
- *
- * @return {boolean}
  */
-function isDevelopment() {
-    return lodashGet(Config, 'ENVIRONMENT', CONST.ENVIRONMENT.DEV) === CONST.ENVIRONMENT.DEV;
+function isDevelopment(): boolean {
+    return (Config?.ENVIRONMENT ?? CONST.ENVIRONMENT.DEV) === CONST.ENVIRONMENT.DEV;
 }
 
 /**
  * Are we running an internal test build?
- *
- * @return {boolean}
  */
-function isInternalTestBuild() {
-    return lodashGet(Config, 'ENVIRONMENT', CONST.ENVIRONMENT.DEV) === CONST.ENVIRONMENT.ADHOC && lodashGet(Config, 'PULL_REQUEST_NUMBER', '');
+function isInternalTestBuild(): boolean {
+    return !!((Config?.ENVIRONMENT ?? CONST.ENVIRONMENT.DEV) === CONST.ENVIRONMENT.ADHOC && (Config?.PULL_REQUEST_NUMBER ?? ''));
 }
 
 /**
  * Get the URL based on the environment we are in
- *
- * @returns {Promise}
  */
-function getEnvironmentURL() {
+function getEnvironmentURL(): Promise<string> {
     return new Promise((resolve) => {
         getEnvironment().then((environment) => resolve(ENVIRONMENT_URLS[environment]));
     });
 }
 
 /**
  * Get the corresponding oldDot URL based on the environment we are in
- *
- * @returns {Promise<string>}
  */
-function getOldDotEnvironmentURL() {
+function getOldDotEnvironmentURL(): Promise<string> {
     return getEnvironment().then((environment) => OLDDOT_ENVIRONMENT_URLS[environment]);
 }
 

src/libs/Environment/betaChecker/index.android.js → src/libs/Environment/betaChecker/index.android.ts

@@ -4,19 +4,20 @@ import * as AppUpdate from '@userActions/AppUpdate';
 import CONST from '@src/CONST';
 import ONYXKEYS from '@src/ONYXKEYS';
 import pkg from '../../../../package.json';
+import IsBetaBuild from './types';
 
 let isLastSavedBeta = false;
 Onyx.connect({
     key: ONYXKEYS.IS_BETA,
-    callback: (value) => (isLastSavedBeta = value),
+    callback: (value) => {
+        isLastSavedBeta = Boolean(value);
+    },
 });
 
 /**
  * Check the GitHub releases to see if the current build is a beta build or production build
- *
- * @returns {Promise}
  */
-function isBetaBuild() {
+function isBetaBuild(): IsBetaBuild {
     return new Promise((resolve) => {
         fetch(CONST.GITHUB_RELEASE_URL)
             .then((res) => res.json())

src/libs/Environment/betaChecker/index.ios.js → src/libs/Environment/betaChecker/index.ios.ts

@@ -1,13 +1,12 @@
 import {NativeModules} from 'react-native';
+import IsBetaBuild from './types';
 
 /**
  * Check to see if the build is staging (TestFlight) or production
- *
- * @returns {Promise}
  */
-function isBetaBuild() {
+function isBetaBuild(): IsBetaBuild {
     return new Promise((resolve) => {
-        NativeModules.EnvironmentChecker.isBeta().then((isBeta) => {
+        NativeModules.EnvironmentChecker.isBeta().then((isBeta: boolean) => {
             resolve(isBeta);
         });
     });

src/libs/Environment/betaChecker/index.js → src/libs/Environment/betaChecker/index.ts

@@ -1,9 +1,9 @@
+import IsBetaBuild from './types';
+
 /**
  * There's no beta build in non native
- *
- * @returns {Promise}
  */
-function isBetaBuild() {
+function isBetaBuild(): IsBetaBuild {
     return Promise.resolve(false);
 }
 

src/libs/Environment/betaChecker/types.ts

@@ -0,0 +1,3 @@
+type IsBetaBuild = Promise<boolean>;
+
+export default IsBetaBuild;

src/libs/Environment/getEnvironment/index.native.js → src/libs/Environment/getEnvironment/index.native.ts

@@ -1,28 +1,26 @@
-import lodashGet from 'lodash/get';
 import Config from 'react-native-config';
 import betaChecker from '@libs/Environment/betaChecker';
 import CONST from '@src/CONST';
+import Environment from './types';
 
-let environment = null;
+let environment: Environment | null = null;
 
 /**
  * Returns a promise that resolves with the current environment string value
- *
- * @returns {Promise}
  */
-function getEnvironment() {
+function getEnvironment(): Promise<Environment> {
     return new Promise((resolve) => {
         // If we've already set the environment, use the current value
         if (environment) {
             return resolve(environment);
         }
 
-        if (lodashGet(Config, 'ENVIRONMENT', CONST.ENVIRONMENT.DEV) === CONST.ENVIRONMENT.DEV) {
+        if ((Config?.ENVIRONMENT ?? CONST.ENVIRONMENT.DEV) === CONST.ENVIRONMENT.DEV) {
             environment = CONST.ENVIRONMENT.DEV;
             return resolve(environment);
         }
 
-        if (lodashGet(Config, 'ENVIRONMENT', CONST.ENVIRONMENT.DEV) === CONST.ENVIRONMENT.ADHOC) {
+        if ((Config?.ENVIRONMENT ?? CONST.ENVIRONMENT.DEV) === CONST.ENVIRONMENT.ADHOC) {
             environment = CONST.ENVIRONMENT.ADHOC;
             return resolve(environment);
         }

src/libs/Environment/getEnvironment/index.ts

@@ -0,0 +1,9 @@
+import Config from 'react-native-config';
+import CONST from '@src/CONST';
+import Environment from './types';
+
+function getEnvironment(): Promise<Environment> {
+    return Promise.resolve((Config?.ENVIRONMENT as Environment) ?? CONST.ENVIRONMENT.DEV);
+}
+
+export default getEnvironment;

src/libs/Environment/getEnvironment/types.ts

@@ -0,0 +1,6 @@
+import {ValueOf} from 'type-fest';
+import CONST from '@src/CONST';
+
+type Environment = ValueOf<typeof CONST.ENVIRONMENT>;
+
+export default Environment;