Added ability to provided the container listener strategy (logs/attach)

* added ability to get existing containers and not only new ones (to support the launch composition step where container already exists)
* handle both cases of tty and non tty containers

Author: itai-codefresh

.eslintignore

@@ -0,0 +1,15 @@
+# /node_modules/* and /bower_components/* ignored by default
+
+# Ignore built files except build/index.js
+build/*
+!build/index.js
+coverage/*
+
+# Directory for instrumented libs generated by jscoverage/JSCover
+lib-cov
+
+reports
+.DS_Store
+
+# Until we move all tests to their own subdirectory, we ignore them in eslint
+*.spec.js

.eslintrc

@@ -0,0 +1,57 @@
+// Codefresh Code Style - eslint ruleset
+// Based on AirBnB.
+//
+// More details: https://codefresh-io.atlassian.net/wiki/display/COD/Code+Style+Guide
+{
+
+  "extends": "airbnb",
+  "parserOptions": {
+    "ecmaVersion": 6,
+    "sourceType": "script",
+    "ecmaFeatures": {
+      "jsx": true
+    }
+  },
+
+  "rules": {
+    "indent": [
+      "error",
+      4,
+      {
+        "SwitchCase": 1,
+        "VariableDeclarator": 1
+      }
+    ],
+    "func-names": [
+      "error",
+      "never"
+    ],
+    "quotes": [
+      "error",
+      "single",
+      {
+        "allowTemplateLiterals": true
+      }
+    ],
+    "no-underscore-dangle": "off",
+    "no-param-reassign": "off",
+    "no-else-return": "off",
+    "arrow-body-style": "off",
+    "strict": [
+      "error",
+      "global"
+    ],
+    "no-multi-spaces": "off",
+    "padded-blocks": "off",
+    "import/no-extraneous-dependencies": [
+      2,
+      {
+        "devDependencies": true
+      }
+    ],
+    "guard-for-in": "error",
+    "no-console": "off",
+    "comma-dangle": ["error", "only-multiline"],
+    "quote-props": ["error", "consistent"]
+  }
+}

.gitignore

@@ -5,4 +5,5 @@ coverage/*.html
 .coverdata
 .debug
 coverage
-state.json
+state.json
+*.log

Dockerfile

@@ -1 +1,3 @@
-FROM node:onbuild
+FROM node:onbuild
+
+CMD ["npm", "start", "-s"]

README.md

@@ -1,5 +1,13 @@
 # cf-container-logger
+
 # required environment variables:
     # FIREBASE_AUTH_URL - the main firebase ref to authenticate on initialization
     # FIREBASE_SECRET - the secret key to write to the firebase auth url and all future derived urls
-    # LOGGER_ID - logger id. if a container will include this id in its label, we will log it
+    # LOGGER_ID - logger id. if a container will include this id in its label, we will log it
+    # LOG_TO_CONSOLE - by default, logging to console is disabled and only logging to a file is enabled. set this env to log to console to
+
+# Container labels
+    # logging strategies
+        # io.codefresh.loggerStrategy
+            # logs - will get all container logs from the beginning
+            # attach - will get all container logs from the point where attach was enabled. usefull for getting all interactive i/o

lib/ContainerLogger.js

@@ -0,0 +1,99 @@
+'use strict';
+
+const Q              = require('q');
+const logger         = require('cf-logs').Logger('codefresh:containerLogger');
+const CFError        = require('cf-errors');
+const LoggerStrategy = require('./enums').LoggerStrategy;
+
+class ContainerLogger {
+
+    constructor(containerId, containerInterface, firebaseLogger, loggerStrategy) {
+        this.containerId        = containerId;
+        this.containerInterface = containerInterface;
+        this.firebaseLogger     = firebaseLogger;
+        this.loggerStrategy     = loggerStrategy;
+        this.tty                = false;
+    }
+
+    start() {
+        return Q.ninvoke(this.containerInterface, 'inspect')
+            .then((inspectedContainer) => {
+                this.tty = inspectedContainer.Config.Tty;
+                if (this.loggerStrategy === LoggerStrategy.ATTACH) {
+                    return this._getAttachStrategyStream();
+                } else if (this.loggerStrategy === LoggerStrategy.LOGS) {
+                    return this._getLogsStrategyStream();
+                } else {
+                    return Q.reject(new CFError(`Strategy: ${this.loggerStrategy} is not supported`));
+                }
+            })
+            .then((stream) => {
+                logger.info(`Attached stream to container: ${this.containerId}`);
+                // Listening on the stream needs to be performed different depending if a tty is attached or not
+                // See documentation of the docker api here: https://docs.docker.com/engine/reference/api/docker_remote_api_v1.24/#/attach-to-a-container
+                if (this.tty) {
+                    this._handleTtyStream(stream);
+                } else {
+                    this._handleNonTtyStream(stream);
+                }
+
+                stream.on('end', () => {
+                    logger.info(`stream end event was fired for container: ${this.containerId}`);
+                });
+            }, (err) => {
+                return Q.reject(new CFError({
+                    cause: err,
+                    message: `Failed to handle container:${this.containerId}`
+                }));
+            });
+    }
+
+    _getAttachStrategyStream() {
+        return Q.ninvoke(this.containerInterface, 'attach', {
+            stream: true,
+            stdout: true,
+            stderr: true,
+            tty: true
+        });
+    }
+
+    _getLogsStrategyStream() {
+        return Q.ninvoke(this.containerInterface, 'logs', {
+            follow: 1,
+            stdout: 1,
+            stderr: 1
+        });
+    }
+
+    _handleTtyStream(stream) {
+        stream.on('data', (chunk) => {
+            const buf     = new Buffer(chunk);
+            const message = buf.toString('utf8');
+            this._logMessageToFirebase(message);
+        });
+        logger.info(`Listening on stream 'data' event for container: ${this.containerId}`);
+    }
+
+    _handleNonTtyStream(stream) {
+        stream.on('readable', () => {
+            let header = stream.read(8);
+            while (header !== null) {
+                const payload = stream.read(header.readUInt32BE(4));
+                if (payload === null) {
+                    break;
+                }
+                this._logMessageToFirebase(new Buffer(payload).toString('utf8'));
+                header = stream.read(8);
+            }
+        });
+        logger.info(`Listening on stream 'readable' event for container: ${this.containerId}`);
+    }
+
+    _logMessageToFirebase(message) {
+        this.firebaseLogger.child('logs').push(message);
+        this.firebaseLogger.child('lastUpdate').set(new Date().getTime());
+    }
+
+}
+
+module.exports = ContainerLogger;

lib/enums.js

@@ -0,0 +1,22 @@
+'use strict';
+
+const ContainerStatus         = {
+    CREATE: 'create'
+};
+const LoggerStrategy          = {
+    ATTACH: 'attach',
+    LOGS: 'logs',
+    ALL: ['attach', 'logs']
+};
+const ContainerHandlingStatus = {
+    INITIALIZING: 'initializing',
+    LISTENING: 'listening'
+};
+
+
+module.exports = {
+    ContainerStatus,
+    LoggerStrategy,
+    ContainerHandlingStatus
+};
+

lib/index.js

@@ -1,4 +1,18 @@
 'use strict';
 
-var logger = require('./logger');
-logger(process.env.LOGGER_ID, process.env.FIREBASE_AUTH_URL, process.env.FIREBASE_SECRET);
+const path   = require('path');
+const cflogs = require('cf-logs');
+
+const loggerOptions = {
+    filePath: path.join(__dirname, '../logs', 'logs.log'),
+    console: process.env.LOG_TO_CONSOLE || false
+};
+cflogs.init(loggerOptions);
+
+const Logger = require('./logger');
+
+
+const logger = new Logger(process.env.LOGGER_ID, process.env.FIREBASE_AUTH_URL, process.env.FIREBASE_SECRET, process.env.LISTEN_ON_EXISTING);
+
+logger.validate();
+logger.start();