Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/elasticio/code-component
The holy grail of the elastic.io platform
https://github.com/elasticio/code-component
Last synced: 3 days ago
JSON representation
The holy grail of the elastic.io platform
- Host: GitHub
- URL: https://github.com/elasticio/code-component
- Owner: elasticio
- License: apache-2.0
- Created: 2015-09-25T13:35:14.000Z (about 9 years ago)
- Default Branch: master
- Last Pushed: 2024-09-12T14:33:42.000Z (2 months ago)
- Last Synced: 2024-09-13T02:21:56.604Z (2 months ago)
- Language: JavaScript
- Size: 206 KB
- Stars: 2
- Watchers: 13
- Forks: 12
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# code-component
> A code component for the [elastic.io platform](https://www.elastic.io "elastic.io platform"), runs a piece of a JavaScript code inside your integration flow.
## Documentation
Pretty much the same way that you would use any other component in our system. It is deployed by default to production,
so no need to deploy it yourself (although you could if you have extended it yourself). In our Dashboard
start building your integration and include the Code component as well. You will see a picture similar to the one below:
However, don't let the simple look fool you - it has a full-fledged interface with many very useful features like the ones you would expect from your favourite desktop developing tool:
* Syntax highlighting - a standard for any online real-time coding interface
* Code auto-completion - again a standard that you got used to from your desktop tool
* Support for number of variables and libraries within the context of the execution
* Support latest ECMAScript standard
* Run and troubleshoot within the designer interface.
## Available Variables and Libraries
Here are the available variables and libraries that can be used within the context of execution. The most up-to-date list
can always be found in be used within the context of execution or in `code.js` of the component. Below is a sample for the reference.
Built-in Node.js global objects are also supported.
### Elastic.io Specific Functionality
- `msg` - incoming message containing the payload from the previous step
- `cfg` - step's configuration. At the moment contains only one property: `code` (the code, being executed)
- `snapshot` - step's snapshot
- `messages` - utility for convenient message creation
- `emitter` user to emit messages and errors
### Other Libraries/functions
- `wait(numberOfMilliscondsToSleep)` - Utility function for sleeping
- [`request`](https://github.com/request/request) - Http Client (wrapped in `co` - [this library](https://www.npmjs.com/package/co-request) so that it is pre-promisified)
- `_` - [Lodash](https://lodash.com/)
## Code component usage Examples
Use code is very simple, just do following:
```JavaScript
async function run(msg, cfg, snapshot) {
console.log('Incoming message is %s', JSON.stringify(msg));
const body = { result : 'Hello world!' };
// You can emit as many data messages as required
await this.emit('data', { body });
console.log('Execution finished');
}
```
Please note if you have a simple one-in-one-out function you can simply return a JSON object as a result
of your function, it will be automatically emitted as data.
## Common usage scenarios
### Doing complex data transformation
[JSONata](http://jsonata.org/) is great however sometimes it's easier to do things in JavaScript, if you want to transorm
an incoming message with code, just use following sample:
```JavaScript
async function run(msg, cfg, snapshot) {
return {
addition: 'You can use code',
keys: Object.keys(msg)
};
}
```
### Calling an external REST API
It's very simple to code a small REST API call out of the Code component, see following example:
```JavaScript
async function run(msg, cfg, snapshot) {
const res = await request.get({
uri: 'https://api.elastic.io/v1/users',
auth: {
user: process.env.ELASTICIO_API_USERNAME,
pass: process.env.ELASTICIO_API_KEY
},
json: true
});
return {
fullName: res.body.first_name + " " + res.body.last_name,
email: res.body.email,
userID: res.body.id
}
}
```
## Known issues and limitations
- Credentials are not supported