Computer >> Hướng Dẫn Máy Tính >  >> Lập Trình >> Redis

Xây dựng hệ thống Quota tin cậy cho SaaS với Upstash & Next.js

Trong bài viết này, chúng tôi sẽ chỉ cho bạn cách sử dụng Upstash để tạo hệ thống quota cho ứng dụng SaaS, được làm với Next.js và Prisma. Chúng tôi sẽ sử dụng Next.js API routes để tạo một API đơn giản.

Trong nhiều ứng dụng SaaS, bạn có thể đã gặp hệ thống quota. Đó là hệ thống giới hạn số lượng hành động người dùng có thể thực hiện trong một khoảng thời gian cho trước.

Trong ví dụ của chúng tôi, một người dùng chỉ có thể gửi 1.000 yêu cầu API mỗi tháng trên gói "Free". Nếu người dùng cố gắng gửi hơn 1.000 yêu cầu API, ứng dụng sẽ chặn người dùng gửi thêm yêu cầu.

Những yêu cầu API này được dùng để truy xuất nội dung spreadsheet, và biến nó thành JSON. Đây là những gì fastsheet làm, biến bất kỳ spreadsheet Google Sheets nào thành JSON API.

Xây dựng hệ thống Quota tin cậy cho SaaS với Upstash & Next.js

Định nghĩa schema database

Như đã nói trước, chúng ta sẽ sử dụng Prisma làm ORM để tương tác với database. Đây là ví dụ của model User triển khai hệ thống quota, cũng như model Spreadsheet để lưu trữ spreadsheets:

model User {
  id        Int      @id @default(autoincrement())
  planId    String   @default("FREE")
  email     String   @unique
  quota     Int      @default(0)
  spreadsheets Spreadsheet[]
}
model Spreadsheet {
  id        Int      @id @default(autoincrement())
  userId    Int
  user      User     @relation(fields: [userId], references: [id])
  content   String
}
  • Trường planId là gói mà người dùng đăng ký.
  • Trường quota là số lượng yêu cầu API người dùng đã thực hiện trong tháng hiện tại.
  • Model Spreadsheet đại diện cho một spreadsheet, được kết nối với User.
  • Một User có thể có nhiều Spreadsheet liên kết với nó.

Để đơn giản, chúng ta chỉ xử lý gói "FREE", cho phép 1.000 yêu cầu API mỗi tháng.

Tăng quota của người dùng

Chúng ta muốn tăng quota của người dùng mỗi khi người dùng thực hiện yêu cầu API.

À đầu nhìn, điều này có vẻ dễ dàng và đơn giản. Chúng ta có thể đơn giản tăng quota của người dùng lên 1 mỗi khi người dùng thực hiện yêu cầu API trên Next.js API route của chúng ta:

// pages/api/spreadsheets/[id]/index.ts
import type { NextApiRequest, NextApiResponse } from "next";
const MAX_FREE_TIER_QUOTA = 1000;
export default async function handler(
  req: NextApiRequest,
  res: NextApiResponse,
) {
  // Get the ID of the spreadsheet from the URL.
  const { id } = req.params;
  // Get the spreadsheet and its associated user from the database.
  const spreadsheet = await prisma.spreadsheet.findUnique({
    where: { id: Number(id) },
    include: { user: true },
  });
  // Verify that the spreadsheet exists.
  if (!spreadsheet) {
    return res.status(404).json({ error: "Spreadsheet not found" });
  }
  // Verify that the user is not over the quota.
  if (spreadsheet.user.quota >= MAX_FREE_TIER_QUOTA) {
    return res.status(429).json({ error: "Quota exceeded" });
  }
  // Increase the user's quota by 1.
  await prisma.user.update({
    where: { id: spreadsheet.user.id },
    data: { quota: { increment: 1 } },
  });
  // Return the spreadsheet's content.
  return res.json({ content: spreadsheet.content });
}

Tuy nhiên, có vấn đề với cách tiếp cận này, nó không nhanh như nó nên.

Thực tế, chúng ta đang tạo transaction database để tăng quota của người dùng trên mọi yêu cầu API.

Chúng ta truy cập database để lấy quota của người dùng, tạo transaction để tăng quota lên 1, và sau đó gửi nội dung spreadsheet.

Điều này không tối ưu vì nhiều lý do:

  • Database của bạn có thể chậm, điều này sẽ làm chậm thời gian phản hồi.
  • Database của bạn có thể xa server của bạn, điều này sẽ lại làm chậm thời gian phản hồi.
  • Code này khó làm Edge compatible, bạn cần tạo nhiều bản sao database trên khắp thế giới (không phải việc dễ dàng!).

Sử dụng Upstash để tăng quota người dùng

Để giải quyết vấn đề này, chúng ta sẽ sử dụng Upstash Redis® để tăng quota của người dùng. Upstash Redis® là cơ sở dữ liệu Redis® nhanh và tin cậy, được lưu trữ trên cloud, được tạo cho môi trường serverless, sẵn sàng cho Edge (chạy code gần người dùng của bạn).

Chúng ta sẽ sử dụng lệnh INCR Redis® để tăng quota của người dùng lên 1. Lệnh này là nguyên tử (atomic), có nghĩa là nó sẽ chỉ được thực thi một lần, và nó sẽ được thực thi nhanh.

Đây là cùng code như trước, nhưng sử dụng Upstash Redis® để quản lý quota của người dùng:

// pages/api/spreadsheets/[id]/index.ts
import type { NextApiRequest, NextApiResponse } from "next";
import { Redis } from "@upstash/redis";
const MAX_FREE_TIER_QUOTA = 1000;
// Generate an Upstash Redis instance using environment variables.
// Make sure those are defined in your .env file.
const redis = new Redis({
  url: process.env.UPSTASH_REDIS_REST_URL!,
  token: process.env.UPSTASH_REDIS_REST_TOKEN!,
});
export default async function handler(
  req: NextApiRequest,
  res: NextApiResponse,
) {
  // Get the ID of the spreadsheet from the URL.
  const { id } = req.params;
  // Get the spreadsheet and its associated user from the database.
  const spreadsheet = await prisma.spreadsheet.findUnique({
    where: { id: Number(id) },
    include: { user: true },
  });
  // Verify that the spreadsheet exists.
  if (!spreadsheet) {
    return res.status(404).json({ error: "Spreadsheet not found" });
  }
  // Redis quota key, unique for each user by its ID.
  const quotaKey = `user:${spreadsheet.user.id}:quota`;
  // Retrieve the user's quota from Redis.
  const quota = await redis.incr(quotaKey);
  // If the key did not exist before, the returned value will be 1
  // and we set the expiration to 1 day.
  if (quota === 1) {
    await redis.expire(quotaKey, 60 * 60 * 24);
  }
  // Verify that the user is not over the quota.
  if (quota > MAX_FREE_TIER_QUOTA) {
    return res.status(429).json({ error: "Quota exceeded" });
  }
  // Return the spreadsheet's content.
  return res.json({ content: spreadsheet.content });
}

Sử dụng Upstash Redis® làm cho code của bạn dễ dàng mở rộng, vì bạn có thể tận dụng sức mạnh của Upstash Redis® Edge để chạy code của bạn gần người dùng.

Kết luận

Upstash Redis® làm cho việc triển khai hệ thống caching cho môi trường serverless trở nên rất dễ dàng.

Chúng ta đã dùng nó để triển khai hệ thống quota nhưng ý tưởng gốc có thể áp dụng cho nhiều trường hợp sử dụng hơn, chẳng hạn như cache nhiều truy vấn database hơn, hoặc cache kết quả của yêu cầu API.

Mục tiêu cuối cùng của caching là làm cho API của bạn nhanh hơn và có khả năng tiêu thụ ít tài nguyên hơn (ví dụ: truy vấn đọc/ghi database Planetscale).

Trong bài viết tương lai, chúng ta sẽ thấy cách sử dụng Upstash QStash để lấy quota của người dùng từ Redis® và lưu trữ nó trong database, để đảm bảo quota của người dùng luôn được cập nhật và không bị mất.

Xem trực tiếp

Nếu bạn muốn xem loại tối ưu hóa này trực tiếp, bạn có thể xem fastsheet, dịch vụ API biến Google Sheets của bạn thành API trong vài cú nhấp chuột. Nó miễn phí để sử dụng với cấp miễn phí hào phóng.