Tutorials

Now Available: Upstash Redis

clock-icon

15 minutes read

writer-avatar

Andreia Ocanoaia

Nov 22, 2023

Share on:

linkedin-icon

Upstash Redis simplifies data storage and access, making it a natural fit for serverless web applications and cloud-native architectures. Its key-value store functionality allows for rapid data access, making it ideal for caching frequently accessed data and improving overall application performance. Redis also supports complex data structures such as lists, sets, and hashes, providing versatility in data modeling.

Today, we are excited to announce the integration with Upstash Redis, a serverless Redis provider, into the genezio platform. The integration allows you to easily manage and connect Redis databases directly from the genezio dashboard.

Use cases

Out-of-the-box caching system

Redis is often used as a caching layer to store frequently accessed data in memory, reducing the need to fetch data from slower disk-based databases. This can significantly improve application performance.

Use genezio classes to implement a boilerplate-free caching system that stores data in Redis.

import { GenezioDeploy } from "@genezio/types";
import Redis from "ioredis";

@GenezioDeploy()
export class EcommerceCacheService {
  client: Redis;

  constructor() {
    this.client = new Redis(process.env.REDIS_URL);
  }

  cacheProductDetails(productId: string, productDetails: string): Promise<boolean> {
    const key = `product:${productId}`;
    await this.client.set(key, productDetails, "EX", expirationInSeconds);

    // the rest of the implementation goes here
  }

  getCachedProductDetails(productId: string): Promise<string | null> {
    const key = `product:${productId}`;
    const cachedProductDetails = await this.client.get(key);

    // the rest of the implementation goes here
  }
}

Session storage

Storing session data in Redis is a common practice. Because of its speed, Redis is well-suited for managing user sessions in web applications. It allows for quick and efficient retrieval of user-specific information.

import { GenezioDeploy } from "@genezio/types";
import Redis from "ioredis";

@GenezioDeploy()
export class EcommerceSessionService {
  client: Redis;

  constructor() {
    this.client = new Redis(process.env.REDIS_URL);
  }

  storeSessionData(userId: string, sessionData: string): Promise<boolean> {
    await this.client.set(`user:${userId}:session`, sessionData);

    // the rest of the implementation goes here
  }

  getSessionData(userId: string): Promise<string | null> {
    const sessionData = await this.client.get(`user:${userId}:session`);

    // the rest of the implementation goes here
  }
}

Pub/Sub Messaging

Redis has built-in support for publish/subscribe messaging patterns. It can be used as a message broker to facilitate communication between different components of a system in a decoupled manner.

Rate limiting

Redis can be used to implement rate-limiting mechanisms. By tracking and controlling access rates for different operations, Redis helps prevent abuse and ensures the stability and performance of an application.

Connect your backend to Upstash Redis

In this short guide, you will learn how to integrate a Redis database into your project.

Step 1: Create a new genezio project

If you already have a genezio project deployed, you can skip to Step 2: Initialize an Upstash Redis database.

Otherwise, you can create a new genezio project by running the following steps.

First, you have to install genezio from npmjs:

npm install genezio -g

Then, you can create a new genezio project by simply running genezio in your terminal:

genezio create backend --backend=ts --name=getting-started-with-upstash --region=us-east-1

The next step is to integrate this small project with a Redis database provided by Upstash. To do that, we first need to deploy the project. We can do that by running the following commands in the root directory of the project:

genezio deploy

Step 2: Initialize an Upstash Redis database

Once the deployment is complete, open your genezio dashboard and pick the project you created earlier.

Go to the Integrations tab and select to install the Upstash Redis integration:

Alt text

Connect with an Upstash account using the preferred login method:

Alt text

Create a Redis database or select an already existing database:

Alt text

Hit the Save button to set the database credentials as environment variables in your genezio project:

Alt text

Step 3: Connect your backend to the Redis database

To connect to the Redis database from your NodeJs backend, create a new file called redis.ts in the root folder of your project.

The following code snippet creates a new class that will be a minimal Redis service. In the constructor, we initialize the Redis client using the UPSTASH_REDIS_URL environment variable. This variable is already set remotely in your project by the Upstash Redis integration.

import { GenezioDeploy } from "@genezio/types";
import Redis from "ioredis";

@GenezioDeploy()
export class ShoppingCartService {
  client: Redis;
  constructor() {
    if (!process.env.UPSTASH_REDIS_URL) {
      throw new Error("UPSTASH_REDIS_URL is not set in the `.env` file.");
    }
    this.client = new Redis(process.env.UPSTASH_REDIS_URL);
  }
}

Step 4: Store and retrieve data from Redis

Implement two methods to store and retrieve <key, value> pairs in the Redis database:

@GenezioDeploy()
export class ShoppingCartService {
  client: Redis;
  constructor() {
    if (!process.env.UPSTASH_REDIS_URL) {
      throw new Error("UPSTASH_REDIS_URL is not set in the `.env` file.");
    }
    this.client = new Redis(process.env.UPSTASH_REDIS_URL);
  }

  addItemToCart(cartId: string, productId: string, quantity: number): Promise<boolean> {
    const cartKey = `cart:${cartId}`;
    await this.client.set(`${cartKey}:${productId}`, quantity);

    // the rest of the implementation goes here
  }

  getCartContents(cartId: string): Promise<Map<string, number> | null> {
    const cartKey = `cart:${cartId}`;
    const cartItems = await this.client.keys(`${cartKey}:*`);

    // the rest of the implementation goes here
  }
}

Step 5: Test your Redis service

To locally test your Redis service, you have to use the copy button to add the environment variables to your clipboard. Using the copy button will disclose the sensitive information from the environment variables. Paste them in a .env file in the root folder of your project.

You can find the environment variables in the Integrations tab of your project page in the dashboard .

The .env file should look similar to the following snippet:

UPSTASH_REDIS_URL="redis://default:sensitivepassword@cute-capybara-33897.upstash.io:33897"
UPSTASH_REDIS_REST_URL="https://cute-capybara-33897.upstash.io"
UPSTASH_REDIS_REST_TOKEN="sensitivetoken"

After setting the environment variables, you can test your Redis service by running the following command in your terminal:

genezio local

Open the testing page in your browser by navigating to https://app.genez.io/test-interface/local?port=8083 .

Here you can create and send a request to your backend to test if it works as expected.

Step 5: Deploy your application

After you tested your application, you can deploy it by running the following command in your terminal:

genezio deploy

Now available in the genezio dashboard

The integration with Upstash Redis is available today in the genezio dashboard.

It might not be perfect yet, but we prefer bringing you new features sooner, rather than later. Your feedback in the early stages of feature development is essential to us as it helps improve the product to better suit your needs.

We’re thrilled about the amazing use cases the Upstash Redis integration will enable and we can’t wait to see what you’ll put together with it.

Check out our documentation and try the Upstash Redis integration today! Let us know your thoughts and feedback through our support chat or on our Discord server .

Subscribe to our newsletter

Genezio is a serverless platform for building full-stack web and mobile applications in a scalable and cost-efficient way.



Related articles


More from Tutorials