Merge pull request #108 from HuolalaTech/fix/harmony-ua

feat: update the ua in harmony SDK
HuolalaTech · Aug 28, 2024 · 6c4118a · 6c4118a
2 parents 0a5611f + e18819b
commit 6c4118a
Show file tree

Hide file tree

Showing 29 changed files with 176 additions and 364 deletions.
diff --git a/packages/page-spy-alipay/package.json b/packages/page-spy-alipay/package.json
@@ -26,7 +26,7 @@
   },
   "scripts": {
     "build": "rollup -c",
-    "build:watch": "rollup -c -w"
+    "watch": "rollup -c -w"
   },
   "dependencies": {
     "@huolala-tech/page-spy-base": "^1.0.5",

diff --git a/packages/page-spy-base/package.json b/packages/page-spy-base/package.json
@@ -11,6 +11,7 @@
   "types": "./dist/index.d.ts",
   "scripts": {
     "build": "yarn clean && tsc",
+    "watch": "tsc -w",
     "clean": "rm -rf ./dist"
   },
   "publishConfig": {

diff --git a/packages/page-spy-base/src/client.ts b/packages/page-spy-base/src/client.ts
@@ -1,76 +1,6 @@
 /* eslint-disable no-restricted-syntax */
 import { SpyClient } from '@huolala-tech/page-spy-types';
 
-const browsers = {
-  WeChat: /MicroMessenger\/([\d.]+)/,
-  QQ: /(?:QQBrowser|MQQBrowser|QQ)\/([\d.]+)/,
-  UC: /(?:UCBrowser|UCBS)\/([\d.]+)/,
-  Baidu: /(?:BIDUBrowser|baiduboxapp)[/]?([\d.]*)/,
-  Edge: /Edg(?:e|A|iOS)?\/([\d.]+)/,
-  Chrome: /(?:Chrome|CriOS)\/([\d.]+)/,
-  Firefox: /(?:Firefox|FxiOS)\/([\d.]+)/,
-  Safari: /Version\/([\d.]+).*Safari/,
-};
-
-const platforms = {
-  Windows: /Windows NT ([\d_.]+)/,
-  iPhone: /iPhone OS ([\d_.]+)/,
-  iPad: /iPad.*OS ([\d_.]+)/,
-  Mac: /Mac OS X ([\d_.]+)/,
-  Android: /Android ([\d_.]+)/,
-  Linux: /Linux/,
-};
-
-export function parseUserAgent(
-  uaString: string = window.navigator.userAgent,
-): SpyClient.ClientInfo {
-  let osType: SpyClient.OS = 'unknown';
-  let osVersion = 'unknown';
-  let browserType: SpyClient.Browser = 'unknown';
-  let browserVersion = 'unknown';
-
-  // 判断操作系统
-  for (const platform in platforms) {
-    if (Object.prototype.hasOwnProperty.call(platforms, platform)) {
-      const reg = platforms[platform as keyof typeof platforms];
-      const match = uaString.match(reg);
-      if (match) {
-        osType = platform as SpyClient.OS;
-        osVersion = match[1]?.replaceAll('_', '.');
-        break;
-      }
-    }
-  }
-
-  // 判断浏览器
-  for (const browser in browsers) {
-    if (Object.prototype.hasOwnProperty.call(browsers, browser)) {
-      const match = uaString.match(browsers[browser as keyof typeof browsers]);
-      if (match) {
-        browserType = browser as SpyClient.Browser;
-        // eslint-disable-next-line prefer-destructuring
-        browserVersion = match[1];
-        break;
-      }
-    }
-  }
-
-  return {
-    osType,
-    osVersion,
-    browserType,
-    browserVersion,
-  };
-}
-
-export const combineName = ({
-  osType,
-  osVersion,
-  browserType,
-  browserVersion,
-}: SpyClient.ClientInfo) =>
-  `${osType}/${osVersion} ${browserType}/${browserVersion}`;
-
 export class Client {
   static info: SpyClient.ClientInfo = {
     // browserName and framework should be overwritten by package implementation\
@@ -86,13 +16,25 @@ export class Client {
   static plugins: string[] = [];
 
   static makeClientInfoMsg() {
-    const ua = Client.info.ua || combineName(Client.info);
     const msg: SpyClient.DataItem = {
       sdk: Client.info.sdk,
       isDevTools: Client.info.isDevTools,
-      ua,
+      ua: Client.getName(),
       plugins: Client.plugins,
     };
     return msg;
   }
+
+  private static _name: string;
+
+  static getName() {
+    if (!Client._name) {
+      const { ua, osType, osVersion, browserType, browserVersion } =
+        Client.info;
+
+      Client._name =
+        ua || `${osType}/${osVersion} ${browserType}/${browserVersion}`;
+    }
+    return Client._name;
+  }
 }
diff --git a/packages/page-spy-base/src/socket-base.ts b/packages/page-spy-base/src/socket-base.ts
@@ -3,7 +3,12 @@
  * 不同平台 socket 的 api 不同但功能相同，这里抽象一层
  */
 
-import { SpyMessage, SpySocket, SpyBase } from '@huolala-tech/page-spy-types';
+import {
+  SpyMessage,
+  SpySocket,
+  SpyBase,
+  InitConfigBase,
+} from '@huolala-tech/page-spy-types';
 import { PackedEvent } from '@huolala-tech/page-spy-types/lib/socket-event';
 import { getRandomId, psLog, stringifyData } from './utils';
 import {
@@ -95,10 +100,6 @@ export abstract class SocketWrapper {
 }
 
 export abstract class SocketStoreBase {
-  protected abstract socketWrapper: SocketWrapper;
-
-  protected abstract updateRoomInfo(): void;
-
   public socketUrl: string = '';
 
   public socketConnection: SpySocket.Connection | null = null;
@@ -142,7 +143,39 @@ export abstract class SocketStoreBase {
   // initial retry interval.
   public retryInterval = INIT_RETRY_INTERVAL;
 
-  connectable = true;
+  public connectable = true;
+
+  protected abstract socketWrapper: SocketWrapper;
+
+  public getSocket() {
+    return this.socketWrapper;
+  }
+
+  public getPageSpyConfig: (() => Required<InitConfigBase>) | null = null;
+
+  updateRoomInfo() {
+    if (this.getPageSpyConfig) {
+      const { project, title } = this.getPageSpyConfig();
+      const name = Client.getName();
+      this.send(
+        {
+          type: SERVER_MESSAGE_TYPE.UPDATE_ROOM_INFO,
+          content: {
+            info: {
+              name,
+              group: project,
+              tags: {
+                title,
+                name,
+                group: project,
+              },
+            },
+          },
+        },
+        true,
+      );
+    }
+  }
 
   // response message filters, to handle some wired messages
   public static messageFilters: ((data: any) => any)[] = [];

diff --git a/packages/page-spy-browser/package.json b/packages/page-spy-browser/package.json
@@ -27,7 +27,7 @@
   ],
   "scripts": {
     "build": "rollup -c",
-    "build:watch": "rollup -c -w"
+    "watch": "rollup -c -w"
   },
   "dependencies": {
     "@babel/runtime": "^7.13.0",

diff --git a/packages/page-spy-browser/src/helpers/socket.ts b/packages/page-spy-browser/src/helpers/socket.ts
@@ -1,13 +1,11 @@
 import {
   stringifyData,
   ROOM_SESSION_KEY,
-  UPDATE_ROOM_INFO,
   SocketStoreBase,
   SocketState,
   SocketWrapper,
   WebSocketEvents,
 } from '@huolala-tech/page-spy-base';
-import { InitConfig } from '../config';
 
 export class WebSocketWrapper extends SocketWrapper {
   public socketInstance: WebSocket | null = null;
@@ -41,35 +39,6 @@ export class WebSocketStore extends SocketStoreBase {
   // websocket instance
   protected socketWrapper: WebSocketWrapper = new WebSocketWrapper();
 
-  public getPageSpyConfig: (() => Required<InitConfig>) | null = null;
-
-  updateRoomInfo() {
-    if (this.getPageSpyConfig) {
-      const { project, title } = this.getPageSpyConfig();
-      this.send(
-        {
-          type: UPDATE_ROOM_INFO,
-          content: {
-            info: {
-              name: navigator.userAgent,
-              group: project,
-              tags: {
-                title,
-                name: navigator.userAgent,
-                group: project,
-              },
-            },
-          },
-        },
-        true,
-      );
-    }
-  }
-
-  public getSocket() {
-    return this.socketWrapper;
-  }
-
   // disable lint: this is an abstract method of parent class, so it cannot be static
   // eslint-disable-next-line class-methods-use-this
   onOffline(): void {

diff --git a/packages/page-spy-harmony/library/src/main/ets/api/index.ts b/packages/page-spy-harmony/library/src/main/ets/api/index.ts
@@ -2,7 +2,7 @@ import url from '@ohos.url';
 import http from '@ohos.net.http';
 import { InitConfig } from '../types';
 import { getRandomId } from '../utils';
-import Client, { combineName } from '../utils/client';
+import Client from '../utils/client';
 
 interface TResponse<T> {
   code: string;
@@ -50,7 +50,7 @@ export default class Request {
     const scheme = this.getScheme();
     const query = joinQuery({
       // TODO
-      name: combineName(Client.info),
+      name: Client.getName(),
       group: project,
       title,
     });

diff --git a/packages/page-spy-harmony/library/src/main/ets/helpers/socket.ts b/packages/page-spy-harmony/library/src/main/ets/helpers/socket.ts
@@ -1,8 +1,5 @@
 import webSocket from '@ohos.net.webSocket';
-import { InitConfig } from '../types';
 import { psLog, stringifyData } from '../utils';
-import Client, { combineName } from '../utils/client';
-import { UPDATE_ROOM_INFO } from '../utils/message/server-type';
 import {
   SocketStoreBase,
   SocketState,
@@ -59,37 +56,6 @@ export class OHSocketWrapper extends SocketWrapper {
 export class OHSocketStore extends SocketStoreBase {
   protected socketWrapper: OHSocketWrapper = new OHSocketWrapper();
 
-  public getPageSpyConfig: (() => Required<InitConfig>) | null = null;
-
-  updateRoomInfo() {
-    if (this.getPageSpyConfig) {
-      const { project, title } = this.getPageSpyConfig();
-      const name = combineName(Client.info);
-
-      this.send(
-        {
-          type: UPDATE_ROOM_INFO,
-          content: {
-            info: {
-              name,
-              group: project,
-              tags: {
-                title,
-                name,
-                group: project,
-              },
-            },
-          },
-        },
-        true,
-      );
-    }
-  }
-
-  public getSocket() {
-    return this.socketWrapper;
-  }
-
   onOffline(): void {
     // AppStorage.delete(ROOM_SESSION_KEY);
   }

diff --git a/packages/page-spy-harmony/library/src/main/ets/plugins/system.ts b/packages/page-spy-harmony/library/src/main/ets/plugins/system.ts
@@ -1,6 +1,6 @@
 import socketStore from '../helpers/socket';
 import { InitConfig, OnInitParams, PageSpyPlugin, SpySystem } from '../types';
-import Client, { combineName } from '../utils/client';
+import Client from '../utils/client';
 import { makeMessage } from '../utils/message';
 
 export default class SystemPlugin implements PageSpyPlugin {
@@ -38,7 +38,7 @@ export default class SystemPlugin implements PageSpyPlugin {
   public static getSystemInfo() {
     return {
       system: {
-        ua: combineName(Client.info),
+        ua: Client.getName(),
       },
       features: {},
     };