feat: reorganize the network plugin structure (#3)

BREAKING CHANGE: The headers and getData structure have been changed to [string, string][]. The use of postData is now deprecated. Please use requestPayload instead, with a structure of [string, string][] | string.

.github/workflows/coveralls.yml

@@ -23,7 +23,7 @@ jobs:
       - name: yarn install, yarn test
         run: |
           yarn install
-          yarn test
+          yarn test --silent
 
       - name: Coveralls
         uses: coverallsapp/github-action@v2

package.json

@@ -28,12 +28,12 @@
     "build": "rollup -c",
     "postbuild": "cp -R ./types ./dist",
     "build:watch": "rollup -c -w",
-    "test": "jest --silent",
+    "test": "jest",
     "lint": "eslint --ext .js,.ts ./src",
     "lint:fix": "eslint --ext .js,.ts --fix ./src",
     "prettier": "prettier --write '**/*.{js,jsx,tsx,ts,md,json}'",
     "commit": "git-cz",
-    "prepublishOnly": "yarn test && yarn build",
+    "prepublishOnly": "yarn test --silent && yarn build",
     "release:major": "standard-version --release-as major",
     "release:minor": "standard-version --release-as minor",
     "release:patch": "standard-version --release-as patch"

src/api/index.ts

@@ -1,3 +1,4 @@
+import { psLog } from 'src/utils';
 import { combineName, parseUserAgent } from 'src/utils/ua';
 
 interface TResponse<T> {
@@ -14,7 +15,7 @@ interface TCreateRoom {
   group: string;
   tags: Record<string, any>;
 }
-/* c8 ignore start */
+
 const resolvedProtocol = (() => {
   try {
     const { protocol } = new URL(document.currentScript?.getAttribute('src')!);
@@ -23,14 +24,13 @@ const resolvedProtocol = (() => {
     }
   } catch (e) {
     console.error(e);
-    console.error(
-      '[PageSpy] Failed to resolve the protocol and fallback to [http://, ws://]',
+    psLog.error(
+      'Failed to resolve the protocol and fallback to [http://, ws://]',
     );
   }
   return ['http://', 'ws://'];
 })();
 
-/* c8 ignore stop */
 export default class Request {
   constructor(public base: string = '') {
     /* c8 ignore next 3 */

src/index.ts

@@ -12,7 +12,7 @@ import { StoragePlugin } from './plugins/storage';
 
 import socketStore from './utils/socket';
 import Request from './api';
-import { getRandomId } from './utils';
+import { getRandomId, psLog } from './utils';
 import pkg from '../package.json';
 
 import type { UElement } from './utils/moveable';
@@ -229,7 +229,7 @@ export default class PageSpy {
     moveable(logo);
     this.handleDeviceDPR();
 
-    console.log('[PageSpy] init success.');
+    psLog.log('Init success.');
   }
 
   handleDeviceDPR() {

src/plugins/console.ts

@@ -5,11 +5,11 @@ import atom from 'src/utils/atom';
 import type PageSpyPlugin from './index';
 
 export default class ConsolePlugin implements PageSpyPlugin {
-  name: string = 'ConsolePlugin';
+  public name: string = 'ConsolePlugin';
 
-  console: Record<string, any> = {};
+  private console: Record<string, any> = {};
 
-  onCreated() {
+  public onCreated() {
     const type: SpyConsole.ProxyType[] = ['log', 'info', 'error', 'warn'];
     type.forEach((item) => {
       this.console[item] = window.console[item];
@@ -23,7 +23,7 @@ export default class ConsolePlugin implements PageSpyPlugin {
     });
   }
 
-  printLog(data: SpyConsole.DataItem) {
+  private printLog(data: SpyConsole.DataItem) {
     if (data.logs && data.logs.length) {
       this.console[data.logType](...data.logs);
       // eslint-disable-next-line no-param-reassign

src/plugins/error.ts

@@ -4,11 +4,11 @@ import socketStore from 'src/utils/socket';
 import type PageSpyPlugin from './index';
 
 export default class ErrorPlugin implements PageSpyPlugin {
-  name = 'ErrorPlugin';
+  public name = 'ErrorPlugin';
 
-  error: OnErrorEventHandler = null;
+  private error: OnErrorEventHandler = null;
 
-  onCreated() {
+  public onCreated() {
     const that = this;
     this.error = window.onerror;
 
@@ -35,7 +35,7 @@ export default class ErrorPlugin implements PageSpyPlugin {
       true,
     );
 
-    // Promise unhandleRejection Error
+    // Promise unhandledRejection Error
     window.addEventListener(
       'unhandledrejection',
       (evt: PromiseRejectionEvent) => {
@@ -44,7 +44,7 @@ export default class ErrorPlugin implements PageSpyPlugin {
     );
   }
 
-  static sendMessage(data: any) {
+  public static sendMessage(data: any) {
     // Treat `error` data as `console`
     const message = makeMessage(DEBUG_MESSAGE_TYPE.CONSOLE, {
       logType: 'error',

src/plugins/index.ts

@@ -1,7 +1,7 @@
 export default abstract class PageSpyPlugin {
-  constructor(public name: string) {}
+  public constructor(public name: string) {}
   // 加载后立即生效
-  abstract onCreated?(): void;
+  public abstract onCreated?(): void;
   // 用户主动触发的回调
-  abstract onLoaded?(): void;
+  public abstract onLoaded?(): void;
 }