yj-deploy 0.0.6 → 0.0.7

package/README.md

@@ -10,6 +10,7 @@
 - ✔ 支持手动上传其他任何类型项目
 - ✔ 支持灵活配置dockerfile，upload.sh等脚本内容
 - ✔ 支持多种方式配置 `镜像仓库` `镜像环境`等参数
+- ✔ 支持懒上传，仅上传新增部分文件，提升上传效率
 > 全程不需要连接跳板机做任何操作即可完成镜像推送
 
 ## 运行情况

package/dist/yj-deploy.mjs

@@ -0,0 +1,340 @@
+var x = Object.defineProperty;
+var L = (f, e, t) => e in f ? x(f, e, { enumerable: !0, configurable: !0, writable: !0, value: t }) : f[e] = t;
+var $ = (f, e, t) => (L(f, typeof e != "symbol" ? e + "" : e, t), t);
+const { stdout: v } = require("single-line-log"), F = require("path"), k = require("fs"), { Client: A } = require("ssh2");
+module.exports = class {
+  constructor(e) {
+    $(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,
+      // 是否显示全部日志
+      lazyUpload: !1
+      // 是否开启懒上传
+    });
+    $(this, "ssh2Conn", null);
+    // 上传状态
+    $(this, "uploading", !1);
+    // 定时器
+    $(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((i, s) => {
+      this.ssh2Conn.shell((n, l) => {
+        if (n) {
+          console.log("- 远程命令错误：" + n, e), this.breakConnect(), s(n);
+          return;
+        }
+        let r = [];
+        l.on("close", () => {
+          i(r.toString());
+        }).on("data", (c) => {
+          let a = c.toString();
+          (t || this.config.allLog || a.startsWith("- ")) && r.push(`
+` + a);
+        }).stderr.on("data", (c) => {
+          console.log(`- 远程命令错误：
+` + c), this.breakConnect(), s(c);
+        }), l.end(e + `
+exit
+`);
+      });
+    });
+  }
+  /**
+   * 初始化项目
+   * @param {*} sftp 
+   * @param {*} dir 
+   */
+  projectInit(e, t) {
+    return new Promise(async (i, s) => {
+      e.mkdir(t, async (n) => {
+        if (n)
+          s(n);
+        else {
+          console.log("- 正在创建dockerfile");
+          const l = `${t}/${this.config.dockerfile.name}`;
+          await this.onShell(`touch ${l}`), await this.onShell(`echo '${this.config.dockerfile.content.join(`
+`)}' > ${l}`), console.log("- 正在创建upload.sh");
+          const r = `${t}/${this.config.upload.name}`;
+          await this.onShell(`touch ${r}`), await this.onShell(`echo '${this.config.upload.content.join(`
+`)}' > ${r}`), i();
+        }
+      });
+    });
+  }
+  /**
+   * 判断文件是否存在
+   * @param {*} sftp 
+   * @param {*} remotePath 
+   * @returns 
+   */
+  checkRemoteFile(e, t) {
+    return new Promise((i) => {
+      e.stat(t, (s) => {
+        i(!s);
+      });
+    });
+  }
+  /**
+   * 上传项目
+   * @param {*} sftp 
+   * @param {*} dir 
+   */
+  upLoadProject(e, t) {
+    e.readdir(t, async (i) => {
+      if (i) {
+        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 = this.getArgv("--lazyUpload") !== void 0 || this.config.lazyUpload, n = `${t}/${this.config.dist.name}`;
+      if (s || await this.onShell(`rm -rf ${n}`), await this.onShell(`mkdir ${n}`), !this.config.fileDir) {
+        console.log("- 请配置待上传文件目录 fileDir"), this.breakConnect();
+        return;
+      }
+      const { localFileList: l, dirList: r } = await this.getFilesInDirectory(this.config.fileDir);
+      if (l.length === 0) {
+        console.log("- 待上传目录没有获取到文件，请检查"), this.breakConnect();
+        return;
+      }
+      let c = 0, a = l.length;
+      const w = (o) => new Promise(async (u, g) => {
+        try {
+          if (s && await this.checkRemoteFile(e, `${n}${o.remotePath}`))
+            return u();
+          const h = k.createReadStream(o.localPath), S = e.createWriteStream(`${n}${o.remotePath}`);
+          S.on("close", () => {
+            this.progressBar(++c, a), u();
+          }), S.on("error", (b) => {
+            console.log(`- 文件 ${o.remotePath} 上传失败：${b}`), g(b), this.breakConnect();
+          }), h.pipe(S);
+        } catch (h) {
+          g(h);
+        }
+      }), m = (o, u) => {
+        let g = [];
+        for (let h = 0; h < o.length; h += u)
+          g.push(o.slice(h, h + u));
+        return g;
+      }, d = (o) => {
+        if (o.length === 0)
+          return Promise.resolve();
+        const u = o.shift();
+        return Promise.all(u.map((g) => w(g))).then(() => d(o));
+      }, p = (o) => {
+        if (o.length === 0)
+          return Promise.resolve();
+        let g = o.shift().map((h) => `${n}${h}`).join(" ");
+        return this.onShell(`mkdir -p ${g}`).then(() => p(o));
+      };
+      let C = [...m(r, this.config.parallelDir || 20)];
+      await p(C), console.log("- 创建目录完成"), await new Promise((o) => {
+        setTimeout(() => {
+          o();
+        }, 500);
+      });
+      let y = [...m(l, this.config.parallelFile || 50)];
+      await d(y), s && (this.progressBar(a, a), console.log("\x1B[32m%s\x1B[0m", `- 已开启懒上传，本次共上传 ${c} 个文件`)), console.log("- 文件上传成功"), console.log("- 开始推送镜像");
+      let P = `cd ${t} && sh ${this.config.upload.name}`;
+      if (await this.isNewShell(e, t)) {
+        const o = this.getArgv("--imageStore") || this.config.imageStore;
+        P += ` ${o}`;
+      } else
+        console.log(`
+- warning 检测到当前脚本为手动创建,不支持镜像仓库配置,imageStore将失效`), console.log("- warning 如需支持imageStore参数,请在命令行后添加 --reset 重新生成脚本");
+      const j = this.getArgv("--tmpName") || this.config.tmpName;
+      P += ` ${j}`;
+      const D = await this.onShell(P);
+      console.log(D), console.log("- 镜像推送完成"), this.breakConnect();
+    });
+  }
+  /**
+   * 获取脚本内容是不是自动创建的脚本
+   * 兼容用户手动根据运维文档创建的推送脚本，因参数不同可能报错的问题
+   * 有 $2代表是自动创建的版本，否则老版本
+  */
+  async isNewShell(e, t) {
+    return new Promise((i, s) => {
+      e.readFile(`${t}/${this.config.upload.name}`, (n, l) => {
+        if (n)
+          return s(!1);
+        const r = l.toString();
+        i(r.includes("$2"));
+      });
+    });
+  }
+  /**
+   * 进度条
+   * @param description 命令行开头的文字信息
+   * @param bar_length 进度条的长度(单位：字符)，默认设为 25
+   */
+  progressBar(e, t, i = 25) {
+    let s = (e / t).toFixed(4), n = Math.floor(s * i), l = "";
+    for (let a = 0; a < n; a++)
+      l += "█";
+    let r = "";
+    for (let a = 0; a < i - n; a++)
+      r += "░";
+    let c = `- 文件上传进度: ${l}${r} (${e}/${t}) ${(100 * s).toFixed(2)}%`;
+    v(c), e == t && console.log("");
+  }
+  /**
+   * 获取目录下所有文件并分类
+   * @param {*} dir 
+   */
+  getFilesInDirectory(e) {
+    const t = [], i = [];
+    return new Promise((s, n) => {
+      const l = (r, c, a) => {
+        const w = k.readdirSync(r);
+        let m = !1;
+        w.forEach((d) => {
+          const p = F.join(r, d), y = k.statSync(p).isDirectory();
+          y ? m = !0 : t.push({
+            localPath: p,
+            // 本地路径
+            remotePath: `${c}${d}`,
+            // 远程路径
+            level: a
+            // 文件或目录层级
+          }), y && l(p, `${c}${d}/`, a + 1);
+        }), m || i.push(c);
+      };
+      l(e, "/", 0), s({
+        localFileList: t,
+        dirList: i
+      });
+    });
+  }
+  /**
+   * 获取命令行参数
+   * @param { string } name
+   */
+  getArgv(e) {
+    const t = process.argv;
+    let i;
+    return t.forEach((s) => {
+      s.indexOf(e) > -1 && (i = s.split("=")[1] || "");
+    }), i;
+  }
+};

package/dist/yj-deploy.umd.js

@@ -0,0 +1,8 @@
+(function(h){typeof define=="function"&&define.amd?define(h):h()})(function(){"use strict";var v=Object.defineProperty;var F=(h,f,u)=>f in h?v(h,f,{enumerable:!0,configurable:!0,writable:!0,value:u}):h[f]=u;var w=(h,f,u)=>(F(h,typeof f!="symbol"?f+"":f,u),u);const{stdout:h}=require("single-line-log"),f=require("path"),u=require("fs"),{Client:D}=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,lazyUpload:!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 D,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((n,s)=>{this.ssh2Conn.shell((i,l)=>{if(i){console.log("- 远程命令错误："+i,e),this.breakConnect(),s(i);return}let r=[];l.on("close",()=>{n(r.toString())}).on("data",c=>{let a=c.toString();(t||this.config.allLog||a.startsWith("- "))&&r.push(`
+`+a)}).stderr.on("data",c=>{console.log(`- 远程命令错误：
+`+c),this.breakConnect(),s(c)}),l.end(e+`
+exit
+`)})})}projectInit(e,t){return new Promise(async(n,s)=>{e.mkdir(t,async i=>{if(i)s(i);else{console.log("- 正在创建dockerfile");const l=`${t}/${this.config.dockerfile.name}`;await this.onShell(`touch ${l}`),await this.onShell(`echo '${this.config.dockerfile.content.join(`
+`)}' > ${l}`),console.log("- 正在创建upload.sh");const r=`${t}/${this.config.upload.name}`;await this.onShell(`touch ${r}`),await this.onShell(`echo '${this.config.upload.content.join(`
+`)}' > ${r}`),n()}})})}checkRemoteFile(e,t){return new Promise(n=>{e.stat(t,s=>{n(!s)})})}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=this.getArgv("--lazyUpload")!==void 0||this.config.lazyUpload,i=`${t}/${this.config.dist.name}`;if(s||await this.onShell(`rm -rf ${i}`),await this.onShell(`mkdir ${i}`),!this.config.fileDir){console.log("- 请配置待上传文件目录 fileDir"),this.breakConnect();return}const{localFileList:l,dirList:r}=await this.getFilesInDirectory(this.config.fileDir);if(l.length===0){console.log("- 待上传目录没有获取到文件，请检查"),this.breakConnect();return}let c=0,a=l.length;const S=o=>new Promise(async(p,d)=>{try{if(s&&await this.checkRemoteFile(e,`${i}${o.remotePath}`))return p();const g=u.createReadStream(o.localPath),k=e.createWriteStream(`${i}${o.remotePath}`);k.on("close",()=>{this.progressBar(++c,a),p()}),k.on("error",C=>{console.log(`- 文件 ${o.remotePath} 上传失败：${C}`),d(C),this.breakConnect()}),g.pipe(k)}catch(g){d(g)}}),y=(o,p)=>{let d=[];for(let g=0;g<o.length;g+=p)d.push(o.slice(g,g+p));return d},m=o=>{if(o.length===0)return Promise.resolve();const p=o.shift();return Promise.all(p.map(d=>S(d))).then(()=>m(o))},$=o=>{if(o.length===0)return Promise.resolve();let d=o.shift().map(g=>`${i}${g}`).join(" ");return this.onShell(`mkdir -p ${d}`).then(()=>$(o))};let j=[...y(r,this.config.parallelDir||20)];await $(j),console.log("- 创建目录完成"),await new Promise(o=>{setTimeout(()=>{o()},500)});let P=[...y(l,this.config.parallelFile||50)];await m(P),s&&(this.progressBar(a,a),console.log("\x1B[32m%s\x1B[0m",`- 已开启懒上传，本次共上传 ${c} 个文件`)),console.log("- 文件上传成功"),console.log("- 开始推送镜像");let b=`cd ${t} && sh ${this.config.upload.name}`;if(await this.isNewShell(e,t)){const o=this.getArgv("--imageStore")||this.config.imageStore;b+=` ${o}`}else console.log(`
+- warning 检测到当前脚本为手动创建,不支持镜像仓库配置,imageStore将失效`),console.log("- warning 如需支持imageStore参数,请在命令行后添加 --reset 重新生成脚本");const x=this.getArgv("--tmpName")||this.config.tmpName;b+=` ${x}`;const L=await this.onShell(b);console.log(L),console.log("- 镜像推送完成"),this.breakConnect()})}async isNewShell(e,t){return new Promise((n,s)=>{e.readFile(`${t}/${this.config.upload.name}`,(i,l)=>{if(i)return s(!1);const r=l.toString();n(r.includes("$2"))})})}progressBar(e,t,n=25){let s=(e/t).toFixed(4),i=Math.floor(s*n),l="";for(let a=0;a<i;a++)l+="█";let r="";for(let a=0;a<n-i;a++)r+="░";let c=`- 文件上传进度: ${l}${r} (${e}/${t}) ${(100*s).toFixed(2)}%`;h(c),e==t&&console.log("")}getFilesInDirectory(e){const t=[],n=[];return new Promise((s,i)=>{const l=(r,c,a)=>{const S=u.readdirSync(r);let y=!1;S.forEach(m=>{const $=f.join(r,m),P=u.statSync($).isDirectory();P?y=!0:t.push({localPath:$,remotePath:`${c}${m}`,level:a}),P&&l($,`${c}${m}/`,a+1)}),y||n.push(c)};l(e,"/",0),s({localFileList:t,dirList:n})})}getArgv(e){const t=process.argv;let n;return t.forEach(s=>{s.indexOf(e)>-1&&(n=s.split("=")[1]||"")}),n}}});

package/package.json

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