opt-in migration

Author: n1ru4l

integration-tests/docker-compose.integration.yaml

@@ -10,6 +10,10 @@ networks:
     name: hive
 
 services:
+  migrations:
+    environment:
+      CLICKHOUSE_OPERATIONS_V01_ROLLUPS: '1'
+
   local_cdn:
     image: node${NODE_VERSION_TAG}
     working_dir: /app

packages/migrations/.env.template

@@ -14,4 +14,6 @@ POSTGRES_USER=postgres
 POSTGRES_PASSWORD=postgres
 POSTGRES_HOST=localhost
 POSTGRES_PORT=5432
-POSTGRES_DB=registry
+POSTGRES_DB=registry
+
+CLICKHOUSE_OPERATIONS_V01_ROLLUPS=1

packages/migrations/src/clickhouse.ts

@@ -26,6 +26,7 @@ export type Action = (
 
 export async function migrateClickHouse(
   isClickHouseMigrator: boolean,
+  enableOperationsV01Rollups: boolean,
   isHiveCloud: boolean,
   hiveCloudEnvironment: 'prod' | 'staging' | 'dev' | null,
   clickhouse: {
@@ -197,6 +198,12 @@ export async function migrateClickHouse(
       return;
     }
 
+    // Keep the v01 rollup tables opt-in without recording the migration as completed.
+    if (index === 21 && !enableOperationsV01Rollups) {
+      console.log('   Skipping because CLICKHOUSE_OPERATIONS_V01_ROLLUPS_START is not set');
+      return;
+    }
+
     try {
       await action(
         async (query, settings) => {

packages/migrations/src/environment.ts

@@ -35,6 +35,9 @@ const EnvironmentModel = zod.object({
   RELEASE: emptyString(zod.string().optional()),
   MIGRATOR: emptyString(zod.string().optional()),
   CLICKHOUSE_MIGRATOR: emptyString(zod.string().optional()),
+  CLICKHOUSE_OPERATIONS_V01_ROLLUPS: emptyString(
+    zod.union([zod.literal('1'), zod.literal('0')]).optional(),
+  ),
   CLICKHOUSE_MIGRATOR_GRAPHQL_HIVE_CLOUD: zod
     .union([zod.literal('1'), zod.literal('0')])
     .optional(),
@@ -111,6 +114,7 @@ export const env = {
       : null,
   isMigrator: base.MIGRATOR === 'up',
   isClickHouseMigrator: base.CLICKHOUSE_MIGRATOR === 'up',
+  enableOperationsV01Rollups: base.CLICKHOUSE_OPERATIONS_V01_ROLLUPS === '1',
   isHiveCloud: base.CLICKHOUSE_MIGRATOR_GRAPHQL_HIVE_CLOUD === '1',
   hiveCloudEnvironment: base.GRAPHQL_HIVE_ENVIRONMENT ?? null,
 } as const;

packages/migrations/src/index.ts

@@ -48,6 +48,7 @@ try {
   if (env.clickhouse) {
     await migrateClickHouse(
       env.isClickHouseMigrator,
+      env.enableOperationsV01Rollups,
       env.isHiveCloud,
       env.hiveCloudEnvironment,
       env.clickhouse,