Add --db-image argument to wasp-app-runner

wasp-app-runner/README.md

@@ -48,17 +48,18 @@ npx @wasp.sh/wasp-app-runner dev
 ### Options
 
 ```
-npx run-wasp-app <mode> [--path-to-app <path>] [--wasp-cli-cmd <command>]
+npx run-wasp-app <mode> [--path-to-app <path>] [--wasp-cli-cmd <command>] [--db-image <image>]
 ```
 
 You must pass the `<mode>` as an argument, which can be either `dev` or `build`.
 
-| Option           | Description                                            | Example         |
-| ---------------- | ------------------------------------------------------ | --------------- |
-| `--path-to-app`  | Path to your Wasp application directory (default: ".") | `./my-wasp-app` |
-| `--wasp-cli-cmd` | Wasp CLI command (default: `wasp`)                     | `wasp-cli`      |
+| Option           | Description                                            | Example           |
+| ---------------- | ------------------------------------------------------ | ----------------- |
+| `--path-to-app`  | Path to your Wasp application directory (default: ".") | `./my-wasp-app`   |
+| `--wasp-cli-cmd` | Wasp CLI command (default: `wasp`)                     | `wasp-cli`        |
+| `--db-image`     | Custom PostgreSQL Docker image (default: `postgres`)   | `postgis/postgis` |
 
-## Postgres Configuration
+### Postgres Configuration
 
 Check the `./db/postgres.ts` file to see the Postgres configuration used.
 
@@ -68,6 +69,15 @@ If Postgres is used, the script automatically sets the `DATABASE_URL` env variab
 DATABASE_URL=postgresql://postgres:devpass@localhost:5432/postgres
 ```
 
+#### Custom database image
+
+You can override the Docker image used for Postgres via `--db-image`. If not provided, the default `postgres` is used.
+
+Examples: `--db-image postgres:15`, `--db-image pgvector/pgvector:pg16`, `--db-image postgis/postgis:14-3.2`.
+
+> [!NOTE]
+> The same requirements as in `wasp start db` apply for the Postgres image used. See [Wasp docs](../web/docs/data-model/databases.md#custom-database) for more details.
+
 ### Env variables
 
 When using the `dev` mode:
@@ -85,7 +95,7 @@ When developing, you can run the script directly from the local directory withou
 
 ```
 npm install
-npm run start -- <mode> [--path-to-app <path>] [--wasp-cli-cmd <command>]
+npm run start -- <mode> [--path-to-app <path>] [--wasp-cli-cmd <command>] [--db-image <image>]
 ```
 
 `npm run start` runs `npm run build` to build the TypeScript code and then runs the `./bin/index.js` script.

wasp-app-runner/src/args.ts

@@ -5,11 +5,13 @@ import { Branded } from "./types.js";
 export type Mode = "dev" | "build";
 export type PathToApp = Branded<string, "PathToApp">;
 export type WaspCliCmd = Branded<string, "WaspCliCmd">;
+export type DockerImageName = Branded<string, "DockerImageName">;
 
 export function parseArgs(): {
   mode: Mode;
   pathToApp: PathToApp;
   waspCliCmd: WaspCliCmd;
+  dbImage: DockerImageName;
 } {
   const parsedProgram = program
     .name("run-wasp-app")
@@ -22,6 +24,11 @@ export function parseArgs(): {
     )
     .option("--path-to-app <path>", "Path to the Wasp application", ".")
     .option("--wasp-cli-cmd <command>", "Wasp CLI command to use", "wasp")
+    .option(
+      "--db-image <image>",
+      "Custom PostgreSQL Docker image to use",
+      "postgres:16",
+    )
     .parse();
 
   const options = parsedProgram.opts();
@@ -31,5 +38,6 @@ export function parseArgs(): {
     mode,
     pathToApp: options.pathToApp as PathToApp,
     waspCliCmd: options.waspCliCmd as WaspCliCmd,
+    dbImage: options.dbImage as DockerImageName,
   };
 }

wasp-app-runner/src/build/index.ts

@@ -1,4 +1,4 @@
-import type { PathToApp, WaspCliCmd } from "../args.js";
+import type { DockerImageName, PathToApp, WaspCliCmd } from "../args.js";
 import { DbType, setupDb } from "../db/index.js";
 import { startLocalSmtpServer } from "../smtp.js";
 import { type AppName, waspBuild } from "../waspCli.js";
@@ -11,11 +11,13 @@ export async function startAppInBuildMode({
   pathToApp,
   appName,
   dbType,
+  dbImage,
 }: {
   waspCliCmd: WaspCliCmd;
   pathToApp: PathToApp;
   appName: AppName;
   dbType: DbType;
+  dbImage: DockerImageName;
 }) {
   await waspBuild({
     waspCliCmd,
@@ -26,6 +28,7 @@ export async function startAppInBuildMode({
     appName,
     dbType,
     pathToApp,
+    dbImage,
   });
 
   await startLocalSmtpServer();

wasp-app-runner/src/db/index.ts

@@ -1,8 +1,8 @@
-import type { PathToApp } from "../args.js";
+import type { DockerImageName, PathToApp } from "../args.js";
 import type { AppName } from "../waspCli.js";
 import { setupPostgres } from "./postgres.js";
 import { setupSqlite } from "./sqlite.js";
-import type { SetupDbFn } from "./types.js";
+import type { SetupDbResult } from "./types.js";
 
 export enum DbType {
   Sqlite = "sqlite",
@@ -13,16 +13,18 @@ export function setupDb({
   appName,
   dbType,
   pathToApp,
+  dbImage,
 }: {
   dbType: DbType;
   appName: AppName;
   pathToApp: PathToApp;
-}): ReturnType<SetupDbFn> {
+  dbImage: DockerImageName;
+}): Promise<SetupDbResult> {
   switch (dbType) {
     case DbType.Sqlite:
-      return setupSqlite({ appName, pathToApp });
+      return setupSqlite();
     case DbType.Postgres:
-      return setupPostgres({ appName, pathToApp });
+      return setupPostgres({ appName, pathToApp, dbImage });
     default:
       dbType satisfies never;
       throw new Error(`Unknown database type: ${dbType}`);

wasp-app-runner/src/db/postgres.ts

@@ -1,4 +1,4 @@
-import type { PathToApp } from "../args.js";
+import type { DockerImageName, PathToApp } from "../args.js";
 import {
   DbContainerName,
   createAppSpecificDbContainerName,
@@ -7,18 +7,27 @@ import { createLogger } from "../logging.js";
 import { spawnAndCollectOutput } from "../process.js";
 import { Branded } from "../types.js";
 import type { AppName } from "../waspCli.js";
-import type { SetupDbFn } from "./types.js";
+import type { SetupDbResult } from "./types.js";
 
 type DatabaseConnectionUrl = Branded<string, "DatabaseConnectionUrl">;
 
 const logger = createLogger("postgres");
 
-export const setupPostgres: SetupDbFn = async ({ appName, pathToApp }) => {
+export const setupPostgres = async ({
+  appName,
+  pathToApp,
+  dbImage,
+}: {
+  appName: AppName;
+  pathToApp: PathToApp;
+  dbImage: DockerImageName;
+}): Promise<SetupDbResult> => {
   await ensureDockerIsRunning();
 
   const databaseUrl = await startPostgresContainerForApp({
     appName,
     pathToApp,
+    dbImage,
   });
 
   logger.info(`Using DATABASE_URL: ${databaseUrl}`);
@@ -31,9 +40,11 @@ export const setupPostgres: SetupDbFn = async ({ appName, pathToApp }) => {
 async function startPostgresContainerForApp({
   appName,
   pathToApp,
+  dbImage,
 }: {
   appName: AppName;
   pathToApp: PathToApp;
+  dbImage: DockerImageName;
 }): Promise<DatabaseConnectionUrl> {
   const containerName = createAppSpecificDbContainerName({
     appName,
@@ -42,20 +53,22 @@ async function startPostgresContainerForApp({
 
   logger.info(`Using container name: ${containerName}`);
 
-  const databaseUrl =
-    await startPostgresContainerAndWaitUntilReady(containerName);
+  const databaseUrl = await startPostgresContainerAndWaitUntilReady(
+    containerName,
+    dbImage,
+  );
 
   return databaseUrl;
 }
 
 async function startPostgresContainerAndWaitUntilReady(
   containerName: DbContainerName,
+  dbImage: DockerImageName,
 ): Promise<DatabaseConnectionUrl> {
   const port = 5432;
   const password = "devpass";
-  const image = "postgres:16";
 
-  logger.info("Starting the PostgreSQL container...");
+  logger.info(`Starting the PostgreSQL container with image: ${dbImage}...`);
 
   spawnAndCollectOutput({
     name: "create-postgres-container",
@@ -69,7 +82,7 @@ async function startPostgresContainerAndWaitUntilReady(
       "-e",
       `POSTGRES_PASSWORD=${password}`,
       `--rm`,
-      image,
+      dbImage,
     ],
   })
     // If we awaited here, we would block the main thread indefinitely.

wasp-app-runner/src/db/sqlite.ts

@@ -1,6 +1,6 @@
-import type { SetupDbFn } from "./types.js";
+import type { SetupDbResult } from "./types.js";
 
-export const setupSqlite: SetupDbFn = async (_options) => {
+export const setupSqlite = async (): Promise<SetupDbResult> => {
   // No need to do anything special for SQLite, just return
   // an empty object for the env vars.
   return {

wasp-app-runner/src/db/types.ts

@@ -1,9 +1,5 @@
-import type { PathToApp } from "../args.js";
-import type { AppName } from "../waspCli.js";
-
-export type SetupDbFn = (options: {
-  appName: AppName;
-  pathToApp: PathToApp;
-}) => Promise<{
-  dbEnvVars: { [envVarName: string]: string };
-}>;
+export type SetupDbResult = {
+  dbEnvVars: {
+    [envVarName: string]: string;
+  };
+};

wasp-app-runner/src/dev/index.ts

@@ -1,4 +1,4 @@
-import type { PathToApp, WaspCliCmd } from "../args.js";
+import type { DockerImageName, PathToApp, WaspCliCmd } from "../args.js";
 import { DbType, setupDb } from "../db/index.js";
 import { type AppName, waspMigrateDb, waspStart } from "../waspCli.js";
 
@@ -7,16 +7,19 @@ export async function startAppInDevMode({
   pathToApp,
   appName,
   dbType,
+  dbImage,
 }: {
   waspCliCmd: WaspCliCmd;
   pathToApp: PathToApp;
   appName: AppName;
   dbType: DbType;
+  dbImage: DockerImageName;
 }): Promise<void> {
   const { dbEnvVars } = await setupDb({
     appName,
     dbType,
     pathToApp,
+    dbImage,
   });
 
   await waspMigrateDb({

wasp-app-runner/src/index.ts

@@ -1,5 +1,11 @@
 import { readdir } from "fs/promises";
-import { type Mode, parseArgs, PathToApp, WaspCliCmd } from "./args.js";
+import {
+  parseArgs,
+  type DockerImageName,
+  type Mode,
+  type PathToApp,
+  type WaspCliCmd,
+} from "./args.js";
 import { startAppInBuildMode } from "./build/index.js";
 import { checkDependencies } from "./dependencies.js";
 import { startAppInDevMode } from "./dev/index.js";
@@ -9,13 +15,14 @@ import { waspInfo, waspTsSetup } from "./waspCli.js";
 const logger = createLogger("main");
 
 export async function main(): Promise<void> {
-  const { mode, waspCliCmd, pathToApp } = parseArgs();
+  const { mode, waspCliCmd, pathToApp, dbImage } = parseArgs();
 
   try {
     await runWaspApp({
       mode,
       waspCliCmd,
       pathToApp,
+      dbImage,
     });
   } catch (error: unknown) {
     if (error instanceof Error) {
@@ -31,10 +38,12 @@ async function runWaspApp({
   mode,
   waspCliCmd,
   pathToApp,
+  dbImage,
 }: {
   mode: Mode;
   waspCliCmd: WaspCliCmd;
   pathToApp: PathToApp;
+  dbImage: DockerImageName;
 }): Promise<void> {
   await checkDependencies();
 
@@ -61,6 +70,7 @@ async function runWaspApp({
         pathToApp,
         appName,
         dbType,
+        dbImage,
       });
       break;
 
@@ -70,6 +80,7 @@ async function runWaspApp({
         pathToApp,
         appName,
         dbType,
+        dbImage,
       });
       break;