Assign color for each project

Author: alexandrudanpop

packages/server/api/src/app/database/migrations/1765287443041-AddColorToProject.ts

@@ -0,0 +1,34 @@
+import { PROJECT_COLORS } from '@openops/shared';
+import { MigrationInterface, QueryRunner } from 'typeorm';
+
+export class AddColorToProject1765287443041 implements MigrationInterface {
+  name = 'AddColorToProject1765287443041';
+
+  public async up(queryRunner: QueryRunner): Promise<void> {
+    await queryRunner.query(`
+      ALTER TABLE "project"
+      ADD COLUMN IF NOT EXISTS "color" character varying;
+    `);
+
+    const projects = await queryRunner.query(`
+      SELECT "id" FROM "project" WHERE "color" IS NULL ORDER BY "created" ASC;
+    `);
+
+    for (let i = 0; i < projects.length; i++) {
+      const color = PROJECT_COLORS[i % PROJECT_COLORS.length];
+      await queryRunner.query(
+        `UPDATE "project" SET "color" = $1 WHERE "id" = $2;`,
+        [color, projects[i].id],
+      );
+    }
+
+    await queryRunner.query(`
+      ALTER TABLE "project"
+      ALTER COLUMN "color" SET NOT NULL;
+    `);
+  }
+
+  public async down(_: QueryRunner): Promise<void> {
+    throw new Error('Rollback not implemented');
+  }
+}

packages/server/api/src/app/database/postgres-connection.ts

@@ -39,6 +39,7 @@ import { AddTestRunActionLimitsToFlowVersion1760429290001 } from './migrations/1
 import { MoveTablesWorkspaceIdFromOrganizationToProject1760500000000 } from './migrations/1760500000000-MoveTablesWorkspaceIdFromOrganizationToProject';
 import { AddTablesDatabaseTokenToProject1763394159990 } from './migrations/1763394159990-AddTablesTokenToProject';
 import { MigrateTablesUserPassword1763755045436 } from './migrations/1763755045436-MigrateTablesUserPassword';
+import { AddColorToProject1765287443041 } from './migrations/1765287443041-AddColorToProject';
 
 const getSslConfig = (): boolean | TlsOptions => {
   const useSsl = system.get(AppSystemProp.POSTGRES_USE_SSL);
@@ -86,6 +87,7 @@ const getMigrations = (): (new () => MigrationInterface)[] => {
     MoveTablesWorkspaceIdFromOrganizationToProject1760500000000,
     AddTablesDatabaseTokenToProject1763394159990,
     MigrateTablesUserPassword1763755045436,
+    AddColorToProject1765287443041,
   ];
 };
 

packages/server/api/src/app/project/project-entity.ts

@@ -51,6 +51,10 @@ export const ProjectEntity = new EntitySchema<ProjectSchema>({
       type: JSONB_COLUMN_TYPE,
       nullable: false,
     },
+    color: {
+      type: String,
+      nullable: false,
+    },
   },
   indices: [
     {

packages/server/api/src/app/project/project-service.ts

@@ -7,6 +7,8 @@ import {
   openOpsId,
   OpenOpsId,
   Project,
+  PROJECT_COLORS,
+  ProjectColor,
   ProjectId,
   spreadIfDefined,
   User,
@@ -19,6 +21,12 @@ import { projectHooks } from './project-hooks';
 
 export const projectRepo = repoFactory(ProjectEntity);
 
+async function getNextProjectColor(): Promise<ProjectColor> {
+  const projectCount = await projectRepo().count();
+  const colorIndex = projectCount % PROJECT_COLORS.length;
+  return PROJECT_COLORS[colorIndex];
+}
+
 export const projectService = {
   async create(params: CreateParams): Promise<Project> {
     const encryptTablesToken = encryptUtils.encryptString(
@@ -28,6 +36,7 @@ export const projectService = {
       id: openOpsId(),
       ...params,
       tablesDatabaseToken: encryptTablesToken,
+      color: await getNextProjectColor(),
     };
 
     const savedProject = await projectRepo().save(newProject);

packages/shared/src/lib/project/project.ts

@@ -3,6 +3,20 @@ import { BaseModelSchema, Nullable } from '../common/base-model';
 import { OpenOpsId } from '../common/id-generator';
 import { ProjectMemberRole } from './project-member';
 
+export const PROJECT_COLORS = [
+  'purple',
+  'blue',
+  'green',
+  'yellow',
+  'pink',
+] as const;
+
+export type ProjectColor = (typeof PROJECT_COLORS)[number];
+
+export const ProjectColorSchema = Type.Union(
+  PROJECT_COLORS.map((color) => Type.Literal(color)),
+);
+
 export const ListProjectRequestForUserQueryParams = Type.Object({
   cursor: Type.Optional(Type.String()),
   limit: Type.Optional(Type.Number()),
@@ -38,6 +52,7 @@ export const Project = Type.Object({
     iv: Type.String(),
     data: Type.String(),
   }),
+  color: ProjectColorSchema,
 });
 
 export type Project = Static<typeof Project>;