Deploying Async TypeScript Functions to Google Cloud Run: A Step-by-Step Guide

8 August 2024

DESCRIPTION: Learn how to deploy async TypeScript functions to Google Cloud Run and improve your serverless development experience.
Deploying Async TypeScript Functions to Google Cloud Run: A Step-by-Step Guide

Understanding the Challenge

When working with asynchronous code in TypeScript, deploying it to a cloud-based environment like Google Cloud Run can be a daunting task. The async keyword and its accompanying await expressions make it difficult for deployment scripts to handle the function’s execution flow.
In this article, we will explore how to deploy async TypeScript functions to Google Cloud Run, focusing on the specific challenges and solutions that come with asynchronous code.

Setting Up Your Environment

Before we dive into the deployment process, ensure you have the following set up:

A Google Cloud account (sign-up if you don’t have one)
The @google-cloud/run package installed in your project (npm install @google-cloud/run)
TypeScript 4.x or higher configured in your project

Creating an Async TypeScript Function

For this example, let’s create a simple async function that simulates a long-running operation:

import { CloudRun } from '@google-cloud/run';
async function myAsyncFunction(): Promise<void> {
    console.log('Starting the long-running operation...');
    await new Promise(resolve => setTimeout(resolve, 5000)); // Simulate a 5-second delay
    console.log('Operation completed!');
}
export async function handler(request: CloudRun.Request): Promise<CloudRun.Response> {
    return { result: myAsyncFunction() };
}

This example demonstrates an async function (myAsyncFunction) that uses the await keyword to pause execution for 5 seconds. The handler function, required by Cloud Run, simply calls and returns the result of myAsyncFunction.

Deploying to Google Cloud Run

Now, let’s deploy this async function to Cloud Run:

import { CloudRun } from '@google-cloud/run';
const cloudRun = new CloudRun();
// Create a deployment with the handler function
const deployment = await cloudRun.deploy({
    id: 'my-deployment',
    region: 'us-central1', // Replace with your desired region
    platform: 'nodejs14', // This matches the runtime of our project
    handlers: [{ handler, options: { method: 'GET' } }],
});
// Get the URL for our deployment
const url = await cloudRun.url(deployment);
console.log(`Your async TypeScript function is now deployed to ${url}!`);

In this example, we use the @google-cloud/run package to deploy our async function to Cloud Run. We specify the region, platform (which matches our project’s runtime), and handlers for the deployment.

Conclusion

Deploying async TypeScript functions to Google Cloud Run requires a clear understanding of how asynchronous code interacts with cloud-based environments. By setting up your environment correctly, creating an async function that handles long-running operations, and deploying it using the @google-cloud/run package, you can successfully deploy such functions and improve your serverless development experience.
Make sure to test and refine your deployment process as needed to accommodate specific requirements in your projects.

Poespas Blog