استقرار یک پشته کامل برنامه Next.js در Cloud Run با Cloud SQL برای PostgreSQL با استفاده از رابط Cloud SQL Node.js

۱. مرور کلی

Cloud Run یک پلتفرم کاملاً مدیریت‌شده است که به شما امکان می‌دهد کد خود را مستقیماً روی زیرساخت مقیاس‌پذیر گوگل اجرا کنید. این Codelab نحوه اتصال یک برنامه Next.js در Cloud Run به یک پایگاه داده Cloud SQL برای PostgreSQL با استفاده از Cloud SQL Node.js Connector را نشان می‌دهد.

در این آزمایشگاه، شما یاد خواهید گرفت که چگونه:

  • ایجاد یک Cloud SQL برای نمونه PostgreSQL
  • یک برنامه را در Cloud Run مستقر کنید که به پایگاه داده Cloud SQL شما متصل شود

۲. پیش‌نیازها

  1. اگر از قبل حساب گوگل ندارید، باید یک حساب گوگل ایجاد کنید .
    • به جای حساب کاری یا تحصیلی از یک حساب شخصی استفاده کنید. حساب‌های کاری و تحصیلی ممکن است محدودیت‌هایی داشته باشند که مانع از فعال کردن APIهای مورد نیاز برای این آزمایشگاه توسط شما شود.

۳. راه‌اندازی پروژه

  1. وارد کنسول ابری گوگل شوید.
  2. فعال کردن پرداخت در کنسول ابری
    • تکمیل این آزمایشگاه باید کمتر از ۱ دلار آمریکا از طریق منابع ابری هزینه داشته باشد.
    • شما می‌توانید مراحل انتهای این آزمایش را برای حذف منابع دنبال کنید تا از هزینه‌های بیشتر جلوگیری شود.
    • کاربران جدید واجد شرایط استفاده از دوره آزمایشی رایگان ۳۰۰ دلاری هستند.
  3. یک پروژه جدید ایجاد کنید یا از یک پروژه موجود دوباره استفاده کنید.

۴. ویرایشگر Cloud Shell را باز کنید

  1. به ویرایشگر Cloud Shell بروید
  2. اگر ترمینال در پایین صفحه نمایش داده نشد، آن را باز کنید:
    • روی منوی همبرگری کلیک کنید آیکون منوی همبرگری
    • روی ترمینال کلیک کنید
    • روی ترمینال جدید کلیک کنید باز کردن ترمینال جدید در ویرایشگر Cloud Shell
  3. در ترمینال، پروژه خود را با این دستور تنظیم کنید:
    • قالب: 
      gcloud config set project [PROJECT_ID]
    • مثال: 
      gcloud config set project lab-project-id-example
    • اگر نمی‌توانید شناسه پروژه خود را به خاطر بیاورید:
      • شما می‌توانید تمام شناسه‌های پروژه خود را با دستور زیر فهرست کنید: 
        gcloud projects list | awk '/PROJECT_ID/{print $2}'
      شناسه پروژه را در ترمینال ویرایشگر Cloud Shell تنظیم کنید
  4. اگر از شما خواسته شد که مجوز دهید، برای ادامه روی تأیید کلیک کنید. برای تأیید Cloud Shell کلیک کنید
  5. شما باید این پیام را ببینید:
    Updated property [core/project].
    اگر یک WARNING مشاهده کردید و از شما پرسیده شد Do you want to continue (Y/N)? احتمالاً شناسه پروژه را اشتباه وارد کرده‌اید. N را فشار دهید، Enter را بزنید و دوباره سعی کنید دستور gcloud config set project اجرا کنید.

۵. فعال کردن APIها

در ترمینال، APIها را فعال کنید:

gcloud services enable \
  sqladmin.googleapis.com \
  run.googleapis.com \
  artifactregistry.googleapis.com \
  cloudbuild.googleapis.com

اگر از شما خواسته شد که مجوز دهید، برای ادامه روی تأیید کلیک کنید. برای تأیید Cloud Shell کلیک کنید

تکمیل این دستور ممکن است چند دقیقه طول بکشد، اما در نهایت باید پیامی مشابه این پیام موفقیت‌آمیز نمایش داده شود:

Operation "operations/acf.p2-73d90d00-47ee-447a-b600" finished successfully.

۶. یک حساب کاربری سرویس راه‌اندازی کنید

یک حساب کاربری سرویس Google Cloud ایجاد و پیکربندی کنید تا توسط Cloud Run مورد استفاده قرار گیرد تا مجوزهای صحیح برای اتصال به Cloud SQL را داشته باشد.

  1. برای ایجاد یک حساب سرویس جدید، دستور gcloud iam service-accounts create را به صورت زیر اجرا کنید: 
    gcloud iam service-accounts create quickstart-service-account \
  --display-name="Quickstart Service Account"
  2. دستور gcloud projects add-iam-policy-binding را به صورت زیر اجرا کنید تا نقش Cloud SQL Client به حساب سرویس Google Cloud که اخیراً ایجاد کرده‌اید اضافه شود. 
    gcloud projects add-iam-policy-binding ${GOOGLE_CLOUD_PROJECT} \
  --member="serviceAccount:quickstart-service-account@${GOOGLE_CLOUD_PROJECT}.iam.gserviceaccount.com" \
  --role="roles/cloudsql.client"
  3. دستور gcloud projects add-iam-policy-binding را به صورت زیر اجرا کنید تا نقش Cloud SQL Instance User به حساب سرویس Google Cloud که اخیراً ایجاد کرده‌اید اضافه شود. 
    gcloud projects add-iam-policy-binding ${GOOGLE_CLOUD_PROJECT} \
  --member="serviceAccount:quickstart-service-account@${GOOGLE_CLOUD_PROJECT}.iam.gserviceaccount.com" \
  --role="roles/cloudsql.instanceUser"
  4. دستور gcloud projects add-iam-policy-binding را به صورت زیر اجرا کنید تا نقش Log Writer به حساب سرویس Google Cloud که اخیراً ایجاد کرده‌اید اضافه شود. 
    gcloud projects add-iam-policy-binding ${GOOGLE_CLOUD_PROJECT} \
  --member="serviceAccount:quickstart-service-account@${GOOGLE_CLOUD_PROJECT}.iam.gserviceaccount.com" \
  --role="roles/logging.logWriter"

۷. ایجاد پایگاه داده ابری SQL

  1. دستور gcloud sql instances create اجرا کنید تا یک نمونه Cloud SQL ایجاد شود. 
    gcloud sql instances create quickstart-instance \
    --database-version=POSTGRES_14 \
    --cpu=4 \
    --memory=16GB \
    --region=us-central1 \
    --database-flags=cloudsql.iam_authentication=on

اجرای این دستور ممکن است چند دقیقه طول بکشد.

  1. دستور gcloud sql databases create را اجرا کنید تا یک پایگاه داده Cloud SQL در quickstart-instance ایجاد شود. 
    gcloud sql databases create quickstart_db \
    --instance=quickstart-instance
  2. یک کاربر پایگاه داده PostgreSQL برای حساب کاربری سرویسی که قبلاً ایجاد کرده‌اید تا به پایگاه داده دسترسی داشته باشید، ایجاد کنید. 
    gcloud sql users create quickstart-service-account@${GOOGLE_CLOUD_PROJECT}.iam \
    --instance=quickstart-instance \
    --type=cloud_iam_service_account

۸. آماده‌سازی درخواست

یک برنامه Next.js آماده کنید که به درخواست‌های HTTP پاسخ دهد.

  1. برای ایجاد یک پروژه جدید Next.js با نام task-app ، از دستور زیر استفاده کنید: 
    npx --yes create-next-app@15 task-app \
  --ts \
  --eslint \
  --tailwind \
  --no-src-dir \
  --turbopack \
  --app \
  --no-import-alias
  2. تغییر دایرکتوری به task-app : 
    cd task-app
  1. برای تعامل با پایگاه داده PostgreSQL، pg و کتابخانه رابط Cloud SQL Node.js را نصب کنید. 
    npm install pg @google-cloud/cloud-sql-connector google-auth-library
  2. برای استفاده از یک برنامه TypeScript Next.js، @types/pg را به عنوان یک وابستگی توسعه‌دهنده نصب کنید. 
    npm install --save-dev @types/pg
  1. فایل actions.ts را در ویرایشگر Cloud Shell باز کنید:
    cloudshell edit app/actions.ts
    اکنون باید یک فایل خالی در قسمت بالای صفحه نمایش داده شود. اینجاست که می‌توانید فایل actions.ts را ویرایش کنید. نمایش اینکه کد در قسمت بالای صفحه نمایش قرار می‌گیرد
  2. کد زیر را کپی کرده و در فایل actions.ts باز شده قرار دهید: 
    'use server'
import pg from 'pg';
import { AuthTypes, Connector } from '@google-cloud/cloud-sql-connector';
import { GoogleAuth } from 'google-auth-library';
const auth = new GoogleAuth();

const { Pool } = pg;

type Task = {
  id: string;
  title: string;
  status: 'IN_PROGRESS' | 'COMPLETE';
};

const projectId = await auth.getProjectId();

const connector = new Connector();
const clientOpts = await connector.getOptions({
  instanceConnectionName: `${projectId}:us-central1:quickstart-instance`,
  authType: AuthTypes.IAM,
});

const pool = new Pool({
  ...clientOpts,
  user: `quickstart-service-account@${projectId}.iam`,
  database: 'quickstart_db',
});

const tableCreationIfDoesNotExist = async () => {
  await pool.query(`CREATE TABLE IF NOT EXISTS tasks (
      id SERIAL NOT NULL,
      created_at timestamp NOT NULL,
      status VARCHAR(255) NOT NULL default 'IN_PROGRESS',
      title VARCHAR(1024) NOT NULL,
      PRIMARY KEY (id)
    );`);
}

// CREATE
export async function addNewTaskToDatabase(newTask: string) {
  await tableCreationIfDoesNotExist();
  await pool.query(`INSERT INTO tasks(created_at, status, title) VALUES(NOW(), 'IN_PROGRESS', $1)`, [newTask]);
  return;
}

// READ
export async function getTasksFromDatabase() {
  await tableCreationIfDoesNotExist();
  const { rows } = await pool.query(`SELECT id, created_at, status, title FROM tasks ORDER BY created_at DESC LIMIT 100`);
  return rows;
}

// UPDATE
export async function updateTaskInDatabase(task: Task) {
  await tableCreationIfDoesNotExist();
  await pool.query(
    `UPDATE tasks SET status = $1, title = $2 WHERE id = $3`,
    [task.status, task.title, task.id]
  );
  return;
}

// DELETE
export async function deleteTaskFromDatabase(taskId: string) {
  await tableCreationIfDoesNotExist();
  await pool.query(`DELETE FROM tasks WHERE id = $1`, [taskId]);
  return;
}
  1. فایل page.tsx را در ویرایشگر Cloud Shell باز کنید:
    cloudshell edit app/page.tsx
    اکنون یک فایل موجود باید در قسمت بالای صفحه نمایش داده شود. اینجاست که می‌توانید فایل page.tsx را ویرایش کنید. نمایش اینکه کد در قسمت بالای صفحه نمایش قرار می‌گیرد
  2. محتویات موجود در فایل page.tsx را حذف کنید.
  3. کد زیر را کپی کرده و در فایل page.tsx باز شده قرار دهید: 
    'use client'
import React, { useEffect, useState } from "react";
import { addNewTaskToDatabase, getTasksFromDatabase, deleteTaskFromDatabase, updateTaskInDatabase } from "./actions";

type Task = {
  id: string;
  title: string;
  status: 'IN_PROGRESS' | 'COMPLETE';
  createdAt: number;
};

export default function Home() {
  const [newTaskTitle, setNewTaskTitle] = useState('');
  const [tasks, setTasks] = useState<Task[]>([]);

  async function getTasks() {
    const updatedListOfTasks = await getTasksFromDatabase();
    setTasks(updatedListOfTasks);
  }

  useEffect(() => {
    getTasks();
  }, []);

  async function handleSubmit(e: React.FormEvent<HTMLFormElement>) {
    e.preventDefault();
    await addNewTaskToDatabase(newTaskTitle);
    await getTasks();
    setNewTaskTitle('');
  };

  async function updateTask(task: Task, newTaskValues: Partial<Task>) {
    await updateTaskInDatabase({ ...task, ...newTaskValues });
    await getTasks();
  }

  async function deleteTask(taskId: string) {
    await deleteTaskFromDatabase(taskId);
    await getTasks();
  }

  return (
    <main className="p-4">
      <h2 className="text-2xl font-bold mb-4">To Do List</h2>
      <div className="flex mb-4">
        <form onSubmit={handleSubmit} className="flex mb-8">
          <input
            type="text"
            placeholder="New Task Title"
            value={newTaskTitle}
            onChange={(e) => setNewTaskTitle(e.target.value)}
            className="flex-grow border border-gray-400 rounded px-3 py-2 mr-2 bg-inherit"
          />
          <button
            type="submit"
            className="bg-blue-500 hover:bg-blue-700 text-white font-bold py-2 px-4 rounded text-nowrap"
          >
            Add New Task
          </button>
        </form>
      </div>
      <table className="w-full">
        <tbody>
          {tasks.map(function (task) {
            const isComplete = task.status === 'COMPLETE';
            return (
              <tr key={task.id} className="border-b border-gray-200">
                <td className="py-2 px-4">
                  <input
                    type="checkbox"
                    checked={isComplete}
                    onChange={() => updateTask(task, { status: isComplete ? 'IN_PROGRESS' : 'COMPLETE' })}
                    className="transition-transform duration-300 ease-in-out transform scale-100 checked:scale-125 checked:bg-green-500"
                  />
                </td>
                <td className="py-2 px-4">
                  <span
                    className={`transition-all duration-300 ease-in-out ${isComplete ? 'line-through text-gray-400 opacity-50' : 'opacity-100'}`}
                  >
                    {task.title}
                  </span>
                </td>
                <td className="py-2 px-4">
                  <button
                    onClick={() => deleteTask(task.id)}
                    className="bg-red-500 hover:bg-red-700 text-white font-bold py-2 px-4 rounded float-right"
                  >
                    Delete
                  </button>
                </td>
              </tr>
            );
          })}
        </tbody>
      </table>
    </main>
  );
}

اکنون برنامه آماده‌ی استقرار است.

۹. برنامه را روی Cloud Run مستقر کنید

  1. دستور زیر را برای استقرار برنامه خود در Cloud Run اجرا کنید: 
    gcloud run deploy to-do-tracker \
    --region=us-central1 \
    --source=. \
    --service-account="quickstart-service-account@${GOOGLE_CLOUD_PROJECT}.iam.gserviceaccount.com" \
    --allow-unauthenticated
  2. در صورت درخواست، Y و Enter را فشار دهید تا تأیید کنید که می‌خواهید ادامه دهید: 
    Do you want to continue (Y/n)? Y

پس از چند دقیقه، برنامه باید یک URL برای بازدید شما ارائه دهد.

برای مشاهده‌ی عملکرد برنامه‌ی خود، به آدرس اینترنتی (URL) بروید. هر بار که از آدرس اینترنتی (URL) بازدید می‌کنید یا صفحه را رفرش می‌کنید، برنامه‌ی وظیفه (task app) را مشاهده خواهید کرد.

۱۰. تبریک

در این آزمایشگاه، شما یاد گرفته‌اید که چگونه موارد زیر را انجام دهید:

  • ایجاد یک Cloud SQL برای نمونه PostgreSQL
  • یک برنامه را در Cloud Run مستقر کنید که به پایگاه داده Cloud SQL شما متصل شود

تمیز کردن

Cloud SQL نسخه رایگان ندارد و در صورت ادامه استفاده، از شما هزینه دریافت می‌شود. می‌توانید پروژه Cloud خود را حذف کنید تا از هزینه‌های اضافی جلوگیری شود.

اگرچه Cloud Run در صورت عدم استفاده از سرویس، هزینه‌ای دریافت نمی‌کند، اما ممکن است همچنان برای ذخیره تصویر کانتینر در Artifact Registry هزینه دریافت شود. حذف پروژه Cloud شما، پرداخت هزینه برای تمام منابع استفاده شده در آن پروژه را متوقف می‌کند.

اگر مایلید، پروژه را حذف کنید: 

gcloud projects delete $GOOGLE_CLOUD_PROJECT

همچنین ممکن است بخواهید منابع غیرضروری را از دیسک cloudshell خود حذف کنید. می‌توانید:

  1. پوشه پروژه codelab را حذف کنید: 
    rm -rf ~/task-app
  2. هشدار! اقدام بعدی قابل بازگشت نیست! اگر می‌خواهید همه چیز را در Cloud Shell خود حذف کنید تا فضا آزاد شود، می‌توانید کل دایرکتوری خانگی خود را حذف کنید . مراقب باشید که هر چیزی که می‌خواهید نگه دارید در جای دیگری ذخیره شده باشد. 
    sudo rm -rf $HOME

به یادگیری ادامه دهید