Functions

Table of contents

• What are Functions
• Use case: Custom external references
  • Examples
• Use case: App Events
  • Examples
• Use case: App Actions
  • Examples
• Limitations
• Get started with Functions
  • Custom external references setup
  • App Event Functions setup
  • App Actions Functions setup
• Inspect Function invocations and logs
• Using the CMA
• Feedback

What are Functions?

Functions are serverless workloads that run on Contentful’s infrastructure to provide enhanced flexibility and customization. You can use Functions to:

• connect to external systems and enrich the response of requests issued through Contentful's GraphQL API,
• filter, transform, and handle events coming from Contentful without having to set up your own server, or
• easily add a backend component to your app that can process actions triggered by the frontend, the CMA, or even by other apps.

Function workloads are executed in a sandboxed runtime environment. For more information, see the Function limitations section.

Use case: Custom external references

At times, you may need to reference content stored outside of Contentful. With Custom external references you can seamlessly integrate your custom code within the delivery context. Some of our marketplace apps, such as Shopify, Commercetools and Cloudinary, already have out-of-the-box support for this feature. For more information, see the Custom external references page.

Custom external references examples

The following diagram displays the Function request flow:

The Function event handler can parse two different types of events:

1. GraphQL field mapping event – the information returned by your function for this event is used to decide which GraphQL type is exposed on the additional _data field.
2. GraphQL query event - your function will receive this event whenever we want to get data for a GraphQL request. This includes introspection queries.

The Function event handler can return two different types of responses:

1. Field mapping response.
2. Query response.

Each field that is configured with Functions, must map to a schema. We need to know the relation with the field and the corresponding GraphQL type in the Function. Therefore, the field mapping response should include a field mapping for each field.

Given the schema below:

type Query {
  product(id: String!): Product
}

type Product {
  title: String!
  description: String
  inStock: Int!
}

Here is the typing for GraphQLFieldMapping:

type GraphQLFieldTypeMapping = {
  contentTypeId: string
  fieldId: string
  graphQLOutputType: string
  graphQLQueryField: string
  graphQLQueryArguments: Record<string, string>
}

GraphQLFieldTypeMapping would have the following values for the product field:

The information coming in the event.fields array in the field mapping event is driven by the annotations that are added to the field once you enable Resolve content on delivery checkbox.

To get the schema, we run an introspection query that ends up triggering the graphql.query event. Note that this might happen repeatedly, and not when you install an app.

Use case: App Events

Subscribing to App Events unlocks powerful hooks into the content lifecycle, but it requires setting up and hosting a backend app. Using Functions with App Events, developers gain access to a fully managed, scalable, and resilient serverless workflow that eliminates the need for custom backend infrastructure.

Functions streamline interaction with App Events, simplifying the process for developers. They can be used to:

• orchestrate intricate workflows across various services.
• perform resolution and hydration of data from external systems.
• implement custom logic to manage event-triggered builds or cache invalidation.

The following App Event functions are supported:

• Filter functions that run before any other processing, and are used to determine whether events are triggered or discarded.
• Transformation functions that run before request signing, and are used to modify the headers and body of the request.
• Handler functions that can be used as the target of the event, as opposed to targeting a URL.

All three function types receive the same headers and body as a traditional App Event.

App Event Function Examples

Use Case: App Actions

Functions can be linked to and then invoked via App Actions, which provides apps an easy way to expose generic capabilities to their own frontends as well as to other apps.

Similar to App Event functions, App Action functions receive the same headers and body as a traditional App Action.

App Action Function Examples

Limitations

Functions platform:

• There is a limit of 50 Functions per Contentful app definition.
• Custom external references run only for uncached requests.
• Custom external references can only be used with short Text or JSON object field types.
• Custom external references allow you to integrate with external GraphQL APIs. You can also integrate with external REST APIs, but you have to provide your own GraphQL server implementation. For more information on the REST API implementation, see our PotterDB for REST example.
• Functions that resolve data in the delivery context are not currently compatible with live updates when using live preview.

Functions execution environment:

• A Function has a maximum execution time of 30 seconds.
• A Function can make at most 20 HTTP requests per event.
• Function code does not have access to the filesystem.
• Functions have limited CPU and Memory resources available. Exceeding these resources will terminate the Function.

Get started with Functions

To build a custom Function:

1. Start by creating a custom Contentful App. To quickly scaffold a new app with TypeScript support and an example Function, run the following command: npx create-contentful-app@latest <app-name> --function <function-type>. Replace <app-name> with your desired app name, and replace <function-type> with one of the following:
   • external-references
   • appevent-filter
   • appevent-transformation
   • appevent-handler
2. Build your app by running the following command: npm run build.
3. Upload your app to Contentful by running npm run upload.
4. Install your app.

At this point, your custom Function is ready to be used within Contentful, and you have just a few more steps left to enable it. Use the following custom external references setup procedure when building Custom external references Functions, or the app event functions setup steps when building App Event Functions.

Custom external references setup

If building an Custom external references Function, follow these steps to link it to a content type and use it in a GraphQL request:

1. Create a content type.
   Important:To use the Functions, make sure you select your app in the Appearance section of the Content Type field settings and enable the Resolve content on delivery checkbox.

2. Create an entry.
3. Make a GraphQL request. You can use the GraphQL Playground app to try this easily.

query {
  topicProduct(id: "ENTRY_ID") {
    myField
    myField_data {
      foo
    }
  }
}

Within the topicProduct content type, there is a field named myField which represents the content within topicProduct. The query also contains a reference to myField_data. The _data suffix in the field name implies that it is intended for use with functions. Functions are custom functions that retrieve content, and the _data suffix is a convention to signify that the field is designed to access content fetched through these functions. The foo type comes from the schema used in the function implementation.

Here is an example Response with resolved data from the function:

{
  "data": {
    "topicProduct": {
      "myField": "this is a test",
      "myField_data": {
        "foo": "hello world"
      }
    }
  }
}

App Event Functions setup

If building an App Event function, follow these steps to link it to an App Event Subscription:

1. Navigate to the Events tab of your app definition in the organization settings, and ensure the Enable events option is active for your app.

2. Select the topics you would like to trigger your function.

3. Use the dropdown menus on this page to select the functions you would like to invoke. You may select one filter function, one transformation function, and one handler function.

4. Click the Save button in the top right to preserve your selections.

   NOTE: You can also perform these actions via the Content Management API (CMA) by issuing a request to update or subscribe to events.

5. Trigger a targeted action within Contentful to invoke your function. For example, if you subscribed to the Entry.create topic, create an entry to invoke your function.

App Action Functions setup

Once you've created your App Action function, follow these steps to link it to an App Action:

1. Navigate to the Actions tab of your app definition in the organization settings, and add a new action using the Add action button or edit an existing action by clicking the Edit menu option within the more actions menu (three horizontal dots) next to the existing action.

2. Select the function-invocation action type.

3. Use the dropdown menu to select the function you would like to invoke.

4. Click the Save action button at the bottom of the panel to preserve your selections.

   NOTE: You can also perform these actions via the Content Management API (CMA) by issuing a request to create an action or update an existing action.

5. Now that your function is linked to your App Action, you can invoke it by using the CMA to trigger an App Action Call. To read more about this process, see the App Actions documentation.

Inspect Function invocations and logs

To get a better understanding of how your function is performing, you can inspect the invocations and log output. To inspect the invocations and log output:

1. Navigate to the App configuration page in the Contentful web app.
2. Select the Functions tab.
3. Open the menu of the function you want to inspect and select View logs.

4. On the Function logs page, select the space and environment the app is installed in. A list of all the function invocations in the selected space and environment is displayed.
5. Click on an invocation to see the log output of the function.

6. At the top of the drawer, expand the Event section to see the event that triggered the function. Below that, the log output of the function is displayed.

Using the CMA

The FunctionEventContext passed into App Event and App Action function invocations contains an authenticated contentful-management.js client. This client simplifies the execution of CMA requests within the function on behalf of the App Identity.

Feedback

Functions are continuously evolving to better meet your needs. We'd love to hear about your experience using Functions and the use cases you're looking to implement.

To share your feedback, follow this this link.