👷 优化ci构建与同步目录

Author: CodFrm

.github/workflows/build.yaml

@@ -11,20 +11,12 @@ jobs:
     runs-on: ubuntu-latest
     name: Build
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
       - name: Use Node.js
-        uses: actions/setup-node@v1
+        uses: actions/setup-node@v3
         with:
-          node-version: '16.x'
-
-      - name: Cache Node.js modules
-        uses: actions/cache@v2
-        with:
-          path: ~/.npm 
-          key: ${{ runner.OS }}-node-${{ hashFiles('**/package-lock.json') }}
-          restore-keys: |
-            ${{ runner.OS }}-node-
-            ${{ runner.OS }}-
+          node-version: 16
+          cache: 'npm'
 
       - name: Package with Node
         env:

.github/workflows/packageRelease.yml

@@ -11,20 +11,12 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
       - name: Use Node.js
-        uses: actions/setup-node@v1
+        uses: actions/setup-node@v3
         with:
-          node-version: "16.x"
-
-      - name: Cache Node.js modules
-        uses: actions/cache@v2
-        with:
-          path: ~/.npm
-          key: ${{ runner.OS }}-node-${{ hashFiles('**/package-lock.json') }}
-          restore-keys: |
-            ${{ runner.OS }}-node-
-            ${{ runner.OS }}-
+          node-version: 16
+          cache: 'npm'
 
       - name: Package with Node
         env:

.github/workflows/test.yaml

@@ -12,20 +12,12 @@ jobs:
     runs-on: ubuntu-latest
     name: Run tests
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
       - name: Use Node.js
-        uses: actions/setup-node@v1
+        uses: actions/setup-node@v3
         with:
-          node-version: "16.x"
-
-      - name: Cache Node.js modules
-        uses: actions/cache@v2
-        with:
-          path: ~/.npm
-          key: ${{ runner.OS }}-node-${{ hashFiles('**/package-lock.json') }}
-          restore-keys: |
-            ${{ runner.OS }}-node-
-            ${{ runner.OS }}-
+          node-version: 16
+          cache: 'npm'
 
       - name: Unit Test
         run: |

pkg/chrome-extension-mock/index.ts

@@ -4,6 +4,7 @@ import Notifications from "./notifications";
 import Runtime from "./runtime";
 import MockTab from "./tab";
 import WebRequest from "./web_reqeuest";
+import Storage from "./storage";
 
 const chromeMock = {
   tabs: new MockTab(),
@@ -12,6 +13,7 @@ const chromeMock = {
   notifications: new Notifications(),
   downloads: new Downloads(),
   cookies: new Cookies(),
+  storage: new Storage(),
 };
 // @ts-ignore
 global.chrome = chromeMock;

pkg/chrome-extension-mock/storage.ts

@@ -0,0 +1,10 @@
+export default class Storage {
+  sync = {
+    get(callback: (data: any) => void) {
+      callback({});
+    },
+    set() {},
+  };
+
+  local = {};
+}

pkg/filesystem/filesystem.ts

@@ -31,8 +31,12 @@ export default interface FileSystem {
   verify(): Promise<void>;
   // 打开文件
   open(path: string): Promise<FileReader>;
+  // 打开目录
+  openDir(path: string): Promise<FileSystem>;
   // 创建文件
   create(path: string): Promise<FileWriter>;
+  // 创建目录
+  createDir(dir: string): Promise<void>;
   // 删除文件
   delete(path: string): Promise<void>;
   // 文件列表

pkg/filesystem/webdav/webdav.ts

@@ -5,17 +5,24 @@ import { WebDAVFileReader, WebDAVFileWriter } from "./rw";
 export default class WebDAVFileSystem implements FileSystem {
   client: WebDAVClient;
 
+  basePath: string = "";
+
   constructor(
-    authType: AuthType,
-    url: string,
-    username: string,
-    password: string
+    authType: AuthType | WebDAVClient,
+    url?: string,
+    username?: string,
+    password?: string
   ) {
-    this.client = createClient(url, {
-      authType,
-      username,
-      password,
-    });
+    if (typeof authType === "object") {
+      this.client = authType;
+      this.basePath = url || "";
+    } else {
+      this.client = createClient(url!, {
+        authType,
+        username,
+        password,
+      });
+    }
   }
 
   async verify(): Promise<void> {
@@ -24,20 +31,39 @@ export default class WebDAVFileSystem implements FileSystem {
   }
 
   open(path: string): Promise<FileReader> {
-    return Promise.resolve(new WebDAVFileReader(this.client, path));
+    return Promise.resolve(
+      new WebDAVFileReader(this.client, this.getPath(path))
+    );
+  }
+
+  openDir(path: string): Promise<FileSystem> {
+    if (!path.endsWith("/")) {
+      path += "/";
+    }
+    return Promise.resolve(new WebDAVFileSystem(this.client, path));
   }
 
   create(path: string): Promise<FileWriter> {
-    return Promise.resolve(new WebDAVFileWriter(this.client, path));
+    return Promise.resolve(
+      new WebDAVFileWriter(this.client, this.getPath(path))
+    );
+  }
+
+  createDir(path: string): Promise<void> {
+    return this.client.createDirectory(this.getPath(path));
   }
 
   async delete(path: string): Promise<void> {
-    return this.client.deleteFile(path);
+    return this.client.deleteFile(this.getPath(path));
+  }
+
+  getPath(path: string): string {
+    return this.basePath + path;
   }
 
   async list(path?: string | undefined): Promise<File[]> {
     const dir = (await this.client.getDirectoryContents(
-      path || ""
+      this.getPath(path || "")
     )) as FileStat[];
     const ret: File[] = [];
     dir.forEach((item: FileStat) => {

pkg/filesystem/zip/zip.ts

@@ -9,9 +9,12 @@ import { ZipFileReader, ZipFileWriter } from "./rw";
 export default class ZipFileSystem implements FileSystem {
   zip: JSZip;
 
+  basePath: string;
+
   // zip为空时，创建一个空的zip
-  constructor(zip?: JSZip) {
+  constructor(zip?: JSZip, basePath?: string) {
     this.zip = zip || new JSZip();
+    this.basePath = basePath || "";
   }
 
   verify(): Promise<void> {
@@ -26,10 +29,18 @@ export default class ZipFileSystem implements FileSystem {
     return Promise.reject(new Error("File not found"));
   }
 
+  openDir(path: string): Promise<FileSystem> {
+    return Promise.resolve(new ZipFileSystem(this.zip, path));
+  }
+
   create(path: string): Promise<FileWriter> {
     return Promise.resolve(new ZipFileWriter(this.zip, path));
   }
 
+  createDir(): Promise<void> {
+    return Promise.resolve();
+  }
+
   delete(path: string): Promise<void> {
     this.zip.remove(path);
     return Promise.resolve();

src/app/service/script/event.ts

@@ -4,7 +4,6 @@ import CacheKey from "@App/pkg/utils/cache_key";
 import Cache from "../../cache";
 import {
   Script,
-  SCRIPT_RUN_STATUS_COMPLETE,
   SCRIPT_STATUS_DISABLE,
   SCRIPT_STATUS_ENABLE,
   ScriptDAO,

src/app/service/synchronize/event.ts

@@ -98,12 +98,14 @@ export default class SynchronizeEventListener {
     await this.manager.backup(fs);
     this.logger.info("backup to cloud");
     // 然后创建云端文件系统
-    const cloudFs = await FileSystemFactory.create(type, params);
-    // 云端文件系统写入文件
-    const file = await cloudFs.create(
-      `scriptcat-backup-${dayjs().format("YYYY-MM-DDTHH-mm-ss")}.zip`
-    );
+    let cloudFs = await FileSystemFactory.create(type, params);
     try {
+      await cloudFs.createDir("ScriptCat");
+      cloudFs = await cloudFs.openDir("ScriptCat");
+      // 云端文件系统写入文件
+      const file = await cloudFs.create(
+        `scriptcat-backup-${dayjs().format("YYYY-MM-DDTHH-mm-ss")}.zip`
+      );
       await file.write(
         await zip.generateAsync({
           type: "blob",

src/app/service/synchronize/manager.ts

@@ -106,6 +106,10 @@ export default class SynchronizeManager extends Manager {
         config.filesystem,
         config.params[config.filesystem]
       );
+      // 创建base目录
+      await fs.createDir("ScriptCat");
+      await fs.createDir("ScriptCat/sync");
+      fs = await fs.openDir("ScriptCat/sync");
     } catch (e) {
       logger.error("create filesystem error", Logger.E(e), {
         type: config.filesystem,

src/pages/components/ScriptMenuList/index.tsx

@@ -1,7 +1,7 @@
 import React, { useEffect, useState } from "react";
 import MessageInternal from "@App/app/message/internal";
 import { MessageSender } from "@App/app/message/message";
-import { ScriptMenu, ScriptMenuItem } from "@App/runtime/background/runtime";
+import { ScriptMenu } from "@App/runtime/background/runtime";
 import {
   Button,
   Collapse,

src/pages/options/routes/Setting.tsx

@@ -1,12 +1,5 @@
 import React, { useState } from "react";
-import {
-  Button,
-  Card,
-  Checkbox,
-  Message,
-  Select,
-  Space,
-} from "@arco-design/web-react";
+import { Button, Card, Checkbox, Message, Space } from "@arco-design/web-react";
 import FileSystemParams from "@App/pages/components/FileSystemParams";
 import { SystemConfig } from "@App/pkg/config/config";
 import IoC from "@App/app/ioc";

src/pages/options/routes/Tools.tsx

@@ -117,13 +117,22 @@ function Tools() {
               <Button
                 type="primary"
                 onClick={async () => {
-                  const fs = await FileSystemFactory.create(
+                  let fs = await FileSystemFactory.create(
                     fileSystemType,
                     fileSystemParams
                   );
-                  const list = await fs.list();
-                  list.sort((a, b) => b.updatetime - a.updatetime);
-                  setBackupFileList(list);
+                  try {
+                    fs = await fs.openDir("ScriptCat");
+                    const list = await fs.list();
+                    list.sort((a, b) => b.updatetime - a.updatetime);
+                    if (list.length === 0) {
+                      Message.info("没有备份文件");
+                      return;
+                    }
+                    setBackupFileList(list);
+                  } catch (e) {
+                    Message.error(`获取备份文件失败: ${e}`);
+                  }
                 }}
               >
                 备份列表

src/runtime/background/runtime.ts

@@ -6,7 +6,6 @@ import Logger from "@App/app/logger/logger";
 import {
   Script,
   SCRIPT_RUN_STATUS,
-  SCRIPT_RUN_STATUS_RUNNING,
   SCRIPT_STATUS_ENABLE,
   SCRIPT_TYPE_NORMAL,
   ScriptDAO,
@@ -241,22 +240,19 @@ export default class Runtime extends Manager {
       runningScript.delete(script.id);
     });
 
-    Runtime.hook.addListener(
-      "runStatus",
-      async (scriptId: number, status: SCRIPT_RUN_STATUS) => {
-        const script = await this.scriptDAO.findById(scriptId);
-        if (!script) {
-          return;
-        }
-        if (script.status !== SCRIPT_STATUS_ENABLE) {
-          // 没开启并且不是运行中的脚本,删除
-          runningScript.delete(scriptId);
-        } else {
-          // 否则进行一次更新
-          runningScript.set(scriptId, script);
-        }
+    Runtime.hook.addListener("runStatus", async (scriptId: number) => {
+      const script = await this.scriptDAO.findById(scriptId);
+      if (!script) {
+        return;
       }
-    );
+      if (script.status !== SCRIPT_STATUS_ENABLE) {
+        // 没开启并且不是运行中的脚本,删除
+        runningScript.delete(scriptId);
+      } else {
+        // 否则进行一次更新
+        runningScript.set(scriptId, script);
+      }
+    });
 
     // 给popup页面获取运行脚本,与菜单
     this.message.setHandler(