fix: 上传缓存目录不再污染仓库
miniprogram-ci 的 SummerCompiler 用 path.join("", md5(projectPath + "|summer"))
建编译缓存,得到的是相对路径,会创建在进程工作目录下。上传子进程此前继承
API 进程的工作目录,于是每次上传都在 apps/api 下留下一个 32 位十六进制空目录。
把上传子进程的工作目录固定到 MINIAPP_UPLOAD_WORKSPACE(默认系统临时目录),
缓存随之落在临时目录,仓库保持干净;projectPath 一直是绝对路径,行为不受影响。
用真实 ensureCacheDir 验证目录落在临时工作目录,并断言仓库内不再新增缓存目录。
This commit is contained in:
1 parent
ac3f433ee6
commit
53713e5935
4 files changed
+147
-41
No files matched your search
@@ -29,3 +29,5 @@ MINIAPP_CREDENTIAL_ENCRYPTION_KEY=replace-with-32-byte-random-secret
|
||||
# MINIAPP_API_PATH=/api
|
||||
# 单个品牌的 AppID 在后台“小程序上传配置”维护,这里只作为回落值
|
||||
# WEAPP_APP_ID=
|
||||
# 上传子进程工作目录;miniprogram-ci 的编译缓存放这里,默认系统临时目录
|
||||
# MINIAPP_UPLOAD_WORKSPACE=/tmp/personal-brand-miniapp-upload
|
||||
@@ -1,4 +1,7 @@
|
||||
import { spawn } from "node:child_process";
|
||||
import { mkdir } from "node:fs/promises";
|
||||
import os from "node:os";
|
||||
import path from "node:path";
|
||||
import { fileURLToPath } from "node:url";
|
||||
import {
|
||||
UPLOAD_RESULT_PREFIX,
|
||||
@@ -9,6 +12,17 @@ import {
|
||||
const RUNNER_PATH = fileURLToPath(new URL("./miniapp-upload-cli.js", import.meta.url));
|
||||
const DEFAULT_TIMEOUT_MS = 5 * 60 * 1000;
|
||||
|
||||
/**
|
||||
* miniprogram-ci 的 SummerCompiler 用 `path.join("", md5(projectPath|summer))`
|
||||
* 建缓存目录,这是相对路径,会落在子进程的工作目录下。若沿用 API 进程的工作目录
|
||||
* (通常是 `apps/api`),每次上传都会在仓库里留下一个 32 位十六进制目录。
|
||||
* 因此把上传进程的工作目录固定到系统临时目录。
|
||||
*/
|
||||
export function miniappUploadWorkspace(configured = process.env.MINIAPP_UPLOAD_WORKSPACE): string {
|
||||
const value = configured?.trim();
|
||||
return value ? path.resolve(value) : path.join(os.tmpdir(), "personal-brand-miniapp-upload");
|
||||
}
|
||||
|
||||
function parseOutcome(stdout: string): MiniAppUploadOutcome | null {
|
||||
const line = stdout
|
||||
.split("\n")
|
||||
@@ -30,48 +44,53 @@ export function runMiniAppUpload(
|
||||
request: MiniAppUploadRequest,
|
||||
timeoutMs = DEFAULT_TIMEOUT_MS,
|
||||
): Promise<Record<string, unknown>> {
|
||||
return new Promise((resolvePromise, rejectPromise) => {
|
||||
const child = spawn(process.execPath, [RUNNER_PATH], {
|
||||
stdio: ["pipe", "pipe", "pipe"],
|
||||
});
|
||||
let stdout = "";
|
||||
let stderr = "";
|
||||
let settled = false;
|
||||
const timer = setTimeout(() => {
|
||||
if (settled) return;
|
||||
settled = true;
|
||||
child.kill("SIGKILL");
|
||||
rejectPromise(new Error("微信代码上传超时,请稍后重试"));
|
||||
}, timeoutMs);
|
||||
const finish = (action: () => void) => {
|
||||
if (settled) return;
|
||||
settled = true;
|
||||
clearTimeout(timer);
|
||||
action();
|
||||
};
|
||||
const workspace = miniappUploadWorkspace();
|
||||
return mkdir(workspace, { recursive: true }).then(
|
||||
() =>
|
||||
new Promise<Record<string, unknown>>((resolvePromise, rejectPromise) => {
|
||||
const child = spawn(process.execPath, [RUNNER_PATH], {
|
||||
cwd: workspace,
|
||||
stdio: ["pipe", "pipe", "pipe"],
|
||||
});
|
||||
let stdout = "";
|
||||
let stderr = "";
|
||||
let settled = false;
|
||||
const timer = setTimeout(() => {
|
||||
if (settled) return;
|
||||
settled = true;
|
||||
child.kill("SIGKILL");
|
||||
rejectPromise(new Error("微信代码上传超时,请稍后重试"));
|
||||
}, timeoutMs);
|
||||
const finish = (action: () => void) => {
|
||||
if (settled) return;
|
||||
settled = true;
|
||||
clearTimeout(timer);
|
||||
action();
|
||||
};
|
||||
|
||||
child.stdout.on("data", (chunk: Buffer) => {
|
||||
stdout += chunk.toString();
|
||||
});
|
||||
child.stderr.on("data", (chunk: Buffer) => {
|
||||
stderr += chunk.toString();
|
||||
});
|
||||
child.on("error", () => finish(() => rejectPromise(new Error("微信上传进程启动失败"))));
|
||||
child.on("close", (code) =>
|
||||
finish(() => {
|
||||
const outcome = parseOutcome(stdout);
|
||||
if (outcome?.ok && outcome.result) return resolvePromise(outcome.result);
|
||||
const detail = outcome?.message ?? stderr.trim().split("\n").pop() ?? "";
|
||||
rejectPromise(
|
||||
new Error(
|
||||
detail
|
||||
? `微信代码上传失败:${detail}`
|
||||
: `微信代码上传失败(上传进程退出码 ${code ?? 1})`,
|
||||
),
|
||||
child.stdout.on("data", (chunk: Buffer) => {
|
||||
stdout += chunk.toString();
|
||||
});
|
||||
child.stderr.on("data", (chunk: Buffer) => {
|
||||
stderr += chunk.toString();
|
||||
});
|
||||
child.on("error", () => finish(() => rejectPromise(new Error("微信上传进程启动失败"))));
|
||||
child.on("close", (code) =>
|
||||
finish(() => {
|
||||
const outcome = parseOutcome(stdout);
|
||||
if (outcome?.ok && outcome.result) return resolvePromise(outcome.result);
|
||||
const detail = outcome?.message ?? stderr.trim().split("\n").pop() ?? "";
|
||||
rejectPromise(
|
||||
new Error(
|
||||
detail
|
||||
? `微信代码上传失败:${detail}`
|
||||
: `微信代码上传失败(上传进程退出码 ${code ?? 1})`,
|
||||
),
|
||||
);
|
||||
}),
|
||||
);
|
||||
child.stdin.on("error", () => undefined);
|
||||
child.stdin.end(JSON.stringify(request));
|
||||
}),
|
||||
);
|
||||
child.stdin.on("error", () => undefined);
|
||||
child.stdin.end(JSON.stringify(request));
|
||||
});
|
||||
);
|
||||
}
|
||||
@@ -0,0 +1,83 @@
|
||||
import assert from "node:assert/strict";
|
||||
import { existsSync, readdirSync, rmSync } from "node:fs";
|
||||
import { mkdir } from "node:fs/promises";
|
||||
import { createRequire } from "node:module";
|
||||
import os from "node:os";
|
||||
import path from "node:path";
|
||||
import { test } from "node:test";
|
||||
import { fileURLToPath } from "node:url";
|
||||
import { miniappUploadWorkspace, runMiniAppUpload } from "../src/modules/admin/miniapp-upload.js";
|
||||
|
||||
const repositoryRoot = fileURLToPath(new URL("../../..", import.meta.url));
|
||||
const hex32 = /^[0-9a-f]{32}$/;
|
||||
|
||||
function strayCacheDirectories(directory: string): string[] {
|
||||
return readdirSync(directory).filter((name) => hex32.test(name));
|
||||
}
|
||||
|
||||
test("上传工作目录位于系统临时目录,不会落在仓库内", () => {
|
||||
const workspace = miniappUploadWorkspace();
|
||||
assert.ok(workspace.startsWith(os.tmpdir()), workspace);
|
||||
assert.ok(!workspace.startsWith(repositoryRoot), workspace);
|
||||
assert.equal(miniappUploadWorkspace("relative/dir"), path.resolve("relative/dir"));
|
||||
});
|
||||
|
||||
test("miniprogram-ci 的相对路径缓存目录落在临时工作目录而不是仓库", async () => {
|
||||
const workspace = miniappUploadWorkspace();
|
||||
await mkdir(workspace, { recursive: true });
|
||||
const createSummer = createRequire(import.meta.url).resolve(
|
||||
"miniprogram-ci/dist/modules/createSummer.js",
|
||||
);
|
||||
const { summerCompilerFactory } = (await import(createSummer)) as {
|
||||
summerCompilerFactory: {
|
||||
project: unknown;
|
||||
ensureCacheDir: () => string;
|
||||
};
|
||||
};
|
||||
const projectPath = path.join(repositoryRoot, "apps/taro/dist/linjing-editorial/weapp");
|
||||
const before = strayCacheDirectories(path.join(repositoryRoot, "apps/api"));
|
||||
|
||||
// ensureCacheDir 用相对路径 mkdirSync,创建位置取决于进程工作目录,
|
||||
// 这里用真实实现验证:工作目录设为上传工作目录后,目录就落在临时目录里。
|
||||
const originalCwd = process.cwd();
|
||||
let created = "";
|
||||
try {
|
||||
summerCompilerFactory.project = { projectPath };
|
||||
process.chdir(workspace);
|
||||
created = summerCompilerFactory.ensureCacheDir();
|
||||
} finally {
|
||||
process.chdir(originalCwd);
|
||||
}
|
||||
|
||||
try {
|
||||
assert.match(created, hex32);
|
||||
assert.ok(existsSync(path.join(workspace, created)));
|
||||
assert.deepEqual(
|
||||
strayCacheDirectories(path.join(repositoryRoot, "apps/api")),
|
||||
before,
|
||||
"仓库内不应新增 miniprogram-ci 缓存目录",
|
||||
);
|
||||
} finally {
|
||||
if (created) rmSync(path.join(workspace, created), { recursive: true, force: true });
|
||||
}
|
||||
});
|
||||
|
||||
test("上传会在临时工作目录下启动,失败也不会在仓库留下目录", async () => {
|
||||
const workspace = miniappUploadWorkspace();
|
||||
const before = strayCacheDirectories(path.join(repositoryRoot, "apps/api"));
|
||||
await assert.rejects(() =>
|
||||
runMiniAppUpload(
|
||||
{
|
||||
projectPath: path.join(repositoryRoot, "apps/taro/dist/linjing-editorial/weapp"),
|
||||
appid: "wxtest",
|
||||
privateKey: "not-a-pem",
|
||||
version: "1",
|
||||
desc: "test",
|
||||
robot: 1,
|
||||
},
|
||||
30_000,
|
||||
),
|
||||
);
|
||||
assert.ok(existsSync(workspace));
|
||||
assert.deepEqual(strayCacheDirectories(path.join(repositoryRoot, "apps/api")), before);
|
||||
});
|
||||
@@ -159,6 +159,8 @@ pnpm deploy:verify
|
||||
|
||||
微信代码上传在独立子进程中执行,`miniprogram-ci` 崩溃或超时不会影响 API 服务。任务若停在 `building` 超过 `MINIAPP_BUILD_STALE_MS`(默认 15 分钟)没有进度更新,会被视为中断并允许重新发起上传。
|
||||
|
||||
上传子进程的工作目录固定为 `MINIAPP_UPLOAD_WORKSPACE`(默认 `os.tmpdir()/personal-brand-miniapp-upload`)。`miniprogram-ci` 的 SummerCompiler 用 `path.join("", md5(projectPath + "|summer"))` 建缓存目录,这是相对路径,若沿用 API 进程的工作目录就会在仓库里留下 32 位十六进制目录;把工作目录放到系统临时目录后,该缓存落在临时目录内,仓库保持干净。
|
||||
|
||||
`API_BASE_URL` 与 AppID 是**编译期常量**,构建时写入小程序包,无法在后台热改。上传前按以下顺序解析并校验,任一项不合法就直接拒绝构建,避免把指向 `localhost` 的包上传到微信:
|
||||
|
||||
- 请求地址:后台「配置与发布 → 小程序上传配置」里的“小程序请求地址”优先;未配置时回落到 `MINIAPP_API_BASE_URL`,再回落到 `PUBLIC_BASE_URL` 加 `MINIAPP_API_PATH`(默认 `/api`)。非 `https` 的公网地址会被拒绝。因此换域名只需在后台改这一项并重新上传代码,不用改服务端环境变量。
|
||||
|
||||
Reference in new issue
Block a user