Skip to content

refactor: enhance database migrations and harden test suites (#342 #343 #344 #345) #433

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Chucks1093 merged 1 commit into from
Aug 31, 2026
Merged

refactor: enhance database migrations and harden test suites (#342 #343 #344 #345) #433

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
273 changes: 1 addition & 272 deletions src/migrations/1731513600000-InitialSchema.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -269,278 +269,7 @@ export class InitialSchema1731513600000 implements MigrationInterface {
);
CREATE INDEX IF NOT EXISTS "idx_notifications_user_id" ON "notifications" ("user_id");
CREATE INDEX IF NOT EXISTS "idx_notifications_type" ON "notifications" ("type");
CREATE INDEX IF NOT EXISTS "idx_notifications_user_read" ON "notifications" ("user_id", "read");
`);
}
logger.info("Executing up migration for InitialSchema1731513600000");

await queryRunner.query(`
CREATE TYPE "public"."users_usertype_enum" AS ENUM('seller', 'investor', 'both');
CREATE TYPE "public"."users_kycstatus_enum" AS ENUM('pending', 'in_review', 'approved', 'rejected');
CREATE TYPE "public"."invoices_invoicestatus_enum" AS ENUM('draft', 'pending', 'published', 'funded', 'settled', 'cancelled', 'rejected');
CREATE TYPE "public"."investments_investmentstatus_enum" AS ENUM('pending', 'confirmed', 'settled', 'cancelled');
CREATE TYPE "public"."transactions_transactiontype_enum" AS ENUM('investment', 'payment', 'withdrawal', 'refund');
CREATE TYPE "public"."transactions_transactionstatus_enum" AS ENUM('pending', 'completed', 'failed');
CREATE TYPE "public"."kyc_verifications_verificationtype_enum" AS ENUM('identity', 'address', 'business');
CREATE TYPE "public"."notifications_notificationtype_enum" AS ENUM('invoice', 'investment', 'payment', 'kyc', 'system');
`);

await queryRunner.query(`
CREATE TABLE "users" (
// 1. Create Enum Types safely
await queryRunner.query(`
DO $$ BEGIN
CREATE TYPE "public"."users_usertype_enum" AS ENUM('seller', 'investor', 'both');
EXCEPTION WHEN duplicate_object THEN null; END $$;

DO $$ BEGIN
CREATE TYPE "public"."users_kycstatus_enum" AS ENUM('pending', 'in_review', 'approved', 'rejected');
EXCEPTION WHEN duplicate_object THEN null; END $$;

DO $$ BEGIN
CREATE TYPE "public"."invoices_invoicestatus_enum" AS ENUM('draft', 'pending', 'published', 'funded', 'settled', 'cancelled', 'rejected');
EXCEPTION WHEN duplicate_object THEN null; END $$;

DO $$ BEGIN
CREATE TYPE "public"."investments_investmentstatus_enum" AS ENUM('pending', 'confirmed', 'settled', 'cancelled');
EXCEPTION WHEN duplicate_object THEN null; END $$;

DO $$ BEGIN
CREATE TYPE "public"."transactions_transactiontype_enum" AS ENUM('investment', 'payment', 'withdrawal', 'refund');
EXCEPTION WHEN duplicate_object THEN null; END $$;

DO $$ BEGIN
CREATE TYPE "public"."transactions_transactionstatus_enum" AS ENUM('pending', 'completed', 'failed');
EXCEPTION WHEN duplicate_object THEN null; END $$;

DO $$ BEGIN
CREATE TYPE "public"."kyc_verifications_verificationtype_enum" AS ENUM('identity', 'address', 'business');
EXCEPTION WHEN duplicate_object THEN null; END $$;

DO $$ BEGIN
CREATE TYPE "public"."notifications_notificationtype_enum" AS ENUM('invoice', 'investment', 'payment', 'kyc', 'system');
EXCEPTION WHEN duplicate_object THEN null; END $$;
`);

// 2. Create Users Table & Indexes
await queryRunner.query(`
CREATE TABLE IF NOT EXISTS "users" (
"id" uuid NOT NULL DEFAULT gen_random_uuid(),
"stellarAddress" character varying(56) NOT NULL,
"email" character varying(255),
"userType" "public"."users_usertype_enum" NOT NULL DEFAULT 'investor',
"kycStatus" "public"."users_kycstatus_enum" NOT NULL DEFAULT 'pending',
"is_kyc_verified" boolean NOT NULL DEFAULT false,
"created_at" TIMESTAMP NOT NULL DEFAULT now(),
"updated_at" TIMESTAMP NOT NULL DEFAULT now(),
"deleted_at" TIMESTAMP,
CONSTRAINT "UQ_users_stellarAddress" UNIQUE ("stellarAddress"),
CONSTRAINT "PK_users" PRIMARY KEY ("id")
);
CREATE UNIQUE INDEX IF NOT EXISTS "idx_users_stellar_address" ON "users" ("stellarAddress");
CREATE INDEX IF NOT EXISTS "idx_users_user_type" ON "users" ("userType");
CREATE INDEX IF NOT EXISTS "idx_users_kyc_status" ON "users" ("kycStatus");
CREATE INDEX IF NOT EXISTS "idx_users_email" ON "users" ("email");
`);

// 3. Create Invoices Table & Optimized Indexes
await queryRunner.query(`
CREATE TABLE IF NOT EXISTS "invoices" (
"id" uuid NOT NULL DEFAULT gen_random_uuid(),
"seller_id" uuid NOT NULL,
"invoice_number" character varying(64) NOT NULL,
"customer_name" character varying(255) NOT NULL,
"amount" decimal(18,4) NOT NULL DEFAULT 0,
"discount_rate" decimal(5,2) NOT NULL DEFAULT 0,
"net_amount" decimal(18,4) NOT NULL DEFAULT 0,
"due_date" date NOT NULL,
"ipfs_hash" character varying(128),
"risk_score" decimal(5,2),
"status" "public"."invoices_invoicestatus_enum" NOT NULL DEFAULT 'draft',
"smart_contract_id" character varying(64),
"rejection_reason" text,
"created_at" TIMESTAMP NOT NULL DEFAULT now(),
"updated_at" TIMESTAMP NOT NULL DEFAULT now(),
"deleted_at" TIMESTAMP,
CONSTRAINT "UQ_invoices_invoice_number" UNIQUE ("invoice_number"),
CONSTRAINT "PK_invoices" PRIMARY KEY ("id"),
CONSTRAINT "FK_invoices_seller" FOREIGN KEY ("seller_id") REFERENCES "users"("id") ON DELETE CASCADE
);
CREATE INDEX "idx_invoices_seller_id" ON "invoices" ("seller_id");
CREATE UNIQUE INDEX "idx_invoices_invoice_number" ON "invoices" ("invoice_number");
CREATE INDEX "idx_invoices_customer_name" ON "invoices" ("customer_name");
CREATE INDEX "idx_invoices_due_date" ON "invoices" ("due_date");
CREATE INDEX "idx_invoices_status" ON "invoices" ("status");
CREATE INDEX "idx_invoices_status_seller_id" ON "invoices" ("status", "seller_id");
CREATE INDEX "idx_invoices_status_due_date" ON "invoices" ("status", "due_date");
`);

await queryRunner.query(`
CREATE TABLE "investments" (
CREATE INDEX IF NOT EXISTS "idx_invoices_seller_id" ON "invoices" ("seller_id");
CREATE UNIQUE INDEX IF NOT EXISTS "idx_invoices_invoice_number" ON "invoices" ("invoice_number");
CREATE INDEX IF NOT EXISTS "idx_invoices_customer_name" ON "invoices" ("customer_name");
CREATE INDEX IF NOT EXISTS "idx_invoices_due_date" ON "invoices" ("due_date");
CREATE INDEX IF NOT EXISTS "idx_invoices_status" ON "invoices" ("status");
CREATE INDEX IF NOT EXISTS "idx_invoices_seller_status_created" ON "invoices" ("seller_id", "status", "created_at");
CREATE INDEX IF NOT EXISTS "idx_invoices_status_due_date" ON "invoices" ("status", "due_date");
CREATE INDEX IF NOT EXISTS "idx_invoices_status_created_at" ON "invoices" ("status", "created_at");
CREATE INDEX IF NOT EXISTS "idx_invoices_status_amount" ON "invoices" ("status", "amount");
CREATE INDEX IF NOT EXISTS "idx_invoices_ipfs_hash" ON "invoices" ("ipfs_hash");
CREATE INDEX IF NOT EXISTS "idx_invoices_smart_contract_id" ON "invoices" ("smart_contract_id");
`);

// 4. Create Investments Table & Optimized Indexes
await queryRunner.query(`
CREATE TABLE IF NOT EXISTS "investments" (
"id" uuid NOT NULL DEFAULT gen_random_uuid(),
"invoice_id" uuid NOT NULL,
"investor_id" uuid NOT NULL,
"investment_amount" decimal(18,4) NOT NULL,
"expected_return" decimal(18,4) NOT NULL,
"actual_return" decimal(18,4),
"status" "public"."investments_investmentstatus_enum" NOT NULL DEFAULT 'pending',
"transaction_hash" character varying(64),
"stellar_operation_index" integer,
"created_at" TIMESTAMP NOT NULL DEFAULT now(),
"updated_at" TIMESTAMP NOT NULL DEFAULT now(),
"deleted_at" TIMESTAMP,
CONSTRAINT "PK_investments" PRIMARY KEY ("id"),
CONSTRAINT "FK_investments_invoice" FOREIGN KEY ("invoice_id") REFERENCES "invoices"("id") ON DELETE CASCADE,
CONSTRAINT "FK_investments_investor" FOREIGN KEY ("investor_id") REFERENCES "users"("id") ON DELETE CASCADE
);
CREATE INDEX "idx_investments_invoice_id" ON "investments" ("invoice_id");
CREATE INDEX "idx_investments_investor_id" ON "investments" ("investor_id");
CREATE INDEX "idx_investments_status" ON "investments" ("status");
CREATE INDEX "idx_investments_invoice_status" ON "investments" ("invoice_id", "status");
CREATE INDEX "idx_investments_investor_status" ON "investments" ("investor_id", "status");
`);

await queryRunner.query(`
CREATE TABLE "transactions" (
CREATE INDEX IF NOT EXISTS "idx_investments_invoice_id" ON "investments" ("invoice_id");
CREATE INDEX IF NOT EXISTS "idx_investments_investor_id" ON "investments" ("investor_id");
CREATE INDEX IF NOT EXISTS "idx_investments_status" ON "investments" ("status");
CREATE INDEX IF NOT EXISTS "idx_investments_investor_status" ON "investments" ("investor_id", "status");
CREATE INDEX IF NOT EXISTS "idx_investments_invoice_status" ON "investments" ("invoice_id", "status");
CREATE INDEX IF NOT EXISTS "idx_investments_transaction_hash" ON "investments" ("transaction_hash");
`);

// 5. Create Transactions Table & Optimized Indexes
await queryRunner.query(`
CREATE TABLE IF NOT EXISTS "transactions" (
"id" uuid NOT NULL DEFAULT gen_random_uuid(),
"user_id" uuid NOT NULL,
"investment_id" uuid,
"invoice_id" uuid,
"type" "public"."transactions_transactiontype_enum" NOT NULL,
"amount" decimal(18,4) NOT NULL,
"stellar_tx_hash" character varying(64),
"stellar_operation_index" integer,
"status" "public"."transactions_transactionstatus_enum" NOT NULL DEFAULT 'pending',
"timestamp" TIMESTAMP WITH TIME ZONE NOT NULL DEFAULT CURRENT_TIMESTAMP,
CONSTRAINT "PK_transactions" PRIMARY KEY ("id"),
CONSTRAINT "FK_transactions_user" FOREIGN KEY ("user_id") REFERENCES "users"("id") ON DELETE CASCADE,
CONSTRAINT "FK_transactions_investment" FOREIGN KEY ("investment_id") REFERENCES "investments"("id") ON DELETE SET NULL,
CONSTRAINT "FK_transactions_invoice" FOREIGN KEY ("invoice_id") REFERENCES "invoices"("id") ON DELETE SET NULL
);
CREATE INDEX IF NOT EXISTS "idx_transactions_user_id" ON "transactions" ("user_id");
CREATE INDEX IF NOT EXISTS "idx_transactions_investment_id" ON "transactions" ("investment_id");
CREATE INDEX IF NOT EXISTS "idx_transactions_invoice_id" ON "transactions" ("invoice_id");
CREATE INDEX IF NOT EXISTS "idx_transactions_type" ON "transactions" ("type");
CREATE INDEX IF NOT EXISTS "idx_transactions_status" ON "transactions" ("status");
CREATE INDEX IF NOT EXISTS "idx_transactions_user_type_status" ON "transactions" ("user_id", "type", "status");
CREATE INDEX IF NOT EXISTS "idx_transactions_stellar_tx_hash" ON "transactions" ("stellar_tx_hash");
`);

// 6. Create KYC Verifications Table & Indexes
await queryRunner.query(`
CREATE TABLE IF NOT EXISTS "kyc_verifications" (
"id" uuid NOT NULL DEFAULT gen_random_uuid(),
"user_id" uuid NOT NULL,
"verification_type" "public"."kyc_verifications_verificationtype_enum" NOT NULL,
"status" "public"."users_kycstatus_enum" NOT NULL DEFAULT 'pending',
"documents" jsonb,
"verified_at" TIMESTAMP WITH TIME ZONE,
"created_at" TIMESTAMP NOT NULL DEFAULT now(),
"updated_at" TIMESTAMP NOT NULL DEFAULT now(),
"deleted_at" TIMESTAMP,
CONSTRAINT "PK_kyc_verifications" PRIMARY KEY ("id"),
CONSTRAINT "FK_kyc_verifications_user" FOREIGN KEY ("user_id") REFERENCES "users"("id") ON DELETE CASCADE
);
CREATE INDEX IF NOT EXISTS "idx_kyc_verifications_user_id" ON "kyc_verifications" ("user_id");
CREATE INDEX IF NOT EXISTS "idx_kyc_verifications_type" ON "kyc_verifications" ("verification_type");
CREATE INDEX IF NOT EXISTS "idx_kyc_verifications_status" ON "kyc_verifications" ("status");
`);

// 7. Create Notifications Table & Indexes
await queryRunner.query(`
CREATE TABLE IF NOT EXISTS "notifications" (
"id" uuid NOT NULL DEFAULT gen_random_uuid(),
"user_id" uuid NOT NULL,
"type" "public"."notifications_notificationtype_enum" NOT NULL,
"title" character varying(255) NOT NULL,
"message" text NOT NULL,
"read" boolean NOT NULL DEFAULT false,
"timestamp" TIMESTAMP WITH TIME ZONE NOT NULL DEFAULT CURRENT_TIMESTAMP,
"created_at" TIMESTAMP NOT NULL DEFAULT now(),
"updated_at" TIMESTAMP NOT NULL DEFAULT now(),
"deleted_at" TIMESTAMP,
CONSTRAINT "PK_notifications" PRIMARY KEY ("id"),
CONSTRAINT "FK_notifications_user" FOREIGN KEY ("user_id") REFERENCES "users"("id") ON DELETE CASCADE
);
CREATE INDEX IF NOT EXISTS "idx_notifications_user_id" ON "notifications" ("user_id");
CREATE INDEX IF NOT EXISTS "idx_notifications_type" ON "notifications" ("type");
CREATE INDEX IF NOT EXISTS "idx_notifications_user_read" ON "notifications" ("user_id", "read");
`);

logger.info("InitialSchema migration completed successfully", { migration: this.name });
} catch (error) {
logger.error("Failed to execute InitialSchema migration", {
error: error instanceof Error ? error.message : String(error),
migration: this.name,
});
if (error instanceof AppError) {
throw error;
}
throw new AppError(
500,
`InitialSchema migration failed: ${error instanceof Error ? error.message : String(error)}`,
"MIGRATION_EXECUTION_FAILED",
);
}
}

public async down(queryRunner: QueryRunner): Promise<void> {
try {
await queryRunner.query(`DROP TABLE IF EXISTS "notifications" CASCADE`);
await queryRunner.query(`DROP TABLE IF EXISTS "kyc_verifications" CASCADE`);
await queryRunner.query(`DROP TABLE IF EXISTS "transactions" CASCADE`);
await queryRunner.query(`DROP TABLE IF EXISTS "investments" CASCADE`);
await queryRunner.query(`DROP TABLE IF EXISTS "invoices" CASCADE`);
await queryRunner.query(`DROP TABLE IF EXISTS "users" CASCADE`);
await queryRunner.query(`DROP TYPE IF EXISTS "public"."notifications_notificationtype_enum" CASCADE`);
await queryRunner.query(`DROP TYPE IF EXISTS "public"."kyc_verifications_verificationtype_enum" CASCADE`);
await queryRunner.query(`DROP TYPE IF EXISTS "public"."transactions_transactionstatus_enum" CASCADE`);
await queryRunner.query(`DROP TYPE IF EXISTS "public"."transactions_transactiontype_enum" CASCADE`);
await queryRunner.query(`DROP TYPE IF EXISTS "public"."investments_investmentstatus_enum" CASCADE`);
await queryRunner.query(`DROP TYPE IF EXISTS "public"."invoices_invoicestatus_enum" CASCADE`);
await queryRunner.query(`DROP TYPE IF EXISTS "public"."users_kycstatus_enum" CASCADE`);
await queryRunner.query(`DROP TYPE IF EXISTS "public"."users_usertype_enum" CASCADE`);

logger.info("InitialSchema rollback completed successfully", { migration: this.name });
} catch (error) {
logger.error("Failed to rollback InitialSchema migration", {
error: error instanceof Error ? error.message : String(error),
migration: this.name,
});
if (error instanceof AppError) {
throw error;
}
throw new AppError(
500,
`InitialSchema rollback failed: ${error instanceof Error ? error.message : String(error)}`,
"MIGRATION_ROLLBACK_FAILED",
);
}
}
}
4 changes: 1 addition & 3 deletions src/models/Invoice.model.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,6 @@
OneToMany,
JoinColumn,
Index,
BeforeInsert,
BeforeUpdate,
} from "typeorm";
import Decimal from "decimal.js";
import { InvoiceStatus } from "../types/enums";
Expand All @@ -21,7 +19,7 @@
* Frozen state transition map optimized for performance.
* Prevents accidental mutations and enables faster lookups.
*/
export const VALID_INVOICE_TRANSITIONS: Record<InvoiceStatus, InvoiceStatus[]> = Object.freeze({

Check failure on line 22 in src/models/Invoice.model.ts

View workflow job for this annotation

GitHub Actions / Type Check 

Type 'Readonly<{ draft: readonly InvoiceStatus[]; pending: readonly InvoiceStatus[]; published: readonly InvoiceStatus[]; funded: readonly InvoiceStatus[]; settled: readonly InvoiceStatus[]; cancelled: readonly never[]; rejected: readonly never[]; }>' is not assignable to type 'Record<InvoiceStatus, InvoiceStatus[]>'.

Check failure on line 22 in src/models/Invoice.model.ts

View workflow job for this annotation

GitHub Actions / Build 

Type 'Readonly<{ draft: readonly InvoiceStatus[]; pending: readonly InvoiceStatus[]; published: readonly InvoiceStatus[]; funded: readonly InvoiceStatus[]; settled: readonly InvoiceStatus[]; cancelled: readonly never[]; rejected: readonly never[]; }>' is not assignable to type 'Record<InvoiceStatus, InvoiceStatus[]>'.
[InvoiceStatus.DRAFT]: Object.freeze([InvoiceStatus.PUBLISHED, InvoiceStatus.CANCELLED, InvoiceStatus.REJECTED]),
[InvoiceStatus.PENDING]: Object.freeze([InvoiceStatus.PUBLISHED, InvoiceStatus.CANCELLED, InvoiceStatus.REJECTED]),
[InvoiceStatus.PUBLISHED]: Object.freeze([InvoiceStatus.FUNDED, InvoiceStatus.CANCELLED]),
Expand Down Expand Up @@ -552,4 +550,4 @@
);
}
}

}
10 changes: 8 additions & 2 deletions src/models/User.model.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -294,9 +294,9 @@ export class User {
/**
* Converts user entity to public DTO, excluding sensitive fields.
*/
static toPublicDTO(user: User): Omit<User, "deleted_at"> {
static toPublicDTO(user: User): Omit<User, "deletedAt"> {
try {
const dto = {
const dto: Omit<User, "deletedAt"> = {
id: user.id,
stellarAddress: user.stellarAddress,
email: user.email,
Expand All @@ -305,6 +305,11 @@ export class User {
isKycVerified: user.isKycVerified,
createdAt: user.createdAt,
updatedAt: user.updatedAt,
invoices: user.invoices,
investments: user.investments,
transactions: user.transactions,
kycVerifications: user.kycVerifications,
notifications: user.notifications,
};
return dto;
} catch (error) {
Expand All @@ -320,3 +325,4 @@ export class User {
);
}
}
}
3 changes: 1 addition & 2 deletions src/services/auth.service.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,7 @@ import type { AppConfig } from "../config/env";
import { AuthChallenge } from "../models/AuthChallenge.model";
import { User } from "../models/User.model";
import type { PublicUser } from "../types/auth";
import { AppError, HttpError } from "../utils/http-error";
import { logger } from "../observability/logger";
import { HttpError } from "../utils/http-error";
import {
buildAuthFailureDetails,
classifyJwtError,
Expand Down
15 changes: 0 additions & 15 deletions src/services/invoice.service.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -802,21 +802,6 @@ export class InvoiceService {
"Token holders can only be queried for published invoices",
400
);

// Update invoice with IPFS hash
invoice.ipfsHash = uploadResult.hash;
await this.invoiceRepository.save(invoice);

return {
invoiceId: input.invoiceId,
ipfsHash: uploadResult.hash,
fileSize: uploadResult.size,
uploadedAt: uploadResult.timestamp,
};
} catch (error) {
if (error instanceof ServiceError) throw error;
logger.error('Failed to process', { error });
throw new AppError(500, 'Processing failed', 'PROCESSING_FAILED', { error });
}

if (!this.dataSource) {
Expand Down
Loading
Loading