feat: add parsing logic to detect deprecated images

Author: vasil-cf

lib/ContainerLogger.js

@@ -3,9 +3,11 @@ const Q = require('q');
 const promiseRetry = require('promise-retry');
 const logger = require('cf-logs').Logger('codefresh:containerLogger');
 const CFError = require('cf-errors');
-const { Transform } = require('stream');
+const { Transform, PassThrough } = require('stream');
+
 const _ = require('lodash');
 const { LoggerStrategy } = require('./enums');
+const deprecatedImagesCollector = require('./metric/deprecated-images/deprecated-images.collector');
 
 const CONTAINER_START_RETRY_TIMEOUT_SECONDS = 1;
 const CONTAINER_START_RETRY_LIMIT = 10;
@@ -74,6 +76,7 @@ class ContainerLogger extends EventEmitter {
 
                             this._registerToTtyStreams(stdout, stderr);
                         } else {
+                            // TODO: parse deprecated images here
                             this._handleNonTtyStream(stdout, false);
                             if (stderr) {
                                 this._handleNonTtyStream(stderr, true);
@@ -131,6 +134,7 @@ class ContainerLogger extends EventEmitter {
         // { end = false } on the stepLoggerWritableStream because there is only one instance of it for all the steps.
         this.handledStreams++;
         let stdoutStream = stdout
+            .pipe(this._interceptDeprecatedImagesStream())
             .pipe(this._logSizeLimitStream())
             .pipe(this.stepLogger.createMaskingStream());
 
@@ -148,6 +152,7 @@ class ContainerLogger extends EventEmitter {
 
         this.handledStreams++;
         let stderrStream = stderr
+            .pipe(this._interceptDeprecatedImagesStream())
             .pipe(this._logSizeLimitStream())
             .pipe(this._errorTransformerStream())
             .pipe(this.stepLogger.createMaskingStream());
@@ -182,7 +187,9 @@ class ContainerLogger extends EventEmitter {
         this.handledStreams++;
         stream.on('end', this._handleFinished.bind(this));
         stream.on('data', (chunk) => {
-            this._logMessage(Buffer.from(chunk).toString('utf-8'), isError);
+            const message = Buffer.from(chunk).toString('utf-8');
+            deprecatedImagesCollector.catchDeprecatedImage(message);
+            this._logMessage(message, isError);
         });
         logger.info(`Listening on stream 'data' event for container: ${this.containerId}`);
     }
@@ -233,6 +240,11 @@ class ContainerLogger extends EventEmitter {
         this.emit('message.logged', curLogSize);
     }
 
+    _interceptDeprecatedImagesStream() {
+        return new PassThrough()
+            .on('data', (chunk) => deprecatedImagesCollector.catchDeprecatedImage(chunk.toString('utf8')));
+    }
+
     _errorTransformerStream() {
         return new Transform({
             transform: (data, encoding, done) => {

lib/metric/deprecated-images/deprecated-images.collector.ts

@@ -1,5 +1,10 @@
+// @ts-expect-error it's a js library
+import cfLogs from 'cf-logs';
+
 import { DeprecatedImageDto } from './deprecated-image.dto';
 
+const logger = cfLogs.Logger('codefresh:containerLogger');
+
 class DeprecatedImagesCollector {
 
     private list: DeprecatedImageDto[] = [];
@@ -15,6 +20,36 @@ class DeprecatedImagesCollector {
     destroyConsumed(consumedNumber: number) {
         this.list = this.list.slice(consumedNumber);
     }
+
+    catchDeprecatedImage(logText: string) {
+        if (logText.includes('[DEPRECATION NOTICE]')) {
+            const imageName = this._parseImageName(logText);
+
+            if (imageName === null) {
+                logger.error(`detected pulling of the deprecated image but failed to parse the image name. The original log text: '${logText}'`);
+            } else {
+                logger.warn(`detected pulling of the deprecated image '${imageName}'. The original log text: '${logText}'`);
+
+                this.push({
+                    image: imageName,
+                });
+            }
+        }
+    }
+
+    private _parseImageName(logText: string) {
+        const startMarker = 'Suggest the author of ';
+        const endMarker = ' to upgrade the image';
+
+        const startIndex = logText.indexOf(startMarker);
+        const endIndex = logText.indexOf(endMarker);
+
+        if (startIndex > -1 && endIndex > -1 && endIndex > startIndex) {
+            return logText.substring(startIndex + startMarker.length, endIndex);
+        }
+
+        return null;
+    }
 }
 
 export default new DeprecatedImagesCollector();

service.yaml

@@ -1 +1 @@
-version: 1.11.8
+version: 1.12.0