New manifest and action level logs with new strip and tail options

src/commands/app/logs.js

@@ -13,11 +13,17 @@ governing permissions and limitations under the License.
 const { flags } = require('@oclif/command')
 // const { cli } = require('cli-ux')
 const BaseCommand = require('../../BaseCommand')
-const { wrapError, getLogs } = require('../../lib/app-helper')
+const { wrapError } = require('../../lib/app-helper')
+const rtLib = require('@adobe/aio-lib-runtime')
+const fs = require('fs-extra')
 
 class Logs extends BaseCommand {
   async run () {
     const { flags } = this.parse(Logs)
+    const config = this.getAppConfig()
+    if (!fs.existsSync('manifest.yml')) {
+      this.error(wrapError(new Error('no manifest.yml')))
+    }
 
     if (flags.limit < 1) {
       this.log('--limit should be > 0, using --limit=1')
@@ -27,10 +33,25 @@ class Logs extends BaseCommand {
       flags.limit = 50
     }
 
-    try {
-      const config = this.getAppConfig()
+    let filterActions = []
+    if (flags.action) {
+      let actionName = flags.action
+      if (!actionName.includes('/')) {
+        actionName = config.ow.package + '/' + actionName
+      }
+      filterActions = [actionName]
+    } else {
+      Object.entries(config.manifest.full.packages).forEach((packageTuple) => {
+        packageTuple[0] = packageTuple[0].replace(/__APP_PACKAGE__/g, config.ow.package)
+
+        Object.keys(packageTuple[1].actions).forEach((actionName) => {
+          filterActions.push(packageTuple[0] + '/' + actionName)
+        })
+      })
+    }
 
-      await getLogs(config, flags.limit, this.log)
+    try {
+      await rtLib.printActionLogs(config, this.log, flags.limit, filterActions, flags.strip, flags.poll || flags.tail || flags.watch)
     } catch (error) {
       this.error(wrapError(error))
     }
@@ -46,11 +67,34 @@ Logs.flags = {
     description: 'Limit number of activations to fetch logs from ( 1-50 )',
     default: 1,
     char: 'l'
+  }),
+  action: flags.string({
+    description: 'Fetch logs for a specific action',
+    char: 'a'
+  }),
+  strip: flags.boolean({
+    char: 'r',
+    description: 'strip timestamp information and output first line only',
+    default: false
+  }),
+  tail: flags.boolean({
+    description: 'Fetch logs continuously',
+    char: 't',
+    default: false,
+    exclusive: ['watch', 'poll']
+  }),
+  watch: flags.boolean({
+    description: 'Fetch logs continuously',
+    default: false,
+    char: 'w',
+    exclusive: ['tail', 'poll']
+  }),
+  poll: flags.boolean({
+    description: 'Fetch logs continuously',
+    default: false,
+    char: 'o',
+    exclusive: ['watch', 'tail']
   })
 }
 
-// Logs.args = [
-//   ...BaseCommand.args
-// ]
-
 module.exports = Logs

src/lib/app-helper.js

@@ -17,7 +17,6 @@ const dotenv = require('dotenv')
 const aioLogger = require('@adobe/aio-lib-core-logging')('@adobe/aio-cli-plugin-app:lib-app-helper', { provider: 'debug' })
 const { getToken, context } = require('@adobe/aio-lib-ims')
 const { CLI } = require('@adobe/aio-lib-ims/src/context')
-const RuntimeLib = require('@adobe/aio-lib-runtime')
 const fetch = require('node-fetch')
 
 /** @private */
@@ -86,42 +85,6 @@ async function getCliInfo () {
   return { accessToken, env }
 }
 
-async function getLogs (config, limit, logger, startTime = 0) {
-  // check for runtime credentials
-  RuntimeLib.utils.checkOpenWhiskCredentials(config)
-  const runtime = await RuntimeLib.init({
-    // todo make this.config.ow compatible with Openwhisk config
-    apihost: config.ow.apihost,
-    apiversion: config.ow.apiversion,
-    api_key: config.ow.auth,
-    namespace: config.ow.namespace
-  })
-
-  // get activations
-  const listOptions = { limit: limit, skip: 0 }
-  const logFunc = logger || console.log
-  const activations = await runtime.activations.list(listOptions)
-  let lastActivationTime = 0
-  // console.log('activations = ', activations)
-  for (let i = (activations.length - 1); i >= 0; i--) {
-    const activation = activations[i]
-    lastActivationTime = activation.start
-    if (lastActivationTime > startTime) {
-      const results = await runtime.activations.logs({ activationId: activation.activationId })
-      // console.log('results = ', results)
-      // send fetched logs to console
-      if (results.logs.length > 0) {
-        logFunc(activation.name + ':' + activation.activationId)
-        results.logs.forEach(function (log) {
-          logFunc(log)
-        })
-        logFunc()
-      }
-    }
-  }
-  return { lastActivationTime }
-}
-
 function getActionUrls (config, isRemoteDev = false, isLocalDev = false) {
   // set action urls
   // action urls {name: url}, if !LocalDev subdomain uses namespace
@@ -360,7 +323,6 @@ module.exports = {
   wrapError,
   getCliInfo,
   getActionUrls,
-  getLogs,
   removeProtocolFromURL,
   urlJoin,
   checkFile,

src/lib/runDev.js

@@ -11,7 +11,8 @@ governing permissions and limitations under the License.
 */
 /* eslint-disable no-template-curly-in-string */
 const aioLogger = require('@adobe/aio-lib-core-logging')('@adobe/aio-cli-plugin-app:runDev', { provider: 'debug' })
-const rtLibUtils = require('@adobe/aio-lib-runtime').utils
+const rtLib = require('@adobe/aio-lib-runtime')
+const rtLibUtils = rtLib.utils
 const path = require('path')
 const fs = require('fs-extra')
 
@@ -232,7 +233,8 @@ async function runDev (args = [], config, options = {}, log) {
 async function logListener (args) {
   if (!args.resources.stopFetchLogs) {
     try {
-      const ret = await utils.getLogs(args.config, logOptions.limit || 1, console.log, logOptions.startTime)
+      // TODO : Is is better to just tail ?
+      const ret = await rtLib.printActionLogs(args.config, console.log, logOptions.limit || 1, [], false, false, undefined, logOptions.startTime)
       logOptions.limit = 30
       logOptions.startTime = ret.lastActivationTime
     } catch (e) {

test/__mocks__/@adobe/aio-lib-runtime.js

@@ -86,7 +86,8 @@ const init = jest.fn().mockReturnValue(mockRtLibInstance)
 const mockActionMethods = {
   buildActions: jest.fn(),
   deployActions: jest.fn(),
-  undeployActions: jest.fn()
+  undeployActions: jest.fn(),
+  printActionLogs: jest.fn()
 }
 module.exports = {
   utils: {

test/commands/app/init.test.js

@@ -14,6 +14,7 @@ const path = require('path')
 
 const TheCommand = require('../../../src/commands/app/init')
 const BaseCommand = require('../../../src/BaseCommand')
+const runtimeLib = require('@adobe/aio-lib-runtime') // eslint-disable-line no-unused-vars
 const importLib = require('../../../src/lib/import')
 jest.mock('../../../src/lib/import')
 

test/commands/app/logs.test.js

@@ -13,9 +13,30 @@ governing permissions and limitations under the License.
 const TheCommand = require('../../../src/commands/app/logs')
 const BaseCommand = require('../../../src/BaseCommand')
 
+const mockFS = require('fs-extra')
+
 jest.mock('../../../src/lib/app-helper.js')
 const helpers = require('../../../src/lib/app-helper.js')
 
+const mockRuntimeLib = require('@adobe/aio-lib-runtime')
+const printActionLogs = mockRuntimeLib.printActionLogs
+
+const fakeAppConfig = {
+  manifest: {
+    full: {
+      packages: {
+        jesttestpackage: {
+          actions: {
+            hello: {}
+          }
+        }
+      }
+    }
+  },
+  ow: {
+    package: 'jesttestpackage'
+  }
+}
 describe('interface', () => {
   test('exports', async () => {
     expect(typeof TheCommand).toEqual('function')
@@ -40,66 +61,108 @@ describe('interface', () => {
 
 describe('run', () => {
   beforeEach(() => {
-    helpers.getLogs.mockReset()
+    printActionLogs.mockReset()
     helpers.wrapError.mockReset()
+    mockFS.existsSync.mockReset()
   })
 
   test('no flags, sets limit to 1', async () => {
+    mockFS.existsSync.mockReturnValue(true)
     const command = new TheCommand([])
-    command.appConfig = { fake: 'config' }
+    command.appConfig = fakeAppConfig
     command.error = jest.fn()
     command.log = jest.fn()
 
     await command.run()
-    expect(helpers.getLogs).toHaveBeenCalledWith({ fake: 'config' }, 1, command.log)
+    expect(printActionLogs).toHaveBeenCalledWith(command.appConfig, command.log, 1, ['jesttestpackage/hello'], false, false)
     expect(command.error).not.toHaveBeenCalled()
   })
 
   test('--limit < 1, sets limit to 1', async () => {
+    mockFS.existsSync.mockReturnValue(true)
     const command = new TheCommand(['--limit', '-1'])
-    command.appConfig = { fake: 'config' }
+    command.appConfig = fakeAppConfig
     command.error = jest.fn()
     command.log = jest.fn()
 
     await command.run()
     expect(command.log).toHaveBeenCalledWith(expect.stringContaining('using --limit=1'))
-    expect(helpers.getLogs).toHaveBeenCalledWith({ fake: 'config' }, 1, command.log)
+    expect(printActionLogs).toHaveBeenCalledWith(fakeAppConfig, command.log, 1, ['jesttestpackage/hello'], false, false)
     expect(command.error).not.toHaveBeenCalled()
   })
 
   test('--limit > 50, sets limit to 50', async () => {
+    mockFS.existsSync.mockReturnValue(true)
     const command = new TheCommand(['--limit', '51'])
-    command.appConfig = { fake: 'config' }
+    command.appConfig = fakeAppConfig
     command.error = jest.fn()
     command.log = jest.fn()
 
     await command.run()
     expect(command.log).toHaveBeenCalledWith(expect.stringContaining('using --limit=50'))
-    expect(helpers.getLogs).toHaveBeenCalledWith({ fake: 'config' }, 50, command.log)
+    expect(printActionLogs).toHaveBeenCalledWith(fakeAppConfig, command.log, 50, ['jesttestpackage/hello'], false, false)
     expect(command.error).not.toHaveBeenCalled()
   })
 
   test('--limit 32', async () => {
+    mockFS.existsSync.mockReturnValue(true)
     const command = new TheCommand(['--limit', '32'])
-    command.appConfig = { fake: 'config' }
+    command.appConfig = fakeAppConfig
+    command.error = jest.fn()
+    command.log = jest.fn()
+
+    await command.run()
+    expect(printActionLogs).toHaveBeenCalledWith(fakeAppConfig, command.log, 32, ['jesttestpackage/hello'], false, false)
+    expect(command.error).not.toHaveBeenCalled()
+  })
+
+  test('--action without including package name', async () => {
+    mockFS.existsSync.mockReturnValue(true)
+    const command = new TheCommand(['--action', 'hello'])
+    command.appConfig = fakeAppConfig
     command.error = jest.fn()
     command.log = jest.fn()
 
     await command.run()
-    expect(helpers.getLogs).toHaveBeenCalledWith({ fake: 'config' }, 32, command.log)
+    expect(printActionLogs).toHaveBeenCalledWith(fakeAppConfig, command.log, 1, ['jesttestpackage/hello'], false, false)
+    expect(command.error).not.toHaveBeenCalled()
+  })
+
+  test('--action including package name', async () => {
+    mockFS.existsSync.mockReturnValue(true)
+    const command = new TheCommand(['--action', 'pkg1/hello'])
+    command.appConfig = fakeAppConfig
+    command.error = jest.fn()
+    command.log = jest.fn()
+
+    await command.run()
+    expect(printActionLogs).toHaveBeenCalledWith(fakeAppConfig, command.log, 1, ['pkg1/hello'], false, false)
     expect(command.error).not.toHaveBeenCalled()
   })
 
   test('error while getting logs', async () => {
+    mockFS.existsSync.mockReturnValue(true)
     const command = new TheCommand([])
-    command.appConfig = { fake: 'config' }
+    command.appConfig = fakeAppConfig
     command.error = jest.fn()
     command.log = jest.fn()
     const theerror = new Error('I do not like logs')
-    helpers.getLogs.mockRejectedValue(theerror)
+    printActionLogs.mockRejectedValue(theerror)
     helpers.wrapError.mockReturnValue('wrapped error')
     await command.run()
     expect(command.error).toHaveBeenCalledWith('wrapped error')
     expect(helpers.wrapError).toHaveBeenCalledWith(theerror)
   })
+
+  test('error no manifest', async () => {
+    mockFS.existsSync.mockReturnValue(false)
+    const command = new TheCommand([])
+    command.appConfig = fakeAppConfig
+    command.error = jest.fn()
+    command.log = jest.fn()
+    helpers.wrapError.mockReturnValue('wrapped error')
+    await command.run()
+    expect(command.error).toHaveBeenCalledWith('wrapped error')
+    expect(helpers.wrapError).toHaveBeenCalledWith(new Error('no manifest.yml'))
+  })
 })