diff --git a/.gitignore b/.gitignore index 07726b1..4667f99 100644 --- a/.gitignore +++ b/.gitignore @@ -96,5 +96,7 @@ video_split/ # Chrome 插件打包产物(.crx / updates.xml,由 npm run extension:build 生成) extension/out/ +# Chrome 插件的压缩产物(npm run extension:bundle 生成,桌面安装包与 CRX 都用它) +extension/dist/ # 注意:extension/keys/key.pem **是入库的**(决定扩展 ID,丢了就换 ID)。 # 它绝不能随安装包发给客户 —— desktop/YuncangTrace.LocalService.csproj 已显式排除 keys\ 与 out\。 diff --git a/backend/README.md b/backend/README.md index bc278dd..4da24da 100644 --- a/backend/README.md +++ b/backend/README.md @@ -340,11 +340,17 @@ npm run desktop:publish -- --target=Msi # 只出 MSI(不发 EXE) ```bash cd backend -npm run extension:build # 只打包(dry-run),产物在 extension/out -npm run extension:publish # 打包 + 上传 + 刷新 nginx +npm run extension:bundle # 只压缩源码 → extension/dist(esbuild,体积约 1/3) +npm run extension:build # 压缩 + 打包(dry-run),产物在 extension/out +npm run extension:publish # 压缩 + 打包 + 上传 + 刷新 nginx +npm run extension:zip # 压缩 + 出商店上传包(extension/out/*.zip) npm run extension:publish -- --version=1.2.0 --skip-nginx ``` +- **打进去的是 `extension/dist`(压缩产物)**,不是源码:`build-extension.cjs` 用 esbuild 逐文件 minify + (不合并文件,`importScripts('lib/rules.js')` 与各处路径原样有效);桌面端 `build.ps1` 在 + `dotnet publish` 前也会自动跑一遍,csproj 打的同样是 `dist`; +- 只做 minify、不做混淆:MV3 的 CSP 禁止 `eval`/`new Function`,Chrome/Edge 商店也要求代码可读; - 用本机 Chrome/Edge 的 `--pack-extension` 打包(找不到浏览器时用 `--browser=<路径>` 指定); - 产物:`YuncangTraceExtension-.crx`、`updates.xml`、`extension-id.txt`; - 上传到 `deployRoot/download/extension/`;nginx 对 **`updates.xml` 关缓存**(浏览器靠它自动升级), diff --git a/backend/package-lock.json b/backend/package-lock.json index c8b8ebe..b23cec4 100644 --- a/backend/package-lock.json +++ b/backend/package-lock.json @@ -24,7 +24,8 @@ }, "devDependencies": { "egg-bin": "^6.13.0", - "egg-mock": "^5.15.2" + "egg-mock": "^5.15.2", + "esbuild": "^0.28.2" }, "engines": { "node": ">=18.0.0" @@ -205,6 +206,448 @@ "dev": true, "license": "MIT" }, + "node_modules/@esbuild/aix-ppc64": { + "version": "0.28.2", + "resolved": "https://registry.npmjs.org/@esbuild/aix-ppc64/-/aix-ppc64-0.28.2.tgz", + "integrity": "sha512-XExcO+dvLKvVtNTibSTBej1NCAbaGhWn9Ww1ZPx80qsahhPFe/8jgWP0IchNe0F3HwkU7n8ejhH8bjonqht8mQ==", + "cpu": [ + "ppc64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "aix" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/@esbuild/android-arm": { + "version": "0.28.2", + "resolved": "https://registry.npmjs.org/@esbuild/android-arm/-/android-arm-0.28.2.tgz", + "integrity": "sha512-kXXoiPVVGQcnIYGOeaovwOURpniDBpSq4A03qkQ+BMQqtGG6HYap3xne9C1O1yo4TR3qxlCX5IqqmX6fFo2Lqg==", + "cpu": [ + "arm" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "android" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/@esbuild/android-arm64": { + "version": "0.28.2", + "resolved": "https://registry.npmjs.org/@esbuild/android-arm64/-/android-arm64-0.28.2.tgz", + "integrity": "sha512-5YfKeeI8qWfBZIX+u2xZC3Zlb3Os/gLS2sbEKM+I4ZOcsWmHS2WLysCcQZDAFRslDUU5Oiq44gf6PYN1vGwG5A==", + "cpu": [ + "arm64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "android" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/@esbuild/android-x64": { + "version": "0.28.2", + "resolved": "https://registry.npmjs.org/@esbuild/android-x64/-/android-x64-0.28.2.tgz", + "integrity": "sha512-O387ite7SzUyCcy3JQX4P4bLtEA7bLLkx+esve5JHnyYfNTxcVpXZo9jhdB0lTKN44gztELTdU7nS8Nr16Fs1Q==", + "cpu": [ + "x64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "android" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/@esbuild/darwin-arm64": { + "version": "0.28.2", + "resolved": "https://registry.npmjs.org/@esbuild/darwin-arm64/-/darwin-arm64-0.28.2.tgz", + "integrity": "sha512-n4KqkOQrraxHJcgjM1RvwbigfQKIKJVpM7xp+KsxiyUSrRdIXnt73VhrPAx0fV44hgfmIVKjxMN9J1t5jySVkw==", + "cpu": [ + "arm64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "darwin" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/@esbuild/darwin-x64": { + "version": "0.28.2", + "resolved": "https://registry.npmjs.org/@esbuild/darwin-x64/-/darwin-x64-0.28.2.tgz", + "integrity": "sha512-uq6suIWYP37qzGddBKPw5QEQPi6HiLGsO7UmkpfyaYNQ3D+rN6w6WfwH+nuqcGXWvawGwxOEroO4YGnFh95azw==", + "cpu": [ + "x64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "darwin" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/@esbuild/freebsd-arm64": { + "version": "0.28.2", + "resolved": "https://registry.npmjs.org/@esbuild/freebsd-arm64/-/freebsd-arm64-0.28.2.tgz", + "integrity": "sha512-n+I0BTSRIoy+d6RPKnEVwql5UwBJolytvY4mAOIEJorKlqgPII8ix6slVVrfZ5Tnj7glIZvloylbB/EJPMWEXw==", + "cpu": [ + "arm64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "freebsd" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/@esbuild/freebsd-x64": { + "version": "0.28.2", + "resolved": "https://registry.npmjs.org/@esbuild/freebsd-x64/-/freebsd-x64-0.28.2.tgz", + "integrity": "sha512-78XJTJkvPs0kz2w61301PJjXl4g7q3JqiYMZ/M/yVI73EHBrCRTgkhu9oqG7vPqq+a/yadEW8aD+agKlk5xrmg==", + "cpu": [ + "x64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "freebsd" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/@esbuild/linux-arm": { + "version": "0.28.2", + "resolved": "https://registry.npmjs.org/@esbuild/linux-arm/-/linux-arm-0.28.2.tgz", + "integrity": "sha512-XlDnu2q5yoqems+xay6wSAcg9DDD7K9RLKZEBOMZm3ckNpJBvOX20tSfby8KfrrhINDyv9V2YVZKY/SpoGJI8w==", + "cpu": [ + "arm" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "linux" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/@esbuild/linux-arm64": { + "version": "0.28.2", + "resolved": "https://registry.npmjs.org/@esbuild/linux-arm64/-/linux-arm64-0.28.2.tgz", + "integrity": "sha512-pW4AC0P3it8c7do9MVM4p51FzHzdM/TZrerurgRcHJ2WTa1VQ1CIq18xncfpBJw4ojkiZZrKW2yIBWBP92j6Ug==", + "cpu": [ + "arm64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "linux" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/@esbuild/linux-ia32": { + "version": "0.28.2", + "resolved": "https://registry.npmjs.org/@esbuild/linux-ia32/-/linux-ia32-0.28.2.tgz", + "integrity": "sha512-CYbnj78HsIeA+DhgUKgFCfvNsTHFhMMrinUrMZpDXJXKN8T3XViTZ/+wtHeVxEWY8ewSzTFN+nRmSwO2tZaLUQ==", + "cpu": [ + "ia32" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "linux" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/@esbuild/linux-loong64": { + "version": "0.28.2", + "resolved": "https://registry.npmjs.org/@esbuild/linux-loong64/-/linux-loong64-0.28.2.tgz", + "integrity": "sha512-buwkd8nsph4R+ajRvw0qM5Hja/TXQow3ptzWO2EbG/cqcIkHloRrdlBtQlshyYGTNFvfkfJ5tpPLVkY4DtsPfQ==", + "cpu": [ + "loong64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "linux" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/@esbuild/linux-mips64el": { + "version": "0.28.2", + "resolved": "https://registry.npmjs.org/@esbuild/linux-mips64el/-/linux-mips64el-0.28.2.tgz", + "integrity": "sha512-ZVykbDyk7519VwiNb9Lcj9m8XM6v5V9uKPvrEMkkEedVewf+0itkhahp4HDpgERXhwLRpWFypsGbG/J8s0QjJA==", + "cpu": [ + "mips64el" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "linux" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/@esbuild/linux-ppc64": { + "version": "0.28.2", + "resolved": "https://registry.npmjs.org/@esbuild/linux-ppc64/-/linux-ppc64-0.28.2.tgz", + "integrity": "sha512-CAXl+Dtd9UUuJd8pKKdwh6MLm3MUMiqMPmhZ3tTSXPqfyQ3vDl6R5hZdZ/kYojK4ofXtdfSv1tFq8XzWx3heNQ==", + "cpu": [ + "ppc64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "linux" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/@esbuild/linux-riscv64": { + "version": "0.28.2", + "resolved": "https://registry.npmjs.org/@esbuild/linux-riscv64/-/linux-riscv64-0.28.2.tgz", + "integrity": "sha512-GeXCej4IQtU1B+QlDV8W/RRvbzI3O/Stss+/bCXv4lZls5WGRtu2a+3JkA3i4qIUlMXpcHebWpF8AkJhATowuA==", + "cpu": [ + "riscv64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "linux" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/@esbuild/linux-s390x": { + "version": "0.28.2", + "resolved": "https://registry.npmjs.org/@esbuild/linux-s390x/-/linux-s390x-0.28.2.tgz", + "integrity": "sha512-3H1weTYZPxt/WOhByszQZybS9w5lKzUn1FDMsgEChbHWQwHYQQRfBxgCcZvPhjHfKyJjIievvMmEUawJrdY9Dg==", + "cpu": [ + "s390x" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "linux" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/@esbuild/linux-x64": { + "version": "0.28.2", + "resolved": "https://registry.npmjs.org/@esbuild/linux-x64/-/linux-x64-0.28.2.tgz", + "integrity": "sha512-4xTZr1FUmSoQW4XIWmit3tzQrUTZM+N3P0XV8xROKYF50XfI7xeO90+1bZvNwxIufQ9hDQVRJH5YhgPVF8A/HQ==", + "cpu": [ + "x64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "linux" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/@esbuild/netbsd-arm64": { + "version": "0.28.2", + "resolved": "https://registry.npmjs.org/@esbuild/netbsd-arm64/-/netbsd-arm64-0.28.2.tgz", + "integrity": "sha512-sSATRjPeDBg3pdgHoQfoYBob11Kk1FGa9lui5RIHZCoCkJa9QKlvl3/vKz2usCmYYjs7ymJR/2Nnsqe+Hjt5nw==", + "cpu": [ + "arm64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "netbsd" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/@esbuild/netbsd-x64": { + "version": "0.28.2", + "resolved": "https://registry.npmjs.org/@esbuild/netbsd-x64/-/netbsd-x64-0.28.2.tgz", + "integrity": "sha512-lqnzCV+mM0gIADaKihiCg6ifgfU2L3h5E33rNQBN1Y4MaVGnzryzmvvf7UHxprpQdE8hpqLolJ9Rl+SkIRDpyw==", + "cpu": [ + "x64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "netbsd" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/@esbuild/openbsd-arm64": { + "version": "0.28.2", + "resolved": "https://registry.npmjs.org/@esbuild/openbsd-arm64/-/openbsd-arm64-0.28.2.tgz", + "integrity": "sha512-AL2qJILH7lNjrDmCQDvdxMfAUIv8KMNZOvrwAQ8i8//ntL9FflhOyMJ8OZSMBb8/AWXe3/5v5S20y3zCoZWKoQ==", + "cpu": [ + "arm64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "openbsd" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/@esbuild/openbsd-x64": { + "version": "0.28.2", + "resolved": "https://registry.npmjs.org/@esbuild/openbsd-x64/-/openbsd-x64-0.28.2.tgz", + "integrity": "sha512-QtiuPytchRyC4rwUKhexJdQKvDuZ6hWloi3igqPQNUJCS1/v9EiO3UTOXR6A3FoMo4fnAKbWJdqaIwhOzh8qEw==", + "cpu": [ + "x64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "openbsd" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/@esbuild/openharmony-arm64": { + "version": "0.28.2", + "resolved": "https://registry.npmjs.org/@esbuild/openharmony-arm64/-/openharmony-arm64-0.28.2.tgz", + "integrity": "sha512-WkhYDmpTjLvGlScA1rwjRUmhl4k8oXR3cIbtqWmELgU/dFeHHlEllxDvdWcNJV9rbzCexB5vz8gtNewWLgCT7Q==", + "cpu": [ + "arm64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "openharmony" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/@esbuild/sunos-x64": { + "version": "0.28.2", + "resolved": "https://registry.npmjs.org/@esbuild/sunos-x64/-/sunos-x64-0.28.2.tgz", + "integrity": "sha512-GPMSkTOtMnv2U2F8gxe4Io6qmVs+YKyp832Etqqxr0hFngmXQ3rzwytelm3GIn7T4VviRUlf3sOgBOiTdvaf7g==", + "cpu": [ + "x64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "sunos" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/@esbuild/win32-arm64": { + "version": "0.28.2", + "resolved": "https://registry.npmjs.org/@esbuild/win32-arm64/-/win32-arm64-0.28.2.tgz", + "integrity": "sha512-PIhhEkE9uPBleRBrQEJpUn7MBnibZzbGzYWPmY3x+YoVg/95zbjB4CxPPOQ8l5tYYM4mMaCthF8/1DIfBQQyWQ==", + "cpu": [ + "arm64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "win32" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/@esbuild/win32-ia32": { + "version": "0.28.2", + "resolved": "https://registry.npmjs.org/@esbuild/win32-ia32/-/win32-ia32-0.28.2.tgz", + "integrity": "sha512-YmJbfTlvU7Sdn9BB+4PRES4oB6pxgS37MAONj+hBr/cpXS1aBPKXxNnDbu+QCWPj0o9dgyxeq79g6c5P8KeuYA==", + "cpu": [ + "ia32" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "win32" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/@esbuild/win32-x64": { + "version": "0.28.2", + "resolved": "https://registry.npmjs.org/@esbuild/win32-x64/-/win32-x64-0.28.2.tgz", + "integrity": "sha512-5ebpxr3nWMzrL/rnUI755Jkuee0bHL/Gq0WTF9lvcpv73wAp5eu8MfBUgWK9bhWvZjj7yX8etf/8tI8Ney695g==", + "cpu": [ + "x64" + ], + "dev": true, + "license": "MIT", + "optional": true, + "os": [ + "win32" + ], + "engines": { + "node": ">=18" + } + }, "node_modules/@fastify/busboy": { "version": "2.1.1", "resolved": "https://registry.npmjs.org/@fastify/busboy/-/busboy-2.1.1.tgz", @@ -4169,6 +4612,48 @@ "node": ">= 0.4" } }, + "node_modules/esbuild": { + "version": "0.28.2", + "resolved": "https://registry.npmjs.org/esbuild/-/esbuild-0.28.2.tgz", + "integrity": "sha512-HKVLS8dvII+xoKW9kmqxbRKrnWEXfJJr/FZhhJmiqIB0e053QNYFqOBouTMO/k5sID4MvCiUCvv8b9M4h32wIA==", + "dev": true, + "hasInstallScript": true, + "license": "MIT", + "bin": { + "esbuild": "bin/esbuild" + }, + "engines": { + "node": ">=18" + }, + "optionalDependencies": { + "@esbuild/aix-ppc64": "0.28.2", + "@esbuild/android-arm": "0.28.2", + "@esbuild/android-arm64": "0.28.2", + "@esbuild/android-x64": "0.28.2", + "@esbuild/darwin-arm64": "0.28.2", + "@esbuild/darwin-x64": "0.28.2", + "@esbuild/freebsd-arm64": "0.28.2", + "@esbuild/freebsd-x64": "0.28.2", + "@esbuild/linux-arm": "0.28.2", + "@esbuild/linux-arm64": "0.28.2", + "@esbuild/linux-ia32": "0.28.2", + "@esbuild/linux-loong64": "0.28.2", + "@esbuild/linux-mips64el": "0.28.2", + "@esbuild/linux-ppc64": "0.28.2", + "@esbuild/linux-riscv64": "0.28.2", + "@esbuild/linux-s390x": "0.28.2", + "@esbuild/linux-x64": "0.28.2", + "@esbuild/netbsd-arm64": "0.28.2", + "@esbuild/netbsd-x64": "0.28.2", + "@esbuild/openbsd-arm64": "0.28.2", + "@esbuild/openbsd-x64": "0.28.2", + "@esbuild/openharmony-arm64": "0.28.2", + "@esbuild/sunos-x64": "0.28.2", + "@esbuild/win32-arm64": "0.28.2", + "@esbuild/win32-ia32": "0.28.2", + "@esbuild/win32-x64": "0.28.2" + } + }, "node_modules/escalade": { "version": "3.2.0", "resolved": "https://registry.npmjs.org/escalade/-/escalade-3.2.0.tgz", diff --git a/backend/package.json b/backend/package.json index c9e5e0f..440572f 100644 --- a/backend/package.json +++ b/backend/package.json @@ -23,7 +23,8 @@ }, "devDependencies": { "egg-bin": "^6.13.0", - "egg-mock": "^5.15.2" + "egg-mock": "^5.15.2", + "esbuild": "^0.28.2" }, "engines": { "node": ">=18.0.0" @@ -62,6 +63,7 @@ "version:history": "node ./scripts/deploy/version-history.cjs --limit=50", "desktop:build": "node ./scripts/deploy/publish-desktop.cjs production --dry-run", "desktop:publish": "node ./scripts/deploy/publish-desktop.cjs production", + "extension:bundle": "node ./scripts/deploy/build-extension.cjs", "extension:build": "node ./scripts/deploy/publish-extension.cjs production --dry-run", "extension:zip": "node ./scripts/deploy/publish-extension.cjs production --zip", "extension:publish": "node ./scripts/deploy/publish-extension.cjs production", diff --git a/backend/scripts/deploy/build-extension.cjs b/backend/scripts/deploy/build-extension.cjs new file mode 100644 index 0000000..043e086 --- /dev/null +++ b/backend/scripts/deploy/build-extension.cjs @@ -0,0 +1,148 @@ +'use strict'; + +/** + * 打包 Chrome 插件到 `extension/dist`(**只压缩,不混淆**) + * + * 为什么要这一步: + * - MV3 没有编译产物,浏览器直接执行明文 JS;桌面安装包把 `extension/` 整个装在 + * `<安装目录>\extension`,用户打开就能看到带注释的源码,也能随手改掉跳转地址; + * - 压缩(去注释、压空白、合并冗余)后体积约为源码的 1/3,逆向和篡改成本明显上升, + * 而且**不需要** eval / Function(MV3 的 CSP 禁止),符合 Chrome 商店「代码必须可读」的要求; + * - 真正需要保密的东西不在这里:识别前缀 / 正则 / 生效站点全部由服务端下发, + * 扩展 ID 的私钥 `extension/keys/key.pem` 也从不进包(见 csproj 的 Exclude)。 + * + * 产物目录结构**与源码一致**(manifest 里的路径不用改): + * dist/manifest.json 原样拷贝 + * dist/icons/… 原样拷贝 + * dist/src/… 的 .js 文件 esbuild 压缩 + * dist/src/… 的 .html / .css 原样拷贝(HTML 里引用的 js 路径不变) + * + * ⚠️ `background.js` 用 `importScripts('lib/rules.js')`、`content_scripts` 也各自按路径加载, + * 所以这里**不做 bundle**(不合并文件),只逐文件压缩 —— 语义零变化。 + * + * 用法: + * node scripts/deploy/build-extension.cjs + * npm run extension:bundle + */ + +const fs = require('node:fs'); +const path = require('node:path'); + +let esbuild; +try { + // devDependency:只在开发和发版机器上装(服务器跑的是已构建产物,不需要) + esbuild = require('esbuild'); +} catch { + throw new Error('缺少 esbuild:先执行 `cd backend && npm install`(它是 devDependency,压缩插件要用)'); +} + +const ROOT = __dirname; +const REPO_ROOT = path.resolve(ROOT, '..', '..', '..'); +const EXT_DIR = path.join(REPO_ROOT, 'extension'); +const OUT_DIR = path.join(EXT_DIR, 'dist'); + +/** 进包的内容(README / test / tools / keys / out / dist 自身都不进) */ +const INCLUDE = [ 'manifest.json', 'icons', 'src' ]; + +/** manifest 里声明的最低 Chrome 版本,压缩目标跟着它走 */ +const JS_TARGET = 'chrome96'; + +/** 递归列出目录下所有文件 */ +function walk(dir, files = []) { + for (const entry of fs.readdirSync(dir, { withFileTypes: true })) { + const full = path.join(dir, entry.name); + if (entry.isDirectory()) { + walk(full, files); + } else if (entry.isFile()) { + files.push(full); + } + } + return files; +} + +/** 压缩单个 js 文件 */ +async function minifyJs(from, to) { + const source = fs.readFileSync(from, 'utf8'); + const result = await esbuild.transform(source, { + loader: 'js', + target: JS_TARGET, + minify: true, + // 保留 'use strict' 等语义;去掉 @license 之类注释(我们的注释都是给人看的) + legalComments: 'none', + // 中文提示语保持原样(默认会转成 \uXXXX,体积更大) + charset: 'utf8', + }); + + fs.writeFileSync(to, result.code); + return { bytesBefore: Buffer.byteLength(source), bytesAfter: Buffer.byteLength(result.code) }; +} + +/** + * 生成 dist + * @param {{ log?: boolean }} [options] + * @returns {Promise>} + */ +async function build(options = {}) { + const log = options.log !== false; + + if (!fs.existsSync(path.join(EXT_DIR, 'manifest.json'))) { + throw new Error(`找不到扩展源码目录:${EXT_DIR}`); + } + + fs.rmSync(OUT_DIR, { recursive: true, force: true }); + fs.mkdirSync(OUT_DIR, { recursive: true }); + + const stats = []; + + for (const item of INCLUDE) { + const source = path.join(EXT_DIR, item); + if (!fs.existsSync(source)) { + throw new Error(`扩展缺少 ${item}:${source}`); + } + + if (!fs.statSync(source).isDirectory()) { + fs.copyFileSync(source, path.join(OUT_DIR, item)); + continue; + } + + for (const file of walk(source)) { + const relative = path.relative(EXT_DIR, file); + const target = path.join(OUT_DIR, relative); + fs.mkdirSync(path.dirname(target), { recursive: true }); + + if (path.extname(file).toLowerCase() === '.js') { + const result = await minifyJs(file, target); + stats.push({ file: relative.replace(/\\/g, '/'), ...result }); + } else { + fs.copyFileSync(file, target); + } + } + } + + if (log) { + const pad = Math.max(...stats.map(item => item.file.length), 8); + let before = 0; + let after = 0; + for (const item of stats) { + before += item.bytesBefore; + after += item.bytesAfter; + console.log( + ` ${item.file.padEnd(pad)} ${(item.bytesBefore / 1024).toFixed(1).padStart(6)} KB → ` + + `${(item.bytesAfter / 1024).toFixed(1).padStart(5)} KB`, + ); + } + console.log(` ${'合计'.padEnd(pad)} ${(before / 1024).toFixed(1).padStart(6)} KB → ${(after / 1024).toFixed(1).padStart(5)} KB`); + console.log(`插件已打包: ${path.relative(REPO_ROOT, OUT_DIR)}(${INCLUDE.join(' / ')})`); + } + + return stats; +} + +module.exports = { build, EXT_DIR, OUT_DIR, INCLUDE }; + +if (require.main === module) { + build().catch(err => { + console.error(`打包插件失败:${err.message}`); + process.exit(1); + }); +} diff --git a/backend/scripts/deploy/publish-extension.cjs b/backend/scripts/deploy/publish-extension.cjs index 901fc56..b802af2 100644 --- a/backend/scripts/deploy/publish-extension.cjs +++ b/backend/scripts/deploy/publish-extension.cjs @@ -42,15 +42,19 @@ const { runScp, runSsh, } = require('./deploy-lib.cjs'); +const { build: buildExtension } = require('./build-extension.cjs'); +const { zipDirectory } = require('./zip-util.cjs'); /** 仓库根(backend 的上一级) */ const REPO_ROOT = path.resolve(ROOT, '..'); const EXT_DIR = path.join(REPO_ROOT, 'extension'); +/** 正式包一律用压缩后的产物(`npm run extension:bundle` 生成,体积约为源码 1/3) */ +const DIST_DIR = path.join(EXT_DIR, 'dist'); const KEY_FILE = path.join(EXT_DIR, 'keys', 'key.pem'); const OUT_DIR = path.join(EXT_DIR, 'out'); const PACKAGE_NAME = 'YuncangTraceExtension'; -/** 打进 crx 的内容(其余 README/test/tools/out/keys 不进包) */ +/** 打进 crx 的内容(其余 README/test/tools/out/keys/dist 不进包) */ const INCLUDE = [ 'manifest.json', 'icons', 'src' ]; function parseArgs(argv) { @@ -127,8 +131,8 @@ function stageSources(workDir) { const target = path.join(workDir, PACKAGE_NAME); fs.mkdirSync(target, { recursive: true }); for (const name of INCLUDE) { - const from = path.join(EXT_DIR, name); - if (!fs.existsSync(from)) throw new Error(`扩展源码缺少:${from}`); + const from = path.join(DIST_DIR, name); + if (!fs.existsSync(from)) throw new Error(`插件打包产物缺少:${from}(先跑 npm run extension:bundle)`); fs.cpSync(from, path.join(target, name), { recursive: true }); } return target; @@ -204,7 +208,7 @@ function uploadFile(config, localPath, remoteDir, name, stamp) { ].join('\n')); } -function main() { +async function main() { const options = parseArgs(process.argv.slice(2)); const config = loadDeployConfig(options.envName); @@ -222,7 +226,8 @@ function main() { // 打包在临时目录里做,仓库里只留 out/ 产物 const workDir = fs.mkdtempSync(path.join(os.tmpdir(), 'yuncang-ext-')); try { - console.log(`打包 Chrome 插件 ${version}(${path.relative(REPO_ROOT, EXT_DIR)})`); + console.log(`打包 Chrome 插件 ${version}(${path.relative(REPO_ROOT, DIST_DIR)},已压缩)`); + await buildExtension({ log: true }); const srcDir = stageSources(workDir); // 商店上传用的是 zip(manifest.json 必须在压缩包根目录) @@ -231,10 +236,11 @@ function main() { const zipPath = path.join(OUT_DIR, zipName); fs.mkdirSync(OUT_DIR, { recursive: true }); fs.rmSync(zipPath, { force: true }); - runCommand('powershell.exe', [ - '-NoProfile', '-Command', - `Compress-Archive -Path '${path.join(srcDir, '*')}' -DestinationPath '${zipPath}' -Force`, - ], { stdio: 'inherit' }); + // 条目名一律 `/`(PowerShell 的 Compress-Archive 会写反斜杠,商店不认) + const result = zipDirectory(srcDir, zipPath); + + console.log(`商店上传包: ${zipPath}(${result.files} 个文件,${(result.bytes / 1024).toFixed(0)} KB)`); + return; console.log(`商店上传包: ${zipPath}(${(fs.statSync(zipPath).size / 1024).toFixed(0)} KB)`); return; @@ -289,4 +295,7 @@ function main() { } } -main(); +main().catch(err => { + console.error(err.message); + process.exit(1); +}); diff --git a/backend/scripts/deploy/zip-util.cjs b/backend/scripts/deploy/zip-util.cjs new file mode 100644 index 0000000..9ab8ead --- /dev/null +++ b/backend/scripts/deploy/zip-util.cjs @@ -0,0 +1,136 @@ +'use strict'; + +/** + * 极简 ZIP 打包(deflate,无第三方依赖) + * + * 为什么不用 PowerShell 的 `Compress-Archive` / `ZipFile::CreateFromDirectory`: + * - PowerShell 5.1(.NET Framework)写出来的条目名是**反斜杠**(`src\content.js`), + * 而 ZIP 规范要求 `/`,商店上传/解压工具会把它当成带 \ 的怪文件名; + * - 走 8.3 短路径(`C:\Users\LFMING~1\...`)时,`FullName.Substring($src.Length + 1)` + * 算出来的相对路径还会多一个前导 `/`,manifest.json 就不在根目录了。 + * + * 这里自己写:条目名一律 `/`、无前导斜杠、UTF-8 文件名、Deflate 压缩。 + * 只支持「单文件 < 4GB、总长 < 4GB」的普通包(插件包够用,不需要 ZIP64)。 + */ + +const fs = require('node:fs'); +const path = require('node:path'); +const zlib = require('node:zlib'); + +const CRC_TABLE = (() => { + const table = new Int32Array(256); + for (let index = 0; index < 256; index++) { + let value = index; + for (let bit = 0; bit < 8; bit++) { + value = value & 1 ? 0xedb88320 ^ (value >>> 1) : value >>> 1; + } + table[index] = value; + } + return table; +})(); + +function crc32(buffer) { + let crc = -1; + for (let index = 0; index < buffer.length; index++) { + crc = CRC_TABLE[(crc ^ buffer[index]) & 0xff] ^ (crc >>> 8); + } + return (crc ^ -1) >>> 0; +} + +/** 递归列出文件(返回相对路径,统一用 `/`) */ +function listFiles(dir, base = dir, files = []) { + for (const entry of fs.readdirSync(dir, { withFileTypes: true })) { + const full = path.join(dir, entry.name); + if (entry.isDirectory()) { + listFiles(full, base, files); + } else if (entry.isFile()) { + files.push({ full, name: path.relative(base, full).split(path.sep).join('/') }); + } + } + return files; +} + +/** 转成 DOS 时间(ZIP 头里是 1980 起的本地时间) */ +function toDosTime(date) { + const year = Math.max(date.getFullYear(), 1980); + return { + time: (date.getHours() << 11) | (date.getMinutes() << 5) | (date.getSeconds() >> 1), + date: ((year - 1980) << 9) | ((date.getMonth() + 1) << 5) | date.getDate(), + }; +} + +/** + * 把目录打成 zip + * @param {string} dir 源目录 + * @param {string} zipPath 目标 zip(不存在会自动创建父目录) + * @returns {{ files: number, bytes: number }} 条目数与压缩包大小 + */ +function zipDirectory(dir, zipPath) { + const files = listFiles(dir).sort((a, b) => a.name.localeCompare(b.name)); + + const localParts = []; + const centralParts = []; + let offset = 0; + + for (const file of files) { + const data = fs.readFileSync(file.full); + const deflated = zlib.deflateRawSync(data, { level: 9 }); + const name = Buffer.from(file.name, 'utf8'); + const crc = crc32(data); + const { time, date } = toDosTime(fs.statSync(file.full).mtime); + + const local = Buffer.alloc(30); + local.writeUInt32LE(0x04034b50, 0); // 局部文件头签名 + local.writeUInt16LE(20, 4); // 解压所需版本 + local.writeUInt16LE(0x0800, 6); // 文件名 UTF-8 + local.writeUInt16LE(8, 8); // Deflate + local.writeUInt16LE(time, 10); + local.writeUInt16LE(date, 12); + local.writeUInt32LE(crc, 14); + local.writeUInt32LE(deflated.length, 18); + local.writeUInt32LE(data.length, 22); + local.writeUInt16LE(name.length, 26); + local.writeUInt16LE(0, 28); // 无扩展字段 + localParts.push(local, name, deflated); + + const central = Buffer.alloc(46); + central.writeUInt32LE(0x02014b50, 0); // 中央目录签名 + central.writeUInt16LE(20, 4); // 打包者版本 + central.writeUInt16LE(20, 6); // 解压所需版本 + central.writeUInt16LE(0x0800, 8); // 文件名 UTF-8 + central.writeUInt16LE(8, 10); // Deflate + central.writeUInt16LE(time, 12); + central.writeUInt16LE(date, 14); + central.writeUInt32LE(crc, 16); + central.writeUInt32LE(deflated.length, 20); + central.writeUInt32LE(data.length, 24); + central.writeUInt16LE(name.length, 28); + central.writeUInt16LE(0, 30); // 扩展字段长度 + central.writeUInt16LE(0, 32); // 注释长度 + central.writeUInt16LE(0, 34); // 起始磁盘号 + central.writeUInt16LE(0, 36); // 内部属性 + central.writeUInt32LE(0, 38); // 外部属性 + central.writeUInt32LE(offset, 42); // 局部头偏移 + centralParts.push(central, name); + + offset += local.length + name.length + deflated.length; + } + + const centralBuffer = Buffer.concat(centralParts); + const end = Buffer.alloc(22); + end.writeUInt32LE(0x06054b50, 0); // 目录结束签名 + end.writeUInt16LE(0, 4); // 本磁盘号 + end.writeUInt16LE(0, 6); // 中央目录起始磁盘 + end.writeUInt16LE(files.length, 8); + end.writeUInt16LE(files.length, 10); + end.writeUInt32LE(centralBuffer.length, 12); + end.writeUInt32LE(offset, 16); + end.writeUInt16LE(0, 20); // 注释长度 + + fs.mkdirSync(path.dirname(zipPath), { recursive: true }); + fs.writeFileSync(zipPath, Buffer.concat([ ...localParts, centralBuffer, end ])); + + return { files: files.length, bytes: fs.statSync(zipPath).size }; +} + +module.exports = { zipDirectory }; diff --git a/desktop/YuncangTrace.LocalService.csproj b/desktop/YuncangTrace.LocalService.csproj index 77c10f9..b159395 100644 --- a/desktop/YuncangTrace.LocalService.csproj +++ b/desktop/YuncangTrace.LocalService.csproj @@ -98,16 +98,22 @@ - + extension\%(RecursiveDir)%(Filename)%(Extension) PreserveNewest PreserveNewest diff --git a/desktop/installer/build.ps1 b/desktop/installer/build.ps1 index 017cc06..174cd9f 100644 --- a/desktop/installer/build.ps1 +++ b/desktop/installer/build.ps1 @@ -1,18 +1,19 @@ -#requires -Version 5.1 +#requires -Version 5.1 <# .SYNOPSIS 打「云仓视频溯源软件」的安装包(MSI 和/或 EXE),并生成本机自动更新用的 version.json。 .DESCRIPTION 1. 按 -Environment 从 package.config.json 取该环境的域名(开发 / 生产); - 2. dotnet publish(自包含单文件,不依赖 .NET 运行时); - 3. wix build 生成 MSI;Inno Setup(ISCC)生成 EXE; - 4. 计算 MD5 → 写 version.json(version / downloadUrl / md5 / size / publishedAt / buildId; + 2. 打包 Chrome 插件:源码压缩到 extension\dist(esbuild,只压缩不混淆); + 3. dotnet publish(自包含单文件,不依赖 .NET 运行时;csproj 打的是 extension\dist); + 4. wix build 生成 MSI;Inno Setup(ISCC)生成 EXE; + 5. 计算 MD5 → 写 version.json(version / downloadUrl / md5 / size / publishedAt / buildId; EXE 版另有 downloadUrlExe / md5Exe / sizeExe); - 5. 把 version.json + 安装包复制到后端目录(安装包 → backend/app/public/download/desktop/、 + 6. 把 version.json + 安装包复制到后端目录(安装包 → backend/app/public/download/desktop/、 version.json → backend/app/public/version/desktop/),供软件启动时 GET /download/version.json 检测更新; - 6. 本地 out/ 与后端目录各只保留最近 keepVersions(默认 5)个安装包。 + 7. 本地 out/ 与后端目录各只保留最近 keepVersions(默认 5)个安装包。 .PARAMETER Environment Development(默认,连本机 7300)/ Production(用正式域名)。 @@ -87,6 +88,7 @@ if (-not (Get-Command $dotnetExe -ErrorAction SilentlyContinue)) { } $desktop = Split-Path -Parent $PSScriptRoot # desktop\ +$repoRoot = Split-Path -Parent $desktop # 仓库根(backend\ / extension\ 在这里) $project = Join-Path $desktop 'YuncangTrace.LocalService.csproj' $publishDir = Join-Path $desktop 'publish' $outDir = Join-Path $PSScriptRoot 'out' @@ -148,7 +150,16 @@ $buildMsi = $Target -ne 'Exe' $buildExe = $Target -ne 'Msi' Write-Host "安装包:$Target" -# ---------------- 3. 发布 ---------------- +# ---------------- 3. 插件打包(压缩源码 → extension\dist,csproj 打的是 dist) ---------------- +# 用 backend 的 node_modules 里的 esbuild;没装就明确报错,别静默打到上一次的旧 dist +$bundleScript = Join-Path $repoRoot 'backend\scripts\deploy\build-extension.cjs' +if (-not (Test-Path $bundleScript)) { throw "找不到插件打包脚本:$bundleScript" } +$nodeExe = (Get-Command node -ErrorAction SilentlyContinue).Source +if (-not $nodeExe) { throw "找不到 node,无法打包谷歌插件(先装 Node.js,再 cd backend; npm install)" } +& $nodeExe $bundleScript +if ($LASTEXITCODE -ne 0) { throw "插件打包失败($LASTEXITCODE):先 cd backend; npm install" } + +# ---------------- 4. 发布 ---------------- Push-Location $desktop try { & $dotnetExe publish $project -c Release -r win-x64 ` @@ -176,7 +187,7 @@ if (-not (Test-Path $ffmpeg)) { } Write-Host "ffmpeg:$([math]::Round((Get-Item $ffmpeg).Length / 1MB, 1)) MB" -# ---------------- 4. 打安装包 ---------------- +# ---------------- 5. 打安装包 ---------------- New-Item -ItemType Directory -Force -Path $outDir | Out-Null # 4a. MSI(WiX) @@ -235,7 +246,7 @@ if ($buildExe) { Write-Host "EXE:$([math]::Round((Get-Item $setupExe).Length / 1MB, 1)) MB" } -# ---------------- 5. version.json ---------------- +# ---------------- 6. version.json ---------------- $now = Get-Date $msiHash = $null @@ -284,7 +295,7 @@ $versionJson = $versionJson | ConvertTo-Json $versionFile = Join-Path $outDir 'version.json' Write-Utf8NoBom $versionFile $versionJson -# ---------------- 6. 复制到后端 ---------------- +# ---------------- 7. 复制到后端 ---------------- # MSI → app/public/download/desktop/(/download/desktop/xxx.msi,长缓存) # version.json → app/public/version/desktop/(/download/version.json 由路由提供,绝不能缓存) $skipVersionJson = $false @@ -343,7 +354,7 @@ else { Write-Host "(该环境 copyToServer=false,跳过复制到后端)" } -# ---------------- 7. 只保留最近 N 个安装包 ---------------- +# ---------------- 8. 只保留最近 N 个安装包 ---------------- function Remove-OldPackages([string]$dir, [int]$keep, [string]$pattern) { if (-not (Test-Path $dir)) { return } @@ -371,7 +382,7 @@ foreach ($pattern in @('YuncangTraceSetup-*.msi', 'YuncangTraceSetup-*.exe')) { if ($downloadDir) { Remove-OldPackages $downloadDir $Keep $pattern } } -# ---------------- 8. 摘要 ---------------- +# ---------------- 9. 摘要 ---------------- Write-Host "" if ($msi) { Write-Host "MSI:$msi" -ForegroundColor Green } if ($setupExe) { Write-Host "EXE:$setupExe" -ForegroundColor Green } diff --git a/extension/README.md b/extension/README.md index fce902d..f1e057c 100644 --- a/extension/README.md +++ b/extension/README.md @@ -41,10 +41,20 @@ Chrome / Edge 扩展(**Manifest V3 + 原生 JS,零构建**)。 ```powershell cd backend -npm run extension:build # 只打包(extension/out/ 下产出 .crx / updates.xml / extension-id.txt) -npm run extension:publish # 打包 + 上传到服务器 /download/extension/ + 刷新 nginx +npm run extension:bundle # 只压缩源码 → extension/dist(esbuild minify,去注释压空白,约 1/3 体积) +npm run extension:build # 压缩 + 打包(extension/out/ 下产出 .crx / updates.xml / extension-id.txt) +npm run extension:publish # 压缩 + 打包 + 上传到服务器 /download/extension/ + 刷新 nginx +npm run extension:zip # 压缩 + 出商店上传包(extension/out/*.zip,条目名是标准 `/`) ``` +**分发用的都是 `extension/dist`(压缩产物),开发调试仍用源码目录**: + +- `extension/` = 源码(带完整注释),`chrome://extensions`「加载已解压」时选这个目录; +- `extension/dist/` = 压缩产物(`dist/` 已 gitignore,随时可重新生成),桌面端安装包和 `.crx` 都只用它; +- 只做 minify、**不做混淆**:MV3 的 CSP 禁止 `eval`/`new Function`(`debugProtection` 之类直接报错), + 而且 Chrome/Edge 商店要求提交的代码可读;压缩后已经去掉全部注释、缩短了标识符, + 真正需要保密的东西也不在插件里(前缀/正则/站点全部由服务端下发,私钥从不进包)。 + - 私钥 `extension/keys/key.pem`(首次运行自动生成,**务必单独备份**):它决定**扩展 ID**, 换了私钥 = 换了 ID = 已经下发到客户机的策略全部失效; - 服务器上:`/download/extension/updates.xml`(**不缓存**,浏览器靠它自动升级)、 @@ -57,16 +67,16 @@ npm run extension:publish # 打包 + 上传到服务器 /download/extension/ 重启浏览器即自动装好(`chrome://extensions` 里显示「由你的组织管理」)。 「工具 → 卸载谷歌插件」只会删掉值里带 `/download/extension/` 的那几条,不动别的策略。 -没有管理员权限的机器仍可用「工具 → 复制插件路径(开发者模式)」手动加载。 +没有管理员权限的机器仍可用「工具 → 复制插件路径(开发者模式)」手动加载(拿到的是安装目录里的压缩版)。 ## 1. 安装 ### 客户机:从桌面端安装包直接加载(推荐) -桌面端安装包(MSI / EXE)已经把这个 `extension/` 目录一起装好,路径固定为 -`%LOCALAPPDATA%\Programs\YuncangTrace\extension`: +桌面端安装包(MSI / EXE)已经把插件的**压缩产物**装到固定路径 +`%LOCALAPPDATA%\Programs\YuncangTrace\extension`(源码、私钥都不进包): -1. 桌面端软件菜单「**工具 → 复制谷歌插件地址**」(复制的是 Windows 路径,可直接粘进选择框)。 +1. 桌面端软件菜单「**工具 → 复制插件路径(开发者模式)**」(复制的是 Windows 路径,可直接粘进选择框)。 2. 打开 `chrome://extensions`(Edge 是 `edge://extensions`)→ 右上角打开 **开发者模式**。 3. 点 **加载已解压的扩展程序**,把刚复制的路径粘进去。 4. 刷新一下已经打开的 WMS 页面(扩展只对**安装之后**加载的页面生效)。 @@ -93,14 +103,19 @@ extension/ │ ├── background.js # service worker:打开目标地址 + **每 5 分钟拉取服务器配置** │ ├── popup.html/.css/.js # 工具栏弹窗:配置版本、本页命中清单、重新扫描、立即同步 │ └── options.html/.js # ★ 只读状态页:同步状态 / 生效站点 / 前缀(不可编辑) +├── dist/ # 压缩产物(npm run extension:bundle 生成,不进仓库) ├── test/wms-mock.html # 自测页:按真实结构复刻的表格 └── tools/make-icons.ps1 # 生成图标(纯 ASCII,见文件头说明) ``` -**没有构建步骤**:`rules.js` 挂在 `globalThis.PSTRules` 上,content script / popup / options 各自 +**开发没有构建步骤**:`rules.js` 挂在 `globalThis.PSTRules` 上,content script / popup / options 各自 用 `