fix: maintain incremental orderIndex for collections and requests (hoppscotch#5338)

Co-authored-by: Anwarul Islam <[email protected]>
Co-authored-by: jamesgeorge007 <[email protected]>

Author: 3 people

.env.example

@@ -3,7 +3,7 @@
 DATABASE_URL=postgresql://postgres:testpass@hoppscotch-db:5432/hoppscotch
 
 # Sensitive Data Encryption Key while storing in Database (32 character)
-DATA_ENCRYPTION_KEY="data encryption key with 32 char"
+DATA_ENCRYPTION_KEY=data encryption key with 32 char
 
 # Whitelisted origins for the Hoppscotch App.
 # This list controls which origins can interact with the app through cross-origin comms.
@@ -12,7 +12,7 @@ DATA_ENCRYPTION_KEY="data encryption key with 32 char"
 #   NOTE: `3200` here refers to the bundle server (port 3200) that provides the bundles,
 #   NOT where the app runs. The app itself uses the `app://` protocol with dynamic
 #   bundle names like `app://{bundle-name}/`
-WHITELISTED_ORIGINS="http://localhost:3170,http://localhost:3000,http://localhost:3100,app://localhost_3200,app://hoppscotch"
+WHITELISTED_ORIGINS=http://localhost:3170,http://localhost:3000,http://localhost:3100,app://localhost_3200,app://hoppscotch
 
 # If true, the client’s IP address is understood as the left-most entry in the X-Forwarded-For header
 TRUST_PROXY=false

packages/hoppscotch-backend/prisma/migrations/20250818154928_fix_order_index/migration.sql

@@ -0,0 +1,59 @@
+-- Recalculate orderIndex for UserCollection per (parentID)
+WITH ordered AS (
+  SELECT
+    id,
+    ROW_NUMBER() OVER (
+      PARTITION BY "parentID"
+      ORDER BY "orderIndex" ASC, "createdOn" ASC, id ASC
+    ) AS new_index
+  FROM "UserCollection"
+)
+UPDATE "UserCollection" uc
+SET "orderIndex" = o.new_index
+FROM ordered o
+WHERE uc.id = o.id;
+
+-- Recalculate orderIndex for UserRequest per (collectionID)
+WITH ordered AS (
+  SELECT
+    id,
+    ROW_NUMBER() OVER (
+      PARTITION BY "collectionID"
+      ORDER BY "orderIndex" ASC, "createdOn" ASC, id ASC
+    ) AS new_index
+  FROM "UserRequest"
+)
+UPDATE "UserRequest" ur
+SET "orderIndex" = o.new_index
+FROM ordered o
+WHERE ur.id = o.id;
+
+-- Recalculate orderIndex for TeamCollection per (teamID, parentID)
+WITH ordered AS (
+  SELECT
+    id,
+    ROW_NUMBER() OVER (
+      PARTITION BY "teamID", "parentID"
+      ORDER BY "orderIndex" ASC, "createdOn" ASC, id ASC
+    ) AS new_index
+  FROM "TeamCollection"
+)
+UPDATE "TeamCollection" tc
+SET "orderIndex" = o.new_index
+FROM ordered o
+WHERE tc.id = o.id;
+
+-- Recalculate orderIndex for TeamRequest per (teamID, collectionID)
+WITH ordered AS (
+  SELECT
+    id,
+    ROW_NUMBER() OVER (
+      PARTITION BY "teamID", "collectionID"
+      ORDER BY "orderIndex" ASC, "createdOn" ASC, id ASC
+    ) AS new_index
+  FROM "TeamRequest"
+)
+UPDATE "TeamRequest" tr
+SET "orderIndex" = o.new_index
+FROM ordered o
+WHERE tr.id = o.id;

packages/hoppscotch-backend/prisma/migrations/20250822044741_order_index_unique_constraint/migration.sql

@@ -0,0 +1,21 @@
+-- Recreate as DEFERRABLE UNIQUE CONSTRAINTS
+
+ALTER TABLE "TeamCollection"
+ADD CONSTRAINT "TeamCollection_teamID_parentID_orderIndex_key"
+  UNIQUE ("teamID", "parentID", "orderIndex")
+  DEFERRABLE INITIALLY DEFERRED;
+
+ALTER TABLE "TeamRequest"
+ADD CONSTRAINT "TeamRequest_teamID_collectionID_orderIndex_key"
+  UNIQUE ("teamID", "collectionID", "orderIndex")
+  DEFERRABLE INITIALLY DEFERRED;
+
+ALTER TABLE "UserCollection"
+ADD CONSTRAINT "UserCollection_userUid_parentID_orderIndex_key"
+  UNIQUE ("userUid", "parentID", "orderIndex")
+  DEFERRABLE INITIALLY DEFERRED;
+
+ALTER TABLE "UserRequest"
+ADD CONSTRAINT "UserRequest_userUid_collectionID_orderIndex_key"
+  UNIQUE ("userUid", "collectionID", "orderIndex")
+  DEFERRABLE INITIALLY DEFERRED;

packages/hoppscotch-backend/prisma/schema.prisma

@@ -53,6 +53,8 @@ model TeamCollection {
   orderIndex Int
   createdOn  DateTime         @default(now()) @db.Timestamptz(3)
   updatedOn  DateTime         @updatedAt @db.Timestamptz(3)
+
+  @@unique([teamID, parentID, orderIndex])
 }
 
 model TeamRequest {
@@ -66,6 +68,8 @@ model TeamRequest {
   orderIndex   Int
   createdOn    DateTime       @default(now()) @db.Timestamptz(3)
   updatedOn    DateTime       @updatedAt @db.Timestamptz(3)
+
+  @@unique([teamID, collectionID, orderIndex])
 }
 
 model Shortcode {
@@ -189,6 +193,8 @@ model UserRequest {
   orderIndex     Int
   createdOn      DateTime       @default(now()) @db.Timestamptz(3)
   updatedOn      DateTime       @updatedAt @db.Timestamptz(3)
+
+  @@unique([userUid, collectionID, orderIndex])
 }
 
 model UserCollection {
@@ -205,6 +211,8 @@ model UserCollection {
   type       ReqType
   createdOn  DateTime         @default(now()) @db.Timestamptz(3)
   updatedOn  DateTime         @updatedAt @db.Timestamptz(3)
+
+  @@unique([userUid, parentID, orderIndex])
 }
 
 enum TeamAccessRole {

packages/hoppscotch-backend/src/errors.ts

@@ -188,6 +188,12 @@ export const TEAM_FB_COLL_PATH_RESOLVE_FAIL = 'team/fb_coll_path_resolve_fail';
  */
 export const TEAM_COLL_NOT_FOUND = 'team_coll/collection_not_found';
 
+/**
+ * Could not find the team in the database
+ * (TeamCollectionService)
+ */
+export const TEAM_COLL_CREATION_FAILED = 'team_coll/creation_failed';
+
 /**
  * Cannot make parent collection a child of a collection that a child of itself
  * (TeamCollectionService)
@@ -650,6 +656,13 @@ export const USER_COLL_NOT_SAME_TYPE = 'user_coll/type_mismatch' as const;
 export const USER_COLL_IS_PARENT_COLL =
   'user_coll/user_collection_is_parent_coll' as const;
 
+/**
+ * User Collection Creation Failed
+ * (UserCollectionService)
+ */
+export const USER_COLLECTION_CREATION_FAILED =
+  'user_collection/creation_failed' as const;
+
 /**
  * User Collection Re-Ordering Failed
  * (UserCollectionService)

packages/hoppscotch-backend/src/infra-config/helper.ts

@@ -87,7 +87,7 @@ export async function loadInfraConfiguration() {
 
     // Prisma throw error if 'Can't reach at database server' OR 'Table does not exist'
     // Reason for not throwing error is, we want successful build during 'postinstall' and generate dist files
-    console.log('Error from loadInfraConfiguration', error);
+    console.error('Error from loadInfraConfiguration', error);
     return { INFRA: {} };
   }
 }

packages/hoppscotch-backend/src/infra-config/infra-config.service.ts

@@ -42,6 +42,7 @@ import {
   SaveOnboardingConfigResponse,
 } from './dto/onboarding.dto';
 import * as crypto from 'crypto';
+import { PrismaError } from 'src/prisma/prisma-error-codes';
 
 @Injectable()
 export class InfraConfigService implements OnModuleInit {
@@ -125,14 +126,14 @@ export class InfraConfigService implements OnModuleInit {
         stopApp();
       }
     } catch (error) {
-      if (error.code === 'P1001') {
+      if (error.code === PrismaError.DATABASE_UNREACHABLE) {
         // Prisma error code for 'Can't reach at database server'
         // We're not throwing error here because we want to allow the app to run 'pnpm install'
-      } else if (error.code === 'P2021') {
+      } else if (error.code === PrismaError.TABLE_DOES_NOT_EXIST) {
         // Prisma error code for 'Table does not exist'
         throwErr(DATABASE_TABLE_NOT_EXIST);
       } else {
-        console.log(error);
+        console.error(error);
         throwErr(error);
       }
     }

packages/hoppscotch-backend/src/mailer/mailer.service.ts

@@ -56,7 +56,7 @@ export class MailerService {
         context: mailDesc.variables,
       });
     } catch (error) {
-      console.log('Error from sendEmail:', error);
+      console.error('Error from sendEmail:', error);
       return throwErr(EMAIL_FAILED);
     }
   }
@@ -82,7 +82,7 @@ export class MailerService {
       });
       return res;
     } catch (error) {
-      console.log('Error from sendUserInvitationEmail:', error);
+      console.error('Error from sendUserInvitationEmail:', error);
       return throwErr(EMAIL_FAILED);
     }
   }

packages/hoppscotch-backend/src/main.ts

@@ -88,7 +88,6 @@ async function bootstrap() {
 
   if (configService.get('TRUST_PROXY') === 'true') {
     console.log('Enabling trust proxy');
-
     app.set('trust proxy', true);
   }
 

packages/hoppscotch-backend/src/prisma/prisma-error-codes.ts

@@ -0,0 +1,7 @@
+export enum PrismaError {
+  DATABASE_UNREACHABLE = 'P1001',
+  TABLE_DOES_NOT_EXIST = 'P2021',
+  UNIQUE_CONSTRAINT_VIOLATION = 'P2002',
+  TRANSACTION_TIMEOUT = 'P2028',
+  TRANSACTION_DEADLOCK = 'P2034', // write conflict or a deadlock
+}