feat: add multi-tenant deployment support to nx-fly-deployment-action

Copilot · hakalb · hakalb · commit 3eeffa38d3f9 · 2025-11-22T17:22:54.000+01:00
Co-authored-by: hakalb &lt;16068945+hakalb@users.noreply.github.com&gt;
diff --git a/packages/nx-fly-deployment-action/action.yml b/packages/nx-fly-deployment-action/action.yml
@@ -35,6 +35,12 @@ inputs:
       The token to use for repository authentication.
       For example `GITHUB_TOKEN`.
     required: true
+  tenants:
+    description: >
+      A multiline string of tenant IDs to deploy for multi-tenant applications.
+      Each tenant ID should be on a new line.
+      If provided, each affected project will be deployed once per tenant with TENANT_ID env var set.
+      Defaults to an empty string (no multi-tenant deployment).
   opt-out-depot-builder:
     description: >
       Whether to opt out of the default depot builder.
diff --git a/packages/nx-fly-deployment-action/src/lib/__snapshots__/schemas.spec.ts.snap b/packages/nx-fly-deployment-action/src/lib/__snapshots__/schemas.spec.ts.snap
@@ -15,6 +15,7 @@ exports[`Fly Deployment Action schema validation > validates all schemas against
     "SECRET_KEY1=secret-value1",
     "SECRET_KEY2=secret-value2",
   ],
+  "tenants": [],
   "token": "github-token",
 }
 `;
@@ -60,6 +61,7 @@ exports[`Fly Deployment Action schema validation > validates all schemas against
     "SECRET_KEY1": "secret-value1",
     "SECRET_KEY2": "secret-value2",
   },
+  "tenants": [],
   "token": "github-token",
 }
 `;
diff --git a/packages/nx-fly-deployment-action/src/lib/fly-deployment.spec.ts b/packages/nx-fly-deployment-action/src/lib/fly-deployment.spec.ts
@@ -336,6 +336,7 @@ describe('flyDeployment', () => {
         mainBranch: '',
         optOutDepotBuilder: false,
         secrets: [],
+        tenants: [],
         token: 'token'
       },
       ...configOverride
@@ -384,6 +385,7 @@ describe('flyDeployment', () => {
         mainBranch: '',
         optOutDepotBuilder: false,
         secrets: [],
+        tenants: [],
         token: 'token'
       } satisfies ActionInputs);
 
@@ -1049,6 +1051,102 @@ describe('flyDeployment', () => {
         optOutDepotBuilder: true
       });
     });
+
+    it('should deploy apps to production with multiple tenants', async () => {
+      setContext('push-main-branch');
+      setupMocks();
+      const config = setupTest({
+        tenants: ['demo', 'customer1']
+      });
+      const result = await flyDeployment(config, true);
+
+      // Each project should be deployed once for each tenant
+      expect(getMockFly().deploy).toHaveBeenCalledTimes(4); // 2 projects * 2 tenants
+
+      // app-one for demo tenant
+      expect(getMockFly().deploy).toHaveBeenCalledWith({
+        app: 'app-one-config-demo',
+        config: '/apps/app-one/fly.toml',
+        env: {
+          APP_NAME: 'app-one-config-demo',
+          PR_NUMBER: '',
+          TENANT_ID: 'demo'
+        },
+        environment: 'production',
+        optOutDepotBuilder: false,
+        postgres: expect.any(String)
+      });
+
+      // app-one for customer1 tenant
+      expect(getMockFly().deploy).toHaveBeenCalledWith({
+        app: 'app-one-config-customer1',
+        config: '/apps/app-one/fly.toml',
+        env: {
+          APP_NAME: 'app-one-config-customer1',
+          PR_NUMBER: '',
+          TENANT_ID: 'customer1'
+        },
+        environment: 'production',
+        optOutDepotBuilder: false,
+        postgres: expect.any(String)
+      });
+
+      // app-two for demo tenant
+      expect(getMockFly().deploy).toHaveBeenCalledWith({
+        app: 'app-two-config-demo',
+        config: '/apps/app-two/src/fly.toml',
+        env: {
+          APP_NAME: 'app-two-config-demo',
+          PR_NUMBER: '',
+          TENANT_ID: 'demo'
+        },
+        environment: 'production',
+        optOutDepotBuilder: false
+      });
+
+      // app-two for customer1 tenant
+      expect(getMockFly().deploy).toHaveBeenCalledWith({
+        app: 'app-two-config-customer1',
+        config: '/apps/app-two/src/fly.toml',
+        env: {
+          APP_NAME: 'app-two-config-customer1',
+          PR_NUMBER: '',
+          TENANT_ID: 'customer1'
+        },
+        environment: 'production',
+        optOutDepotBuilder: false
+      });
+
+      expect(result).toEqual({
+        environment: 'production',
+        projects: [
+          {
+            action: 'deploy',
+            app: 'app-one-config-demo',
+            name: 'app-one (demo)',
+            url: 'https://app-one-config-demo.fly.dev'
+          },
+          {
+            action: 'deploy',
+            app: 'app-one-config-customer1',
+            name: 'app-one (customer1)',
+            url: 'https://app-one-config-customer1.fly.dev'
+          },
+          {
+            action: 'deploy',
+            app: 'app-two-config-demo',
+            name: 'app-two (demo)',
+            url: 'https://app-two-config-demo.fly.dev'
+          },
+          {
+            action: 'deploy',
+            app: 'app-two-config-customer1',
+            name: 'app-two (customer1)',
+            url: 'https://app-two-config-customer1.fly.dev'
+          }
+        ]
+      } satisfies ActionOutputs);
+    });
   });
 
   describe('error handling', () => {
diff --git a/packages/nx-fly-deployment-action/src/lib/main.spec.ts b/packages/nx-fly-deployment-action/src/lib/main.spec.ts
@@ -59,6 +59,7 @@ describe('main', () => {
       mainBranch: 'main-branch',
       optOutDepotBuilder: true,
       secrets: [],
+      tenants: [],
       token: 'token'
     } satisfies ActionInputs);
     expect(runMock).toHaveReturned();
@@ -83,6 +84,7 @@ describe('main', () => {
       mainBranch: '',
       optOutDepotBuilder: true,
       secrets: [],
+      tenants: [],
       token: 'token'
     } satisfies ActionInputs);
     expect(runMock).toHaveReturned();
diff --git a/packages/nx-fly-deployment-action/src/lib/main.ts b/packages/nx-fly-deployment-action/src/lib/main.ts
@@ -19,6 +19,7 @@ export async function run(): Promise<void> {
       mainBranch: core.getInput('main-branch'),
       optOutDepotBuilder: core.getBooleanInput('opt-out-depot-builder'),
       secrets: core.getMultilineInput('secrets'),
+      tenants: core.getMultilineInput('tenants'),
       token: core.getInput('token', { required: true })
     } satisfies ActionInputs);
 
diff --git a/packages/nx-fly-deployment-action/src/lib/schemas/__fixtures__/action-inputs.json b/packages/nx-fly-deployment-action/src/lib/schemas/__fixtures__/action-inputs.json
@@ -7,5 +7,6 @@
   "postgresPreview": "db-app",
   "env": ["ENV_KEY1=env-value1", "ENV_KEY2=env-value2"],
   "secrets": ["SECRET_KEY1=secret-value1", "SECRET_KEY2=secret-value2"],
+  "tenants": [],
   "token": "github-token"
 }
diff --git a/packages/nx-fly-deployment-action/src/lib/schemas/__fixtures__/deployment-config.json b/packages/nx-fly-deployment-action/src/lib/schemas/__fixtures__/deployment-config.json
@@ -11,5 +11,6 @@
     "SECRET_KEY1": "secret-value1",
     "SECRET_KEY2": "secret-value2"
   },
+  "tenants": [],
   "token": "github-token"
 }
diff --git a/packages/nx-fly-deployment-action/src/lib/schemas/action-inputs.schema.ts b/packages/nx-fly-deployment-action/src/lib/schemas/action-inputs.schema.ts
@@ -8,6 +8,7 @@ export const ActionInputsSchema = z.object({
   mainBranch: z.string(),
   optOutDepotBuilder: z.boolean(),
   secrets: z.array(z.string()),
+  tenants: z.array(z.string()),
   token: z.string().min(1, 'A GitHub token is required')
 });
 
diff --git a/packages/nx-fly-deployment-action/src/lib/schemas/deployment-config.schema.ts b/packages/nx-fly-deployment-action/src/lib/schemas/deployment-config.schema.ts
@@ -12,6 +12,7 @@ export const DeploymentConfigSchema = z.object({
   }),
   mainBranch: z.string().min(1, 'main branch is required'),
   secrets: z.record(z.string(), z.string()).optional(),
+  tenants: z.array(z.string()),
   token: ActionInputsSchema.shape.token
 });
 
diff --git a/packages/nx-fly-deployment-action/src/lib/utils/get-deployment-config.ts b/packages/nx-fly-deployment-action/src/lib/utils/get-deployment-config.ts
@@ -43,6 +43,7 @@ export const getDeploymentConfig = async (
     mainBranch: mainBranchInput,
     optOutDepotBuilder,
     secrets: secretsInput,
+    tenants,
     token
   } = inputs;
 
@@ -66,6 +67,7 @@ export const getDeploymentConfig = async (
     },
     mainBranch,
     secrets,
+    tenants,
     token
   };
   core.info(JSON.stringify(config, null, 2));
diff --git a/packages/nx-fly-deployment-action/src/lib/utils/get-tenant-app-name.ts b/packages/nx-fly-deployment-action/src/lib/utils/get-tenant-app-name.ts
@@ -0,0 +1,12 @@
+/**
+ * Get the name of the app for a given base app name and tenant ID
+ *
+ * Pattern: `<base-app-name>-<tenant-id>`
+ *
+ * @param baseAppName - The base name of the app from fly.toml
+ * @param tenantId - The tenant ID
+ * @returns The name of the tenant-specific app
+ */
+export const getTenantAppName = (baseAppName: string, tenantId: string) => {
+  return `${baseAppName}-${tenantId}`;
+};
diff --git a/packages/nx-fly-deployment-action/src/lib/utils/run-deploy-apps.ts b/packages/nx-fly-deployment-action/src/lib/utils/run-deploy-apps.ts
@@ -11,6 +11,7 @@ import { addOpinionatedEnv } from './add-opinionated-env';
 import { getDeployableProjects } from './get-deployable-projects';
 import { getPreviewAppName } from './get-preview-app-name';
 import { getProjectConfiguration } from './get-project-configuration';
+import { getTenantAppName } from './get-tenant-app-name';
 import { lookupGitHubConfigFile } from './lookup-github-config-file';
 
 /**
@@ -119,58 +120,80 @@ export const runDeployApps = async (options: {
     // Requirements are met, ready to deploy
     core.info(`[${projectName}] Ready to fly >>>`);
 
-    // Get app name
-    const appName =
-      environment === 'preview'
-        ? getPreviewAppName(configAppName, pullRequest ?? 0)
-        : configAppName;
-
-    // Add environment variables
-    const env = addOpinionatedEnv(
-      { appName, prNumber: pullRequest },
-      config.env
-    );
-
-    // Get postgres connection string
-    const postgres =
-      environment === 'preview'
-        ? githubConfig.flyPostgresPreview
-        : githubConfig.flyPostgresProduction;
-
-    core.info(
-      `[${projectName}] Deploy app '${appName}' to '${environment}'...`
-    );
-
-    // Deploy app
-    try {
-      const result = await fly.deploy({
-        app: appName,
-        config: resolvedFlyConfig,
-        env,
-        environment,
-        optOutDepotBuilder: config.fly.optOutDepotBuilder,
-        postgres: postgres || undefined, // rather undefined than empty string
-        secrets: config.secrets
-      });
+    // Determine which tenants to deploy for
+    // If no tenants provided, deploy once without tenant suffix
+    const tenantsToDeployFor = config.tenants.length > 0 ? config.tenants : [''];
+
+    // Deploy once for each tenant
+    for (const tenantId of tenantsToDeployFor) {
+      const tenantLabel = tenantId ? ` for tenant '${tenantId}'` : '';
+      core.info(`[${projectName}] Deploying${tenantLabel}...`);
+
+      // Get app name with tenant suffix
+      let appName: string;
+      if (environment === 'preview') {
+        appName = getPreviewAppName(configAppName, pullRequest ?? 0);
+        // Add tenant suffix for preview if tenant specified
+        if (tenantId) {
+          appName = getTenantAppName(appName, tenantId);
+        }
+      } else {
+        // For production, add tenant suffix if tenant specified
+        appName = tenantId ? getTenantAppName(configAppName, tenantId) : configAppName;
+      }
+
+      // Add environment variables
+      const envVars = addOpinionatedEnv(
+        { appName, prNumber: pullRequest },
+        config.env
+      );
 
-      core.info(`[${projectName}] 🚀 Deployed to '${result.url}'`);
+      // Add TENANT_ID environment variable if tenant is specified
+      if (tenantId) {
+        envVars['TENANT_ID'] = tenantId;
+      }
 
-      projects.push({
-        action: 'deploy',
-        app: result.app,
-        name: projectName,
-        url: result.url
-      });
-    } catch (error) {
-      const msg = error instanceof Error ? error.message : String(error);
+      // Get postgres connection string
+      const postgres =
+        environment === 'preview'
+          ? githubConfig.flyPostgresPreview
+          : githubConfig.flyPostgresProduction;
 
-      core.warning(`[${projectName}] ❌ Failed to deploy project: ${msg}`);
+      core.info(
+        `[${projectName}] Deploy app '${appName}' to '${environment}'${tenantLabel}...`
+      );
 
-      projects.push({
-        appOrProject: projectName,
-        action: 'skip',
-        reason: 'Failed to deploy project'
-      });
+      // Deploy app
+      try {
+        const result = await fly.deploy({
+          app: appName,
+          config: resolvedFlyConfig,
+          env: envVars,
+          environment,
+          optOutDepotBuilder: config.fly.optOutDepotBuilder,
+          postgres: postgres || undefined, // rather undefined than empty string
+          secrets: config.secrets
+        });
+
+        core.info(`[${projectName}] 🚀 Deployed to '${result.url}'${tenantLabel}`);
+
+        projects.push({
+          action: 'deploy',
+          app: result.app,
+          name: tenantId ? `${projectName} (${tenantId})` : projectName,
+          url: result.url
+        });
+      } catch (error) {
+        const msg = error instanceof Error ? error.message : String(error);
+
+        core.warning(`[${projectName}] ❌ Failed to deploy project${tenantLabel}: ${msg}`);
+
+        projects.push({
+          appOrProject: tenantId ? `${projectName} (${tenantId})` : projectName,
+          action: 'skip',
+          reason: `Failed to deploy project${tenantLabel}`
+        });
+      }
     }
   }
 

Original file line number	Diff line number	Diff line change
`@@ -7,5 +7,6 @@`
`7`	`7`	`"postgresPreview": "db-app",`
`8`	`8`	`"env": ["ENV_KEY1=env-value1", "ENV_KEY2=env-value2"],`
`9`	`9`	`"secrets": ["SECRET_KEY1=secret-value1", "SECRET_KEY2=secret-value2"],`
	`10`	`+ "tenants": [],`
`10`	`11`	`"token": "github-token"`
`11`	`12`	`}`
Original file line number	Diff line number	Diff line change
`@@ -11,5 +11,6 @@`
`11`	`11`	`"SECRET_KEY1": "secret-value1",`
`12`	`12`	`"SECRET_KEY2": "secret-value2"`
`13`	`13`	`},`
	`14`	`+ "tenants": [],`
`14`	`15`	`"token": "github-token"`
`15`	`16`	`}`