Adding template to publish to I/O Events #41

sangeetha5491 · 2020-05-07T11:03:33Z

Adding templates that enable a user to publish events to Adobe I/O

Description

New option available as part of aio app init:
Events: Subscribe to Adobe Events or create custom events

On selecting this a use can select an option to create template to: Publish Cloud Events to Adobe I/O

This will result in creation of a template that accepts params: providerId, eventCode, and payload from the user, convert it to cloud events and publish to Adobe I/O

As part of these changes i have also extracted the templates folder out of add-actions to make it commonly available to add-action and add-event

Related Issue

Motivation and Context

How Has This Been Tested?

Screenshots (if appropriate):

Types of changes

Bug fix (non-breaking change which fixes an issue)
New feature (non-breaking change which adds functionality)
Breaking change (fix or feature that would cause existing functionality to change)

Checklist:

I have signed the Adobe Open Source CLA.
My code follows the code style of this project.
My change requires a change to the documentation.
I have updated the documentation accordingly.
I have read the CONTRIBUTING document.
I have added tests to cover my changes.
All new and existing tests passed.

moritzraho

@sangeetha5491 many thanks for your contribution that's a great one!
In addition to my inline comments I also wanted to discuss the addition of a delete-events generator, but I am not so sure how to design it as delete-action is already capable of deleting the event action.

moritzraho · 2020-05-15T14:05:43Z

generators/add-action/analytics/index.js

@@ -33,7 +33,8 @@ class AnalyticsGenerator extends ActionGenerator {
    const response = {
      statusCode: 200,
      body: collections
-    }`
+    }`,
+      utilFunction: undefined


@sangeetha5491 I like the idea of adding an additional placeholder for utility functions, but 3 comments:

not have to set it to undefined, i.e. if it's not defined just leave it out of the options, it's a bit ugly to have utilFunction: undefined in most templates

move the placeholder in the stub after the main function

rename it to inlineUtilityFunctions (plural, multiple could be defined)

moritzraho · 2020-05-15T14:46:27Z

generators/add-action/analytics/index.js

@@ -43,10 +44,10 @@ class AnalyticsGenerator extends ActionGenerator {

  writing () {
    // this.registerTransformStream(beautify({ indent_size: 2 }))
-    this.sourceRoot(path.join(__dirname, '../templates'))
+    this.sourceRoot(path.join(__dirname, '../../templates'))


I understand that we now need to share the action templates, but we could make it more explicit that this is a shared top level template folder:

rename the top level template folder to common-templates

rename the utils.js and utils.test.js to utils-action.js and utils-action.test.js, just rename those in the common-template folder not when copying them to the generated code

(optional - nitpick) in action templates define the source root to '.' and do like testFile: './templates/getCollections.test.js' and sharedLibFile: '../../common-templates/utils-action.js

not renaming to util-action as discussed

moritzraho · 2020-05-15T14:55:46Z

generators/add-events/cloud-events/index.js

+    this.props = {
+      description: 'This is a sample action showcasing how to create a cloud event and publish to I/O Events',
+      // eslint-disable-next-line quotes
+      requiredParams: `['organizationId', 'apiKey', 'providerId', 'eventCode', 'payload']`,


since #44 things have changed a bit. Now you need to specify your requiredHeaders. Also organizationId is not a default parameter anymore (not in manifest nor in .env) but a request header provided by the user of the action via the x-gw-ims-org-id header.

you can take a look at this file https://github.com/adobe/generator-aio-app/pull/44/files#diff-33c1a44418497d1f2fddbe457c86e7e3R24 in the PR where a similar change moving the default paramorgId to the header x-gw-ims-org-id had to be done

moritzraho · 2020-05-15T15:00:01Z

generators/add-events/cloud-events/templates/publishEvents.test.js

+  mockLoggerInstance.error.mockReset()
+})
+
+const fakeRequestParams = { organizationId: 'fakeOrgId', apiKey: 'fakeKey', providerId: 'fakeProvider', eventCode: 'fakeEventCode', payload: {hello: 'world'}, __ow_headers: { authorization: 'Bearer fakeToken' } }


here organizationId will have to be moved to the __ow_headers according to the above comment

moritzraho · 2020-05-15T15:02:49Z

lib/constants.js

@@ -1,6 +1,7 @@
 module.exports = {
  webAssetsDirname: 'web-src',
  actionsDirname: 'actions',
+  eventsDirname: 'events',


that is not needed it seems

moritzraho · 2020-05-15T15:06:17Z

generators/add-events/index.js

+const { eventCodes } = require('../../lib/constants')
+
+// we have one actions generator per service, an action generator could generate different types of actions
+const eventCodeToActionGenerator = {


I don't think you need eventCodes as we do for the sdkCodes. Sdk codes are actual codes used by console for describing adobe APIs.
Here you can remove the constant and the two maps

moritzraho · 2020-05-15T15:06:33Z

generators/add-events/index.js

+
+    // options are inputs from CLI or yeoman parent generator
+    this.option('skip-prompt', { default: false })
+    this.option('adobe-services', { type: String, default: '' })


you don't need the adobe-services input here

moritzraho · 2020-05-15T15:08:28Z

generators/add-events/index.js

+  }
+
+  async prompting () {
+    const eventCodesList = [eventCodes.cloudEvents]


here you can just define a list that directly points to a choice i.e.
eventGeneratorChoices = [{ name: 'Publish Cloud Events to Adobe I/O', value: path.join(__dirname, 'cloud-events/index.js') }]

moritzraho · 2020-05-15T15:09:28Z

generators/add-web-assets/exc-react/index.js

@@ -31,6 +31,7 @@ class ExcReactGenerator extends Generator {
    this.props.adobeServices = this.options['adobe-services'].split(',').map(x => x.trim())
    this.props.projectName = this.options['project-name']
    this.props.sdkCodes = sdkCodes
+    this.props.eventCodes = eventCodes


I don't think eventCodes are needed in web-assets templates

@sangeetha5491 I think you can get rid of the eventCodes here

moritzraho · 2020-05-26T13:31:46Z

generators/add-events/cloud-events/index.js

+        label: 'please provide your Adobe I/O Events organization id and api key',
+        vars: [
+          'EVENTS_ORGANIZATION_ID',
+          'EVENTS_API_KEY'


@sangeetha5491 there is one more change to do 😅 We've just merged a PR (#57) where all actions template use now a unique SERVICE_API_KEY env variable that is globally set. So you can remove EVENTS_API_KEY from the dotenv list and in the actionManifestConfig you should change apiKey: '$EVENTS_API_KEY' for apiKey: '$SERVICE_API_KEY' 🙏

moritzraho

some small formatting issues, then we can merge :)

moritzraho · 2020-05-27T12:34:59Z

generators/add-events/cloud-events/index.js

+
+  async prompting () {
+    this.props.actionName = await this.promptForActionName(
+      'creates messages in Cloud events format and publishes to Adobe I/O Events',


Cloud in lower case ?

moritzraho · 2020-05-27T12:38:01Z

generators/add-events/cloud-events/index.js

+    .id('randomId')
+  return cloudevent.format()
+}
+      `,


please use no tab line 36 this will create whitespaces in the generated file

moritzraho · 2020-05-27T12:38:24Z

generators/add-events/cloud-events/index.js

+    } else if (published === undefined) {
+      logger.info('Published to I/O Events but there were not interested registrations')
+      statusCode = 204
+    } 


trailing whitespace at the eol

(I know the formatting is annoying, eventually would be good to have an auto beautifier for the generated files)

moritzraho · 2020-05-27T12:48:16Z

generators/add-web-assets/exc-react/index.js

@@ -31,6 +31,7 @@ class ExcReactGenerator extends Generator {
    this.props.adobeServices = this.options['adobe-services'].split(',').map(x => x.trim())
    this.props.projectName = this.options['project-name']
    this.props.sdkCodes = sdkCodes
+    this.props.eventCodes = eventCodes


@sangeetha5491 I think you can get rid of the eventCodes here

moritzraho · 2020-05-27T12:52:04Z

generators/common-templates/stub-action.js

@@ -62,4 +62,6 @@ async function main (params) {
  }
 }

+<% if (locals.inlineUtilityFunctions) { %><%- inlineUtilityFunctions %><% } %>


could you remove the blank lines 64 and 66?

moritzraho · 2020-05-28T09:15:44Z

oh actually before we merge there is a test failing: https://travis-ci.com/github/adobe/generator-aio-app/jobs/340844121

sangeetha5491 added 2 commits May 7, 2020 16:29

adding template to publish to I/O Events

0a3a9ed

Merge branch 'master' into CI-3536

d1d2973

meryllblanchet requested review from moritzraho and shazron May 12, 2020 08:52

meryllblanchet added the enhancement New feature or request label May 12, 2020

sangeetha5491 and others added 2 commits May 14, 2020 14:43

renaming and reducing events actions

dbc2a49

resolve merge conflicts

9284fec

moritzraho requested changes May 15, 2020

View reviewed changes

Merge branch 'master' into CI-3536

ec4f5a9

moritzraho reviewed May 26, 2020

View reviewed changes

sangeetha5491 added 5 commits May 27, 2020 14:49

address review comments and add unit tests

e090a75

Merge branch 'master' into CI-3536

c7dfc90

use service api key

2c1c389

fix test

a4f49fe

add unit tests

20bf183

moritzraho requested changes May 27, 2020

View reviewed changes

sangeetha5491 added 3 commits May 27, 2020 20:06

address review comments and add uuid

9b594bf

rename cloud-events to publish-events

019af0a

fix bug

5444f1a

moritzraho approved these changes May 28, 2020

View reviewed changes

fix test

bcb7d0c

moritzraho merged commit fdf35ed into adobe:master May 28, 2020

This was referenced Feb 5, 2024

[Snyk] Upgrade @adobe/generator-add-web-assets-exc-raw-html from 0.2.6 to 1.0.1 Gr00nd-INC/generator-aio-app#5

Open

[Snyk] Upgrade @adobe/generator-add-web-assets-exc-react from 0.2.6 to 1.0.1 Gr00nd-INC/generator-aio-app#6

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Adding template to publish to I/O Events #41

Adding template to publish to I/O Events #41

sangeetha5491 commented May 7, 2020

moritzraho left a comment

moritzraho May 15, 2020

moritzraho May 15, 2020

sangeetha5491 May 26, 2020

moritzraho May 15, 2020

moritzraho May 15, 2020

moritzraho May 15, 2020

moritzraho May 15, 2020

moritzraho May 15, 2020

moritzraho May 15, 2020

moritzraho May 15, 2020

moritzraho May 15, 2020

moritzraho May 27, 2020

moritzraho May 26, 2020 •

edited

Loading

sangeetha5491 May 27, 2020

moritzraho left a comment

moritzraho May 27, 2020

moritzraho May 27, 2020

moritzraho May 27, 2020

moritzraho May 27, 2020

moritzraho May 27, 2020

moritzraho May 27, 2020

moritzraho commented May 28, 2020

Adding template to publish to I/O Events #41

Adding template to publish to I/O Events #41

Conversation

sangeetha5491 commented May 7, 2020

Description

Related Issue

Motivation and Context

How Has This Been Tested?

Screenshots (if appropriate):

Types of changes

Checklist:

moritzraho left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

moritzraho May 26, 2020 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

moritzraho left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

moritzraho commented May 28, 2020

moritzraho May 26, 2020 •

edited

Loading