adobe / aio-cli-plugin-events Goto Github PK

aio plugins:install @adobe/aio-cli-plugin-events

Expected Behaviour

Running aio event should print the help page of the aio event plugin.

Actual Behaviour

$ aio event
    TypeError: Help is not a constructor

Steps to Reproduce

$ npm install -g @adobe/aio-cli 
[...]
$  aio plugins install @adobe/aio-cli-plugin-events
Installing plugin @adobe/aio-cli-plugin-events... installed v1.1.5
$ aio event
    TypeError: Help is not a constructor
$ aio plugins
@adobe/aio-cli-plugin-events 1.1.

Platform and Version

$ npm -v
8.5.1
$ node -v
v17.6.0

Logs taken while reproducing problem

TypeError: Help is not a constructor
(node:74901) WARNING: Exited the environment with code 1
    at exit (node:internal/process/per_thread:194:13)
    at /opt/homebrew/lib/node_modules/@adobe/aio-cli/node_modules/@oclif/errors/lib/handle.js:28:37

File .github/workflows/node.js.yml. See https://github.com/adobe/aio-cli-plugin-app/blob/5670908e7ef7ba63c903ee924520eeb018a9e448/.github/workflows/node.js.yml#L32-L36

Description

1. Click on any command link in the README
2. At the bottom of the command, the See code: link points to .ts file

Expected:

It should point to the actual code file, which ends with a .js file extension

I would suggest, to make the cli commands a bit more consistent, verbose and failsafe.

Consistency: Some aio-cli commands take "json" files as input, some are interactive. It's better to have both options in all commands. If I had to choose, I'd prefer the non-interactive way - because that can be scripted (e.g. for ci/cd)

Failsafe: If Event-Metadata is mandatory, why not have it created with aio event provider create in one command? If there is a usecase for metadata-less providers, this could be done with a flag in the command (--nometadata) .. everything else will yield an error ("please provide metadata")..

Verboseness: The provider create command could create a hint ("Don't forget to register metadata"); the provider list could have a column for "metadata" or "metadata missing".

Verboseness: When registering an event (listener) and the provider does not have metadata or the event-code to be registered is not provided we should not return a 400-bad request but what specifically went wrong. If the underlying API does not provide that information, the client could provide some hints ("please check if the provider has metadata and it aligns with the event metadata you are registering for")

See related adobe/aio-cli-plugin-console#160

Test results: https://github.com/adobe/aio-cli-plugin-events/runs/3750833638?check_suite_focus=true

via Github Actions token publish. Most probably 2FA needs to be turned off for the repo.

Right now it looks like this:

@adobe/aio-cli-plugin-events        1.1.0     <!-- Copyright 2020 Adobe. Al… July 6, 2020

I don't get the point of

 BODYJSONFILE
      Path to a file in JSON format with the information to create a new Event Registration.
      The JSON should follow the following format:
      {
         "name": "<event registration name>",
         "description": "<event registration description>",
         "delivery_type": "WEBHOOK|WEBHOOK_BATCH|JOURNAL",
         "webhook_url": "<webhook URL responding to challenge>"
         "events_of_interest": [{
           "provider_id": "<event provider id>"
           "event_code": "<event provider event_code metadata>"
         }, { <...more events> }]
      }

1. When I choose "JOURNAL" is "webhoook_url" optional (if so.. please document)
2. I thought that each provider registration implicitly creates a Journal. Where is the point in creating a Journal Event Registration?

Your module is dependent on @adobe/aio-lib-ims.

Adobe IMS is retiring TLS 1.0 and TLS 1.1 support on July 14th, 2021.
TLSv1.2 is the default for node-12 or higher: https://nodejs.org/api/cli.html#cli_tls_min_v1_2

Therefore any calls to Adobe IMS using @adobe/aio-lib-ims using node-10 will fail after the retirement date above.

This module should impose a minimum requirement of node-12 going forward.

Add this to your package.json:

{
   "engineStrict": true, 
   "engines" : { 
         "node" : ">=12" 
    }
}

Failed to add event to app ..
aio app init
aio app add events

✔ Finished running template @adobe/generator-add-events-generic
 ›   Error: [CoreConsoleAPISDK:ERROR_CREATE_OAUTH_SERVER_TO_SERVER_CREDENTIAL] 409 - Conflict 
 ›   ({"id":"XwuODNm97cd5Nrpw1vtgtfbEhCXQ6RFn","messages":[{"template":"ERR_MSG_CONFLICT","message":"Credential already exists"}]})