yj-deploy 0.0.4 → 0.0.6

package/README.md

@@ -86,7 +86,9 @@ const deploy = new yjDeploy({
 
   parallelFile: 50, // 文件并行上传数量，如果在上传文件阶段报错，可以减少此配置
 
-  allLog: false // 是否打印所有log信息，主要是包含推送镜像阶段的日志，如果报错可以打开此开关
+  allLog: false, // 是否打印所有log信息，主要是包含推送镜像阶段的日志，如果报错可以打开此开关
+
+  lazyUpload: false // 是否开启懒上传，针对小程序图片等仅需要部署新增部分文件的项目有奇效
 }
 ```
 
@@ -236,6 +238,16 @@ node uploader.js --tmpName=test
 ### --allLog
 `--allLog` ：是否打印所有log信息，主要是包含推送镜像阶段的日志，如果报错可以打开此开关
 
+<br />
+
+### --lazyUpload
+`--lazyUpload` ：是否开启懒上传，如果开启，则不会上传全部文件，仅上传新增的文件。针对小程序图片等仅需要部署新增部分文件的项目有奇效
+
+::: warning
+如果小程序修改了相同路径和文件名的文件，会存在无法判断的情况（使用hash值能判断，但是成本过高），这种情况请关掉此选项，或使用 --reset 重置项目
+:::
+
+
 <br />
 
 # 最后
@@ -243,4 +255,18 @@ node uploader.js --tmpName=test
 
 <br />
 
-项目已提交到git：https://gitlab.yunjingtech.cn:10010/frontend/yj-deploy
+项目已提交到git：https://gitlab.yunjingtech.cn:10010/frontend/yj-deploy
+
+## 升级日志
+
+### v0.0.6
+  支持懒上传文件，大幅提升上传速度
+
+### v0.0.5
+  兼容根据运维文档手动创建的脚本推送镜像
+
+### v0.0.4
+  解决因为并行上传文件太多导致上传失败的问题，支持动态配置并行上传数据量
+  
+### v0.0.3
+  解决文件夹嵌套太深，可能会导致上传文件时文件夹还没有创建导致报错的问题

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "yj-deploy",
-  "version": "0.0.4",
+  "version": "0.0.6",
   "description": "ssh sftp",
   "scripts": {
     "build": "vite build"

package/dist/yj-deploy.mjs

@@ -1,304 +0,0 @@
-var L = Object.defineProperty;
-var v = (f, e, t) => e in f ? L(f, e, { enumerable: !0, configurable: !0, writable: !0, value: t }) : f[e] = t;
-var y = (f, e, t) => (v(f, typeof e != "symbol" ? e + "" : e, t), t);
-const { stdout: x } = require("single-line-log"), F = require("path"), b = require("fs"), { Client: A } = require("ssh2");
-module.exports = class {
-  constructor(e) {
-    y(this, "config", {
-      host: "",
-      port: "",
-      username: "",
-      password: "",
-      namespace: "",
-      // 项目命名空间，等同于镜像地址目录名称
-      imageStore: "dev-images",
-      // 镜像仓库
-      tmpName: "dev",
-      // 镜像环境
-      delay: 0,
-      // 延迟上传时间
-      // 本地文件目录(必填)
-      fileDir: "",
-      // 远程sftp服务根目录
-      rootDir: "/home/yjweb",
-      // dockerfile文件信息
-      dockerfile: {
-        name: "Dockerfile",
-        content: [
-          "FROM harbor.yunjingtech.cn:30002/yj-base/nginx:latest",
-          "RUN rm -rf /usr/share/nginx/html/*",
-          "COPY dist /usr/share/nginx/html/"
-        ]
-      },
-      // upload.sh文件信息
-      upload: {
-        name: "upload.sh",
-        content: [
-          "#!/bin/sh",
-          "tag=`basename \\`pwd\\``:$2-`date +%Y%m%d`",
-          'echo "- 镜像仓库: $1"',
-          'echo "- 镜像环境: $2"',
-          "docker build -t harbor.yunjingtech.cn:30002/$1/$tag .",
-          "docker push harbor.yunjingtech.cn:30002/$1/$tag",
-          "echo - 镜像地址: harbor.yunjingtech.cn:30002/$1/$tag"
-        ]
-      },
-      // 上传dist目录信息
-      dist: {
-        name: "dist"
-      },
-      parallelDir: 20,
-      // 文件夹并行创建数量，如果报错，可以减少此配置
-      parallelFile: 50,
-      // 文件并行上传数量，如果报错，可以减少此配置
-      allLog: !1
-      // 是否显示全部日志
-    });
-    y(this, "ssh2Conn", null);
-    // 上传状态
-    y(this, "uploading", !1);
-    // 定时器
-    y(this, "trim", null);
-    return this.config = Object.assign(this.config, e), {
-      name: "yj-deploy",
-      isPut: this.isPut.bind(this),
-      upload: this.upload.bind(this),
-      // webpack钩子
-      apply: this.apply.bind(this),
-      // vite上传钩子
-      closeBundle: this.isPut.bind(this)
-    };
-  }
-  // webpack钩子
-  apply(e) {
-    return e && e.hooks && e.hooks.done && e.hooks.done.tap("yj-deploy", () => {
-      this.isPut();
-    }), "build";
-  }
-  /**
-   * 判断是否需要上传，
-   * vite和 webpack环境在每次编译完都会触发当前方法
-   * 需要通过是否有命令行参数 --deploy
-   */
-  isPut() {
-    this.getArgv("--deploy") != null && (clearTimeout(this.trim), this.trim = setTimeout(() => {
-      this.upload();
-    }, this.config.delay || 0));
-  }
-  /**
-   * 连接跳板机并开始上传
-   */
-  upload() {
-    if (console.log("-------------- deploy-start --------------"), !this.config.host) {
-      console.log("- 请配置跳板机地址 host");
-      return;
-    }
-    if (!this.config.port) {
-      console.log("- 请配置跳板机端口 port");
-      return;
-    }
-    if (!this.config.username) {
-      console.log("- 请配置跳板机账号 username");
-      return;
-    }
-    if (!this.config.password) {
-      console.log("- 请配置跳板机密码 password");
-      return;
-    }
-    this.uploading || (this.ssh2Conn = new A(), this.ssh2Conn.on("ready", () => {
-      console.log("- 跳板机连接成功！"), this.ssh2Conn.sftp(async (e, t) => {
-        e && (console.log("- sftp连接失败"), this.breakConnect()), this.config.namespace || (console.log("- 请配置项目命名空间 namespace"), this.breakConnect()), this.uploading = !0, this.getArgv("--reset") !== void 0 && (console.log("- 重置项目"), await this.onShell(`rm -r ${this.config.rootDir}/${this.config.namespace}`)), this.upLoadProject(t, `${this.config.rootDir}/${this.config.namespace}`);
-      });
-    }).connect({
-      host: this.config.host,
-      port: this.config.port,
-      username: this.config.username,
-      password: this.config.password
-    }), this.ssh2Conn.on("error", (e) => {
-      console.log(`- 连接失败: ${e}`), this.breakConnect();
-    }), this.ssh2Conn.on("end", () => {
-      this.uploading = !1;
-    }));
-  }
-  /**
-   * 断开连接
-   */
-  breakConnect() {
-    this.uploading = !1, console.log("- 已断开连接"), console.log("-------------- deploy-end --------------"), this.ssh2Conn.end();
-  }
-  /**
-   * 运行shell命令
-   * @param {*} shell 
-   * @returns Promise
-   */
-  onShell(e) {
-    const t = this.getArgv("--allLog") !== void 0;
-    return new Promise((n, s) => {
-      this.ssh2Conn.shell((i, a) => {
-        if (i) {
-          console.log("- 远程命令错误：" + i, e), this.breakConnect(), s(i);
-          return;
-        }
-        let l = [];
-        a.on("close", () => {
-          n(l.toString());
-        }).on("data", (c) => {
-          let r = c.toString();
-          (t || this.config.allLog || r.startsWith("- ")) && l.push(`
-` + r);
-        }).stderr.on("data", (c) => {
-          console.log(`- 远程命令错误：
-` + c), this.breakConnect(), s(c);
-        }), a.end(e + `
-exit
-`);
-      });
-    });
-  }
-  /**
-   * 初始化项目
-   * @param {*} sftp 
-   * @param {*} dir 
-   */
-  projectInit(e, t) {
-    return new Promise(async (n, s) => {
-      e.mkdir(t, async (i) => {
-        if (i)
-          s(i);
-        else {
-          console.log("- 正在创建dockerfile");
-          const a = `${t}/${this.config.dockerfile.name}`;
-          await this.onShell(`touch ${a}`), await this.onShell(`echo '${this.config.dockerfile.content.join(`
-`)}' > ${a}`), console.log("- 正在创建upload.sh");
-          const l = `${t}/${this.config.upload.name}`;
-          await this.onShell(`touch ${l}`), await this.onShell(`echo '${this.config.upload.content.join(`
-`)}' > ${l}`), n();
-        }
-      });
-    });
-  }
-  /**
-   * 上传项目
-   * @param {*} sftp 
-   * @param {*} dir 
-   */
-  upLoadProject(e, t) {
-    e.readdir(t, async (n) => {
-      if (n) {
-        console.log("- 跳板机不存在项目, 开始创建项目"), this.projectInit(e, t).then(() => {
-          console.log(`- ${this.config.namespace}项目创建成功`), this.upLoadProject(e, t);
-        }).catch((o) => {
-          console.log(`- 创建项目失败: ${o}`), this.breakConnect();
-        });
-        return;
-      }
-      const s = `${t}/${this.config.dist.name}`;
-      if (await this.onShell(`rm -rf ${s}`), await this.onShell(`mkdir ${s}`), !this.config.fileDir) {
-        console.log("- 请配置待上传文件目录 fileDir"), this.breakConnect();
-        return;
-      }
-      const { localFileList: i, dirList: a } = await this.getFilesInDirectory(this.config.fileDir);
-      if (i.length === 0) {
-        console.log("- 待上传目录没有获取到文件，请检查"), this.breakConnect();
-        return;
-      }
-      let l = 0, c = i.length;
-      const r = (o) => new Promise((u, g) => {
-        try {
-          const h = b.createReadStream(o.localPath), w = e.createWriteStream(`${s}${o.remotePath}`);
-          w.on("close", () => {
-            this.progressBar(++l, c), u();
-          }), w.on("error", (S) => {
-            console.log(`- 文件 ${o.remotePath} 上传失败：${S}`), g(S), this.breakConnect();
-          }), h.pipe(w);
-        } catch (h) {
-          g(h);
-        }
-      }), P = (o, u) => {
-        let g = [];
-        for (let h = 0; h < o.length; h += u)
-          g.push(o.slice(h, h + u));
-        return g;
-      }, m = (o) => {
-        if (o.length === 0)
-          return Promise.resolve();
-        const u = o.shift();
-        return Promise.all(u.map((g) => r(g))).then(() => m(o));
-      }, d = (o) => {
-        if (o.length === 0)
-          return Promise.resolve();
-        let g = o.shift().map((h) => `${s}${h}`).join(" ");
-        return this.onShell(`mkdir -p ${g}`).then(() => d(o));
-      };
-      let $ = [...P(a, this.config.parallelDir || 20)];
-      console.log("- 开始创建目录"), await d($), console.log("- 创建目录完成"), await new Promise((o) => {
-        setTimeout(() => {
-          o();
-        }, 500);
-      });
-      let k = [...P(i, this.config.parallelFile || 50)];
-      console.log("- 开始上传文件"), await m(k), console.log("- 文件上传成功"), console.log("- 开始推送镜像");
-      let p = `cd ${t} && sh ${this.config.upload.name}`;
-      const C = this.getArgv("--imageStore") || this.config.imageStore;
-      p += ` ${C}`;
-      const j = this.getArgv("--tmpName") || this.config.tmpName;
-      p += ` ${j}`;
-      const D = await this.onShell(p);
-      console.log(D), console.log("- 镜像推送完成"), this.breakConnect();
-    });
-  }
-  /**
-   * 进度条
-   * @param description 命令行开头的文字信息
-   * @param bar_length 进度条的长度(单位：字符)，默认设为 25
-   */
-  progressBar(e, t, n = 25) {
-    let s = (e / t).toFixed(4), i = Math.floor(s * n), a = "";
-    for (let r = 0; r < i; r++)
-      a += "█";
-    let l = "";
-    for (let r = 0; r < n - i; r++)
-      l += "░";
-    let c = `- 文件上传进度: ${a}${l} (${e}/${t}) ${(100 * s).toFixed(2)}%`;
-    x(c), e == t && console.log("");
-  }
-  /**
-   * 获取目录下所有文件并分类
-   * @param {*} dir 
-   */
-  getFilesInDirectory(e) {
-    const t = [], n = [];
-    return new Promise((s, i) => {
-      const a = (l, c, r) => {
-        const P = b.readdirSync(l);
-        let m = !1;
-        P.forEach((d) => {
-          const $ = F.join(l, d), p = b.statSync($).isDirectory();
-          p ? m = !0 : t.push({
-            localPath: $,
-            // 本地路径
-            remotePath: `${c}${d}`,
-            // 远程路径
-            level: r
-            // 文件或目录层级
-          }), p && a($, `${c}${d}/`, r + 1);
-        }), m || n.push(c);
-      };
-      a(e, "/", 0), s({
-        localFileList: t,
-        dirList: n
-      });
-    });
-  }
-  /**
-   * 获取命令行参数
-   * @param { string } name
-   */
-  getArgv(e) {
-    const t = process.argv;
-    let n;
-    return t.forEach((s) => {
-      s.indexOf(e) > -1 && (n = s.split("=")[1] || "");
-    }), n;
-  }
-};

package/dist/yj-deploy.umd.js

@@ -1,7 +0,0 @@
-(function(h){typeof define=="function"&&define.amd?define(h):h()})(function(){"use strict";var x=Object.defineProperty;var F=(h,u,f)=>u in h?x(h,u,{enumerable:!0,configurable:!0,writable:!0,value:f}):h[u]=f;var w=(h,u,f)=>(F(h,typeof u!="symbol"?u+"":u,f),f);const{stdout:h}=require("single-line-log"),u=require("path"),f=require("fs"),{Client:j}=require("ssh2");module.exports=class{constructor(e){w(this,"config",{host:"",port:"",username:"",password:"",namespace:"",imageStore:"dev-images",tmpName:"dev",delay:0,fileDir:"",rootDir:"/home/yjweb",dockerfile:{name:"Dockerfile",content:["FROM harbor.yunjingtech.cn:30002/yj-base/nginx:latest","RUN rm -rf /usr/share/nginx/html/*","COPY dist /usr/share/nginx/html/"]},upload:{name:"upload.sh",content:["#!/bin/sh","tag=`basename \\`pwd\\``:$2-`date +%Y%m%d`",'echo "- 镜像仓库: $1"','echo "- 镜像环境: $2"',"docker build -t harbor.yunjingtech.cn:30002/$1/$tag .","docker push harbor.yunjingtech.cn:30002/$1/$tag","echo - 镜像地址: harbor.yunjingtech.cn:30002/$1/$tag"]},dist:{name:"dist"},parallelDir:20,parallelFile:50,allLog:!1});w(this,"ssh2Conn",null);w(this,"uploading",!1);w(this,"trim",null);return this.config=Object.assign(this.config,e),{name:"yj-deploy",isPut:this.isPut.bind(this),upload:this.upload.bind(this),apply:this.apply.bind(this),closeBundle:this.isPut.bind(this)}}apply(e){return e&&e.hooks&&e.hooks.done&&e.hooks.done.tap("yj-deploy",()=>{this.isPut()}),"build"}isPut(){this.getArgv("--deploy")!=null&&(clearTimeout(this.trim),this.trim=setTimeout(()=>{this.upload()},this.config.delay||0))}upload(){if(console.log("-------------- deploy-start --------------"),!this.config.host){console.log("- 请配置跳板机地址 host");return}if(!this.config.port){console.log("- 请配置跳板机端口 port");return}if(!this.config.username){console.log("- 请配置跳板机账号 username");return}if(!this.config.password){console.log("- 请配置跳板机密码 password");return}this.uploading||(this.ssh2Conn=new j,this.ssh2Conn.on("ready",()=>{console.log("- 跳板机连接成功！"),this.ssh2Conn.sftp(async(e,t)=>{e&&(console.log("- sftp连接失败"),this.breakConnect()),this.config.namespace||(console.log("- 请配置项目命名空间 namespace"),this.breakConnect()),this.uploading=!0,this.getArgv("--reset")!==void 0&&(console.log("- 重置项目"),await this.onShell(`rm -r ${this.config.rootDir}/${this.config.namespace}`)),this.upLoadProject(t,`${this.config.rootDir}/${this.config.namespace}`)})}).connect({host:this.config.host,port:this.config.port,username:this.config.username,password:this.config.password}),this.ssh2Conn.on("error",e=>{console.log(`- 连接失败: ${e}`),this.breakConnect()}),this.ssh2Conn.on("end",()=>{this.uploading=!1}))}breakConnect(){this.uploading=!1,console.log("- 已断开连接"),console.log("-------------- deploy-end --------------"),this.ssh2Conn.end()}onShell(e){const t=this.getArgv("--allLog")!==void 0;return new Promise((s,n)=>{this.ssh2Conn.shell((i,a)=>{if(i){console.log("- 远程命令错误："+i,e),this.breakConnect(),n(i);return}let l=[];a.on("close",()=>{s(l.toString())}).on("data",c=>{let r=c.toString();(t||this.config.allLog||r.startsWith("- "))&&l.push(`
-`+r)}).stderr.on("data",c=>{console.log(`- 远程命令错误：
-`+c),this.breakConnect(),n(c)}),a.end(e+`
-exit
-`)})})}projectInit(e,t){return new Promise(async(s,n)=>{e.mkdir(t,async i=>{if(i)n(i);else{console.log("- 正在创建dockerfile");const a=`${t}/${this.config.dockerfile.name}`;await this.onShell(`touch ${a}`),await this.onShell(`echo '${this.config.dockerfile.content.join(`
-`)}' > ${a}`),console.log("- 正在创建upload.sh");const l=`${t}/${this.config.upload.name}`;await this.onShell(`touch ${l}`),await this.onShell(`echo '${this.config.upload.content.join(`
-`)}' > ${l}`),s()}})})}upLoadProject(e,t){e.readdir(t,async s=>{if(s){console.log("- 跳板机不存在项目, 开始创建项目"),this.projectInit(e,t).then(()=>{console.log(`- ${this.config.namespace}项目创建成功`),this.upLoadProject(e,t)}).catch(o=>{console.log(`- 创建项目失败: ${o}`),this.breakConnect()});return}const n=`${t}/${this.config.dist.name}`;if(await this.onShell(`rm -rf ${n}`),await this.onShell(`mkdir ${n}`),!this.config.fileDir){console.log("- 请配置待上传文件目录 fileDir"),this.breakConnect();return}const{localFileList:i,dirList:a}=await this.getFilesInDirectory(this.config.fileDir);if(i.length===0){console.log("- 待上传目录没有获取到文件，请检查"),this.breakConnect();return}let l=0,c=i.length;const r=o=>new Promise((p,d)=>{try{const g=f.createReadStream(o.localPath),k=e.createWriteStream(`${n}${o.remotePath}`);k.on("close",()=>{this.progressBar(++l,c),p()}),k.on("error",C=>{console.log(`- 文件 ${o.remotePath} 上传失败：${C}`),d(C),this.breakConnect()}),g.pipe(k)}catch(g){d(g)}}),b=(o,p)=>{let d=[];for(let g=0;g<o.length;g+=p)d.push(o.slice(g,g+p));return d},y=o=>{if(o.length===0)return Promise.resolve();const p=o.shift();return Promise.all(p.map(d=>r(d))).then(()=>y(o))},m=o=>{if(o.length===0)return Promise.resolve();let d=o.shift().map(g=>`${n}${g}`).join(" ");return this.onShell(`mkdir -p ${d}`).then(()=>m(o))};let P=[...b(a,this.config.parallelDir||20)];console.log("- 开始创建目录"),await m(P),console.log("- 创建目录完成"),await new Promise(o=>{setTimeout(()=>{o()},500)});let S=[...b(i,this.config.parallelFile||50)];console.log("- 开始上传文件"),await y(S),console.log("- 文件上传成功"),console.log("- 开始推送镜像");let $=`cd ${t} && sh ${this.config.upload.name}`;const D=this.getArgv("--imageStore")||this.config.imageStore;$+=` ${D}`;const L=this.getArgv("--tmpName")||this.config.tmpName;$+=` ${L}`;const v=await this.onShell($);console.log(v),console.log("- 镜像推送完成"),this.breakConnect()})}progressBar(e,t,s=25){let n=(e/t).toFixed(4),i=Math.floor(n*s),a="";for(let r=0;r<i;r++)a+="█";let l="";for(let r=0;r<s-i;r++)l+="░";let c=`- 文件上传进度: ${a}${l} (${e}/${t}) ${(100*n).toFixed(2)}%`;h(c),e==t&&console.log("")}getFilesInDirectory(e){const t=[],s=[];return new Promise((n,i)=>{const a=(l,c,r)=>{const b=f.readdirSync(l);let y=!1;b.forEach(m=>{const P=u.join(l,m),$=f.statSync(P).isDirectory();$?y=!0:t.push({localPath:P,remotePath:`${c}${m}`,level:r}),$&&a(P,`${c}${m}/`,r+1)}),y||s.push(c)};a(e,"/",0),n({localFileList:t,dirList:s})})}getArgv(e){const t=process.argv;let s;return t.forEach(n=>{n.indexOf(e)>-1&&(s=n.split("=")[1]||"")}),s}}});