Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

fix for multiple actions using the require-adobe-auth annotation in the same package #137

Merged
merged 1 commit into from
Mar 17, 2020
Merged

fix for multiple actions using the require-adobe-auth annotation in the same package #137

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@
"@oclif/plugin-help": "^2.1.6",
"cli-ux": "^5.2.0",
"js-yaml": "^3.13.1",
"lodash.clonedeep": "^4.5.0",
"node-fetch": "^2.3.0",
"openwhisk": "^3.21.1",
"openwhisk-fqn": "^0.0.2",
Expand Down
54 changes: 21 additions & 33 deletions src/runtime-helpers.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ const fs = require('fs')
const yaml = require('js-yaml')
const debug = require('debug')('aio-cli-plugin-runtime/deploy')
const sha1 = require('sha1')
const cloneDeep = require('lodash.clonedeep')

// for lines starting with date-time-string followed by stdout|stderr a ':' and a log-line, return only the logline
const dtsRegex = /\d{4}-[01]{1}\d{1}-[0-3]{1}\d{1}T[0-2]{1}\d{1}:[0-6]{1}\d{1}:[0-6]{1}\d{1}.\d+Z( *(stdout|stderr):)?\s(.*)/
Expand Down Expand Up @@ -423,74 +424,61 @@ function rewriteActionsWithAdobeAuthAnnotation (packages, deploymentPackages) {
const REWRITE_ACTION_PREFIX = '__secured_'

// avoid side effects, do not modify input packages
const newPackages = { ...packages }
const newDeploymentPackages = { ...deploymentPackages }
const newPackages = cloneDeep(packages)
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

going with clone deep adds a (small) dependency but makes the implementation clearer and less error prone

const newDeploymentPackages = cloneDeep(deploymentPackages)

// traverse all actions in all packages
Object.keys(packages).forEach((key) => {
if (packages[key]['actions']) {
Object.keys(packages[key]['actions']).forEach((actionName) => {
const thisAction = packages[key]['actions'][actionName]
Object.keys(newPackages).forEach((key) => {
if (newPackages[key]['actions']) {
Object.keys(newPackages[key]['actions']).forEach((actionName) => {
const thisAction = newPackages[key]['actions'][actionName]

const isWeb = checkWebFlags(thisAction['web-export'])['web-export'] || checkWebFlags(thisAction['web'])['web-export']

// check if the annotation is defined AND the action is a web action
if (isWeb && thisAction.annotations && thisAction.annotations[ADOBE_AUTH_ANNOTATION]) {
debug(`found annotation '${ADOBE_AUTH_ANNOTATION}' in action '${key}/${actionName}'`)

// 0. second level copy
newPackages[key] = { ...packages[key] }
newDeploymentPackages[key] = { ...deploymentPackages[key] }

// 1. rename the action
const renamedAction = REWRITE_ACTION_PREFIX + actionName
/* istanbul ignore if */
if (packages[key]['actions'][renamedAction] !== undefined) {
if (newPackages[key]['actions'][renamedAction] !== undefined) {
// unlikely
throw new Error(`Failed to rename the action '${key}/${actionName}' to '${key}/${renamedAction}': an action with the same name exists already.`)
}

// copy actions to the new package and move the action content to the new key
newPackages[key]['actions'] = {
...packages[key]['actions'],
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Here was the problem as we were overriding any previous action rewrites

[renamedAction]: { ...thisAction }
}
// set the action to the new key
newPackages[key]['actions'][renamedAction] = thisAction
// delete the old key
delete newPackages[key]['actions'][actionName]

// make sure any content in the deployment package is linked to the new action name
if (deploymentPackages[key] && deploymentPackages[key]['actions'] && deploymentPackages[key]['actions'][actionName]) {
newDeploymentPackages[key]['actions'] = {
...deploymentPackages[key]['actions'],
[renamedAction]: deploymentPackages[key]['actions'][actionName]
}
if (newDeploymentPackages[key] && newDeploymentPackages[key]['actions'] && newDeploymentPackages[key]['actions'][actionName]) {
newDeploymentPackages[key]['actions'][renamedAction] = newDeploymentPackages[key]['actions'][actionName]
delete newDeploymentPackages[key]['actions'][actionName]
}

// 2. delete the adobe-auth annotation and secure the renamed action
newPackages[key]['actions'][renamedAction]['annotations'] = {
...packages[key]['actions'][actionName]['annotations'],
'require-whisk-auth': true
}
newPackages[key]['actions'][renamedAction]['annotations']['require-whisk-auth'] = true
delete newPackages[key]['actions'][renamedAction]['annotations'][ADOBE_AUTH_ANNOTATION]

debug(`renamed action '${key}/${actionName}' to '${key}/${renamedAction}'`)

// 3. create the sequence
if (packages[key]['sequences'] === undefined) {
if (newPackages[key]['sequences'] === undefined) {
newPackages[key]['sequences'] = {}
} /* istanbul ignore next */ else if (packages[key]['sequences'][actionName] !== undefined) {
}
/* istanbul ignore if */
if (newPackages[key]['sequences'][actionName] !== undefined) {
// unlikely
throw new Error(`The name '${key}/${actionName}' is defined both for an action and a sequence, it should be unique`)
}
// set the sequence content
newPackages[key]['sequences'] = {
...packages[key]['sequences'],
[actionName]: {
actions: `${ADOBE_AUTH_ACTION},${key}/${renamedAction}`,
web: 'yes'
}
newPackages[key]['sequences'][actionName] = {
actions: `${ADOBE_AUTH_ACTION},${key}/${renamedAction}`,
web: 'yes'
}

debug(`defined new sequence '${key}/${actionName}': '${ADOBE_AUTH_ACTION},${key}/${renamedAction}'`)
}
})
Expand Down
5 changes: 5 additions & 0 deletions test/__fixtures__/deploy/manifest_with_adobe_auth.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,11 @@ packages:
require-adobe-auth: true
inputs:
name: Elrond
helloAction2:
function: ./hello.js
web: 'yes'
annotations:
require-adobe-auth: true
sequences:
helloSeq:
actions: 'testSeq/helloAction,global/fake/action' # testSeq/helloAction will be converted to a seq
Expand Down
16 changes: 10 additions & 6 deletions test/commands/runtime/deploy/index.test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -896,16 +896,18 @@ describe('instance methods', () => {
// pkg1
// defined sequence (untouched)
expect(cmd).toHaveBeenCalledWith({ name: 'testSeq/helloSeq', action: '', annotations: { 'web-export': false, 'raw-http': false }, exec: { components: ['/ns/testSeq/helloAction', '/global/fake/action'], kind: 'sequence' } })
// action
// actions
expect(cmd).toHaveBeenCalledWith({ name: 'testSeq/__secured_helloAction', action: hello, annotations: { 'web-export': true, 'require-whisk-auth': true }, params: { name: 'Elrond' } })
// generated sequence
expect(cmd).toHaveBeenCalledWith({ name: 'testSeq/__secured_helloAction2', action: hello, annotations: { 'web-export': true, 'require-whisk-auth': true } })
// generated sequences
expect(cmd).toHaveBeenCalledWith({ name: 'testSeq/helloAction', action: '', annotations: { 'web-export': true }, exec: { components: ['/adobeio/shared-validators/ims', '/ns/testSeq/__secured_helloAction'], kind: 'sequence' } })
expect(cmd).toHaveBeenCalledWith({ name: 'testSeq/helloAction2', action: '', annotations: { 'web-export': true }, exec: { components: ['/adobeio/shared-validators/ims', '/ns/testSeq/__secured_helloAction2'], kind: 'sequence' } })
// pkg2
// action
expect(cmd).toHaveBeenCalledWith({ name: 'demo_package/__secured_sampleAction', action: hello, annotations: { 'web-export': true, 'require-whisk-auth': true } })
// sequence
expect(cmd).toHaveBeenCalledWith({ name: 'demo_package/sampleAction', action: '', annotations: { 'web-export': true }, exec: { components: ['/adobeio/shared-validators/ims', '/ns/demo_package/__secured_sampleAction'], kind: 'sequence' } })
expect(cmd).toHaveBeenCalledTimes(5)
expect(cmd).toHaveBeenCalledTimes(7)
expect(stdout.output).toMatch('')
})
})
Expand All @@ -917,19 +919,21 @@ describe('instance methods', () => {
// pkg1
// defined sequence (untouched)
expect(cmd).toHaveBeenCalledWith({ name: 'testSeq/helloSeq', action: '', annotations: { 'web-export': false, 'raw-http': false }, exec: { components: ['/ns/testSeq/helloAction', '/global/fake/action'], kind: 'sequence' } })
// action
// actions
// eslint-disable-next-line object-property-newline
expect(cmd).toHaveBeenCalledWith({ name: 'testSeq/__secured_helloAction', action: hello, annotations: { 'web-export': true, 'require-whisk-auth': true },
params: { name: 'Runtime' } // only difference in this test is the changed param
})
// sequence
expect(cmd).toHaveBeenCalledWith({ name: 'testSeq/__secured_helloAction2', action: hello, annotations: { 'web-export': true, 'require-whisk-auth': true } })
// sequences
expect(cmd).toHaveBeenCalledWith({ name: 'testSeq/helloAction', action: '', annotations: { 'web-export': true }, exec: { components: ['/adobeio/shared-validators/ims', '/ns/testSeq/__secured_helloAction'], kind: 'sequence' } })
expect(cmd).toHaveBeenCalledWith({ name: 'testSeq/helloAction2', action: '', annotations: { 'web-export': true }, exec: { components: ['/adobeio/shared-validators/ims', '/ns/testSeq/__secured_helloAction2'], kind: 'sequence' } })
// pkg2
// action
expect(cmd).toHaveBeenCalledWith({ name: 'demo_package/__secured_sampleAction', action: hello, annotations: { 'web-export': true, 'require-whisk-auth': true } })
// sequence
expect(cmd).toHaveBeenCalledWith({ name: 'demo_package/sampleAction', action: '', annotations: { 'web-export': true }, exec: { components: ['/adobeio/shared-validators/ims', '/ns/demo_package/__secured_sampleAction'], kind: 'sequence' } })
expect(cmd).toHaveBeenCalledTimes(5)
expect(cmd).toHaveBeenCalledTimes(7)
expect(stdout.output).toMatch('')
})
})
Expand Down