elasticio/petstore-component-nodejs

elastic.io component for the Petstore API

Petstore Component Node.js

Description

A fully working and operational component template to use for starting development of your own component for the elastic.io platform. This component comes with a basic architecture which you can use on the platform.

The component interacts with the petstore sample server.

Our documentation on building components in nodejs has more about each including file and their function.

Requirements

To use this component you must be registered platform user. Please see our home page at https://www.elastic.io to learn how to register.

Authentication

To authenticate use secret as an API key. For more details see the Petstore API docs.

Triggers

Get Pets By Status

Retrieves pets from the Petstore API by given pet status using Dynamic or Static Data Sample. The difference is how these functions are made. However, both can have the following statuses defined by the Petstore API:

• Available - select to get all pets with status Available.
• Pending - select for Pending.
• Sold - select for Sold.

Actions

Creates a new pet

Creates a new Pet by making a POST to /pet endpoint of the API. The input fields are:

• petId (required) - the Id of the pet.
• name - the name of the pet.
• status - the status which can have one Available, Pending and Sold values.

File Structure

The structure of petstore-component-nodejs component is quite flexible. elastic.io platform expects only two files to be present in the main directory. These are the component.json and package.json. Our documentation on how to build a component in node.js has more about each file and their function.

petstore-component-nodejs's Issues

Add sample on dynamic metadata

Remove all mentioning about elastic.io from component.json and other needed places

petstore-component-nodejs documentation should have ability to be white-labeled easily

Description: petstore-component-nodejs should have ability to be white-labeled easily

Broken link in readme

I am interested in writing a component, but the nice sounding link at the end of the readme is broken:

https://support.elastic.io/support/solutions/articles/14000027123-how-to-build-a-component-in-node-js

Petstore. Update component to new sailor version / use new logger functionality / dockerize

DoD
Development:

• use new logger
• component should be dockerised, add: "buildType":"docker" line into component.json
• sailor version is changed from -.-.- to -.-.-
• CHANGELOG.md is updated
  QA:
• Smoke test is finished
• Regression testing is finished (optional)
• Component is deployed to the production stage (app.elastic.io) and/or another required stage

Error if pet status starts with a small letter

While following the instruction given in our online documentation https://docs.elastic.io/getting-started/webhooks-flow.html, we encountered problem if the pet status is given in small letter. This was not an issue in the previous version of the component.

Here is input JSON:

{
  "petname": "Gromit",
  "petstatus": "sold"
}

Here is the mapping stage:

Here is the result with an error:

Starting your Docker container ...
Starting application in apprunner...
[INFO  tini (1)] Spawned child process '/run.sh' with pid '7'
Will try to start app at /home/apprunner
node: /usr/lib/libstdc++.so.6: no version information available (required by node)
node: /usr/lib/libstdc++.so.6: no version information available (required by node)
node: /usr/lib/libstdc++.so.6: no version information available (required by node)
node: /usr/lib/libstdc++.so.6: no version information available (required by node)
node: /usr/lib/libstdc++.so.6: no version information available (required by node)
node: /usr/lib/libstdc++.so.6: no version information available (required by node)
node: /usr/lib/libstdc++.so.6: no version information available (required by node)
node: /usr/lib/libstdc++.so.6: no version information available (required by node)
invokeModuleFunction – init is not found
Checking if incoming messages is lightweight...
Checking if incoming messages is lightweight...
Empty headers so not lightweight.
Message processed, going to emit
About to process message...
Error: Status is required
    at TaskExec.process (/home/apprunner/lib/actions/createPet.js:42:11)
    at /home/apprunner/node_modules/elasticio-sailor-nodejs/lib/executor.js:33:62
    at new Promise (<anonymous>)
    at TaskExec.process (/home/apprunner/node_modules/elasticio-sailor-nodejs/lib/executor.js:32:9)
    at /home/apprunner/node_modules/elasticio-sailor-nodejs/lib/sailor.js:341:22
    at new Promise (<anonymous>)
    at Sailor.runExec (/home/apprunner/node_modules/elasticio-sailor-nodejs/lib/sailor.js:317:15)
    at Sailor.processMessage (/home/apprunner/node_modules/elasticio-sailor-nodejs/lib/sailor.js:661:20)
    at processTicksAndRejections (internal/process/task_queues.js:93:5)
    at async Sailor.processMessageAndMaybeShutdownCallback (/home/apprunner/node_modules/elasticio-sailor-nodejs/lib/sailor.js:194:20)
    at async readAndProcess (/home/apprunner/node_modules/elasticio-sailor-nodejs/lib/amqp.js:238:21)
    at async Promise.all (index 0)
    at async Amqp.listenQueue (/home/apprunner/node_modules/elasticio-sailor-nodejs/lib/amqp.js:249:9)
    at async putOutToSea (/home/apprunner/node_modules/elasticio-sailor-nodejs/run.js:33:5)
    at async run (/home/apprunner/node_modules/elasticio-sailor-nodejs/run.js:78:9)
node: /usr/lib/libstdc++.so.6: no version information available (required by node)
node: /usr/lib/libstdc++.so.6: no version information available (required by node)
node: /usr/lib/libstdc++.so.6: no version information available (required by node)
node: /usr/lib/libstdc++.so.6: no version information available (required by node)
node: /usr/lib/libstdc++.so.6: no version information available (required by node)
node: /usr/lib/libstdc++.so.6: no version information available (required by node)
node: /usr/lib/libstdc++.so.6: no version information available (required by node)
[INFO  tini (1)] Spawned child process '/run.sh' with pid '6'
Starting application in apprunner...
Will try to start app at /home/apprunner
node: /usr/lib/libstdc++.so.6: no version information available (required by node)
invokeModuleFunction – init is not found
Checking if incoming messages is lightweight...
Empty headers so not lightweight.
Checking if incoming messages is lightweight...
Error occurred during trigger or action processing
Checking if incoming messages is lightweight...

The error is gone if you use the petstatus in capital letter like Sold.

Add eslint

In order to comply with code convention of PS team is required to add .eslint rules to the source code of the component.

Update to the latest sailor API version

Current sailor version is 2.2.1. Version referenced by this component is 2.2.0

Improve API error hadling

When supplying invalid pet status error looks like this:

400 - "<!DOCTYPE html>\n<html lang=\"en\">\n<head>\n<meta charset=\"utf-8\">\n<title>Error</title>\n</head>\n<body>\n<pre>Error: Parameter (body) failed schema validation<br> &nbsp; &nbsp;at throwErrorWithCode (/app/node_modules/swagger-tools/lib/validators.js:121:13)<br> &nbsp; &nbsp;at Object.module.exports.validateAgainstSchema (/app/node_modules/swagger-tools/lib/validators.js:176:7)<br> &nbsp; &nbsp;at /app/node_modules/swagger-tools/middleware/swagger-validator.js:143:22<br> &nbsp; &nbsp;at /app/node_modules/async/lib/async.js:356:13<br> &nbsp; &nbsp;at async.forEachOf.async.eachOf (/app/node_modules/async/lib/async.js:233:13)<br> &nbsp; &nbsp;at _asyncMap (/app/node_modules/async/lib/async.js:355:9)<br> &nbsp; &nbsp;at Object.map (/app/node_modules/async/lib/async.js:337:20)<br> &nbsp; &nbsp;at validateValue (/app/node_modules/swagger-tools/middleware/swagger-validator.js:136:11)<br> &nbsp; &nbsp;at /app/node_modules/swagger-tools/middleware/swagger-validator.js:343:21<br> &nbsp; &nbsp;at /app/node_modules/async/lib/async.js:356:13</pre>\n</body>\n</html>\n"

Wrong in-metadata for create PET action

Apparently Pet status is enumeration but it's not declared (or displayed) as such:

Bump dependencies and Node Version

Update the version of Sailor used

Since clients regularly use this component as a starting point, we should update to the latest version of sailor and the latest working node/npm verson so that clients using this as a starting point can make use of the latest language features.

Missing description of the action

Review component and update as this is an example of node.js component

What could be done:

• review and update code according to PS best practises (e.g: get rid of MagentoClient here

  petstore-component-nodejs/verifyCredentials.js

  Line 16 in a728a8b

  const client = new MagentoClient(this, credentials);

  petstore-component-nodejs/verifyCredentials.js

  Line 1 in a728a8b

  const MagentoClient = require('./lib/petstoreClient');

  )
• update README according to https://github.com/elasticio/professional-services-best-practices/blob/master/templates/readme-template.md
• add helplinks
• remove html tegs from notes as this is currently not supported by frontend
  
• maybe add circle.ci as an example
• use npm audit as an example
• etc