@taole/deploy-helper 1.0.0-beta.6 → 1.0.1

package/lib/login.mjs

@@ -0,0 +1,167 @@
+import { log } from "./util.mjs";
+import path from "path";
+import os from "os";
+import fs from "fs";
+import { exec } from "child_process";
+import { promisify } from "util";
+
+const execAsync = promisify(exec);
+const isDev = false;
+/**
+ * 保存本地用户登录状态的缓存文件
+ */
+const cacheFilePath = path.join(os.homedir(), ".tw-cli-userinfo-cache.json");
+let host =
+  "https://fapi.tuwan.com";
+if (isDev) {
+  host = "https://local-h5-plat.tuwan.com";
+}
+const devHost = "http://localhost:9000";
+let CREATE_SESSION_URL = `${host}/api/login/createLoginSession`;
+
+export async function getCache() {
+  try {
+    if (fs.existsSync(cacheFilePath)) {
+      const cacheStr = fs.readFileSync(cacheFilePath, "utf8");
+      const cache = JSON.parse(cacheStr);
+      const Tuwan_Passport = cache.Tuwan_Passport;
+      if (Tuwan_Passport) {
+        // 检查Tuwan_Passport是否还有效
+        const res = await fetch(
+          "https://yapi.tuwan.com/User/getUid?format=json",
+          {
+            headers: {
+              Cookie: `Tuwan_Passport=${Tuwan_Passport}`,
+            },
+          }
+        );
+        //log("getCache res", res);
+        const uidResp = await res.json();
+        //log("getCache uidResp", uidResp);
+        if (
+          uidResp &&
+          uidResp.error === 0 &&
+          uidResp.data &&
+          uidResp.data.uid === cache.userInfo.uid
+        ) {
+          return cache;
+        } else {
+          log("验证本地缓存失败, 已清理本地缓存");
+        }
+      }
+    }
+    clearCache();
+    return null;
+  } catch (error) {
+    console.error("获取缓存失败:", error);
+    clearCache();
+    return null;
+  }
+}
+
+function setCache(data) {
+  fs.writeFileSync(cacheFilePath, JSON.stringify(data));
+}
+
+function clearCache() {
+  if (fs.existsSync(cacheFilePath)) {
+    fs.unlinkSync(cacheFilePath);
+  }
+}
+
+async function openBrowser(url) {
+  const platform = process.platform;
+  if (platform === "win32") {
+    await execAsync(`start "" "${url}"`);
+  } else if (platform === "darwin") {
+    await execAsync(`open "${url}"`);
+  } else {
+    await execAsync(`xdg-open "${url}"`);
+  }
+}
+
+async function createLoginSession() {
+  let url = CREATE_SESSION_URL;
+  if (isDev) {
+    url = url.replace(host, devHost);
+  }
+  const res = await fetch(url, {
+    method: "POST",
+    headers: { "Content-Type": "application/json" },
+  });
+  if (!res.ok) {
+    throw new Error(`创建登录会话失败: ${res.status} ${res.statusText}`);
+  }
+  return res.json();
+}
+
+async function queryLoginResult(
+  doneUrl,
+  intervalMs = 2000,
+  timeoutMs = 120000
+) {
+  const start = Date.now();
+  if (isDev) {
+    doneUrl = doneUrl.replace(host, devHost);
+  }
+  while (Date.now() - start < timeoutMs) {
+    const res = await fetch(doneUrl, {
+      method: "POST",
+      headers: { "Content-Type": "application/json" },
+    });
+    //log("queryLoginResult res", res);
+    if (!res.ok) {
+      throw new Error(`轮询登录结果失败: ${res.status} ${res.statusText}`);
+    }
+    const data = await res.json();
+    //log("queryLoginResult data", JSON.stringify(data, null, 2));
+    let loginResult = data.loginResult;
+    if (loginResult && data.status === "success") {
+      return JSON.parse(loginResult);
+    }
+    await new Promise((resolve) => setTimeout(resolve, intervalMs));
+  }
+  throw new Error("登录超时，请重试");
+}
+
+export async function cmdLogin() {
+  const cache = await getCache();
+  if (cache && cache.userInfo && cache.userInfo.uid) {
+    log(
+      `已登录账号: ${cache.userInfo.nickname}(${cache.userInfo.uid}), 若需登录其他账号请先登出`
+    );
+    return;
+  }
+  log("正在创建登录会话...");
+  const { openUrl, doneUrl } = await createLoginSession();
+  log("请在浏览器中完成登录:", openUrl);
+
+  log("正在打开浏览器...");
+  await openBrowser(openUrl);
+
+  log("等待登录结果...");
+  const result = await queryLoginResult(doneUrl);
+  log(`${result.userInfo.nickname}(${result.userInfo.uid})登录成功`);
+  setCache(result);
+}
+
+export async function cmdWhoami() {
+  const cache = await getCache();
+  const userInfo = cache?.userInfo;
+  if (!userInfo || !userInfo.uid) {
+    log("当前未登录");
+    return;
+  }
+  log(`当前登录账号: ${userInfo.nickname}(${userInfo.uid})`);
+}
+
+export async function cmdLogout() {
+  const cache = await getCache();
+  const userInfo = cache?.userInfo;
+  if (!userInfo || !userInfo.uid) {
+    log("当前未登录");
+    return;
+  }
+  clearCache();
+  log("已退出登录");
+}

package/lib/offlinePkg.mjs

@@ -0,0 +1,314 @@
+import fs from 'fs';
+import archiver from 'archiver';
+import { join } from "node:path"
+import { log, getOssToken, getUserDeployHelperConfig } from './util.mjs';
+import { uploadFile } from './upload.js';
+import md5File from 'md5-file';
+
+
+
+function genArchive(outputPath, dir) {
+    return new Promise((resolve, reject) => {
+        const output = fs.createWriteStream(outputPath);
+        const archive = archiver('zip', {
+            zlib: { level: 1 } // Sets the compression level.
+        });
+        archive.on('error', reject);
+        archive.on("finish", resolve);
+        archive.pipe(output);
+        archive.directory(dir, false);
+        archive.finalize();
+    })
+}
+
+/**
+ * json配置
+ * @param {string} workDir 项目工作目录
+ * @returns {Object|null} 配置
+ */
+export function getJsonConfig(workDir, name) {
+    const filePath = join(workDir, name);
+    if (fs.existsSync(filePath)) {
+        try {
+            return JSON.parse(fs.readFileSync(filePath, "utf-8"));
+        } catch (_error) {
+            // pass
+        }
+    }
+    return null;
+}
+
+/**
+ * 同步离线包列表到api
+ * @param {{offlineApi: {get: string, set: string}}} userDeployHelperConfig 用户配置
+ * @param {"prod"|"test"} mode 部署模式 prod: 线上, test: 测试
+ * @param {{name: string, remove: boolean}} offlineConfig 离线包配置
+ * @param {any} packageDescJson 离线包描述json
+ */
+export async function syncApi(userDeployHelperConfig, mode, offlineConfig, packageDescJson) {
+    // 根据部署模式，决定更新调用哪个接口
+    const doAction = offlineConfig.remove ? "remove" : "add";
+    const apiDomain = mode === "prod" ? "https://yapi.tuwan.com" : "https://yapi-test.tuwan.com";
+    const getPath = userDeployHelperConfig.offlineApi.get;
+    const setPath = userDeployHelperConfig.offlineApi.set;
+    const getUrl = `${apiDomain}${getPath}`;
+    const setUrl = `${apiDomain}${setPath}`;
+    const envPrefix = `${mode === "prod" ? "线上环境" : "测试环境"}[platform=${offlineConfig.platform}]`;
+    const nowRes = await fetch(getUrl, {
+        headers: {
+            platform: String(offlineConfig.platform),
+        }
+    });
+    const nowData = await nowRes.json();
+    let needSetData = true;
+    let finalJsonData = null;
+    if (!nowData || nowData.error !== 0) {
+        throw new Error(`获取离线包列表失败, 获取离线包当前配置失败: ${nowData.error_msg || "未知错误"}`);
+    }
+    const jsonData = JSON.parse(nowData.data.json || "{}");
+    finalJsonData = jsonData;
+    jsonData.packages = jsonData.packages || [];
+    if (doAction === "add") {
+        const idx = jsonData.packages.findIndex(item => item.name === offlineConfig.name);
+        if (idx !== -1) {
+            log(`离线包${offlineConfig.name}已存在, 更新离线包`);
+            jsonData.packages[idx] = packageDescJson;
+        } else {
+            log(`离线包${offlineConfig.name}不存在, 添加离线包`);
+            jsonData.packages.push(packageDescJson);
+        }
+    } else {
+        const idx = jsonData.packages.findIndex(item => item.name === offlineConfig.name);
+        if (idx === -1) {
+            log(`离线包${offlineConfig.name}不存在, 无需删除`);
+            needSetData = false;
+        }
+        jsonData.packages = jsonData.packages.filter(item => item.name !== offlineConfig.name);
+    }
+    jsonData.packages = jsonData.packages.filter(item => item.name);
+    if (needSetData) {
+        // console.log('jsonData', jsonData);
+        var formdata = new FormData();
+        formdata.append("json", JSON.stringify(jsonData));
+        const setRes = await fetch(setUrl, {
+            method: "POST",
+            body: formdata,
+            headers: {
+                platform: String(offlineConfig.platform),
+            }
+        });
+        const setData = await setRes.json();
+        if (!setData || setData.error !== 0) {
+            throw new Error(`更新离线包列表失败, 更新离线包当前配置失败: ${setData.error_msg || "未知错误"}`);
+        }
+        log(`${envPrefix}离线包列表更新完成: ${JSON.stringify(setData)}`);
+        // 再次获取列表，确保更新成功
+        const nowRes2 = await fetch(getUrl, {
+            headers: {
+                platform: String(offlineConfig.platform),
+            }
+        });
+        const nowData2 = await nowRes2.json();
+        if (!nowData2 || nowData2.error !== 0) {
+            throw new Error(`再次获取离线包列表失败, 获取离线包当前配置失败: ${nowData2.error_msg || "未知错误"}`);
+        }
+        finalJsonData = JSON.parse(nowData2.data.json || "{}");
+    }
+
+    const packages = finalJsonData.packages || [];
+    console.log(`${envPrefix}当前离线包列表:`, packages.map(item => ({ ...item, items: '省略' + item.items.length + '个条目' })));
+}
+
+/**
+ * @deprecated 不再需要这个函数, 如果插件使用的是@taole/vite-plugin-dynamic-base, 则不需要这个函数
+ * hack
+ * 由于vite-plugin-dynamic-base插件和legacy插件同时使用, 生存的入口文件中代码有点问题,这里直接修改有问题的代码
+ */
+function fixEntryHtml(config, offlineConfig) {
+    if (!offlineConfig || !config) return;
+    const entryHtmlPath = join(config.workDir, offlineConfig.distDir, "index.html");
+    if (!fs.existsSync(entryHtmlPath)) {
+        throw new Error(`构建产物${entryHtmlPath}不存在`);
+    }
+    const markLine = "} else if (item.tagName == 'script') {";
+    const replaceLine = `} else if (item.tagName == 'script')/*injected by deploy-helper*/{
+if(item.attrs.id=='vite-legacy-polyfill')childNode.onload=function(){System.import(window.__dynamic_base__ + document.getElementById('vite-legacy-entry').getAttribute('data-src'))};
+`;
+    let entryHtml = fs.readFileSync(entryHtmlPath, "utf-8");
+    entryHtml = entryHtml.replace(markLine, replaceLine);
+    fs.writeFileSync(entryHtmlPath, entryHtml);
+}
+
+/**
+ * @typedef {Object} CheckOfflinePkgResult
+ * @property {string} workDir 工作目录
+ * @property {boolean} canBuild 是否可以构建离线包
+ * @property {string} errorMsg 错误信息
+ * @property {function} hookPostBuild 构建后钩子
+ * @property {function} hookPostDeployTest 部署到测试环境后钩子
+ * @property {function} hookPostDeployProd 部署到生产环境后钩子
+ */
+
+/**
+ * 在项目构建好之后，将项目打包成离线包，并上传到指定服务器
+ * @param {Object} config 配置
+ * @param {string} config.workDir 工作目录
+ * @param {"prod"|"test"} config.mode 部署模式
+ * @returns {CheckOfflinePkgResult} 结果
+ */
+export function checkOfflinePkg(config) {
+    let canBuildOfflinePkg = true;
+    let errorMsg = "";
+    const offlineConfig = getJsonConfig(config.workDir, "offline.config.json");
+    if (offlineConfig) {
+        offlineConfig.distDir = offlineConfig.distDir || "dist";
+        offlineConfig.platform = offlineConfig.platform || 3; // 3,4是点点
+    }
+    const packageJson = getJsonConfig(config.workDir, "package.json");
+    const userDeployHelperConfig = getUserDeployHelperConfig();
+    const distPath = join(config.workDir, offlineConfig && offlineConfig.distDir ? offlineConfig.distDir : "dist");
+    const allDeps = {
+        ...packageJson.devDependencies,
+        ...packageJson.dependencies,
+    };
+    const useOldPDB = !!allDeps['vite-plugin-dynamic-base'];
+
+    // 如果offlineConfig.remove为true，则不构建离线包
+    const willRemovePkg = offlineConfig && offlineConfig.name && offlineConfig.remove === true && offlineConfig.skip !== true;
+    const willSkip = !offlineConfig || !offlineConfig.name || offlineConfig.skip === true || (offlineConfig.onlyTest === true && config.mode === "prod");
+    if (willRemovePkg) {
+        return {
+            canBuild: true,
+            errorMsg: "",
+            hookPostBuild: async () => {
+                if (useOldPDB) {
+                    fixEntryHtml(config, offlineConfig);
+                }
+                log(`开始删除离线包${offlineConfig.name}`);
+                await syncApi(userDeployHelperConfig, config.mode, offlineConfig, null);
+            }
+        }
+    }
+    if (!fs.existsSync(distPath)) {
+        errorMsg = `构建产物${distPath}不存在, 请先构建项目`;
+        canBuildOfflinePkg = false;
+    } else if (offlineConfig && !offlineConfig.name) {
+        errorMsg = "离线包配置文件中未配置name, 请先配置";
+        canBuildOfflinePkg = false;
+    } else if (!userDeployHelperConfig || !userDeployHelperConfig.offlineApi || !userDeployHelperConfig.offlineApi.get || !userDeployHelperConfig.offlineApi.set) {
+        errorMsg = "未配置离线包接口, 请移步看配置文档: https://alidocs.dingtalk.com/i/nodes/R1zknDm0WRkbz13oHn0LDz3ZVBQEx5rG?doc_type=wiki_doc";
+        canBuildOfflinePkg = false;
+    } else if (!packageJson) {
+        errorMsg = "啊没有package.json?";
+        canBuildOfflinePkg = false;
+    } else {
+        if (!allDeps['vite-plugin-dynamic-base'] && !allDeps['@taole/vite-plugin-dynamic-base']) {
+            errorMsg = "检查到项目中未安装依赖@taole/vite-plugin-dynamic-base, 请先安装依赖并调整构建代码以支持离线化，相关文档：https://alidocs.dingtalk.com/i/nodes/ydxXB52LJqexwD71F9K5XNMrJqjMp697?doc_type=wiki_doc";
+            canBuildOfflinePkg = false;
+        }
+    }
+    if (willSkip) {
+        if (!offlineConfig) {
+            return {
+                canBuild: false,
+                errorMsg: ""
+            }
+        }
+        if (offlineConfig.onlyTest === true && config.mode === "prod") {
+            console.log(`离线包${offlineConfig.name}只用于测试环境, 跳过构建线上环境的离线包构建`);
+        }
+        return {
+            canBuild: true,
+            errorMsg: "",
+            hookPostBuild: async () => {
+                if (useOldPDB) {
+                    fixEntryHtml(config, offlineConfig);
+                }
+            }
+        }
+    }
+    let ossToken = "";
+    if (canBuildOfflinePkg) {
+        ossToken = getOssToken();
+        if (!ossToken) {
+            errorMsg = "获取ossToken失败";
+            canBuildOfflinePkg = false;
+        }
+    }
+    if (!canBuildOfflinePkg) {
+        return {
+            canBuild: false,
+            errorMsg: errorMsg
+        }
+    }
+    const hookPostBuild = async () => {
+        if (!offlineConfig || !config) return;
+        // 在构建完成后，执行一些操作
+        if (useOldPDB) {
+            fixEntryHtml(config, offlineConfig);
+        }
+        // 开始进行打包流程
+        const offlinePkgDir = join(config.workDir, "./offlinepkgDist");
+        if (fs.existsSync(offlinePkgDir)) {
+            fs.rmSync(offlinePkgDir, { recursive: true });
+        } else {
+            fs.mkdirSync(offlinePkgDir, { recursive: true });
+        }
+
+        const packageDir = join(offlinePkgDir, "./package");
+        fs.mkdirSync(packageDir, { recursive: true });
+        // cp dist到offlinepkgDist目录下
+        fs.cpSync(join(config.workDir, offlineConfig.distDir), join(packageDir, offlineConfig.distDir), { recursive: true });
+
+        const targetArchive = join(offlinePkgDir, `./${packageJson.version}.zip`);
+        await genArchive(targetArchive, packageDir);
+        log(`离线包zip包打包完成: ${targetArchive}`);
+
+        const packageDescJson = { // 包描述json，之后会通过接口更新
+            name: offlineConfig.name,
+            version: packageJson.version,
+            md5: "",
+            packageUrl: "",
+            items: [],
+            updateTime: String(Math.floor(Date.now() / 1000)),
+            cacheTime: offlineConfig.cacheTime || "7200",
+            isLazy: offlineConfig.isLazy || 0,
+            openType: offlineConfig.openType || "file",
+        };
+        Object.keys(offlineConfig.entry || {}).forEach(key => {
+            const val = offlineConfig.entry[key];
+            let vals = [];
+            if (typeof val === 'string') {
+                vals.push(val);
+            } else if (Array.isArray(val)) {
+                vals = val;
+            }
+            vals.forEach(v => {
+                packageDescJson.items.push({
+                    "path": key,
+                    "mimeType": "text/html",
+                    "remoteUrl": v,
+                    "isEntrance": 1
+                });
+            });
+        });
+        packageDescJson.md5 = await md5File(targetArchive);
+        const uploadResult = await uploadFile(ossToken, targetArchive, packageDescJson.md5);
+        packageDescJson.packageUrl = uploadResult.url;
+        fs.writeFileSync(join(offlinePkgDir, "./offline.package.json"), JSON.stringify(packageDescJson, null, 2));
+        log(`离线包描述json写入完成: ${join(offlinePkgDir, "./offline.package.json")}`);
+
+        if (config.mode !== "prod") {
+            packageDescJson.items.forEach(item => {
+                item.remoteUrl = item.remoteUrl.replace("https://y.tuwan.com", "https://y-test.tuwan.com");
+            });
+        }
+        await syncApi(userDeployHelperConfig, config.mode, offlineConfig, packageDescJson);
+    }
+    return {
+        canBuild: canBuildOfflinePkg,
+        errorMsg: errorMsg,
+        hookPostBuild: hookPostBuild,
+    }
+}
+