feat: scripts for creating blue-green dbs and copying cache (#85)

## Description
We add two more scripts on 'scripts/migrations' for creation of Blue and
Green databases in Postgres and cache data copying between them

## Checklist before requesting a review

-   [ ] I have conducted a self-review of my code.
-   [ ] I have conducted a QA.
-   [ ] If it is a core feature, I have included comprehensive tests.


<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->
## Summary by CodeRabbit

- **New Features**
- Introduced new commands to automate database setup and cache
synchronization for blue-green deployment, streamlining database
management.

- **Documentation**
- Provided a detailed guide outlining procedures for managing PostgreSQL
databases in a blue-green deployment setup.

- **Chores**
- Added new scripts for copying cache data and creating databases,
enhancing database management capabilities.
  - Updated dependencies to support PostgreSQL operations.
<!-- end of auto-generated comment: release notes by coderabbit.ai -->

Author: 0xnigir1

package.json

@@ -15,6 +15,8 @@
         "clean": "turbo run clean",
         "db:cache:migrate": "pnpm run --filter @grants-stack-indexer/migrations db:cache:migrate",
         "db:cache:reset": "pnpm run --filter @grants-stack-indexer/migrations db:cache:reset",
+        "db:copy-cache": "pnpm run --filter @grants-stack-indexer/migrations db:copy-cache",
+        "db:create-databases": "pnpm run --filter @grants-stack-indexer/migrations db:create-databases",
         "db:migrate": "pnpm run --filter @grants-stack-indexer/migrations db:migrate",
         "db:reset": "pnpm run --filter @grants-stack-indexer/migrations db:reset",
         "dev": "turbo run dev",

pnpm-lock.yaml

@@ -142,7 +142,7 @@ export class HasuraMetadataApi<Tables extends readonly string[]> {
 
             // Object relationship: in the child table
             const objectRelationshipPayload = {
-                name: singularize(camelize(parentTable.name)), // name derived from parent table
+                name: singularize(camelize(parentTable.name, true)), // name derived from parent table
                 table: childTable,
                 source: "default",
                 using: {
@@ -160,7 +160,7 @@ export class HasuraMetadataApi<Tables extends readonly string[]> {
             );
 
             const arrayRelationshipPayload = {
-                name: camelize(childTable.name), // name derived from child table
+                name: camelize(childTable.name, true), // name derived from child table
                 table: parentTable,
                 source: "default",
                 using: {

scripts/hasura-config/src/services/hasura.api.ts

@@ -0,0 +1,59 @@
+# Blue-Green Database Operations
+
+This utility provides scripts for managing PostgreSQL databases in a blue-green deployment strategy. It handles the creation and maintenance of two fixed databases: **GitcoinDatalayerBlue** and **GitcoinDatalayerGreen**.
+
+## Features
+
+The scripts offer two main operations:
+
+1. **Database Creation** - Create both blue and green databases if they don't exist
+2. **Cache Data Copy** - Copy external services cache data from one database to the other
+
+## Database Creation
+
+Use this operation to create the required blue and green databases if they don't already exist.
+
+```bash
+# Create both databases if they don't exist
+pnpm db:create-databases
+```
+
+### How Database Creation Works
+
+1. The script reads the PostgreSQL connection details from the `DATABASE_URL` environment variable
+2. It checks if the databases `GitcoinDatalayerBlue` and `GitcoinDatalayerGreen` exist
+3. If either database doesn't exist, it creates it
+4. This operation can be run multiple times without error, as it only creates databases when needed
+
+## Cache Data Copy
+
+Use this operation to copy cache data between blue and green databases. This is essential for maintaining cache consistency during blue-green deployments.
+
+```bash
+# Copy cache data from blue to green
+pnpm db:copy-cache --copyFrom=blue
+
+# Copy cache data from green to blue
+pnpm db:copy-cache --copyFrom=green
+
+# Using the shorthand parameter
+pnpm db:copy-cache -f blue
+```
+
+### How Cache Data Copy Works
+
+1. The script reads the PostgreSQL connection details from the `DATABASE_URL` environment variable
+2. It handles the two specific cache tables: `price_cache` and `metadata_cache`
+3. For each table:
+    - It truncates the target table
+    - Copies all data from the source to the target table
+    - Processes data in batches to avoid memory issues with large tables
+
+### Cache Tables
+
+The script only copies the following tables, which contain cached data from external services:
+
+-   `price_cache`: Stores token price information
+-   `metadata_cache`: Stores token metadata
+
+All other tables are managed through the regular migration process and are not part of the blue-green deployment cache copying strategy.

scripts/migrations/README-DB-BLUE-GREEN.md

@@ -18,6 +18,8 @@
         "clean": "rm -rf dist/",
         "db:cache:migrate": "tsx src/migrateDb.script.ts --migrationsFolder external_services_cache",
         "db:cache:reset": "tsx src/resetDb.script.ts --migrationsFolder external_services_cache",
+        "db:copy-cache": "tsx src/copyCache.script.ts",
+        "db:create-databases": "tsx src/createDatabases.script.ts",
         "db:migrate": "tsx src/migrateDb.script.ts",
         "db:reset": "tsx src/resetDb.script.ts",
         "format": "prettier --check \"{src,test}/**/*.{js,ts,json}\"",
@@ -32,10 +34,12 @@
         "@grants-stack-indexer/shared": "workspace:*",
         "dotenv": "16.4.5",
         "kysely": "0.27.4",
+        "pg": "8.13.0",
         "yargs": "17.7.2",
         "zod": "3.23.8"
     },
     "devDependencies": {
+        "@types/pg": "8.11.10",
         "@types/yargs": "17.0.33",
         "tsx": "4.19.2"
     }

scripts/migrations/package.json

@@ -0,0 +1,41 @@
+/**
+ * Shared constants for blue-green deployment database operations
+ */
+
+// Constant database names
+export const BLUE_DB = "GitcoinDatalayerBlue";
+export const GREEN_DB = "GitcoinDatalayerGreen";
+
+// These are the only two cache tables we need to handle
+export const CACHE_TABLES = ["price_cache", "metadata_cache"];
+
+/**
+ * Interface for database connection details
+ */
+export interface ConnectionDetails {
+    host: string;
+    port: string;
+    user: string;
+    password: string;
+}
+
+/**
+ * Extract connection details from DATABASE_URL
+ */
+export const extractConnectionDetails = (url: string): ConnectionDetails => {
+    // Parse DATABASE_URL (format: postgres://user:password@host:port/dbname)
+    // Allow for different protocol variants: postgre, postgres, postgresql
+    const connectionRegex = /(?:postgre(?:s|sql)?):\/\/([^:]+):([^@]+)@([^:]+):([^\/]+)\/.*/;
+    const match = url.match(connectionRegex);
+
+    if (!match || match.length < 5) {
+        throw new Error(`Invalid DATABASE_URL format: ${url}`);
+    }
+
+    return {
+        user: match[1] as string,
+        password: match[2] as string,
+        host: match[3] as string,
+        port: match[4] as string,
+    };
+};