Further refactor template tables seed for improved semantics (#1726)

cezudas · web-flow · commit 1b1bfcbc74a8 · 2025-12-03T16:13:06.000+02:00
Part of OPS-3009.
diff --git a/packages/server/api/src/app/database/seeds/auto-instances-shutdown-table-seed.ts b/packages/server/api/src/app/database/seeds/auto-instances-shutdown-table-seed.ts
@@ -7,7 +7,7 @@ import {
 } from '../../openops-tables/template-tables/create-auto-instances-shutdown-table';
 import { databaseConnection } from '../database-connection';
 import { getDefaultProjectTablesDatabaseToken } from '../get-default-user-db-token';
-import { getAdminTokenAndDatabaseId } from './get-admin-token-and-database';
+import { getAdminTablesContext } from './get-admin-token-and-database';
 
 const AUTO_INSTANCES_SHUTDOWN_TABLE_SEED = 'AUTOINSTANCESSHUTDOWN';
 
@@ -42,8 +42,8 @@ export const seedAutoInstancesShutdownTable = async (): Promise<void> => {
   );
 
   if (!table) {
-    const tokenAndDatabaseId = await getAdminTokenAndDatabaseId();
-    await createAutoInstancesShutdownTable(tokenAndDatabaseId);
+    const tablesContext = await getAdminTablesContext();
+    await createAutoInstancesShutdownTable(tablesContext);
   }
 
   await setTableSeedFlag();
diff --git a/packages/server/api/src/app/database/seeds/get-admin-token-and-database.ts b/packages/server/api/src/app/database/seeds/get-admin-token-and-database.ts
@@ -1,6 +1,7 @@
 import { AppSystemProp, system } from '@openops/server-shared';
 import { Project } from '@openops/shared';
 import { authenticateAdminUserInOpenOpsTables } from '../../openops-tables/auth-admin-tables';
+import { TablesContext } from '../../openops-tables/template-tables/types';
 import { projectService } from '../../project/project-service';
 import { userService } from '../../user/user-service';
 
@@ -24,10 +25,7 @@ const getAdminUserProject = async (): Promise<Project> => {
   return project;
 };
 
-export const getAdminTokenAndDatabaseId = async (): Promise<{
-  token: string;
-  tablesDatabaseId: number;
-}> => {
+export const getAdminTablesContext = async (): Promise<TablesContext> => {
   const { token } = await authenticateAdminUserInOpenOpsTables();
   const { tablesDatabaseId } = await getAdminUserProject();
   return { token, tablesDatabaseId };
diff --git a/packages/server/api/src/app/database/seeds/openops-aggregated-costs-seed.ts b/packages/server/api/src/app/database/seeds/openops-aggregated-costs-seed.ts
@@ -7,7 +7,7 @@ import {
 } from '../../openops-tables/template-tables/create-aggregated-costs-table';
 import { databaseConnection } from '../database-connection';
 import { getDefaultProjectTablesDatabaseToken } from '../get-default-user-db-token';
-import { getAdminTokenAndDatabaseId } from './get-admin-token-and-database';
+import { getAdminTablesContext } from './get-admin-token-and-database';
 
 const AGGREGATED_TABLE_SEED = 'AGGREGATEDCOSTS';
 
@@ -41,8 +41,8 @@ export const seedFocusDataAggregationTemplateTable =
     );
 
     if (!table) {
-      const tokenAndDatabaseId = await getAdminTokenAndDatabaseId();
-      await createAggregatedCostsTable(tokenAndDatabaseId);
+      const tablesContext = await getAdminTablesContext();
+      await createAggregatedCostsTable(tablesContext);
     }
 
     await setTableSeedFlag();
diff --git a/packages/server/api/src/app/database/seeds/openops-known-cost-types-by-application-seed.ts b/packages/server/api/src/app/database/seeds/openops-known-cost-types-by-application-seed.ts
@@ -7,7 +7,7 @@ import {
 } from '../../openops-tables/template-tables/create-known-cost-types-by-application-table';
 import { databaseConnection } from '../database-connection';
 import { getDefaultProjectTablesDatabaseToken } from '../get-default-user-db-token';
-import { getAdminTokenAndDatabaseId } from './get-admin-token-and-database';
+import { getAdminTablesContext } from './get-admin-token-and-database';
 
 const KNOWN_COST_TYPES_BY_APPLICATION = 'KNOWNCOSTTYPES';
 
@@ -42,8 +42,8 @@ export const seedKnownCostTypesByApplicationTable = async (): Promise<void> => {
   );
 
   if (!table) {
-    const tokenAndDatabaseId = await getAdminTokenAndDatabaseId();
-    await createKnownCostTypesByApplicationTable(tokenAndDatabaseId);
+    const tablesContext = await getAdminTablesContext();
+    await createKnownCostTypesByApplicationTable(tablesContext);
   }
 
   await setTableSeedFlag();
diff --git a/packages/server/api/src/app/database/seeds/openops-opportunities-table-seed.ts b/packages/server/api/src/app/database/seeds/openops-opportunities-table-seed.ts
@@ -7,7 +7,7 @@ import {
 } from '../../openops-tables/template-tables/create-opportunities-table';
 import { databaseConnection } from '../database-connection';
 import { getDefaultProjectTablesDatabaseToken } from '../get-default-user-db-token';
-import { getAdminTokenAndDatabaseId } from './get-admin-token-and-database';
+import { getAdminTablesContext } from './get-admin-token-and-database';
 
 const OPPORTUNITIES_TABLE_SEED = 'OPPORTUNITIESSEED';
 
@@ -42,8 +42,8 @@ export const seedOpportunitesTemplateTable = async (): Promise<void> => {
   );
 
   if (!table) {
-    const tokenAndDatabaseId = await getAdminTokenAndDatabaseId();
-    await createOpportunitiesTable(tokenAndDatabaseId);
+    const tablesContext = await getAdminTablesContext();
+    await createOpportunitiesTable(tablesContext);
   }
 
   await setTableSeedFlag();
diff --git a/packages/server/api/src/app/database/seeds/seed-template-tables.ts b/packages/server/api/src/app/database/seeds/seed-template-tables.ts
@@ -1,8 +1,8 @@
 import { logger } from '@openops/server-shared';
 import { FlagEntity } from '../../flags/flag.entity';
-import { seedTemplateTablesService } from '../../openops-tables/template-tables/seed-tables-for-templates';
+import { createBaseTemplateTables } from '../../openops-tables/template-tables/seed-tables-for-templates';
 import { databaseConnection } from '../database-connection';
-import { getAdminTokenAndDatabaseId } from './get-admin-token-and-database';
+import { getAdminTablesContext } from './get-admin-token-and-database';
 
 const TEMPLATE_TABLES_SEED = 'TEMPLATE_TABLES_SEED';
 
@@ -31,8 +31,8 @@ export const seedTemplateTables = async (): Promise<void> => {
     return;
   }
 
-  const tokenAndDatabaseId = await getAdminTokenAndDatabaseId();
-  await seedTemplateTablesService.createBaseTemplateTables(tokenAndDatabaseId);
+  const tablesContext = await getAdminTablesContext();
+  await createBaseTemplateTables(tablesContext);
 
   await setTableSeedFlag();
 };
diff --git a/packages/server/api/src/app/openops-tables/template-tables/create-aggregated-costs-table.ts b/packages/server/api/src/app/openops-tables/template-tables/create-aggregated-costs-table.ts
@@ -7,15 +7,15 @@ import {
 } from '@openops/common';
 import { logger } from '@openops/server-shared';
 import { openopsTables } from '../index';
-import { TokenAndDatabaseId } from './types';
+import { TablesContext } from './types';
 
 export const SEED_TABLE_NAME = 'Aggregated Costs';
 const SEED_LOG_HEADER = `[Seeding ${SEED_TABLE_NAME} table]`;
 
 export async function createAggregatedCostsTable({
   token,
   tablesDatabaseId,
-}: TokenAndDatabaseId): Promise<{ tableId: number }> {
+}: TablesContext): Promise<{ tableId: number }> {
   logger.debug(`${SEED_LOG_HEADER} Start`);
 
   const table = await openopsTables.createTable(
diff --git a/packages/server/api/src/app/openops-tables/template-tables/create-auto-instances-shutdown-table.ts b/packages/server/api/src/app/openops-tables/template-tables/create-auto-instances-shutdown-table.ts
@@ -7,15 +7,15 @@ import {
 } from '@openops/common';
 import { logger } from '@openops/server-shared';
 import { createTable } from '../create-table';
-import { TokenAndDatabaseId } from './types';
+import { TablesContext } from './types';
 
 export const SEED_OPENOPS_AUTO_INSTANCES_SHUTDOWN_TABLE_NAME =
   'Auto instances shutdown';
 
 export async function createAutoInstancesShutdownTable({
   token,
   tablesDatabaseId,
-}: TokenAndDatabaseId): Promise<void> {
+}: TablesContext): Promise<void> {
   logger.debug(
     `[Seeding ${SEED_OPENOPS_AUTO_INSTANCES_SHUTDOWN_TABLE_NAME} table] Start`,
   );
diff --git a/packages/server/api/src/app/openops-tables/template-tables/create-known-cost-types-by-application-table.ts b/packages/server/api/src/app/openops-tables/template-tables/create-known-cost-types-by-application-table.ts
@@ -8,15 +8,15 @@ import {
 } from '@openops/common';
 import { logger } from '@openops/server-shared';
 import { createTable } from '../create-table';
-import { TokenAndDatabaseId } from './types';
+import { TablesContext } from './types';
 
 export const SEED_OPENOPS_KNOWN_COST_TYPES_BY_APPLICATION_TABLE_NAME =
   'Known cost types by application';
 
 export async function createKnownCostTypesByApplicationTable({
   token,
   tablesDatabaseId,
-}: TokenAndDatabaseId) {
+}: TablesContext) {
   logger.debug(
     `[Seeding ${SEED_OPENOPS_KNOWN_COST_TYPES_BY_APPLICATION_TABLE_NAME} table] Start`,
   );
diff --git a/packages/server/api/src/app/openops-tables/template-tables/create-opportunities-table.ts b/packages/server/api/src/app/openops-tables/template-tables/create-opportunities-table.ts
@@ -8,14 +8,14 @@ import {
 } from '@openops/common';
 import { logger } from '@openops/server-shared';
 import { createTable } from '../create-table';
-import { TokenAndDatabaseId } from './types';
+import { TablesContext } from './types';
 
 export const SEED_OPENOPS_TABLE_NAME = 'Opportunities';
 
 export async function createOpportunitiesTable({
   token,
   tablesDatabaseId,
-}: TokenAndDatabaseId) {
+}: TablesContext) {
   logger.debug(`[Seeding ${SEED_OPENOPS_TABLE_NAME} table] Start`);
 
   const table = await createTable(
diff --git a/packages/server/api/src/app/openops-tables/template-tables/seed-tables-for-templates.ts b/packages/server/api/src/app/openops-tables/template-tables/seed-tables-for-templates.ts
@@ -3,22 +3,20 @@ import { createBusinessUnitsTable } from './create-business-units-table';
 import { createIdleEbsVolumesToDeleteTable } from './create-idle-ebs-volumes-to-delete-table';
 import { createResourceBuTagAssignmentTable } from './create-resource-bu-tag-assignment-table';
 import { createTagOwnerMappingTable } from './create-tag-owner-mapping-table';
-import { TokenAndDatabaseId } from './types';
+import { TablesContext } from './types';
 
-export const seedTemplateTablesService = {
-  async createBaseTemplateTables({
-    token,
+export async function createBaseTemplateTables({
+  token,
+  tablesDatabaseId,
+}: TablesContext): Promise<void> {
+  const buTable = await createBusinessUnitsTable(tablesDatabaseId, token);
+  await createTagOwnerMappingTable(tablesDatabaseId, token, buTable.tableId);
+  await createIdleEbsVolumesToDeleteTable(tablesDatabaseId, token);
+  await createResourceBuTagAssignmentTable(
     tablesDatabaseId,
-  }: TokenAndDatabaseId) {
-    const buTable = await createBusinessUnitsTable(tablesDatabaseId, token);
-    await createTagOwnerMappingTable(tablesDatabaseId, token, buTable.tableId);
-    await createIdleEbsVolumesToDeleteTable(tablesDatabaseId, token);
-    await createResourceBuTagAssignmentTable(
-      tablesDatabaseId,
-      token,
-      buTable.tableId,
-    );
+    token,
+    buTable.tableId,
+  );
 
-    logger.info('[Seeding template tables] Done');
-  },
-};
+  logger.info('[Seeding template tables] Done');
+}
diff --git a/packages/server/api/src/app/openops-tables/template-tables/types.ts b/packages/server/api/src/app/openops-tables/template-tables/types.ts
@@ -1,4 +1,4 @@
-export type TokenAndDatabaseId = {
+export type TablesContext = {
   token: string;
   tablesDatabaseId: number;
 };
diff --git a/packages/server/api/src/main.ts b/packages/server/api/src/main.ts
@@ -16,7 +16,7 @@ import { seedDevData } from './app/database/seeds/dev-seeds';
 import { seedFocusDataAggregationTemplateTable } from './app/database/seeds/openops-aggregated-costs-seed';
 import * as analytics from './app/database/seeds/openops-analytics-seed';
 import { deleteOldOpportunitiesTable } from './app/database/seeds/openops-delete-old-opportunities-table';
-import { seedKnownCostTypesByApplicationTable } from './app/database/seeds/openops-knonw-cost-types-by-application-seed';
+import { seedKnownCostTypesByApplicationTable } from './app/database/seeds/openops-known-cost-types-by-application-seed';
 import { seedOpportunitesTemplateTable } from './app/database/seeds/openops-opportunities-table-seed';
 import { updateOpenopsTablesDatabase } from './app/database/seeds/openops-tables-rename-database';
 import { upsertAdminUser } from './app/database/seeds/seed-admin';
