Skip to main content

Code Component Usage

The code component allows you to execute product or industry-specific code within an integration. This page outlines when and how to use a code component.

Why Use a Code Component?#

You will likely have integration logic that can't be solved using the standard components Prismatic provides. The portion of your integrations that are specific to your product or industry can be accomplished using code component steps, or custom components.

When to Use a Custom Component Instead#

Code component steps should be succinct and integration-specific. If the code you write could be reused in other integrations, or if the code is complex enough that it would benefit from unit tests, etc., you should use a custom component instead.

Adding a Code Component to an Integration#

Within the integration designer, add a step to your integration. Select the Code component, Code Block action.

You will be presented with a new code step in your integration, and you can click the "Edit" button to open the code editor:

Code editor in Prismatic app

Code Structure#

The code component provides a stub function by default. Let's examine the structure of the code:

module.exports = async (context, stepResults) => {  return { data: null };};

The code component requires you to export an asynchronous function. The default code uses arrow function notation to create an async function to return.

Code Component Parameters#

This function is provided a few parameters:

  1. The first positional parameter, context, is comprised of several properties:
    • logger allows you to write out log lines.
    • configVars lets you access config variables (including connections).
    • instanceState, crossFlowState and executionState gives you access to persisted state.
    • stepId is the ID of the current step being executed.
    • executionId is the ID of the current execution.
    • webhookUrls contains the URLs of the running instance's sibling flows.
    • webhookApiKeys contains the API keys of the running instance's sibling flows.
    • invokeUrl was the URL used to invoke the integration.
    • customer is an object containing an id, name, and externalId of the customer the instance is assigned to.
    • instance is an object containing an id and name of the running instance.
  2. The second positional parameter, stepResults, is an object that contains output from previous steps of the integration.

Logging#

context.logger is an object that can be used for logging and debugging. context.logger has four functions: debug, info, warn, and error. For example:

module.exports = async (context, stepResults) => {  context.logger.info("Things are going great");  context.logger.warn("Now less great...");};
// or
module.exports = async ({ logger }, stepResults) => {  logger.info("Hello World");};

Config Variables#

context.configVars provides the Code Component with access to all config variables, including connections, associated with the integration.

You can add config variables to your integration by clicking the Config Variables button in the integration designer.

Add config variables in Prismatic app

If you create a config variable Acme ERP Endpoint, you could reference that config variable in a code component block with context.configVars["Config Variable Name"] syntax:

module.exports = async ({ configVars }, stepResults) => {  const fuelApiUrl = `${configVars["Acme ERP Endpoint"]}/fuel`;  // ...};

Notice that the step output on the left-hand side shows a proper endpoint with /extrapath appended to it:

Test runner showing endpoint as output in Prismatic app

Connections#

Connections are a special type of config variable. You can access the contents of a connection the same way that you would any other config variable. In this example, suppose you have a connection config variable named Acme ERP Connection that contains two fields, tenantId and apiKey:

Destructuring a connection config variable
module.exports = async ({ logger, configVars }, stepResults) => {  const {    fields: { tenantId, apiKey },  } = configVars["Acme ERP Connection"];  const result = await doAThing({ tenantId, apiKey });  return { data: result };};

Credentials#

Credentials are deprecated

Credentials are being phased out in favor of connections. You can read about this change on our blog.

The credential object that is passed in to a code component function contains any credentials that are bound to the function.

Any type of credentials can be associated with a code component.

In this example we have a code component step that accesses a username / private_key pair that is associated with it. It throws an error if no credentials is passed in, or if the credential is of a type other than private_key:

module.exports = async ({ logger, configVars, credential }, stepResults) => {  if (credential?.authorizationMethod !== "private_key") {    throw "This step requires a private key credential.";  }  const { username, private_key } = credential.fields;  console.log(    `This is terrible security practice, but here's your username: "${username}" and private key: "${private_key}"`  );  return { data: null };};

Referencing Previous Step Outputs#

Most steps of an integration return some sort of value. An HTTP - GET action, for example, might return a JSON payload from a REST API. An Amazon S3 - Get Object will return a binary file pulled from S3.

The code component can reference those outputs through the stepResults parameter. stepResults is an object that contains results from all previous steps.

For example, if you have an HTTP - GET step named Fetch Users List that pulls down an array of users from https://jsonplaceholder.typicode.com/users, you can generate an array of email addresses with this code:

module.exports = async (context, stepResults) => {  const userArray = stepResults.fetchUsersList.results;  const emailArray = userArray.map((user) => user.email);  return { data: emailArray };};
Step results are often objects

Many components return objects that have multiple keys. So, you can reference stepResults.myStepName.results.someKey. It's rare for a component to return serialized JSON, so there's rarely need to JSON.parse() results from a previous step.

Previous Steps Names as Variables#

Since names of steps can include spaces and non-JavaScript-friendly characters, alphanumeric characters of step names are converted to camelCase. So, a step named Download JSON from API would be converted to downloadJsonFromApi. You can test out step name -> referenceable name conversions here:

Referencing Integration Trigger Payload Data#

The integration trigger is simply another step that can have a unique name. Suppose an integration is triggered by a webhook, the trigger is named "My integration trigger", and the webhook is provided a payload body.data of {"exampleKey": "exampleValue"}.

Reference integration trigger payload in Prismatic app

That exampleKey would be accessible using stepResults.myIntegrationTrigger like so:

module.exports = async ({ logger }, stepResults) => {  const exampleKey =    stepResults.myIntegrationTrigger.results.body.data.exampleKey;  logger.info(`Received '${exampleKey}'`);};

Using JavaScript destructuring, you can instead write this:

module.exports = async (  { logger },  {    myIntegrationTrigger: {      results: {        body: {          data: { exampleKey },        },      },    },  }) => {  logger.info(`Received '${exampleKey}'`);};

Notice the logged message in the testing pane

Test runner step results in Prismatic app

Code Component Return Values#

The code component can optionally return a value for use by a subsequent step. The return value can be an object, string, integer, etc., and will retain its type as the value is passed to the next step.

The return value is specified using the data key in the return object.

In this example we return a string with value "https://ipinfo.io/ip":

module.exports = async (context, stepResults) => {  return { data: "https://ipinfo.io/ip" };};

The output can be used as input for the next step by referencing codeComponentStepName.results.

Use output for prior step for input to new step in Prismatic app

To see an example of returning more complex data structures, and a good example use case for a code component, see the Using a Code Component to Transform Data quickstart.

Returning Binary Data from a Code Component#

Sometimes you'll want your code component to return binary data (like a rendered image or PDF). To do that, return an object with a data property of type Buffer (a file buffer), and a contentType property of type String that contains the file's MIME type:

module.exports = async (context, stepResults) => {  // ...  const fileBuffer = SomePdfLibrary.generatePdf();  return {    data: fileBuffer,    contentType: "application/pdf",  };};

To see an example use case for returning binary data from a code component, check out our Generate a PDF with a Code Component.

For More Information: Using a Code Component to Transform Data

Adding Dependencies to a Code Component#

If your code component depends on node modules from npm, dependencies will automatically be imported. For example, if your code component reads:

const fetch = require("node-fetch@2.6.1/lib/index.js");
module.exports = async (context, stepResults) => {  const response = await fetch("https://jsonplaceholder.typicode.com/todos/1");  const responseJson = await response.json();  return { data: responseJson };};

Then node-fetch version 2.6.1 will be imported as a dependency automatically from the UNPKG CDN.

You should specify specific known working versions of npm packages for your code component:

const lodash = require("lodash@2.4.2");const fetch = require("node-fetch@2.6.1/lib/index.js");

You can require any file from npm using package[@version][/file] syntax. Note that with the lodash import above, no file was specified. If no file is specified, the main file defined in the npm package's package.json is imported. An explicit path was called out for the node-fetch import because the node-fetch package defaults to importing a browser version of the package, and we want a compiled server version instead.

Using Spectral Utility Functions in the Code Component#

Prismatic's SDK, @prismatic-io/spectral is automatically imported into each code block as spectral. You can reference any utility functions that Spectral declares.

For example, if you need to cast a truthy "NO" string to a boolean, you can do this:

module.exports = async ({ configVars }, stepResults) => {  const doAThing = spectral.util.types.toBool(configVars["Do a Thing?"]);  if (doAThing) {    return "Did a thing";  } else {    return "Didn't do a thing";  }};

A list of all util type functions is available in the Spectral SDK docs.