Add --db-image argument to wasp deploy railway

waspc/ChangeLog.md

@@ -5,6 +5,7 @@
 ### 🎉 New Features
 
 - You can now specify which PostgreSQL image to use in `wasp start db` with the `--db-image` argument. ([#3182](https://github.com/wasp-lang/wasp/pull/3182))
+- You can now specify which PostgreSQL image to use in `wasp deploy railway` with the `--db-image` argument. ([#3184](https://github.com/wasp-lang/wasp/pull/3184))
 
 ### 🐞 Bug fixes
 

waspc/packages/deploy/src/providers/railway/commands/deploy/DeployCmdOptions.ts

@@ -4,5 +4,5 @@ import { CommonCmdOptions } from "../../DeploymentInstructions.js";
 export interface DeployCmdOptions extends CommonCmdOptions {
   skipClient?: boolean;
   skipServer?: boolean;
-  existingProjectId: RailwayProjectId | null;
+  existingProjectId?: RailwayProjectId;
 }

waspc/packages/deploy/src/providers/railway/commands/deploy/index.ts

@@ -62,7 +62,7 @@ async function ensureRailwayProjectForDirectory({
   railwayExe: RailwayCliExe;
   projectName: RailwayProjectName;
   waspProjectDir: WaspProjectDir;
-  existingProjectId: RailwayProjectId | null;
+  existingProjectId?: RailwayProjectId;
 }): Promise<RailwayProject> {
   const { status, project } = await getRailwayProjectStatus({
     projectName,

waspc/packages/deploy/src/providers/railway/commands/setup/SetupCmdOptions.ts

@@ -5,6 +5,7 @@ import {
 } from "../../DeploymentInstructions.js";
 
 export interface SetupCmdOptions extends CommonCmdOptions, SecretsOptions {
-  existingProjectId: RailwayProjectId | null;
-  workspace: string | null;
+  existingProjectId?: RailwayProjectId;
+  workspace?: string;
+  dbImage?: string;
 }

waspc/packages/deploy/src/providers/railway/commands/setup/setup.ts

@@ -81,8 +81,8 @@ async function setupRailwayProjectForDirectory({
   railwayExe: RailwayCliExe;
   projectName: RailwayProjectName;
   waspProjectDir: WaspProjectDir;
-  existingProjectId: RailwayProjectId | null;
-  workspace: string | null;
+  existingProjectId?: RailwayProjectId;
+  workspace?: string;
 }): Promise<RailwayProject> {
   const { status, project } = await getRailwayProjectStatus({
     projectName,
@@ -122,14 +122,40 @@ async function setupRailwayProjectForDirectory({
 
 async function setupDb({
   cmdOptions: options,
+  dbServiceName,
 }: DeploymentInstructions<SetupCmdOptions>): Promise<void> {
   waspSays("Setting up database");
 
   const railwayCli = createCommandWithCwd(
     options.railwayExe,
     options.waspProjectDir,
   );
-  await railwayCli(["add", "-d", "postgres"]);
+
+  if (options.dbImage) {
+    waspSays(`Using custom database image: ${options.dbImage}`);
+    // When using a custom database image, Railway doesn't automatically set the default
+    // Postgres-related environment variables, so we need to set them ourselves.
+    await railwayCli([
+      "add",
+      ...["--service", dbServiceName],
+      ...["--image", options.dbImage],
+      ...["--variables", "POSTGRES_DB=railway"],
+      ...["--variables", "POSTGRES_USER=postgres"],
+      ...[
+        "--variables",
+        `POSTGRES_PASSWORD=${getRailwayEnvVarValueReference("secret()")}`,
+      ],
+      ...["--variables", "PORT=5432"],
+      ...["--variables", "PGDATA=/var/lib/postgresql/data/pgdata"],
+      ...[
+        "--variables",
+        `DATABASE_URL=postgresql://${getRailwayEnvVarValueReference("POSTGRES_USER")}:${getRailwayEnvVarValueReference("POSTGRES_PASSWORD")}@${getRailwayEnvVarValueReference("RAILWAY_PRIVATE_DOMAIN")}:${getRailwayEnvVarValueReference("PORT")}/${getRailwayEnvVarValueReference("POSTGRES_DB")}`,
+      ],
+    ]);
+  } else {
+    // Use the default Railway Postgres template.
+    await railwayCli(["add", "-d", "postgres"]);
+  }
 }
 
 async function setupServer({

waspc/packages/deploy/src/providers/railway/index.ts

@@ -111,6 +111,10 @@ function makeRailwaySetupCommand(): Command {
       "--workspace [workspace]",
       "the Railway workspace to use if a new project needs to be created (if not provided, will ask interactively)",
     )
+    .option(
+      "--db-image <dbImage>",
+      "custom Docker image for the PostgreSQL database",
+    )
     .action(setupFn);
 }
 
@@ -140,5 +144,9 @@ function makeRailwayLaunchCommand(): Command {
       "--workspace [workspace]",
       "the Railway workspace to use if a new project needs to be created (if not provided, will ask interactively)",
     )
+    .option(
+      "--db-image <dbImage>",
+      "custom Docker image for the PostgreSQL database",
+    )
     .action(launchFn);
 }

waspc/packages/deploy/src/providers/railway/railwayProject/cli.ts

@@ -24,7 +24,7 @@ export async function initRailwayProject({
   projectName: RailwayProjectName;
   railwayExe: RailwayCliExe;
   waspProjectDir: WaspProjectDir;
-  workspace: string | null;
+  workspace?: string;
 }): Promise<RailwayProject> {
   const railwayCli = createCommandWithCwd(railwayExe, waspProjectDir);
 

waspc/packages/deploy/src/providers/railway/railwayProject/index.ts

@@ -24,7 +24,7 @@ export async function getRailwayProjectStatus({
   existingProjectId,
 }: {
   projectName: RailwayProjectName;
-  existingProjectId: RailwayProjectId | null;
+  existingProjectId?: RailwayProjectId;
   waspProjectDir: WaspProjectDir;
   railwayExe: RailwayCliExe;
 }): Promise<

web/docs/deployment/deployment-methods/wasp-deploy/_railway-custom-postgres-option.md

@@ -0,0 +1,23 @@
+import CodeBlock from '@theme/CodeBlock'
+
+#### Using a custom PostgreSQL database
+
+By default, Wasp uses the standard PostgreSQL image provided by Railway when creating a new database for your app. However, if your application requires specific PostgreSQL extensions (e.g., PostGIS), you can specify a Docker image with a custom PostgreSQL installation, with the `--db-image <docker-image>` flag.
+
+:::tip
+You only need to specify the Docker image once, when first creating the app.
+:::
+
+<CodeBlock language="shell">{
+`# Use PostGIS:
+wasp deploy railway ${props.command} my-wasp-app --db-image postgis/postgis
+`
+}</CodeBlock>
+
+<CodeBlock language="shell">{
+`# Use pgvector:
+wasp deploy railway ${props.command} my-wasp-app --db-image pgvector/pgvector:pg16
+`
+}</CodeBlock>
+
+The service name will always be `Postgres`, regardless of the image used.

web/docs/deployment/deployment-methods/wasp-deploy/railway.md

@@ -5,6 +5,7 @@ title-llm: Automated Deployment to Railway with Wasp CLI
 
 import { Required } from '@site/src/components/Tag';
 import LaunchCommandEnvVars from './\_launch-command-env-vars.md'
+import CustomPostgresOption from './\_railway-custom-postgres-option.md'
 
 [Railway](https://railway.com/?utm_medium=integration&utm_source=docs&utm_campaign=wasp) is a cloud development platform that streamlines building and deploying applications with built-in support for databases and services. It offers an intuitive interface and automates infrastructure.
 
@@ -39,7 +40,7 @@ The project name is used as a base for your server and client service names on R
 - `my-wasp-app-client`
 - `my-wasp-app-server`
 
-Railway doesn't allow setting the database service name using the Railway CLI. It will always be named `Postgres`.
+Railway doesn't allow setting the database service name using the Railway CLI. It will always be named `Postgres`. This also applies when using the `--db-image` flag.
 
 <LaunchCommandEnvVars />
 
@@ -94,6 +95,8 @@ wasp deploy railway setup <project-name>
 wasp deploy railway deploy <project-name>
 ```
 
+<CustomPostgresOption command="launch" />
+
 #### Explicitly providing the Railway project ID
 
 By default, Wasp CLI tries to create a new Railway project named `<project-name>`. If you want to use an existing Railway project, pass its ID with `--existing-project-id` option:
@@ -192,6 +195,8 @@ The project name is used as a base for your server and client service names on R
 
 Railway also creates a PostgreSQL database service named `Postgres`.
 
+<CustomPostgresOption command="setup" />
+
 #### Explicitly providing the Railway project ID
 
 By default, Wasp CLI tries to create a new Railway project named `<project-name>`. If you want to use an existing Railway project, pass its ID with `--existing-project-id` option: