Scripts: Complete (PalisadoesFoundation#3356)

* added id column

* basic test

* test ping

* code quality

* added more cases

* final

* environment configured

* quality

* dynamicity

* completely dynamic

* final fix

* debug

* code quality

* debug level high

* added bucket name in testing env

* fix

* bucket name

* api service env

* validate approval

* coderabbit fix

* doc fix

---------

Co-authored-by: JaiPannu-IITI <[email protected]>

Author: JaiPannu-IITI

.coderabbit.yaml

@@ -12,7 +12,6 @@ reviews:
   high_level_summary: true
   review_status: true
   collapse_walkthrough: false
-  request_changes_workflow: true
   auto_review:
     enabled: true
     drafts: false

docker/compose.testing.yaml

@@ -25,6 +25,7 @@ services:
     environment:
       - API_MINIO_TEST_END_POINT=${API_MINIO_TEST_END_POINT:?error}
       - API_POSTGRES_TEST_HOST=${API_POSTGRES_TEST_HOST:?error}
+      - MINIO_ROOT_USER=${MINIO_ROOT_USER:?error}
     # https://docs.docker.com/reference/dockerfile/#healthcheck
     # https://docs.docker.com/reference/compose-file/services/#healthcheck
     healthcheck:

docs/docs/docs/getting-started/installation.md

@@ -397,10 +397,6 @@ This applies to users running Talawa API in dev containers.
    ```bash
     docker exec talawa-api-1 /bin/bash -c 'pnpm run add:sample_data && exit'
    ```
-4. Then exit
-   ```bash
-    exit
-   ```
    Refer to the next section for login information.
 
 ### Sample Data Users

drizzle_migrations/20250122092015_sweet_scrambler.sql renamed to drizzle_migrations/20250311060842_lean_misty_knight.sql

@@ -275,6 +275,7 @@ CREATE TABLE "organizations" (
 --> statement-breakpoint
 CREATE TABLE "post_attachments" (
 	"created_at" timestamp (3) with time zone DEFAULT now() NOT NULL,
+	"id" uuid PRIMARY KEY NOT NULL,
 	"creator_id" uuid,
 	"post_id" uuid NOT NULL,
 	"mime_type" text NOT NULL,

drizzle_migrations/meta/20250122092015_snapshot.json renamed to drizzle_migrations/meta/20250311060842_snapshot.json

@@ -1,5 +1,5 @@
 {
-  "id": "e5fe635f-2302-4a95-86e6-16508bb68c63",
+  "id": "41d3c6f8-89e8-438f-bd91-4802134c00ad",
   "prevId": "00000000-0000-0000-0000-000000000000",
   "version": "7",
   "dialect": "postgresql",
@@ -4084,6 +4084,12 @@
           "notNull": true,
           "default": "now()"
         },
+        "id": {
+          "name": "id",
+          "type": "uuid",
+          "primaryKey": true,
+          "notNull": true
+        },
         "creator_id": {
           "name": "creator_id",
           "type": "uuid",

drizzle_migrations/meta/_journal.json

@@ -5,8 +5,8 @@
     {
       "idx": 0,
       "version": "7",
-      "when": 1737537615071,
-      "tag": "20250122092015_sweet_scrambler",
+      "when": 1741673322722,
+      "tag": "20250311060842_lean_misty_knight",
       "breakpoints": true
     }
   ]

scripts/dbManagement/helpers.ts

@@ -35,7 +35,7 @@ export const queryClient = postgres({
 });
 
 //Create a bucket client
-const minioClient = new MinioClient({
+export const minioClient = new MinioClient({
 	accessKey: envConfig.API_MINIO_ACCESS_KEY || "",
 	endPoint: envConfig.API_MINIO_END_POINT || "",
 	port: Number(envConfig.API_MINIO_PORT),
@@ -98,7 +98,7 @@ export async function formatDatabase(): Promise<boolean> {
 
 			await tx.execute(sql`
 				DELETE FROM ${sql.identifier(USERS_TABLE)}
-				WHERE email != ${adminEmail};
+				WHERE email_address != ${adminEmail};
 			  `);
 		});
 
@@ -233,6 +233,7 @@ export async function insertCollections(
 
 		const API_ADMINISTRATOR_USER_EMAIL_ADDRESS =
 			envConfig.API_ADMINISTRATOR_USER_EMAIL_ADDRESS;
+
 		if (!API_ADMINISTRATOR_USER_EMAIL_ADDRESS) {
 			throw new Error(
 				"\x1b[31mAPI_ADMINISTRATOR_USER_EMAIL_ADDRESS is not defined.\x1b[0m",
@@ -399,16 +400,12 @@ export async function insertCollections(
 							createdAt: parseDate(post_attachment.createdAt),
 						}),
 					) as (typeof schema.postAttachmentsTable.$inferInsert)[];
-					try {
-						// Post Attachements are not unique. So they are inserted without checking for duplicates.
-						await db
-							.insert(schema.postAttachmentsTable)
-							.values(post_attachments);
-					} catch {
-						throw new Error(
-							"\x1b[31mError inserting post_attachments data\x1b[0m",
-						);
-					}
+					await checkAndInsertData(
+						schema.postAttachmentsTable,
+						post_attachments,
+						schema.postAttachmentsTable.id,
+						1000,
+					);
 					// Handle file uploads to Minio.
 					await Promise.all(
 						post_attachments.map(async (attachment) => {

src/drizzle/tables/postAttachments.ts

@@ -1,10 +1,10 @@
 import { relations, sql } from "drizzle-orm";
 import { index, pgTable, text, timestamp, uuid } from "drizzle-orm/pg-core";
 import { createInsertSchema } from "drizzle-zod";
+import { uuidv7 } from "uuidv7";
 import { postAttachmentMimeTypeEnum } from "~/src/drizzle/enums/postAttachmentMimeType";
 import { postsTable } from "./posts";
 import { usersTable } from "./users";
-
 /**
  * Drizzle orm postgres table definition for post attachments.
  */
@@ -21,6 +21,11 @@ export const postAttachmentsTable = pgTable(
 		})
 			.notNull()
 			.defaultNow(),
+		/**
+		 * Primary unique identifier of the post attachment.
+		 */
+		id: uuid("id").primaryKey().$default(uuidv7),
+
 		/**
 		 * Foreign key reference to the id of the user who created the attachment.
 		 */

test/envConfigSchema.ts

@@ -1,6 +1,7 @@
 import { type Static, Type } from "@sinclair/typebox";
+import envSchema from "env-schema";
 import { envConfigSchema } from "~/src/envConfigSchema";
-
+import { envSchemaAjv } from "~/src/envConfigSchema";
 /**
  * JSON schema of a record of environment variables accessible to the talawa api tests at runtime.
  */
@@ -13,6 +14,13 @@ export const testEnvConfigSchema = Type.Object({
 	 * More information at this link: {@link https://www.postgresql.org/docs/current/libpq-connect.html#LIBPQ-CONNECT-HOST}
 	 */
 	API_POSTGRES_TEST_HOST: envConfigSchema.properties.API_POSTGRES_HOST,
+
+	MINIO_ROOT_USER: envConfigSchema.properties.MINIO_ROOT_USER,
+});
+export const testEnvConfig = envSchema<TestEnvConfig>({
+	ajv: envSchemaAjv,
+	dotenv: true,
+	schema: testEnvConfigSchema,
 });
 
 /**