Add support for retreiving workflow logs

Author: Itai Gendler

lib/interface/cli/commands/root/logs.cmd.js

@@ -0,0 +1,34 @@
+const debug = require('debug')('codefresh:cli:logs');
+const Command = require('../../Command');
+const _ = require('lodash');
+const CFError = require('cf-errors');
+const { logs } = require('../../../../logic').api;
+
+
+const run = new Command({
+    root: true,
+    command: 'logs <id>',
+    description: 'Show logs of a workflow',
+    builder: (yargs) => {
+        yargs
+            .positional('id', {
+                describe: 'Pipeline id',
+            })
+            .option('f', {
+                describe: 'Continue showing workflow logs until it will finish',
+                type: 'boolean',
+            });
+
+        return yargs;
+    },
+    handler: async (argv) => {
+        const workflowId = argv.id;
+        const follow = argv.f;
+
+        await logs.showWorkflowLogs(workflowId, follow);
+        // TODO fix this. its a workaround since something related to firebase in not properly closed
+        process.exit(0);
+    },
+});
+
+module.exports = run;

lib/interface/cli/commands/root/run.cmd.js

@@ -48,6 +48,9 @@ const run = new Command({
                 describe: 'todo',
                 type: 'number',
                 default: 1,
+            })
+            .option('f', {
+                describe: 'Show and follow the logs of the created workflow',
             });
 
         crudFilenameOption(yargs, {

lib/logic/api/index.js

@@ -1,12 +1,11 @@
-
-
 const user = require('./user');
 const pipeline = require('./pipeline');
 const context = require('./context');
 const image = require('./image');
 const composition = require('./composition');
 const environment = require('./environment');
 const workflow = require('./workflow');
+const logs = require('./logs');
 
 module.exports = {
     user,
@@ -16,4 +15,5 @@ module.exports = {
     composition,
     environment,
     workflow,
+    logs,
 };

lib/logic/api/logs.js

@@ -0,0 +1,119 @@
+const debug = require('debug')('codefresh:api:logs');
+const Promise = require('bluebird');
+const _ = require('lodash');
+const CFError = require('cf-errors'); // eslint-disable-line
+const { sendHttpRequest } = require('./helper');
+const workflows = require('./workflow');
+const Firebase = require('firebase');
+const rp = require('request-promise');
+
+const getFirebaseToken = async () => {
+    const options = {
+        url: '/api/user/firebaseAuth',
+        method: 'GET',
+    };
+
+    const firebaseAuth = await sendHttpRequest(options);
+    return firebaseAuth;
+};
+
+const connectToFirebase = async (firebaseAuth) => {
+    const promise = new Promise((resolve, reject) => {
+        const jobIdRef = new Firebase(firebaseAuth.url);
+        jobIdRef.authWithCustomToken(firebaseAuth.accessToken, (err) => {
+            if (err) {
+                reject(new CFError({
+                    cause: err,
+                    message: 'Failed to login to Firebase',
+                }));
+            } else {
+                debug('Firebase login succeeded');
+                resolve();
+            }
+        });
+    });
+    return promise;
+};
+
+const printLogsFromJson = (steps) => {
+    _.forEach(steps, (step) => {
+        const prefixSuffix = Array(step.name.length)
+            .join('=');
+        console.log(`${prefixSuffix}\nStep: ${step.name}\n${prefixSuffix}`);
+        _.forEach(step.logs, (log) => {
+            console.log(log);
+        });
+    });
+};
+
+const printCurrentFirebaseLogs = async (firebaseAuth, progressJobId) => {
+    const promise = new Promise((resolve, reject) => {
+        const jobIdRef = new Firebase(`${firebaseAuth.url}/build-logs/${progressJobId}`);
+        jobIdRef.once('value', (snapshot) => {
+            const { steps } = snapshot.val();
+            printLogsFromJson(steps);
+
+            resolve();
+        }, (err) => {
+            reject(new CFError({
+                cause: err,
+                message: 'Failed to get logs from firebase',
+            }));
+        });
+    });
+    return promise;
+};
+
+// TODO implement
+const printFollowFirebaseLogs = async (firebaseAuth, progressJobId) => { // eslint-disable-line
+};
+
+const getProgressJob = async (workflowId) => {
+    const workflow = await workflows.getWorkflowById(workflowId);
+    const progressJobId = workflow.info.progress;
+
+    const options = {
+        url: `/api/progress/${progressJobId}`,
+        method: 'GET',
+    };
+
+    const progressJob = await sendHttpRequest(options);
+    return progressJob;
+};
+
+const showWorkflowLogsFromFirebase = async (progressJobId, follow) => {
+    const firebaseAuth = await getFirebaseToken();
+    await connectToFirebase(firebaseAuth);
+    if (follow) { // eslint-disable-line
+        // TODO implement
+    } else {
+        await printCurrentFirebaseLogs(firebaseAuth, progressJobId);
+    }
+};
+
+// when bringing logs from gcs, there is no meaning for workflow since the workflow has finished
+const showWorkflowLogsFromGCS = async (progressJob) => {
+    const options = {
+        url: progressJob.location.url,
+        method: 'GET',
+        json: true,
+    };
+
+
+    const { steps } = await rp(options);
+    printLogsFromJson(steps);
+};
+
+const showWorkflowLogs = async (workflowId, follow) => {
+    const progressJob = await getProgressJob(workflowId);
+    if (progressJob.location.type === 'firebase') {
+        await showWorkflowLogsFromFirebase(progressJob._id, follow);
+    } else {
+        await showWorkflowLogsFromGCS(progressJob);
+    }
+};
+
+
+module.exports = {
+    showWorkflowLogs,
+};

lib/logic/api/workflow.js

@@ -22,6 +22,7 @@ const _extractFieldsForWorkflowEntity = (workflow) => {
         repository: `${workflow.repoOwner}/${workflow.repoName}`,
         branch: workflow.branchName,
         trigger: workflow.trigger,
+        progress: workflow.progress,
     };
 };
 

package.json

@@ -21,6 +21,7 @@
     "scripts": "lib/**/*.js"
   },
   "dependencies": {
+    "firebase": "git+https://github.com/codefresh-io/firebase.git#80b2ed883ff281cd67b53bd0f6a0bbd6f330fed5",
     "@codefresh-io/docker-reference": "^0.0.5",
     "bluebird": "^3.5.1",
     "cf-errors": "^0.1.11",

yarn.lock

@@ -1269,6 +1269,12 @@ fast-levenshtein@~2.0.4:
   version "2.0.6"
   resolved "https://registry.yarnpkg.com/fast-levenshtein/-/fast-levenshtein-2.0.6.tgz#3d8a5c66883a16a30ca8643e851f19baa7797917"
 
+faye-websocket@>=0.6.0:
+  version "0.11.1"
+  resolved "https://registry.yarnpkg.com/faye-websocket/-/faye-websocket-0.11.1.tgz#f0efe18c4f56e4f40afc7e06c719fd5ee6188f38"
+  dependencies:
+    websocket-driver ">=0.5.1"
+
 fb-watchman@^2.0.0:
   version "2.0.0"
   resolved "https://registry.yarnpkg.com/fb-watchman/-/fb-watchman-2.0.0.tgz#54e9abf7dfa2f26cd9b1636c588c1afc05de5d58"
@@ -1337,6 +1343,12 @@ find-up@^2.0.0, find-up@^2.1.0:
   dependencies:
     locate-path "^2.0.0"
 
+"firebase@git+https://github.com/codefresh-io/firebase.git#80b2ed883ff281cd67b53bd0f6a0bbd6f330fed5":
+  version "2.4.2"
+  resolved "git+https://github.com/codefresh-io/firebase.git#80b2ed883ff281cd67b53bd0f6a0bbd6f330fed5"
+  dependencies:
+    faye-websocket ">=0.6.0"
+
 flat-cache@^1.2.1:
   version "1.3.0"
   resolved "https://registry.yarnpkg.com/flat-cache/-/flat-cache-1.3.0.tgz#d3030b32b38154f4e3b7e9c709f490f7ef97c481"
@@ -1680,6 +1692,10 @@ html-encoding-sniffer@^1.0.1:
   dependencies:
     whatwg-encoding "^1.0.1"
 
+http-parser-js@>=0.4.0:
+  version "0.4.9"
+  resolved "https://registry.yarnpkg.com/http-parser-js/-/http-parser-js-0.4.9.tgz#ea1a04fb64adff0242e9974f297dd4c3cad271e1"
+
 http-signature@~1.1.0:
   version "1.1.1"
   resolved "https://registry.yarnpkg.com/http-signature/-/http-signature-1.1.1.tgz#df72e267066cd0ac67fb76adf8e134a8fbcf91bf"
@@ -4006,6 +4022,17 @@ webidl-conversions@^4.0.0:
   version "4.0.2"
   resolved "https://registry.yarnpkg.com/webidl-conversions/-/webidl-conversions-4.0.2.tgz#a855980b1f0b6b359ba1d5d9fb39ae941faa63ad"
 
+websocket-driver@>=0.5.1:
+  version "0.7.0"
+  resolved "https://registry.yarnpkg.com/websocket-driver/-/websocket-driver-0.7.0.tgz#0caf9d2d755d93aee049d4bdd0d3fe2cca2a24eb"
+  dependencies:
+    http-parser-js ">=0.4.0"
+    websocket-extensions ">=0.1.1"
+
+websocket-extensions@>=0.1.1:
+  version "0.1.3"
+  resolved "https://registry.yarnpkg.com/websocket-extensions/-/websocket-extensions-0.1.3.tgz#5d2ff22977003ec687a4b87073dfbbac146ccf29"
+
 whatwg-encoding@^1.0.1:
   version "1.0.3"
   resolved "https://registry.yarnpkg.com/whatwg-encoding/-/whatwg-encoding-1.0.3.tgz#57c235bc8657e914d24e1a397d3c82daee0a6ba3"