👷 增加单元测试流程

Author: CodFrm

.github/workflows/build.yaml

@@ -34,7 +34,7 @@ jobs:
           mkdir dist
           echo "$CHROME_PEM" > ./dist/scriptcat.pem
           chmod 600 ./dist/scriptcat.pem
-          pnpm i
+          pnpm i --frozen-lockfile
           pnpm run pack
 
       - name: Archive production artifacts

.github/workflows/packageRelease.yml

@@ -27,7 +27,8 @@ jobs:
           mkdir dist
           echo "$CHROME_PEM" > ./dist/scriptcat.pem
           chmod 600 ./dist/scriptcat.pem
-          pnpm i
+          pnpm i --frozen-lockfile
+          pnpm test
           pnpm run pack
 
       - uses: ncipollo/release-action@v1

.github/workflows/test.yaml

@@ -3,8 +3,11 @@ name: test
 on:
   push:
     branches:
-      - disable # 暂时禁用
-  # pull_request:
+      - main
+      - release/*
+      - dev
+      - develop/*
+  pull_request:
 
 jobs:
   tests:
@@ -22,7 +25,8 @@ jobs:
 
       - name: Unit Test
         run: |
-          pnpm i
+          pnpm i --frozen-lockfile
+          pnpm test
           pnpm run coverage
 
       - name: Upload coverage reports to Codecov with GitHub Action

packages/chrome-extension-mock/cookies.ts

@@ -1,7 +1,5 @@
 export default class Cookies {
-  getAllCookieStores(
-    callback: (cookieStores: chrome.cookies.CookieStore[]) => void
-  ) {
+  getAllCookieStores(callback: (cookieStores: chrome.cookies.CookieStore[]) => void) {
     callback([
       {
         id: "0",
@@ -18,15 +16,16 @@ export default class Cookies {
   getAll(
     details: chrome.cookies.GetAllDetails,
     callback: (cookies: chrome.cookies.Cookie[]) => void
-  ): void {
+  ): Promise<chrome.cookies.Cookie[]> {
     this.mockGetAll?.(details, callback);
+    return Promise.resolve([]);
   }
 
   set(details: chrome.cookies.SetDetails, callback?: () => void): void {
     callback?.();
   }
 
-  remove(details: chrome.cookies.Details, callback?: () => void): void {
+  remove(details: chrome.cookies.CookieDetails, callback?: () => void): void {
     callback?.();
   }
 }

packages/chrome-extension-mock/i18n.ts

@@ -4,6 +4,6 @@ export default class I18n {
   }
 
   getAcceptLanguages(callback: (lngs: string[]) => void) {
-    callback(["zh-CN"]);
+    // callback(["zh-CN"]);
   }
 }

src/app/logger/core.ts

@@ -37,13 +37,17 @@ export default class LoggerCore {
 
   labels: LogLabel;
 
-  constructor(config: { level?: LogLevel; writer: Writer; labels: LogLabel }) {
+  constructor(config: { level?: LogLevel; consoleLevel?: LogLevel; writer: Writer; labels: LogLabel }) {
     this.writer = config.writer;
     this.level = config.level || this.level;
     this.labels = config.labels || {};
     // 获取日志debug等级, 如果是开发环境, 则默认为debug
-    if (process.env.NODE_ENV === "development") {
-      this.consoleLevel = "debug";
+    if (config.consoleLevel !== undefined) {
+      this.consoleLevel = config.consoleLevel;
+    } else {
+      if (process.env.NODE_ENV === "development") {
+        this.consoleLevel = "debug";
+      }
     }
     if (!LoggerCore.instance) {
       LoggerCore.instance = this;

src/app/repo/repo.ts

@@ -12,7 +12,7 @@ function loadCache(): Promise<any> {
     return loadCachePromise;
   }
   loadCachePromise = new Promise((resolve) => {
-    chrome.storage.local.get((result) => {
+    chrome.storage.local.get((result: { [key: string]: any; } | undefined) => {
       cache = result;
       resolve(cache);
     });
@@ -110,7 +110,7 @@ export abstract class Repo<T> {
     }
     const loadData = () => {
       return new Promise<T[]>((resolve) => {
-        chrome.storage.local.get((result) => {
+        chrome.storage.local.get((result: { [key: string]: T; }) => {
           resolve(this.filter(result, filters));
         });
       });

src/app/service/service_worker/gm_api.ts

@@ -8,7 +8,7 @@ import { connect, sendMessage } from "@Packages/message/client";
 import Cache, { incr } from "@App/app/cache";
 import EventEmitter from "eventemitter3";
 import { MessageQueue } from "@Packages/message/message_queue";
-import { RuntimeService } from "./runtime";
+import { EmitEventRequest, RuntimeService } from "./runtime";
 import { getIcon, isFirefox } from "@App/pkg/utils/utils";
 import { MockMessageConnect } from "@Packages/message/mock_message";
 import i18next, { i18nName } from "@App/locales/locales";
@@ -116,6 +116,27 @@ type NotificationData = {
 
 export type Api = (request: Request, con: GetSender) => Promise<any>;
 
+// GMExternalDependencies接口定义
+// 为了支持外部依赖注入，方便测试和扩展
+export interface IGMExternalDependencies {
+  emitEventToTab(to: ExtMessageSender, req: EmitEventRequest): void;
+}
+
+export class GMExternalDependencies implements IGMExternalDependencies {
+  constructor(private runtimeService: RuntimeService) {}
+
+  emitEventToTab(to: ExtMessageSender, req: EmitEventRequest): void {
+    this.runtimeService.emitEventToTab(to, req);
+  }
+}
+
+export class MockGMExternalDependencies implements IGMExternalDependencies {
+  emitEventToTab(to: ExtMessageSender, req: EmitEventRequest): void {
+    // Mock implementation for testing
+    console.log("Mock emitEventToTab called", { to, req });
+  }
+}
+
 export default class GMApi {
   logger: Logger;
 
@@ -128,7 +149,7 @@ export default class GMApi {
     private send: MessageSend,
     private mq: MessageQueue,
     private value: ValueService,
-    private runtime: RuntimeService
+    private gmExternalDependencies: IGMExternalDependencies
   ) {
     this.logger = LoggerCore.logger().with({ service: "runtime/gm_api" });
   }
@@ -889,7 +910,7 @@ export default class GMApi {
                 | NotificationData
                 | undefined;
               if (sender) {
-                this.runtime.emitEventToTab(sender.sender, {
+                this.gmExternalDependencies.emitEventToTab(sender.sender, {
                   event: "GM_notification",
                   eventId: notificationId,
                   uuid: sender.uuid,
@@ -1055,7 +1076,7 @@ export default class GMApi {
         | NotificationData
         | undefined;
       if (sender) {
-        this.runtime.emitEventToTab(sender.sender, {
+        this.gmExternalDependencies.emitEventToTab(sender.sender, {
           event: "GM_notification",
           eventId: notificationId,
           uuid: sender.uuid,
@@ -1143,7 +1164,7 @@ export default class GMApi {
         sender: ExtMessageSender;
       };
       if (sender) {
-        this.runtime.emitEventToTab(sender.sender, {
+        this.gmExternalDependencies.emitEventToTab(sender.sender, {
           event: "GM_openInTab",
           eventId: tabId.toString(),
           uuid: sender.uuid,

src/app/service/service_worker/index.ts

@@ -39,7 +39,7 @@ export default class ServiceWorkerManager {
 
     const resource = new ResourceService(this.api.group("resource"), this.mq);
     resource.init();
-    const value = new ValueService(this.api.group("value"), this.sender, this.mq);
+    const value = new ValueService(this.api.group("value"), this.mq);
     const script = new ScriptService(systemConfig, this.api.group("script"), this.mq, value, resource, scriptDAO);
     script.init();
     const runtime = new RuntimeService(

src/app/service/service_worker/runtime.ts

@@ -10,7 +10,7 @@ import {
   ScriptRunResouce,
 } from "@App/app/repo/scripts";
 import { ValueService } from "./value";
-import GMApi from "./gm_api";
+import GMApi, { GMExternalDependencies } from "./gm_api";
 import { subscribeScriptDelete, subscribeScriptEnable, subscribeScriptInstall } from "../queue";
 import { ScriptService } from "./script";
 import { runScript, stopScript } from "../offscreen/client";
@@ -75,7 +75,15 @@ export class RuntimeService {
   async init() {
     // 启动gm api
     const permission = new PermissionVerify(this.group.group("permission"), this.mq);
-    const gmApi = new GMApi(this.systemConfig, permission, this.group, this.sender, this.mq, this.value, this);
+    const gmApi = new GMApi(
+      this.systemConfig,
+      permission,
+      this.group,
+      this.sender,
+      this.mq,
+      this.value,
+      new GMExternalDependencies(this)
+    );
     permission.init();
     gmApi.start();