Feat/log affected (#15)

* fix: change filter name

* chore: up version

* feat: add flag to log only affected files

Author: hmdoganjf

package.json

@@ -1,7 +1,7 @@
 {
   "name": "@jotforminc/zenith",
   "packageManager": "pnpm@7.18.0",
-  "version": "0.5.3",
+  "version": "0.5.4",
   "description": "",
   "main": "./build/index.js",
   "files": [

src/classes/BuildHelper.js

@@ -20,9 +20,10 @@ export default class BuildHelper extends WorkerHelper {
     this.command = command;
   }
 
-  async init(debug, compareWith, compareHash) {
+  async init({debug, compareWith, compareHash, logAffected}) {
     this.cacher = new Cacher().cacher;
     this.compareHash = compareHash;
+    this.logAffected = logAffected;
     this.startTime = process.hrtime();
     if (debug) {
       this.debug = debug;
@@ -120,7 +121,7 @@ export default class BuildHelper extends WorkerHelper {
         for (const output of outputs) {
           // const outputPath = path.join(ROOT_PATH, root, output);
           Logger.log(3, 'Recovering from cache', buildProject, 'with hash => ', hash);
-          const recoverResponse = await this.anotherJob(hash, root, output, script, this.compareHash);
+          const recoverResponse = await this.anotherJob(hash, root, output, script, this.compareHash, this.logAffected);
           if (recoverResponse instanceof Error) {
             throw new Error(recoverResponse);
           }

src/classes/RemoteCacher.js

@@ -185,7 +185,7 @@ class RemoteCacher {
     })
   }
 
-  async recoverFromCache(originalHash, root, output, target) {
+  async recoverFromCache(originalHash, root, output, target, logAffected) {
     const isStdOut = isOutputTxt(output)
     const remotePath = `${target}/${originalHash}/${root}/${output}.${isStdOut ? 'txt' : 'zip'}`;
     try {
@@ -194,7 +194,11 @@ class RemoteCacher {
         Key: remotePath,
       });
       const outputPath = path.join(ROOT_PATH, root, output);
-      if (isStdOut) return Logger.log(2, await this.txtPipeEnd(response.Body));
+      if (isStdOut) {
+        const stdout = await this.txtPipeEnd(response.Body);
+        if (logAffected) return stdout
+        return Logger.log(2, await this.txtPipeEnd(response.Body));
+      }
       if (existsSync(outputPath)) {
         rmSync(outputPath, { recursive: true, force: true });
         mkdirSync(outputPath);

src/classes/Runner.js

@@ -11,6 +11,7 @@ export default class Runner {
       .option('-d, --debug', 'Debug mode')
       .option('-c, --compareWith <compareWith>', 'Compare with')
       .option('-ch, --noCompareHash', 'default: false. If false, will compare remote folders\' and local folders\' hash and execute target if hashes are not the same.')
+      .option('-la, --logAffected', 'default: false. If true, will log outputs of ONLY missed caches\' executes.')
       .addOption(
         new Option(
           '-l, --logLevel <logLevel>',
@@ -35,13 +36,21 @@ export default class Runner {
     if (options.noCompareHash) {
       this.compareHash = false;
     }
+    if (options.logAffected) {
+      this.logAffected = true;
+    }
 
     Logger.setLogLevel(Number(options.logLevel));
   }
 
   async run() {
     const Builder = new BuildHelper(this.command);
-    await Builder.init(this.debug, this.compareWith, this.compareHash);
+    await Builder.init({
+      debug: this.debug, 
+      compareWith: this.compareWith, 
+      compareHash: this.compareHash, 
+      logAffected: this.logAffected
+    });
     Logger.log(2, `Zenith ${this.command} started.`)
     if (this.project === 'all') {
       Builder.buildAll();

src/classes/WorkerHelper.js

@@ -21,9 +21,9 @@ export default class WorkerHelper {
     }
   }
 
-  async anotherJob(hash, root, output, target, compareHashes) {
+  async anotherJob(hash, root, output, target, compareHashes, logAffected) {
     try {
-      return await this.pool.exec('anotherJob', [hash, root, output, target, compareHashes], {
+      return await this.pool.exec('anotherJob', [hash, root, output, target, compareHashes, logAffected], {
         on: message => Logger.log(3, message)
       });
     } catch (error) {

src/worker.js

@@ -21,9 +21,9 @@ const execute = async (buildPath, targetCommand, hash, root, outputs, projectNam
   }
 }
 
-const anotherJob = async (hash, root, output, target, compareHash) => {
+const anotherJob = async (hash, root, output, target, compareHash, logAffected) => {
   try {
-    const outputHash = await RemoteCacher.recoverFromCache(hash, root, output, target);
+    const outputHash = await RemoteCacher.recoverFromCache(hash, root, output, target, logAffected);
     workerpool.workerEmit(`Cache recovered ${root}`);
     if (!compareHash) return true;
     const remoteHash = await RemoteCacher.checkHashes(hash, root, output, target);