8587777644

Committed 07 Apr 2024 09:32AM UTC coverage: 80.223% (-0.3%) from 80.511%

Build # 8587777644

Build Type

Pull #71

github

Committed by

web-flow

Commit Message

Merge 9ca784b5e into 37e21f98c

Pull Request Pull Request #71: a simpler implementation of socket interface for different platform

Run Details

1283 of 1430 branches covered (89.72%)

Branch coverage included in aggregate %.

85 of 111 new or added lines in 7 files covered. (76.58%)

4 existing lines in 2 files now uncovered.

5134 of 6569 relevant lines covered (78.15%)

42.53 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

83.17

/packages/mp-base/src/index.ts

import { getRandomId, isArray, isClass, psLog } from 'base/src';
import type {
  SpyMP,
  PageSpyPlugin,
  PageSpyPluginLifecycle,
  PluginOrder,
  PageSpyPluginLifecycleArgs,
} from '@huolala-tech/page-spy-types';
import { SocketState } from 'base/src/socket-base';
import { ROOM_SESSION_KEY } from 'base/src/constants';

import ConsolePlugin from './plugins/console';
import ErrorPlugin from './plugins/error';
import NetworkPlugin from './plugins/network';
import SystemPlugin from './plugins/system';
import StoragePlugin from './plugins/storage';

import socketStore, { MPSocketImpl } from './helpers/socket';
import Request from './api';

// import './index.less';
// eslint-disable-next-line import/order
import { Config } from './config';
import { getMPSDK, utilAPI } from './utils';

class PageSpy {
  root: HTMLElement | null = null;

  version = PKG_VERSION;

  static plugins: Record<PluginOrder | 'normal', PageSpyPlugin[]> = {
    pre: [],
    normal: [],
    post: [],
  };

  static get pluginsWithOrder() {
    return [
      ...PageSpy.plugins.pre,
      ...PageSpy.plugins.normal,
      ...PageSpy.plugins.post,
    ];
  }

  request: Request | null = null;

  // System info: <os>-<browser>:<browserVersion>
  name = '';

  // Room address
  address = '';

  // Completed websocket room url
  roomUrl = '';

  socketStore = socketStore;

  config = new Config();

  static instance: PageSpy | null = null;

  static registerPlugin(plugin: PageSpyPlugin) {
    if (!plugin) {
      return;
    }
    if (isClass(plugin)) {
      psLog.error(
        'PageSpy.registerPlugin() expect to pass an instance, not a class',
      );
      return;
    }
    if (!plugin.name) {
      psLog.error(
        `The ${plugin.constructor.name} plugin should provide a "name" property`,
      );
      return;
    }
    const isExist = PageSpy.pluginsWithOrder.some(
      (i) => i.name === plugin.name,
    );
    if (isExist) {
      psLog.error(
        `The ${plugin.name} has registered. Consider the following reasons:
      - Duplicate register one same plugin;
      - Plugin's "name" conflict with others, you can print all registered plugins by "PageSpy.plugins";`,
      );
      return;
    }
    const currentPluginSet = PageSpy.plugins[plugin.enforce || 'normal'];
    currentPluginSet.push(plugin);
  }

  constructor(init: SpyMP.MPInitConfig) {
    if (PageSpy.instance) {
      psLog.warn('Cannot initialize PageSpy multiple times');
      // eslint-disable-next-line no-constructor-return
      return PageSpy.instance;
    }

    const config = this.config.mergeConfig(init);

    if (config.singletonSocket) {
      MPSocketImpl.isSingleSocket = true;
    }

    const mp = getMPSDK();

    if (mp.canIUse('getAccountInfoSync')) {
      const accountInfo = mp.getAccountInfoSync().miniProgram;
      if (
        accountInfo.envVersion === 'release' &&
        config.disabledOnProd !== false
      ) {
        psLog.warn('PageSpy is not allowed on release env of mini program');
        // eslint-disable-next-line consistent-return
        return;
      }
    }

    // Here will check the config api
    this.request = new Request(this.config);

    PageSpy.instance = this;
    const mpWarningText =
      '!!!WARNING!!!: When submitting the mini program for review, be sure to delete the SDK in the code, otherwise the review will fail.';

    psLog.log(mpWarningText);
    psLog.info(mpWarningText);
    psLog.warn(mpWarningText);

    this.triggerPlugins('onInit', { socketStore, config });

    this.init();
  }

  triggerPlugins<T extends PageSpyPluginLifecycle>(
    lifecycle: T,
    ...args: PageSpyPluginLifecycleArgs<T>
  ) {
    const { disabledPlugins } = this.config.get();
    PageSpy.pluginsWithOrder.forEach((plugin) => {
      if (
        isArray(disabledPlugins) &&
        disabledPlugins.length &&
        disabledPlugins.includes(plugin.name)
      ) {
        return;
      }
      (plugin[lifecycle] as any)?.apply(plugin, args);
    });
  }

  async init() {
    const mp = getMPSDK();
    const config = this.config.get();
    const roomCache = utilAPI.getStorage(ROOM_SESSION_KEY);
    if (!roomCache || typeof roomCache !== 'object') {
      await this.createNewConnection();
    } else {
      const { name, address, roomUrl, usable, project: prev, time } = roomCache;
      // The server will close the connection after 60s. for the sdk, we use 30s.
      if (!usable || config.project !== prev || time < Date.now() - 1000 * 30) {
        await this.createNewConnection();
      } else {
        this.name = name;
        this.address = address;
        this.roomUrl = roomUrl;
        this.useOldConnection();
      }
    }

    /* c8 ignore next 10 */
    if (mp.canIUse('onAppShow')) {
      mp.onAppShow(() => {
        // Mini programe can not detect ws disconnect (before we add heart beat ping pong).
        // So we need to refresh the connection.
        const state = socketStore.getSocket()?.readyState;
        if (state === SocketState.CLOSED || state === SocketState.CLOSING) {
          this.useOldConnection();
        }
      });
    }
    psLog.log('Plugins inited');
  }

  abort() {
    this.triggerPlugins('onReset');
    socketStore.close();
    PageSpy.instance = null;
  }

  async createNewConnection() {
    if (!this.request) {
      psLog.error('Cannot get the Request');
      return;
    }
    const { data } = await this.request.createRoom();
    const roomUrl = this.request.getRoomUrl({
      address: data.address,
      name: `client:${getRandomId()}`,
      userId: 'Client',
    });
    this.name = data.name;
    this.address = data.address;
    this.roomUrl = roomUrl;
    this.refreshRoomInfo();
    socketStore.init(roomUrl);
  }

  useOldConnection() {
    // TODO when use old connection, must make sure it's connectable, then refresh the cache
    this.refreshRoomInfo();
    socketStore.init(this.roomUrl);
  }

  // avoid deleted by user code
  refreshRoomInfo() {
    /* c8 ignore start */
    this.saveSession();
    const timerId = setInterval(() => {
      const roomCache = utilAPI.getStorage(ROOM_SESSION_KEY);
      if (roomCache && typeof roomCache === 'object') {
        const { usable } = roomCache;
        // unusable or time is expired, the room is not usable
        if (usable === false) {
          clearInterval(timerId);
          return;
        }
      }

      this.saveSession();
    }, 15 * 1000);
    /* c8 ignore stop */
    psLog.log(`Room ID: ${this.address.slice(0, 4)}`);
  }

  saveSession() {
    const { name, address, roomUrl } = this;
    const roomCache = {
      name,
      address,
      roomUrl,
      usable: true,
      project: this.config.get().project,
      time: Date.now(),
    };
    utilAPI.setStorage(ROOM_SESSION_KEY, roomCache);
  }
}

const INTERNAL_PLUGINS = [
  new ConsolePlugin(),
  new ErrorPlugin(),
  new NetworkPlugin(),
  new StoragePlugin(),
  new SystemPlugin(),
];

INTERNAL_PLUGINS.forEach((p) => {
  PageSpy.registerPlugin(p);
});

export default PageSpy;

1	import { getRandomId, isArray, isClass, psLog } from 'base/src';	2✔
2	import type {	2✔
3	SpyMP,	2✔
4	PageSpyPlugin,	2✔
5	PageSpyPluginLifecycle,	2✔
6	PluginOrder,	2✔
7	PageSpyPluginLifecycleArgs,	2✔
8	} from '@huolala-tech/page-spy-types';	2✔
9	import { SocketState } from 'base/src/socket-base';	2✔
10	import { ROOM_SESSION_KEY } from 'base/src/constants';	2✔
11		2✔
12	import ConsolePlugin from './plugins/console';	2✔
13	import ErrorPlugin from './plugins/error';	2✔
14	import NetworkPlugin from './plugins/network';	2✔
15	import SystemPlugin from './plugins/system';	2✔
16	import StoragePlugin from './plugins/storage';	2✔
17		2✔
18	import socketStore, { MPSocketImpl } from './helpers/socket';	2✔
19	import Request from './api';	2✔
20		2✔
21	// import './index.less';	2✔
22	// eslint-disable-next-line import/order	2✔
23	import { Config } from './config';	2✔
24	import { getMPSDK, utilAPI } from './utils';	2✔
25		2✔
26	class PageSpy {	2✔
27	root: HTMLElement \| null = null;	2✔
28		16✔
29	version = PKG_VERSION;	16✔
30		16✔
31	static plugins: Record<PluginOrder \| 'normal', PageSpyPlugin[]> = {	16✔
32	pre: [],	2✔
33	normal: [],	2✔
34	post: [],	2✔
35	};	2✔
36		2✔
37	static get pluginsWithOrder() {	2✔
38	return [	30✔
39	...PageSpy.plugins.pre,	30✔
40	...PageSpy.plugins.normal,	30✔
41	...PageSpy.plugins.post,	30✔
42	];	30✔
43	}	30✔
44		2✔
45	request: Request \| null = null;	2✔
46		2✔
47	// System info: <os>-<browser>:<browserVersion>	2✔
48	name = '';	2✔
49		2✔
50	// Room address	2✔
51	address = '';	2✔
52		2✔
53	// Completed websocket room url	2✔
54	roomUrl = '';	2✔
55		2✔
56	socketStore = socketStore;	2✔
57		2✔
58	config = new Config();	2✔
59		2✔
60	static instance: PageSpy \| null = null;	2✔
61		2✔
62	static registerPlugin(plugin: PageSpyPlugin) {	2✔
63	if (!plugin) {	10!
64	return;	×
65	}	×
66	if (isClass(plugin)) {	10!
67	psLog.error(	×
68	'PageSpy.registerPlugin() expect to pass an instance, not a class',	×
69	);	×
70	return;	×
71	}	×
72	if (!plugin.name) {	10!
73	psLog.error(	×
74	`The ${plugin.constructor.name} plugin should provide a "name" property`,	×
75	);	×
76	return;	×
77	}	×
78	const isExist = PageSpy.pluginsWithOrder.some(	10✔
79	(i) => i.name === plugin.name,	10✔
80	);	10✔
81	if (isExist) {	10!
82	psLog.error(	×
83	`The ${plugin.name} has registered. Consider the following reasons:	×
84	- Duplicate register one same plugin;	×
85	- Plugin's "name" conflict with others, you can print all registered plugins by "PageSpy.plugins";`,	×
86	);	×
87	return;	×
88	}	×
89	const currentPluginSet = PageSpy.plugins[plugin.enforce \|\| 'normal'];	10✔
90	currentPluginSet.push(plugin);	10✔
91	}	10✔
92		2✔
93	constructor(init: SpyMP.MPInitConfig) {	2✔
94	if (PageSpy.instance) {	16✔
95	psLog.warn('Cannot initialize PageSpy multiple times');	4✔
96	// eslint-disable-next-line no-constructor-return	4✔
97	return PageSpy.instance;	4✔
98	}	4✔
99		12✔
100	const config = this.config.mergeConfig(init);	12✔
101		12✔
102	if (config.singletonSocket) {	16!
NEW 103	MPSocketImpl.isSingleSocket = true;	×
104	}	×
105		12✔
106	const mp = getMPSDK();	12✔
107		12✔
108	if (mp.canIUse('getAccountInfoSync')) {	12✔
109	const accountInfo = mp.getAccountInfoSync().miniProgram;	12✔
110	if (	12✔
111	accountInfo.envVersion === 'release' &&	12!
112	config.disabledOnProd !== false	×
113	) {	12!
114	psLog.warn('PageSpy is not allowed on release env of mini program');	×
115	// eslint-disable-next-line consistent-return	×
116	return;	×
117	}	×
118	}	12✔
119		12✔
120	// Here will check the config api	12✔
121	this.request = new Request(this.config);	12✔
122		12✔
123	PageSpy.instance = this;	12✔
124	const mpWarningText =	12✔
125	'!!!WARNING!!!: When submitting the mini program for review, be sure to delete the SDK in the code, otherwise the review will fail.';	12✔
126		12✔
127	psLog.log(mpWarningText);	12✔
128	psLog.info(mpWarningText);	12✔
129	psLog.warn(mpWarningText);	12✔
130		12✔
131	this.triggerPlugins('onInit', { socketStore, config });	12✔
132		12✔
133	this.init();	12✔
134	}	12✔
135		2✔
136	triggerPlugins<T extends PageSpyPluginLifecycle>(	2✔
137	lifecycle: T,	20✔
138	...args: PageSpyPluginLifecycleArgs<T>	20✔
139	) {	20✔
140	const { disabledPlugins } = this.config.get();	20✔
141	PageSpy.pluginsWithOrder.forEach((plugin) => {	20✔
142	if (	100✔
143	isArray(disabledPlugins) &&	100✔
144	disabledPlugins.length &&	100!
145	disabledPlugins.includes(plugin.name)	×
146	) {	100!
147	return;	×
148	}	×
149	(plugin[lifecycle] as any)?.apply(plugin, args);	100✔
150	});	20✔
151	}	20✔
152		2✔
153	async init() {	2✔
154	const mp = getMPSDK();	10✔
155	const config = this.config.get();	10✔
156	const roomCache = utilAPI.getStorage(ROOM_SESSION_KEY);	10✔
157	if (!roomCache \|\| typeof roomCache !== 'object') {	10✔
158	await this.createNewConnection();	8✔
159	} else {	10✔
160	const { name, address, roomUrl, usable, project: prev, time } = roomCache;	2✔
161	// The server will close the connection after 60s. for the sdk, we use 30s.	2✔
162	if (!usable \|\| config.project !== prev \|\| time < Date.now() - 1000 * 30) {	2!
163	await this.createNewConnection();	×
164	} else {	2✔
165	this.name = name;	2✔
166	this.address = address;	2✔
167	this.roomUrl = roomUrl;	2✔
168	this.useOldConnection();	2✔
169	}	2✔
170	}	2✔
171		10✔
172	/* c8 ignore next 10 */	2✔
173	if (mp.canIUse('onAppShow')) {	2✔
174	mp.onAppShow(() => {	2✔
175	// Mini programe can not detect ws disconnect (before we add heart beat ping pong).	2✔
176	// So we need to refresh the connection.	2✔
177	const state = socketStore.getSocket()?.readyState;	2✔
178	if (state === SocketState.CLOSED \|\| state === SocketState.CLOSING) {	2✔
179	this.useOldConnection();	2✔
180	}	2✔
181	});	2✔
182	}	2✔
183	psLog.log('Plugins inited');	10✔
184	}	10✔
185		2✔
186	abort() {	2✔
187	this.triggerPlugins('onReset');	10✔
188	socketStore.close();	10✔
189	PageSpy.instance = null;	10✔
190	}	10✔
191		2✔
192	async createNewConnection() {	2✔
193	if (!this.request) {	8!
194	psLog.error('Cannot get the Request');	×
195	return;	×
196	}	×
197	const { data } = await this.request.createRoom();	8✔
198	const roomUrl = this.request.getRoomUrl({	8✔
199	address: data.address,	8✔
200	name: `client:${getRandomId()}`,	8✔
201	userId: 'Client',	8✔
202	});	8✔
203	this.name = data.name;	8✔
204	this.address = data.address;	8✔
205	this.roomUrl = roomUrl;	8✔
206	this.refreshRoomInfo();	8✔
207	socketStore.init(roomUrl);	8✔
208	}	8✔
209		2✔
210	useOldConnection() {	2✔
211	// TODO when use old connection, must make sure it's connectable, then refresh the cache	2✔
212	this.refreshRoomInfo();	2✔
213	socketStore.init(this.roomUrl);	2✔
214	}	2✔
215		2✔
216	// avoid deleted by user code	2✔
217	refreshRoomInfo() {	2✔
218	/* c8 ignore start */	2✔
219	this.saveSession();	2✔
220	const timerId = setInterval(() => {	2✔
221	const roomCache = utilAPI.getStorage(ROOM_SESSION_KEY);	2✔
222	if (roomCache && typeof roomCache === 'object') {	2✔
223	const { usable } = roomCache;	2✔
224	// unusable or time is expired, the room is not usable	2✔
225	if (usable === false) {	2✔
226	clearInterval(timerId);	2✔
227	return;	2✔
228	}	2✔
229	}	2✔
230		2✔
231	this.saveSession();	2✔
232	}, 15 * 1000);	2✔
233	/* c8 ignore stop */	2✔
234	psLog.log(`Room ID: ${this.address.slice(0, 4)}`);	10✔
235	}	10✔
236		2✔
237	saveSession() {	2✔
238	const { name, address, roomUrl } = this;	10✔
239	const roomCache = {	10✔
240	name,	10✔
241	address,	10✔
242	roomUrl,	10✔
243	usable: true,	10✔
244	project: this.config.get().project,	10✔
245	time: Date.now(),	10✔
246	};	10✔
247	utilAPI.setStorage(ROOM_SESSION_KEY, roomCache);	10✔
248	}	10✔
249	}	2✔
250		2✔
251	const INTERNAL_PLUGINS = [	2✔
252	new ConsolePlugin(),	2✔
253	new ErrorPlugin(),	2✔
254	new NetworkPlugin(),	2✔
255	new StoragePlugin(),	2✔
256	new SystemPlugin(),	2✔
257	];	2✔
258		2✔
259	INTERNAL_PLUGINS.forEach((p) => {	2✔
260	PageSpy.registerPlugin(p);	10✔
261	});	2✔
262		2✔
263	export default PageSpy;	2✔

HuolalaTech / page-spy / 8587777644

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous