logs (#34)

* logs improvements

* fix tests

* bump

* bump

Co-authored-by: Denis <denis@codefresh.io>

Author: cf-ci-bot-v2

.eslintrc.js

@@ -115,7 +115,7 @@ module.exports = {
             },
             {
                 'selector': 'objectLiteralProperty',
-                'format': ['camelCase', 'UPPER_CASE'],
+                'format': ['camelCase', 'UPPER_CASE', 'PascalCase'],
                 'leadingUnderscore': 'allow',
             },
             {

package.json

@@ -24,7 +24,9 @@
     "node": "16.14.2"
   },
   "dependencies": {
-    "eventsource": "^2.0.1"
+    "chalk": "4.1.2",
+    "eventsource": "^2.0.1",
+    "winston": "^3.7.2"
   },
   "devDependencies": {
     "@types/jest": "^27.5.1",

service.yaml

@@ -1,2 +1,2 @@
 name: csdp-report-image
-version: 0.0.41
+version: 0.0.42

src/__tests__/request-builder.spec.ts

@@ -1,4 +1,4 @@
-import { buildUrlHeaders } from '../request-builder'
+import { buildUrlHeaders } from '../utils'
 
 
 describe('request builder test', () => {

src/logger.ts

@@ -0,0 +1,35 @@
+import winston from 'winston'
+import chalk from 'chalk'
+
+const format = winston.format
+const paint = (kind, message) => {
+    const painter = {
+        error: chalk.red,
+        warn: chalk.yellow,
+        workflowLog: chalk.blue
+    }[kind]
+
+    if (painter) {
+        return painter(message)
+    }
+    return message
+}
+
+
+export const logger = winston.createLogger({
+    format: format.printf((info) => {
+        return paint(info.level, `${info.message}`)
+    }),
+    transports: [ new winston.transports.Console() ],
+})
+
+export const workflowLogger = winston.createLogger({
+    format: format.printf((info) => {
+        let logMessage = `${info.message}`
+        if (info.pod) {
+            logMessage = `[${info.pod}] ${logMessage}`
+        }
+        return paint('workflowLog', logMessage)
+    }),
+    transports: [ new winston.transports.Console() ],
+})

src/main.ts

@@ -1,73 +1,85 @@
 import EventSource from 'eventsource'
 
 import { validate } from './validate'
-import { buildUrlHeaders } from './request-builder'
+import { tryParseJson, errors, buildUrlHeaders } from './utils'
+import { logger, workflowLogger } from './logger'
+
+const { EventSourceError } = errors
 
 /**
  * Take (CF_ prefixed) Env variables and perform http/s request (SSE) to app-proxy for image-report with CF_ENRICHERS
  */
-async function mainProcess(argv, env): Promise<void> {
+async function main(argv, env): Promise<void> {
     const verbose = argv.includes('verbose') || env['VERBOSE']
     if (verbose) {
-        console.debug('Running with verbose log')
+        logger.debug('running with verbose log')
     }
     const payload = validate(env)
     const { url, headers } = buildUrlHeaders(payload)
     if (verbose) {
-        console.debug(`Payload: ${JSON.stringify(payload, null, 2)}`)
-        console.debug(`Sending request: ${url}, headers: ${JSON.stringify(headers)}`)
+        logger.debug(`payload: ${JSON.stringify(payload, null, 2)}`)
+        logger.debug(`sending request: ${url}, headers: ${JSON.stringify(headers)}`)
     }
     if (payload['CF_CI_TYPE'] && payload['CF_WORKFLOW_URL']) {
-        console.info(`Running ${payload['CF_CI_TYPE']} URL: ${payload['CF_WORKFLOW_URL']}`)
+        logger.info(`CI provider: ${payload['CF_CI_TYPE']}, job URL: ${payload['CF_WORKFLOW_URL']}`)
     }
-    const waitFor = new Promise((resolve, reject) => {
-        const eventSource = new EventSource(url, { headers })
+    const eventSource = new EventSource(url, { headers })
+    const waitFor = new Promise<void>((resolve, reject) => {
+        
         eventSource.addEventListener('report', function (event) {
-            console.info(`report =>`, JSON.stringify(JSON.parse(event.data), null, 2))
+            logger.info(JSON.stringify(JSON.parse(event.data), null, 2))
         })
         eventSource.addEventListener('info', function (event) {
-            console.info(`\t\t${JSON.stringify(event.data)}`)
+            logger.info(event.data)
         })
         eventSource.addEventListener('warn', function (event) {
-            console.warn(`Warning:\t${JSON.stringify(event.data)}`)
+            logger.warn(event.data)
         })
-        eventSource.addEventListener('error', (err) => {
+        eventSource.addEventListener('workflow-log', function (event) {
+            const log = tryParseJson(event.data)
+            if (typeof log === 'object' && log.content && log.podName) {
+                workflowLogger.info({ pod: log.podName, message: log.content })
+            } else {
+                workflowLogger.info(event.data)
+            }
+        })
+        eventSource.addEventListener('error', (errorEvent) => {
             eventSource.close()
-            reject(err)
+
+            const error = tryParseJson(errorEvent.data)
+            let name
+            let message
+            if (typeof error === 'string') {
+                message = error
+            } else if (typeof error === 'object') {
+                if (typeof error.message === 'string') {
+                    message = error.message
+                }
+                if (typeof error.name === 'string') {
+                    name = error.name
+                }
+            } else {
+                message = errorEvent.message || 'Unknown error. Something went wrong.'
+            }
+            reject(new EventSourceError(message, name))
         })
-        eventSource.addEventListener('end', (ev) => {
+        eventSource.addEventListener('end', (event) => {
             eventSource.close()
-            resolve(ev)
+            logger.info(event.data)
+            resolve()
         })
     })
     await waitFor
 }
 
-async function main(argv, env): Promise<void> {
-    try {
-        await mainProcess(argv, env)
-    } catch (error) {
-        console.error(error)
-        if (error.type=='error' && error.status===500) {
-            const tokenStart = (env['CF_API_KEY'] || '').slice(0, 6)
-            const tokenEnd = (env['CF_API_KEY'] || '').slice(-6)
-            console.info(`Error 500 are usually caused by providing an invalid CF_API_KEY, please check that the validity of the provided codefresh api token ${tokenStart}..${tokenEnd}`)
-        }
-        throw error
-    }
-}
-
 /**
  * calling main with process argv and env. Exit code 1 on error
  */
 export async function mainErrorHandling() {
     try {
         await main(process.argv, process.env)
-    } catch {
-        // Catchall for general errors
+    } catch (error) {
+        logger.error(error.toString())
         process.exit(1)
     }
 }
-
-
-

src/request-builder.ts

@@ -0,0 +1,42 @@
+export const tryParseJson = (str: string) => {
+    try {
+        return JSON.parse(str)
+    } catch {
+        return str
+    }
+}
+
+
+/**
+ * Build image-report url and headers
+ * @param payload
+ */
+ export function buildUrlHeaders(payload: Record<string, string | undefined>) {
+    const esc = encodeURIComponent
+    const headers = { 'authorization': payload['CF_API_KEY'] }
+    const host = payload['CF_HOST'] as string
+    delete payload['CF_API_KEY']
+    delete payload['CF_HOST']
+    const qs = Object.entries(payload).map(kv => `${esc(kv[0])}=${esc(kv[1] || '')}`).join('&')
+    const url = `${host}/app-proxy/api/image-report?${qs}`
+    if (payload['CF_LOCAL']) {
+        return { url: `${host}/api/image-report?${qs}`,  headers }
+    }
+    return { url, headers }
+}
+
+
+export const errors = {
+    EventSourceError: class extends Error {
+        constructor(message?: string, name?: string) {
+            super(message)
+            this.name = name || 'EventSourceError'
+        }
+    },
+    ValidationError: class extends Error {
+        constructor(message?: string, name?: string) {
+            super(message)
+            this.name = name || 'ValidationError'
+        }
+    }
+}

src/utils.ts

@@ -1,3 +1,5 @@
+import { errors } from './utils'
+
 /**
  * Validate mandatory env vars. address host default
  */
@@ -13,8 +15,8 @@ export function validate(payload: Record<string, string|undefined>): Record<stri
     if (!filtered['CF_HOST']) {
         messages.push(`CF_HOST must be provided as app-proxy http/s address`)
     }
-    if (messages.length>0) {
-        throw new Error(`Validation Error: ${JSON.stringify(messages)}`)
+    if (messages.length > 0) {
+        throw new errors.ValidationError(`Validation Error: ${JSON.stringify(messages)}`)
     }
 
     return filtered