Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
286 changes: 277 additions & 9 deletions migration/1779182511001-AddIdToProjectQfRound.ts
Original file line number Diff line number Diff line change
@@ -1,32 +1,300 @@
import { MigrationInterface, QueryRunner } from 'typeorm';
import { logger } from '../src/utils/logger';

export class AddIdToProjectQfRound1779182511001 implements MigrationInterface {
name = 'AddIdToProjectQfRound1779182511001';

public async up(queryRunner: QueryRunner): Promise<void> {
// Add the new id column as auto-incrementing column (not primary key)
// First, check if the table exists and get the current primary key constraint name
const tableExists = await queryRunner.hasTable(
'project_qf_rounds_qf_round',
);
if (!tableExists) {
throw new Error('Table project_qf_rounds_qf_round does not exist');
}

// Check if the id column already exists (migration already ran)
const idColumnExists = await queryRunner.hasColumn(
'project_qf_rounds_qf_round',
'id',
);

if (idColumnExists) {
return;
}

// Get all primary key constraints for this table
const allConstraintsQuery = await queryRunner.query(`
SELECT conname, contype
FROM pg_constraint
WHERE conrelid = (
SELECT oid
FROM pg_class
WHERE relname = 'project_qf_rounds_qf_round'
) AND contype = 'p'
`);

// Drop all primary key constraints
for (const constraint of allConstraintsQuery) {
try {
await queryRunner.query(`
ALTER TABLE "project_qf_rounds_qf_round"
DROP CONSTRAINT IF EXISTS "${constraint.conname}"
`);
} catch (error) {
// Continue with other constraints
}
}

// Also try to drop the standard constraint names that might exist
// Use a more robust approach to handle constraint dropping
const possibleConstraints = [
'PK_046d515dee2988817725ec75ebf',
'project_qf_rounds_qf_round_pkey',
'PK_project_qf_rounds_qf_round',
];

for (const constraintName of possibleConstraints) {
try {
// First check if constraint exists before trying to drop it
const constraintExists = await queryRunner.query(`
SELECT 1 FROM pg_constraint
WHERE conname = '${constraintName}'
AND conrelid = (
SELECT oid FROM pg_class WHERE relname = 'project_qf_rounds_qf_round'
)
`);

if (constraintExists && constraintExists.length > 0) {
await queryRunner.query(`
ALTER TABLE "project_qf_rounds_qf_round"
DROP CONSTRAINT "${constraintName}"
`);
}
} catch (error) {
// Ignore errors for constraints that don't exist
logger.error(`Error handling constraint ${constraintName}:`, error);
}
}

// PostgreSQL doesn't support column positioning, so we need to recreate the table
// to have id as the first column
await this.resetTableStructure(queryRunner);
}

// Emergency method to completely reset the table if needed
private async resetTableStructure(queryRunner: QueryRunner): Promise<void> {
// Step 1: Backup existing data
await queryRunner.query(`
CREATE TEMP TABLE project_qf_rounds_backup AS
SELECT "projectId", "qfRoundId", "sumDonationValueUsd", "countUniqueDonors", "createdAt", "updatedAt"
FROM "project_qf_rounds_qf_round"
`);

// Step 2: Drop the problematic table
await queryRunner.query(`
DROP TABLE IF EXISTS "project_qf_rounds_qf_round" CASCADE
`);
Comment on lines +95 to +97
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🔴 Critical

CASCADE will drop dependent objects without recreating them.

DROP TABLE ... CASCADE on line 96 will silently drop all dependent database objects:

  • Foreign key constraints from other tables
  • Views that reference this table
  • Triggers
  • Stored procedures that reference the table

These dependencies are not recreated after the table is rebuilt, which will break referential integrity and potentially cause application failures.

Either:

Option 1: Remove CASCADE and handle dependencies explicitly:

     // Step 2: Drop the problematic table
     await queryRunner.query(`
-      DROP TABLE IF EXISTS "project_qf_rounds_qf_round" CASCADE
+      DROP TABLE IF EXISTS "project_qf_rounds_qf_round"
     `);

Then query pg_constraint for foreign keys and recreate them manually after table creation.

Option 2: Document that this migration requires manual restoration of dependent objects, and provide a script to identify what will be dropped:

// Before dropping, log what CASCADE will affect:
const dependencies = await queryRunner.query(`
  SELECT 
    conname AS constraint_name,
    confrelid::regclass AS referencing_table
  FROM pg_constraint
  WHERE confrelid = 'project_qf_rounds_qf_round'::regclass
`);
logger.warn('CASCADE will drop these dependencies:', dependencies);


// Step 3: Recreate the table with proper structure
await queryRunner.query(`
CREATE TABLE "project_qf_rounds_qf_round" (
"id" SERIAL PRIMARY KEY,
"projectId" INTEGER NOT NULL,
"qfRoundId" INTEGER NOT NULL,
"sumDonationValueUsd" REAL DEFAULT 0,
"countUniqueDonors" INTEGER DEFAULT 0,
"createdAt" TIMESTAMP DEFAULT NOW(),
"updatedAt" TIMESTAMP DEFAULT NOW(),
CONSTRAINT "UQ_project_qf_rounds_composite" UNIQUE ("projectId", "qfRoundId")
)
`);

// Step 4: Create indexes
await queryRunner.query(`
CREATE INDEX "IDX_project_qf_rounds_projectId" ON "project_qf_rounds_qf_round" ("projectId")
`);

await queryRunner.query(`
CREATE INDEX "IDX_project_qf_rounds_qfRoundId" ON "project_qf_rounds_qf_round" ("qfRoundId")
`);

// Step 5: Restore data with new auto-incrementing IDs
await queryRunner.query(`
INSERT INTO "project_qf_rounds_qf_round" ("projectId", "qfRoundId", "sumDonationValueUsd", "countUniqueDonors", "createdAt", "updatedAt")
SELECT "projectId", "qfRoundId", "sumDonationValueUsd", "countUniqueDonors", "createdAt", "updatedAt"
FROM project_qf_rounds_backup
`);

// Clean up
await queryRunner.query(`DROP TABLE project_qf_rounds_backup`);
}

// Alternative method using the constraint fix approach
private async fixConstraintsOnly(queryRunner: QueryRunner): Promise<void> {
// Drop all possible primary key constraints
const allConstraints = await queryRunner.query(`
SELECT conname
FROM pg_constraint
WHERE conrelid = (
SELECT oid
FROM pg_class
WHERE relname = 'project_qf_rounds_qf_round'
) AND contype = 'p'
`);

for (const constraint of allConstraints) {
try {
await queryRunner.query(`
ALTER TABLE "project_qf_rounds_qf_round"
DROP CONSTRAINT IF EXISTS "${constraint.conname}"
`);
} catch (error) {
logger.error(`Error dropping constraint ${constraint.conname}:`, error);
}
}

// Also try common constraint names
const commonConstraints = [
'PK_046d515dee2988817725ec75ebf',
'project_qf_rounds_qf_round_pkey',
'PK_project_qf_rounds_qf_round',
];

for (const constraintName of commonConstraints) {
try {
await queryRunner.query(`
ALTER TABLE "project_qf_rounds_qf_round"
DROP CONSTRAINT IF EXISTS "${constraintName}"
`);
} catch (error) {
// Ignore errors for constraints that don't exist
}
}

// Check if id column exists, if not add it
const idColumnExists = await queryRunner.hasColumn(
'project_qf_rounds_qf_round',
'id',
);

if (!idColumnExists) {
// First add the column as SERIAL (auto-incrementing)
await queryRunner.query(`
ALTER TABLE "project_qf_rounds_qf_round" ADD COLUMN id SERIAL
`);

// Then add the primary key constraint
await queryRunner.query(`
ALTER TABLE "project_qf_rounds_qf_round"
ADD CONSTRAINT "PK_project_qf_rounds_qf_round_id" PRIMARY KEY (id)
`);
} else {
// Check if there are records without IDs (shouldn't happen with SERIAL)
const recordsWithoutIdResult = await queryRunner.query(`
SELECT COUNT(*) as count
FROM "project_qf_rounds_qf_round"
WHERE id IS NULL
`);
const recordsWithoutId = recordsWithoutIdResult[0]?.count || 0;

if (recordsWithoutId > 0) {
// Fix records without ID
await queryRunner.query(`
UPDATE "project_qf_rounds_qf_round"
SET id = nextval(pg_get_serial_sequence('project_qf_rounds_qf_round', 'id'))
WHERE id IS NULL
`);
}
}

// Add unique constraint if it doesn't exist
const uniqueConstraintExists = await queryRunner.query(`
SELECT 1
FROM information_schema.table_constraints
WHERE table_name = 'project_qf_rounds_qf_round'
AND constraint_name = 'UQ_project_qf_rounds_composite'
`);

if (!uniqueConstraintExists || uniqueConstraintExists.length === 0) {
await queryRunner.query(`
ALTER TABLE "project_qf_rounds_qf_round"
ADD CONSTRAINT "UQ_project_qf_rounds_composite"
UNIQUE ("projectId", "qfRoundId")
`);
}

// Add indexes if they don't exist
await queryRunner.query(`
ALTER TABLE "project_qf_rounds_qf_round"
ADD COLUMN "id" SERIAL
CREATE INDEX IF NOT EXISTS "IDX_project_qf_rounds_projectId"
ON "project_qf_rounds_qf_round" ("projectId")
`);

// Add index on the id column for performance
await queryRunner.query(`
CREATE INDEX "IDX_project_qf_rounds_id"
ON "project_qf_rounds_qf_round" ("id")
CREATE INDEX IF NOT EXISTS "IDX_project_qf_rounds_qfRoundId"
ON "project_qf_rounds_qf_round" ("qfRoundId")
`);
}

public async down(queryRunner: QueryRunner): Promise<void> {
// Drop the index first
// Drop the indexes first
await queryRunner.query(`
DROP INDEX IF EXISTS "IDX_project_qf_rounds_projectId"
`);

await queryRunner.query(`
DROP INDEX IF EXISTS "IDX_project_qf_rounds_qfRoundId"
`);

// Drop the unique constraint
await queryRunner.query(`
DROP INDEX IF EXISTS "IDX_project_qf_rounds_id"
ALTER TABLE IF EXISTS "project_qf_rounds_qf_round"
DROP CONSTRAINT IF EXISTS "UQ_project_qf_rounds_composite"
`);

// Get the current primary key constraint name for the id column
const primaryKeyQuery = await queryRunner.query(`
SELECT constraint_name
FROM information_schema.table_constraints
WHERE table_name = 'project_qf_rounds_qf_round'
AND constraint_type = 'PRIMARY KEY'
`);

const primaryKeyName = primaryKeyQuery[0]?.constraint_name;

if (primaryKeyName) {
try {
// Drop the id primary key constraint
await queryRunner.query(`
ALTER TABLE "project_qf_rounds_qf_round"
DROP CONSTRAINT "${primaryKeyName}"
`);
} catch (error) {
// Fallback with IF EXISTS
await queryRunner.query(`
ALTER TABLE "project_qf_rounds_qf_round"
DROP CONSTRAINT IF EXISTS "${primaryKeyName}"
`);
}
} else {
// Fallback: drop all possible primary key constraints
await queryRunner.query(`
ALTER TABLE "project_qf_rounds_qf_round"
DROP CONSTRAINT IF EXISTS "UQ_project_qf_rounds_qf_round"
`);
}

// Drop the id column
await queryRunner.query(`
ALTER TABLE "project_qf_rounds_qf_round"
ALTER TABLE IF EXISTS "project_qf_rounds_qf_round"
DROP COLUMN IF EXISTS "id"
`);

// Restore the composite primary key
await queryRunner.query(`
ALTER TABLE IF EXISTS "project_qf_rounds_qf_round"
ADD CONSTRAINT "PK_project_qf_rounds_qf_round"
PRIMARY KEY ("projectId", "qfRoundId")
`);
Comment on lines +293 to +298
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor

Hard-coded constraint name may differ from original.

The composite primary key is restored with the hard-coded name "PK_project_qf_rounds_qf_round" (line 296), but the original constraint may have had a different name (e.g., "PK_046d515dee2988817725ec75ebf" as seen in line 52).

This was previously flagged and marked as addressed in commit 6595f6d, but the hard-coded name remains.

While functionally equivalent, this creates a naming inconsistency. Consider dynamically determining the original name if perfect reversibility is required. However, since constraint names don't affect behavior, this may be acceptable if you're standardizing on the new name going forward.

If standardization is not the goal, you could store the original PK name before dropping it in up() and reference it in down():

// In up(), before dropping PKs:
const originalPK = await queryRunner.query(`
  SELECT conname 
  FROM pg_constraint 
  WHERE conrelid = 'project_qf_rounds_qf_round'::regclass 
  AND contype = 'p' 
  LIMIT 1
`);
// Store originalPK[0]?.conname somewhere (e.g., migration metadata table)

// In down():
// Retrieve stored name and use it instead of hard-coded value
🤖 Prompt for AI Agents
In migration/1779182511001-AddIdToProjectQfRound.ts around lines 293-298 the
composite PK is recreated with a hard-coded name
"PK_project_qf_rounds_qf_round", which may differ from the original and breaks
perfect reversibility; before dropping the original PK in up(), query
pg_constraint for the existing primary key name on project_qf_rounds_qf_round
and persist that name (e.g., in a simple migration metadata table or a temporary
table/comment), then in down() retrieve and use that persisted name when
re-adding the constraint instead of the hard-coded string so the original
constraint name is restored; alternatively, if you intend to standardize on the
new name, document that decision and leave the new name.

}
}
13 changes: 8 additions & 5 deletions src/entities/projectQfRound.ts
Original file line number Diff line number Diff line change
@@ -1,31 +1,34 @@
import { Field, ID, ObjectType, Float, Int } from 'type-graphql';
import {
PrimaryColumn,
PrimaryGeneratedColumn,
Column,
Entity,
ManyToOne,
BaseEntity,
CreateDateColumn,
UpdateDateColumn,
Index,
Unique,
} from 'typeorm';
import { Project } from './project';
import { QfRound } from './qfRound';

@Entity('project_qf_rounds_qf_round')
@ObjectType()
@Unique(['projectId', 'qfRoundId']) // Ensure uniqueness of the composite key
export class ProjectQfRound extends BaseEntity {
@Field(_type => ID)
@Column({ generated: 'increment' })
@Index()
@PrimaryGeneratedColumn() // Make this the primary key
id: number;

@Field(_type => ID)
@PrimaryColumn()
@Column()
@Index()
projectId: number;

@Field(_type => ID)
@PrimaryColumn()
@Column()
@Index()
qfRoundId: number;

@ManyToOne(_type => Project, project => project.projectQfRoundRelations)
Expand Down
Loading