some cleanUp and more modular codes

mammad2c · mammad2c · commit 2dc6da27fc96 · 2020-10-09T05:55:12.000+03:30
diff --git a/lib/index.js b/lib/index.js
@@ -7,7 +7,11 @@ const chalk = require("chalk");
 const objChange = require("on-change");
 const cliProgress = require("cli-progress");
 const argv = require("yargs");
+const Utils = require("./utils");
 
+/**
+ * define script options.
+ */
 argv
   .usage("Backup gitlab repo in local machine")
   .option("token", {
@@ -36,10 +40,13 @@ if (!argv.argv.token) {
   process.exit(0);
 }
 
+/**
+ * defining our needs.
+ */
 const token = argv.argv.token || "";
 const baseUrl = argv.argv.url || "https://gitlab.com";
 const output = argv.argv.output || "./repos";
-const pagination = 100;
+const pagination = 100; // currently maximum gitlab pagination supports.
 const defaultAddress = `/api/v4/projects?simple=true&membership=true&pagination=keyset&order_by=id&sort=asc&per_page=${pagination}`;
 const bar = new cliProgress.SingleBar(
   {
@@ -48,8 +55,19 @@ const bar = new cliProgress.SingleBar(
   cliProgress.Presets.shades_classic
 );
 
+/**
+ * for saving next paginated data url.
+ */
 let next;
+
+/**
+ * total repository for handling progress bar.
+ */
 let total = 0;
+
+/**
+ * to indicate when first cloning starts.
+ */
 let firstStart = true;
 
 axios.defaults.baseURL = baseUrl;
@@ -59,12 +77,18 @@ if (!fs.existsSync(output)) {
   fs.mkdirSync(output);
 }
 
+/**
+ * listen for changes on cloned repos and we reached end of pagination or not.
+ */
 const observer = objChange(
   {
     cloned: 0,
     hasNext: true,
   },
   () => {
+    /**
+     * if we cloned all repos based on total and cloned and also there is no link for next paginated data, so we cloned all repos and should stop progress bar and cleanup message.
+     */
     if (observer.cloned === total && !observer.hasNext) {
       bar.stop();
       console.clear();
@@ -73,32 +97,48 @@ const observer = objChange(
   }
 );
 
-function isRepoExist(repoName) {
-  return fs.existsSync(`${output}/${repoName}/.git`);
-}
-
-function cloneCompleted(repoName, showMessage = true) {
-  if (showMessage) {
-    console.log(chalk.green(`\n clone completed ${repoName} \n`));
-  }
-
-  observer.cloned += 1;
-  bar.increment(1);
-}
-
+/**
+ * generate our uitls.
+ */
+const utils = new Utils({
+  token,
+  url: baseUrl,
+  output,
+  bar,
+  observer,
+});
+
+/**
+ * main function:
+ * we make a request to gitlab for fetching available repos in this particular request.
+ * at the beginning we don't have next url so we fetch from defaultAddress, in next recursive call it should be next url
+ * this mechanism guarantee that we can take all repos if they are paginated.
+ */
 function main() {
   axios
     .get(next || defaultAddress)
     .then((res) => {
       const repos = res.data;
       const { length } = repos;
       total += length;
+
+      /**
+       * based on gitlab pagination document, the next url to be called come here, so we grab it and save it
+       * to handle our pagination process.
+       */
       const { link } = res.headers;
 
       if (firstStart) {
+        /**
+         * so at the beginning of cloning we start our cli progress.
+         */
         bar.start(total, 0);
+
         firstStart = false;
       } else {
+        /**
+         * we update our total repos because of in new paginated data we should update total repos.
+         */
         bar.setTotal(total);
       }
 
@@ -108,35 +148,54 @@ function main() {
           name_with_namespace: nameWithNameSpace,
           http_url_to_repo: httpUrlToRepo,
         } = repo;
-        const repoName = nameWithNameSpace.replace(/\//g, "-");
-        const repoNameColor = chalk.cyan(repoName);
-        const repoUrl = httpUrlToRepo.replace(
-          "https://",
-          `https://gitlab-ci-token:${token}@`
-        );
-
-        if (isRepoExist(repoName)) {
-          cloneCompleted(repoNameColor, false);
+
+        const repoName = Utils.generateRepoName(nameWithNameSpace);
+        const repoNameColor = Utils.generateRepoNameColorized(repoName);
+        const repoUrl = utils.generateRepoUrl(httpUrlToRepo);
+
+        /**
+         * if we had already cloned this repo, we do action after cloning a repo without showing any message to update our process.
+         */
+        if (utils.isRepoExist(repoName)) {
+          utils.cloneCompleted(repoNameColor, false);
         } else {
+          /**
+           * we start cloning the repo
+           */
           console.log(chalk.yellow(`\n cloning ${repoNameColor} ... \n`));
 
           clone(`${repoUrl}`, `${output}/${repoName}`, undefined, () => {
-            if (isRepoExist(repoName)) {
-              cloneCompleted(repoNameColor);
+            /**
+             * here again, check if clone completed, do action after completing clone.
+             */
+            if (utils.isRepoExist(repoName)) {
+              utils.cloneCompleted(repoNameColor);
             }
           });
         }
       }
 
+      /**
+       * handle pagination.
+       * based on gitlab document, if our array length is 0 and link also is no absence then we have all of our repos data.
+       */
       if (length !== 0 && link) {
         next = link.replace("<http", "http").replace(`>; rel="next"`, "");
+
+        /**
+         * after saving next url that should be called, we call again our main function.
+         */
         main();
       } else {
+        /**
+         * if we don't have any other repos, so we stop our pagination process.
+         */
         observer.hasNext = false;
       }
     })
     .catch((err) => {
-      console.log("err:", err.message);
+      console.log(`\n ${chalk.red(`trace: ${err.stack}`)} \n`);
+      process.exit(0);
     });
 }
 
diff --git a/lib/utils.js b/lib/utils.js
@@ -0,0 +1,74 @@
+const fs = require("fs-extra");
+const chalk = require("chalk");
+
+class Utils {
+  /**
+   * generate repo directory based on name space and remove all `/` in the name because don't create directory per `/`.
+   * @param {string} name - name of repo with name space.
+   * TODO: this should be configurable by passing an option.
+   */
+  static generateRepoName(name) {
+    return name.replace(/\//g, "-");
+  }
+
+  /**
+   * make repoName colorable. :)
+   *
+   * @param {string} name - name of repo after generated by generateRepoName
+   */
+  static generateRepoNameColorized(name) {
+    return chalk.cyan(name);
+  }
+
+  constructor(scriptState) {
+    const { token, url, output, bar, observer } = scriptState;
+    this.token = token;
+    this.url = url;
+    this.output = output;
+    this.bar = bar;
+    this.observer = observer;
+  }
+
+  /**
+   * a utility function for detect given repo is cloned or not. return true or false.
+   * @param {string} repoName - the name of repo for checking directory.
+   */
+  isRepoExist(repoName) {
+    return fs.existsSync(`${this.output}/${repoName}/.git`);
+  }
+
+  /**
+   * a utility function should called after a repo has been successfully cloned.
+   * @param {string} repoName - the name of repo to be displayed.
+   * @param {boolean} showMessage - show completed message or not.
+   */
+  cloneCompleted(repoName, showMessage = true) {
+    if (showMessage) {
+      console.log(chalk.green(`\n clone completed ${repoName} \n`));
+    }
+
+    /**
+     * we increase cloned repo to keep tracking how much cloned.
+     */
+    // this.observer.cloned += 1;
+
+    /**
+     * increase cli progress bar by 1 when a repo cloned.
+     */
+    this.bar.increment(1);
+  }
+
+  /**
+   * generate url of a repo based on Personal Access Token.
+   * by this method there is no need to satisfy cloning in `https` or `ssh` mode.
+   * @param {string} httpUrlToRepo http url of repo
+   */
+  generateRepoUrl(httpUrlToRepo) {
+    return httpUrlToRepo.replace(
+      "https://",
+      `https://gitlab-ci-token:${this.token}@`
+    );
+  }
+}
+
+module.exports = Utils;
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -1,22 +1,21 @@
 {
   "name": "mmd-gitlab-backuper",
   "description": "a package to backup from all projects that you have on gitlab",
-  "version": "1.0.1",
-  "main": "index.js",
+  "version": "1.2.0",
+  "main": "lib/index.js",
   "license": "MIT",
   "author": {
     "name": "Mohammad Toosi",
     "email": "mammadtoosi@gmail.com",
     "url": "http://mammad2c.github.io/"
   },
   "bin": {
-    "mmd-gitlab-backuper": "index.js"
+    "mmd-gitlab-backuper": "lib/index.js"
   },
   "scripts": {
-    "start": "node index.js"
+    "start": "node lib/index.js"
   },
   "dependencies": {
-    "add": "^2.0.6",
     "axios": "^0.20.0",
     "chalk": "^4.1.0",
     "cli-progress": "^3.8.2",
