From a665b918a9f9515691414b67cfee78924b2bd63b Mon Sep 17 00:00:00 2001 From: Mihovil Ilakovac Date: Mon, 5 Oct 2026 17:05:22 +0200 Subject: [PATCH 01/27] Start managed PostgreSQL with foreground Wasp commands --- waspc/cli/exe/Main.hs | 27 +- waspc/cli/src/Wasp/Cli/Command/Db.hs | 17 +- waspc/cli/src/Wasp/Cli/Command/Start.hs | 7 +- .../Wasp/Cli/Command/Start/ArgumentsParser.hs | 34 +- waspc/cli/src/Wasp/Cli/Command/Start/Db.hs | 329 +++++++++++------- waspc/cli/tests/DbMigrateTest.hs | 31 ++ waspc/e2e-tests/Tests/WaspDbStartTest.hs | 81 +++-- waspc/src/Wasp/Project/Db/Dev/Postgres.hs | 93 +++-- waspc/waspc.cabal | 2 + 9 files changed, 427 insertions(+), 194 deletions(-) create mode 100644 waspc/cli/tests/DbMigrateTest.hs diff --git a/waspc/cli/exe/Main.hs b/waspc/cli/exe/Main.hs index 82466493d62..ab3d23b41b4 100644 --- a/waspc/cli/exe/Main.hs +++ b/waspc/cli/exe/Main.hs @@ -20,6 +20,7 @@ import Wasp.Cli.Command.Clean (clean) import Wasp.Cli.Command.Compile (compileCommand) import Wasp.Cli.Command.CreateNewProject (createNewProject) import Wasp.Cli.Command.CreateNewProject.AvailableTemplates (availableStarterTemplates) +import Wasp.Cli.Command.Db (runCommandThatRequiresDbRunning) import qualified Wasp.Cli.Command.Db.Migrate as Command.Db.Migrate import qualified Wasp.Cli.Command.Db.Reset as Command.Db.Reset import qualified Wasp.Cli.Command.Db.Seed as Command.Db.Seed @@ -38,7 +39,7 @@ import qualified Wasp.Cli.Command.Telemetry as Telemetry import Wasp.Cli.Command.Test (test) import Wasp.Cli.Command.Uninstall (uninstall) import Wasp.Cli.Terminal (title) -import Wasp.Cli.Util.Parser (ArgsParser (..), withArguments) +import Wasp.Cli.Util.Parser (ArgsParser (..)) import Wasp.Util (indent) import Wasp.Util.InstallMethod (getInstallationCommand) import qualified Wasp.Util.Terminal as Term @@ -151,7 +152,7 @@ printUsage = cmd " completion Prints help on bash completion.", cmd " uninstall [--force] Removes Wasp from your system.", title " IN PROJECT", - cmd " start [--client-port ] [--server-port ] [--client-url ] [--server-url ]", + cmd " start [--client-port ] [--server-port ] [--client-url ] [--server-url ] [--db-port ] [--db-image ] [--db-volume-mount-path ]", " Runs Wasp app in development mode, watching for file changes.", " Optionally specify the ports the client and the server run on.", " If not specified, Wasp picks the first free port when the default one is taken.", @@ -210,10 +211,10 @@ dbCli args = case args of -- These commands don't require an existing and running database. "start" : optionalStartArgs -> runCommand $ Command.Start.Db.start optionalStartArgs -- These commands require an existing and running database. - "reset" : resetArgs -> runCommand $ withArguments Command.Db.Reset.resetArgsParser Command.Db.Reset.reset resetArgs - "migrate-dev" : optionalMigrateArgs -> runCommand $ withArguments Command.Db.Migrate.migrateArgsParser Command.Db.Migrate.migrateDev optionalMigrateArgs - "seed" : seedArgs -> runCommand $ withArguments Command.Db.Seed.seedArgsParser Command.Db.Seed.seed seedArgs - "studio" : studioArgs -> runCommand $ withArguments (ArgsParser "wasp db studio" (pure ())) (const Command.Db.Studio.studio) studioArgs + "reset" : resetArgs -> runCommandThatRequiresDbRunning Command.Db.Reset.resetArgsParser Command.Db.Reset.reset resetArgs + "migrate-dev" : optionalMigrateArgs -> runCommandThatRequiresDbRunning Command.Db.Migrate.migrateArgsParser Command.Db.Migrate.migrateDev optionalMigrateArgs + "seed" : seedArgs -> runCommandThatRequiresDbRunning Command.Db.Seed.seedArgsParser Command.Db.Seed.seed seedArgs + "studio" : studioArgs -> runCommandThatRequiresDbRunning (ArgsParser "wasp db studio" (pure ())) (const Command.Db.Studio.studio) studioArgs _unknownDbCommand -> printDbUsage >> exitFailure {- ORMOLU_DISABLE -} @@ -228,7 +229,7 @@ printDbUsage = cmd $ intercalate "\n" [ " start [--db-port ] [--db-image ] [--db-volume-mount-path ]", " Alias for `wasp start db`.", - " Starts managed development database for you.", + " Runs a development database and streams its logs until Ctrl+C.", " Optionally specify a custom port, Docker image, or Docker volume mount path.", " If the port is not specified, Wasp picks the first free port when the default one is taken." ], @@ -243,10 +244,20 @@ printDbUsage = " supplied migration name or asking for one.", " OPTIONS:", " --name [migration-name]", - " --create-only" + " --create-only", + " --db-port ", + " --db-image ", + " --db-volume-mount-path " ], cmd " studio GUI for inspecting your database.", "", + title "DATABASE OPTIONS", + " --db-port Host port when starting managed PostgreSQL.", + " --db-image Docker image when starting managed PostgreSQL.", + " --db-volume-mount-path ", + " Data path inside a new PostgreSQL container.", + " These options also work with reset, seed, migrate-dev, and studio.", + "", title "EXAMPLES", " wasp db migrate-dev", " wasp db migrate-dev --name \"Added User entity\"", diff --git a/waspc/cli/src/Wasp/Cli/Command/Db.hs b/waspc/cli/src/Wasp/Cli/Command/Db.hs index e34eb3eda53..5201fcf7059 100644 --- a/waspc/cli/src/Wasp/Cli/Command/Db.hs +++ b/waspc/cli/src/Wasp/Cli/Command/Db.hs @@ -1,17 +1,30 @@ module Wasp.Cli.Command.Db - ( makeDbCommand, + ( runCommandThatRequiresDbRunning, + makeDbCommand, ) where import qualified Wasp.AppSpec as AS -import Wasp.Cli.Command (Command, require) +import Wasp.Cli.Command (Command, require, runCommand) +import Wasp.Cli.Command.Call (Arguments) import Wasp.Cli.Command.Compile (defaultCompileOptions, withSetupGoals) import Wasp.Cli.Command.Require.DbConnectionEstablished (DbConnectionEstablished (DbConnectionEstablished)) import Wasp.Cli.Command.Require.InWaspProject (InWaspProject (InWaspProject)) import Wasp.Cli.Command.Require.WaspSpecAvailable (WaspSpecAvailable (WaspSpecAvailable)) +import Wasp.Cli.Command.Start.ArgumentsParser (startDbArgsParser) +import qualified Wasp.Cli.Command.Start.Db as Start.Db import Wasp.Cli.Compile (waitEnsureCompile) +import Wasp.Cli.Util.Parser (ArgsParser (..), withArguments) import Wasp.Generator.Setup (SetupGoal) +runCommandThatRequiresDbRunning :: ArgsParser a -> (a -> Command ()) -> Arguments -> IO () +runCommandThatRequiresDbRunning parser command args = + runCommand $ withArguments databaseArgsParser run args + where + databaseArgsParser = parser {optParser = (,) <$> startDbArgsParser <*> parser.optParser} + run (dbArgs, commandArgs) = + Start.Db.withManagedDb dbArgs $ \_ -> command commandArgs + -- | Prepares what a db command needs before it runs: a compile, -- post-compile setup, and a reachable database. -- diff --git a/waspc/cli/src/Wasp/Cli/Command/Start.hs b/waspc/cli/src/Wasp/Cli/Command/Start.hs index 87d89420add..f011941d2bc 100644 --- a/waspc/cli/src/Wasp/Cli/Command/Start.hs +++ b/waspc/cli/src/Wasp/Cli/Command/Start.hs @@ -21,6 +21,7 @@ import Wasp.Cli.Command.News (fetchAndListMustSeeNewsIfDue) import Wasp.Cli.Command.Require.DbConnectionEstablished (DbConnectionEstablished (DbConnectionEstablished)) import Wasp.Cli.Command.Require.InWaspProject (InWaspProject (InWaspProject)) import Wasp.Cli.Command.Start.ArgumentsParser (StartArgs (..), startArgsParser) +import qualified Wasp.Cli.Command.Start.Db as Start.Db import Wasp.Cli.Command.Watch (watch) import Wasp.Cli.EnvVarWithCtx (addEnvVarsUniqueC) import qualified Wasp.Cli.EnvVarWithCtx as EnvVarWithCtx @@ -33,13 +34,14 @@ import Wasp.Generator.WebAppGenerator.RunConfig (WebAppRunConfig) import qualified Wasp.Message as Msg import Wasp.Project (CompileError, CompileWarning) import Wasp.Project.Common (WaspProjectDir, findFileInWaspProjectDir, generatedAppDirInWaspProjectDir) +import qualified Wasp.Project.Db.Dev.Postgres as Dev.Postgres import qualified Wasp.Project.Env as Env -- | Does initial compile of wasp code and then runs the generated project. -- It also listens for any file changes and recompiles and restarts generated project accordingly. start :: Arguments -> Command () start = withArguments startArgsParser $ \args -> - ProjectLock.acquireWatcher $ \projectLock -> do + ProjectLock.acquireWatcher $ \projectLock -> Start.Db.withManagedDb args.dbArgs $ \managedDb -> do -- We check for the news only in `wasp start`, and only periodically, -- to avoid being too aggressive. Specifically: -- - We don't run it in other `wasp` commands because we don't want to @@ -66,7 +68,8 @@ start = withArguments startArgsParser $ \args -> cliSendMessageC $ Msg.Start "Listening for file changes..." cliSendMessageC $ Msg.Start "Starting up generated project..." - cliSendMessageC $ Msg.Info $ showRunConfigUrls runConfigs + let databaseUrlLine = maybe "" (\db -> " ℹ Database: " <> Dev.Postgres.getDevConnectionUrl db <> "\n") managedDb + cliSendMessageC $ Msg.Info $ showRunConfigUrls runConfigs <> databaseUrlLine watchOrStartResult <- liftIO $ do -- This MVar is used to exchange information between the two processes below running in diff --git a/waspc/cli/src/Wasp/Cli/Command/Start/ArgumentsParser.hs b/waspc/cli/src/Wasp/Cli/Command/Start/ArgumentsParser.hs index 8482db6206e..34ce57218a0 100644 --- a/waspc/cli/src/Wasp/Cli/Command/Start/ArgumentsParser.hs +++ b/waspc/cli/src/Wasp/Cli/Command/Start/ArgumentsParser.hs @@ -1,6 +1,8 @@ module Wasp.Cli.Command.Start.ArgumentsParser ( StartArgs (..), startArgsParser, + StartDbArgs (..), + startDbArgsParser, ) where @@ -10,12 +12,15 @@ import qualified Options.Applicative as Opt import Wasp.Cli.Util.HttpUrlArgument (httpUrlParser) import Wasp.Cli.Util.Parser (ArgsParser (..)) import Wasp.Cli.Util.PortArgument (portParser) +import Wasp.Db.Postgres (defaultPostgresPort) +import Wasp.Util.Docker (DockerImageName, DockerVolumeMountPath) data StartArgs = StartArgs { clientPort :: Maybe PortNumber, serverPort :: Maybe PortNumber, clientUrl :: Maybe URI, - serverUrl :: Maybe URI + serverUrl :: Maybe URI, + dbArgs :: StartDbArgs } deriving (Eq, Show) @@ -27,3 +32,30 @@ startArgsParser = <*> Opt.optional (portParser "server-port" "Port to run the server on") <*> Opt.optional (httpUrlParser "client-url" "URL at which the client is reachable") <*> Opt.optional (httpUrlParser "server-url" "URL at which the server is reachable") + <*> startDbArgsParser + +data StartDbArgs = StartDbArgs + { dbPort :: Maybe PortNumber, + dbImage :: Maybe DockerImageName, + dbVolumeMountPath :: Maybe DockerVolumeMountPath + } + deriving (Eq, Show) + +startDbArgsParser :: Opt.Parser StartDbArgs +startDbArgsParser = + StartDbArgs + <$> Opt.optional (portParser "db-port" ("Port to run the dev database on (default: " ++ show defaultPostgresPort ++ ")")) + <*> Opt.optional + ( Opt.strOption + ( Opt.long "db-image" + <> Opt.metavar "IMAGE" + <> Opt.help "Docker image to use for the database" + ) + ) + <*> Opt.optional + ( Opt.strOption + ( Opt.long "db-volume-mount-path" + <> Opt.metavar "PATH" + <> Opt.help "Path inside Docker container where database files are stored" + ) + ) diff --git a/waspc/cli/src/Wasp/Cli/Command/Start/Db.hs b/waspc/cli/src/Wasp/Cli/Command/Start/Db.hs index 6327c4bb66e..f355241ff52 100644 --- a/waspc/cli/src/Wasp/Cli/Command/Start/Db.hs +++ b/waspc/cli/src/Wasp/Cli/Command/Start/Db.hs @@ -1,18 +1,24 @@ module Wasp.Cli.Command.Start.Db ( start, + withManagedDb, ) where -import Control.Monad (when) +import Control.Concurrent (Chan, newChan, readChan) +import Control.Concurrent.Async (Async, async, cancel, concurrently, race, wait) +import Control.Exception (IOException, try) +import Control.Monad (unless, when) +import Control.Monad.Catch (bracket, bracketOnError, finally) import qualified Control.Monad.Except as E import Control.Monad.IO.Class (liftIO) -import Data.Maybe (isJust) +import Data.List (intercalate, isInfixOf) +import Data.Maybe (fromMaybe, isJust) import Network.Socket (PortNumber) -import qualified Options.Applicative as Opt -import StrongPath (Abs, Dir, File', Path', Rel, fromRelFile) +import StrongPath (Abs, Dir, Path') import System.Environment (lookupEnv) -import System.Exit (exitFailure) -import Text.Printf (printf) +import System.Exit (ExitCode (..)) +import System.IO.Error (ioeGetErrorString) +import System.Process (CreateProcess (create_group), proc, readCreateProcessWithExitCode, readProcessWithExitCode) import qualified Wasp.AppSpec as AS import qualified Wasp.AppSpec.App as AS.App import qualified Wasp.AppSpec.App.Db as AS.App.Db @@ -24,15 +30,17 @@ import Wasp.Cli.Command.Compile (analyze) import Wasp.Cli.Command.Message (cliSendMessageC) import Wasp.Cli.Command.Require.InWaspProject (InWaspProject (InWaspProject)) import Wasp.Cli.Command.Require.WaspSpecAvailable (WaspSpecAvailable (WaspSpecAvailable)) +import Wasp.Cli.Command.Start.ArgumentsParser (StartDbArgs (..), startDbArgsParser) import Wasp.Cli.Port (resolvePort) import Wasp.Cli.Util.Parser (ArgsParser (..), withArguments) -import Wasp.Cli.Util.PortArgument (portParser) import Wasp.Db.Postgres (defaultPostgresDockerImageSpec, defaultPostgresPort) +import qualified Wasp.Job as Job +import Wasp.Job.IO.PrefixedWriter (printJobMessagePrefixed, runPrefixedWriter) +import Wasp.Job.Process (runProcessAsJob) import qualified Wasp.Message as Msg import Wasp.Project.Common (WaspProjectDir) import Wasp.Project.Db (databaseUrlEnvVarName) import qualified Wasp.Project.Db.Dev.Postgres as Dev.Postgres -import Wasp.Project.Env (dotEnvServer) import Wasp.Util.Docker (DockerImageName, DockerVolumeMountPath) -- | Starts a "managed" dev database, where "managed" means that @@ -40,142 +48,211 @@ import Wasp.Util.Docker (DockerImageName, DockerVolumeMountPath) -- Wasp is smart while doing this so it checks which database is specified -- in Wasp configuration and spins up a database of appropriate type. start :: Arguments -> Command () -start = withArguments startDbArgsParser $ \args -> do - InWaspProject waspProjectDir <- require - WaspSpecAvailable <- require - appSpec <- analyze waspProjectDir - - throwIfCustomDbAlreadyInUse appSpec - - let app = ASV.getApp appSpec - - case ASV.getValidDbSystem appSpec of - AS.App.Db.SQLite -> noteSQLiteDoesntNeedStart - AS.App.Db.PostgreSQL -> - startPostgresDevDb - waspProjectDir - app.name - (dbPort args) - (dbImage args) - (dbVolumeMountPath args) +start = withArguments (ArgsParser "wasp db start" startDbArgsParser) $ \args -> + withDatabaseSession args StartNewDatabase $ \case + StartedDatabase _ _ process -> do + cliSendMessageC $ Msg.Info "PostgreSQL is running. Ctrl+C stops PostgreSQL." + _ <- liftIO $ wait process + E.throwError $ CommandError "PostgreSQL stopped" "The database container exited. Check the PostgreSQL logs above." + _ -> E.throwError $ CommandError "Database not started" "No managed PostgreSQL database was started." + +printDbMessages :: Chan Job.JobMessage -> IO () +printDbMessages channel = runPrefixedWriter go where - noteSQLiteDoesntNeedStart = - cliSendMessageC . Msg.Info $ - "Nothing to do! You are all good, you are using SQLite which doesn't need to be started." - -startDbArgsParser :: ArgsParser StartDbArgs -startDbArgsParser = - ArgsParser "wasp start db" $ - StartDbArgs - <$> Opt.optional (portParser "db-port" ("Port to run the dev database on (default: " ++ show defaultPostgresPort ++ ")")) - <*> Opt.strOption - ( Opt.long "db-image" - <> Opt.metavar "IMAGE" - <> Opt.help "Docker image to use for the database" - <> Opt.showDefault - <> Opt.value (fst defaultPostgresDockerImageSpec) - ) - <*> Opt.strOption - ( Opt.long "db-volume-mount-path" - <> Opt.metavar "PATH" - <> Opt.help "Path inside Docker container where database files are stored" - <> Opt.showDefault - <> Opt.value (snd defaultPostgresDockerImageSpec) + go = do + message <- liftIO $ readChan channel + case Job._data message of + Job.JobOutput output _ -> do + printJobMessagePrefixed $ Job.JobMessage (Job.JobOutput output Job.Stdout) Job.Db + go + Job.JobExit _ -> return () + +withManagedDb :: StartDbArgs -> (Maybe Dev.Postgres.DevDbSpec -> Command a) -> Command a +withManagedDb args action = withDatabaseSession args EnsureDatabase (action . databaseForSession) + +data DatabaseRequest = StartNewDatabase | EnsureDatabase + deriving (Eq) + +data DatabaseSession + = NoDatabase + | ReusedDatabase Dev.Postgres.DevDbSpec + | StartedDatabase Dev.Postgres.DevDbSpec String (Async ExitCode) + +data PreparedDatabase + = ExistingDatabase DatabaseSession + | NewDatabase Dev.Postgres.DevDbSpec DockerImageName DockerVolumeMountPath + +databaseForSession :: DatabaseSession -> Maybe Dev.Postgres.DevDbSpec +databaseForSession NoDatabase = Nothing +databaseForSession (ReusedDatabase db) = Just db +databaseForSession (StartedDatabase db _ _) = Just db + +withDatabaseSession :: StartDbArgs -> DatabaseRequest -> (DatabaseSession -> Command a) -> Command a +withDatabaseSession args request action = do + prepared <- prepare + bracket (acquire prepared) release use + where + use session = do + case session of + StartedDatabase db _ process -> do + result <- + withDatabaseError "Could not start PostgreSQL" $ + race (wait process) (Dev.Postgres.waitForReadyDevDb db) + case result of + Left _ -> E.throwError $ CommandError "Could not start PostgreSQL" "The Docker process exited before PostgreSQL was ready. Check the database output above." + Right () -> return () + cliSendMessageC $ Msg.Info "PostgreSQL ready." + when (request == StartNewDatabase) $ do + cliSendMessageC $ Msg.Info $ "Database URL: " <> Dev.Postgres.getDevConnectionUrl db + cliSendMessageC $ Msg.Info $ "Data volume: " <> db.dockerVolumeName + _ -> return () + action session + prepare = do + InWaspProject waspProjectDir <- require + WaspSpecAvailable <- require + appSpec <- analyze waspProjectDir + customDb <- liftIO $ hasExternalDatabaseUrl appSpec + if customDb + then case request of + StartNewDatabase -> E.throwError $ CommandError "No database to start" "DATABASE_URL points to an external database. Start that database outside Wasp." + EnsureDatabase -> rejectUnusedOptions "DATABASE_URL is set." args >> return (ExistingDatabase NoDatabase) + else case ASV.getValidDbSystem appSpec of + AS.App.Db.SQLite -> case request of + StartNewDatabase -> E.throwError $ CommandError "No database to start" "SQLite uses a local file and needs no separate startup." + EnsureDatabase -> rejectUnusedOptions "This project uses SQLite." args >> return (ExistingDatabase NoDatabase) + AS.App.Db.PostgreSQL -> do + let appName = (ASV.getApp appSpec).name + preparePostgresDevDb waspProjectDir appName args request + + acquire (ExistingDatabase session) = return session + acquire (NewDatabase db image mountPath) = + bracketOnError + (withDatabaseError "Could not start PostgreSQL" $ Dev.Postgres.createDevPostgresDb db image mountPath) + removeContainer + ( \containerId -> do + process <- liftIO $ async $ do + channel <- newChan + fst + <$> concurrently + (runProcessAsJob (proc "docker" ["start", "--attach", containerId]) Job.Db channel) + (printDbMessages channel) + return $ StartedDatabase db containerId process ) -data StartDbArgs = StartDbArgs - { dbPort :: Maybe PortNumber, - dbImage :: DockerImageName, - dbVolumeMountPath :: DockerVolumeMountPath - } + release (StartedDatabase _ containerId process) = + stopDatabase containerId `finally` (liftIO (cancel process) `finally` removeContainer containerId) + release _ = return () -throwIfCustomDbAlreadyInUse :: AS.AppSpec -> Command () -throwIfCustomDbAlreadyInUse spec = do - throwIfDbUrlInEnv - throwIfDbUrlInServerDotEnv spec + stopDatabase containerId = do + cliSendMessageC $ Msg.Start "Stopping database..." + runDockerCleanup "stop" containerId + +removeContainer :: String -> Command () +removeContainer = runDockerCleanup "rm" + +runDockerCleanup :: String -> String -> Command () +runDockerCleanup operation containerId = do + let args = [operation] ++ ["--force" | operation == "rm"] ++ [containerId] + (status, _, errors) <- liftIO $ readCreateProcessWithExitCode ((proc "docker" args) {create_group = True}) "" + when (status /= ExitSuccess && not ("No such container" `isInfixOf` errors)) $ + if operation == "stop" + then cliSendMessageC $ Msg.Warning "Could not stop PostgreSQL" ("Wasp will try to remove the container. " <> errors) + else cliSendMessageC $ Msg.Warning "Could not remove PostgreSQL container" ("Try `docker rm --force " <> containerId <> "`. " <> errors) + +rejectUnusedOptions :: String -> StartDbArgs -> Command () +rejectUnusedOptions source args = + unless (null options) + $ E.throwError + $ CommandError + "Database options do not apply" + (source <> " These options only apply to Wasp-managed PostgreSQL: " <> intercalate ", " options <> ". Remove them to continue.") where - throwIfDbUrlInEnv :: Command () - throwIfDbUrlInEnv = do - dbUrl <- liftIO $ lookupEnv databaseUrlEnvVarName - when (isJust dbUrl) $ - throwCustomDbAlreadyInUseError - ( "Wasp has detected existing " - <> databaseUrlEnvVarName - <> " var in your environment.\n" - <> "To have Wasp run the dev database for you, make sure you remove that env var first." - ) - - throwIfDbUrlInServerDotEnv :: AS.AppSpec -> Command () - throwIfDbUrlInServerDotEnv appSpec = - when (isThereDbUrlInServerDotEnv appSpec) $ - throwCustomDbAlreadyInUseError - ( printf - ( "Wasp has detected that you have defined %s env var in your %s file.\n" - <> "To have Wasp run the dev database for you, make sure you remove that env var first." - ) - databaseUrlEnvVarName - (fromRelFile (dotEnvServer :: Path' (Rel WaspProjectDir) File')) - ) - where - isThereDbUrlInServerDotEnv = any ((== databaseUrlEnvVarName) . fst) . AS.devEnvVarsServer - - throwCustomDbAlreadyInUseError :: String -> Command () - throwCustomDbAlreadyInUseError msg = - E.throwError $ CommandError "You are using custom database already" msg - -startPostgresDevDb :: Path' Abs (Dir WaspProjectDir) -> String -> Maybe PortNumber -> DockerImageName -> DockerVolumeMountPath -> Command () -startPostgresDevDb waspProjectDir appName requestedDbPort dbDockerImage dbDockerVolumeMountPath = do + options = suppliedOptionNames args + +suppliedOptionNames :: StartDbArgs -> [String] +suppliedOptionNames args = + ["--db-port" | isJust args.dbPort] + ++ ["--db-image" | isJust args.dbImage] + ++ ["--db-volume-mount-path" | isJust args.dbVolumeMountPath] + +requireDockerAvailable :: Command () +requireDockerAvailable = do + (exitCode, _, stderr) <- liftIO $ readProcessWithExitCode "docker" ["info", "--format", "{{.ServerVersion}}"] "" + when (exitCode /= ExitSuccess) + $ E.throwError + $ CommandError "Docker unavailable" ("Start Docker and retry. " <> stderr) + +preparePostgresDevDb :: Path' Abs (Dir WaspProjectDir) -> String -> StartDbArgs -> DatabaseRequest -> Command PreparedDatabase +preparePostgresDevDb waspProjectDir appName args request = do throwIfExeIsNotAvailable "docker" "To run PostgreSQL dev database, Wasp needs `docker` installed and in PATH." + requireDockerAvailable liftIO (Dev.Postgres.discoverProjectsRunningDevDb waspProjectDir appName) >>= \case - Just runningDb -> noteDbIsAlreadyRunningAndExit runningDb - Nothing -> startDbOnPort =<< resolveDevDbPort + Just runningDb -> case request of + StartNewDatabase -> + E.throwError $ + CommandError + "PostgreSQL already running" + ( "This project's database is already running. Stop the command that started it, or run `docker stop " + <> runningDb.dockerContainerName + <> "` before starting it again. Database URL: " + <> Dev.Postgres.getDevConnectionUrl runningDb + ) + EnsureDatabase -> ExistingDatabase <$> reportReusedDb runningDb + Nothing -> prepareDbOnPort =<< resolveDevDbPort where + dbDockerImage = fromMaybe (fst defaultPostgresDockerImageSpec) args.dbImage + dbDockerVolumeMountPath = fromMaybe (snd defaultPostgresDockerImageSpec) args.dbVolumeMountPath + resolveDevDbPort :: Command PortNumber resolveDevDbPort = resolvePort - requestedDbPort + args.dbPort defaultPostgresPort [] "Choose a different port with --db-port, or free up this one." "Free at least one of those ports by exiting the program listening on it, or choose the port yourself with --db-port." - noteDbIsAlreadyRunningAndExit :: Dev.Postgres.DevDbSpec -> Command () - noteDbIsAlreadyRunningAndExit devDbSpec = do - cliSendMessageC . Msg.Info . unlines $ - ("Your PostgreSQL dev database is already running on port " ++ show devDbSpec.port ++ ".") - : additionalInfoLines devDbSpec - liftIO exitFailure + reportReusedDb :: Dev.Postgres.DevDbSpec -> Command DatabaseSession + reportReusedDb devDbSpec = do + withDatabaseError "PostgreSQL is not ready" $ Dev.Postgres.waitForReadyDevDb devDbSpec + cliSendMessageC $ Msg.Info "PostgreSQL was already running for this project. Wasp did not start it and will not stop it." + unless (null $ suppliedOptionNames args) + $ cliSendMessageC + $ Msg.Warning + "Database options not used" + ("These options only apply when starting a new container: " <> intercalate ", " (suppliedOptionNames args) <> ". Stop the running database before changing them.") + return $ ReusedDatabase devDbSpec - startDbOnPort :: PortNumber -> Command () - startDbOnPort port = do + prepareDbOnPort :: PortNumber -> Command PreparedDatabase + prepareDbOnPort port = do let devDbSpec = Dev.Postgres.makeDevPostgresDbSpec waspProjectDir appName port - cliSendMessageC . Msg.Info . unlines $ - "✨ Starting a PostgreSQL dev database (based on your Wasp config) ✨" - : additionalInfoLines devDbSpec - <> dockerRunInfoLines - cliSendMessageC $ Msg.Info "..." - liftIO $ Dev.Postgres.runDevPostgresDb devDbSpec dbDockerImage dbDockerVolumeMountPath - - additionalInfoLines :: Dev.Postgres.DevDbSpec -> [String] - additionalInfoLines devDbSpec = - [ "", - "Additional info:", - " ℹ Connection URL, in case you might want to connect with external tools:", - " " <> Dev.Postgres.getDevConnectionUrl devDbSpec, - " ℹ Database data is persisted in a Docker volume with the following name" - <> " (useful to know if you will want to delete it at some point):", - " " <> devDbSpec.dockerVolumeName - ] - - -- These lines describe what `docker run` is about to use, so we print them - -- only when starting the database: an already running container might have - -- been started with a different image or mount path than the current - -- invocation's arguments. - dockerRunInfoLines :: [String] - dockerRunInfoLines = - [ " ℹ Using Docker image: " <> dbDockerImage, - " with the data volume mounted at: " <> dbDockerVolumeMountPath - ] + ensureImageAvailable + cliSendMessageC $ Msg.Start "Starting PostgreSQL..." + return $ NewDatabase devDbSpec dbDockerImage dbDockerVolumeMountPath + + ensureImageAvailable :: Command () + ensureImageAvailable = do + (imageStatus, _, _) <- liftIO $ readProcessWithExitCode "docker" ["image", "inspect", dbDockerImage] "" + when (imageStatus /= ExitSuccess) $ do + cliSendMessageC $ Msg.Start $ "Pulling PostgreSQL image " <> dbDockerImage <> "..." + pullStatus <- liftIO $ do + channel <- newChan + fst <$> concurrently (runProcessAsJob (proc "docker" ["pull", dbDockerImage]) Job.Db channel) (printDbMessages channel) + when (pullStatus /= ExitSuccess) + $ E.throwError + $ CommandError "Could not pull PostgreSQL image" ("Check the image name, registry access, and network connection. Image: " <> dbDockerImage) + +withDatabaseError :: String -> IO a -> Command a +withDatabaseError title action = do + result <- liftIO $ try action + case result of + Left (err :: IOException) -> E.throwError $ CommandError title $ ioeGetErrorString err + Right value -> return value + +hasExternalDatabaseUrl :: AS.AppSpec -> IO Bool +hasExternalDatabaseUrl appSpec = do + envUrl <- lookupEnv databaseUrlEnvVarName + return $ isJust envUrl || any ((== databaseUrlEnvVarName) . fst) (AS.devEnvVarsServer appSpec) diff --git a/waspc/cli/tests/DbMigrateTest.hs b/waspc/cli/tests/DbMigrateTest.hs new file mode 100644 index 00000000000..edf18811d91 --- /dev/null +++ b/waspc/cli/tests/DbMigrateTest.hs @@ -0,0 +1,31 @@ +module DbMigrateTest where + +import Data.Either (isLeft) +import qualified Options.Applicative as Opt +import Test.Hspec +import Wasp.Cli.Command.Db.Migrate (migrateArgsParser) +import Wasp.Cli.Command.Start.ArgumentsParser (StartDbArgs (..), startDbArgsParser) +import Wasp.Cli.Util.Parser (ArgsParser (optParser)) +import Wasp.Generator.DbGenerator.Common (MigrateArgs (..), defaultMigrateArgs) + +spec_databaseOptions :: Spec +spec_databaseOptions = do + it "parses database and migration options together" $ do + parseOptions ["--name", "new model", "--db-image", "postgis:18", "--create-only", "--db-port", "5544"] + `shouldBe` Right (StartDbArgs (Just 5544) (Just "postgis:18") Nothing, MigrateArgs (Just "new model") True) + parseOptions ["--db-volume-mount-path=/var/lib/postgresql/data"] + `shouldBe` Right (StartDbArgs Nothing Nothing (Just "/var/lib/postgresql/data"), defaultMigrateArgs) + parseOptions [] `shouldBe` Right (StartDbArgs Nothing Nothing Nothing, defaultMigrateArgs) + it "rejects missing values and unknown options" $ do + mapM_ + (\args -> isLeft (parseOptions args) `shouldBe` True) + [["--db-port"], ["--db-port", "0"], ["--db-port", "65536"], ["--db-port", "abc"], ["--db-image"], ["--name", "--db-image", "postgres:18"], ["--unknown"]] + where + parseOptions = parse ((,) <$> startDbArgsParser <*> optParser migrateArgsParser) + +parse :: Opt.Parser a -> [String] -> Either String a +parse parser args = + case Opt.execParserPure Opt.defaultPrefs (Opt.info parser Opt.fullDesc) args of + Opt.Success value -> Right value + Opt.Failure failure -> Left $ fst $ Opt.renderFailure failure "wasp db migrate-dev" + Opt.CompletionInvoked _ -> Left "Unexpected completion" diff --git a/waspc/e2e-tests/Tests/WaspDbStartTest.hs b/waspc/e2e-tests/Tests/WaspDbStartTest.hs index 533a2c92f53..e3353690ce2 100644 --- a/waspc/e2e-tests/Tests/WaspDbStartTest.hs +++ b/waspc/e2e-tests/Tests/WaspDbStartTest.hs @@ -1,16 +1,16 @@ module Tests.WaspDbStartTest (waspDbStartTest) where +import Control.Monad.Reader (ask) import ShellCommands ( ShellCommand, ShellCommandBuilder, - WaspProjectContext, + WaspProjectContext (..), assertCommandOutputContains, createTestWaspProject, inTestWaspProjectDir, setWaspDbToPSQL, skipIfDockerDisabled, waspCliDbMigrateDev, - waspCliDbStart, ) import Test (Test (..), TestCase (..)) import Wasp.Cli.Command.CreateNewProject.AvailableTemplates (minimalStarterTemplate) @@ -25,23 +25,22 @@ waspDbStartTest = "fail-outside-project" (return [waspCliDbStartFails]), TestCase - "succeed-sqlite-project" + "fail-sqlite-project" ( sequence [ createTestWaspProject minimalStarterTemplate, inTestWaspProjectDir - [ waspCliDbStart + [ assertCommandOutputContains (return waspCliDbStartFails) "SQLite uses a local file" ] ] ), TestCase - "fail-postgresql-project-when-dev-db-not-running" + "fail-sqlite-docker-option" ( sequence [ createTestWaspProject minimalStarterTemplate, inTestWaspProjectDir - [ setWaspDbToPSQL, - assertCommandOutputContains - (return waspCliDbMigrateDevFails) - "The database needs to be running" + [ assertCommandOutputContains + (return "! $WASP_CLI_CMD db migrate-dev --db-image postgres:18") + "only apply to Wasp-managed PostgreSQL" ] ] ), @@ -53,23 +52,25 @@ waspDbStartTest = [ createTestWaspProject minimalStarterTemplate, inTestWaspProjectDir [ setWaspDbToPSQL, + installDbCleanup, -- Test 1: Does `wasp db start` work? waspCliDbStartInBackground, -- Test 2: Does a Wasp command find the database and connect to it -- after `wasp db start` says it's ready? waitUntilDevDbReportsItIsReady, waspCliDbMigrateDev "first_migration", + assertDevDbRunning, -- Test 3: Does the second `wasp db start` detect and report -- an already running dev database? assertCommandOutputContains - (return waspCliDbStartFails) - "already running on port", + (return "! timeout 30 $WASP_CLI_CMD db start") + "PostgreSQL already running", -- Test 4: - -- - Does SIGINT stop the database and delete the container? + -- - Does stopping PostgreSQL delete the container? -- If it didn't delete the container, the next `wasp db start` would fail -- with a container name conflict. -- - Does `wasp db start` find a new port when the default one is taken? - stopWaspCliDbStartWithSigint, + stopDevDbAndWait, occupyDefaultDevDbPort, waspCliDbStartInBackground, waitUntilDevDbReportsItIsReady, @@ -77,7 +78,14 @@ waspDbStartTest = -- even when it's running on a non-default port? waspCliDbMigrateDev "no_new_migration", removeDefaultDevDbPortHolder, - stopWaspCliDbStartWithSigint, + stopDevDbAndWait, + assertDevDbRemoved, + waspCliDbMigrateDev "automatic_start", + assertDevDbRemoved, + assertCommandOutputContains + (return "$WASP_CLI_CMD db reset --force") + "PostgreSQL ready.", + assertDevDbRemoved, -- Test 6: Can the user remove the volume reported by `wasp db start`? removeReportedDevDbVolume ] @@ -88,9 +96,6 @@ waspDbStartTest = waspCliDbStartFails :: ShellCommand waspCliDbStartFails = "! $WASP_CLI_CMD db start" - waspCliDbMigrateDevFails :: ShellCommand - waspCliDbMigrateDevFails = "! $WASP_CLI_CMD db migrate-dev" - -- | `wasp db start` runs the database in the foreground, so we background it. -- We capture its output to test whether it correctly reports its readiness and volume name. waspCliDbStartInBackground :: ShellCommandBuilder WaspProjectContext ShellCommand @@ -98,27 +103,18 @@ waspCliDbStartInBackground = return $ "rm -f " ++ devDbOutputFile ++ " && { $WASP_CLI_CMD db start > " ++ devDbOutputFile ++ " 2>&1 & echo $! > db-start.pid ; }" --- | Stops the dev db the way Ctrl+C on `wasp db start` would - Postgres --- receives SIGINT and shuts down. --- --- We send the signal directly the container instead of `wasp db start` because --- Wasp ignores SIGINT when it has a child process. Wasp expects the child to --- handle the signal and exits after the child exits. --- --- In a terminal, Ctrl+C sends SIGINT to the entire process group, which means --- both Wasp and the container get it. Wasp ignores it, the container handles it --- and exists, which then causes Wasp to exit. -stopWaspCliDbStartWithSigint :: ShellCommandBuilder WaspProjectContext ShellCommand -stopWaspCliDbStartWithSigint = +-- Stop PostgreSQL directly so this test does not depend on terminal signal forwarding. +stopDevDbAndWait :: ShellCommandBuilder WaspProjectContext ShellCommand +stopDevDbAndWait = return $ - "{ docker kill --signal INT \"$(docker ps -q --filter volume=" + "{ docker kill --signal INT \"$(docker ps -q --filter \"volume=" ++ reportedDevDbVolumeName - ++ ")\" && wait \"$(cat db-start.pid)\" || true ; }" + ++ "\")\" && { wait \"$(cat db-start.pid)\" || true; } && rm db-start.pid; }" waitUntilDevDbReportsItIsReady :: ShellCommandBuilder WaspProjectContext ShellCommand waitUntilDevDbReportsItIsReady = return $ - "{ retries=180; until grep -q 'listening on IPv4 address' " + "{ retries=180; until grep -q 'Data volume:' " ++ devDbOutputFile ++ "; do retries=$((retries - 1)); [ \"$retries\" -gt 0 ] || exit 1; sleep 1; done ; }" @@ -149,7 +145,26 @@ removeReportedDevDbVolume = -- because it's the same place users learn it from. reportedDevDbVolumeName :: String reportedDevDbVolumeName = - "$(grep -o -m 1 '" ++ Dev.Postgres.waspDevDbDockerVolumePrefix ++ "[^ ]*' " ++ devDbOutputFile ++ ")" + "$(grep -o -m 1 '" ++ Dev.Postgres.waspDevDbDockerVolumePrefix ++ "[a-zA-Z0-9_-]*' " ++ devDbOutputFile ++ ")" devDbPortHolderContainerName :: String devDbPortHolderContainerName = "wasp-e2e-tests-db-port-holder" + +assertDevDbRunning :: ShellCommandBuilder WaspProjectContext ShellCommand +assertDevDbRunning = + return $ "test -n \"$(docker ps -q --filter \"volume=" ++ reportedDevDbVolumeName ++ "\")\"" + +assertDevDbRemoved :: ShellCommandBuilder WaspProjectContext ShellCommand +assertDevDbRemoved = + return $ "test -z \"$(docker ps -aq --filter \"volume=" ++ reportedDevDbVolumeName ++ "\")\"" + +installDbCleanup :: ShellCommandBuilder WaspProjectContext ShellCommand +installDbCleanup = do + context <- ask + let db = Dev.Postgres.makeDevPostgresDbSpec context.waspProjectDir "waspApp" defaultPostgresPort + return $ + "trap 'if [ -f db-start.pid ]; then kill \"$(cat db-start.pid)\" 2>/dev/null || true; wait \"$(cat db-start.pid)\" 2>/dev/null || true; fi; docker rm -f " + ++ db.dockerContainerName + ++ " " + ++ devDbPortHolderContainerName + ++ " >/dev/null 2>&1 || true' EXIT" diff --git a/waspc/src/Wasp/Project/Db/Dev/Postgres.hs b/waspc/src/Wasp/Project/Db/Dev/Postgres.hs index df676208610..db63cceb2be 100644 --- a/waspc/src/Wasp/Project/Db/Dev/Postgres.hs +++ b/waspc/src/Wasp/Project/Db/Dev/Postgres.hs @@ -1,7 +1,8 @@ -- | This module captures how Wasp runs a PostgreSQL dev database. module Wasp.Project.Db.Dev.Postgres ( makeDevPostgresDbSpec, - runDevPostgresDb, + createDevPostgresDb, + waitForReadyDevDb, DevDbSpec (..), getDevConnectionUrl, discoverProjectsRunningDevDb, @@ -9,13 +10,15 @@ module Wasp.Project.Db.Dev.Postgres ) where +import Control.Concurrent (threadDelay) import Network.Socket (PortNumber) import StrongPath (Abs, Dir, Path') -import System.Process (callCommand) -import Text.Printf (printf) +import System.Exit (ExitCode (..)) +import System.Process (CreateProcess (create_group), proc, readCreateProcessWithExitCode, readProcessWithExitCode) import Wasp.Db.Postgres (defaultPostgresPort, makeConnectionUrl, postgresMaxDbNameLength) import Wasp.Project.Common (WaspProjectDir, makeAppUniqueId) import Wasp.Util.Docker (DockerImageName, DockerVolumeMountPath, discoverHostPortForDockerContainersInternalPort) +import qualified Wasp.Util.Network.Socket as Socket data DevDbSpec = DevDbSpec { dockerVolumeName :: String, @@ -41,26 +44,72 @@ getDevConnectionUrl :: DevDbSpec -> String getDevConnectionUrl devDbSpec = makeConnectionUrl devDbSpec.user devDbSpec.password devDbSpec.port devDbSpec.dbName -runDevPostgresDb :: DevDbSpec -> DockerImageName -> DockerVolumeMountPath -> IO () -runDevPostgresDb devDbSpec dbDockerImage dbDockerVolumeMountPath = - callCommand runDbCommand +createDevPostgresDb :: DevDbSpec -> DockerImageName -> DockerVolumeMountPath -> IO String +createDevPostgresDb db image mountPath = do + (status, output, errors) <- readCreateProcessWithExitCode ((proc "docker" args) {create_group = True}) "" + case (status, words output) of + (ExitSuccess, [containerId]) -> return containerId + _ -> ioError $ userError $ "Could not create PostgreSQL container. " <> errors where - -- NOTE: POSTGRES_PASSWORD, POSTGRES_USER, POSTGRES_DB below are really used by the docker image - -- only when initializing the database -> if the volume was created previously, they will be ignored. - -- This is how the postgres Docker image works. - runDbCommand = - unwords - [ "docker run", - printf "--name %s" devDbSpec.dockerContainerName, - "--rm", - printf "--publish %s:%s" (show devDbSpec.port) (show postgresImageInternalPort), - printf "-v %s:%s" devDbSpec.dockerVolumeName dbDockerVolumeMountPath, - printf "--env POSTGRES_PASSWORD=%s" devDbSpec.password, - printf "--env POSTGRES_USER=%s" devDbSpec.user, - printf "--env POSTGRES_DB=%s" devDbSpec.dbName, - dbDockerImage - ] - postgresImageInternalPort = defaultPostgresPort + args = + [ "create", + "--rm", + "--name", + db.dockerContainerName, + "--publish", + "127.0.0.1:" <> show db.port <> ":" <> show defaultPostgresPort, + "-v", + db.dockerVolumeName <> ":" <> mountPath, + "--env", + "POSTGRES_PASSWORD=" <> db.password, + "--env", + "POSTGRES_USER=" <> db.user, + "--env", + "POSTGRES_DB=" <> db.dbName, + image + ] + +waitForReadyDevDb :: DevDbSpec -> IO () +waitForReadyDevDb devDbSpec = waitForReady 60 + where + waitForReady :: Int -> IO () + waitForReady 0 = do + (_, output, errors) <- readProcessWithExitCode "docker" ["logs", "--tail", "30", devDbSpec.dockerContainerName] "" + ioError $ userError $ "PostgreSQL did not become ready. Check the logs below, then try again.\n" <> output <> errors + waitForReady attempts = do + ready <- isDevDbReady devDbSpec + if ready then return () else threadDelay 1000000 >> waitForReady (attempts - 1) + +isDevDbReady :: DevDbSpec -> IO Bool +isDevDbReady devDbSpec = do + databaseReady <- isDevDbConnectionReady devDbSpec + if databaseReady + then Socket.checkIfPortIsAcceptingConnections $ Socket.makeLocalHostSocketAddress devDbSpec.port + else return False + +isDevDbConnectionReady :: DevDbSpec -> IO Bool +isDevDbConnectionReady devDbSpec = do + (exitCode, output, _) <- + readProcessWithExitCode + "docker" + [ "exec", + "--env", + "PGPASSWORD=" <> devDbSpec.password, + devDbSpec.dockerContainerName, + "psql", + "-h", + "127.0.0.1", + "-U", + devDbSpec.user, + "-d", + devDbSpec.dbName, + "-t", + "-A", + "-c", + "SELECT 1" + ] + "" + return $ exitCode == ExitSuccess && output == "1\n" -- | Returns all relevant info about this Wasp project's dev detabase if its -- container is running, 'Nothing' otherwise. diff --git a/waspc/waspc.cabal b/waspc/waspc.cabal index 5ec9b6e7b8b..58151ca7a61 100644 --- a/waspc/waspc.cabal +++ b/waspc/waspc.cabal @@ -653,6 +653,7 @@ test-suite wasp-cli-tests hspec, network, network-uri, + optparse-applicative, QuickCheck, tasty, tasty-hspec, @@ -660,6 +661,7 @@ test-suite wasp-cli-tests waspc, other-modules: + DbMigrateTest Paths_waspc TerminalTest Wasp.Cli.Command.CreateNewProject.ProjectDescriptionTest From 51d4a4ccfca632b9c2957e6bc8865f89baa19355 Mon Sep 17 00:00:00 2001 From: Mihovil Ilakovac Date: Tue, 6 Oct 2026 15:23:00 +0200 Subject: [PATCH 02/27] Remove redundant PostgreSQL ready message --- waspc/cli/src/Wasp/Cli/Command/Start/Db.hs | 1 - 1 file changed, 1 deletion(-) diff --git a/waspc/cli/src/Wasp/Cli/Command/Start/Db.hs b/waspc/cli/src/Wasp/Cli/Command/Start/Db.hs index f355241ff52..3f9c3428aba 100644 --- a/waspc/cli/src/Wasp/Cli/Command/Start/Db.hs +++ b/waspc/cli/src/Wasp/Cli/Command/Start/Db.hs @@ -101,7 +101,6 @@ withDatabaseSession args request action = do case result of Left _ -> E.throwError $ CommandError "Could not start PostgreSQL" "The Docker process exited before PostgreSQL was ready. Check the database output above." Right () -> return () - cliSendMessageC $ Msg.Info "PostgreSQL ready." when (request == StartNewDatabase) $ do cliSendMessageC $ Msg.Info $ "Database URL: " <> Dev.Postgres.getDevConnectionUrl db cliSendMessageC $ Msg.Info $ "Data volume: " <> db.dockerVolumeName From e82f79ee5d2ae997074605aaecf1d5985032d133 Mon Sep 17 00:00:00 2001 From: Mihovil Ilakovac Date: Tue, 6 Oct 2026 17:18:47 +0200 Subject: [PATCH 03/27] Separate database lifecycle and shared options from command entry points --- waspc/cli/src/Wasp/Cli/Command/Db.hs | 6 +- .../Wasp/Cli/Command/Db/ArgumentsParser.hs | 37 +++ .../cli/src/Wasp/Cli/Command/Db/Lifecycle.hs | 267 ++++++++++++++++++ waspc/cli/src/Wasp/Cli/Command/Start.hs | 8 +- .../Wasp/Cli/Command/Start/ArgumentsParser.hs | 31 +- waspc/cli/src/Wasp/Cli/Command/Start/Db.hs | 252 +---------------- waspc/cli/tests/DbMigrateTest.hs | 7 +- waspc/e2e-tests/Tests/WaspDbStartTest.hs | 4 +- waspc/src/Wasp/Project/Db/Dev/Postgres.hs | 6 +- waspc/waspc.cabal | 2 + 10 files changed, 326 insertions(+), 294 deletions(-) create mode 100644 waspc/cli/src/Wasp/Cli/Command/Db/ArgumentsParser.hs create mode 100644 waspc/cli/src/Wasp/Cli/Command/Db/Lifecycle.hs diff --git a/waspc/cli/src/Wasp/Cli/Command/Db.hs b/waspc/cli/src/Wasp/Cli/Command/Db.hs index 5201fcf7059..7443e88df21 100644 --- a/waspc/cli/src/Wasp/Cli/Command/Db.hs +++ b/waspc/cli/src/Wasp/Cli/Command/Db.hs @@ -11,8 +11,8 @@ import Wasp.Cli.Command.Compile (defaultCompileOptions, withSetupGoals) import Wasp.Cli.Command.Require.DbConnectionEstablished (DbConnectionEstablished (DbConnectionEstablished)) import Wasp.Cli.Command.Require.InWaspProject (InWaspProject (InWaspProject)) import Wasp.Cli.Command.Require.WaspSpecAvailable (WaspSpecAvailable (WaspSpecAvailable)) -import Wasp.Cli.Command.Start.ArgumentsParser (startDbArgsParser) -import qualified Wasp.Cli.Command.Start.Db as Start.Db +import Wasp.Cli.Command.Db.ArgumentsParser (startDbArgsParser) +import qualified Wasp.Cli.Command.Db.Lifecycle as DbLifecycle import Wasp.Cli.Compile (waitEnsureCompile) import Wasp.Cli.Util.Parser (ArgsParser (..), withArguments) import Wasp.Generator.Setup (SetupGoal) @@ -23,7 +23,7 @@ runCommandThatRequiresDbRunning parser command args = where databaseArgsParser = parser {optParser = (,) <$> startDbArgsParser <*> parser.optParser} run (dbArgs, commandArgs) = - Start.Db.withManagedDb dbArgs $ \_ -> command commandArgs + DbLifecycle.withManagedDb dbArgs $ \_ -> command commandArgs -- | Prepares what a db command needs before it runs: a compile, -- post-compile setup, and a reachable database. diff --git a/waspc/cli/src/Wasp/Cli/Command/Db/ArgumentsParser.hs b/waspc/cli/src/Wasp/Cli/Command/Db/ArgumentsParser.hs new file mode 100644 index 00000000000..74396819ae5 --- /dev/null +++ b/waspc/cli/src/Wasp/Cli/Command/Db/ArgumentsParser.hs @@ -0,0 +1,37 @@ +module Wasp.Cli.Command.Db.ArgumentsParser + ( StartDbArgs (..), + startDbArgsParser, + ) +where + +import Network.Socket (PortNumber) +import qualified Options.Applicative as Opt +import Wasp.Cli.Util.PortArgument (portParser) +import Wasp.Db.Postgres (defaultPostgresPort) +import Wasp.Util.Docker (DockerImageName, DockerVolumeMountPath) + +data StartDbArgs = StartDbArgs + { dbPort :: Maybe PortNumber, + dbImage :: Maybe DockerImageName, + dbVolumeMountPath :: Maybe DockerVolumeMountPath + } + deriving (Eq, Show) + +startDbArgsParser :: Opt.Parser StartDbArgs +startDbArgsParser = + StartDbArgs + <$> Opt.optional (portParser "db-port" ("Port to run the dev database on (default: " ++ show defaultPostgresPort ++ ")")) + <*> Opt.optional + ( Opt.strOption + ( Opt.long "db-image" + <> Opt.metavar "IMAGE" + <> Opt.help "Docker image to use for the database" + ) + ) + <*> Opt.optional + ( Opt.strOption + ( Opt.long "db-volume-mount-path" + <> Opt.metavar "PATH" + <> Opt.help "Path inside Docker container where database files are stored" + ) + ) diff --git a/waspc/cli/src/Wasp/Cli/Command/Db/Lifecycle.hs b/waspc/cli/src/Wasp/Cli/Command/Db/Lifecycle.hs new file mode 100644 index 00000000000..047bd07aa49 --- /dev/null +++ b/waspc/cli/src/Wasp/Cli/Command/Db/Lifecycle.hs @@ -0,0 +1,267 @@ +module Wasp.Cli.Command.Db.Lifecycle + ( start, + withManagedDb, + ) +where + +import Control.Concurrent (Chan, newChan, readChan) +import Control.Concurrent.Async (Async, async, cancel, concurrently, race, wait) +import Control.Exception (IOException, try) +import Control.Monad (unless, when) +import Control.Monad.Catch (bracket, bracketOnError, finally) +import qualified Control.Monad.Except as E +import Control.Monad.IO.Class (liftIO) +import Data.List (intercalate, isInfixOf) +import Data.Maybe (fromMaybe, isJust) +import Network.Socket (PortNumber) +import StrongPath (Abs, Dir, Path') +import System.Environment (lookupEnv) +import System.Exit (ExitCode (..)) +import System.IO.Error (ioeGetErrorString) +import System.Process (CreateProcess (create_group), proc, readCreateProcessWithExitCode, readProcessWithExitCode) +import qualified Wasp.AppSpec as AS +import qualified Wasp.AppSpec.App as AS.App +import qualified Wasp.AppSpec.App.Db as AS.App.Db +import qualified Wasp.AppSpec.Valid as ASV +import Wasp.Cli.Command (Command, CommandError (CommandError), require) +import Wasp.Cli.Command.Common (throwIfExeIsNotAvailable) +import Wasp.Cli.Command.Compile (analyze) +import Wasp.Cli.Command.Db.ArgumentsParser (StartDbArgs (..)) +import Wasp.Cli.Command.Message (cliSendMessageC) +import Wasp.Cli.Command.Require.InWaspProject (InWaspProject (InWaspProject)) +import Wasp.Cli.Command.Require.WaspSpecAvailable (WaspSpecAvailable (WaspSpecAvailable)) +import Wasp.Cli.Port (resolvePort) +import Wasp.Db.Postgres (defaultPostgresDockerImageSpec, defaultPostgresPort) +import qualified Wasp.Job as Job +import Wasp.Job.IO.PrefixedWriter (printJobMessagePrefixed, runPrefixedWriter) +import Wasp.Job.Process (runProcessAsJob) +import qualified Wasp.Message as Msg +import Wasp.Project.Common (WaspProjectDir) +import Wasp.Project.Db (databaseUrlEnvVarName) +import qualified Wasp.Project.Db.Dev.Postgres as Dev.Postgres +import Wasp.Util.Docker (DockerImageName, DockerVolumeMountPath) + +-- | Starts a "managed" dev database, where "managed" means that +-- Wasp creates it and connects the Wasp app with it. +-- Wasp is smart while doing this so it checks which database is specified +-- in Wasp configuration and spins up a database of appropriate type. +start :: StartDbArgs -> Command () +start args = + withDatabaseSession args StartNewDatabase $ \case + StartedDatabase _ _ process -> do + cliSendMessageC $ Msg.Info "PostgreSQL is running. Ctrl+C stops PostgreSQL." + _ <- liftIO $ wait process + E.throwError $ CommandError "PostgreSQL stopped" "The database container exited. Check the PostgreSQL logs above." + _ -> E.throwError $ CommandError "Database not started" "No managed PostgreSQL database was started." + +printDbMessages :: Chan Job.JobMessage -> IO () +printDbMessages channel = runPrefixedWriter go + where + go = do + message <- liftIO $ readChan channel + case Job._data message of + Job.JobOutput output _ -> do + printJobMessagePrefixed $ Job.JobMessage (Job.JobOutput output Job.Stdout) Job.Db + go + Job.JobExit _ -> return () + +withManagedDb :: StartDbArgs -> (Maybe Dev.Postgres.DevDbSpec -> Command a) -> Command a +withManagedDb args action = withDatabaseSession args EnsureDatabase (action . databaseForSession) + +data DatabaseRequest = StartNewDatabase | EnsureDatabase + deriving (Eq) + +data DatabaseSession + = NoDatabase + | ReusedDatabase Dev.Postgres.DevDbSpec + | StartedDatabase Dev.Postgres.DevDbSpec String (Async ExitCode) + +data PreparedDatabase + = ExistingDatabase DatabaseSession + | NewDatabase Dev.Postgres.DevDbSpec DockerImageName DockerVolumeMountPath + +databaseForSession :: DatabaseSession -> Maybe Dev.Postgres.DevDbSpec +databaseForSession NoDatabase = Nothing +databaseForSession (ReusedDatabase db) = Just db +databaseForSession (StartedDatabase db _ _) = Just db + +withDatabaseSession :: StartDbArgs -> DatabaseRequest -> (DatabaseSession -> Command a) -> Command a +withDatabaseSession args request action = do + prepared <- prepare + bracket (acquire prepared) release use + where + use session = do + case session of + StartedDatabase db _ process -> do + result <- + withDatabaseError "Could not start PostgreSQL" $ + race (wait process) (Dev.Postgres.waitForReadyDevDb db) + case result of + Left _ -> E.throwError $ CommandError "Could not start PostgreSQL" "The Docker process exited before PostgreSQL was ready. Check the database output above." + Right () -> return () + when (request == StartNewDatabase) $ do + cliSendMessageC $ Msg.Info $ "Database URL: " <> Dev.Postgres.getDevConnectionUrl db + cliSendMessageC $ Msg.Info $ "Data volume: " <> db.dockerVolumeName + _ -> return () + action session + prepare = do + InWaspProject waspProjectDir <- require + WaspSpecAvailable <- require + appSpec <- analyze waspProjectDir + customDb <- liftIO $ hasExternalDatabaseUrl appSpec + if customDb + then case request of + StartNewDatabase -> E.throwError $ CommandError "No database to start" "DATABASE_URL points to an external database. Start that database outside Wasp." + EnsureDatabase -> rejectUnusedOptions "DATABASE_URL is set." args >> return (ExistingDatabase NoDatabase) + else case ASV.getValidDbSystem appSpec of + AS.App.Db.SQLite -> case request of + StartNewDatabase -> E.throwError $ CommandError "No database to start" "SQLite uses a local file and needs no separate startup." + EnsureDatabase -> rejectUnusedOptions "This project uses SQLite." args >> return (ExistingDatabase NoDatabase) + AS.App.Db.PostgreSQL -> do + let appName = (ASV.getApp appSpec).name + preparePostgresDevDb waspProjectDir appName args request + + acquire (ExistingDatabase session) = return session + acquire (NewDatabase db image mountPath) = + bracketOnError + (withDatabaseError "Could not start PostgreSQL" $ Dev.Postgres.createDevPostgresDb db image mountPath) + removeContainer + ( \containerId -> do + process <- liftIO $ async $ do + channel <- newChan + fst + <$> concurrently + (runProcessAsJob (proc "docker" ["start", "--attach", containerId]) Job.Db channel) + (printDbMessages channel) + return $ StartedDatabase db containerId process + ) + + release (StartedDatabase _ containerId process) = + stopDatabase containerId `finally` (liftIO (cancel process) `finally` removeContainer containerId) + release _ = return () + + stopDatabase containerId = do + cliSendMessageC $ Msg.Start "Stopping database..." + runDockerCleanup "stop" containerId + +removeContainer :: String -> Command () +removeContainer = runDockerCleanup "rm" + +runDockerCleanup :: String -> String -> Command () +runDockerCleanup operation containerId = do + let args = [operation] ++ ["--force" | operation == "rm"] ++ [containerId] + -- Let Docker finish stopping or removing the container even if the user presses Ctrl+C again. + (status, _, errors) <- liftIO $ readCreateProcessWithExitCode ((proc "docker" args) {create_group = True}) "" + when (status /= ExitSuccess && not ("No such container" `isInfixOf` errors)) $ + if operation == "stop" + then cliSendMessageC $ Msg.Warning "Could not stop PostgreSQL" ("Wasp will try to remove the container. " <> errors) + else cliSendMessageC $ Msg.Warning "Could not remove PostgreSQL container" ("Try `docker rm --force " <> containerId <> "`. " <> errors) + +rejectUnusedOptions :: String -> StartDbArgs -> Command () +rejectUnusedOptions source args = + unless (null options) $ + E.throwError $ + CommandError + "Database options do not apply" + (source <> " These options only apply to Wasp-managed PostgreSQL: " <> intercalate ", " options <> ". Remove them to continue.") + where + options = suppliedOptionNames args + +suppliedOptionNames :: StartDbArgs -> [String] +suppliedOptionNames args = + ["--db-port" | isJust args.dbPort] + ++ ["--db-image" | isJust args.dbImage] + ++ ["--db-volume-mount-path" | isJust args.dbVolumeMountPath] + +requireDockerAvailable :: Command () +requireDockerAvailable = do + (exitCode, _, stderr) <- liftIO $ readProcessWithExitCode "docker" ["info", "--format", "{{.ServerVersion}}"] "" + when (exitCode /= ExitSuccess) $ + E.throwError $ + CommandError "Docker unavailable" ("Start Docker and retry. " <> stderr) + +preparePostgresDevDb :: Path' Abs (Dir WaspProjectDir) -> String -> StartDbArgs -> DatabaseRequest -> Command PreparedDatabase +preparePostgresDevDb waspProjectDir appName args request = do + throwIfExeIsNotAvailable + "docker" + "To run PostgreSQL dev database, Wasp needs `docker` installed and in PATH." + requireDockerAvailable + + liftIO (Dev.Postgres.discoverProjectsRunningDevDb waspProjectDir appName) >>= \case + Just runningDb -> case request of + StartNewDatabase -> + E.throwError $ + CommandError + "PostgreSQL already running" + ( "This project's database is already running. Stop the command that started it, or run `docker stop " + <> runningDb.dockerContainerName + <> "` before starting it again. Database URL: " + <> Dev.Postgres.getDevConnectionUrl runningDb + ) + EnsureDatabase -> ExistingDatabase <$> reportReusedDb runningDb + Nothing -> prepareDbOnPort =<< resolveDevDbPort + where + dbDockerImage = fromMaybe (fst defaultPostgresDockerImageSpec) args.dbImage + dbDockerVolumeMountPath = fromMaybe (snd defaultPostgresDockerImageSpec) args.dbVolumeMountPath + + resolveDevDbPort :: Command PortNumber + resolveDevDbPort = + resolvePort + args.dbPort + defaultPostgresPort + [] + "Choose a different port with --db-port, or free up this one." + "Free at least one of those ports by exiting the program listening on it, or choose the port yourself with --db-port." + + reportReusedDb :: Dev.Postgres.DevDbSpec -> Command DatabaseSession + reportReusedDb devDbSpec = do + withDatabaseError "PostgreSQL is not ready" $ Dev.Postgres.waitForReadyDevDb devDbSpec + cliSendMessageC $ Msg.Info "PostgreSQL was already running for this project. Wasp did not start it and will not stop it." + unless (null $ suppliedOptionNames args) $ + cliSendMessageC $ + Msg.Warning + "Database options not used" + ("These options only apply when starting a new container: " <> intercalate ", " (suppliedOptionNames args) <> ". Stop the running database before changing them.") + return $ ReusedDatabase devDbSpec + + prepareDbOnPort :: PortNumber -> Command PreparedDatabase + prepareDbOnPort port = do + let devDbSpec = Dev.Postgres.makeDevPostgresDbSpec waspProjectDir appName port + ensureImageAvailable + cliSendMessageC $ Msg.Start "Starting PostgreSQL..." + cliSendMessageC $ Msg.Info $ unlines dockerRunInfoLines + return $ NewDatabase devDbSpec dbDockerImage dbDockerVolumeMountPath + + -- These lines describe what Docker is about to use, so we print them + -- only when starting the database: an already running container might have + -- been started with a different image or mount path than the current + -- invocation's arguments. + dockerRunInfoLines :: [String] + dockerRunInfoLines = + [ " ℹ Using Docker image: " <> dbDockerImage, + " with the data volume mounted at: " <> dbDockerVolumeMountPath + ] + + ensureImageAvailable :: Command () + ensureImageAvailable = do + (imageStatus, _, _) <- liftIO $ readProcessWithExitCode "docker" ["image", "inspect", dbDockerImage] "" + when (imageStatus /= ExitSuccess) $ do + cliSendMessageC $ Msg.Start $ "Pulling PostgreSQL image " <> dbDockerImage <> "..." + pullStatus <- liftIO $ do + channel <- newChan + fst <$> concurrently (runProcessAsJob (proc "docker" ["pull", dbDockerImage]) Job.Db channel) (printDbMessages channel) + when (pullStatus /= ExitSuccess) $ + E.throwError $ + CommandError "Could not pull PostgreSQL image" ("Check the image name, registry access, and network connection. Image: " <> dbDockerImage) + +withDatabaseError :: String -> IO a -> Command a +withDatabaseError title action = do + result <- liftIO $ try action + case result of + Left (err :: IOException) -> E.throwError $ CommandError title $ ioeGetErrorString err + Right value -> return value + +hasExternalDatabaseUrl :: AS.AppSpec -> IO Bool +hasExternalDatabaseUrl appSpec = do + envUrl <- lookupEnv databaseUrlEnvVarName + return $ isJust envUrl || any ((== databaseUrlEnvVarName) . fst) (AS.devEnvVarsServer appSpec) diff --git a/waspc/cli/src/Wasp/Cli/Command/Start.hs b/waspc/cli/src/Wasp/Cli/Command/Start.hs index f011941d2bc..09bdfc56371 100644 --- a/waspc/cli/src/Wasp/Cli/Command/Start.hs +++ b/waspc/cli/src/Wasp/Cli/Command/Start.hs @@ -21,7 +21,7 @@ import Wasp.Cli.Command.News (fetchAndListMustSeeNewsIfDue) import Wasp.Cli.Command.Require.DbConnectionEstablished (DbConnectionEstablished (DbConnectionEstablished)) import Wasp.Cli.Command.Require.InWaspProject (InWaspProject (InWaspProject)) import Wasp.Cli.Command.Start.ArgumentsParser (StartArgs (..), startArgsParser) -import qualified Wasp.Cli.Command.Start.Db as Start.Db +import qualified Wasp.Cli.Command.Db.Lifecycle as DbLifecycle import Wasp.Cli.Command.Watch (watch) import Wasp.Cli.EnvVarWithCtx (addEnvVarsUniqueC) import qualified Wasp.Cli.EnvVarWithCtx as EnvVarWithCtx @@ -41,7 +41,7 @@ import qualified Wasp.Project.Env as Env -- It also listens for any file changes and recompiles and restarts generated project accordingly. start :: Arguments -> Command () start = withArguments startArgsParser $ \args -> - ProjectLock.acquireWatcher $ \projectLock -> Start.Db.withManagedDb args.dbArgs $ \managedDb -> do + ProjectLock.acquireWatcher $ \projectLock -> DbLifecycle.withManagedDb args.dbArgs $ \managedDb -> do -- We check for the news only in `wasp start`, and only periodically, -- to avoid being too aggressive. Specifically: -- - We don't run it in other `wasp` commands because we don't want to @@ -68,7 +68,9 @@ start = withArguments startArgsParser $ \args -> cliSendMessageC $ Msg.Start "Listening for file changes..." cliSendMessageC $ Msg.Start "Starting up generated project..." - let databaseUrlLine = maybe "" (\db -> " ℹ Database: " <> Dev.Postgres.getDevConnectionUrl db <> "\n") managedDb + let databaseUrlLine = case managedDb of + Nothing -> "" + Just db -> " ℹ Database: " <> Dev.Postgres.getDevConnectionUrl db <> "\n" cliSendMessageC $ Msg.Info $ showRunConfigUrls runConfigs <> databaseUrlLine watchOrStartResult <- liftIO $ do diff --git a/waspc/cli/src/Wasp/Cli/Command/Start/ArgumentsParser.hs b/waspc/cli/src/Wasp/Cli/Command/Start/ArgumentsParser.hs index 34ce57218a0..bea5b0195e9 100644 --- a/waspc/cli/src/Wasp/Cli/Command/Start/ArgumentsParser.hs +++ b/waspc/cli/src/Wasp/Cli/Command/Start/ArgumentsParser.hs @@ -1,19 +1,16 @@ module Wasp.Cli.Command.Start.ArgumentsParser ( StartArgs (..), startArgsParser, - StartDbArgs (..), - startDbArgsParser, ) where import Network.Socket (PortNumber) import Network.URI (URI) import qualified Options.Applicative as Opt +import Wasp.Cli.Command.Db.ArgumentsParser (StartDbArgs, startDbArgsParser) import Wasp.Cli.Util.HttpUrlArgument (httpUrlParser) import Wasp.Cli.Util.Parser (ArgsParser (..)) import Wasp.Cli.Util.PortArgument (portParser) -import Wasp.Db.Postgres (defaultPostgresPort) -import Wasp.Util.Docker (DockerImageName, DockerVolumeMountPath) data StartArgs = StartArgs { clientPort :: Maybe PortNumber, @@ -33,29 +30,3 @@ startArgsParser = <*> Opt.optional (httpUrlParser "client-url" "URL at which the client is reachable") <*> Opt.optional (httpUrlParser "server-url" "URL at which the server is reachable") <*> startDbArgsParser - -data StartDbArgs = StartDbArgs - { dbPort :: Maybe PortNumber, - dbImage :: Maybe DockerImageName, - dbVolumeMountPath :: Maybe DockerVolumeMountPath - } - deriving (Eq, Show) - -startDbArgsParser :: Opt.Parser StartDbArgs -startDbArgsParser = - StartDbArgs - <$> Opt.optional (portParser "db-port" ("Port to run the dev database on (default: " ++ show defaultPostgresPort ++ ")")) - <*> Opt.optional - ( Opt.strOption - ( Opt.long "db-image" - <> Opt.metavar "IMAGE" - <> Opt.help "Docker image to use for the database" - ) - ) - <*> Opt.optional - ( Opt.strOption - ( Opt.long "db-volume-mount-path" - <> Opt.metavar "PATH" - <> Opt.help "Path inside Docker container where database files are stored" - ) - ) diff --git a/waspc/cli/src/Wasp/Cli/Command/Start/Db.hs b/waspc/cli/src/Wasp/Cli/Command/Start/Db.hs index 3f9c3428aba..1e001df0453 100644 --- a/waspc/cli/src/Wasp/Cli/Command/Start/Db.hs +++ b/waspc/cli/src/Wasp/Cli/Command/Start/Db.hs @@ -1,257 +1,13 @@ module Wasp.Cli.Command.Start.Db ( start, - withManagedDb, ) where -import Control.Concurrent (Chan, newChan, readChan) -import Control.Concurrent.Async (Async, async, cancel, concurrently, race, wait) -import Control.Exception (IOException, try) -import Control.Monad (unless, when) -import Control.Monad.Catch (bracket, bracketOnError, finally) -import qualified Control.Monad.Except as E -import Control.Monad.IO.Class (liftIO) -import Data.List (intercalate, isInfixOf) -import Data.Maybe (fromMaybe, isJust) -import Network.Socket (PortNumber) -import StrongPath (Abs, Dir, Path') -import System.Environment (lookupEnv) -import System.Exit (ExitCode (..)) -import System.IO.Error (ioeGetErrorString) -import System.Process (CreateProcess (create_group), proc, readCreateProcessWithExitCode, readProcessWithExitCode) -import qualified Wasp.AppSpec as AS -import qualified Wasp.AppSpec.App as AS.App -import qualified Wasp.AppSpec.App.Db as AS.App.Db -import qualified Wasp.AppSpec.Valid as ASV -import Wasp.Cli.Command (Command, CommandError (CommandError), require) +import Wasp.Cli.Command (Command) import Wasp.Cli.Command.Call (Arguments) -import Wasp.Cli.Command.Common (throwIfExeIsNotAvailable) -import Wasp.Cli.Command.Compile (analyze) -import Wasp.Cli.Command.Message (cliSendMessageC) -import Wasp.Cli.Command.Require.InWaspProject (InWaspProject (InWaspProject)) -import Wasp.Cli.Command.Require.WaspSpecAvailable (WaspSpecAvailable (WaspSpecAvailable)) -import Wasp.Cli.Command.Start.ArgumentsParser (StartDbArgs (..), startDbArgsParser) -import Wasp.Cli.Port (resolvePort) +import Wasp.Cli.Command.Db.ArgumentsParser (startDbArgsParser) +import qualified Wasp.Cli.Command.Db.Lifecycle as DbLifecycle import Wasp.Cli.Util.Parser (ArgsParser (..), withArguments) -import Wasp.Db.Postgres (defaultPostgresDockerImageSpec, defaultPostgresPort) -import qualified Wasp.Job as Job -import Wasp.Job.IO.PrefixedWriter (printJobMessagePrefixed, runPrefixedWriter) -import Wasp.Job.Process (runProcessAsJob) -import qualified Wasp.Message as Msg -import Wasp.Project.Common (WaspProjectDir) -import Wasp.Project.Db (databaseUrlEnvVarName) -import qualified Wasp.Project.Db.Dev.Postgres as Dev.Postgres -import Wasp.Util.Docker (DockerImageName, DockerVolumeMountPath) --- | Starts a "managed" dev database, where "managed" means that --- Wasp creates it and connects the Wasp app with it. --- Wasp is smart while doing this so it checks which database is specified --- in Wasp configuration and spins up a database of appropriate type. start :: Arguments -> Command () -start = withArguments (ArgsParser "wasp db start" startDbArgsParser) $ \args -> - withDatabaseSession args StartNewDatabase $ \case - StartedDatabase _ _ process -> do - cliSendMessageC $ Msg.Info "PostgreSQL is running. Ctrl+C stops PostgreSQL." - _ <- liftIO $ wait process - E.throwError $ CommandError "PostgreSQL stopped" "The database container exited. Check the PostgreSQL logs above." - _ -> E.throwError $ CommandError "Database not started" "No managed PostgreSQL database was started." - -printDbMessages :: Chan Job.JobMessage -> IO () -printDbMessages channel = runPrefixedWriter go - where - go = do - message <- liftIO $ readChan channel - case Job._data message of - Job.JobOutput output _ -> do - printJobMessagePrefixed $ Job.JobMessage (Job.JobOutput output Job.Stdout) Job.Db - go - Job.JobExit _ -> return () - -withManagedDb :: StartDbArgs -> (Maybe Dev.Postgres.DevDbSpec -> Command a) -> Command a -withManagedDb args action = withDatabaseSession args EnsureDatabase (action . databaseForSession) - -data DatabaseRequest = StartNewDatabase | EnsureDatabase - deriving (Eq) - -data DatabaseSession - = NoDatabase - | ReusedDatabase Dev.Postgres.DevDbSpec - | StartedDatabase Dev.Postgres.DevDbSpec String (Async ExitCode) - -data PreparedDatabase - = ExistingDatabase DatabaseSession - | NewDatabase Dev.Postgres.DevDbSpec DockerImageName DockerVolumeMountPath - -databaseForSession :: DatabaseSession -> Maybe Dev.Postgres.DevDbSpec -databaseForSession NoDatabase = Nothing -databaseForSession (ReusedDatabase db) = Just db -databaseForSession (StartedDatabase db _ _) = Just db - -withDatabaseSession :: StartDbArgs -> DatabaseRequest -> (DatabaseSession -> Command a) -> Command a -withDatabaseSession args request action = do - prepared <- prepare - bracket (acquire prepared) release use - where - use session = do - case session of - StartedDatabase db _ process -> do - result <- - withDatabaseError "Could not start PostgreSQL" $ - race (wait process) (Dev.Postgres.waitForReadyDevDb db) - case result of - Left _ -> E.throwError $ CommandError "Could not start PostgreSQL" "The Docker process exited before PostgreSQL was ready. Check the database output above." - Right () -> return () - when (request == StartNewDatabase) $ do - cliSendMessageC $ Msg.Info $ "Database URL: " <> Dev.Postgres.getDevConnectionUrl db - cliSendMessageC $ Msg.Info $ "Data volume: " <> db.dockerVolumeName - _ -> return () - action session - prepare = do - InWaspProject waspProjectDir <- require - WaspSpecAvailable <- require - appSpec <- analyze waspProjectDir - customDb <- liftIO $ hasExternalDatabaseUrl appSpec - if customDb - then case request of - StartNewDatabase -> E.throwError $ CommandError "No database to start" "DATABASE_URL points to an external database. Start that database outside Wasp." - EnsureDatabase -> rejectUnusedOptions "DATABASE_URL is set." args >> return (ExistingDatabase NoDatabase) - else case ASV.getValidDbSystem appSpec of - AS.App.Db.SQLite -> case request of - StartNewDatabase -> E.throwError $ CommandError "No database to start" "SQLite uses a local file and needs no separate startup." - EnsureDatabase -> rejectUnusedOptions "This project uses SQLite." args >> return (ExistingDatabase NoDatabase) - AS.App.Db.PostgreSQL -> do - let appName = (ASV.getApp appSpec).name - preparePostgresDevDb waspProjectDir appName args request - - acquire (ExistingDatabase session) = return session - acquire (NewDatabase db image mountPath) = - bracketOnError - (withDatabaseError "Could not start PostgreSQL" $ Dev.Postgres.createDevPostgresDb db image mountPath) - removeContainer - ( \containerId -> do - process <- liftIO $ async $ do - channel <- newChan - fst - <$> concurrently - (runProcessAsJob (proc "docker" ["start", "--attach", containerId]) Job.Db channel) - (printDbMessages channel) - return $ StartedDatabase db containerId process - ) - - release (StartedDatabase _ containerId process) = - stopDatabase containerId `finally` (liftIO (cancel process) `finally` removeContainer containerId) - release _ = return () - - stopDatabase containerId = do - cliSendMessageC $ Msg.Start "Stopping database..." - runDockerCleanup "stop" containerId - -removeContainer :: String -> Command () -removeContainer = runDockerCleanup "rm" - -runDockerCleanup :: String -> String -> Command () -runDockerCleanup operation containerId = do - let args = [operation] ++ ["--force" | operation == "rm"] ++ [containerId] - (status, _, errors) <- liftIO $ readCreateProcessWithExitCode ((proc "docker" args) {create_group = True}) "" - when (status /= ExitSuccess && not ("No such container" `isInfixOf` errors)) $ - if operation == "stop" - then cliSendMessageC $ Msg.Warning "Could not stop PostgreSQL" ("Wasp will try to remove the container. " <> errors) - else cliSendMessageC $ Msg.Warning "Could not remove PostgreSQL container" ("Try `docker rm --force " <> containerId <> "`. " <> errors) - -rejectUnusedOptions :: String -> StartDbArgs -> Command () -rejectUnusedOptions source args = - unless (null options) - $ E.throwError - $ CommandError - "Database options do not apply" - (source <> " These options only apply to Wasp-managed PostgreSQL: " <> intercalate ", " options <> ". Remove them to continue.") - where - options = suppliedOptionNames args - -suppliedOptionNames :: StartDbArgs -> [String] -suppliedOptionNames args = - ["--db-port" | isJust args.dbPort] - ++ ["--db-image" | isJust args.dbImage] - ++ ["--db-volume-mount-path" | isJust args.dbVolumeMountPath] - -requireDockerAvailable :: Command () -requireDockerAvailable = do - (exitCode, _, stderr) <- liftIO $ readProcessWithExitCode "docker" ["info", "--format", "{{.ServerVersion}}"] "" - when (exitCode /= ExitSuccess) - $ E.throwError - $ CommandError "Docker unavailable" ("Start Docker and retry. " <> stderr) - -preparePostgresDevDb :: Path' Abs (Dir WaspProjectDir) -> String -> StartDbArgs -> DatabaseRequest -> Command PreparedDatabase -preparePostgresDevDb waspProjectDir appName args request = do - throwIfExeIsNotAvailable - "docker" - "To run PostgreSQL dev database, Wasp needs `docker` installed and in PATH." - requireDockerAvailable - - liftIO (Dev.Postgres.discoverProjectsRunningDevDb waspProjectDir appName) >>= \case - Just runningDb -> case request of - StartNewDatabase -> - E.throwError $ - CommandError - "PostgreSQL already running" - ( "This project's database is already running. Stop the command that started it, or run `docker stop " - <> runningDb.dockerContainerName - <> "` before starting it again. Database URL: " - <> Dev.Postgres.getDevConnectionUrl runningDb - ) - EnsureDatabase -> ExistingDatabase <$> reportReusedDb runningDb - Nothing -> prepareDbOnPort =<< resolveDevDbPort - where - dbDockerImage = fromMaybe (fst defaultPostgresDockerImageSpec) args.dbImage - dbDockerVolumeMountPath = fromMaybe (snd defaultPostgresDockerImageSpec) args.dbVolumeMountPath - - resolveDevDbPort :: Command PortNumber - resolveDevDbPort = - resolvePort - args.dbPort - defaultPostgresPort - [] - "Choose a different port with --db-port, or free up this one." - "Free at least one of those ports by exiting the program listening on it, or choose the port yourself with --db-port." - - reportReusedDb :: Dev.Postgres.DevDbSpec -> Command DatabaseSession - reportReusedDb devDbSpec = do - withDatabaseError "PostgreSQL is not ready" $ Dev.Postgres.waitForReadyDevDb devDbSpec - cliSendMessageC $ Msg.Info "PostgreSQL was already running for this project. Wasp did not start it and will not stop it." - unless (null $ suppliedOptionNames args) - $ cliSendMessageC - $ Msg.Warning - "Database options not used" - ("These options only apply when starting a new container: " <> intercalate ", " (suppliedOptionNames args) <> ". Stop the running database before changing them.") - return $ ReusedDatabase devDbSpec - - prepareDbOnPort :: PortNumber -> Command PreparedDatabase - prepareDbOnPort port = do - let devDbSpec = Dev.Postgres.makeDevPostgresDbSpec waspProjectDir appName port - ensureImageAvailable - cliSendMessageC $ Msg.Start "Starting PostgreSQL..." - return $ NewDatabase devDbSpec dbDockerImage dbDockerVolumeMountPath - - ensureImageAvailable :: Command () - ensureImageAvailable = do - (imageStatus, _, _) <- liftIO $ readProcessWithExitCode "docker" ["image", "inspect", dbDockerImage] "" - when (imageStatus /= ExitSuccess) $ do - cliSendMessageC $ Msg.Start $ "Pulling PostgreSQL image " <> dbDockerImage <> "..." - pullStatus <- liftIO $ do - channel <- newChan - fst <$> concurrently (runProcessAsJob (proc "docker" ["pull", dbDockerImage]) Job.Db channel) (printDbMessages channel) - when (pullStatus /= ExitSuccess) - $ E.throwError - $ CommandError "Could not pull PostgreSQL image" ("Check the image name, registry access, and network connection. Image: " <> dbDockerImage) - -withDatabaseError :: String -> IO a -> Command a -withDatabaseError title action = do - result <- liftIO $ try action - case result of - Left (err :: IOException) -> E.throwError $ CommandError title $ ioeGetErrorString err - Right value -> return value - -hasExternalDatabaseUrl :: AS.AppSpec -> IO Bool -hasExternalDatabaseUrl appSpec = do - envUrl <- lookupEnv databaseUrlEnvVarName - return $ isJust envUrl || any ((== databaseUrlEnvVarName) . fst) (AS.devEnvVarsServer appSpec) +start = withArguments (ArgsParser "wasp db start" startDbArgsParser) DbLifecycle.start diff --git a/waspc/cli/tests/DbMigrateTest.hs b/waspc/cli/tests/DbMigrateTest.hs index edf18811d91..81ef5088b74 100644 --- a/waspc/cli/tests/DbMigrateTest.hs +++ b/waspc/cli/tests/DbMigrateTest.hs @@ -1,10 +1,9 @@ module DbMigrateTest where -import Data.Either (isLeft) import qualified Options.Applicative as Opt import Test.Hspec +import Wasp.Cli.Command.Db.ArgumentsParser (StartDbArgs (..), startDbArgsParser) import Wasp.Cli.Command.Db.Migrate (migrateArgsParser) -import Wasp.Cli.Command.Start.ArgumentsParser (StartDbArgs (..), startDbArgsParser) import Wasp.Cli.Util.Parser (ArgsParser (optParser)) import Wasp.Generator.DbGenerator.Common (MigrateArgs (..), defaultMigrateArgs) @@ -16,10 +15,6 @@ spec_databaseOptions = do parseOptions ["--db-volume-mount-path=/var/lib/postgresql/data"] `shouldBe` Right (StartDbArgs Nothing Nothing (Just "/var/lib/postgresql/data"), defaultMigrateArgs) parseOptions [] `shouldBe` Right (StartDbArgs Nothing Nothing Nothing, defaultMigrateArgs) - it "rejects missing values and unknown options" $ do - mapM_ - (\args -> isLeft (parseOptions args) `shouldBe` True) - [["--db-port"], ["--db-port", "0"], ["--db-port", "65536"], ["--db-port", "abc"], ["--db-image"], ["--name", "--db-image", "postgres:18"], ["--unknown"]] where parseOptions = parse ((,) <$> startDbArgsParser <*> optParser migrateArgsParser) diff --git a/waspc/e2e-tests/Tests/WaspDbStartTest.hs b/waspc/e2e-tests/Tests/WaspDbStartTest.hs index e3353690ce2..67976edd548 100644 --- a/waspc/e2e-tests/Tests/WaspDbStartTest.hs +++ b/waspc/e2e-tests/Tests/WaspDbStartTest.hs @@ -82,9 +82,7 @@ waspDbStartTest = assertDevDbRemoved, waspCliDbMigrateDev "automatic_start", assertDevDbRemoved, - assertCommandOutputContains - (return "$WASP_CLI_CMD db reset --force") - "PostgreSQL ready.", + return "$WASP_CLI_CMD db reset --force", assertDevDbRemoved, -- Test 6: Can the user remove the volume reported by `wasp db start`? removeReportedDevDbVolume diff --git a/waspc/src/Wasp/Project/Db/Dev/Postgres.hs b/waspc/src/Wasp/Project/Db/Dev/Postgres.hs index db63cceb2be..b2416ead0be 100644 --- a/waspc/src/Wasp/Project/Db/Dev/Postgres.hs +++ b/waspc/src/Wasp/Project/Db/Dev/Postgres.hs @@ -46,18 +46,22 @@ getDevConnectionUrl devDbSpec = createDevPostgresDb :: DevDbSpec -> DockerImageName -> DockerVolumeMountPath -> IO String createDevPostgresDb db image mountPath = do + -- Keep terminal Ctrl+C from stopping Docker before it returns the container ID we need for cleanup. (status, output, errors) <- readCreateProcessWithExitCode ((proc "docker" args) {create_group = True}) "" case (status, words output) of (ExitSuccess, [containerId]) -> return containerId _ -> ioError $ userError $ "Could not create PostgreSQL container. " <> errors where + -- NOTE: POSTGRES_PASSWORD, POSTGRES_USER, POSTGRES_DB below are really used by the docker image + -- only when initializing the database -> if the volume was created previously, they will be ignored. + -- This is how the postgres Docker image works. args = [ "create", "--rm", "--name", db.dockerContainerName, "--publish", - "127.0.0.1:" <> show db.port <> ":" <> show defaultPostgresPort, + show db.port <> ":" <> show defaultPostgresPort, "-v", db.dockerVolumeName <> ":" <> mountPath, "--env", diff --git a/waspc/waspc.cabal b/waspc/waspc.cabal index 58151ca7a61..f7258a41d9a 100644 --- a/waspc/waspc.cabal +++ b/waspc/waspc.cabal @@ -474,6 +474,8 @@ library cli-lib Wasp.Cli.Command.CreateNewProject.StarterTemplates.GhReleaseArchive Wasp.Cli.Command.CreateNewProject.StarterTemplates.Templating Wasp.Cli.Command.Db + Wasp.Cli.Command.Db.ArgumentsParser + Wasp.Cli.Command.Db.Lifecycle Wasp.Cli.Command.Db.Migrate Wasp.Cli.Command.Db.Reset Wasp.Cli.Command.Db.Seed From 8961d9185c6344cc1cb360ae45c8e20bb1e4ce52 Mon Sep 17 00:00:00 2001 From: Mihovil Ilakovac Date: Wed, 7 Oct 2026 12:22:46 +0200 Subject: [PATCH 04/27] Simplify database readiness and formatting and organize database tests --- .../Wasp/Cli/Command/Db/ArgumentsParser.hs | 3 +- .../cli/src/Wasp/Cli/Command/Db/Lifecycle.hs | 59 +++++++------- waspc/cli/src/Wasp/Cli/Command/Start.hs | 3 +- waspc/cli/tests/DbMigrateTest.hs | 2 - waspc/e2e-tests/Tests/WaspDbStartTest.hs | 78 +++++++++--------- waspc/src/Wasp/Project/Db/Dev/Postgres.hs | 80 ++++++++----------- 6 files changed, 108 insertions(+), 117 deletions(-) diff --git a/waspc/cli/src/Wasp/Cli/Command/Db/ArgumentsParser.hs b/waspc/cli/src/Wasp/Cli/Command/Db/ArgumentsParser.hs index 74396819ae5..b8c06fd7ece 100644 --- a/waspc/cli/src/Wasp/Cli/Command/Db/ArgumentsParser.hs +++ b/waspc/cli/src/Wasp/Cli/Command/Db/ArgumentsParser.hs @@ -6,6 +6,7 @@ where import Network.Socket (PortNumber) import qualified Options.Applicative as Opt +import Text.Printf (printf) import Wasp.Cli.Util.PortArgument (portParser) import Wasp.Db.Postgres (defaultPostgresPort) import Wasp.Util.Docker (DockerImageName, DockerVolumeMountPath) @@ -20,7 +21,7 @@ data StartDbArgs = StartDbArgs startDbArgsParser :: Opt.Parser StartDbArgs startDbArgsParser = StartDbArgs - <$> Opt.optional (portParser "db-port" ("Port to run the dev database on (default: " ++ show defaultPostgresPort ++ ")")) + <$> Opt.optional (portParser "db-port" (printf "Port to run the dev database on (default: %s)" (show defaultPostgresPort))) <*> Opt.optional ( Opt.strOption ( Opt.long "db-image" diff --git a/waspc/cli/src/Wasp/Cli/Command/Db/Lifecycle.hs b/waspc/cli/src/Wasp/Cli/Command/Db/Lifecycle.hs index 047bd07aa49..451ea610c86 100644 --- a/waspc/cli/src/Wasp/Cli/Command/Db/Lifecycle.hs +++ b/waspc/cli/src/Wasp/Cli/Command/Db/Lifecycle.hs @@ -19,6 +19,7 @@ import System.Environment (lookupEnv) import System.Exit (ExitCode (..)) import System.IO.Error (ioeGetErrorString) import System.Process (CreateProcess (create_group), proc, readCreateProcessWithExitCode, readProcessWithExitCode) +import Text.Printf (printf) import qualified Wasp.AppSpec as AS import qualified Wasp.AppSpec.App as AS.App import qualified Wasp.AppSpec.App.Db as AS.App.Db @@ -48,6 +49,8 @@ import Wasp.Util.Docker (DockerImageName, DockerVolumeMountPath) start :: StartDbArgs -> Command () start args = withDatabaseSession args StartNewDatabase $ \case + NoDatabase -> + cliSendMessageC $ Msg.Info "Nothing to do! You are all good, you are using SQLite which doesn't need to be started." StartedDatabase _ _ process -> do cliSendMessageC $ Msg.Info "PostgreSQL is running. Ctrl+C stops PostgreSQL." _ <- liftIO $ wait process @@ -100,8 +103,8 @@ withDatabaseSession args request action = do Left _ -> E.throwError $ CommandError "Could not start PostgreSQL" "The Docker process exited before PostgreSQL was ready. Check the database output above." Right () -> return () when (request == StartNewDatabase) $ do - cliSendMessageC $ Msg.Info $ "Database URL: " <> Dev.Postgres.getDevConnectionUrl db - cliSendMessageC $ Msg.Info $ "Data volume: " <> db.dockerVolumeName + cliSendMessageC $ Msg.Info $ printf "Database URL: %s" (Dev.Postgres.getDevConnectionUrl db) + cliSendMessageC $ Msg.Info $ printf "Data volume: %s" db.dockerVolumeName _ -> return () action session prepare = do @@ -115,7 +118,7 @@ withDatabaseSession args request action = do EnsureDatabase -> rejectUnusedOptions "DATABASE_URL is set." args >> return (ExistingDatabase NoDatabase) else case ASV.getValidDbSystem appSpec of AS.App.Db.SQLite -> case request of - StartNewDatabase -> E.throwError $ CommandError "No database to start" "SQLite uses a local file and needs no separate startup." + StartNewDatabase -> return (ExistingDatabase NoDatabase) EnsureDatabase -> rejectUnusedOptions "This project uses SQLite." args >> return (ExistingDatabase NoDatabase) AS.App.Db.PostgreSQL -> do let appName = (ASV.getApp appSpec).name @@ -154,16 +157,16 @@ runDockerCleanup operation containerId = do (status, _, errors) <- liftIO $ readCreateProcessWithExitCode ((proc "docker" args) {create_group = True}) "" when (status /= ExitSuccess && not ("No such container" `isInfixOf` errors)) $ if operation == "stop" - then cliSendMessageC $ Msg.Warning "Could not stop PostgreSQL" ("Wasp will try to remove the container. " <> errors) - else cliSendMessageC $ Msg.Warning "Could not remove PostgreSQL container" ("Try `docker rm --force " <> containerId <> "`. " <> errors) + then cliSendMessageC $ Msg.Warning "Could not stop PostgreSQL" (printf "Wasp will try to remove the container. %s" errors) + else cliSendMessageC $ Msg.Warning "Could not remove PostgreSQL container" (printf "Try `docker rm --force %s`. %s" containerId errors) rejectUnusedOptions :: String -> StartDbArgs -> Command () rejectUnusedOptions source args = - unless (null options) $ - E.throwError $ - CommandError - "Database options do not apply" - (source <> " These options only apply to Wasp-managed PostgreSQL: " <> intercalate ", " options <> ". Remove them to continue.") + unless (null options) + $ E.throwError + $ CommandError + "Database options do not apply" + (printf "%s These options only apply to Wasp-managed PostgreSQL: %s. Remove them to continue." source (intercalate ", " options)) where options = suppliedOptionNames args @@ -176,9 +179,9 @@ suppliedOptionNames args = requireDockerAvailable :: Command () requireDockerAvailable = do (exitCode, _, stderr) <- liftIO $ readProcessWithExitCode "docker" ["info", "--format", "{{.ServerVersion}}"] "" - when (exitCode /= ExitSuccess) $ - E.throwError $ - CommandError "Docker unavailable" ("Start Docker and retry. " <> stderr) + when (exitCode /= ExitSuccess) + $ E.throwError + $ CommandError "Docker unavailable" (printf "Start Docker and retry. %s" stderr) preparePostgresDevDb :: Path' Abs (Dir WaspProjectDir) -> String -> StartDbArgs -> DatabaseRequest -> Command PreparedDatabase preparePostgresDevDb waspProjectDir appName args request = do @@ -193,10 +196,10 @@ preparePostgresDevDb waspProjectDir appName args request = do E.throwError $ CommandError "PostgreSQL already running" - ( "This project's database is already running. Stop the command that started it, or run `docker stop " - <> runningDb.dockerContainerName - <> "` before starting it again. Database URL: " - <> Dev.Postgres.getDevConnectionUrl runningDb + ( printf + "This project's database is already running. Stop the command that started it, or run `docker stop %s` before starting it again. Database URL: %s" + runningDb.dockerContainerName + (Dev.Postgres.getDevConnectionUrl runningDb) ) EnsureDatabase -> ExistingDatabase <$> reportReusedDb runningDb Nothing -> prepareDbOnPort =<< resolveDevDbPort @@ -217,11 +220,11 @@ preparePostgresDevDb waspProjectDir appName args request = do reportReusedDb devDbSpec = do withDatabaseError "PostgreSQL is not ready" $ Dev.Postgres.waitForReadyDevDb devDbSpec cliSendMessageC $ Msg.Info "PostgreSQL was already running for this project. Wasp did not start it and will not stop it." - unless (null $ suppliedOptionNames args) $ - cliSendMessageC $ - Msg.Warning - "Database options not used" - ("These options only apply when starting a new container: " <> intercalate ", " (suppliedOptionNames args) <> ". Stop the running database before changing them.") + unless (null $ suppliedOptionNames args) + $ cliSendMessageC + $ Msg.Warning + "Database options not used" + (printf "These options only apply when starting a new container: %s. Stop the running database before changing them." (intercalate ", " (suppliedOptionNames args))) return $ ReusedDatabase devDbSpec prepareDbOnPort :: PortNumber -> Command PreparedDatabase @@ -238,21 +241,21 @@ preparePostgresDevDb waspProjectDir appName args request = do -- invocation's arguments. dockerRunInfoLines :: [String] dockerRunInfoLines = - [ " ℹ Using Docker image: " <> dbDockerImage, - " with the data volume mounted at: " <> dbDockerVolumeMountPath + [ printf " ℹ Using Docker image: %s" dbDockerImage, + printf " with the data volume mounted at: %s" dbDockerVolumeMountPath ] ensureImageAvailable :: Command () ensureImageAvailable = do (imageStatus, _, _) <- liftIO $ readProcessWithExitCode "docker" ["image", "inspect", dbDockerImage] "" when (imageStatus /= ExitSuccess) $ do - cliSendMessageC $ Msg.Start $ "Pulling PostgreSQL image " <> dbDockerImage <> "..." + cliSendMessageC $ Msg.Start $ printf "Pulling PostgreSQL image %s..." dbDockerImage pullStatus <- liftIO $ do channel <- newChan fst <$> concurrently (runProcessAsJob (proc "docker" ["pull", dbDockerImage]) Job.Db channel) (printDbMessages channel) - when (pullStatus /= ExitSuccess) $ - E.throwError $ - CommandError "Could not pull PostgreSQL image" ("Check the image name, registry access, and network connection. Image: " <> dbDockerImage) + when (pullStatus /= ExitSuccess) + $ E.throwError + $ CommandError "Could not pull PostgreSQL image" (printf "Check the image name, registry access, and network connection. Image: %s" dbDockerImage) withDatabaseError :: String -> IO a -> Command a withDatabaseError title action = do diff --git a/waspc/cli/src/Wasp/Cli/Command/Start.hs b/waspc/cli/src/Wasp/Cli/Command/Start.hs index 09bdfc56371..23f3578de2d 100644 --- a/waspc/cli/src/Wasp/Cli/Command/Start.hs +++ b/waspc/cli/src/Wasp/Cli/Command/Start.hs @@ -9,6 +9,7 @@ import Control.Monad.Except (throwError) import Control.Monad.IO.Class (liftIO) import StrongPath (Abs, Dir, Path', ()) import qualified StrongPath as SP +import Text.Printf (printf) import Wasp.AppComponentUrl (AppComponentUrl) import Wasp.AppSpec (AppSpec) import Wasp.Cli.AppComponentPorts (findAppComponentPorts) @@ -70,7 +71,7 @@ start = withArguments startArgsParser $ \args -> cliSendMessageC $ Msg.Start "Starting up generated project..." let databaseUrlLine = case managedDb of Nothing -> "" - Just db -> " ℹ Database: " <> Dev.Postgres.getDevConnectionUrl db <> "\n" + Just db -> printf " ℹ Database: %s\n" (Dev.Postgres.getDevConnectionUrl db) cliSendMessageC $ Msg.Info $ showRunConfigUrls runConfigs <> databaseUrlLine watchOrStartResult <- liftIO $ do diff --git a/waspc/cli/tests/DbMigrateTest.hs b/waspc/cli/tests/DbMigrateTest.hs index 81ef5088b74..daf60b94c28 100644 --- a/waspc/cli/tests/DbMigrateTest.hs +++ b/waspc/cli/tests/DbMigrateTest.hs @@ -12,8 +12,6 @@ spec_databaseOptions = do it "parses database and migration options together" $ do parseOptions ["--name", "new model", "--db-image", "postgis:18", "--create-only", "--db-port", "5544"] `shouldBe` Right (StartDbArgs (Just 5544) (Just "postgis:18") Nothing, MigrateArgs (Just "new model") True) - parseOptions ["--db-volume-mount-path=/var/lib/postgresql/data"] - `shouldBe` Right (StartDbArgs Nothing Nothing (Just "/var/lib/postgresql/data"), defaultMigrateArgs) parseOptions [] `shouldBe` Right (StartDbArgs Nothing Nothing Nothing, defaultMigrateArgs) where parseOptions = parse ((,) <$> startDbArgsParser <*> optParser migrateArgsParser) diff --git a/waspc/e2e-tests/Tests/WaspDbStartTest.hs b/waspc/e2e-tests/Tests/WaspDbStartTest.hs index 67976edd548..42de28c34f2 100644 --- a/waspc/e2e-tests/Tests/WaspDbStartTest.hs +++ b/waspc/e2e-tests/Tests/WaspDbStartTest.hs @@ -11,6 +11,7 @@ import ShellCommands setWaspDbToPSQL, skipIfDockerDisabled, waspCliDbMigrateDev, + waspCliDbStart, ) import Test (Test (..), TestCase (..)) import Wasp.Cli.Command.CreateNewProject.AvailableTemplates (minimalStarterTemplate) @@ -25,11 +26,11 @@ waspDbStartTest = "fail-outside-project" (return [waspCliDbStartFails]), TestCase - "fail-sqlite-project" + "succeed-sqlite-project" ( sequence [ createTestWaspProject minimalStarterTemplate, inTestWaspProjectDir - [ assertCommandOutputContains (return waspCliDbStartFails) "SQLite uses a local file" + [ waspCliDbStart ] ] ), @@ -50,43 +51,41 @@ waspDbStartTest = "succeed-postgresql-project" ( skipIfDockerDisabled . sequence $ [ createTestWaspProject minimalStarterTemplate, - inTestWaspProjectDir - [ setWaspDbToPSQL, - installDbCleanup, - -- Test 1: Does `wasp db start` work? - waspCliDbStartInBackground, - -- Test 2: Does a Wasp command find the database and connect to it - -- after `wasp db start` says it's ready? - waitUntilDevDbReportsItIsReady, - waspCliDbMigrateDev "first_migration", - assertDevDbRunning, - -- Test 3: Does the second `wasp db start` detect and report - -- an already running dev database? - assertCommandOutputContains - (return "! timeout 30 $WASP_CLI_CMD db start") - "PostgreSQL already running", - -- Test 4: - -- - Does stopping PostgreSQL delete the container? - -- If it didn't delete the container, the next `wasp db start` would fail - -- with a container name conflict. - -- - Does `wasp db start` find a new port when the default one is taken? - stopDevDbAndWait, - occupyDefaultDevDbPort, - waspCliDbStartInBackground, - waitUntilDevDbReportsItIsReady, - -- Test 5: Does a Wasp command find and connect to the database - -- even when it's running on a non-default port? - waspCliDbMigrateDev "no_new_migration", - removeDefaultDevDbPortHolder, - stopDevDbAndWait, - assertDevDbRemoved, - waspCliDbMigrateDev "automatic_start", - assertDevDbRemoved, - return "$WASP_CLI_CMD db reset --force", - assertDevDbRemoved, - -- Test 6: Can the user remove the volume reported by `wasp db start`? - removeReportedDevDbVolume - ] + inTestWaspProjectDir $ + concat + [ [setWaspDbToPSQL, installDbCleanup], + -- Migration reuses a separately started database and leaves it running. + [ waspCliDbStartInBackground, + waitUntilDevDbReportsItIsReady, + waspCliDbMigrateDev "first_migration", + assertDevDbRunning, + assertCommandOutputContains + (return waspCliDbStartFails) + "PostgreSQL already running", + stopDevDbAndWait, + assertDevDbRemoved + ], + -- Startup finds another port when the default is occupied. + [ occupyDefaultDevDbPort, + waspCliDbStartInBackground, + waitUntilDevDbReportsItIsReady, + waspCliDbMigrateDev "no_new_migration", + assertDevDbRunning, + removeDefaultDevDbPortHolder, + stopDevDbAndWait, + assertDevDbRemoved + ], + -- Migration starts and removes its own database. + [ waspCliDbMigrateDev "automatic_start", + assertDevDbRemoved + ], + -- Reset starts and removes its own database. + [ return "$WASP_CLI_CMD db reset --force", + assertDevDbRemoved + ], + -- The reported data volume remains available for explicit removal. + [removeReportedDevDbVolume] + ] ] ) ] @@ -109,6 +108,7 @@ stopDevDbAndWait = ++ reportedDevDbVolumeName ++ "\")\" && { wait \"$(cat db-start.pid)\" || true; } && rm db-start.pid; }" +-- Wasp prints the volume name after its database readiness check succeeds. waitUntilDevDbReportsItIsReady :: ShellCommandBuilder WaspProjectContext ShellCommand waitUntilDevDbReportsItIsReady = return $ diff --git a/waspc/src/Wasp/Project/Db/Dev/Postgres.hs b/waspc/src/Wasp/Project/Db/Dev/Postgres.hs index b2416ead0be..1f01993f4c7 100644 --- a/waspc/src/Wasp/Project/Db/Dev/Postgres.hs +++ b/waspc/src/Wasp/Project/Db/Dev/Postgres.hs @@ -10,14 +10,15 @@ module Wasp.Project.Db.Dev.Postgres ) where -import Control.Concurrent (threadDelay) import Network.Socket (PortNumber) import StrongPath (Abs, Dir, Path') import System.Exit (ExitCode (..)) import System.Process (CreateProcess (create_group), proc, readCreateProcessWithExitCode, readProcessWithExitCode) +import Text.Printf (printf) import Wasp.Db.Postgres (defaultPostgresPort, makeConnectionUrl, postgresMaxDbNameLength) import Wasp.Project.Common (WaspProjectDir, makeAppUniqueId) import Wasp.Util.Docker (DockerImageName, DockerVolumeMountPath, discoverHostPortForDockerContainersInternalPort) +import qualified Wasp.Util.IO.Retry as Retry import qualified Wasp.Util.Network.Socket as Socket data DevDbSpec = DevDbSpec @@ -46,43 +47,39 @@ getDevConnectionUrl devDbSpec = createDevPostgresDb :: DevDbSpec -> DockerImageName -> DockerVolumeMountPath -> IO String createDevPostgresDb db image mountPath = do - -- Keep terminal Ctrl+C from stopping Docker before it returns the container ID we need for cleanup. + -- create_group keeps Docker outside the terminal's Ctrl+C group so it can return the container ID needed for cleanup. (status, output, errors) <- readCreateProcessWithExitCode ((proc "docker" args) {create_group = True}) "" case (status, words output) of (ExitSuccess, [containerId]) -> return containerId - _ -> ioError $ userError $ "Could not create PostgreSQL container. " <> errors + _ -> ioError $ userError $ printf "Could not create PostgreSQL container. %s" errors where -- NOTE: POSTGRES_PASSWORD, POSTGRES_USER, POSTGRES_DB below are really used by the docker image -- only when initializing the database -> if the volume was created previously, they will be ignored. -- This is how the postgres Docker image works. args = - [ "create", - "--rm", - "--name", - db.dockerContainerName, - "--publish", - show db.port <> ":" <> show defaultPostgresPort, - "-v", - db.dockerVolumeName <> ":" <> mountPath, - "--env", - "POSTGRES_PASSWORD=" <> db.password, - "--env", - "POSTGRES_USER=" <> db.user, - "--env", - "POSTGRES_DB=" <> db.dbName, - image - ] + concat + [ ["create", "--rm"], + ["--name", db.dockerContainerName], + ["--publish", printf "%s:%s" (show db.port) (show defaultPostgresPort)], + ["-v", printf "%s:%s" db.dockerVolumeName mountPath], + ["--env", printf "POSTGRES_PASSWORD=%s" db.password], + ["--env", printf "POSTGRES_USER=%s" db.user], + ["--env", printf "POSTGRES_DB=%s" db.dbName], + [image] + ] waitForReadyDevDb :: DevDbSpec -> IO () -waitForReadyDevDb devDbSpec = waitForReady 60 - where - waitForReady :: Int -> IO () - waitForReady 0 = do +waitForReadyDevDb devDbSpec = do + result <- Retry.retry (Retry.constPause 1000000) 59 checkReady + case result of + Right () -> return () + Left () -> do (_, output, errors) <- readProcessWithExitCode "docker" ["logs", "--tail", "30", devDbSpec.dockerContainerName] "" - ioError $ userError $ "PostgreSQL did not become ready. Check the logs below, then try again.\n" <> output <> errors - waitForReady attempts = do + ioError $ userError $ printf "PostgreSQL did not become ready. Check the logs below, then try again.\n%s%s" output errors + where + checkReady = do ready <- isDevDbReady devDbSpec - if ready then return () else threadDelay 1000000 >> waitForReady (attempts - 1) + return $ if ready then Right () else Left () isDevDbReady :: DevDbSpec -> IO Bool isDevDbReady devDbSpec = do @@ -93,27 +90,18 @@ isDevDbReady devDbSpec = do isDevDbConnectionReady :: DevDbSpec -> IO Bool isDevDbConnectionReady devDbSpec = do - (exitCode, output, _) <- - readProcessWithExitCode - "docker" - [ "exec", - "--env", - "PGPASSWORD=" <> devDbSpec.password, - devDbSpec.dockerContainerName, - "psql", - "-h", - "127.0.0.1", - "-U", - devDbSpec.user, - "-d", - devDbSpec.dbName, - "-t", - "-A", - "-c", - "SELECT 1" - ] - "" + (exitCode, output, _) <- readProcessWithExitCode "docker" args "" return $ exitCode == ExitSuccess && output == "1\n" + where + args = + concat + [ ["exec", "--env", printf "PGPASSWORD=%s" devDbSpec.password], + [devDbSpec.dockerContainerName, "psql"], + ["-h", "127.0.0.1"], + ["-U", devDbSpec.user], + ["-d", devDbSpec.dbName], + ["-t", "-A", "-c", "SELECT 1"] + ] -- | Returns all relevant info about this Wasp project's dev detabase if its -- container is running, 'Nothing' otherwise. From 25c33091781d1fb8a081cf26c95c08f0b42110f8 Mon Sep 17 00:00:00 2001 From: Mihovil Ilakovac Date: Wed, 7 Oct 2026 15:18:13 +0200 Subject: [PATCH 05/27] Clarify database startup options and restore database guidance --- waspc/cli/src/Wasp/Cli/Command/Db.hs | 8 +- .../cli/src/Wasp/Cli/Command/Db/Lifecycle.hs | 76 ++++++++++++++----- .../{ArgumentsParser.hs => StartOptions.hs} | 14 ++-- waspc/cli/src/Wasp/Cli/Command/Start.hs | 2 +- .../Wasp/Cli/Command/Start/ArgumentsParser.hs | 6 +- waspc/cli/src/Wasp/Cli/Command/Start/Db.hs | 4 +- waspc/cli/tests/DbMigrateTest.hs | 8 +- waspc/e2e-tests/Tests/WaspDbStartTest.hs | 4 +- waspc/waspc.cabal | 2 +- 9 files changed, 80 insertions(+), 44 deletions(-) rename waspc/cli/src/Wasp/Cli/Command/Db/{ArgumentsParser.hs => StartOptions.hs} (81%) diff --git a/waspc/cli/src/Wasp/Cli/Command/Db.hs b/waspc/cli/src/Wasp/Cli/Command/Db.hs index 7443e88df21..af9b6e2dcb9 100644 --- a/waspc/cli/src/Wasp/Cli/Command/Db.hs +++ b/waspc/cli/src/Wasp/Cli/Command/Db.hs @@ -11,7 +11,7 @@ import Wasp.Cli.Command.Compile (defaultCompileOptions, withSetupGoals) import Wasp.Cli.Command.Require.DbConnectionEstablished (DbConnectionEstablished (DbConnectionEstablished)) import Wasp.Cli.Command.Require.InWaspProject (InWaspProject (InWaspProject)) import Wasp.Cli.Command.Require.WaspSpecAvailable (WaspSpecAvailable (WaspSpecAvailable)) -import Wasp.Cli.Command.Db.ArgumentsParser (startDbArgsParser) +import Wasp.Cli.Command.Db.StartOptions (dbStartOptionsParser) import qualified Wasp.Cli.Command.Db.Lifecycle as DbLifecycle import Wasp.Cli.Compile (waitEnsureCompile) import Wasp.Cli.Util.Parser (ArgsParser (..), withArguments) @@ -21,9 +21,9 @@ runCommandThatRequiresDbRunning :: ArgsParser a -> (a -> Command ()) -> Argument runCommandThatRequiresDbRunning parser command args = runCommand $ withArguments databaseArgsParser run args where - databaseArgsParser = parser {optParser = (,) <$> startDbArgsParser <*> parser.optParser} - run (dbArgs, commandArgs) = - DbLifecycle.withManagedDb dbArgs $ \_ -> command commandArgs + databaseArgsParser = parser {optParser = (,) <$> dbStartOptionsParser <*> parser.optParser} + run (dbStartOptions, commandArgs) = + DbLifecycle.withManagedDb dbStartOptions $ \_ -> command commandArgs -- | Prepares what a db command needs before it runs: a compile, -- post-compile setup, and a reachable database. diff --git a/waspc/cli/src/Wasp/Cli/Command/Db/Lifecycle.hs b/waspc/cli/src/Wasp/Cli/Command/Db/Lifecycle.hs index 451ea610c86..0e6c8e72a43 100644 --- a/waspc/cli/src/Wasp/Cli/Command/Db/Lifecycle.hs +++ b/waspc/cli/src/Wasp/Cli/Command/Db/Lifecycle.hs @@ -14,7 +14,7 @@ import Control.Monad.IO.Class (liftIO) import Data.List (intercalate, isInfixOf) import Data.Maybe (fromMaybe, isJust) import Network.Socket (PortNumber) -import StrongPath (Abs, Dir, Path') +import StrongPath (Abs, Dir, File', Path', Rel, fromRelFile) import System.Environment (lookupEnv) import System.Exit (ExitCode (..)) import System.IO.Error (ioeGetErrorString) @@ -27,7 +27,7 @@ import qualified Wasp.AppSpec.Valid as ASV import Wasp.Cli.Command (Command, CommandError (CommandError), require) import Wasp.Cli.Command.Common (throwIfExeIsNotAvailable) import Wasp.Cli.Command.Compile (analyze) -import Wasp.Cli.Command.Db.ArgumentsParser (StartDbArgs (..)) +import Wasp.Cli.Command.Db.StartOptions (DbStartOptions (..)) import Wasp.Cli.Command.Message (cliSendMessageC) import Wasp.Cli.Command.Require.InWaspProject (InWaspProject (InWaspProject)) import Wasp.Cli.Command.Require.WaspSpecAvailable (WaspSpecAvailable (WaspSpecAvailable)) @@ -40,13 +40,14 @@ import qualified Wasp.Message as Msg import Wasp.Project.Common (WaspProjectDir) import Wasp.Project.Db (databaseUrlEnvVarName) import qualified Wasp.Project.Db.Dev.Postgres as Dev.Postgres +import Wasp.Project.Env (dotEnvServer) import Wasp.Util.Docker (DockerImageName, DockerVolumeMountPath) -- | Starts a "managed" dev database, where "managed" means that -- Wasp creates it and connects the Wasp app with it. -- Wasp is smart while doing this so it checks which database is specified -- in Wasp configuration and spins up a database of appropriate type. -start :: StartDbArgs -> Command () +start :: DbStartOptions -> Command () start args = withDatabaseSession args StartNewDatabase $ \case NoDatabase -> @@ -68,7 +69,7 @@ printDbMessages channel = runPrefixedWriter go go Job.JobExit _ -> return () -withManagedDb :: StartDbArgs -> (Maybe Dev.Postgres.DevDbSpec -> Command a) -> Command a +withManagedDb :: DbStartOptions -> (Maybe Dev.Postgres.DevDbSpec -> Command a) -> Command a withManagedDb args action = withDatabaseSession args EnsureDatabase (action . databaseForSession) data DatabaseRequest = StartNewDatabase | EnsureDatabase @@ -88,7 +89,7 @@ databaseForSession NoDatabase = Nothing databaseForSession (ReusedDatabase db) = Just db databaseForSession (StartedDatabase db _ _) = Just db -withDatabaseSession :: StartDbArgs -> DatabaseRequest -> (DatabaseSession -> Command a) -> Command a +withDatabaseSession :: DbStartOptions -> DatabaseRequest -> (DatabaseSession -> Command a) -> Command a withDatabaseSession args request action = do prepared <- prepare bracket (acquire prepared) release use @@ -102,21 +103,23 @@ withDatabaseSession args request action = do case result of Left _ -> E.throwError $ CommandError "Could not start PostgreSQL" "The Docker process exited before PostgreSQL was ready. Check the database output above." Right () -> return () - when (request == StartNewDatabase) $ do - cliSendMessageC $ Msg.Info $ printf "Database URL: %s" (Dev.Postgres.getDevConnectionUrl db) - cliSendMessageC $ Msg.Info $ printf "Data volume: %s" db.dockerVolumeName + when (request == StartNewDatabase) + $ cliSendMessageC + $ Msg.Info + $ unlines + $ additionalInfoLines db _ -> return () action session prepare = do InWaspProject waspProjectDir <- require WaspSpecAvailable <- require appSpec <- analyze waspProjectDir - customDb <- liftIO $ hasExternalDatabaseUrl appSpec - if customDb - then case request of - StartNewDatabase -> E.throwError $ CommandError "No database to start" "DATABASE_URL points to an external database. Start that database outside Wasp." + customDbError <- liftIO $ customDatabaseError appSpec + case customDbError of + Just err -> case request of + StartNewDatabase -> E.throwError err EnsureDatabase -> rejectUnusedOptions "DATABASE_URL is set." args >> return (ExistingDatabase NoDatabase) - else case ASV.getValidDbSystem appSpec of + Nothing -> case ASV.getValidDbSystem appSpec of AS.App.Db.SQLite -> case request of StartNewDatabase -> return (ExistingDatabase NoDatabase) EnsureDatabase -> rejectUnusedOptions "This project uses SQLite." args >> return (ExistingDatabase NoDatabase) @@ -160,7 +163,7 @@ runDockerCleanup operation containerId = do then cliSendMessageC $ Msg.Warning "Could not stop PostgreSQL" (printf "Wasp will try to remove the container. %s" errors) else cliSendMessageC $ Msg.Warning "Could not remove PostgreSQL container" (printf "Try `docker rm --force %s`. %s" containerId errors) -rejectUnusedOptions :: String -> StartDbArgs -> Command () +rejectUnusedOptions :: String -> DbStartOptions -> Command () rejectUnusedOptions source args = unless (null options) $ E.throwError @@ -170,7 +173,7 @@ rejectUnusedOptions source args = where options = suppliedOptionNames args -suppliedOptionNames :: StartDbArgs -> [String] +suppliedOptionNames :: DbStartOptions -> [String] suppliedOptionNames args = ["--db-port" | isJust args.dbPort] ++ ["--db-image" | isJust args.dbImage] @@ -183,7 +186,7 @@ requireDockerAvailable = do $ E.throwError $ CommandError "Docker unavailable" (printf "Start Docker and retry. %s" stderr) -preparePostgresDevDb :: Path' Abs (Dir WaspProjectDir) -> String -> StartDbArgs -> DatabaseRequest -> Command PreparedDatabase +preparePostgresDevDb :: Path' Abs (Dir WaspProjectDir) -> String -> DbStartOptions -> DatabaseRequest -> Command PreparedDatabase preparePostgresDevDb waspProjectDir appName args request = do throwIfExeIsNotAvailable "docker" @@ -197,9 +200,10 @@ preparePostgresDevDb waspProjectDir appName args request = do CommandError "PostgreSQL already running" ( printf - "This project's database is already running. Stop the command that started it, or run `docker stop %s` before starting it again. Database URL: %s" + "This project's database is already running on port %s. Stop the command that started it, or run `docker stop %s` before starting it again.\n%s" + (show runningDb.port) runningDb.dockerContainerName - (Dev.Postgres.getDevConnectionUrl runningDb) + (unlines $ additionalInfoLines runningDb) ) EnsureDatabase -> ExistingDatabase <$> reportReusedDb runningDb Nothing -> prepareDbOnPort =<< resolveDevDbPort @@ -264,7 +268,37 @@ withDatabaseError title action = do Left (err :: IOException) -> E.throwError $ CommandError title $ ioeGetErrorString err Right value -> return value -hasExternalDatabaseUrl :: AS.AppSpec -> IO Bool -hasExternalDatabaseUrl appSpec = do +additionalInfoLines :: Dev.Postgres.DevDbSpec -> [String] +additionalInfoLines db = + [ "", + "Additional info:", + " ℹ Connection URL, in case you might want to connect with external tools:", + printf " %s" (Dev.Postgres.getDevConnectionUrl db), + " ℹ Database data is persisted in a Docker volume with the following name", + " (useful to know if you will want to delete it at some point):", + printf " %s" db.dockerVolumeName + ] + +customDatabaseError :: AS.AppSpec -> IO (Maybe CommandError) +customDatabaseError appSpec = do envUrl <- lookupEnv databaseUrlEnvVarName - return $ isJust envUrl || any ((== databaseUrlEnvVarName) . fst) (AS.devEnvVarsServer appSpec) + return $ + if isJust envUrl + then + Just + $ errorWithMessage + $ printf + "Wasp has detected existing %s var in your environment.\nTo have Wasp run the dev database for you, make sure you remove that env var first." + databaseUrlEnvVarName + else + if any ((== databaseUrlEnvVarName) . fst) appSpec.devEnvVarsServer + then + Just + $ errorWithMessage + $ printf + "Wasp has detected that you have defined %s env var in your %s file.\nTo have Wasp run the dev database for you, make sure you remove that env var first." + databaseUrlEnvVarName + (fromRelFile (dotEnvServer :: Path' (Rel WaspProjectDir) File')) + else Nothing + where + errorWithMessage = CommandError "You are using custom database already" diff --git a/waspc/cli/src/Wasp/Cli/Command/Db/ArgumentsParser.hs b/waspc/cli/src/Wasp/Cli/Command/Db/StartOptions.hs similarity index 81% rename from waspc/cli/src/Wasp/Cli/Command/Db/ArgumentsParser.hs rename to waspc/cli/src/Wasp/Cli/Command/Db/StartOptions.hs index b8c06fd7ece..d0b7dcd5262 100644 --- a/waspc/cli/src/Wasp/Cli/Command/Db/ArgumentsParser.hs +++ b/waspc/cli/src/Wasp/Cli/Command/Db/StartOptions.hs @@ -1,6 +1,6 @@ -module Wasp.Cli.Command.Db.ArgumentsParser - ( StartDbArgs (..), - startDbArgsParser, +module Wasp.Cli.Command.Db.StartOptions + ( DbStartOptions (..), + dbStartOptionsParser, ) where @@ -11,16 +11,16 @@ import Wasp.Cli.Util.PortArgument (portParser) import Wasp.Db.Postgres (defaultPostgresPort) import Wasp.Util.Docker (DockerImageName, DockerVolumeMountPath) -data StartDbArgs = StartDbArgs +data DbStartOptions = DbStartOptions { dbPort :: Maybe PortNumber, dbImage :: Maybe DockerImageName, dbVolumeMountPath :: Maybe DockerVolumeMountPath } deriving (Eq, Show) -startDbArgsParser :: Opt.Parser StartDbArgs -startDbArgsParser = - StartDbArgs +dbStartOptionsParser :: Opt.Parser DbStartOptions +dbStartOptionsParser = + DbStartOptions <$> Opt.optional (portParser "db-port" (printf "Port to run the dev database on (default: %s)" (show defaultPostgresPort))) <*> Opt.optional ( Opt.strOption diff --git a/waspc/cli/src/Wasp/Cli/Command/Start.hs b/waspc/cli/src/Wasp/Cli/Command/Start.hs index 23f3578de2d..f7eeb28c01d 100644 --- a/waspc/cli/src/Wasp/Cli/Command/Start.hs +++ b/waspc/cli/src/Wasp/Cli/Command/Start.hs @@ -42,7 +42,7 @@ import qualified Wasp.Project.Env as Env -- It also listens for any file changes and recompiles and restarts generated project accordingly. start :: Arguments -> Command () start = withArguments startArgsParser $ \args -> - ProjectLock.acquireWatcher $ \projectLock -> DbLifecycle.withManagedDb args.dbArgs $ \managedDb -> do + ProjectLock.acquireWatcher $ \projectLock -> DbLifecycle.withManagedDb args.dbStartOptions $ \managedDb -> do -- We check for the news only in `wasp start`, and only periodically, -- to avoid being too aggressive. Specifically: -- - We don't run it in other `wasp` commands because we don't want to diff --git a/waspc/cli/src/Wasp/Cli/Command/Start/ArgumentsParser.hs b/waspc/cli/src/Wasp/Cli/Command/Start/ArgumentsParser.hs index bea5b0195e9..ed4bf69e6bd 100644 --- a/waspc/cli/src/Wasp/Cli/Command/Start/ArgumentsParser.hs +++ b/waspc/cli/src/Wasp/Cli/Command/Start/ArgumentsParser.hs @@ -7,7 +7,7 @@ where import Network.Socket (PortNumber) import Network.URI (URI) import qualified Options.Applicative as Opt -import Wasp.Cli.Command.Db.ArgumentsParser (StartDbArgs, startDbArgsParser) +import Wasp.Cli.Command.Db.StartOptions (DbStartOptions, dbStartOptionsParser) import Wasp.Cli.Util.HttpUrlArgument (httpUrlParser) import Wasp.Cli.Util.Parser (ArgsParser (..)) import Wasp.Cli.Util.PortArgument (portParser) @@ -17,7 +17,7 @@ data StartArgs = StartArgs serverPort :: Maybe PortNumber, clientUrl :: Maybe URI, serverUrl :: Maybe URI, - dbArgs :: StartDbArgs + dbStartOptions :: DbStartOptions } deriving (Eq, Show) @@ -29,4 +29,4 @@ startArgsParser = <*> Opt.optional (portParser "server-port" "Port to run the server on") <*> Opt.optional (httpUrlParser "client-url" "URL at which the client is reachable") <*> Opt.optional (httpUrlParser "server-url" "URL at which the server is reachable") - <*> startDbArgsParser + <*> dbStartOptionsParser diff --git a/waspc/cli/src/Wasp/Cli/Command/Start/Db.hs b/waspc/cli/src/Wasp/Cli/Command/Start/Db.hs index 1e001df0453..f6866dedafe 100644 --- a/waspc/cli/src/Wasp/Cli/Command/Start/Db.hs +++ b/waspc/cli/src/Wasp/Cli/Command/Start/Db.hs @@ -5,9 +5,9 @@ where import Wasp.Cli.Command (Command) import Wasp.Cli.Command.Call (Arguments) -import Wasp.Cli.Command.Db.ArgumentsParser (startDbArgsParser) import qualified Wasp.Cli.Command.Db.Lifecycle as DbLifecycle +import Wasp.Cli.Command.Db.StartOptions (dbStartOptionsParser) import Wasp.Cli.Util.Parser (ArgsParser (..), withArguments) start :: Arguments -> Command () -start = withArguments (ArgsParser "wasp db start" startDbArgsParser) DbLifecycle.start +start = withArguments (ArgsParser "wasp db start" dbStartOptionsParser) DbLifecycle.start diff --git a/waspc/cli/tests/DbMigrateTest.hs b/waspc/cli/tests/DbMigrateTest.hs index daf60b94c28..a297c0badb8 100644 --- a/waspc/cli/tests/DbMigrateTest.hs +++ b/waspc/cli/tests/DbMigrateTest.hs @@ -2,8 +2,8 @@ module DbMigrateTest where import qualified Options.Applicative as Opt import Test.Hspec -import Wasp.Cli.Command.Db.ArgumentsParser (StartDbArgs (..), startDbArgsParser) import Wasp.Cli.Command.Db.Migrate (migrateArgsParser) +import Wasp.Cli.Command.Db.StartOptions (DbStartOptions (..), dbStartOptionsParser) import Wasp.Cli.Util.Parser (ArgsParser (optParser)) import Wasp.Generator.DbGenerator.Common (MigrateArgs (..), defaultMigrateArgs) @@ -11,10 +11,10 @@ spec_databaseOptions :: Spec spec_databaseOptions = do it "parses database and migration options together" $ do parseOptions ["--name", "new model", "--db-image", "postgis:18", "--create-only", "--db-port", "5544"] - `shouldBe` Right (StartDbArgs (Just 5544) (Just "postgis:18") Nothing, MigrateArgs (Just "new model") True) - parseOptions [] `shouldBe` Right (StartDbArgs Nothing Nothing Nothing, defaultMigrateArgs) + `shouldBe` Right (DbStartOptions (Just 5544) (Just "postgis:18") Nothing, MigrateArgs (Just "new model") True) + parseOptions [] `shouldBe` Right (DbStartOptions Nothing Nothing Nothing, defaultMigrateArgs) where - parseOptions = parse ((,) <$> startDbArgsParser <*> optParser migrateArgsParser) + parseOptions = parse ((,) <$> dbStartOptionsParser <*> optParser migrateArgsParser) parse :: Opt.Parser a -> [String] -> Either String a parse parser args = diff --git a/waspc/e2e-tests/Tests/WaspDbStartTest.hs b/waspc/e2e-tests/Tests/WaspDbStartTest.hs index 42de28c34f2..3e1e5741587 100644 --- a/waspc/e2e-tests/Tests/WaspDbStartTest.hs +++ b/waspc/e2e-tests/Tests/WaspDbStartTest.hs @@ -112,7 +112,9 @@ stopDevDbAndWait = waitUntilDevDbReportsItIsReady :: ShellCommandBuilder WaspProjectContext ShellCommand waitUntilDevDbReportsItIsReady = return $ - "{ retries=180; until grep -q 'Data volume:' " + "{ retries=180; until grep -q '" + ++ Dev.Postgres.waspDevDbDockerVolumePrefix + ++ "' " ++ devDbOutputFile ++ "; do retries=$((retries - 1)); [ \"$retries\" -gt 0 ] || exit 1; sleep 1; done ; }" diff --git a/waspc/waspc.cabal b/waspc/waspc.cabal index f7258a41d9a..155c8fb7a4b 100644 --- a/waspc/waspc.cabal +++ b/waspc/waspc.cabal @@ -474,11 +474,11 @@ library cli-lib Wasp.Cli.Command.CreateNewProject.StarterTemplates.GhReleaseArchive Wasp.Cli.Command.CreateNewProject.StarterTemplates.Templating Wasp.Cli.Command.Db - Wasp.Cli.Command.Db.ArgumentsParser Wasp.Cli.Command.Db.Lifecycle Wasp.Cli.Command.Db.Migrate Wasp.Cli.Command.Db.Reset Wasp.Cli.Command.Db.Seed + Wasp.Cli.Command.Db.StartOptions Wasp.Cli.Command.Db.Studio Wasp.Cli.Command.Deploy Wasp.Cli.Command.Deps From 279d1ff49cdc962a7c61e1a3f1a957a7c657902a Mon Sep 17 00:00:00 2001 From: Mihovil Ilakovac Date: Wed, 7 Oct 2026 15:30:11 +0200 Subject: [PATCH 06/27] Split database lifecycle scenarios into independent tests --- waspc/e2e-tests/Tests/WaspDbStartTest.hs | 126 +++++++++++++---------- 1 file changed, 70 insertions(+), 56 deletions(-) diff --git a/waspc/e2e-tests/Tests/WaspDbStartTest.hs b/waspc/e2e-tests/Tests/WaspDbStartTest.hs index 3e1e5741587..54b37ecff6b 100644 --- a/waspc/e2e-tests/Tests/WaspDbStartTest.hs +++ b/waspc/e2e-tests/Tests/WaspDbStartTest.hs @@ -45,60 +45,63 @@ waspDbStartTest = ] ] ), - -- NOTE: Tasty runs test cases in parallel, so the PostgreSQL scenarios (which - -- compete for the same host ports) are all in a single sequential test case. - TestCase - "succeed-postgresql-project" - ( skipIfDockerDisabled . sequence $ - [ createTestWaspProject minimalStarterTemplate, - inTestWaspProjectDir $ - concat - [ [setWaspDbToPSQL, installDbCleanup], - -- Migration reuses a separately started database and leaves it running. - [ waspCliDbStartInBackground, - waitUntilDevDbReportsItIsReady, - waspCliDbMigrateDev "first_migration", - assertDevDbRunning, - assertCommandOutputContains - (return waspCliDbStartFails) - "PostgreSQL already running", - stopDevDbAndWait, - assertDevDbRemoved - ], - -- Startup finds another port when the default is occupied. - [ occupyDefaultDevDbPort, - waspCliDbStartInBackground, - waitUntilDevDbReportsItIsReady, - waspCliDbMigrateDev "no_new_migration", - assertDevDbRunning, - removeDefaultDevDbPortHolder, - stopDevDbAndWait, - assertDevDbRemoved - ], - -- Migration starts and removes its own database. - [ waspCliDbMigrateDev "automatic_start", - assertDevDbRemoved - ], - -- Reset starts and removes its own database. - [ return "$WASP_CLI_CMD db reset --force", - assertDevDbRemoved - ], - -- The reported data volume remains available for explicit removal. - [removeReportedDevDbVolume] - ] - ] - ) + postgresTestCase + "migration-reuses-running-database" + [ waspCliDbStartInBackground (Just 15432), + waitUntilDevDbReportsItIsReady, + waspCliDbMigrateDev "first_migration", + assertDevDbRunning, + assertCommandOutputContains + (return waspCliDbStartFails) + "PostgreSQL already running", + stopDevDbAndWait, + assertDevDbRemoved, + removeReportedDevDbVolume + ], + postgresTestCase + "startup-uses-another-port-when-default-is-occupied" + [ occupyDefaultDevDbPort, + waspCliDbStartInBackground Nothing, + waitUntilDevDbReportsItIsReady, + waspCliDbMigrateDev "first_migration", + assertDevDbRunning, + removeDefaultDevDbPortHolder, + stopDevDbAndWait, + assertDevDbRemoved, + removeReportedDevDbVolume + ], + postgresTestCase + "migration-starts-and-removes-database" + [ return "$WASP_CLI_CMD db migrate-dev --name first_migration --db-port 15433", + assertDevDbRemoved + ], + postgresTestCase + "reset-starts-and-removes-database" + [ return "$WASP_CLI_CMD db reset --force --db-port 15434", + assertDevDbRemoved + ] ] where waspCliDbStartFails :: ShellCommand waspCliDbStartFails = "! $WASP_CLI_CMD db start" +postgresTestCase :: String -> [ShellCommandBuilder WaspProjectContext ShellCommand] -> TestCase +postgresTestCase name commands = + TestCase name + $ skipIfDockerDisabled + $ sequence + [ createTestWaspProject minimalStarterTemplate, + inTestWaspProjectDir $ [setWaspDbToPSQL, installDbCleanup] ++ commands + ] + -- | `wasp db start` runs the database in the foreground, so we background it. -- We capture its output to test whether it correctly reports its readiness and volume name. -waspCliDbStartInBackground :: ShellCommandBuilder WaspProjectContext ShellCommand -waspCliDbStartInBackground = +waspCliDbStartInBackground :: Maybe Int -> ShellCommandBuilder WaspProjectContext ShellCommand +waspCliDbStartInBackground port = return $ - "rm -f " ++ devDbOutputFile ++ " && { $WASP_CLI_CMD db start > " ++ devDbOutputFile ++ " 2>&1 & echo $! > db-start.pid ; }" + "rm -f " ++ devDbOutputFile ++ " && { $WASP_CLI_CMD db start" ++ portOption ++ " > " ++ devDbOutputFile ++ " 2>&1 & echo $! > db-start.pid ; }" + where + portOption = maybe "" ((" --db-port " ++) . show) port -- Stop PostgreSQL directly so this test does not depend on terminal signal forwarding. stopDevDbAndWait :: ShellCommandBuilder WaspProjectContext ShellCommand @@ -122,10 +125,11 @@ devDbOutputFile :: FilePath devDbOutputFile = "db-start-output.log" occupyDefaultDevDbPort :: ShellCommandBuilder WaspProjectContext ShellCommand -occupyDefaultDevDbPort = +occupyDefaultDevDbPort = do + containerName <- devDbPortHolderContainerName return $ "docker run -d --rm --name " - ++ devDbPortHolderContainerName + ++ containerName ++ " -p " ++ defaultPort ++ ":" @@ -135,7 +139,7 @@ occupyDefaultDevDbPort = defaultPort = show defaultPostgresPort removeDefaultDevDbPortHolder :: ShellCommandBuilder WaspProjectContext ShellCommand -removeDefaultDevDbPortHolder = return $ "docker rm -f " ++ devDbPortHolderContainerName +removeDefaultDevDbPortHolder = ("docker rm -f " ++) <$> devDbPortHolderContainerName removeReportedDevDbVolume :: ShellCommandBuilder WaspProjectContext ShellCommand removeReportedDevDbVolume = @@ -147,24 +151,34 @@ reportedDevDbVolumeName :: String reportedDevDbVolumeName = "$(grep -o -m 1 '" ++ Dev.Postgres.waspDevDbDockerVolumePrefix ++ "[a-zA-Z0-9_-]*' " ++ devDbOutputFile ++ ")" -devDbPortHolderContainerName :: String -devDbPortHolderContainerName = "wasp-e2e-tests-db-port-holder" +devDbPortHolderContainerName :: ShellCommandBuilder WaspProjectContext String +devDbPortHolderContainerName = do + db <- testDevDb + return $ db.dockerContainerName ++ "-port-holder" + +testDevDb :: ShellCommandBuilder WaspProjectContext Dev.Postgres.DevDbSpec +testDevDb = do + context <- ask + return $ Dev.Postgres.makeDevPostgresDbSpec context.waspProjectDir "waspApp" defaultPostgresPort assertDevDbRunning :: ShellCommandBuilder WaspProjectContext ShellCommand assertDevDbRunning = return $ "test -n \"$(docker ps -q --filter \"volume=" ++ reportedDevDbVolumeName ++ "\")\"" assertDevDbRemoved :: ShellCommandBuilder WaspProjectContext ShellCommand -assertDevDbRemoved = - return $ "test -z \"$(docker ps -aq --filter \"volume=" ++ reportedDevDbVolumeName ++ "\")\"" +assertDevDbRemoved = do + db <- testDevDb + return $ "test -z \"$(docker ps -aq --filter \"volume=" ++ db.dockerVolumeName ++ "\")\"" installDbCleanup :: ShellCommandBuilder WaspProjectContext ShellCommand installDbCleanup = do - context <- ask - let db = Dev.Postgres.makeDevPostgresDbSpec context.waspProjectDir "waspApp" defaultPostgresPort + db <- testDevDb + portHolder <- devDbPortHolderContainerName return $ "trap 'if [ -f db-start.pid ]; then kill \"$(cat db-start.pid)\" 2>/dev/null || true; wait \"$(cat db-start.pid)\" 2>/dev/null || true; fi; docker rm -f " ++ db.dockerContainerName ++ " " - ++ devDbPortHolderContainerName + ++ portHolder + ++ " >/dev/null 2>&1 || true; docker volume rm " + ++ db.dockerVolumeName ++ " >/dev/null 2>&1 || true' EXIT" From 00fae0b3c88ce10d5ca8b3b332d89709b012b2b5 Mon Sep 17 00:00:00 2001 From: Mihovil Ilakovac Date: Wed, 7 Oct 2026 15:30:11 +0200 Subject: [PATCH 07/27] Select development database before entering PostgreSQL session --- waspc/cli/src/Wasp/Cli/Command/Db.hs | 4 +- .../Cli/Command/Db/{Lifecycle.hs => DevDb.hs} | 83 ++++++++++--------- waspc/cli/src/Wasp/Cli/Command/Start.hs | 4 +- waspc/cli/src/Wasp/Cli/Command/Start/Db.hs | 4 +- waspc/waspc.cabal | 2 +- 5 files changed, 51 insertions(+), 46 deletions(-) rename waspc/cli/src/Wasp/Cli/Command/Db/{Lifecycle.hs => DevDb.hs} (84%) diff --git a/waspc/cli/src/Wasp/Cli/Command/Db.hs b/waspc/cli/src/Wasp/Cli/Command/Db.hs index af9b6e2dcb9..296c6296eda 100644 --- a/waspc/cli/src/Wasp/Cli/Command/Db.hs +++ b/waspc/cli/src/Wasp/Cli/Command/Db.hs @@ -12,7 +12,7 @@ import Wasp.Cli.Command.Require.DbConnectionEstablished (DbConnectionEstablished import Wasp.Cli.Command.Require.InWaspProject (InWaspProject (InWaspProject)) import Wasp.Cli.Command.Require.WaspSpecAvailable (WaspSpecAvailable (WaspSpecAvailable)) import Wasp.Cli.Command.Db.StartOptions (dbStartOptionsParser) -import qualified Wasp.Cli.Command.Db.Lifecycle as DbLifecycle +import qualified Wasp.Cli.Command.Db.DevDb as DevDb import Wasp.Cli.Compile (waitEnsureCompile) import Wasp.Cli.Util.Parser (ArgsParser (..), withArguments) import Wasp.Generator.Setup (SetupGoal) @@ -23,7 +23,7 @@ runCommandThatRequiresDbRunning parser command args = where databaseArgsParser = parser {optParser = (,) <$> dbStartOptionsParser <*> parser.optParser} run (dbStartOptions, commandArgs) = - DbLifecycle.withManagedDb dbStartOptions $ \_ -> command commandArgs + DevDb.withDevDb dbStartOptions $ \_ -> command commandArgs -- | Prepares what a db command needs before it runs: a compile, -- post-compile setup, and a reachable database. diff --git a/waspc/cli/src/Wasp/Cli/Command/Db/Lifecycle.hs b/waspc/cli/src/Wasp/Cli/Command/Db/DevDb.hs similarity index 84% rename from waspc/cli/src/Wasp/Cli/Command/Db/Lifecycle.hs rename to waspc/cli/src/Wasp/Cli/Command/Db/DevDb.hs index 0e6c8e72a43..a4c1b572447 100644 --- a/waspc/cli/src/Wasp/Cli/Command/Db/Lifecycle.hs +++ b/waspc/cli/src/Wasp/Cli/Command/Db/DevDb.hs @@ -1,6 +1,6 @@ -module Wasp.Cli.Command.Db.Lifecycle +module Wasp.Cli.Command.Db.DevDb ( start, - withManagedDb, + withDevDb, ) where @@ -48,15 +48,24 @@ import Wasp.Util.Docker (DockerImageName, DockerVolumeMountPath) -- Wasp is smart while doing this so it checks which database is specified -- in Wasp configuration and spins up a database of appropriate type. start :: DbStartOptions -> Command () -start args = - withDatabaseSession args StartNewDatabase $ \case - NoDatabase -> - cliSendMessageC $ Msg.Info "Nothing to do! You are all good, you are using SQLite which doesn't need to be started." - StartedDatabase _ _ process -> do - cliSendMessageC $ Msg.Info "PostgreSQL is running. Ctrl+C stops PostgreSQL." - _ <- liftIO $ wait process - E.throwError $ CommandError "PostgreSQL stopped" "The database container exited. Check the PostgreSQL logs above." - _ -> E.throwError $ CommandError "Database not started" "No managed PostgreSQL database was started." +start args = do + InWaspProject waspProjectDir <- require + WaspSpecAvailable <- require + appSpec <- analyze waspProjectDir + customDbError <- liftIO $ customDatabaseError appSpec + case customDbError of + Just err -> E.throwError err + Nothing -> case ASV.getValidDbSystem appSpec of + AS.App.Db.SQLite -> + cliSendMessageC $ Msg.Info "Nothing to do! You are all good, you are using SQLite which doesn't need to be started." + AS.App.Db.PostgreSQL -> + withPostgresSession waspProjectDir (ASV.getApp appSpec).name args StartNewDatabase $ \case + StartedDatabase _ _ process -> do + cliSendMessageC $ Msg.Info "PostgreSQL is running. Ctrl+C stops PostgreSQL." + _ <- liftIO $ wait process + E.throwError $ CommandError "PostgreSQL stopped" "The database container exited. Check the PostgreSQL logs above." + ReusedDatabase _ -> + E.throwError $ CommandError "Database not started" "No managed PostgreSQL database was started." printDbMessages :: Chan Job.JobMessage -> IO () printDbMessages channel = runPrefixedWriter go @@ -69,29 +78,42 @@ printDbMessages channel = runPrefixedWriter go go Job.JobExit _ -> return () -withManagedDb :: DbStartOptions -> (Maybe Dev.Postgres.DevDbSpec -> Command a) -> Command a -withManagedDb args action = withDatabaseSession args EnsureDatabase (action . databaseForSession) +withDevDb :: DbStartOptions -> (Maybe Dev.Postgres.DevDbSpec -> Command a) -> Command a +withDevDb args action = do + InWaspProject waspProjectDir <- require + WaspSpecAvailable <- require + appSpec <- analyze waspProjectDir + customDbError <- liftIO $ customDatabaseError appSpec + case customDbError of + Just _ -> do + rejectUnusedOptions "DATABASE_URL is set." args + action Nothing + Nothing -> case ASV.getValidDbSystem appSpec of + AS.App.Db.SQLite -> do + rejectUnusedOptions "This project uses SQLite." args + action Nothing + AS.App.Db.PostgreSQL -> + withPostgresSession waspProjectDir (ASV.getApp appSpec).name args EnsureDatabase $ + action . Just . databaseForSession data DatabaseRequest = StartNewDatabase | EnsureDatabase deriving (Eq) data DatabaseSession - = NoDatabase - | ReusedDatabase Dev.Postgres.DevDbSpec + = ReusedDatabase Dev.Postgres.DevDbSpec | StartedDatabase Dev.Postgres.DevDbSpec String (Async ExitCode) data PreparedDatabase = ExistingDatabase DatabaseSession | NewDatabase Dev.Postgres.DevDbSpec DockerImageName DockerVolumeMountPath -databaseForSession :: DatabaseSession -> Maybe Dev.Postgres.DevDbSpec -databaseForSession NoDatabase = Nothing -databaseForSession (ReusedDatabase db) = Just db -databaseForSession (StartedDatabase db _ _) = Just db +databaseForSession :: DatabaseSession -> Dev.Postgres.DevDbSpec +databaseForSession (ReusedDatabase db) = db +databaseForSession (StartedDatabase db _ _) = db -withDatabaseSession :: DbStartOptions -> DatabaseRequest -> (DatabaseSession -> Command a) -> Command a -withDatabaseSession args request action = do - prepared <- prepare +withPostgresSession :: Path' Abs (Dir WaspProjectDir) -> String -> DbStartOptions -> DatabaseRequest -> (DatabaseSession -> Command a) -> Command a +withPostgresSession waspProjectDir appName args request action = do + prepared <- preparePostgresDevDb waspProjectDir appName args request bracket (acquire prepared) release use where use session = do @@ -110,23 +132,6 @@ withDatabaseSession args request action = do $ additionalInfoLines db _ -> return () action session - prepare = do - InWaspProject waspProjectDir <- require - WaspSpecAvailable <- require - appSpec <- analyze waspProjectDir - customDbError <- liftIO $ customDatabaseError appSpec - case customDbError of - Just err -> case request of - StartNewDatabase -> E.throwError err - EnsureDatabase -> rejectUnusedOptions "DATABASE_URL is set." args >> return (ExistingDatabase NoDatabase) - Nothing -> case ASV.getValidDbSystem appSpec of - AS.App.Db.SQLite -> case request of - StartNewDatabase -> return (ExistingDatabase NoDatabase) - EnsureDatabase -> rejectUnusedOptions "This project uses SQLite." args >> return (ExistingDatabase NoDatabase) - AS.App.Db.PostgreSQL -> do - let appName = (ASV.getApp appSpec).name - preparePostgresDevDb waspProjectDir appName args request - acquire (ExistingDatabase session) = return session acquire (NewDatabase db image mountPath) = bracketOnError diff --git a/waspc/cli/src/Wasp/Cli/Command/Start.hs b/waspc/cli/src/Wasp/Cli/Command/Start.hs index f7eeb28c01d..a2b13e897ea 100644 --- a/waspc/cli/src/Wasp/Cli/Command/Start.hs +++ b/waspc/cli/src/Wasp/Cli/Command/Start.hs @@ -22,7 +22,7 @@ import Wasp.Cli.Command.News (fetchAndListMustSeeNewsIfDue) import Wasp.Cli.Command.Require.DbConnectionEstablished (DbConnectionEstablished (DbConnectionEstablished)) import Wasp.Cli.Command.Require.InWaspProject (InWaspProject (InWaspProject)) import Wasp.Cli.Command.Start.ArgumentsParser (StartArgs (..), startArgsParser) -import qualified Wasp.Cli.Command.Db.Lifecycle as DbLifecycle +import qualified Wasp.Cli.Command.Db.DevDb as DevDb import Wasp.Cli.Command.Watch (watch) import Wasp.Cli.EnvVarWithCtx (addEnvVarsUniqueC) import qualified Wasp.Cli.EnvVarWithCtx as EnvVarWithCtx @@ -42,7 +42,7 @@ import qualified Wasp.Project.Env as Env -- It also listens for any file changes and recompiles and restarts generated project accordingly. start :: Arguments -> Command () start = withArguments startArgsParser $ \args -> - ProjectLock.acquireWatcher $ \projectLock -> DbLifecycle.withManagedDb args.dbStartOptions $ \managedDb -> do + ProjectLock.acquireWatcher $ \projectLock -> DevDb.withDevDb args.dbStartOptions $ \managedDb -> do -- We check for the news only in `wasp start`, and only periodically, -- to avoid being too aggressive. Specifically: -- - We don't run it in other `wasp` commands because we don't want to diff --git a/waspc/cli/src/Wasp/Cli/Command/Start/Db.hs b/waspc/cli/src/Wasp/Cli/Command/Start/Db.hs index f6866dedafe..d995b62ea35 100644 --- a/waspc/cli/src/Wasp/Cli/Command/Start/Db.hs +++ b/waspc/cli/src/Wasp/Cli/Command/Start/Db.hs @@ -5,9 +5,9 @@ where import Wasp.Cli.Command (Command) import Wasp.Cli.Command.Call (Arguments) -import qualified Wasp.Cli.Command.Db.Lifecycle as DbLifecycle +import qualified Wasp.Cli.Command.Db.DevDb as DevDb import Wasp.Cli.Command.Db.StartOptions (dbStartOptionsParser) import Wasp.Cli.Util.Parser (ArgsParser (..), withArguments) start :: Arguments -> Command () -start = withArguments (ArgsParser "wasp db start" dbStartOptionsParser) DbLifecycle.start +start = withArguments (ArgsParser "wasp db start" dbStartOptionsParser) DevDb.start diff --git a/waspc/waspc.cabal b/waspc/waspc.cabal index 155c8fb7a4b..a72508e2572 100644 --- a/waspc/waspc.cabal +++ b/waspc/waspc.cabal @@ -474,7 +474,7 @@ library cli-lib Wasp.Cli.Command.CreateNewProject.StarterTemplates.GhReleaseArchive Wasp.Cli.Command.CreateNewProject.StarterTemplates.Templating Wasp.Cli.Command.Db - Wasp.Cli.Command.Db.Lifecycle + Wasp.Cli.Command.Db.DevDb Wasp.Cli.Command.Db.Migrate Wasp.Cli.Command.Db.Reset Wasp.Cli.Command.Db.Seed From 6c9aa88c29317e6c424c15e493ffeb318a914cd3 Mon Sep 17 00:00:00 2001 From: Mihovil Ilakovac Date: Wed, 7 Oct 2026 15:56:09 +0200 Subject: [PATCH 08/27] Clarify development database names and separate URL detection from errors --- waspc/cli/src/Wasp/Cli/Command/Db/DevDb.hs | 144 +++++++++++---------- waspc/src/Wasp/Project/Db/Dev/Postgres.hs | 12 +- 2 files changed, 80 insertions(+), 76 deletions(-) diff --git a/waspc/cli/src/Wasp/Cli/Command/Db/DevDb.hs b/waspc/cli/src/Wasp/Cli/Command/Db/DevDb.hs index a4c1b572447..acef31040ac 100644 --- a/waspc/cli/src/Wasp/Cli/Command/Db/DevDb.hs +++ b/waspc/cli/src/Wasp/Cli/Command/Db/DevDb.hs @@ -48,21 +48,21 @@ import Wasp.Util.Docker (DockerImageName, DockerVolumeMountPath) -- Wasp is smart while doing this so it checks which database is specified -- in Wasp configuration and spins up a database of appropriate type. start :: DbStartOptions -> Command () -start args = do +start options = do InWaspProject waspProjectDir <- require WaspSpecAvailable <- require appSpec <- analyze waspProjectDir - customDbError <- liftIO $ customDatabaseError appSpec - case customDbError of - Just err -> E.throwError err + databaseUrlSource <- liftIO $ findDatabaseUrlSource appSpec + case databaseUrlSource of + Just source -> throwCustomDatabaseError source Nothing -> case ASV.getValidDbSystem appSpec of AS.App.Db.SQLite -> cliSendMessageC $ Msg.Info "Nothing to do! You are all good, you are using SQLite which doesn't need to be started." AS.App.Db.PostgreSQL -> - withPostgresSession waspProjectDir (ASV.getApp appSpec).name args StartNewDatabase $ \case - StartedDatabase _ _ process -> do + withPostgresSession waspProjectDir (ASV.getApp appSpec).name options StartNewDatabase $ \case + StartedDatabase _ _ databaseJob -> do cliSendMessageC $ Msg.Info "PostgreSQL is running. Ctrl+C stops PostgreSQL." - _ <- liftIO $ wait process + _ <- liftIO $ wait databaseJob E.throwError $ CommandError "PostgreSQL stopped" "The database container exited. Check the PostgreSQL logs above." ReusedDatabase _ -> E.throwError $ CommandError "Database not started" "No managed PostgreSQL database was started." @@ -79,24 +79,24 @@ printDbMessages channel = runPrefixedWriter go Job.JobExit _ -> return () withDevDb :: DbStartOptions -> (Maybe Dev.Postgres.DevDbSpec -> Command a) -> Command a -withDevDb args action = do +withDevDb options action = do InWaspProject waspProjectDir <- require WaspSpecAvailable <- require appSpec <- analyze waspProjectDir - customDbError <- liftIO $ customDatabaseError appSpec - case customDbError of + databaseUrlSource <- liftIO $ findDatabaseUrlSource appSpec + case databaseUrlSource of Just _ -> do - rejectUnusedOptions "DATABASE_URL is set." args + rejectUnusedOptions "DATABASE_URL is set." options action Nothing Nothing -> case ASV.getValidDbSystem appSpec of AS.App.Db.SQLite -> do - rejectUnusedOptions "This project uses SQLite." args + rejectUnusedOptions "This project uses SQLite." options action Nothing AS.App.Db.PostgreSQL -> - withPostgresSession waspProjectDir (ASV.getApp appSpec).name args EnsureDatabase $ - action . Just . databaseForSession + withPostgresSession waspProjectDir (ASV.getApp appSpec).name options StartOrReuseDatabase $ + action . Just . getDatabaseForSession -data DatabaseRequest = StartNewDatabase | EnsureDatabase +data DatabaseStartPolicy = StartNewDatabase | StartOrReuseDatabase deriving (Eq) data DatabaseSession @@ -104,51 +104,51 @@ data DatabaseSession | StartedDatabase Dev.Postgres.DevDbSpec String (Async ExitCode) data PreparedDatabase - = ExistingDatabase DatabaseSession - | NewDatabase Dev.Postgres.DevDbSpec DockerImageName DockerVolumeMountPath + = ReuseDatabase DatabaseSession + | CreateDatabase Dev.Postgres.DevDbSpec DockerImageName DockerVolumeMountPath -databaseForSession :: DatabaseSession -> Dev.Postgres.DevDbSpec -databaseForSession (ReusedDatabase db) = db -databaseForSession (StartedDatabase db _ _) = db +getDatabaseForSession :: DatabaseSession -> Dev.Postgres.DevDbSpec +getDatabaseForSession (ReusedDatabase db) = db +getDatabaseForSession (StartedDatabase db _ _) = db -withPostgresSession :: Path' Abs (Dir WaspProjectDir) -> String -> DbStartOptions -> DatabaseRequest -> (DatabaseSession -> Command a) -> Command a -withPostgresSession waspProjectDir appName args request action = do - prepared <- preparePostgresDevDb waspProjectDir appName args request +withPostgresSession :: Path' Abs (Dir WaspProjectDir) -> String -> DbStartOptions -> DatabaseStartPolicy -> (DatabaseSession -> Command a) -> Command a +withPostgresSession waspProjectDir appName options policy action = do + prepared <- preparePostgresDevDb waspProjectDir appName options policy bracket (acquire prepared) release use where use session = do case session of - StartedDatabase db _ process -> do + StartedDatabase db _ databaseJob -> do result <- withDatabaseError "Could not start PostgreSQL" $ - race (wait process) (Dev.Postgres.waitForReadyDevDb db) + race (wait databaseJob) (Dev.Postgres.waitForDevDbReady db) case result of Left _ -> E.throwError $ CommandError "Could not start PostgreSQL" "The Docker process exited before PostgreSQL was ready. Check the database output above." Right () -> return () - when (request == StartNewDatabase) + when (policy == StartNewDatabase) $ cliSendMessageC $ Msg.Info $ unlines $ additionalInfoLines db _ -> return () action session - acquire (ExistingDatabase session) = return session - acquire (NewDatabase db image mountPath) = + acquire (ReuseDatabase session) = return session + acquire (CreateDatabase db image mountPath) = bracketOnError - (withDatabaseError "Could not start PostgreSQL" $ Dev.Postgres.createDevPostgresDb db image mountPath) + (withDatabaseError "Could not start PostgreSQL" $ Dev.Postgres.createDevPostgresContainer db image mountPath) removeContainer ( \containerId -> do - process <- liftIO $ async $ do + databaseJob <- liftIO $ async $ do channel <- newChan fst <$> concurrently (runProcessAsJob (proc "docker" ["start", "--attach", containerId]) Job.Db channel) (printDbMessages channel) - return $ StartedDatabase db containerId process + return $ StartedDatabase db containerId databaseJob ) - release (StartedDatabase _ containerId process) = - stopDatabase containerId `finally` (liftIO (cancel process) `finally` removeContainer containerId) + release (StartedDatabase _ containerId databaseJob) = + stopDatabase containerId `finally` (liftIO (cancel databaseJob) `finally` removeContainer containerId) release _ = return () stopDatabase containerId = do @@ -169,20 +169,20 @@ runDockerCleanup operation containerId = do else cliSendMessageC $ Msg.Warning "Could not remove PostgreSQL container" (printf "Try `docker rm --force %s`. %s" containerId errors) rejectUnusedOptions :: String -> DbStartOptions -> Command () -rejectUnusedOptions source args = - unless (null options) +rejectUnusedOptions reason options = + unless (null optionNames) $ E.throwError $ CommandError "Database options do not apply" - (printf "%s These options only apply to Wasp-managed PostgreSQL: %s. Remove them to continue." source (intercalate ", " options)) + (printf "%s These options only apply to Wasp-managed PostgreSQL: %s. Remove them to continue." reason (intercalate ", " optionNames)) where - options = suppliedOptionNames args + optionNames = suppliedOptionNames options suppliedOptionNames :: DbStartOptions -> [String] -suppliedOptionNames args = - ["--db-port" | isJust args.dbPort] - ++ ["--db-image" | isJust args.dbImage] - ++ ["--db-volume-mount-path" | isJust args.dbVolumeMountPath] +suppliedOptionNames options = + ["--db-port" | isJust options.dbPort] + ++ ["--db-image" | isJust options.dbImage] + ++ ["--db-volume-mount-path" | isJust options.dbVolumeMountPath] requireDockerAvailable :: Command () requireDockerAvailable = do @@ -191,15 +191,15 @@ requireDockerAvailable = do $ E.throwError $ CommandError "Docker unavailable" (printf "Start Docker and retry. %s" stderr) -preparePostgresDevDb :: Path' Abs (Dir WaspProjectDir) -> String -> DbStartOptions -> DatabaseRequest -> Command PreparedDatabase -preparePostgresDevDb waspProjectDir appName args request = do +preparePostgresDevDb :: Path' Abs (Dir WaspProjectDir) -> String -> DbStartOptions -> DatabaseStartPolicy -> Command PreparedDatabase +preparePostgresDevDb waspProjectDir appName options policy = do throwIfExeIsNotAvailable "docker" "To run PostgreSQL dev database, Wasp needs `docker` installed and in PATH." requireDockerAvailable liftIO (Dev.Postgres.discoverProjectsRunningDevDb waspProjectDir appName) >>= \case - Just runningDb -> case request of + Just runningDb -> case policy of StartNewDatabase -> E.throwError $ CommandError @@ -210,30 +210,30 @@ preparePostgresDevDb waspProjectDir appName args request = do runningDb.dockerContainerName (unlines $ additionalInfoLines runningDb) ) - EnsureDatabase -> ExistingDatabase <$> reportReusedDb runningDb + StartOrReuseDatabase -> ReuseDatabase <$> prepareExistingDatabase runningDb Nothing -> prepareDbOnPort =<< resolveDevDbPort where - dbDockerImage = fromMaybe (fst defaultPostgresDockerImageSpec) args.dbImage - dbDockerVolumeMountPath = fromMaybe (snd defaultPostgresDockerImageSpec) args.dbVolumeMountPath + dbDockerImage = fromMaybe (fst defaultPostgresDockerImageSpec) options.dbImage + dbDockerVolumeMountPath = fromMaybe (snd defaultPostgresDockerImageSpec) options.dbVolumeMountPath resolveDevDbPort :: Command PortNumber resolveDevDbPort = resolvePort - args.dbPort + options.dbPort defaultPostgresPort [] "Choose a different port with --db-port, or free up this one." "Free at least one of those ports by exiting the program listening on it, or choose the port yourself with --db-port." - reportReusedDb :: Dev.Postgres.DevDbSpec -> Command DatabaseSession - reportReusedDb devDbSpec = do - withDatabaseError "PostgreSQL is not ready" $ Dev.Postgres.waitForReadyDevDb devDbSpec + prepareExistingDatabase :: Dev.Postgres.DevDbSpec -> Command DatabaseSession + prepareExistingDatabase devDbSpec = do + withDatabaseError "PostgreSQL is not ready" $ Dev.Postgres.waitForDevDbReady devDbSpec cliSendMessageC $ Msg.Info "PostgreSQL was already running for this project. Wasp did not start it and will not stop it." - unless (null $ suppliedOptionNames args) + unless (null $ suppliedOptionNames options) $ cliSendMessageC $ Msg.Warning "Database options not used" - (printf "These options only apply when starting a new container: %s. Stop the running database before changing them." (intercalate ", " (suppliedOptionNames args))) + (printf "These options only apply when starting a new container: %s. Stop the running database before changing them." (intercalate ", " (suppliedOptionNames options))) return $ ReusedDatabase devDbSpec prepareDbOnPort :: PortNumber -> Command PreparedDatabase @@ -242,7 +242,7 @@ preparePostgresDevDb waspProjectDir appName args request = do ensureImageAvailable cliSendMessageC $ Msg.Start "Starting PostgreSQL..." cliSendMessageC $ Msg.Info $ unlines dockerRunInfoLines - return $ NewDatabase devDbSpec dbDockerImage dbDockerVolumeMountPath + return $ CreateDatabase devDbSpec dbDockerImage dbDockerVolumeMountPath -- These lines describe what Docker is about to use, so we print them -- only when starting the database: an already running container might have @@ -284,26 +284,30 @@ additionalInfoLines db = printf " %s" db.dockerVolumeName ] -customDatabaseError :: AS.AppSpec -> IO (Maybe CommandError) -customDatabaseError appSpec = do +data DatabaseUrlSource = Environment | ServerDotEnv + +findDatabaseUrlSource :: AS.AppSpec -> IO (Maybe DatabaseUrlSource) +findDatabaseUrlSource appSpec = do envUrl <- lookupEnv databaseUrlEnvVarName return $ if isJust envUrl - then - Just - $ errorWithMessage - $ printf - "Wasp has detected existing %s var in your environment.\nTo have Wasp run the dev database for you, make sure you remove that env var first." - databaseUrlEnvVarName + then Just Environment else if any ((== databaseUrlEnvVarName) . fst) appSpec.devEnvVarsServer - then - Just - $ errorWithMessage - $ printf - "Wasp has detected that you have defined %s env var in your %s file.\nTo have Wasp run the dev database for you, make sure you remove that env var first." - databaseUrlEnvVarName - (fromRelFile (dotEnvServer :: Path' (Rel WaspProjectDir) File')) + then Just ServerDotEnv else Nothing + +throwCustomDatabaseError :: DatabaseUrlSource -> Command a +throwCustomDatabaseError source = + E.throwError $ CommandError "You are using custom database already" message where - errorWithMessage = CommandError "You are using custom database already" + message = case source of + Environment -> + printf + "Wasp has detected existing %s var in your environment.\nTo have Wasp run the dev database for you, make sure you remove that env var first." + databaseUrlEnvVarName + ServerDotEnv -> + printf + "Wasp has detected that you have defined %s env var in your %s file.\nTo have Wasp run the dev database for you, make sure you remove that env var first." + databaseUrlEnvVarName + (fromRelFile (dotEnvServer :: Path' (Rel WaspProjectDir) File')) diff --git a/waspc/src/Wasp/Project/Db/Dev/Postgres.hs b/waspc/src/Wasp/Project/Db/Dev/Postgres.hs index 1f01993f4c7..49885c22276 100644 --- a/waspc/src/Wasp/Project/Db/Dev/Postgres.hs +++ b/waspc/src/Wasp/Project/Db/Dev/Postgres.hs @@ -1,8 +1,8 @@ -- | This module captures how Wasp runs a PostgreSQL dev database. module Wasp.Project.Db.Dev.Postgres ( makeDevPostgresDbSpec, - createDevPostgresDb, - waitForReadyDevDb, + createDevPostgresContainer, + waitForDevDbReady, DevDbSpec (..), getDevConnectionUrl, discoverProjectsRunningDevDb, @@ -45,8 +45,8 @@ getDevConnectionUrl :: DevDbSpec -> String getDevConnectionUrl devDbSpec = makeConnectionUrl devDbSpec.user devDbSpec.password devDbSpec.port devDbSpec.dbName -createDevPostgresDb :: DevDbSpec -> DockerImageName -> DockerVolumeMountPath -> IO String -createDevPostgresDb db image mountPath = do +createDevPostgresContainer :: DevDbSpec -> DockerImageName -> DockerVolumeMountPath -> IO String +createDevPostgresContainer db image mountPath = do -- create_group keeps Docker outside the terminal's Ctrl+C group so it can return the container ID needed for cleanup. (status, output, errors) <- readCreateProcessWithExitCode ((proc "docker" args) {create_group = True}) "" case (status, words output) of @@ -68,8 +68,8 @@ createDevPostgresDb db image mountPath = do [image] ] -waitForReadyDevDb :: DevDbSpec -> IO () -waitForReadyDevDb devDbSpec = do +waitForDevDbReady :: DevDbSpec -> IO () +waitForDevDbReady devDbSpec = do result <- Retry.retry (Retry.constPause 1000000) 59 checkReady case result of Right () -> return () From 0569614dea0ae3d502698e516fed79fbd41eac9f Mon Sep 17 00:00:00 2001 From: Mihovil Ilakovac Date: Wed, 7 Oct 2026 16:03:09 +0200 Subject: [PATCH 09/27] Keep explicit database startup behavior in its command module --- waspc/cli/src/Wasp/Cli/Command/Db/DevDb.hs | 50 +++-------------- waspc/cli/src/Wasp/Cli/Command/Start/Db.hs | 64 +++++++++++++++++++++- 2 files changed, 68 insertions(+), 46 deletions(-) diff --git a/waspc/cli/src/Wasp/Cli/Command/Db/DevDb.hs b/waspc/cli/src/Wasp/Cli/Command/Db/DevDb.hs index acef31040ac..50375e86043 100644 --- a/waspc/cli/src/Wasp/Cli/Command/Db/DevDb.hs +++ b/waspc/cli/src/Wasp/Cli/Command/Db/DevDb.hs @@ -1,6 +1,10 @@ module Wasp.Cli.Command.Db.DevDb - ( start, - withDevDb, + ( withDevDb, + withPostgresSession, + DatabaseStartPolicy (..), + DatabaseSession (..), + DatabaseUrlSource (..), + findDatabaseUrlSource, ) where @@ -14,7 +18,7 @@ import Control.Monad.IO.Class (liftIO) import Data.List (intercalate, isInfixOf) import Data.Maybe (fromMaybe, isJust) import Network.Socket (PortNumber) -import StrongPath (Abs, Dir, File', Path', Rel, fromRelFile) +import StrongPath (Abs, Dir, Path') import System.Environment (lookupEnv) import System.Exit (ExitCode (..)) import System.IO.Error (ioeGetErrorString) @@ -40,33 +44,8 @@ import qualified Wasp.Message as Msg import Wasp.Project.Common (WaspProjectDir) import Wasp.Project.Db (databaseUrlEnvVarName) import qualified Wasp.Project.Db.Dev.Postgres as Dev.Postgres -import Wasp.Project.Env (dotEnvServer) import Wasp.Util.Docker (DockerImageName, DockerVolumeMountPath) --- | Starts a "managed" dev database, where "managed" means that --- Wasp creates it and connects the Wasp app with it. --- Wasp is smart while doing this so it checks which database is specified --- in Wasp configuration and spins up a database of appropriate type. -start :: DbStartOptions -> Command () -start options = do - InWaspProject waspProjectDir <- require - WaspSpecAvailable <- require - appSpec <- analyze waspProjectDir - databaseUrlSource <- liftIO $ findDatabaseUrlSource appSpec - case databaseUrlSource of - Just source -> throwCustomDatabaseError source - Nothing -> case ASV.getValidDbSystem appSpec of - AS.App.Db.SQLite -> - cliSendMessageC $ Msg.Info "Nothing to do! You are all good, you are using SQLite which doesn't need to be started." - AS.App.Db.PostgreSQL -> - withPostgresSession waspProjectDir (ASV.getApp appSpec).name options StartNewDatabase $ \case - StartedDatabase _ _ databaseJob -> do - cliSendMessageC $ Msg.Info "PostgreSQL is running. Ctrl+C stops PostgreSQL." - _ <- liftIO $ wait databaseJob - E.throwError $ CommandError "PostgreSQL stopped" "The database container exited. Check the PostgreSQL logs above." - ReusedDatabase _ -> - E.throwError $ CommandError "Database not started" "No managed PostgreSQL database was started." - printDbMessages :: Chan Job.JobMessage -> IO () printDbMessages channel = runPrefixedWriter go where @@ -296,18 +275,3 @@ findDatabaseUrlSource appSpec = do if any ((== databaseUrlEnvVarName) . fst) appSpec.devEnvVarsServer then Just ServerDotEnv else Nothing - -throwCustomDatabaseError :: DatabaseUrlSource -> Command a -throwCustomDatabaseError source = - E.throwError $ CommandError "You are using custom database already" message - where - message = case source of - Environment -> - printf - "Wasp has detected existing %s var in your environment.\nTo have Wasp run the dev database for you, make sure you remove that env var first." - databaseUrlEnvVarName - ServerDotEnv -> - printf - "Wasp has detected that you have defined %s env var in your %s file.\nTo have Wasp run the dev database for you, make sure you remove that env var first." - databaseUrlEnvVarName - (fromRelFile (dotEnvServer :: Path' (Rel WaspProjectDir) File')) diff --git a/waspc/cli/src/Wasp/Cli/Command/Start/Db.hs b/waspc/cli/src/Wasp/Cli/Command/Start/Db.hs index d995b62ea35..501a0fd8071 100644 --- a/waspc/cli/src/Wasp/Cli/Command/Start/Db.hs +++ b/waspc/cli/src/Wasp/Cli/Command/Start/Db.hs @@ -3,11 +3,69 @@ module Wasp.Cli.Command.Start.Db ) where -import Wasp.Cli.Command (Command) +import Control.Concurrent.Async (wait) +import qualified Control.Monad.Except as E +import Control.Monad.IO.Class (liftIO) +import StrongPath (File', Path', Rel, fromRelFile) +import Text.Printf (printf) +import qualified Wasp.AppSpec.App as AS.App +import qualified Wasp.AppSpec.App.Db as AS.App.Db +import qualified Wasp.AppSpec.Valid as ASV +import Wasp.Cli.Command (Command, CommandError (CommandError), require) import Wasp.Cli.Command.Call (Arguments) -import qualified Wasp.Cli.Command.Db.DevDb as DevDb +import Wasp.Cli.Command.Compile (analyze) +import Wasp.Cli.Command.Db.DevDb + ( DatabaseSession (..), + DatabaseStartPolicy (..), + DatabaseUrlSource (..), + findDatabaseUrlSource, + withPostgresSession, + ) import Wasp.Cli.Command.Db.StartOptions (dbStartOptionsParser) +import Wasp.Cli.Command.Message (cliSendMessageC) +import Wasp.Cli.Command.Require.InWaspProject (InWaspProject (InWaspProject)) +import Wasp.Cli.Command.Require.WaspSpecAvailable (WaspSpecAvailable (WaspSpecAvailable)) import Wasp.Cli.Util.Parser (ArgsParser (..), withArguments) +import qualified Wasp.Message as Msg +import Wasp.Project.Common (WaspProjectDir) +import Wasp.Project.Db (databaseUrlEnvVarName) +import Wasp.Project.Env (dotEnvServer) +-- | Starts a "managed" dev database, where "managed" means that +-- Wasp creates it and connects the Wasp app with it. +-- Wasp is smart while doing this so it checks which database is specified +-- in Wasp configuration and spins up a database of appropriate type. start :: Arguments -> Command () -start = withArguments (ArgsParser "wasp db start" dbStartOptionsParser) DevDb.start +start = withArguments (ArgsParser "wasp db start" dbStartOptionsParser) $ \options -> do + InWaspProject waspProjectDir <- require + WaspSpecAvailable <- require + appSpec <- analyze waspProjectDir + databaseUrlSource <- liftIO $ findDatabaseUrlSource appSpec + case databaseUrlSource of + Just source -> rejectDatabaseUrlOverride source + Nothing -> case ASV.getValidDbSystem appSpec of + AS.App.Db.SQLite -> + cliSendMessageC $ Msg.Info "Nothing to do! You are all good, you are using SQLite which doesn't need to be started." + AS.App.Db.PostgreSQL -> + withPostgresSession waspProjectDir (ASV.getApp appSpec).name options StartNewDatabase $ \case + StartedDatabase _ _ databaseJob -> do + cliSendMessageC $ Msg.Info "PostgreSQL is running. Ctrl+C stops PostgreSQL." + _ <- liftIO $ wait databaseJob + E.throwError $ CommandError "PostgreSQL stopped" "The database container exited. Check the PostgreSQL logs above." + ReusedDatabase _ -> + E.throwError $ CommandError "Database not started" "No managed PostgreSQL database was started." + +rejectDatabaseUrlOverride :: DatabaseUrlSource -> Command a +rejectDatabaseUrlOverride source = + E.throwError $ CommandError "You are using custom database already" message + where + message = case source of + Environment -> + printf + "Wasp has detected existing %s var in your environment.\nTo have Wasp run the dev database for you, make sure you remove that env var first." + databaseUrlEnvVarName + ServerDotEnv -> + printf + "Wasp has detected that you have defined %s env var in your %s file.\nTo have Wasp run the dev database for you, make sure you remove that env var first." + databaseUrlEnvVarName + (fromRelFile (dotEnvServer :: Path' (Rel WaspProjectDir) File')) From 2b7dae81ea00e2b65d986788c70f74cdccb8d192 Mon Sep 17 00:00:00 2001 From: Mihovil Ilakovac Date: Wed, 7 Oct 2026 16:03:57 +0200 Subject: [PATCH 10/27] Keep short database message expressions together --- waspc/cli/src/Wasp/Cli/Command/Db/DevDb.hs | 6 +----- 1 file changed, 1 insertion(+), 5 deletions(-) diff --git a/waspc/cli/src/Wasp/Cli/Command/Db/DevDb.hs b/waspc/cli/src/Wasp/Cli/Command/Db/DevDb.hs index 50375e86043..95a710bc321 100644 --- a/waspc/cli/src/Wasp/Cli/Command/Db/DevDb.hs +++ b/waspc/cli/src/Wasp/Cli/Command/Db/DevDb.hs @@ -104,11 +104,7 @@ withPostgresSession waspProjectDir appName options policy action = do case result of Left _ -> E.throwError $ CommandError "Could not start PostgreSQL" "The Docker process exited before PostgreSQL was ready. Check the database output above." Right () -> return () - when (policy == StartNewDatabase) - $ cliSendMessageC - $ Msg.Info - $ unlines - $ additionalInfoLines db + when (policy == StartNewDatabase) $ cliSendMessageC $ Msg.Info $ unlines $ additionalInfoLines db _ -> return () action session acquire (ReuseDatabase session) = return session From 5eda1a5c2b8f1db6306a2ca13a4a20d30f02c2c9 Mon Sep 17 00:00:00 2001 From: Mihovil Ilakovac Date: Wed, 7 Oct 2026 16:07:03 +0200 Subject: [PATCH 11/27] Separate Docker stop and remove handling from cleanup execution --- waspc/cli/src/Wasp/Cli/Command/Db/DevDb.hs | 51 ++++++++++------------ 1 file changed, 22 insertions(+), 29 deletions(-) diff --git a/waspc/cli/src/Wasp/Cli/Command/Db/DevDb.hs b/waspc/cli/src/Wasp/Cli/Command/Db/DevDb.hs index 95a710bc321..a55c230741a 100644 --- a/waspc/cli/src/Wasp/Cli/Command/Db/DevDb.hs +++ b/waspc/cli/src/Wasp/Cli/Command/Db/DevDb.hs @@ -11,7 +11,7 @@ where import Control.Concurrent (Chan, newChan, readChan) import Control.Concurrent.Async (Async, async, cancel, concurrently, race, wait) import Control.Exception (IOException, try) -import Control.Monad (unless, when) +import Control.Monad (forM_, unless, when) import Control.Monad.Catch (bracket, bracketOnError, finally) import qualified Control.Monad.Except as E import Control.Monad.IO.Class (liftIO) @@ -126,30 +126,31 @@ withPostgresSession waspProjectDir appName options policy action = do stopDatabase containerId `finally` (liftIO (cancel databaseJob) `finally` removeContainer containerId) release _ = return () - stopDatabase containerId = do - cliSendMessageC $ Msg.Start "Stopping database..." - runDockerCleanup "stop" containerId +stopDatabase :: String -> Command () +stopDatabase containerId = do + cliSendMessageC $ Msg.Start "Stopping database..." + failure <- runDockerCleanup ["stop", containerId] + forM_ failure $ \errors -> + cliSendMessageC $ Msg.Warning "Could not stop PostgreSQL" (printf "Wasp will try to remove the container. %s" errors) removeContainer :: String -> Command () -removeContainer = runDockerCleanup "rm" +removeContainer containerId = do + failure <- runDockerCleanup ["rm", "--force", containerId] + forM_ failure $ \errors -> + cliSendMessageC $ Msg.Warning "Could not remove PostgreSQL container" (printf "Try `docker rm --force %s`. %s" containerId errors) -runDockerCleanup :: String -> String -> Command () -runDockerCleanup operation containerId = do - let args = [operation] ++ ["--force" | operation == "rm"] ++ [containerId] - -- Let Docker finish stopping or removing the container even if the user presses Ctrl+C again. +runDockerCleanup :: [String] -> Command (Maybe String) +runDockerCleanup args = do + -- create_group keeps terminal Ctrl+C from interrupting Docker's cleanup command. (status, _, errors) <- liftIO $ readCreateProcessWithExitCode ((proc "docker" args) {create_group = True}) "" - when (status /= ExitSuccess && not ("No such container" `isInfixOf` errors)) $ - if operation == "stop" - then cliSendMessageC $ Msg.Warning "Could not stop PostgreSQL" (printf "Wasp will try to remove the container. %s" errors) - else cliSendMessageC $ Msg.Warning "Could not remove PostgreSQL container" (printf "Try `docker rm --force %s`. %s" containerId errors) + return $ + if status == ExitSuccess || "No such container" `isInfixOf` errors + then Nothing + else Just errors rejectUnusedOptions :: String -> DbStartOptions -> Command () rejectUnusedOptions reason options = - unless (null optionNames) - $ E.throwError - $ CommandError - "Database options do not apply" - (printf "%s These options only apply to Wasp-managed PostgreSQL: %s. Remove them to continue." reason (intercalate ", " optionNames)) + unless (null optionNames) $ E.throwError $ CommandError "Database options do not apply" (printf "%s These options only apply to Wasp-managed PostgreSQL: %s. Remove them to continue." reason (intercalate ", " optionNames)) where optionNames = suppliedOptionNames options @@ -162,9 +163,7 @@ suppliedOptionNames options = requireDockerAvailable :: Command () requireDockerAvailable = do (exitCode, _, stderr) <- liftIO $ readProcessWithExitCode "docker" ["info", "--format", "{{.ServerVersion}}"] "" - when (exitCode /= ExitSuccess) - $ E.throwError - $ CommandError "Docker unavailable" (printf "Start Docker and retry. %s" stderr) + when (exitCode /= ExitSuccess) $ E.throwError $ CommandError "Docker unavailable" (printf "Start Docker and retry. %s" stderr) preparePostgresDevDb :: Path' Abs (Dir WaspProjectDir) -> String -> DbStartOptions -> DatabaseStartPolicy -> Command PreparedDatabase preparePostgresDevDb waspProjectDir appName options policy = do @@ -204,11 +203,7 @@ preparePostgresDevDb waspProjectDir appName options policy = do prepareExistingDatabase devDbSpec = do withDatabaseError "PostgreSQL is not ready" $ Dev.Postgres.waitForDevDbReady devDbSpec cliSendMessageC $ Msg.Info "PostgreSQL was already running for this project. Wasp did not start it and will not stop it." - unless (null $ suppliedOptionNames options) - $ cliSendMessageC - $ Msg.Warning - "Database options not used" - (printf "These options only apply when starting a new container: %s. Stop the running database before changing them." (intercalate ", " (suppliedOptionNames options))) + unless (null $ suppliedOptionNames options) $ cliSendMessageC $ Msg.Warning "Database options not used" (printf "These options only apply when starting a new container: %s. Stop the running database before changing them." (intercalate ", " (suppliedOptionNames options))) return $ ReusedDatabase devDbSpec prepareDbOnPort :: PortNumber -> Command PreparedDatabase @@ -237,9 +232,7 @@ preparePostgresDevDb waspProjectDir appName options policy = do pullStatus <- liftIO $ do channel <- newChan fst <$> concurrently (runProcessAsJob (proc "docker" ["pull", dbDockerImage]) Job.Db channel) (printDbMessages channel) - when (pullStatus /= ExitSuccess) - $ E.throwError - $ CommandError "Could not pull PostgreSQL image" (printf "Check the image name, registry access, and network connection. Image: %s" dbDockerImage) + when (pullStatus /= ExitSuccess) $ E.throwError $ CommandError "Could not pull PostgreSQL image" (printf "Check the image name, registry access, and network connection. Image: %s" dbDockerImage) withDatabaseError :: String -> IO a -> Command a withDatabaseError title action = do From 3aaefc5696728c25af7aaf459d0fcf2bd14ac441 Mon Sep 17 00:00:00 2001 From: Mihovil Ilakovac Date: Wed, 7 Oct 2026 16:22:54 +0200 Subject: [PATCH 12/27] Ensure no database URL override before explicit startup --- waspc/cli/src/Wasp/Cli/Command/Start/Db.hs | 38 ++++++++++++---------- 1 file changed, 20 insertions(+), 18 deletions(-) diff --git a/waspc/cli/src/Wasp/Cli/Command/Start/Db.hs b/waspc/cli/src/Wasp/Cli/Command/Start/Db.hs index 501a0fd8071..4a5c772c97b 100644 --- a/waspc/cli/src/Wasp/Cli/Command/Start/Db.hs +++ b/waspc/cli/src/Wasp/Cli/Command/Start/Db.hs @@ -4,10 +4,12 @@ module Wasp.Cli.Command.Start.Db where import Control.Concurrent.Async (wait) +import Control.Monad (forM_) import qualified Control.Monad.Except as E import Control.Monad.IO.Class (liftIO) import StrongPath (File', Path', Rel, fromRelFile) import Text.Printf (printf) +import Wasp.AppSpec (AppSpec) import qualified Wasp.AppSpec.App as AS.App import qualified Wasp.AppSpec.App.Db as AS.App.Db import qualified Wasp.AppSpec.Valid as ASV @@ -40,26 +42,26 @@ start = withArguments (ArgsParser "wasp db start" dbStartOptionsParser) $ \optio InWaspProject waspProjectDir <- require WaspSpecAvailable <- require appSpec <- analyze waspProjectDir - databaseUrlSource <- liftIO $ findDatabaseUrlSource appSpec - case databaseUrlSource of - Just source -> rejectDatabaseUrlOverride source - Nothing -> case ASV.getValidDbSystem appSpec of - AS.App.Db.SQLite -> - cliSendMessageC $ Msg.Info "Nothing to do! You are all good, you are using SQLite which doesn't need to be started." - AS.App.Db.PostgreSQL -> - withPostgresSession waspProjectDir (ASV.getApp appSpec).name options StartNewDatabase $ \case - StartedDatabase _ _ databaseJob -> do - cliSendMessageC $ Msg.Info "PostgreSQL is running. Ctrl+C stops PostgreSQL." - _ <- liftIO $ wait databaseJob - E.throwError $ CommandError "PostgreSQL stopped" "The database container exited. Check the PostgreSQL logs above." - ReusedDatabase _ -> - E.throwError $ CommandError "Database not started" "No managed PostgreSQL database was started." + ensureNoDatabaseUrlOverride appSpec + case ASV.getValidDbSystem appSpec of + AS.App.Db.SQLite -> + cliSendMessageC $ Msg.Info "Nothing to do! You are all good, you are using SQLite which doesn't need to be started." + AS.App.Db.PostgreSQL -> + withPostgresSession waspProjectDir (ASV.getApp appSpec).name options StartNewDatabase $ \case + StartedDatabase _ _ databaseJob -> do + cliSendMessageC $ Msg.Info "PostgreSQL is running. Ctrl+C stops PostgreSQL." + _ <- liftIO $ wait databaseJob + E.throwError $ CommandError "PostgreSQL stopped" "The database container exited. Check the PostgreSQL logs above." + ReusedDatabase _ -> + E.throwError $ CommandError "Database not started" "No managed PostgreSQL database was started." -rejectDatabaseUrlOverride :: DatabaseUrlSource -> Command a -rejectDatabaseUrlOverride source = - E.throwError $ CommandError "You are using custom database already" message +ensureNoDatabaseUrlOverride :: AppSpec -> Command () +ensureNoDatabaseUrlOverride appSpec = do + databaseUrlSource <- liftIO $ findDatabaseUrlSource appSpec + forM_ databaseUrlSource $ \source -> + E.throwError $ CommandError "You are using custom database already" (message source) where - message = case source of + message source = case source of Environment -> printf "Wasp has detected existing %s var in your environment.\nTo have Wasp run the dev database for you, make sure you remove that env var first." From 99badc145d840a757bca1e178e1f64f32fa49489 Mon Sep 17 00:00:00 2001 From: Mihovil Ilakovac Date: Wed, 7 Oct 2026 16:29:01 +0200 Subject: [PATCH 13/27] Check Docker executable and daemon through one helper --- waspc/cli/src/Wasp/Cli/Command/Common.hs | 15 ++----------- waspc/cli/src/Wasp/Cli/Command/Db/DevDb.hs | 26 +++++++++++++--------- 2 files changed, 17 insertions(+), 24 deletions(-) diff --git a/waspc/cli/src/Wasp/Cli/Command/Common.hs b/waspc/cli/src/Wasp/Cli/Command/Common.hs index 1ab85820f4c..03074838c48 100644 --- a/waspc/cli/src/Wasp/Cli/Command/Common.hs +++ b/waspc/cli/src/Wasp/Cli/Command/Common.hs @@ -1,28 +1,17 @@ module Wasp.Cli.Command.Common - ( throwIfExeIsNotAvailable, - deleteDirectoryIfExistsVerbosely, + ( deleteDirectoryIfExistsVerbosely, ) where -import qualified Control.Monad.Except as E import Control.Monad.IO.Class (liftIO) import StrongPath (Abs, Dir, Path') import qualified StrongPath as SP import StrongPath.Operations -import System.Directory (findExecutable) -import Wasp.Cli.Command (Command, CommandError (..)) +import Wasp.Cli.Command (Command) import Wasp.Cli.Command.Message (cliSendMessageC) import qualified Wasp.Message as Msg import qualified Wasp.Util.IO as IOUtil -throwIfExeIsNotAvailable :: String -> String -> Command () -throwIfExeIsNotAvailable exeName explanationMsg = do - liftIO (findExecutable exeName) >>= \case - Just _ -> return () - Nothing -> - E.throwError $ - CommandError ("Couldn't find `" <> exeName <> "` executable") explanationMsg - deleteDirectoryIfExistsVerbosely :: Path' Abs (Dir d) -> Command () deleteDirectoryIfExistsVerbosely dir = do cliSendMessageC $ Msg.Start $ "Deleting the " ++ dirName ++ " directory..." diff --git a/waspc/cli/src/Wasp/Cli/Command/Db/DevDb.hs b/waspc/cli/src/Wasp/Cli/Command/Db/DevDb.hs index a55c230741a..3f6407f35ab 100644 --- a/waspc/cli/src/Wasp/Cli/Command/Db/DevDb.hs +++ b/waspc/cli/src/Wasp/Cli/Command/Db/DevDb.hs @@ -19,6 +19,7 @@ import Data.List (intercalate, isInfixOf) import Data.Maybe (fromMaybe, isJust) import Network.Socket (PortNumber) import StrongPath (Abs, Dir, Path') +import System.Directory (findExecutable) import System.Environment (lookupEnv) import System.Exit (ExitCode (..)) import System.IO.Error (ioeGetErrorString) @@ -29,7 +30,6 @@ import qualified Wasp.AppSpec.App as AS.App import qualified Wasp.AppSpec.App.Db as AS.App.Db import qualified Wasp.AppSpec.Valid as ASV import Wasp.Cli.Command (Command, CommandError (CommandError), require) -import Wasp.Cli.Command.Common (throwIfExeIsNotAvailable) import Wasp.Cli.Command.Compile (analyze) import Wasp.Cli.Command.Db.StartOptions (DbStartOptions (..)) import Wasp.Cli.Command.Message (cliSendMessageC) @@ -65,11 +65,11 @@ withDevDb options action = do databaseUrlSource <- liftIO $ findDatabaseUrlSource appSpec case databaseUrlSource of Just _ -> do - rejectUnusedOptions "DATABASE_URL is set." options + throwIfDbStartOptionsSupplied "DATABASE_URL is set." options action Nothing Nothing -> case ASV.getValidDbSystem appSpec of AS.App.Db.SQLite -> do - rejectUnusedOptions "This project uses SQLite." options + throwIfDbStartOptionsSupplied "This project uses SQLite." options action Nothing AS.App.Db.PostgreSQL -> withPostgresSession waspProjectDir (ASV.getApp appSpec).name options StartOrReuseDatabase $ @@ -148,8 +148,8 @@ runDockerCleanup args = do then Nothing else Just errors -rejectUnusedOptions :: String -> DbStartOptions -> Command () -rejectUnusedOptions reason options = +throwIfDbStartOptionsSupplied :: String -> DbStartOptions -> Command () +throwIfDbStartOptionsSupplied reason options = unless (null optionNames) $ E.throwError $ CommandError "Database options do not apply" (printf "%s These options only apply to Wasp-managed PostgreSQL: %s. Remove them to continue." reason (intercalate ", " optionNames)) where optionNames = suppliedOptionNames options @@ -160,17 +160,21 @@ suppliedOptionNames options = ++ ["--db-image" | isJust options.dbImage] ++ ["--db-volume-mount-path" | isJust options.dbVolumeMountPath] -requireDockerAvailable :: Command () -requireDockerAvailable = do +ensureDockerDaemonAvailable :: Command () +ensureDockerDaemonAvailable = do + liftIO (findExecutable "docker") >>= \case + Just _ -> return () + Nothing -> + E.throwError $ + CommandError + "Couldn't find `docker` executable" + "To run PostgreSQL dev database, Wasp needs `docker` installed and in PATH." (exitCode, _, stderr) <- liftIO $ readProcessWithExitCode "docker" ["info", "--format", "{{.ServerVersion}}"] "" when (exitCode /= ExitSuccess) $ E.throwError $ CommandError "Docker unavailable" (printf "Start Docker and retry. %s" stderr) preparePostgresDevDb :: Path' Abs (Dir WaspProjectDir) -> String -> DbStartOptions -> DatabaseStartPolicy -> Command PreparedDatabase preparePostgresDevDb waspProjectDir appName options policy = do - throwIfExeIsNotAvailable - "docker" - "To run PostgreSQL dev database, Wasp needs `docker` installed and in PATH." - requireDockerAvailable + ensureDockerDaemonAvailable liftIO (Dev.Postgres.discoverProjectsRunningDevDb waspProjectDir appName) >>= \case Just runningDb -> case policy of From 9bcf0cd1384b213132147fe215e89fdd8a1e0e1d Mon Sep 17 00:00:00 2001 From: Mihovil Ilakovac Date: Wed, 7 Oct 2026 16:31:32 +0200 Subject: [PATCH 14/27] Reuse the common executable check for Docker availability --- waspc/cli/src/Wasp/Cli/Command/Common.hs | 15 +++++++++++++-- waspc/cli/src/Wasp/Cli/Command/Db/DevDb.hs | 12 ++++-------- 2 files changed, 17 insertions(+), 10 deletions(-) diff --git a/waspc/cli/src/Wasp/Cli/Command/Common.hs b/waspc/cli/src/Wasp/Cli/Command/Common.hs index 03074838c48..1ab85820f4c 100644 --- a/waspc/cli/src/Wasp/Cli/Command/Common.hs +++ b/waspc/cli/src/Wasp/Cli/Command/Common.hs @@ -1,17 +1,28 @@ module Wasp.Cli.Command.Common - ( deleteDirectoryIfExistsVerbosely, + ( throwIfExeIsNotAvailable, + deleteDirectoryIfExistsVerbosely, ) where +import qualified Control.Monad.Except as E import Control.Monad.IO.Class (liftIO) import StrongPath (Abs, Dir, Path') import qualified StrongPath as SP import StrongPath.Operations -import Wasp.Cli.Command (Command) +import System.Directory (findExecutable) +import Wasp.Cli.Command (Command, CommandError (..)) import Wasp.Cli.Command.Message (cliSendMessageC) import qualified Wasp.Message as Msg import qualified Wasp.Util.IO as IOUtil +throwIfExeIsNotAvailable :: String -> String -> Command () +throwIfExeIsNotAvailable exeName explanationMsg = do + liftIO (findExecutable exeName) >>= \case + Just _ -> return () + Nothing -> + E.throwError $ + CommandError ("Couldn't find `" <> exeName <> "` executable") explanationMsg + deleteDirectoryIfExistsVerbosely :: Path' Abs (Dir d) -> Command () deleteDirectoryIfExistsVerbosely dir = do cliSendMessageC $ Msg.Start $ "Deleting the " ++ dirName ++ " directory..." diff --git a/waspc/cli/src/Wasp/Cli/Command/Db/DevDb.hs b/waspc/cli/src/Wasp/Cli/Command/Db/DevDb.hs index 3f6407f35ab..334b303c4d4 100644 --- a/waspc/cli/src/Wasp/Cli/Command/Db/DevDb.hs +++ b/waspc/cli/src/Wasp/Cli/Command/Db/DevDb.hs @@ -19,7 +19,6 @@ import Data.List (intercalate, isInfixOf) import Data.Maybe (fromMaybe, isJust) import Network.Socket (PortNumber) import StrongPath (Abs, Dir, Path') -import System.Directory (findExecutable) import System.Environment (lookupEnv) import System.Exit (ExitCode (..)) import System.IO.Error (ioeGetErrorString) @@ -30,6 +29,7 @@ import qualified Wasp.AppSpec.App as AS.App import qualified Wasp.AppSpec.App.Db as AS.App.Db import qualified Wasp.AppSpec.Valid as ASV import Wasp.Cli.Command (Command, CommandError (CommandError), require) +import Wasp.Cli.Command.Common (throwIfExeIsNotAvailable) import Wasp.Cli.Command.Compile (analyze) import Wasp.Cli.Command.Db.StartOptions (DbStartOptions (..)) import Wasp.Cli.Command.Message (cliSendMessageC) @@ -162,13 +162,9 @@ suppliedOptionNames options = ensureDockerDaemonAvailable :: Command () ensureDockerDaemonAvailable = do - liftIO (findExecutable "docker") >>= \case - Just _ -> return () - Nothing -> - E.throwError $ - CommandError - "Couldn't find `docker` executable" - "To run PostgreSQL dev database, Wasp needs `docker` installed and in PATH." + throwIfExeIsNotAvailable + "docker" + "To run PostgreSQL dev database, Wasp needs `docker` installed and in PATH." (exitCode, _, stderr) <- liftIO $ readProcessWithExitCode "docker" ["info", "--format", "{{.ServerVersion}}"] "" when (exitCode /= ExitSuccess) $ E.throwError $ CommandError "Docker unavailable" (printf "Start Docker and retry. %s" stderr) From c57d37d5c56ac81e76732a52cbacbaef1a1b9ad9 Mon Sep 17 00:00:00 2001 From: Mihovil Ilakovac Date: Wed, 7 Oct 2026 16:38:38 +0200 Subject: [PATCH 15/27] Use retryUntil for database readiness checks --- waspc/src/Wasp/Project/Db/Dev/Postgres.hs | 15 +++++---------- waspc/src/Wasp/Util/IO/Retry.hs | 12 ++++++++++++ waspc/tests/Util/IO/RetryTest.hs | 9 +++++++++ 3 files changed, 26 insertions(+), 10 deletions(-) diff --git a/waspc/src/Wasp/Project/Db/Dev/Postgres.hs b/waspc/src/Wasp/Project/Db/Dev/Postgres.hs index 49885c22276..07c87ff2a89 100644 --- a/waspc/src/Wasp/Project/Db/Dev/Postgres.hs +++ b/waspc/src/Wasp/Project/Db/Dev/Postgres.hs @@ -10,6 +10,7 @@ module Wasp.Project.Db.Dev.Postgres ) where +import Control.Monad (unless) import Network.Socket (PortNumber) import StrongPath (Abs, Dir, Path') import System.Exit (ExitCode (..)) @@ -70,16 +71,10 @@ createDevPostgresContainer db image mountPath = do waitForDevDbReady :: DevDbSpec -> IO () waitForDevDbReady devDbSpec = do - result <- Retry.retry (Retry.constPause 1000000) 59 checkReady - case result of - Right () -> return () - Left () -> do - (_, output, errors) <- readProcessWithExitCode "docker" ["logs", "--tail", "30", devDbSpec.dockerContainerName] "" - ioError $ userError $ printf "PostgreSQL did not become ready. Check the logs below, then try again.\n%s%s" output errors - where - checkReady = do - ready <- isDevDbReady devDbSpec - return $ if ready then Right () else Left () + ready <- Retry.retryUntil (Retry.constPause 1000000) 59 $ isDevDbReady devDbSpec + unless ready $ do + (_, output, errors) <- readProcessWithExitCode "docker" ["logs", "--tail", "30", devDbSpec.dockerContainerName] "" + ioError $ userError $ printf "PostgreSQL did not become ready. Check the logs below, then try again.\n%s%s" output errors isDevDbReady :: DevDbSpec -> IO Bool isDevDbReady devDbSpec = do diff --git a/waspc/src/Wasp/Util/IO/Retry.hs b/waspc/src/Wasp/Util/IO/Retry.hs index d429803e2d5..c97f1d600fa 100644 --- a/waspc/src/Wasp/Util/IO/Retry.hs +++ b/waspc/src/Wasp/Util/IO/Retry.hs @@ -2,6 +2,7 @@ module Wasp.Util.IO.Retry ( retry, + retryUntil, retryWithCallback, constPause, linearPause, @@ -15,6 +16,7 @@ module Wasp.Util.IO.Retry where import Control.Concurrent (threadDelay) +import Data.Either (isRight) import Numeric.Natural (Natural) import Prelude hiding (readFile, writeFile) @@ -25,6 +27,16 @@ import Prelude hiding (readFile, writeFile) retry :: (MonadRetry m) => PauseStrategy -> Natural -> m (Either e a) -> m (Either e a) retry pauseStrategy maxNumRetries = retryWithCallback pauseStrategy maxNumRetries (\_ _ -> pure ()) +-- | Repeats a check until it returns True or the retries are exhausted. +retryUntil :: (MonadRetry m) => PauseStrategy -> Natural -> m Bool -> m Bool +retryUntil pauseStrategy maxNumRetries check = do + result <- retry pauseStrategy maxNumRetries attempt + return $ isRight result + where + attempt = do + ready <- check + return $ if ready then Right () else Left () + -- | Same as 'retry', but also runs provided onRetry callback after each failed try -- that will be retried, right before the pause. The callback receives the number -- of failed tries so far (starting at 1) and the error from the latest try. diff --git a/waspc/tests/Util/IO/RetryTest.hs b/waspc/tests/Util/IO/RetryTest.hs index 4afdaf99ad2..18087f81805 100644 --- a/waspc/tests/Util/IO/RetryTest.hs +++ b/waspc/tests/Util/IO/RetryTest.hs @@ -4,6 +4,7 @@ module Util.IO.RetryTest where import Control.Monad (forM_) import Control.Monad.State (MonadState (get), State, modify, runState) +import Data.Either (isRight) import Numeric.Natural (Natural) import Test.Hspec (Spec, describe, it, shouldBe) import qualified Wasp.Util.IO.Retry as R @@ -38,6 +39,14 @@ spec_RetryTest = do it "for expPause" $ testPause (R.expPause 10) (10, 20, 40) it "for customPause" $ testPause (R.customPause (^ (2 :: Int))) (1, 4, 9) + describe "retryUntil" $ do + it "stops when the check succeeds" $ do + runState (R.retryUntil (R.constPause 42) 5 (isRight <$> mockAction (NumFails 1))) [] + `shouldBe` (True, [ActionCall, ThreadDelayCall 42, ActionCall]) + it "returns False after the last attempt without another pause" $ do + runState (R.retryUntil (R.constPause 42) 1 (isRight <$> mockAction (NumFails 3))) [] + `shouldBe` (False, [ActionCall, ThreadDelayCall 42, ActionCall]) + describe "retryWithCallback" $ do it "does not call onRetry when action succeeds on the first try" $ do runMockRetryWithCallback (R.constPause 42) 2 (mockAction (NumFails 0)) From c917c0b1e96ba175912764feebe4e7ab18743af8 Mon Sep 17 00:00:00 2001 From: Mihovil Ilakovac Date: Wed, 7 Oct 2026 16:45:03 +0200 Subject: [PATCH 16/27] Order dev database functions by workflow --- waspc/cli/src/Wasp/Cli/Command/Db/DevDb.hs | 195 +++++++++++---------- 1 file changed, 98 insertions(+), 97 deletions(-) diff --git a/waspc/cli/src/Wasp/Cli/Command/Db/DevDb.hs b/waspc/cli/src/Wasp/Cli/Command/Db/DevDb.hs index 334b303c4d4..1921139c7e5 100644 --- a/waspc/cli/src/Wasp/Cli/Command/Db/DevDb.hs +++ b/waspc/cli/src/Wasp/Cli/Command/Db/DevDb.hs @@ -46,16 +46,18 @@ import Wasp.Project.Db (databaseUrlEnvVarName) import qualified Wasp.Project.Db.Dev.Postgres as Dev.Postgres import Wasp.Util.Docker (DockerImageName, DockerVolumeMountPath) -printDbMessages :: Chan Job.JobMessage -> IO () -printDbMessages channel = runPrefixedWriter go - where - go = do - message <- liftIO $ readChan channel - case Job._data message of - Job.JobOutput output _ -> do - printJobMessagePrefixed $ Job.JobMessage (Job.JobOutput output Job.Stdout) Job.Db - go - Job.JobExit _ -> return () +data DatabaseStartPolicy = StartNewDatabase | StartOrReuseDatabase + deriving (Eq) + +data DatabaseSession + = ReusedDatabase Dev.Postgres.DevDbSpec + | StartedDatabase Dev.Postgres.DevDbSpec String (Async ExitCode) + +data PreparedDatabase + = ReuseDatabase DatabaseSession + | CreateDatabase Dev.Postgres.DevDbSpec DockerImageName DockerVolumeMountPath + +data DatabaseUrlSource = Environment | ServerDotEnv withDevDb :: DbStartOptions -> (Maybe Dev.Postgres.DevDbSpec -> Command a) -> Command a withDevDb options action = do @@ -75,38 +77,11 @@ withDevDb options action = do withPostgresSession waspProjectDir (ASV.getApp appSpec).name options StartOrReuseDatabase $ action . Just . getDatabaseForSession -data DatabaseStartPolicy = StartNewDatabase | StartOrReuseDatabase - deriving (Eq) - -data DatabaseSession - = ReusedDatabase Dev.Postgres.DevDbSpec - | StartedDatabase Dev.Postgres.DevDbSpec String (Async ExitCode) - -data PreparedDatabase - = ReuseDatabase DatabaseSession - | CreateDatabase Dev.Postgres.DevDbSpec DockerImageName DockerVolumeMountPath - -getDatabaseForSession :: DatabaseSession -> Dev.Postgres.DevDbSpec -getDatabaseForSession (ReusedDatabase db) = db -getDatabaseForSession (StartedDatabase db _ _) = db - withPostgresSession :: Path' Abs (Dir WaspProjectDir) -> String -> DbStartOptions -> DatabaseStartPolicy -> (DatabaseSession -> Command a) -> Command a withPostgresSession waspProjectDir appName options policy action = do prepared <- preparePostgresDevDb waspProjectDir appName options policy bracket (acquire prepared) release use where - use session = do - case session of - StartedDatabase db _ databaseJob -> do - result <- - withDatabaseError "Could not start PostgreSQL" $ - race (wait databaseJob) (Dev.Postgres.waitForDevDbReady db) - case result of - Left _ -> E.throwError $ CommandError "Could not start PostgreSQL" "The Docker process exited before PostgreSQL was ready. Check the database output above." - Right () -> return () - when (policy == StartNewDatabase) $ cliSendMessageC $ Msg.Info $ unlines $ additionalInfoLines db - _ -> return () - action session acquire (ReuseDatabase session) = return session acquire (CreateDatabase db image mountPath) = bracketOnError @@ -122,52 +97,23 @@ withPostgresSession waspProjectDir appName options policy action = do return $ StartedDatabase db containerId databaseJob ) + use session = do + case session of + StartedDatabase db _ databaseJob -> do + result <- + withDatabaseError "Could not start PostgreSQL" $ + race (wait databaseJob) (Dev.Postgres.waitForDevDbReady db) + case result of + Left _ -> E.throwError $ CommandError "Could not start PostgreSQL" "The Docker process exited before PostgreSQL was ready. Check the database output above." + Right () -> return () + when (policy == StartNewDatabase) $ cliSendMessageC $ Msg.Info $ unlines $ additionalInfoLines db + _ -> return () + action session + release (StartedDatabase _ containerId databaseJob) = stopDatabase containerId `finally` (liftIO (cancel databaseJob) `finally` removeContainer containerId) release _ = return () -stopDatabase :: String -> Command () -stopDatabase containerId = do - cliSendMessageC $ Msg.Start "Stopping database..." - failure <- runDockerCleanup ["stop", containerId] - forM_ failure $ \errors -> - cliSendMessageC $ Msg.Warning "Could not stop PostgreSQL" (printf "Wasp will try to remove the container. %s" errors) - -removeContainer :: String -> Command () -removeContainer containerId = do - failure <- runDockerCleanup ["rm", "--force", containerId] - forM_ failure $ \errors -> - cliSendMessageC $ Msg.Warning "Could not remove PostgreSQL container" (printf "Try `docker rm --force %s`. %s" containerId errors) - -runDockerCleanup :: [String] -> Command (Maybe String) -runDockerCleanup args = do - -- create_group keeps terminal Ctrl+C from interrupting Docker's cleanup command. - (status, _, errors) <- liftIO $ readCreateProcessWithExitCode ((proc "docker" args) {create_group = True}) "" - return $ - if status == ExitSuccess || "No such container" `isInfixOf` errors - then Nothing - else Just errors - -throwIfDbStartOptionsSupplied :: String -> DbStartOptions -> Command () -throwIfDbStartOptionsSupplied reason options = - unless (null optionNames) $ E.throwError $ CommandError "Database options do not apply" (printf "%s These options only apply to Wasp-managed PostgreSQL: %s. Remove them to continue." reason (intercalate ", " optionNames)) - where - optionNames = suppliedOptionNames options - -suppliedOptionNames :: DbStartOptions -> [String] -suppliedOptionNames options = - ["--db-port" | isJust options.dbPort] - ++ ["--db-image" | isJust options.dbImage] - ++ ["--db-volume-mount-path" | isJust options.dbVolumeMountPath] - -ensureDockerDaemonAvailable :: Command () -ensureDockerDaemonAvailable = do - throwIfExeIsNotAvailable - "docker" - "To run PostgreSQL dev database, Wasp needs `docker` installed and in PATH." - (exitCode, _, stderr) <- liftIO $ readProcessWithExitCode "docker" ["info", "--format", "{{.ServerVersion}}"] "" - when (exitCode /= ExitSuccess) $ E.throwError $ CommandError "Docker unavailable" (printf "Start Docker and retry. %s" stderr) - preparePostgresDevDb :: Path' Abs (Dir WaspProjectDir) -> String -> DbStartOptions -> DatabaseStartPolicy -> Command PreparedDatabase preparePostgresDevDb waspProjectDir appName options policy = do ensureDockerDaemonAvailable @@ -234,12 +180,73 @@ preparePostgresDevDb waspProjectDir appName options policy = do fst <$> concurrently (runProcessAsJob (proc "docker" ["pull", dbDockerImage]) Job.Db channel) (printDbMessages channel) when (pullStatus /= ExitSuccess) $ E.throwError $ CommandError "Could not pull PostgreSQL image" (printf "Check the image name, registry access, and network connection. Image: %s" dbDockerImage) -withDatabaseError :: String -> IO a -> Command a -withDatabaseError title action = do - result <- liftIO $ try action - case result of - Left (err :: IOException) -> E.throwError $ CommandError title $ ioeGetErrorString err - Right value -> return value +findDatabaseUrlSource :: AS.AppSpec -> IO (Maybe DatabaseUrlSource) +findDatabaseUrlSource appSpec = do + envUrl <- lookupEnv databaseUrlEnvVarName + return $ + if isJust envUrl + then Just Environment + else + if any ((== databaseUrlEnvVarName) . fst) appSpec.devEnvVarsServer + then Just ServerDotEnv + else Nothing + +throwIfDbStartOptionsSupplied :: String -> DbStartOptions -> Command () +throwIfDbStartOptionsSupplied reason options = + unless (null optionNames) $ E.throwError $ CommandError "Database options do not apply" (printf "%s These options only apply to Wasp-managed PostgreSQL: %s. Remove them to continue." reason (intercalate ", " optionNames)) + where + optionNames = suppliedOptionNames options + +suppliedOptionNames :: DbStartOptions -> [String] +suppliedOptionNames options = + ["--db-port" | isJust options.dbPort] + ++ ["--db-image" | isJust options.dbImage] + ++ ["--db-volume-mount-path" | isJust options.dbVolumeMountPath] + +getDatabaseForSession :: DatabaseSession -> Dev.Postgres.DevDbSpec +getDatabaseForSession (ReusedDatabase db) = db +getDatabaseForSession (StartedDatabase db _ _) = db + +ensureDockerDaemonAvailable :: Command () +ensureDockerDaemonAvailable = do + throwIfExeIsNotAvailable + "docker" + "To run PostgreSQL dev database, Wasp needs `docker` installed and in PATH." + (exitCode, _, stderr) <- liftIO $ readProcessWithExitCode "docker" ["info", "--format", "{{.ServerVersion}}"] "" + when (exitCode /= ExitSuccess) $ E.throwError $ CommandError "Docker unavailable" (printf "Start Docker and retry. %s" stderr) + +stopDatabase :: String -> Command () +stopDatabase containerId = do + cliSendMessageC $ Msg.Start "Stopping database..." + failure <- runDockerCleanup ["stop", containerId] + forM_ failure $ \errors -> + cliSendMessageC $ Msg.Warning "Could not stop PostgreSQL" (printf "Wasp will try to remove the container. %s" errors) + +removeContainer :: String -> Command () +removeContainer containerId = do + failure <- runDockerCleanup ["rm", "--force", containerId] + forM_ failure $ \errors -> + cliSendMessageC $ Msg.Warning "Could not remove PostgreSQL container" (printf "Try `docker rm --force %s`. %s" containerId errors) + +runDockerCleanup :: [String] -> Command (Maybe String) +runDockerCleanup args = do + -- create_group keeps terminal Ctrl+C from interrupting Docker's cleanup command. + (status, _, errors) <- liftIO $ readCreateProcessWithExitCode ((proc "docker" args) {create_group = True}) "" + return $ + if status == ExitSuccess || "No such container" `isInfixOf` errors + then Nothing + else Just errors + +printDbMessages :: Chan Job.JobMessage -> IO () +printDbMessages channel = runPrefixedWriter go + where + go = do + message <- liftIO $ readChan channel + case Job._data message of + Job.JobOutput output _ -> do + printJobMessagePrefixed $ Job.JobMessage (Job.JobOutput output Job.Stdout) Job.Db + go + Job.JobExit _ -> return () additionalInfoLines :: Dev.Postgres.DevDbSpec -> [String] additionalInfoLines db = @@ -252,15 +259,9 @@ additionalInfoLines db = printf " %s" db.dockerVolumeName ] -data DatabaseUrlSource = Environment | ServerDotEnv - -findDatabaseUrlSource :: AS.AppSpec -> IO (Maybe DatabaseUrlSource) -findDatabaseUrlSource appSpec = do - envUrl <- lookupEnv databaseUrlEnvVarName - return $ - if isJust envUrl - then Just Environment - else - if any ((== databaseUrlEnvVarName) . fst) appSpec.devEnvVarsServer - then Just ServerDotEnv - else Nothing +withDatabaseError :: String -> IO a -> Command a +withDatabaseError title action = do + result <- liftIO $ try action + case result of + Left (err :: IOException) -> E.throwError $ CommandError title $ ioeGetErrorString err + Right value -> return value From 16e186900da6e28ce141084d45dff598b5312c99 Mon Sep 17 00:00:00 2001 From: Mihovil Ilakovac Date: Mon, 19 Oct 2026 15:27:46 +0200 Subject: [PATCH 17/27] Keep database startup behavior in the existing command module --- waspc/cli/src/Wasp/Cli/Command/Db.hs | 6 +- waspc/cli/src/Wasp/Cli/Command/Db/DevDb.hs | 267 ------------- .../src/Wasp/Cli/Command/Db/StartOptions.hs | 38 -- waspc/cli/src/Wasp/Cli/Command/Start.hs | 4 +- .../Wasp/Cli/Command/Start/ArgumentsParser.hs | 2 +- waspc/cli/src/Wasp/Cli/Command/Start/Db.hs | 371 ++++++++++++++++-- waspc/cli/tests/DbMigrateTest.hs | 2 +- waspc/waspc.cabal | 2 - 8 files changed, 340 insertions(+), 352 deletions(-) delete mode 100644 waspc/cli/src/Wasp/Cli/Command/Db/DevDb.hs delete mode 100644 waspc/cli/src/Wasp/Cli/Command/Db/StartOptions.hs diff --git a/waspc/cli/src/Wasp/Cli/Command/Db.hs b/waspc/cli/src/Wasp/Cli/Command/Db.hs index 296c6296eda..b3094061519 100644 --- a/waspc/cli/src/Wasp/Cli/Command/Db.hs +++ b/waspc/cli/src/Wasp/Cli/Command/Db.hs @@ -11,8 +11,8 @@ import Wasp.Cli.Command.Compile (defaultCompileOptions, withSetupGoals) import Wasp.Cli.Command.Require.DbConnectionEstablished (DbConnectionEstablished (DbConnectionEstablished)) import Wasp.Cli.Command.Require.InWaspProject (InWaspProject (InWaspProject)) import Wasp.Cli.Command.Require.WaspSpecAvailable (WaspSpecAvailable (WaspSpecAvailable)) -import Wasp.Cli.Command.Db.StartOptions (dbStartOptionsParser) -import qualified Wasp.Cli.Command.Db.DevDb as DevDb +import Wasp.Cli.Command.Start.Db (dbStartOptionsParser) +import qualified Wasp.Cli.Command.Start.Db as Start.Db import Wasp.Cli.Compile (waitEnsureCompile) import Wasp.Cli.Util.Parser (ArgsParser (..), withArguments) import Wasp.Generator.Setup (SetupGoal) @@ -23,7 +23,7 @@ runCommandThatRequiresDbRunning parser command args = where databaseArgsParser = parser {optParser = (,) <$> dbStartOptionsParser <*> parser.optParser} run (dbStartOptions, commandArgs) = - DevDb.withDevDb dbStartOptions $ \_ -> command commandArgs + Start.Db.withDevDb dbStartOptions $ \_ -> command commandArgs -- | Prepares what a db command needs before it runs: a compile, -- post-compile setup, and a reachable database. diff --git a/waspc/cli/src/Wasp/Cli/Command/Db/DevDb.hs b/waspc/cli/src/Wasp/Cli/Command/Db/DevDb.hs deleted file mode 100644 index 1921139c7e5..00000000000 --- a/waspc/cli/src/Wasp/Cli/Command/Db/DevDb.hs +++ /dev/null @@ -1,267 +0,0 @@ -module Wasp.Cli.Command.Db.DevDb - ( withDevDb, - withPostgresSession, - DatabaseStartPolicy (..), - DatabaseSession (..), - DatabaseUrlSource (..), - findDatabaseUrlSource, - ) -where - -import Control.Concurrent (Chan, newChan, readChan) -import Control.Concurrent.Async (Async, async, cancel, concurrently, race, wait) -import Control.Exception (IOException, try) -import Control.Monad (forM_, unless, when) -import Control.Monad.Catch (bracket, bracketOnError, finally) -import qualified Control.Monad.Except as E -import Control.Monad.IO.Class (liftIO) -import Data.List (intercalate, isInfixOf) -import Data.Maybe (fromMaybe, isJust) -import Network.Socket (PortNumber) -import StrongPath (Abs, Dir, Path') -import System.Environment (lookupEnv) -import System.Exit (ExitCode (..)) -import System.IO.Error (ioeGetErrorString) -import System.Process (CreateProcess (create_group), proc, readCreateProcessWithExitCode, readProcessWithExitCode) -import Text.Printf (printf) -import qualified Wasp.AppSpec as AS -import qualified Wasp.AppSpec.App as AS.App -import qualified Wasp.AppSpec.App.Db as AS.App.Db -import qualified Wasp.AppSpec.Valid as ASV -import Wasp.Cli.Command (Command, CommandError (CommandError), require) -import Wasp.Cli.Command.Common (throwIfExeIsNotAvailable) -import Wasp.Cli.Command.Compile (analyze) -import Wasp.Cli.Command.Db.StartOptions (DbStartOptions (..)) -import Wasp.Cli.Command.Message (cliSendMessageC) -import Wasp.Cli.Command.Require.InWaspProject (InWaspProject (InWaspProject)) -import Wasp.Cli.Command.Require.WaspSpecAvailable (WaspSpecAvailable (WaspSpecAvailable)) -import Wasp.Cli.Port (resolvePort) -import Wasp.Db.Postgres (defaultPostgresDockerImageSpec, defaultPostgresPort) -import qualified Wasp.Job as Job -import Wasp.Job.IO.PrefixedWriter (printJobMessagePrefixed, runPrefixedWriter) -import Wasp.Job.Process (runProcessAsJob) -import qualified Wasp.Message as Msg -import Wasp.Project.Common (WaspProjectDir) -import Wasp.Project.Db (databaseUrlEnvVarName) -import qualified Wasp.Project.Db.Dev.Postgres as Dev.Postgres -import Wasp.Util.Docker (DockerImageName, DockerVolumeMountPath) - -data DatabaseStartPolicy = StartNewDatabase | StartOrReuseDatabase - deriving (Eq) - -data DatabaseSession - = ReusedDatabase Dev.Postgres.DevDbSpec - | StartedDatabase Dev.Postgres.DevDbSpec String (Async ExitCode) - -data PreparedDatabase - = ReuseDatabase DatabaseSession - | CreateDatabase Dev.Postgres.DevDbSpec DockerImageName DockerVolumeMountPath - -data DatabaseUrlSource = Environment | ServerDotEnv - -withDevDb :: DbStartOptions -> (Maybe Dev.Postgres.DevDbSpec -> Command a) -> Command a -withDevDb options action = do - InWaspProject waspProjectDir <- require - WaspSpecAvailable <- require - appSpec <- analyze waspProjectDir - databaseUrlSource <- liftIO $ findDatabaseUrlSource appSpec - case databaseUrlSource of - Just _ -> do - throwIfDbStartOptionsSupplied "DATABASE_URL is set." options - action Nothing - Nothing -> case ASV.getValidDbSystem appSpec of - AS.App.Db.SQLite -> do - throwIfDbStartOptionsSupplied "This project uses SQLite." options - action Nothing - AS.App.Db.PostgreSQL -> - withPostgresSession waspProjectDir (ASV.getApp appSpec).name options StartOrReuseDatabase $ - action . Just . getDatabaseForSession - -withPostgresSession :: Path' Abs (Dir WaspProjectDir) -> String -> DbStartOptions -> DatabaseStartPolicy -> (DatabaseSession -> Command a) -> Command a -withPostgresSession waspProjectDir appName options policy action = do - prepared <- preparePostgresDevDb waspProjectDir appName options policy - bracket (acquire prepared) release use - where - acquire (ReuseDatabase session) = return session - acquire (CreateDatabase db image mountPath) = - bracketOnError - (withDatabaseError "Could not start PostgreSQL" $ Dev.Postgres.createDevPostgresContainer db image mountPath) - removeContainer - ( \containerId -> do - databaseJob <- liftIO $ async $ do - channel <- newChan - fst - <$> concurrently - (runProcessAsJob (proc "docker" ["start", "--attach", containerId]) Job.Db channel) - (printDbMessages channel) - return $ StartedDatabase db containerId databaseJob - ) - - use session = do - case session of - StartedDatabase db _ databaseJob -> do - result <- - withDatabaseError "Could not start PostgreSQL" $ - race (wait databaseJob) (Dev.Postgres.waitForDevDbReady db) - case result of - Left _ -> E.throwError $ CommandError "Could not start PostgreSQL" "The Docker process exited before PostgreSQL was ready. Check the database output above." - Right () -> return () - when (policy == StartNewDatabase) $ cliSendMessageC $ Msg.Info $ unlines $ additionalInfoLines db - _ -> return () - action session - - release (StartedDatabase _ containerId databaseJob) = - stopDatabase containerId `finally` (liftIO (cancel databaseJob) `finally` removeContainer containerId) - release _ = return () - -preparePostgresDevDb :: Path' Abs (Dir WaspProjectDir) -> String -> DbStartOptions -> DatabaseStartPolicy -> Command PreparedDatabase -preparePostgresDevDb waspProjectDir appName options policy = do - ensureDockerDaemonAvailable - - liftIO (Dev.Postgres.discoverProjectsRunningDevDb waspProjectDir appName) >>= \case - Just runningDb -> case policy of - StartNewDatabase -> - E.throwError $ - CommandError - "PostgreSQL already running" - ( printf - "This project's database is already running on port %s. Stop the command that started it, or run `docker stop %s` before starting it again.\n%s" - (show runningDb.port) - runningDb.dockerContainerName - (unlines $ additionalInfoLines runningDb) - ) - StartOrReuseDatabase -> ReuseDatabase <$> prepareExistingDatabase runningDb - Nothing -> prepareDbOnPort =<< resolveDevDbPort - where - dbDockerImage = fromMaybe (fst defaultPostgresDockerImageSpec) options.dbImage - dbDockerVolumeMountPath = fromMaybe (snd defaultPostgresDockerImageSpec) options.dbVolumeMountPath - - resolveDevDbPort :: Command PortNumber - resolveDevDbPort = - resolvePort - options.dbPort - defaultPostgresPort - [] - "Choose a different port with --db-port, or free up this one." - "Free at least one of those ports by exiting the program listening on it, or choose the port yourself with --db-port." - - prepareExistingDatabase :: Dev.Postgres.DevDbSpec -> Command DatabaseSession - prepareExistingDatabase devDbSpec = do - withDatabaseError "PostgreSQL is not ready" $ Dev.Postgres.waitForDevDbReady devDbSpec - cliSendMessageC $ Msg.Info "PostgreSQL was already running for this project. Wasp did not start it and will not stop it." - unless (null $ suppliedOptionNames options) $ cliSendMessageC $ Msg.Warning "Database options not used" (printf "These options only apply when starting a new container: %s. Stop the running database before changing them." (intercalate ", " (suppliedOptionNames options))) - return $ ReusedDatabase devDbSpec - - prepareDbOnPort :: PortNumber -> Command PreparedDatabase - prepareDbOnPort port = do - let devDbSpec = Dev.Postgres.makeDevPostgresDbSpec waspProjectDir appName port - ensureImageAvailable - cliSendMessageC $ Msg.Start "Starting PostgreSQL..." - cliSendMessageC $ Msg.Info $ unlines dockerRunInfoLines - return $ CreateDatabase devDbSpec dbDockerImage dbDockerVolumeMountPath - - -- These lines describe what Docker is about to use, so we print them - -- only when starting the database: an already running container might have - -- been started with a different image or mount path than the current - -- invocation's arguments. - dockerRunInfoLines :: [String] - dockerRunInfoLines = - [ printf " ℹ Using Docker image: %s" dbDockerImage, - printf " with the data volume mounted at: %s" dbDockerVolumeMountPath - ] - - ensureImageAvailable :: Command () - ensureImageAvailable = do - (imageStatus, _, _) <- liftIO $ readProcessWithExitCode "docker" ["image", "inspect", dbDockerImage] "" - when (imageStatus /= ExitSuccess) $ do - cliSendMessageC $ Msg.Start $ printf "Pulling PostgreSQL image %s..." dbDockerImage - pullStatus <- liftIO $ do - channel <- newChan - fst <$> concurrently (runProcessAsJob (proc "docker" ["pull", dbDockerImage]) Job.Db channel) (printDbMessages channel) - when (pullStatus /= ExitSuccess) $ E.throwError $ CommandError "Could not pull PostgreSQL image" (printf "Check the image name, registry access, and network connection. Image: %s" dbDockerImage) - -findDatabaseUrlSource :: AS.AppSpec -> IO (Maybe DatabaseUrlSource) -findDatabaseUrlSource appSpec = do - envUrl <- lookupEnv databaseUrlEnvVarName - return $ - if isJust envUrl - then Just Environment - else - if any ((== databaseUrlEnvVarName) . fst) appSpec.devEnvVarsServer - then Just ServerDotEnv - else Nothing - -throwIfDbStartOptionsSupplied :: String -> DbStartOptions -> Command () -throwIfDbStartOptionsSupplied reason options = - unless (null optionNames) $ E.throwError $ CommandError "Database options do not apply" (printf "%s These options only apply to Wasp-managed PostgreSQL: %s. Remove them to continue." reason (intercalate ", " optionNames)) - where - optionNames = suppliedOptionNames options - -suppliedOptionNames :: DbStartOptions -> [String] -suppliedOptionNames options = - ["--db-port" | isJust options.dbPort] - ++ ["--db-image" | isJust options.dbImage] - ++ ["--db-volume-mount-path" | isJust options.dbVolumeMountPath] - -getDatabaseForSession :: DatabaseSession -> Dev.Postgres.DevDbSpec -getDatabaseForSession (ReusedDatabase db) = db -getDatabaseForSession (StartedDatabase db _ _) = db - -ensureDockerDaemonAvailable :: Command () -ensureDockerDaemonAvailable = do - throwIfExeIsNotAvailable - "docker" - "To run PostgreSQL dev database, Wasp needs `docker` installed and in PATH." - (exitCode, _, stderr) <- liftIO $ readProcessWithExitCode "docker" ["info", "--format", "{{.ServerVersion}}"] "" - when (exitCode /= ExitSuccess) $ E.throwError $ CommandError "Docker unavailable" (printf "Start Docker and retry. %s" stderr) - -stopDatabase :: String -> Command () -stopDatabase containerId = do - cliSendMessageC $ Msg.Start "Stopping database..." - failure <- runDockerCleanup ["stop", containerId] - forM_ failure $ \errors -> - cliSendMessageC $ Msg.Warning "Could not stop PostgreSQL" (printf "Wasp will try to remove the container. %s" errors) - -removeContainer :: String -> Command () -removeContainer containerId = do - failure <- runDockerCleanup ["rm", "--force", containerId] - forM_ failure $ \errors -> - cliSendMessageC $ Msg.Warning "Could not remove PostgreSQL container" (printf "Try `docker rm --force %s`. %s" containerId errors) - -runDockerCleanup :: [String] -> Command (Maybe String) -runDockerCleanup args = do - -- create_group keeps terminal Ctrl+C from interrupting Docker's cleanup command. - (status, _, errors) <- liftIO $ readCreateProcessWithExitCode ((proc "docker" args) {create_group = True}) "" - return $ - if status == ExitSuccess || "No such container" `isInfixOf` errors - then Nothing - else Just errors - -printDbMessages :: Chan Job.JobMessage -> IO () -printDbMessages channel = runPrefixedWriter go - where - go = do - message <- liftIO $ readChan channel - case Job._data message of - Job.JobOutput output _ -> do - printJobMessagePrefixed $ Job.JobMessage (Job.JobOutput output Job.Stdout) Job.Db - go - Job.JobExit _ -> return () - -additionalInfoLines :: Dev.Postgres.DevDbSpec -> [String] -additionalInfoLines db = - [ "", - "Additional info:", - " ℹ Connection URL, in case you might want to connect with external tools:", - printf " %s" (Dev.Postgres.getDevConnectionUrl db), - " ℹ Database data is persisted in a Docker volume with the following name", - " (useful to know if you will want to delete it at some point):", - printf " %s" db.dockerVolumeName - ] - -withDatabaseError :: String -> IO a -> Command a -withDatabaseError title action = do - result <- liftIO $ try action - case result of - Left (err :: IOException) -> E.throwError $ CommandError title $ ioeGetErrorString err - Right value -> return value diff --git a/waspc/cli/src/Wasp/Cli/Command/Db/StartOptions.hs b/waspc/cli/src/Wasp/Cli/Command/Db/StartOptions.hs deleted file mode 100644 index d0b7dcd5262..00000000000 --- a/waspc/cli/src/Wasp/Cli/Command/Db/StartOptions.hs +++ /dev/null @@ -1,38 +0,0 @@ -module Wasp.Cli.Command.Db.StartOptions - ( DbStartOptions (..), - dbStartOptionsParser, - ) -where - -import Network.Socket (PortNumber) -import qualified Options.Applicative as Opt -import Text.Printf (printf) -import Wasp.Cli.Util.PortArgument (portParser) -import Wasp.Db.Postgres (defaultPostgresPort) -import Wasp.Util.Docker (DockerImageName, DockerVolumeMountPath) - -data DbStartOptions = DbStartOptions - { dbPort :: Maybe PortNumber, - dbImage :: Maybe DockerImageName, - dbVolumeMountPath :: Maybe DockerVolumeMountPath - } - deriving (Eq, Show) - -dbStartOptionsParser :: Opt.Parser DbStartOptions -dbStartOptionsParser = - DbStartOptions - <$> Opt.optional (portParser "db-port" (printf "Port to run the dev database on (default: %s)" (show defaultPostgresPort))) - <*> Opt.optional - ( Opt.strOption - ( Opt.long "db-image" - <> Opt.metavar "IMAGE" - <> Opt.help "Docker image to use for the database" - ) - ) - <*> Opt.optional - ( Opt.strOption - ( Opt.long "db-volume-mount-path" - <> Opt.metavar "PATH" - <> Opt.help "Path inside Docker container where database files are stored" - ) - ) diff --git a/waspc/cli/src/Wasp/Cli/Command/Start.hs b/waspc/cli/src/Wasp/Cli/Command/Start.hs index a2b13e897ea..7cefc3bc34d 100644 --- a/waspc/cli/src/Wasp/Cli/Command/Start.hs +++ b/waspc/cli/src/Wasp/Cli/Command/Start.hs @@ -22,7 +22,7 @@ import Wasp.Cli.Command.News (fetchAndListMustSeeNewsIfDue) import Wasp.Cli.Command.Require.DbConnectionEstablished (DbConnectionEstablished (DbConnectionEstablished)) import Wasp.Cli.Command.Require.InWaspProject (InWaspProject (InWaspProject)) import Wasp.Cli.Command.Start.ArgumentsParser (StartArgs (..), startArgsParser) -import qualified Wasp.Cli.Command.Db.DevDb as DevDb +import qualified Wasp.Cli.Command.Start.Db as Start.Db import Wasp.Cli.Command.Watch (watch) import Wasp.Cli.EnvVarWithCtx (addEnvVarsUniqueC) import qualified Wasp.Cli.EnvVarWithCtx as EnvVarWithCtx @@ -42,7 +42,7 @@ import qualified Wasp.Project.Env as Env -- It also listens for any file changes and recompiles and restarts generated project accordingly. start :: Arguments -> Command () start = withArguments startArgsParser $ \args -> - ProjectLock.acquireWatcher $ \projectLock -> DevDb.withDevDb args.dbStartOptions $ \managedDb -> do + ProjectLock.acquireWatcher $ \projectLock -> Start.Db.withDevDb args.dbStartOptions $ \managedDb -> do -- We check for the news only in `wasp start`, and only periodically, -- to avoid being too aggressive. Specifically: -- - We don't run it in other `wasp` commands because we don't want to diff --git a/waspc/cli/src/Wasp/Cli/Command/Start/ArgumentsParser.hs b/waspc/cli/src/Wasp/Cli/Command/Start/ArgumentsParser.hs index ed4bf69e6bd..f7241d668db 100644 --- a/waspc/cli/src/Wasp/Cli/Command/Start/ArgumentsParser.hs +++ b/waspc/cli/src/Wasp/Cli/Command/Start/ArgumentsParser.hs @@ -7,7 +7,7 @@ where import Network.Socket (PortNumber) import Network.URI (URI) import qualified Options.Applicative as Opt -import Wasp.Cli.Command.Db.StartOptions (DbStartOptions, dbStartOptionsParser) +import Wasp.Cli.Command.Start.Db (DbStartOptions, dbStartOptionsParser) import Wasp.Cli.Util.HttpUrlArgument (httpUrlParser) import Wasp.Cli.Util.Parser (ArgsParser (..)) import Wasp.Cli.Util.PortArgument (portParser) diff --git a/waspc/cli/src/Wasp/Cli/Command/Start/Db.hs b/waspc/cli/src/Wasp/Cli/Command/Start/Db.hs index 4a5c772c97b..442ec2239da 100644 --- a/waspc/cli/src/Wasp/Cli/Command/Start/Db.hs +++ b/waspc/cli/src/Wasp/Cli/Command/Start/Db.hs @@ -1,73 +1,368 @@ module Wasp.Cli.Command.Start.Db ( start, + withDevDb, + DbStartOptions (..), + dbStartOptionsParser, ) where -import Control.Concurrent.Async (wait) -import Control.Monad (forM_) +import Control.Concurrent (Chan, newChan, readChan) +import Control.Concurrent.Async (Async, async, cancel, concurrently, race, wait) +import Control.Exception (IOException, try) +import Control.Monad (forM_, unless, when) +import Control.Monad.Catch (bracket, bracketOnError, finally) import qualified Control.Monad.Except as E import Control.Monad.IO.Class (liftIO) -import StrongPath (File', Path', Rel, fromRelFile) +import Data.List (intercalate, isInfixOf) +import Data.Maybe (fromMaybe, isJust) +import Network.Socket (PortNumber) +import qualified Options.Applicative as Opt +import StrongPath (Abs, Dir, File', Path', Rel, fromRelFile) +import System.Environment (lookupEnv) +import System.Exit (ExitCode (..)) +import System.IO.Error (ioeGetErrorString) +import System.Process (CreateProcess (create_group), proc, readCreateProcessWithExitCode, readProcessWithExitCode) import Text.Printf (printf) -import Wasp.AppSpec (AppSpec) +import qualified Wasp.AppSpec as AS import qualified Wasp.AppSpec.App as AS.App import qualified Wasp.AppSpec.App.Db as AS.App.Db import qualified Wasp.AppSpec.Valid as ASV import Wasp.Cli.Command (Command, CommandError (CommandError), require) import Wasp.Cli.Command.Call (Arguments) +import Wasp.Cli.Command.Common (throwIfExeIsNotAvailable) import Wasp.Cli.Command.Compile (analyze) -import Wasp.Cli.Command.Db.DevDb - ( DatabaseSession (..), - DatabaseStartPolicy (..), - DatabaseUrlSource (..), - findDatabaseUrlSource, - withPostgresSession, - ) -import Wasp.Cli.Command.Db.StartOptions (dbStartOptionsParser) import Wasp.Cli.Command.Message (cliSendMessageC) import Wasp.Cli.Command.Require.InWaspProject (InWaspProject (InWaspProject)) import Wasp.Cli.Command.Require.WaspSpecAvailable (WaspSpecAvailable (WaspSpecAvailable)) +import Wasp.Cli.Port (resolvePort) import Wasp.Cli.Util.Parser (ArgsParser (..), withArguments) +import Wasp.Cli.Util.PortArgument (portParser) +import Wasp.Db.Postgres (defaultPostgresDockerImageSpec, defaultPostgresPort) +import qualified Wasp.Job as Job +import Wasp.Job.IO.PrefixedWriter (printJobMessagePrefixed, runPrefixedWriter) +import Wasp.Job.Process (runProcessAsJob) import qualified Wasp.Message as Msg import Wasp.Project.Common (WaspProjectDir) import Wasp.Project.Db (databaseUrlEnvVarName) +import qualified Wasp.Project.Db.Dev.Postgres as Dev.Postgres import Wasp.Project.Env (dotEnvServer) +import Wasp.Util.Docker (DockerImageName, DockerVolumeMountPath) -- | Starts a "managed" dev database, where "managed" means that -- Wasp creates it and connects the Wasp app with it. -- Wasp is smart while doing this so it checks which database is specified -- in Wasp configuration and spins up a database of appropriate type. start :: Arguments -> Command () -start = withArguments (ArgsParser "wasp db start" dbStartOptionsParser) $ \options -> do +start = withArguments startDbArgsParser $ \args -> do InWaspProject waspProjectDir <- require WaspSpecAvailable <- require appSpec <- analyze waspProjectDir - ensureNoDatabaseUrlOverride appSpec + + throwIfCustomDbAlreadyInUse appSpec + + let app = ASV.getApp appSpec + case ASV.getValidDbSystem appSpec of - AS.App.Db.SQLite -> - cliSendMessageC $ Msg.Info "Nothing to do! You are all good, you are using SQLite which doesn't need to be started." + AS.App.Db.SQLite -> noteSQLiteDoesntNeedStart AS.App.Db.PostgreSQL -> - withPostgresSession waspProjectDir (ASV.getApp appSpec).name options StartNewDatabase $ \case - StartedDatabase _ _ databaseJob -> do - cliSendMessageC $ Msg.Info "PostgreSQL is running. Ctrl+C stops PostgreSQL." - _ <- liftIO $ wait databaseJob - E.throwError $ CommandError "PostgreSQL stopped" "The database container exited. Check the PostgreSQL logs above." - ReusedDatabase _ -> - E.throwError $ CommandError "Database not started" "No managed PostgreSQL database was started." - -ensureNoDatabaseUrlOverride :: AppSpec -> Command () -ensureNoDatabaseUrlOverride appSpec = do + startPostgresDevDb + waspProjectDir + app.name + args + where + noteSQLiteDoesntNeedStart = + cliSendMessageC . Msg.Info $ + "Nothing to do! You are all good, you are using SQLite which doesn't need to be started." + +startDbArgsParser :: ArgsParser DbStartOptions +startDbArgsParser = ArgsParser "wasp start db" dbStartOptionsParser + +data DbStartOptions = DbStartOptions + { dbPort :: Maybe PortNumber, + dbImage :: Maybe DockerImageName, + dbVolumeMountPath :: Maybe DockerVolumeMountPath + } + deriving (Eq, Show) + +dbStartOptionsParser :: Opt.Parser DbStartOptions +dbStartOptionsParser = + DbStartOptions + <$> Opt.optional (portParser "db-port" ("Port to run the dev database on (default: " ++ show defaultPostgresPort ++ ")")) + <*> Opt.optional + ( Opt.strOption + ( Opt.long "db-image" + <> Opt.metavar "IMAGE" + <> Opt.help "Docker image to use for the database" + ) + ) + <*> Opt.optional + ( Opt.strOption + ( Opt.long "db-volume-mount-path" + <> Opt.metavar "PATH" + <> Opt.help "Path inside Docker container where database files are stored" + ) + ) + +throwIfCustomDbAlreadyInUse :: AS.AppSpec -> Command () +throwIfCustomDbAlreadyInUse spec = do + throwIfDbUrlInEnv + throwIfDbUrlInServerDotEnv spec + where + throwIfDbUrlInEnv :: Command () + throwIfDbUrlInEnv = do + dbUrl <- liftIO $ lookupEnv databaseUrlEnvVarName + when (isJust dbUrl) $ + throwCustomDbAlreadyInUseError + ( "Wasp has detected existing " + <> databaseUrlEnvVarName + <> " var in your environment.\n" + <> "To have Wasp run the dev database for you, make sure you remove that env var first." + ) + + throwIfDbUrlInServerDotEnv :: AS.AppSpec -> Command () + throwIfDbUrlInServerDotEnv appSpec = + when (isThereDbUrlInServerDotEnv appSpec) $ + throwCustomDbAlreadyInUseError + ( printf + ( "Wasp has detected that you have defined %s env var in your %s file.\n" + <> "To have Wasp run the dev database for you, make sure you remove that env var first." + ) + databaseUrlEnvVarName + (fromRelFile (dotEnvServer :: Path' (Rel WaspProjectDir) File')) + ) + where + isThereDbUrlInServerDotEnv = any ((== databaseUrlEnvVarName) . fst) . AS.devEnvVarsServer + + throwCustomDbAlreadyInUseError :: String -> Command () + throwCustomDbAlreadyInUseError msg = + E.throwError $ CommandError "You are using custom database already" msg + +startPostgresDevDb :: Path' Abs (Dir WaspProjectDir) -> String -> DbStartOptions -> Command () +startPostgresDevDb waspProjectDir appName options = + withPostgresSession waspProjectDir appName options StartNewDatabase $ \case + StartedDatabase _ _ databaseJob -> do + cliSendMessageC $ Msg.Info "PostgreSQL is running. Ctrl+C stops PostgreSQL." + _ <- liftIO $ wait databaseJob + E.throwError $ CommandError "PostgreSQL stopped" "The database container exited. Check the PostgreSQL logs above." + ReusedDatabase _ -> + E.throwError $ CommandError "Database not started" "No managed PostgreSQL database was started." + +data DatabaseStartPolicy = StartNewDatabase | StartOrReuseDatabase + deriving (Eq) + +data DatabaseSession + = ReusedDatabase Dev.Postgres.DevDbSpec + | StartedDatabase Dev.Postgres.DevDbSpec String (Async ExitCode) + +data PreparedDatabase + = ReuseDatabase DatabaseSession + | CreateDatabase Dev.Postgres.DevDbSpec DockerImageName DockerVolumeMountPath + +data DatabaseUrlSource = Environment | ServerDotEnv + +withDevDb :: DbStartOptions -> (Maybe Dev.Postgres.DevDbSpec -> Command a) -> Command a +withDevDb options action = do + InWaspProject waspProjectDir <- require + WaspSpecAvailable <- require + appSpec <- analyze waspProjectDir databaseUrlSource <- liftIO $ findDatabaseUrlSource appSpec - forM_ databaseUrlSource $ \source -> - E.throwError $ CommandError "You are using custom database already" (message source) + case databaseUrlSource of + Just _ -> do + throwIfDbStartOptionsSupplied "DATABASE_URL is set." options + action Nothing + Nothing -> case ASV.getValidDbSystem appSpec of + AS.App.Db.SQLite -> do + throwIfDbStartOptionsSupplied "This project uses SQLite." options + action Nothing + AS.App.Db.PostgreSQL -> + withPostgresSession waspProjectDir (ASV.getApp appSpec).name options StartOrReuseDatabase $ + action . Just . getDatabaseForSession + +withPostgresSession :: Path' Abs (Dir WaspProjectDir) -> String -> DbStartOptions -> DatabaseStartPolicy -> (DatabaseSession -> Command a) -> Command a +withPostgresSession waspProjectDir appName options policy action = do + prepared <- preparePostgresDevDb waspProjectDir appName options policy + bracket (acquire prepared) release use where - message source = case source of - Environment -> - printf - "Wasp has detected existing %s var in your environment.\nTo have Wasp run the dev database for you, make sure you remove that env var first." - databaseUrlEnvVarName - ServerDotEnv -> - printf - "Wasp has detected that you have defined %s env var in your %s file.\nTo have Wasp run the dev database for you, make sure you remove that env var first." - databaseUrlEnvVarName - (fromRelFile (dotEnvServer :: Path' (Rel WaspProjectDir) File')) + acquire (ReuseDatabase session) = return session + acquire (CreateDatabase db image mountPath) = + bracketOnError + (withDatabaseError "Could not start PostgreSQL" $ Dev.Postgres.createDevPostgresContainer db image mountPath) + removeContainer + ( \containerId -> do + databaseJob <- liftIO $ async $ do + channel <- newChan + fst + <$> concurrently + (runProcessAsJob (proc "docker" ["start", "--attach", containerId]) Job.Db channel) + (printDbMessages channel) + return $ StartedDatabase db containerId databaseJob + ) + + use session = do + case session of + StartedDatabase db _ databaseJob -> do + result <- + withDatabaseError "Could not start PostgreSQL" $ + race (wait databaseJob) (Dev.Postgres.waitForDevDbReady db) + case result of + Left _ -> E.throwError $ CommandError "Could not start PostgreSQL" "The Docker process exited before PostgreSQL was ready. Check the database output above." + Right () -> return () + when (policy == StartNewDatabase) $ cliSendMessageC $ Msg.Info $ unlines $ additionalInfoLines db + _ -> return () + action session + + release (StartedDatabase _ containerId databaseJob) = + stopDatabase containerId `finally` (liftIO (cancel databaseJob) `finally` removeContainer containerId) + release _ = return () + +preparePostgresDevDb :: Path' Abs (Dir WaspProjectDir) -> String -> DbStartOptions -> DatabaseStartPolicy -> Command PreparedDatabase +preparePostgresDevDb waspProjectDir appName options policy = do + ensureDockerDaemonAvailable + + liftIO (Dev.Postgres.discoverProjectsRunningDevDb waspProjectDir appName) >>= \case + Just runningDb -> case policy of + StartNewDatabase -> + E.throwError $ + CommandError + "PostgreSQL already running" + ( printf + "This project's database is already running on port %s. Stop the command that started it, or run `docker stop %s` before starting it again.\n%s" + (show runningDb.port) + runningDb.dockerContainerName + (unlines $ additionalInfoLines runningDb) + ) + StartOrReuseDatabase -> ReuseDatabase <$> prepareExistingDatabase runningDb + Nothing -> prepareDbOnPort =<< resolveDevDbPort + where + dbDockerImage = fromMaybe (fst defaultPostgresDockerImageSpec) options.dbImage + dbDockerVolumeMountPath = fromMaybe (snd defaultPostgresDockerImageSpec) options.dbVolumeMountPath + + resolveDevDbPort :: Command PortNumber + resolveDevDbPort = + resolvePort + options.dbPort + defaultPostgresPort + [] + "Choose a different port with --db-port, or free up this one." + "Free at least one of those ports by exiting the program listening on it, or choose the port yourself with --db-port." + + prepareExistingDatabase :: Dev.Postgres.DevDbSpec -> Command DatabaseSession + prepareExistingDatabase devDbSpec = do + withDatabaseError "PostgreSQL is not ready" $ Dev.Postgres.waitForDevDbReady devDbSpec + cliSendMessageC $ Msg.Info "PostgreSQL was already running for this project. Wasp did not start it and will not stop it." + unless (null $ suppliedOptionNames options) $ cliSendMessageC $ Msg.Warning "Database options not used" (printf "These options only apply when starting a new container: %s. Stop the running database before changing them." (intercalate ", " (suppliedOptionNames options))) + return $ ReusedDatabase devDbSpec + + prepareDbOnPort :: PortNumber -> Command PreparedDatabase + prepareDbOnPort port = do + let devDbSpec = Dev.Postgres.makeDevPostgresDbSpec waspProjectDir appName port + ensureImageAvailable + cliSendMessageC $ Msg.Start "Starting PostgreSQL..." + cliSendMessageC $ Msg.Info $ unlines dockerRunInfoLines + return $ CreateDatabase devDbSpec dbDockerImage dbDockerVolumeMountPath + + -- These lines describe what Docker is about to use, so we print them + -- only when starting the database: an already running container might have + -- been started with a different image or mount path than the current + -- invocation's arguments. + dockerRunInfoLines :: [String] + dockerRunInfoLines = + [ " ℹ Using Docker image: " <> dbDockerImage, + " with the data volume mounted at: " <> dbDockerVolumeMountPath + ] + + ensureImageAvailable :: Command () + ensureImageAvailable = do + (imageStatus, _, _) <- liftIO $ readProcessWithExitCode "docker" ["image", "inspect", dbDockerImage] "" + when (imageStatus /= ExitSuccess) $ do + cliSendMessageC $ Msg.Start $ printf "Pulling PostgreSQL image %s..." dbDockerImage + pullStatus <- liftIO $ do + channel <- newChan + fst <$> concurrently (runProcessAsJob (proc "docker" ["pull", dbDockerImage]) Job.Db channel) (printDbMessages channel) + when (pullStatus /= ExitSuccess) $ E.throwError $ CommandError "Could not pull PostgreSQL image" (printf "Check the image name, registry access, and network connection. Image: %s" dbDockerImage) + +findDatabaseUrlSource :: AS.AppSpec -> IO (Maybe DatabaseUrlSource) +findDatabaseUrlSource appSpec = do + envUrl <- lookupEnv databaseUrlEnvVarName + return $ + if isJust envUrl + then Just Environment + else + if any ((== databaseUrlEnvVarName) . fst) appSpec.devEnvVarsServer + then Just ServerDotEnv + else Nothing + +throwIfDbStartOptionsSupplied :: String -> DbStartOptions -> Command () +throwIfDbStartOptionsSupplied reason options = + unless (null optionNames) $ E.throwError $ CommandError "Database options do not apply" (printf "%s These options only apply to Wasp-managed PostgreSQL: %s. Remove them to continue." reason (intercalate ", " optionNames)) + where + optionNames = suppliedOptionNames options + +suppliedOptionNames :: DbStartOptions -> [String] +suppliedOptionNames options = + ["--db-port" | isJust options.dbPort] + ++ ["--db-image" | isJust options.dbImage] + ++ ["--db-volume-mount-path" | isJust options.dbVolumeMountPath] + +getDatabaseForSession :: DatabaseSession -> Dev.Postgres.DevDbSpec +getDatabaseForSession (ReusedDatabase db) = db +getDatabaseForSession (StartedDatabase db _ _) = db + +ensureDockerDaemonAvailable :: Command () +ensureDockerDaemonAvailable = do + throwIfExeIsNotAvailable + "docker" + "To run PostgreSQL dev database, Wasp needs `docker` installed and in PATH." + (exitCode, _, stderr) <- liftIO $ readProcessWithExitCode "docker" ["info", "--format", "{{.ServerVersion}}"] "" + when (exitCode /= ExitSuccess) $ E.throwError $ CommandError "Docker unavailable" (printf "Start Docker and retry. %s" stderr) + +stopDatabase :: String -> Command () +stopDatabase containerId = do + cliSendMessageC $ Msg.Start "Stopping database..." + failure <- runDockerCleanup ["stop", containerId] + forM_ failure $ \errors -> + cliSendMessageC $ Msg.Warning "Could not stop PostgreSQL" (printf "Wasp will try to remove the container. %s" errors) + +removeContainer :: String -> Command () +removeContainer containerId = do + failure <- runDockerCleanup ["rm", "--force", containerId] + forM_ failure $ \errors -> + cliSendMessageC $ Msg.Warning "Could not remove PostgreSQL container" (printf "Try `docker rm --force %s`. %s" containerId errors) + +runDockerCleanup :: [String] -> Command (Maybe String) +runDockerCleanup args = do + -- create_group keeps terminal Ctrl+C from interrupting Docker's cleanup command. + (status, _, errors) <- liftIO $ readCreateProcessWithExitCode ((proc "docker" args) {create_group = True}) "" + return $ + if status == ExitSuccess || "No such container" `isInfixOf` errors + then Nothing + else Just errors + +printDbMessages :: Chan Job.JobMessage -> IO () +printDbMessages channel = runPrefixedWriter go + where + go = do + message <- liftIO $ readChan channel + case Job._data message of + Job.JobOutput output _ -> do + printJobMessagePrefixed $ Job.JobMessage (Job.JobOutput output Job.Stdout) Job.Db + go + Job.JobExit _ -> return () + +additionalInfoLines :: Dev.Postgres.DevDbSpec -> [String] +additionalInfoLines devDbSpec = + [ "", + "Additional info:", + " ℹ Connection URL, in case you might want to connect with external tools:", + " " <> Dev.Postgres.getDevConnectionUrl devDbSpec, + " ℹ Database data is persisted in a Docker volume with the following name" + <> " (useful to know if you will want to delete it at some point):", + " " <> devDbSpec.dockerVolumeName + ] + +withDatabaseError :: String -> IO a -> Command a +withDatabaseError title action = do + result <- liftIO $ try action + case result of + Left (err :: IOException) -> E.throwError $ CommandError title $ ioeGetErrorString err + Right value -> return value diff --git a/waspc/cli/tests/DbMigrateTest.hs b/waspc/cli/tests/DbMigrateTest.hs index a297c0badb8..0c340da76c8 100644 --- a/waspc/cli/tests/DbMigrateTest.hs +++ b/waspc/cli/tests/DbMigrateTest.hs @@ -3,7 +3,7 @@ module DbMigrateTest where import qualified Options.Applicative as Opt import Test.Hspec import Wasp.Cli.Command.Db.Migrate (migrateArgsParser) -import Wasp.Cli.Command.Db.StartOptions (DbStartOptions (..), dbStartOptionsParser) +import Wasp.Cli.Command.Start.Db (DbStartOptions (..), dbStartOptionsParser) import Wasp.Cli.Util.Parser (ArgsParser (optParser)) import Wasp.Generator.DbGenerator.Common (MigrateArgs (..), defaultMigrateArgs) diff --git a/waspc/waspc.cabal b/waspc/waspc.cabal index a72508e2572..58151ca7a61 100644 --- a/waspc/waspc.cabal +++ b/waspc/waspc.cabal @@ -474,11 +474,9 @@ library cli-lib Wasp.Cli.Command.CreateNewProject.StarterTemplates.GhReleaseArchive Wasp.Cli.Command.CreateNewProject.StarterTemplates.Templating Wasp.Cli.Command.Db - Wasp.Cli.Command.Db.DevDb Wasp.Cli.Command.Db.Migrate Wasp.Cli.Command.Db.Reset Wasp.Cli.Command.Db.Seed - Wasp.Cli.Command.Db.StartOptions Wasp.Cli.Command.Db.Studio Wasp.Cli.Command.Deploy Wasp.Cli.Command.Deps From 07ba113d9223027c6d1f92a18855b663b3501278 Mon Sep 17 00:00:00 2001 From: Mihovil Ilakovac Date: Mon, 19 Oct 2026 15:51:47 +0200 Subject: [PATCH 18/27] Group development database Docker operations in a helper module --- waspc/cli/src/Wasp/Cli/Command/Db/Docker.hs | 80 ++++++++++++++++++++ waspc/cli/src/Wasp/Cli/Command/Start/Db.hs | 81 +++------------------ waspc/waspc.cabal | 1 + 3 files changed, 91 insertions(+), 71 deletions(-) create mode 100644 waspc/cli/src/Wasp/Cli/Command/Db/Docker.hs diff --git a/waspc/cli/src/Wasp/Cli/Command/Db/Docker.hs b/waspc/cli/src/Wasp/Cli/Command/Db/Docker.hs new file mode 100644 index 00000000000..ace58f23fa7 --- /dev/null +++ b/waspc/cli/src/Wasp/Cli/Command/Db/Docker.hs @@ -0,0 +1,80 @@ +module Wasp.Cli.Command.Db.Docker + ( ensureDockerDaemonAvailable, + ensureImageAvailable, + runDockerCommand, + stopDatabase, + removeContainer, + ) +where + +import Control.Concurrent (Chan, newChan, readChan) +import Control.Concurrent.Async (concurrently) +import Control.Monad (forM_, when) +import qualified Control.Monad.Except as E +import Control.Monad.IO.Class (liftIO) +import Data.List (isInfixOf) +import System.Exit (ExitCode (..)) +import System.Process (CreateProcess (create_group), proc, readCreateProcessWithExitCode, readProcessWithExitCode) +import Text.Printf (printf) +import Wasp.Cli.Command (Command, CommandError (CommandError)) +import Wasp.Cli.Command.Common (throwIfExeIsNotAvailable) +import Wasp.Cli.Command.Message (cliSendMessageC) +import qualified Wasp.Job as Job +import Wasp.Job.IO.PrefixedWriter (printJobMessagePrefixed, runPrefixedWriter) +import Wasp.Job.Process (runProcessAsJob) +import qualified Wasp.Message as Msg +import Wasp.Util.Docker (DockerImageName) + +ensureDockerDaemonAvailable :: Command () +ensureDockerDaemonAvailable = do + throwIfExeIsNotAvailable + "docker" + "To run PostgreSQL dev database, Wasp needs `docker` installed and in PATH." + (exitCode, _, stderr) <- liftIO $ readProcessWithExitCode "docker" ["info", "--format", "{{.ServerVersion}}"] "" + when (exitCode /= ExitSuccess) $ E.throwError $ CommandError "Docker unavailable" (printf "Start Docker and retry. %s" stderr) + +ensureImageAvailable :: DockerImageName -> Command () +ensureImageAvailable dbDockerImage = do + (imageStatus, _, _) <- liftIO $ readProcessWithExitCode "docker" ["image", "inspect", dbDockerImage] "" + when (imageStatus /= ExitSuccess) $ do + cliSendMessageC $ Msg.Start $ printf "Pulling PostgreSQL image %s..." dbDockerImage + pullStatus <- liftIO $ runDockerCommand ["pull", dbDockerImage] + when (pullStatus /= ExitSuccess) $ E.throwError $ CommandError "Could not pull PostgreSQL image" (printf "Check the image name, registry access, and network connection. Image: %s" dbDockerImage) + +runDockerCommand :: [String] -> IO ExitCode +runDockerCommand args = do + channel <- newChan + fst <$> concurrently (runProcessAsJob (proc "docker" args) Job.Db channel) (printDbMessages channel) + +stopDatabase :: String -> Command () +stopDatabase containerId = do + cliSendMessageC $ Msg.Start "Stopping database..." + failure <- runDockerCleanup ["stop", containerId] + forM_ failure $ \errors -> + cliSendMessageC $ Msg.Warning "Could not stop PostgreSQL" (printf "Wasp will try to remove the container. %s" errors) + +removeContainer :: String -> Command () +removeContainer containerId = do + failure <- runDockerCleanup ["rm", "--force", containerId] + forM_ failure $ \errors -> + cliSendMessageC $ Msg.Warning "Could not remove PostgreSQL container" (printf "Try `docker rm --force %s`. %s" containerId errors) + +runDockerCleanup :: [String] -> Command (Maybe String) +runDockerCleanup args = do + -- create_group keeps terminal Ctrl+C from interrupting Docker's cleanup command. + (status, _, errors) <- liftIO $ readCreateProcessWithExitCode ((proc "docker" args) {create_group = True}) "" + return $ + if status == ExitSuccess || "No such container" `isInfixOf` errors + then Nothing + else Just errors + +printDbMessages :: Chan Job.JobMessage -> IO () +printDbMessages channel = runPrefixedWriter go + where + go = do + message <- liftIO $ readChan channel + case Job._data message of + Job.JobOutput output _ -> do + printJobMessagePrefixed $ Job.JobMessage (Job.JobOutput output Job.Stdout) Job.Db + go + Job.JobExit _ -> return () diff --git a/waspc/cli/src/Wasp/Cli/Command/Start/Db.hs b/waspc/cli/src/Wasp/Cli/Command/Start/Db.hs index 442ec2239da..f0c0ae5f1da 100644 --- a/waspc/cli/src/Wasp/Cli/Command/Start/Db.hs +++ b/waspc/cli/src/Wasp/Cli/Command/Start/Db.hs @@ -6,22 +6,20 @@ module Wasp.Cli.Command.Start.Db ) where -import Control.Concurrent (Chan, newChan, readChan) -import Control.Concurrent.Async (Async, async, cancel, concurrently, race, wait) +import Control.Concurrent.Async (Async, async, cancel, race, wait) import Control.Exception (IOException, try) -import Control.Monad (forM_, unless, when) +import Control.Monad (unless, when) import Control.Monad.Catch (bracket, bracketOnError, finally) import qualified Control.Monad.Except as E import Control.Monad.IO.Class (liftIO) -import Data.List (intercalate, isInfixOf) +import Data.List (intercalate) import Data.Maybe (fromMaybe, isJust) import Network.Socket (PortNumber) import qualified Options.Applicative as Opt import StrongPath (Abs, Dir, File', Path', Rel, fromRelFile) import System.Environment (lookupEnv) -import System.Exit (ExitCode (..)) +import System.Exit (ExitCode) import System.IO.Error (ioeGetErrorString) -import System.Process (CreateProcess (create_group), proc, readCreateProcessWithExitCode, readProcessWithExitCode) import Text.Printf (printf) import qualified Wasp.AppSpec as AS import qualified Wasp.AppSpec.App as AS.App @@ -29,8 +27,8 @@ import qualified Wasp.AppSpec.App.Db as AS.App.Db import qualified Wasp.AppSpec.Valid as ASV import Wasp.Cli.Command (Command, CommandError (CommandError), require) import Wasp.Cli.Command.Call (Arguments) -import Wasp.Cli.Command.Common (throwIfExeIsNotAvailable) import Wasp.Cli.Command.Compile (analyze) +import qualified Wasp.Cli.Command.Db.Docker as Docker import Wasp.Cli.Command.Message (cliSendMessageC) import Wasp.Cli.Command.Require.InWaspProject (InWaspProject (InWaspProject)) import Wasp.Cli.Command.Require.WaspSpecAvailable (WaspSpecAvailable (WaspSpecAvailable)) @@ -38,9 +36,6 @@ import Wasp.Cli.Port (resolvePort) import Wasp.Cli.Util.Parser (ArgsParser (..), withArguments) import Wasp.Cli.Util.PortArgument (portParser) import Wasp.Db.Postgres (defaultPostgresDockerImageSpec, defaultPostgresPort) -import qualified Wasp.Job as Job -import Wasp.Job.IO.PrefixedWriter (printJobMessagePrefixed, runPrefixedWriter) -import Wasp.Job.Process (runProcessAsJob) import qualified Wasp.Message as Msg import Wasp.Project.Common (WaspProjectDir) import Wasp.Project.Db (databaseUrlEnvVarName) @@ -187,14 +182,9 @@ withPostgresSession waspProjectDir appName options policy action = do acquire (CreateDatabase db image mountPath) = bracketOnError (withDatabaseError "Could not start PostgreSQL" $ Dev.Postgres.createDevPostgresContainer db image mountPath) - removeContainer + Docker.removeContainer ( \containerId -> do - databaseJob <- liftIO $ async $ do - channel <- newChan - fst - <$> concurrently - (runProcessAsJob (proc "docker" ["start", "--attach", containerId]) Job.Db channel) - (printDbMessages channel) + databaseJob <- liftIO $ async $ Docker.runDockerCommand ["start", "--attach", containerId] return $ StartedDatabase db containerId databaseJob ) @@ -212,12 +202,12 @@ withPostgresSession waspProjectDir appName options policy action = do action session release (StartedDatabase _ containerId databaseJob) = - stopDatabase containerId `finally` (liftIO (cancel databaseJob) `finally` removeContainer containerId) + Docker.stopDatabase containerId `finally` (liftIO (cancel databaseJob) `finally` Docker.removeContainer containerId) release _ = return () preparePostgresDevDb :: Path' Abs (Dir WaspProjectDir) -> String -> DbStartOptions -> DatabaseStartPolicy -> Command PreparedDatabase preparePostgresDevDb waspProjectDir appName options policy = do - ensureDockerDaemonAvailable + Docker.ensureDockerDaemonAvailable liftIO (Dev.Postgres.discoverProjectsRunningDevDb waspProjectDir appName) >>= \case Just runningDb -> case policy of @@ -256,7 +246,7 @@ preparePostgresDevDb waspProjectDir appName options policy = do prepareDbOnPort :: PortNumber -> Command PreparedDatabase prepareDbOnPort port = do let devDbSpec = Dev.Postgres.makeDevPostgresDbSpec waspProjectDir appName port - ensureImageAvailable + Docker.ensureImageAvailable dbDockerImage cliSendMessageC $ Msg.Start "Starting PostgreSQL..." cliSendMessageC $ Msg.Info $ unlines dockerRunInfoLines return $ CreateDatabase devDbSpec dbDockerImage dbDockerVolumeMountPath @@ -271,16 +261,6 @@ preparePostgresDevDb waspProjectDir appName options policy = do " with the data volume mounted at: " <> dbDockerVolumeMountPath ] - ensureImageAvailable :: Command () - ensureImageAvailable = do - (imageStatus, _, _) <- liftIO $ readProcessWithExitCode "docker" ["image", "inspect", dbDockerImage] "" - when (imageStatus /= ExitSuccess) $ do - cliSendMessageC $ Msg.Start $ printf "Pulling PostgreSQL image %s..." dbDockerImage - pullStatus <- liftIO $ do - channel <- newChan - fst <$> concurrently (runProcessAsJob (proc "docker" ["pull", dbDockerImage]) Job.Db channel) (printDbMessages channel) - when (pullStatus /= ExitSuccess) $ E.throwError $ CommandError "Could not pull PostgreSQL image" (printf "Check the image name, registry access, and network connection. Image: %s" dbDockerImage) - findDatabaseUrlSource :: AS.AppSpec -> IO (Maybe DatabaseUrlSource) findDatabaseUrlSource appSpec = do envUrl <- lookupEnv databaseUrlEnvVarName @@ -308,47 +288,6 @@ getDatabaseForSession :: DatabaseSession -> Dev.Postgres.DevDbSpec getDatabaseForSession (ReusedDatabase db) = db getDatabaseForSession (StartedDatabase db _ _) = db -ensureDockerDaemonAvailable :: Command () -ensureDockerDaemonAvailable = do - throwIfExeIsNotAvailable - "docker" - "To run PostgreSQL dev database, Wasp needs `docker` installed and in PATH." - (exitCode, _, stderr) <- liftIO $ readProcessWithExitCode "docker" ["info", "--format", "{{.ServerVersion}}"] "" - when (exitCode /= ExitSuccess) $ E.throwError $ CommandError "Docker unavailable" (printf "Start Docker and retry. %s" stderr) - -stopDatabase :: String -> Command () -stopDatabase containerId = do - cliSendMessageC $ Msg.Start "Stopping database..." - failure <- runDockerCleanup ["stop", containerId] - forM_ failure $ \errors -> - cliSendMessageC $ Msg.Warning "Could not stop PostgreSQL" (printf "Wasp will try to remove the container. %s" errors) - -removeContainer :: String -> Command () -removeContainer containerId = do - failure <- runDockerCleanup ["rm", "--force", containerId] - forM_ failure $ \errors -> - cliSendMessageC $ Msg.Warning "Could not remove PostgreSQL container" (printf "Try `docker rm --force %s`. %s" containerId errors) - -runDockerCleanup :: [String] -> Command (Maybe String) -runDockerCleanup args = do - -- create_group keeps terminal Ctrl+C from interrupting Docker's cleanup command. - (status, _, errors) <- liftIO $ readCreateProcessWithExitCode ((proc "docker" args) {create_group = True}) "" - return $ - if status == ExitSuccess || "No such container" `isInfixOf` errors - then Nothing - else Just errors - -printDbMessages :: Chan Job.JobMessage -> IO () -printDbMessages channel = runPrefixedWriter go - where - go = do - message <- liftIO $ readChan channel - case Job._data message of - Job.JobOutput output _ -> do - printJobMessagePrefixed $ Job.JobMessage (Job.JobOutput output Job.Stdout) Job.Db - go - Job.JobExit _ -> return () - additionalInfoLines :: Dev.Postgres.DevDbSpec -> [String] additionalInfoLines devDbSpec = [ "", diff --git a/waspc/waspc.cabal b/waspc/waspc.cabal index 58151ca7a61..34600838303 100644 --- a/waspc/waspc.cabal +++ b/waspc/waspc.cabal @@ -474,6 +474,7 @@ library cli-lib Wasp.Cli.Command.CreateNewProject.StarterTemplates.GhReleaseArchive Wasp.Cli.Command.CreateNewProject.StarterTemplates.Templating Wasp.Cli.Command.Db + Wasp.Cli.Command.Db.Docker Wasp.Cli.Command.Db.Migrate Wasp.Cli.Command.Db.Reset Wasp.Cli.Command.Db.Seed From 25b54eb29fd405f9af99d1af21f0b56b4dfd6430 Mon Sep 17 00:00:00 2001 From: Mihovil Ilakovac Date: Mon, 19 Oct 2026 16:00:20 +0200 Subject: [PATCH 19/27] Order database helpers from workflow to implementation details --- waspc/cli/src/Wasp/Cli/Command/Db/Docker.hs | 22 ++++++------- waspc/cli/src/Wasp/Cli/Command/Start/Db.hs | 34 ++++++++++----------- 2 files changed, 28 insertions(+), 28 deletions(-) diff --git a/waspc/cli/src/Wasp/Cli/Command/Db/Docker.hs b/waspc/cli/src/Wasp/Cli/Command/Db/Docker.hs index ace58f23fa7..2dba07553bf 100644 --- a/waspc/cli/src/Wasp/Cli/Command/Db/Docker.hs +++ b/waspc/cli/src/Wasp/Cli/Command/Db/Docker.hs @@ -46,6 +46,17 @@ runDockerCommand args = do channel <- newChan fst <$> concurrently (runProcessAsJob (proc "docker" args) Job.Db channel) (printDbMessages channel) +printDbMessages :: Chan Job.JobMessage -> IO () +printDbMessages channel = runPrefixedWriter go + where + go = do + message <- liftIO $ readChan channel + case Job._data message of + Job.JobOutput output _ -> do + printJobMessagePrefixed $ Job.JobMessage (Job.JobOutput output Job.Stdout) Job.Db + go + Job.JobExit _ -> return () + stopDatabase :: String -> Command () stopDatabase containerId = do cliSendMessageC $ Msg.Start "Stopping database..." @@ -67,14 +78,3 @@ runDockerCleanup args = do if status == ExitSuccess || "No such container" `isInfixOf` errors then Nothing else Just errors - -printDbMessages :: Chan Job.JobMessage -> IO () -printDbMessages channel = runPrefixedWriter go - where - go = do - message <- liftIO $ readChan channel - case Job._data message of - Job.JobOutput output _ -> do - printJobMessagePrefixed $ Job.JobMessage (Job.JobOutput output Job.Stdout) Job.Db - go - Job.JobExit _ -> return () diff --git a/waspc/cli/src/Wasp/Cli/Command/Start/Db.hs b/waspc/cli/src/Wasp/Cli/Command/Start/Db.hs index f0c0ae5f1da..77f1076214d 100644 --- a/waspc/cli/src/Wasp/Cli/Command/Start/Db.hs +++ b/waspc/cli/src/Wasp/Cli/Command/Start/Db.hs @@ -142,19 +142,6 @@ startPostgresDevDb waspProjectDir appName options = ReusedDatabase _ -> E.throwError $ CommandError "Database not started" "No managed PostgreSQL database was started." -data DatabaseStartPolicy = StartNewDatabase | StartOrReuseDatabase - deriving (Eq) - -data DatabaseSession - = ReusedDatabase Dev.Postgres.DevDbSpec - | StartedDatabase Dev.Postgres.DevDbSpec String (Async ExitCode) - -data PreparedDatabase - = ReuseDatabase DatabaseSession - | CreateDatabase Dev.Postgres.DevDbSpec DockerImageName DockerVolumeMountPath - -data DatabaseUrlSource = Environment | ServerDotEnv - withDevDb :: DbStartOptions -> (Maybe Dev.Postgres.DevDbSpec -> Command a) -> Command a withDevDb options action = do InWaspProject waspProjectDir <- require @@ -173,6 +160,13 @@ withDevDb options action = do withPostgresSession waspProjectDir (ASV.getApp appSpec).name options StartOrReuseDatabase $ action . Just . getDatabaseForSession +data DatabaseStartPolicy = StartNewDatabase | StartOrReuseDatabase + deriving (Eq) + +data DatabaseSession + = ReusedDatabase Dev.Postgres.DevDbSpec + | StartedDatabase Dev.Postgres.DevDbSpec String (Async ExitCode) + withPostgresSession :: Path' Abs (Dir WaspProjectDir) -> String -> DbStartOptions -> DatabaseStartPolicy -> (DatabaseSession -> Command a) -> Command a withPostgresSession waspProjectDir appName options policy action = do prepared <- preparePostgresDevDb waspProjectDir appName options policy @@ -205,6 +199,10 @@ withPostgresSession waspProjectDir appName options policy action = do Docker.stopDatabase containerId `finally` (liftIO (cancel databaseJob) `finally` Docker.removeContainer containerId) release _ = return () +data PreparedDatabase + = ReuseDatabase DatabaseSession + | CreateDatabase Dev.Postgres.DevDbSpec DockerImageName DockerVolumeMountPath + preparePostgresDevDb :: Path' Abs (Dir WaspProjectDir) -> String -> DbStartOptions -> DatabaseStartPolicy -> Command PreparedDatabase preparePostgresDevDb waspProjectDir appName options policy = do Docker.ensureDockerDaemonAvailable @@ -261,6 +259,12 @@ preparePostgresDevDb waspProjectDir appName options policy = do " with the data volume mounted at: " <> dbDockerVolumeMountPath ] +getDatabaseForSession :: DatabaseSession -> Dev.Postgres.DevDbSpec +getDatabaseForSession (ReusedDatabase db) = db +getDatabaseForSession (StartedDatabase db _ _) = db + +data DatabaseUrlSource = Environment | ServerDotEnv + findDatabaseUrlSource :: AS.AppSpec -> IO (Maybe DatabaseUrlSource) findDatabaseUrlSource appSpec = do envUrl <- lookupEnv databaseUrlEnvVarName @@ -284,10 +288,6 @@ suppliedOptionNames options = ++ ["--db-image" | isJust options.dbImage] ++ ["--db-volume-mount-path" | isJust options.dbVolumeMountPath] -getDatabaseForSession :: DatabaseSession -> Dev.Postgres.DevDbSpec -getDatabaseForSession (ReusedDatabase db) = db -getDatabaseForSession (StartedDatabase db _ _) = db - additionalInfoLines :: Dev.Postgres.DevDbSpec -> [String] additionalInfoLines devDbSpec = [ "", From b68ca49cce563900b8a008760459d5bc13fd9d13 Mon Sep 17 00:00:00 2001 From: Mihovil Ilakovac Date: Tue, 20 Oct 2026 14:41:10 +0200 Subject: [PATCH 20/27] Keep the database studio parser in its command module --- waspc/cli/exe/Main.hs | 3 +-- waspc/cli/src/Wasp/Cli/Command/Db/Studio.hs | 5 +++++ 2 files changed, 6 insertions(+), 2 deletions(-) diff --git a/waspc/cli/exe/Main.hs b/waspc/cli/exe/Main.hs index ab3d23b41b4..2714de0bb27 100644 --- a/waspc/cli/exe/Main.hs +++ b/waspc/cli/exe/Main.hs @@ -39,7 +39,6 @@ import qualified Wasp.Cli.Command.Telemetry as Telemetry import Wasp.Cli.Command.Test (test) import Wasp.Cli.Command.Uninstall (uninstall) import Wasp.Cli.Terminal (title) -import Wasp.Cli.Util.Parser (ArgsParser (..)) import Wasp.Util (indent) import Wasp.Util.InstallMethod (getInstallationCommand) import qualified Wasp.Util.Terminal as Term @@ -214,7 +213,7 @@ dbCli args = case args of "reset" : resetArgs -> runCommandThatRequiresDbRunning Command.Db.Reset.resetArgsParser Command.Db.Reset.reset resetArgs "migrate-dev" : optionalMigrateArgs -> runCommandThatRequiresDbRunning Command.Db.Migrate.migrateArgsParser Command.Db.Migrate.migrateDev optionalMigrateArgs "seed" : seedArgs -> runCommandThatRequiresDbRunning Command.Db.Seed.seedArgsParser Command.Db.Seed.seed seedArgs - "studio" : studioArgs -> runCommandThatRequiresDbRunning (ArgsParser "wasp db studio" (pure ())) (const Command.Db.Studio.studio) studioArgs + "studio" : studioArgs -> runCommandThatRequiresDbRunning Command.Db.Studio.studioArgsParser (const Command.Db.Studio.studio) studioArgs _unknownDbCommand -> printDbUsage >> exitFailure {- ORMOLU_DISABLE -} diff --git a/waspc/cli/src/Wasp/Cli/Command/Db/Studio.hs b/waspc/cli/src/Wasp/Cli/Command/Db/Studio.hs index eeb64b3fcea..30e1998f35b 100644 --- a/waspc/cli/src/Wasp/Cli/Command/Db/Studio.hs +++ b/waspc/cli/src/Wasp/Cli/Command/Db/Studio.hs @@ -1,5 +1,6 @@ module Wasp.Cli.Command.Db.Studio ( studio, + studioArgsParser, ) where @@ -12,6 +13,7 @@ import Wasp.Cli.Command.Db (makeDbCommand) import Wasp.Cli.Command.Message (cliSendMessageC) import Wasp.Cli.Command.Require.InWaspProject (InWaspProject (InWaspProject)) import Wasp.Cli.Command.Require.ValidNodeAndNpm (ValidNodeAndNpm (ValidNodeAndNpm)) +import Wasp.Cli.Util.Parser (ArgsParser (..)) import Wasp.Generator.DbGenerator.Jobs (runStudio) import Wasp.Generator.Setup (SetupGoal (PrismaCliReady)) import Wasp.Job.IO (readJobMessagesAndPrintThemPrefixed) @@ -30,3 +32,6 @@ studio = makeDbCommand [PrismaCliReady] $ \_appSpec -> do _ <- liftIO $ readJobMessagesAndPrintThemPrefixed chan `concurrently` runStudio genProjectDir chan error "This should never happen, studio should never stop." + +studioArgsParser :: ArgsParser () +studioArgsParser = ArgsParser "wasp db studio" (pure ()) From 67ac52508e4bb86f1511fb1404edf0b81368420e Mon Sep 17 00:00:00 2001 From: Mihovil Ilakovac Date: Tue, 20 Oct 2026 16:13:33 +0200 Subject: [PATCH 21/27] Name Docker job execution and output explicitly --- waspc/cli/src/Wasp/Cli/Command/Db/Docker.hs | 16 ++++++++-------- waspc/cli/src/Wasp/Cli/Command/Start/Db.hs | 2 +- 2 files changed, 9 insertions(+), 9 deletions(-) diff --git a/waspc/cli/src/Wasp/Cli/Command/Db/Docker.hs b/waspc/cli/src/Wasp/Cli/Command/Db/Docker.hs index 2dba07553bf..a2849db905f 100644 --- a/waspc/cli/src/Wasp/Cli/Command/Db/Docker.hs +++ b/waspc/cli/src/Wasp/Cli/Command/Db/Docker.hs @@ -1,7 +1,7 @@ module Wasp.Cli.Command.Db.Docker ( ensureDockerDaemonAvailable, ensureImageAvailable, - runDockerCommand, + runDockerJobAndPrintOutput, stopDatabase, removeContainer, ) @@ -38,19 +38,19 @@ ensureImageAvailable dbDockerImage = do (imageStatus, _, _) <- liftIO $ readProcessWithExitCode "docker" ["image", "inspect", dbDockerImage] "" when (imageStatus /= ExitSuccess) $ do cliSendMessageC $ Msg.Start $ printf "Pulling PostgreSQL image %s..." dbDockerImage - pullStatus <- liftIO $ runDockerCommand ["pull", dbDockerImage] + pullStatus <- liftIO $ runDockerJobAndPrintOutput ["pull", dbDockerImage] when (pullStatus /= ExitSuccess) $ E.throwError $ CommandError "Could not pull PostgreSQL image" (printf "Check the image name, registry access, and network connection. Image: %s" dbDockerImage) -runDockerCommand :: [String] -> IO ExitCode -runDockerCommand args = do - channel <- newChan - fst <$> concurrently (runProcessAsJob (proc "docker" args) Job.Db channel) (printDbMessages channel) +runDockerJobAndPrintOutput :: [String] -> IO ExitCode +runDockerJobAndPrintOutput args = do + chan <- newChan + fst <$> concurrently (runProcessAsJob (proc "docker" args) Job.Db chan) (printDbMessages chan) printDbMessages :: Chan Job.JobMessage -> IO () -printDbMessages channel = runPrefixedWriter go +printDbMessages chan = runPrefixedWriter go where go = do - message <- liftIO $ readChan channel + message <- liftIO $ readChan chan case Job._data message of Job.JobOutput output _ -> do printJobMessagePrefixed $ Job.JobMessage (Job.JobOutput output Job.Stdout) Job.Db diff --git a/waspc/cli/src/Wasp/Cli/Command/Start/Db.hs b/waspc/cli/src/Wasp/Cli/Command/Start/Db.hs index 77f1076214d..d7f12325afc 100644 --- a/waspc/cli/src/Wasp/Cli/Command/Start/Db.hs +++ b/waspc/cli/src/Wasp/Cli/Command/Start/Db.hs @@ -178,7 +178,7 @@ withPostgresSession waspProjectDir appName options policy action = do (withDatabaseError "Could not start PostgreSQL" $ Dev.Postgres.createDevPostgresContainer db image mountPath) Docker.removeContainer ( \containerId -> do - databaseJob <- liftIO $ async $ Docker.runDockerCommand ["start", "--attach", containerId] + databaseJob <- liftIO $ async $ Docker.runDockerJobAndPrintOutput ["start", "--attach", containerId] return $ StartedDatabase db containerId databaseJob ) From 415bffc09f24be6ce993f2304656781f911071c4 Mon Sep 17 00:00:00 2001 From: Mihovil Ilakovac Date: Tue, 20 Oct 2026 16:31:37 +0200 Subject: [PATCH 22/27] Clarify database startup and URL source names --- waspc/cli/src/Wasp/Cli/Command/Start/Db.hs | 34 +++++++++++----------- 1 file changed, 17 insertions(+), 17 deletions(-) diff --git a/waspc/cli/src/Wasp/Cli/Command/Start/Db.hs b/waspc/cli/src/Wasp/Cli/Command/Start/Db.hs index d7f12325afc..4491e9a090c 100644 --- a/waspc/cli/src/Wasp/Cli/Command/Start/Db.hs +++ b/waspc/cli/src/Wasp/Cli/Command/Start/Db.hs @@ -134,7 +134,7 @@ throwIfCustomDbAlreadyInUse spec = do startPostgresDevDb :: Path' Abs (Dir WaspProjectDir) -> String -> DbStartOptions -> Command () startPostgresDevDb waspProjectDir appName options = - withPostgresSession waspProjectDir appName options StartNewDatabase $ \case + withPostgresSession waspProjectDir appName options RequireNewDatabase $ \case StartedDatabase _ _ databaseJob -> do cliSendMessageC $ Msg.Info "PostgreSQL is running. Ctrl+C stops PostgreSQL." _ <- liftIO $ wait databaseJob @@ -157,10 +157,10 @@ withDevDb options action = do throwIfDbStartOptionsSupplied "This project uses SQLite." options action Nothing AS.App.Db.PostgreSQL -> - withPostgresSession waspProjectDir (ASV.getApp appSpec).name options StartOrReuseDatabase $ + withPostgresSession waspProjectDir (ASV.getApp appSpec).name options AllowExistingDatabase $ action . Just . getDatabaseForSession -data DatabaseStartPolicy = StartNewDatabase | StartOrReuseDatabase +data DatabaseStartPolicy = RequireNewDatabase | AllowExistingDatabase deriving (Eq) data DatabaseSession @@ -169,8 +169,8 @@ data DatabaseSession withPostgresSession :: Path' Abs (Dir WaspProjectDir) -> String -> DbStartOptions -> DatabaseStartPolicy -> (DatabaseSession -> Command a) -> Command a withPostgresSession waspProjectDir appName options policy action = do - prepared <- preparePostgresDevDb waspProjectDir appName options policy - bracket (acquire prepared) release use + startupPlan <- prepareDatabaseStartup waspProjectDir appName options policy + bracket (acquire startupPlan) release use where acquire (ReuseDatabase session) = return session acquire (CreateDatabase db image mountPath) = @@ -191,7 +191,7 @@ withPostgresSession waspProjectDir appName options policy action = do case result of Left _ -> E.throwError $ CommandError "Could not start PostgreSQL" "The Docker process exited before PostgreSQL was ready. Check the database output above." Right () -> return () - when (policy == StartNewDatabase) $ cliSendMessageC $ Msg.Info $ unlines $ additionalInfoLines db + when (policy == RequireNewDatabase) $ cliSendMessageC $ Msg.Info $ unlines $ additionalInfoLines db _ -> return () action session @@ -199,17 +199,17 @@ withPostgresSession waspProjectDir appName options policy action = do Docker.stopDatabase containerId `finally` (liftIO (cancel databaseJob) `finally` Docker.removeContainer containerId) release _ = return () -data PreparedDatabase +data DatabaseStartupPlan = ReuseDatabase DatabaseSession | CreateDatabase Dev.Postgres.DevDbSpec DockerImageName DockerVolumeMountPath -preparePostgresDevDb :: Path' Abs (Dir WaspProjectDir) -> String -> DbStartOptions -> DatabaseStartPolicy -> Command PreparedDatabase -preparePostgresDevDb waspProjectDir appName options policy = do +prepareDatabaseStartup :: Path' Abs (Dir WaspProjectDir) -> String -> DbStartOptions -> DatabaseStartPolicy -> Command DatabaseStartupPlan +prepareDatabaseStartup waspProjectDir appName options policy = do Docker.ensureDockerDaemonAvailable liftIO (Dev.Postgres.discoverProjectsRunningDevDb waspProjectDir appName) >>= \case Just runningDb -> case policy of - StartNewDatabase -> + RequireNewDatabase -> E.throwError $ CommandError "PostgreSQL already running" @@ -219,8 +219,8 @@ preparePostgresDevDb waspProjectDir appName options policy = do runningDb.dockerContainerName (unlines $ additionalInfoLines runningDb) ) - StartOrReuseDatabase -> ReuseDatabase <$> prepareExistingDatabase runningDb - Nothing -> prepareDbOnPort =<< resolveDevDbPort + AllowExistingDatabase -> ReuseDatabase <$> prepareExistingDatabase runningDb + Nothing -> prepareStartupOnPort =<< resolveDevDbPort where dbDockerImage = fromMaybe (fst defaultPostgresDockerImageSpec) options.dbImage dbDockerVolumeMountPath = fromMaybe (snd defaultPostgresDockerImageSpec) options.dbVolumeMountPath @@ -241,8 +241,8 @@ preparePostgresDevDb waspProjectDir appName options policy = do unless (null $ suppliedOptionNames options) $ cliSendMessageC $ Msg.Warning "Database options not used" (printf "These options only apply when starting a new container: %s. Stop the running database before changing them." (intercalate ", " (suppliedOptionNames options))) return $ ReusedDatabase devDbSpec - prepareDbOnPort :: PortNumber -> Command PreparedDatabase - prepareDbOnPort port = do + prepareStartupOnPort :: PortNumber -> Command DatabaseStartupPlan + prepareStartupOnPort port = do let devDbSpec = Dev.Postgres.makeDevPostgresDbSpec waspProjectDir appName port Docker.ensureImageAvailable dbDockerImage cliSendMessageC $ Msg.Start "Starting PostgreSQL..." @@ -263,17 +263,17 @@ getDatabaseForSession :: DatabaseSession -> Dev.Postgres.DevDbSpec getDatabaseForSession (ReusedDatabase db) = db getDatabaseForSession (StartedDatabase db _ _) = db -data DatabaseUrlSource = Environment | ServerDotEnv +data DatabaseUrlSource = EnvironmentVariable | ServerDotEnvFile findDatabaseUrlSource :: AS.AppSpec -> IO (Maybe DatabaseUrlSource) findDatabaseUrlSource appSpec = do envUrl <- lookupEnv databaseUrlEnvVarName return $ if isJust envUrl - then Just Environment + then Just EnvironmentVariable else if any ((== databaseUrlEnvVarName) . fst) appSpec.devEnvVarsServer - then Just ServerDotEnv + then Just ServerDotEnvFile else Nothing throwIfDbStartOptionsSupplied :: String -> DbStartOptions -> Command () From df0bf3bf7d08c5ff2b3a8911a0e15ae755118927 Mon Sep 17 00:00:00 2001 From: Mihovil Ilakovac Date: Tue, 20 Oct 2026 16:53:14 +0200 Subject: [PATCH 23/27] Allow Prisma to create missing managed databases --- waspc/e2e-tests/Tests/WaspDbStartTest.hs | 18 ++++++++++++++++++ waspc/src/Wasp/Project/Db/Dev/Postgres.hs | 10 ++++------ 2 files changed, 22 insertions(+), 6 deletions(-) diff --git a/waspc/e2e-tests/Tests/WaspDbStartTest.hs b/waspc/e2e-tests/Tests/WaspDbStartTest.hs index 54b37ecff6b..a804c6de82f 100644 --- a/waspc/e2e-tests/Tests/WaspDbStartTest.hs +++ b/waspc/e2e-tests/Tests/WaspDbStartTest.hs @@ -58,6 +58,19 @@ waspDbStartTest = assertDevDbRemoved, removeReportedDevDbVolume ], + postgresTestCase + "migration-and-reset-recreate-missing-database" + [ waspCliDbStartInBackground (Just 15435), + waitUntilDevDbReportsItIsReady, + dropDevDb, + waspCliDbMigrateDev "first_migration", + dropDevDb, + return "$WASP_CLI_CMD db reset --force", + assertDevDbRunning, + stopDevDbAndWait, + assertDevDbRemoved, + removeReportedDevDbVolume + ], postgresTestCase "startup-uses-another-port-when-default-is-occupied" [ occupyDefaultDevDbPort, @@ -165,6 +178,11 @@ assertDevDbRunning :: ShellCommandBuilder WaspProjectContext ShellCommand assertDevDbRunning = return $ "test -n \"$(docker ps -q --filter \"volume=" ++ reportedDevDbVolumeName ++ "\")\"" +dropDevDb :: ShellCommandBuilder WaspProjectContext ShellCommand +dropDevDb = do + db <- testDevDb + return $ unwords ["docker", "exec", db.dockerContainerName, "dropdb", "--username", db.user, "--force", db.dbName] + assertDevDbRemoved :: ShellCommandBuilder WaspProjectContext ShellCommand assertDevDbRemoved = do db <- testDevDb diff --git a/waspc/src/Wasp/Project/Db/Dev/Postgres.hs b/waspc/src/Wasp/Project/Db/Dev/Postgres.hs index 07c87ff2a89..9447ec6bdf3 100644 --- a/waspc/src/Wasp/Project/Db/Dev/Postgres.hs +++ b/waspc/src/Wasp/Project/Db/Dev/Postgres.hs @@ -85,17 +85,15 @@ isDevDbReady devDbSpec = do isDevDbConnectionReady :: DevDbSpec -> IO Bool isDevDbConnectionReady devDbSpec = do - (exitCode, output, _) <- readProcessWithExitCode "docker" args "" - return $ exitCode == ExitSuccess && output == "1\n" + (exitCode, _, _) <- readProcessWithExitCode "docker" args "" + return $ exitCode == ExitSuccess where args = concat - [ ["exec", "--env", printf "PGPASSWORD=%s" devDbSpec.password], - [devDbSpec.dockerContainerName, "psql"], + [ ["exec", devDbSpec.dockerContainerName, "pg_isready"], ["-h", "127.0.0.1"], ["-U", devDbSpec.user], - ["-d", devDbSpec.dbName], - ["-t", "-A", "-c", "SELECT 1"] + ["-d", "postgres", "-q"] ] -- | Returns all relevant info about this Wasp project's dev detabase if its From 42c4a53bd91186d3701700696608200e7ea1070b Mon Sep 17 00:00:00 2001 From: Mihovil Ilakovac Date: Tue, 20 Oct 2026 17:03:35 +0200 Subject: [PATCH 24/27] Clarify PostgreSQL readiness check names --- waspc/src/Wasp/Project/Db/Dev/Postgres.hs | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/waspc/src/Wasp/Project/Db/Dev/Postgres.hs b/waspc/src/Wasp/Project/Db/Dev/Postgres.hs index 9447ec6bdf3..f194b0cac7e 100644 --- a/waspc/src/Wasp/Project/Db/Dev/Postgres.hs +++ b/waspc/src/Wasp/Project/Db/Dev/Postgres.hs @@ -71,20 +71,20 @@ createDevPostgresContainer db image mountPath = do waitForDevDbReady :: DevDbSpec -> IO () waitForDevDbReady devDbSpec = do - ready <- Retry.retryUntil (Retry.constPause 1000000) 59 $ isDevDbReady devDbSpec + ready <- Retry.retryUntil (Retry.constPause 1000000) 59 $ isDevDbReachable devDbSpec unless ready $ do (_, output, errors) <- readProcessWithExitCode "docker" ["logs", "--tail", "30", devDbSpec.dockerContainerName] "" ioError $ userError $ printf "PostgreSQL did not become ready. Check the logs below, then try again.\n%s%s" output errors -isDevDbReady :: DevDbSpec -> IO Bool -isDevDbReady devDbSpec = do - databaseReady <- isDevDbConnectionReady devDbSpec - if databaseReady +isDevDbReachable :: DevDbSpec -> IO Bool +isDevDbReachable devDbSpec = do + postgresAcceptsConnections <- isPostgresAcceptingConnections devDbSpec + if postgresAcceptsConnections then Socket.checkIfPortIsAcceptingConnections $ Socket.makeLocalHostSocketAddress devDbSpec.port else return False -isDevDbConnectionReady :: DevDbSpec -> IO Bool -isDevDbConnectionReady devDbSpec = do +isPostgresAcceptingConnections :: DevDbSpec -> IO Bool +isPostgresAcceptingConnections devDbSpec = do (exitCode, _, _) <- readProcessWithExitCode "docker" args "" return $ exitCode == ExitSuccess where From c98e54c3e0ae66d95c14a04bd7ca266fd383712f Mon Sep 17 00:00:00 2001 From: Mihovil Ilakovac Date: Tue, 20 Oct 2026 17:17:27 +0200 Subject: [PATCH 25/27] Simplify managed PostgreSQL readiness checks --- waspc/src/Wasp/Project/Db/Dev/Postgres.hs | 10 +--------- 1 file changed, 1 insertion(+), 9 deletions(-) diff --git a/waspc/src/Wasp/Project/Db/Dev/Postgres.hs b/waspc/src/Wasp/Project/Db/Dev/Postgres.hs index f194b0cac7e..5e1b068c9b2 100644 --- a/waspc/src/Wasp/Project/Db/Dev/Postgres.hs +++ b/waspc/src/Wasp/Project/Db/Dev/Postgres.hs @@ -20,7 +20,6 @@ import Wasp.Db.Postgres (defaultPostgresPort, makeConnectionUrl, postgresMaxDbNa import Wasp.Project.Common (WaspProjectDir, makeAppUniqueId) import Wasp.Util.Docker (DockerImageName, DockerVolumeMountPath, discoverHostPortForDockerContainersInternalPort) import qualified Wasp.Util.IO.Retry as Retry -import qualified Wasp.Util.Network.Socket as Socket data DevDbSpec = DevDbSpec { dockerVolumeName :: String, @@ -71,18 +70,11 @@ createDevPostgresContainer db image mountPath = do waitForDevDbReady :: DevDbSpec -> IO () waitForDevDbReady devDbSpec = do - ready <- Retry.retryUntil (Retry.constPause 1000000) 59 $ isDevDbReachable devDbSpec + ready <- Retry.retryUntil (Retry.constPause 1000000) 59 $ isPostgresAcceptingConnections devDbSpec unless ready $ do (_, output, errors) <- readProcessWithExitCode "docker" ["logs", "--tail", "30", devDbSpec.dockerContainerName] "" ioError $ userError $ printf "PostgreSQL did not become ready. Check the logs below, then try again.\n%s%s" output errors -isDevDbReachable :: DevDbSpec -> IO Bool -isDevDbReachable devDbSpec = do - postgresAcceptsConnections <- isPostgresAcceptingConnections devDbSpec - if postgresAcceptsConnections - then Socket.checkIfPortIsAcceptingConnections $ Socket.makeLocalHostSocketAddress devDbSpec.port - else return False - isPostgresAcceptingConnections :: DevDbSpec -> IO Bool isPostgresAcceptingConnections devDbSpec = do (exitCode, _, _) <- readProcessWithExitCode "docker" args "" From 5dc4db823a7ab25c4bbe522fe0976fb59487e372 Mon Sep 17 00:00:00 2001 From: Mihovil Ilakovac Date: Tue, 20 Oct 2026 17:57:17 +0200 Subject: [PATCH 26/27] Explain direct PostgreSQL shutdown in database tests --- waspc/e2e-tests/Tests/WaspDbStartTest.hs | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/waspc/e2e-tests/Tests/WaspDbStartTest.hs b/waspc/e2e-tests/Tests/WaspDbStartTest.hs index a804c6de82f..1c612c06aca 100644 --- a/waspc/e2e-tests/Tests/WaspDbStartTest.hs +++ b/waspc/e2e-tests/Tests/WaspDbStartTest.hs @@ -116,7 +116,9 @@ waspCliDbStartInBackground port = where portOption = maybe "" ((" --db-port " ++) . show) port --- Stop PostgreSQL directly so this test does not depend on terminal signal forwarding. +-- Signal PostgreSQL directly to avoid relying on terminal signal forwarding. +-- Wait for Wasp to finish cleanup before checking the container or volume. +-- Wasp reports the stopped database as an error, so a nonzero exit is expected. stopDevDbAndWait :: ShellCommandBuilder WaspProjectContext ShellCommand stopDevDbAndWait = return $ From 89d392580300f945cee763103523f8d3c3b5774b Mon Sep 17 00:00:00 2001 From: Mihovil Ilakovac Date: Mon, 19 Oct 2026 15:29:50 +0200 Subject: [PATCH 27/27] Extract shared development database lifecycle and options --- waspc/cli/src/Wasp/Cli/Command/Db.hs | 6 +- waspc/cli/src/Wasp/Cli/Command/Db/DevDb.hs | 206 ++++++++++++++ .../src/Wasp/Cli/Command/Db/StartOptions.hs | 37 +++ waspc/cli/src/Wasp/Cli/Command/Start.hs | 4 +- .../Wasp/Cli/Command/Start/ArgumentsParser.hs | 2 +- waspc/cli/src/Wasp/Cli/Command/Start/Db.hs | 265 ++---------------- waspc/cli/tests/DbMigrateTest.hs | 2 +- waspc/waspc.cabal | 2 + 8 files changed, 276 insertions(+), 248 deletions(-) create mode 100644 waspc/cli/src/Wasp/Cli/Command/Db/DevDb.hs create mode 100644 waspc/cli/src/Wasp/Cli/Command/Db/StartOptions.hs diff --git a/waspc/cli/src/Wasp/Cli/Command/Db.hs b/waspc/cli/src/Wasp/Cli/Command/Db.hs index b3094061519..1d2702bd396 100644 --- a/waspc/cli/src/Wasp/Cli/Command/Db.hs +++ b/waspc/cli/src/Wasp/Cli/Command/Db.hs @@ -8,11 +8,11 @@ import qualified Wasp.AppSpec as AS import Wasp.Cli.Command (Command, require, runCommand) import Wasp.Cli.Command.Call (Arguments) import Wasp.Cli.Command.Compile (defaultCompileOptions, withSetupGoals) +import qualified Wasp.Cli.Command.Db.DevDb as DevDb +import Wasp.Cli.Command.Db.StartOptions (dbStartOptionsParser) import Wasp.Cli.Command.Require.DbConnectionEstablished (DbConnectionEstablished (DbConnectionEstablished)) import Wasp.Cli.Command.Require.InWaspProject (InWaspProject (InWaspProject)) import Wasp.Cli.Command.Require.WaspSpecAvailable (WaspSpecAvailable (WaspSpecAvailable)) -import Wasp.Cli.Command.Start.Db (dbStartOptionsParser) -import qualified Wasp.Cli.Command.Start.Db as Start.Db import Wasp.Cli.Compile (waitEnsureCompile) import Wasp.Cli.Util.Parser (ArgsParser (..), withArguments) import Wasp.Generator.Setup (SetupGoal) @@ -23,7 +23,7 @@ runCommandThatRequiresDbRunning parser command args = where databaseArgsParser = parser {optParser = (,) <$> dbStartOptionsParser <*> parser.optParser} run (dbStartOptions, commandArgs) = - Start.Db.withDevDb dbStartOptions $ \_ -> command commandArgs + DevDb.withDevDb dbStartOptions $ \_ -> command commandArgs -- | Prepares what a db command needs before it runs: a compile, -- post-compile setup, and a reachable database. diff --git a/waspc/cli/src/Wasp/Cli/Command/Db/DevDb.hs b/waspc/cli/src/Wasp/Cli/Command/Db/DevDb.hs new file mode 100644 index 00000000000..33d3ca26b20 --- /dev/null +++ b/waspc/cli/src/Wasp/Cli/Command/Db/DevDb.hs @@ -0,0 +1,206 @@ +module Wasp.Cli.Command.Db.DevDb + ( withDevDb, + withPostgresSession, + DatabaseStartPolicy (..), + DatabaseSession (..), + DatabaseUrlSource (..), + findDatabaseUrlSource, + ) +where + +import Control.Concurrent.Async (Async, async, cancel, race, wait) +import Control.Exception (IOException, try) +import Control.Monad (unless, when) +import Control.Monad.Catch (bracket, bracketOnError, finally) +import qualified Control.Monad.Except as E +import Control.Monad.IO.Class (liftIO) +import Data.List (intercalate) +import Data.Maybe (fromMaybe, isJust) +import Network.Socket (PortNumber) +import StrongPath (Abs, Dir, Path') +import System.Environment (lookupEnv) +import System.Exit (ExitCode) +import System.IO.Error (ioeGetErrorString) +import Text.Printf (printf) +import qualified Wasp.AppSpec as AS +import qualified Wasp.AppSpec.App as AS.App +import qualified Wasp.AppSpec.App.Db as AS.App.Db +import qualified Wasp.AppSpec.Valid as ASV +import Wasp.Cli.Command (Command, CommandError (CommandError), require) +import Wasp.Cli.Command.Compile (analyze) +import qualified Wasp.Cli.Command.Db.Docker as Docker +import Wasp.Cli.Command.Db.StartOptions (DbStartOptions (..)) +import Wasp.Cli.Command.Message (cliSendMessageC) +import Wasp.Cli.Command.Require.InWaspProject (InWaspProject (InWaspProject)) +import Wasp.Cli.Command.Require.WaspSpecAvailable (WaspSpecAvailable (WaspSpecAvailable)) +import Wasp.Cli.Port (resolvePort) +import Wasp.Db.Postgres (defaultPostgresDockerImageSpec, defaultPostgresPort) +import qualified Wasp.Message as Msg +import Wasp.Project.Common (WaspProjectDir) +import Wasp.Project.Db (databaseUrlEnvVarName) +import qualified Wasp.Project.Db.Dev.Postgres as Dev.Postgres +import Wasp.Util.Docker (DockerImageName, DockerVolumeMountPath) + +withDevDb :: DbStartOptions -> (Maybe Dev.Postgres.DevDbSpec -> Command a) -> Command a +withDevDb options action = do + InWaspProject waspProjectDir <- require + WaspSpecAvailable <- require + appSpec <- analyze waspProjectDir + databaseUrlSource <- liftIO $ findDatabaseUrlSource appSpec + case databaseUrlSource of + Just _ -> do + throwIfDbStartOptionsSupplied "DATABASE_URL is set." options + action Nothing + Nothing -> case ASV.getValidDbSystem appSpec of + AS.App.Db.SQLite -> do + throwIfDbStartOptionsSupplied "This project uses SQLite." options + action Nothing + AS.App.Db.PostgreSQL -> + withPostgresSession waspProjectDir (ASV.getApp appSpec).name options AllowExistingDatabase $ + action . Just . getDatabaseForSession + +data DatabaseStartPolicy = RequireNewDatabase | AllowExistingDatabase + deriving (Eq) + +data DatabaseSession + = ReusedDatabase Dev.Postgres.DevDbSpec + | StartedDatabase Dev.Postgres.DevDbSpec String (Async ExitCode) + +withPostgresSession :: Path' Abs (Dir WaspProjectDir) -> String -> DbStartOptions -> DatabaseStartPolicy -> (DatabaseSession -> Command a) -> Command a +withPostgresSession waspProjectDir appName options policy action = do + startupPlan <- prepareDatabaseStartup waspProjectDir appName options policy + bracket (acquire startupPlan) release use + where + acquire (ReuseDatabase session) = return session + acquire (CreateDatabase db image mountPath) = + bracketOnError + (withDatabaseError "Could not start PostgreSQL" $ Dev.Postgres.createDevPostgresContainer db image mountPath) + Docker.removeContainer + ( \containerId -> do + databaseJob <- liftIO $ async $ Docker.runDockerJobAndPrintOutput ["start", "--attach", containerId] + return $ StartedDatabase db containerId databaseJob + ) + + use session = do + case session of + StartedDatabase db _ databaseJob -> do + result <- + withDatabaseError "Could not start PostgreSQL" $ + race (wait databaseJob) (Dev.Postgres.waitForDevDbReady db) + case result of + Left _ -> E.throwError $ CommandError "Could not start PostgreSQL" "The Docker process exited before PostgreSQL was ready. Check the database output above." + Right () -> return () + when (policy == RequireNewDatabase) $ cliSendMessageC $ Msg.Info $ unlines $ additionalInfoLines db + _ -> return () + action session + + release (StartedDatabase _ containerId databaseJob) = + Docker.stopDatabase containerId `finally` (liftIO (cancel databaseJob) `finally` Docker.removeContainer containerId) + release _ = return () + +data DatabaseStartupPlan + = ReuseDatabase DatabaseSession + | CreateDatabase Dev.Postgres.DevDbSpec DockerImageName DockerVolumeMountPath + +prepareDatabaseStartup :: Path' Abs (Dir WaspProjectDir) -> String -> DbStartOptions -> DatabaseStartPolicy -> Command DatabaseStartupPlan +prepareDatabaseStartup waspProjectDir appName options policy = do + Docker.ensureDockerDaemonAvailable + + liftIO (Dev.Postgres.discoverProjectsRunningDevDb waspProjectDir appName) >>= \case + Just runningDb -> case policy of + RequireNewDatabase -> + E.throwError $ + CommandError + "PostgreSQL already running" + ( printf + "This project's database is already running on port %s. Stop the command that started it, or run `docker stop %s` before starting it again.\n%s" + (show runningDb.port) + runningDb.dockerContainerName + (unlines $ additionalInfoLines runningDb) + ) + AllowExistingDatabase -> ReuseDatabase <$> prepareExistingDatabase runningDb + Nothing -> prepareStartupOnPort =<< resolveDevDbPort + where + dbDockerImage = fromMaybe (fst defaultPostgresDockerImageSpec) options.dbImage + dbDockerVolumeMountPath = fromMaybe (snd defaultPostgresDockerImageSpec) options.dbVolumeMountPath + + resolveDevDbPort :: Command PortNumber + resolveDevDbPort = + resolvePort + options.dbPort + defaultPostgresPort + [] + "Choose a different port with --db-port, or free up this one." + "Free at least one of those ports by exiting the program listening on it, or choose the port yourself with --db-port." + + prepareExistingDatabase :: Dev.Postgres.DevDbSpec -> Command DatabaseSession + prepareExistingDatabase devDbSpec = do + withDatabaseError "PostgreSQL is not ready" $ Dev.Postgres.waitForDevDbReady devDbSpec + cliSendMessageC $ Msg.Info "PostgreSQL was already running for this project. Wasp did not start it and will not stop it." + unless (null $ suppliedOptionNames options) $ cliSendMessageC $ Msg.Warning "Database options not used" (printf "These options only apply when starting a new container: %s. Stop the running database before changing them." (intercalate ", " (suppliedOptionNames options))) + return $ ReusedDatabase devDbSpec + + prepareStartupOnPort :: PortNumber -> Command DatabaseStartupPlan + prepareStartupOnPort port = do + let devDbSpec = Dev.Postgres.makeDevPostgresDbSpec waspProjectDir appName port + Docker.ensureImageAvailable dbDockerImage + cliSendMessageC $ Msg.Start "Starting PostgreSQL..." + cliSendMessageC $ Msg.Info $ unlines dockerRunInfoLines + return $ CreateDatabase devDbSpec dbDockerImage dbDockerVolumeMountPath + + -- These lines describe what Docker is about to use, so we print them + -- only when starting the database: an already running container might have + -- been started with a different image or mount path than the current + -- invocation's arguments. + dockerRunInfoLines :: [String] + dockerRunInfoLines = + [ " ℹ Using Docker image: " <> dbDockerImage, + " with the data volume mounted at: " <> dbDockerVolumeMountPath + ] + +getDatabaseForSession :: DatabaseSession -> Dev.Postgres.DevDbSpec +getDatabaseForSession (ReusedDatabase db) = db +getDatabaseForSession (StartedDatabase db _ _) = db + +data DatabaseUrlSource = EnvironmentVariable | ServerDotEnvFile + +findDatabaseUrlSource :: AS.AppSpec -> IO (Maybe DatabaseUrlSource) +findDatabaseUrlSource appSpec = do + envUrl <- lookupEnv databaseUrlEnvVarName + return $ + if isJust envUrl + then Just EnvironmentVariable + else + if any ((== databaseUrlEnvVarName) . fst) appSpec.devEnvVarsServer + then Just ServerDotEnvFile + else Nothing + +throwIfDbStartOptionsSupplied :: String -> DbStartOptions -> Command () +throwIfDbStartOptionsSupplied reason options = + unless (null optionNames) $ E.throwError $ CommandError "Database options do not apply" (printf "%s These options only apply to Wasp-managed PostgreSQL: %s. Remove them to continue." reason (intercalate ", " optionNames)) + where + optionNames = suppliedOptionNames options + +suppliedOptionNames :: DbStartOptions -> [String] +suppliedOptionNames options = + ["--db-port" | isJust options.dbPort] + ++ ["--db-image" | isJust options.dbImage] + ++ ["--db-volume-mount-path" | isJust options.dbVolumeMountPath] + +additionalInfoLines :: Dev.Postgres.DevDbSpec -> [String] +additionalInfoLines devDbSpec = + [ "", + "Additional info:", + " ℹ Connection URL, in case you might want to connect with external tools:", + " " <> Dev.Postgres.getDevConnectionUrl devDbSpec, + " ℹ Database data is persisted in a Docker volume with the following name" + <> " (useful to know if you will want to delete it at some point):", + " " <> devDbSpec.dockerVolumeName + ] + +withDatabaseError :: String -> IO a -> Command a +withDatabaseError title action = do + result <- liftIO $ try action + case result of + Left (err :: IOException) -> E.throwError $ CommandError title $ ioeGetErrorString err + Right value -> return value diff --git a/waspc/cli/src/Wasp/Cli/Command/Db/StartOptions.hs b/waspc/cli/src/Wasp/Cli/Command/Db/StartOptions.hs new file mode 100644 index 00000000000..92866634013 --- /dev/null +++ b/waspc/cli/src/Wasp/Cli/Command/Db/StartOptions.hs @@ -0,0 +1,37 @@ +module Wasp.Cli.Command.Db.StartOptions + ( DbStartOptions (..), + dbStartOptionsParser, + ) +where + +import Network.Socket (PortNumber) +import qualified Options.Applicative as Opt +import Wasp.Cli.Util.PortArgument (portParser) +import Wasp.Db.Postgres (defaultPostgresPort) +import Wasp.Util.Docker (DockerImageName, DockerVolumeMountPath) + +data DbStartOptions = DbStartOptions + { dbPort :: Maybe PortNumber, + dbImage :: Maybe DockerImageName, + dbVolumeMountPath :: Maybe DockerVolumeMountPath + } + deriving (Eq, Show) + +dbStartOptionsParser :: Opt.Parser DbStartOptions +dbStartOptionsParser = + DbStartOptions + <$> Opt.optional (portParser "db-port" ("Port to run the dev database on (default: " ++ show defaultPostgresPort ++ ")")) + <*> Opt.optional + ( Opt.strOption + ( Opt.long "db-image" + <> Opt.metavar "IMAGE" + <> Opt.help "Docker image to use for the database" + ) + ) + <*> Opt.optional + ( Opt.strOption + ( Opt.long "db-volume-mount-path" + <> Opt.metavar "PATH" + <> Opt.help "Path inside Docker container where database files are stored" + ) + ) diff --git a/waspc/cli/src/Wasp/Cli/Command/Start.hs b/waspc/cli/src/Wasp/Cli/Command/Start.hs index 7cefc3bc34d..d838d36f977 100644 --- a/waspc/cli/src/Wasp/Cli/Command/Start.hs +++ b/waspc/cli/src/Wasp/Cli/Command/Start.hs @@ -17,12 +17,12 @@ import Wasp.Cli.AppComponentUrls (makeAppComponentUrls) import Wasp.Cli.Command (Command, CommandError (..), require) import Wasp.Cli.Command.Call (Arguments) import Wasp.Cli.Command.Compile (compile, printWarningsAndErrorsIfAny) +import qualified Wasp.Cli.Command.Db.DevDb as DevDb import Wasp.Cli.Command.Message (cliSendMessageC) import Wasp.Cli.Command.News (fetchAndListMustSeeNewsIfDue) import Wasp.Cli.Command.Require.DbConnectionEstablished (DbConnectionEstablished (DbConnectionEstablished)) import Wasp.Cli.Command.Require.InWaspProject (InWaspProject (InWaspProject)) import Wasp.Cli.Command.Start.ArgumentsParser (StartArgs (..), startArgsParser) -import qualified Wasp.Cli.Command.Start.Db as Start.Db import Wasp.Cli.Command.Watch (watch) import Wasp.Cli.EnvVarWithCtx (addEnvVarsUniqueC) import qualified Wasp.Cli.EnvVarWithCtx as EnvVarWithCtx @@ -42,7 +42,7 @@ import qualified Wasp.Project.Env as Env -- It also listens for any file changes and recompiles and restarts generated project accordingly. start :: Arguments -> Command () start = withArguments startArgsParser $ \args -> - ProjectLock.acquireWatcher $ \projectLock -> Start.Db.withDevDb args.dbStartOptions $ \managedDb -> do + ProjectLock.acquireWatcher $ \projectLock -> DevDb.withDevDb args.dbStartOptions $ \managedDb -> do -- We check for the news only in `wasp start`, and only periodically, -- to avoid being too aggressive. Specifically: -- - We don't run it in other `wasp` commands because we don't want to diff --git a/waspc/cli/src/Wasp/Cli/Command/Start/ArgumentsParser.hs b/waspc/cli/src/Wasp/Cli/Command/Start/ArgumentsParser.hs index f7241d668db..ed4bf69e6bd 100644 --- a/waspc/cli/src/Wasp/Cli/Command/Start/ArgumentsParser.hs +++ b/waspc/cli/src/Wasp/Cli/Command/Start/ArgumentsParser.hs @@ -7,7 +7,7 @@ where import Network.Socket (PortNumber) import Network.URI (URI) import qualified Options.Applicative as Opt -import Wasp.Cli.Command.Start.Db (DbStartOptions, dbStartOptionsParser) +import Wasp.Cli.Command.Db.StartOptions (DbStartOptions, dbStartOptionsParser) import Wasp.Cli.Util.HttpUrlArgument (httpUrlParser) import Wasp.Cli.Util.Parser (ArgsParser (..)) import Wasp.Cli.Util.PortArgument (portParser) diff --git a/waspc/cli/src/Wasp/Cli/Command/Start/Db.hs b/waspc/cli/src/Wasp/Cli/Command/Start/Db.hs index 4491e9a090c..fef50a95dd6 100644 --- a/waspc/cli/src/Wasp/Cli/Command/Start/Db.hs +++ b/waspc/cli/src/Wasp/Cli/Command/Start/Db.hs @@ -1,25 +1,13 @@ module Wasp.Cli.Command.Start.Db ( start, - withDevDb, - DbStartOptions (..), - dbStartOptionsParser, ) where -import Control.Concurrent.Async (Async, async, cancel, race, wait) -import Control.Exception (IOException, try) -import Control.Monad (unless, when) -import Control.Monad.Catch (bracket, bracketOnError, finally) +import Control.Concurrent.Async (wait) +import Control.Monad (forM_) import qualified Control.Monad.Except as E import Control.Monad.IO.Class (liftIO) -import Data.List (intercalate) -import Data.Maybe (fromMaybe, isJust) -import Network.Socket (PortNumber) -import qualified Options.Applicative as Opt import StrongPath (Abs, Dir, File', Path', Rel, fromRelFile) -import System.Environment (lookupEnv) -import System.Exit (ExitCode) -import System.IO.Error (ioeGetErrorString) import Text.Printf (printf) import qualified Wasp.AppSpec as AS import qualified Wasp.AppSpec.App as AS.App @@ -28,20 +16,22 @@ import qualified Wasp.AppSpec.Valid as ASV import Wasp.Cli.Command (Command, CommandError (CommandError), require) import Wasp.Cli.Command.Call (Arguments) import Wasp.Cli.Command.Compile (analyze) -import qualified Wasp.Cli.Command.Db.Docker as Docker +import Wasp.Cli.Command.Db.DevDb + ( DatabaseSession (..), + DatabaseStartPolicy (..), + DatabaseUrlSource (..), + findDatabaseUrlSource, + withPostgresSession, + ) +import Wasp.Cli.Command.Db.StartOptions (DbStartOptions, dbStartOptionsParser) import Wasp.Cli.Command.Message (cliSendMessageC) import Wasp.Cli.Command.Require.InWaspProject (InWaspProject (InWaspProject)) import Wasp.Cli.Command.Require.WaspSpecAvailable (WaspSpecAvailable (WaspSpecAvailable)) -import Wasp.Cli.Port (resolvePort) import Wasp.Cli.Util.Parser (ArgsParser (..), withArguments) -import Wasp.Cli.Util.PortArgument (portParser) -import Wasp.Db.Postgres (defaultPostgresDockerImageSpec, defaultPostgresPort) import qualified Wasp.Message as Msg import Wasp.Project.Common (WaspProjectDir) import Wasp.Project.Db (databaseUrlEnvVarName) -import qualified Wasp.Project.Db.Dev.Postgres as Dev.Postgres import Wasp.Project.Env (dotEnvServer) -import Wasp.Util.Docker (DockerImageName, DockerVolumeMountPath) -- | Starts a "managed" dev database, where "managed" means that -- Wasp creates it and connects the Wasp app with it. @@ -72,65 +62,22 @@ start = withArguments startDbArgsParser $ \args -> do startDbArgsParser :: ArgsParser DbStartOptions startDbArgsParser = ArgsParser "wasp start db" dbStartOptionsParser -data DbStartOptions = DbStartOptions - { dbPort :: Maybe PortNumber, - dbImage :: Maybe DockerImageName, - dbVolumeMountPath :: Maybe DockerVolumeMountPath - } - deriving (Eq, Show) - -dbStartOptionsParser :: Opt.Parser DbStartOptions -dbStartOptionsParser = - DbStartOptions - <$> Opt.optional (portParser "db-port" ("Port to run the dev database on (default: " ++ show defaultPostgresPort ++ ")")) - <*> Opt.optional - ( Opt.strOption - ( Opt.long "db-image" - <> Opt.metavar "IMAGE" - <> Opt.help "Docker image to use for the database" - ) - ) - <*> Opt.optional - ( Opt.strOption - ( Opt.long "db-volume-mount-path" - <> Opt.metavar "PATH" - <> Opt.help "Path inside Docker container where database files are stored" - ) - ) - throwIfCustomDbAlreadyInUse :: AS.AppSpec -> Command () -throwIfCustomDbAlreadyInUse spec = do - throwIfDbUrlInEnv - throwIfDbUrlInServerDotEnv spec +throwIfCustomDbAlreadyInUse appSpec = do + databaseUrlSource <- liftIO $ findDatabaseUrlSource appSpec + forM_ databaseUrlSource $ \source -> + E.throwError $ CommandError "You are using custom database already" (message source) where - throwIfDbUrlInEnv :: Command () - throwIfDbUrlInEnv = do - dbUrl <- liftIO $ lookupEnv databaseUrlEnvVarName - when (isJust dbUrl) $ - throwCustomDbAlreadyInUseError - ( "Wasp has detected existing " - <> databaseUrlEnvVarName - <> " var in your environment.\n" - <> "To have Wasp run the dev database for you, make sure you remove that env var first." - ) - - throwIfDbUrlInServerDotEnv :: AS.AppSpec -> Command () - throwIfDbUrlInServerDotEnv appSpec = - when (isThereDbUrlInServerDotEnv appSpec) $ - throwCustomDbAlreadyInUseError - ( printf - ( "Wasp has detected that you have defined %s env var in your %s file.\n" - <> "To have Wasp run the dev database for you, make sure you remove that env var first." - ) - databaseUrlEnvVarName - (fromRelFile (dotEnvServer :: Path' (Rel WaspProjectDir) File')) - ) - where - isThereDbUrlInServerDotEnv = any ((== databaseUrlEnvVarName) . fst) . AS.devEnvVarsServer - - throwCustomDbAlreadyInUseError :: String -> Command () - throwCustomDbAlreadyInUseError msg = - E.throwError $ CommandError "You are using custom database already" msg + message source = case source of + EnvironmentVariable -> + printf + "Wasp has detected existing %s var in your environment.\nTo have Wasp run the dev database for you, make sure you remove that env var first." + databaseUrlEnvVarName + ServerDotEnvFile -> + printf + "Wasp has detected that you have defined %s env var in your %s file.\nTo have Wasp run the dev database for you, make sure you remove that env var first." + databaseUrlEnvVarName + (fromRelFile (dotEnvServer :: Path' (Rel WaspProjectDir) File')) startPostgresDevDb :: Path' Abs (Dir WaspProjectDir) -> String -> DbStartOptions -> Command () startPostgresDevDb waspProjectDir appName options = @@ -141,167 +88,3 @@ startPostgresDevDb waspProjectDir appName options = E.throwError $ CommandError "PostgreSQL stopped" "The database container exited. Check the PostgreSQL logs above." ReusedDatabase _ -> E.throwError $ CommandError "Database not started" "No managed PostgreSQL database was started." - -withDevDb :: DbStartOptions -> (Maybe Dev.Postgres.DevDbSpec -> Command a) -> Command a -withDevDb options action = do - InWaspProject waspProjectDir <- require - WaspSpecAvailable <- require - appSpec <- analyze waspProjectDir - databaseUrlSource <- liftIO $ findDatabaseUrlSource appSpec - case databaseUrlSource of - Just _ -> do - throwIfDbStartOptionsSupplied "DATABASE_URL is set." options - action Nothing - Nothing -> case ASV.getValidDbSystem appSpec of - AS.App.Db.SQLite -> do - throwIfDbStartOptionsSupplied "This project uses SQLite." options - action Nothing - AS.App.Db.PostgreSQL -> - withPostgresSession waspProjectDir (ASV.getApp appSpec).name options AllowExistingDatabase $ - action . Just . getDatabaseForSession - -data DatabaseStartPolicy = RequireNewDatabase | AllowExistingDatabase - deriving (Eq) - -data DatabaseSession - = ReusedDatabase Dev.Postgres.DevDbSpec - | StartedDatabase Dev.Postgres.DevDbSpec String (Async ExitCode) - -withPostgresSession :: Path' Abs (Dir WaspProjectDir) -> String -> DbStartOptions -> DatabaseStartPolicy -> (DatabaseSession -> Command a) -> Command a -withPostgresSession waspProjectDir appName options policy action = do - startupPlan <- prepareDatabaseStartup waspProjectDir appName options policy - bracket (acquire startupPlan) release use - where - acquire (ReuseDatabase session) = return session - acquire (CreateDatabase db image mountPath) = - bracketOnError - (withDatabaseError "Could not start PostgreSQL" $ Dev.Postgres.createDevPostgresContainer db image mountPath) - Docker.removeContainer - ( \containerId -> do - databaseJob <- liftIO $ async $ Docker.runDockerJobAndPrintOutput ["start", "--attach", containerId] - return $ StartedDatabase db containerId databaseJob - ) - - use session = do - case session of - StartedDatabase db _ databaseJob -> do - result <- - withDatabaseError "Could not start PostgreSQL" $ - race (wait databaseJob) (Dev.Postgres.waitForDevDbReady db) - case result of - Left _ -> E.throwError $ CommandError "Could not start PostgreSQL" "The Docker process exited before PostgreSQL was ready. Check the database output above." - Right () -> return () - when (policy == RequireNewDatabase) $ cliSendMessageC $ Msg.Info $ unlines $ additionalInfoLines db - _ -> return () - action session - - release (StartedDatabase _ containerId databaseJob) = - Docker.stopDatabase containerId `finally` (liftIO (cancel databaseJob) `finally` Docker.removeContainer containerId) - release _ = return () - -data DatabaseStartupPlan - = ReuseDatabase DatabaseSession - | CreateDatabase Dev.Postgres.DevDbSpec DockerImageName DockerVolumeMountPath - -prepareDatabaseStartup :: Path' Abs (Dir WaspProjectDir) -> String -> DbStartOptions -> DatabaseStartPolicy -> Command DatabaseStartupPlan -prepareDatabaseStartup waspProjectDir appName options policy = do - Docker.ensureDockerDaemonAvailable - - liftIO (Dev.Postgres.discoverProjectsRunningDevDb waspProjectDir appName) >>= \case - Just runningDb -> case policy of - RequireNewDatabase -> - E.throwError $ - CommandError - "PostgreSQL already running" - ( printf - "This project's database is already running on port %s. Stop the command that started it, or run `docker stop %s` before starting it again.\n%s" - (show runningDb.port) - runningDb.dockerContainerName - (unlines $ additionalInfoLines runningDb) - ) - AllowExistingDatabase -> ReuseDatabase <$> prepareExistingDatabase runningDb - Nothing -> prepareStartupOnPort =<< resolveDevDbPort - where - dbDockerImage = fromMaybe (fst defaultPostgresDockerImageSpec) options.dbImage - dbDockerVolumeMountPath = fromMaybe (snd defaultPostgresDockerImageSpec) options.dbVolumeMountPath - - resolveDevDbPort :: Command PortNumber - resolveDevDbPort = - resolvePort - options.dbPort - defaultPostgresPort - [] - "Choose a different port with --db-port, or free up this one." - "Free at least one of those ports by exiting the program listening on it, or choose the port yourself with --db-port." - - prepareExistingDatabase :: Dev.Postgres.DevDbSpec -> Command DatabaseSession - prepareExistingDatabase devDbSpec = do - withDatabaseError "PostgreSQL is not ready" $ Dev.Postgres.waitForDevDbReady devDbSpec - cliSendMessageC $ Msg.Info "PostgreSQL was already running for this project. Wasp did not start it and will not stop it." - unless (null $ suppliedOptionNames options) $ cliSendMessageC $ Msg.Warning "Database options not used" (printf "These options only apply when starting a new container: %s. Stop the running database before changing them." (intercalate ", " (suppliedOptionNames options))) - return $ ReusedDatabase devDbSpec - - prepareStartupOnPort :: PortNumber -> Command DatabaseStartupPlan - prepareStartupOnPort port = do - let devDbSpec = Dev.Postgres.makeDevPostgresDbSpec waspProjectDir appName port - Docker.ensureImageAvailable dbDockerImage - cliSendMessageC $ Msg.Start "Starting PostgreSQL..." - cliSendMessageC $ Msg.Info $ unlines dockerRunInfoLines - return $ CreateDatabase devDbSpec dbDockerImage dbDockerVolumeMountPath - - -- These lines describe what Docker is about to use, so we print them - -- only when starting the database: an already running container might have - -- been started with a different image or mount path than the current - -- invocation's arguments. - dockerRunInfoLines :: [String] - dockerRunInfoLines = - [ " ℹ Using Docker image: " <> dbDockerImage, - " with the data volume mounted at: " <> dbDockerVolumeMountPath - ] - -getDatabaseForSession :: DatabaseSession -> Dev.Postgres.DevDbSpec -getDatabaseForSession (ReusedDatabase db) = db -getDatabaseForSession (StartedDatabase db _ _) = db - -data DatabaseUrlSource = EnvironmentVariable | ServerDotEnvFile - -findDatabaseUrlSource :: AS.AppSpec -> IO (Maybe DatabaseUrlSource) -findDatabaseUrlSource appSpec = do - envUrl <- lookupEnv databaseUrlEnvVarName - return $ - if isJust envUrl - then Just EnvironmentVariable - else - if any ((== databaseUrlEnvVarName) . fst) appSpec.devEnvVarsServer - then Just ServerDotEnvFile - else Nothing - -throwIfDbStartOptionsSupplied :: String -> DbStartOptions -> Command () -throwIfDbStartOptionsSupplied reason options = - unless (null optionNames) $ E.throwError $ CommandError "Database options do not apply" (printf "%s These options only apply to Wasp-managed PostgreSQL: %s. Remove them to continue." reason (intercalate ", " optionNames)) - where - optionNames = suppliedOptionNames options - -suppliedOptionNames :: DbStartOptions -> [String] -suppliedOptionNames options = - ["--db-port" | isJust options.dbPort] - ++ ["--db-image" | isJust options.dbImage] - ++ ["--db-volume-mount-path" | isJust options.dbVolumeMountPath] - -additionalInfoLines :: Dev.Postgres.DevDbSpec -> [String] -additionalInfoLines devDbSpec = - [ "", - "Additional info:", - " ℹ Connection URL, in case you might want to connect with external tools:", - " " <> Dev.Postgres.getDevConnectionUrl devDbSpec, - " ℹ Database data is persisted in a Docker volume with the following name" - <> " (useful to know if you will want to delete it at some point):", - " " <> devDbSpec.dockerVolumeName - ] - -withDatabaseError :: String -> IO a -> Command a -withDatabaseError title action = do - result <- liftIO $ try action - case result of - Left (err :: IOException) -> E.throwError $ CommandError title $ ioeGetErrorString err - Right value -> return value diff --git a/waspc/cli/tests/DbMigrateTest.hs b/waspc/cli/tests/DbMigrateTest.hs index 0c340da76c8..a297c0badb8 100644 --- a/waspc/cli/tests/DbMigrateTest.hs +++ b/waspc/cli/tests/DbMigrateTest.hs @@ -3,7 +3,7 @@ module DbMigrateTest where import qualified Options.Applicative as Opt import Test.Hspec import Wasp.Cli.Command.Db.Migrate (migrateArgsParser) -import Wasp.Cli.Command.Start.Db (DbStartOptions (..), dbStartOptionsParser) +import Wasp.Cli.Command.Db.StartOptions (DbStartOptions (..), dbStartOptionsParser) import Wasp.Cli.Util.Parser (ArgsParser (optParser)) import Wasp.Generator.DbGenerator.Common (MigrateArgs (..), defaultMigrateArgs) diff --git a/waspc/waspc.cabal b/waspc/waspc.cabal index 34600838303..4a5b2e965d2 100644 --- a/waspc/waspc.cabal +++ b/waspc/waspc.cabal @@ -474,10 +474,12 @@ library cli-lib Wasp.Cli.Command.CreateNewProject.StarterTemplates.GhReleaseArchive Wasp.Cli.Command.CreateNewProject.StarterTemplates.Templating Wasp.Cli.Command.Db + Wasp.Cli.Command.Db.DevDb Wasp.Cli.Command.Db.Docker Wasp.Cli.Command.Db.Migrate Wasp.Cli.Command.Db.Reset Wasp.Cli.Command.Db.Seed + Wasp.Cli.Command.Db.StartOptions Wasp.Cli.Command.Db.Studio Wasp.Cli.Command.Deploy Wasp.Cli.Command.Deps