Add campaignId column to opportunities table

Author: bigfluffycookie

packages/server/api/src/app/database/seeds/openops-opportunities-table-campaign-id-seed.ts

@@ -0,0 +1,58 @@
+import {
+  createAxiosHeaders,
+  getTableByName,
+  makeOpenOpsTablesPost,
+  resolveTokenProvider,
+  TablesServerContext,
+} from '@openops/common';
+import { logger } from '@openops/server-shared';
+import { FlagEntity } from '../../flags/flag.entity';
+import { SEED_OPENOPS_TABLE_NAME } from '../../openops-tables/template-tables/create-opportunities-table';
+import { databaseConnection } from '../database-connection';
+import { applyToEachTablesDatabase } from './tables-database-iterator';
+
+const OPPORTUNITIES_CAMPAIGN_ID_SEED = 'OPP_CAMPAIGN_ID_SEED';
+
+const alreadyApplied = async (): Promise<boolean> => {
+  const flagRepo = databaseConnection().getRepository(FlagEntity);
+  const flag = await flagRepo.findOneBy({ id: OPPORTUNITIES_CAMPAIGN_ID_SEED });
+  return flag?.value === true;
+};
+
+const setFlag = async (): Promise<void> => {
+  const flagRepo = databaseConnection().getRepository(FlagEntity);
+  await flagRepo.save({ id: OPPORTUNITIES_CAMPAIGN_ID_SEED, value: true });
+};
+
+export const seedOpportunitiesCampaignIdField = async (): Promise<void> => {
+  await setFlag();
+  return;
+  if (await alreadyApplied()) {
+    logger.info('Skip: Opportunities Campaign ID field already seeded', {
+      name: 'seedOpportunitiesCampaignIdField',
+    });
+    return;
+  }
+
+  await applyToEachTablesDatabase(
+    async (tablesContext: TablesServerContext): Promise<void> => {
+      const table = await getTableByName(
+        SEED_OPENOPS_TABLE_NAME,
+        tablesContext,
+      );
+
+      if (!table) {
+        return;
+      }
+
+      const tokenOrResolver = await resolveTokenProvider(tablesContext);
+      await makeOpenOpsTablesPost(
+        `api/database/fields/table/${table.id}/`,
+        { name: 'Campaign ID', type: 'text' },
+        createAxiosHeaders(tokenOrResolver),
+      );
+    },
+  );
+
+  await setFlag();
+};

packages/server/api/src/app/openops-tables/template-tables/create-opportunities-table.ts

@@ -129,6 +129,11 @@ export async function createOpportunitiesTable(
     type: 'long_text',
   });
 
+  await addField(tokenOrResolver, table.id, {
+    name: 'Campaign ID',
+    type: 'text',
+  });
+
   await addField(tokenOrResolver, table.id, {
     name: 'Creation time',
     type: 'created_on',

packages/server/api/src/main.ts

@@ -16,6 +16,7 @@ import { ensureTablesMcpEndpointExists } from './app/database/seeds/ensure-table
 import { seedFocusDataAggregationTemplateTable } from './app/database/seeds/openops-aggregated-costs-seed';
 import * as analytics from './app/database/seeds/openops-analytics-seed';
 import { seedKnownCostTypesByApplicationTable } from './app/database/seeds/openops-known-cost-types-by-application-seed';
+import { seedOpportunitiesCampaignIdField } from './app/database/seeds/openops-opportunities-table-campaign-id-seed';
 import { seedOpportunitesTemplateTable } from './app/database/seeds/openops-opportunities-table-seed';
 import { seedTimeseriesTemplateTable } from './app/database/seeds/openops-timeseries-table-seed';
 import { upsertAdminUser } from './app/database/seeds/seed-admin';
@@ -97,6 +98,7 @@ const main = async (): Promise<void> => {
 
     await seedTemplateTables();
     await seedOpportunitesTemplateTable();
+    await seedOpportunitiesCampaignIdField();
     await seedFocusDataAggregationTemplateTable();
     await seedKnownCostTypesByApplicationTable();
     await seedAutoInstancesShutdownTable();