Merge pull request #27709 from fvlvte/24877-migrate-device-lib-to-ts

[TS migration] Migrate 'Device' lib to TypeScript

package.json

@@ -98,7 +98,7 @@
     "date-fns-tz": "^2.0.0",
     "dom-serializer": "^0.2.2",
     "domhandler": "^4.3.0",
-    "expensify-common": "git+ssh://[email protected]/Expensify/expensify-common.git#a055da6a339383da825f353d5c0da72a26285007",
+    "expensify-common": "git+ssh://[email protected]/Expensify/expensify-common.git#886f90cbd5e83218fdfd7784d8356c308ef05791",
     "fbjs": "^3.0.2",
     "htmlparser2": "^7.2.0",
     "idb-keyval": "^6.2.1",

src/libs/actions/Device/generateDeviceID/index.android.js → src/libs/actions/Device/generateDeviceID/index.android.ts

@@ -1,5 +1,6 @@
 import Str from 'expensify-common/lib/str';
 import DeviceInfo from 'react-native-device-info';
+import GenerateDeviceID from './types';
 
 const deviceID = DeviceInfo.getDeviceId();
 const uniqueID = Str.guid(deviceID);
@@ -22,11 +23,7 @@ const uniqueID = Str.guid(deviceID);
  *
  * Furthermore, the deviceID prefix is not unique to a specific device, but is likely to change from one type of device to another.
  * Including this prefix will tell us with a reasonable degree of confidence if the user just uninstalled and reinstalled the app, or if they got a new device.
- *
- * @returns {Promise<String>}
  */
-function generateDeviceID() {
-    return Promise.resolve(uniqueID);
-}
+const generateDeviceID: GenerateDeviceID = () => Promise.resolve(uniqueID);
 
 export default generateDeviceID;

src/libs/actions/Device/generateDeviceID/index.desktop.js → src/libs/actions/Device/generateDeviceID/index.desktop.ts

@@ -1,12 +1,10 @@
 import ELECTRON_EVENTS from '../../../../../desktop/ELECTRON_EVENTS';
+import GenerateDeviceID from './types';
 
 /**
  * Get the unique ID of the current device. This should remain the same even if the user uninstalls and reinstalls the app.
- *
- * @returns {Promise<String>}
  */
-function generateDeviceID() {
-    return window.electron.invoke(ELECTRON_EVENTS.REQUEST_DEVICE_ID);
-}
+
+const generateDeviceID: GenerateDeviceID = () => window.electron.invoke(ELECTRON_EVENTS.REQUEST_DEVICE_ID) as Promise<string>;
 
 export default generateDeviceID;

src/libs/actions/Device/generateDeviceID/index.ios.js → src/libs/actions/Device/generateDeviceID/index.ios.ts

@@ -1,14 +1,11 @@
 import DeviceInfo from 'react-native-device-info';
+import GenerateDeviceID from './types';
 
 const deviceID = DeviceInfo.getDeviceId();
 
 /**
  * Get the unique ID of the current device. This should remain the same even if the user uninstalls and reinstalls the app.
- *
- * @returns {Promise<String>}
  */
-function generateDeviceID() {
-    return DeviceInfo.getUniqueId().then((uniqueID) => `${deviceID}_${uniqueID}`);
-}
+const generateDeviceID: GenerateDeviceID = () => DeviceInfo.getUniqueId().then((uniqueID: string) => `${deviceID}_${uniqueID}`);
 
 export default generateDeviceID;

src/libs/actions/Device/generateDeviceID/index.website.js → src/libs/actions/Device/generateDeviceID/index.ts

@@ -1,4 +1,5 @@
 import Str from 'expensify-common/lib/str';
+import GenerateDeviceID from './types';
 
 const uniqueID = Str.guid();
 
@@ -13,11 +14,8 @@ const uniqueID = Str.guid();
  *
  * While this isn't perfect, it's just as good as any other obvious web solution, such as this one https://developer.mozilla.org/en-US/docs/Web/API/MediaDeviceInfo/deviceId
  * which is also different/reset under the same circumstances
- *
- * @returns {Promise<String>}
  */
-function generateDeviceID() {
-    return Promise.resolve(uniqueID);
-}
+
+const generateDeviceID: GenerateDeviceID = () => Promise.resolve(uniqueID);
 
 export default generateDeviceID;

src/libs/actions/Device/generateDeviceID/types.ts

@@ -0,0 +1,3 @@
+type GenerateDeviceID = () => Promise<string>;
+
+export default GenerateDeviceID;

src/libs/actions/Device/getDeviceInfo/getBaseInfo.ts

@@ -0,0 +1,9 @@
+import packageConfig from '../../../../../package.json';
+import {GetBaseInfo} from './types';
+
+const getBaseInfo: GetBaseInfo = () => ({
+    appVersion: packageConfig.version,
+    timestamp: new Date().toISOString().slice(0, 19),
+});
+
+export default getBaseInfo;

src/libs/actions/Device/getDeviceInfo/getOSAndName/index.native.ts

@@ -1,17 +1,13 @@
 import Str from 'expensify-common/lib/str';
 import RNDeviceInfo from 'react-native-device-info';
-import GetOSAndName from './types';
+import {GetOSAndName} from './types';
 
 const getOSAndName: GetOSAndName = () => {
     const deviceName = RNDeviceInfo.getDeviceNameSync();
     const prettyName = `${Str.UCFirst(RNDeviceInfo.getManufacturerSync() || '')} ${deviceName}`;
     return {
-        // Parameter names are predefined and we don't choose it here
-        // eslint-disable-next-line @typescript-eslint/naming-convention
-        device_name: RNDeviceInfo.isEmulatorSync() ? `Emulator - ${prettyName}` : prettyName,
-        // Parameter names are predefined and we don't choose it here
-        // eslint-disable-next-line @typescript-eslint/naming-convention
-        os_version: RNDeviceInfo.getSystemVersion(),
+        deviceName: RNDeviceInfo.isEmulatorSync() ? `Emulator - ${prettyName}` : prettyName,
+        osVersion: RNDeviceInfo.getSystemVersion(),
     };
 };
 

src/libs/actions/Device/getDeviceInfo/getOSAndName/index.ts

@@ -1,12 +1,4 @@
-import {getOSAndName as libGetOSAndName} from 'expensify-common/lib/Device';
-import GetOSAndName from './types';
+// Don't import this file with '* as Device'. It's known to make VSCode IntelliSense crash.
+import {getOSAndName} from 'expensify-common/lib/Device';
 
-const getOSAndName: GetOSAndName = () => {
-    // Parameter names are predefined and we don't choose it here
-    // eslint-disable-next-line @typescript-eslint/naming-convention
-    const {device_name, os_version} = libGetOSAndName();
-    // Parameter names are predefined and we don't choose it here
-    // eslint-disable-next-line @typescript-eslint/naming-convention
-    return {device_name, os_version};
-};
 export default getOSAndName;

src/libs/actions/Device/getDeviceInfo/getOSAndName/types.ts

@@ -1,4 +1,7 @@
-// Parameter names are predefined and we don't choose it here
-// eslint-disable-next-line @typescript-eslint/naming-convention
-type GetOSAndName = () => {device_name: string | undefined; os_version: string | undefined};
-export default GetOSAndName;
+type GetOSAndName = () => OSAndName;
+type OSAndName = {
+    deviceName?: string;
+    osVersion?: string;
+};
+
+export type {GetOSAndName, OSAndName};

src/libs/actions/Device/getDeviceInfo/index.android.ts

@@ -0,0 +1,11 @@
+import getBaseInfo from './getBaseInfo';
+import getOSAndName from './getOSAndName/index';
+import {GetDeviceInfo} from './types';
+
+const getDeviceInfo: GetDeviceInfo = () => ({
+    ...getBaseInfo(),
+    ...getOSAndName(),
+    os: 'Android',
+});
+
+export default getDeviceInfo;

src/libs/actions/Device/getDeviceInfo/index.desktop.ts

@@ -0,0 +1,11 @@
+import getBaseInfo from './getBaseInfo';
+import getOSAndName from './getOSAndName/index';
+import {GetDeviceInfo} from './types';
+
+const getDeviceInfo: GetDeviceInfo = () => ({
+    ...getBaseInfo(),
+    ...getOSAndName(),
+    deviceName: 'Desktop',
+});
+
+export default getDeviceInfo;

src/libs/actions/Device/getDeviceInfo/index.ios.ts

@@ -0,0 +1,11 @@
+import getBaseInfo from './getBaseInfo';
+import getOSAndName from './getOSAndName/index';
+import {GetDeviceInfo} from './types';
+
+const getDeviceInfo: GetDeviceInfo = () => ({
+    ...getBaseInfo(),
+    ...getOSAndName(),
+    os: 'iOS',
+});
+
+export default getDeviceInfo;

src/libs/actions/Device/getDeviceInfo/index.ts

@@ -0,0 +1,10 @@
+import getBaseInfo from './getBaseInfo';
+import getOSAndName from './getOSAndName/index';
+import {GetDeviceInfo} from './types';
+
+const getDeviceInfo: GetDeviceInfo = () => ({
+    ...getBaseInfo(),
+    ...getOSAndName(),
+});
+
+export default getDeviceInfo;

src/libs/actions/Device/getDeviceInfo/types.ts

@@ -0,0 +1,12 @@
+import {OSAndName} from './getOSAndName/types';
+
+type BaseInfo = {
+    appVersion: string;
+    timestamp: string;
+};
+
+type GetDeviceInfo = () => DeviceInfo;
+type DeviceInfo = BaseInfo & OSAndName & {os?: string; deviceName?: string; deviceVersion?: string};
+type GetBaseInfo = () => BaseInfo;
+
+export type {GetDeviceInfo, DeviceInfo, GetBaseInfo, BaseInfo};

src/libs/actions/Device/index.js → src/libs/actions/Device/index.ts

@@ -4,23 +4,23 @@ import ONYXKEYS from '@src/ONYXKEYS';
 import generateDeviceID from './generateDeviceID';
 import getDeviceInfo from './getDeviceInfo';
 
-let deviceID;
+let deviceID: string | null = null;
 
 /**
- * @returns {Promise<String>}
+ * @returns - device ID string or null in case of failure
  */
-function getDeviceID() {
+function getDeviceID(): Promise<string | null> {
     return new Promise((resolve) => {
         if (deviceID) {
             return resolve(deviceID);
         }
 
         const connectionID = Onyx.connect({
             key: ONYXKEYS.DEVICE_ID,
-            callback: (ID) => {
+            callback: (id) => {
                 Onyx.disconnect(connectionID);
-                deviceID = ID;
-                return resolve(ID);
+                deviceID = id;
+                return resolve(id);
             },
         });
     });
@@ -38,7 +38,7 @@ function setDeviceID() {
             throw new Error(existingDeviceID);
         })
         .then(generateDeviceID)
-        .then((uniqueID) => {
+        .then((uniqueID: string) => {
             Log.info('Got new deviceID', false, uniqueID);
             Onyx.set(ONYXKEYS.DEVICE_ID, uniqueID);
         })
@@ -47,9 +47,9 @@ function setDeviceID() {
 
 /**
  * Returns a string object with device info and uniqueID
- * @returns {Promise<string>}
+ * @returns - device info with ID
  */
-function getDeviceInfoWithID() {
+function getDeviceInfoWithID(): Promise<string> {
     return new Promise((resolve) => {
         getDeviceID().then((currentDeviceID) =>
             resolve(