Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
43 changes: 5 additions & 38 deletions waspc/cli/src/Wasp/Cli/Command/Start/Db.hs
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,6 @@ module Wasp.Cli.Command.Start.Db
)
where

import Network.Socket (PortNumber)
import qualified Options.Applicative as Opt
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
Expand All @@ -15,18 +13,16 @@ 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.DevDb (startPostgresDevDb, throwIfCustomDbAlreadyInUse)
import Wasp.Cli.DevDb.ArgumentsParser (DevDbOptions, devDbOptionsParser)
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.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 startDbArgsParser $ \args -> do
start = withArguments startDbArgsParser $ \devDbOptions -> do
InWaspProject waspProjectDir <- require
WaspSpecAvailable <- require
appSpec <- analyze waspProjectDir
Expand All @@ -37,40 +33,11 @@ start = withArguments startDbArgsParser $ \args -> do

case ASV.getValidDbSystem appSpec of
AS.App.Db.SQLite -> noteSQLiteDoesntNeedStart
AS.App.Db.PostgreSQL ->
startPostgresDevDb
waspProjectDir
app.name
(dbPort args)
(dbImage args)
(dbVolumeMountPath args)
AS.App.Db.PostgreSQL -> startPostgresDevDb waspProjectDir app.name devDbOptions
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)
)

data StartDbArgs = StartDbArgs
{ dbPort :: Maybe PortNumber,
dbImage :: DockerImageName,
dbVolumeMountPath :: DockerVolumeMountPath
}
startDbArgsParser :: ArgsParser DevDbOptions
startDbArgsParser = ArgsParser "wasp start db" devDbOptionsParser
20 changes: 10 additions & 10 deletions waspc/cli/src/Wasp/Cli/DevDb.hs
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@ import qualified Wasp.AppSpec as AS
import Wasp.Cli.Command (Command, CommandError (CommandError))
import Wasp.Cli.Command.Common (throwIfExeIsNotAvailable)
import Wasp.Cli.Command.Message (cliSendMessageC)
import Wasp.Cli.DevDb.ArgumentsParser (DevDbOptions (..))
import Wasp.Cli.Port (resolvePort)
import Wasp.Db.Postgres (defaultPostgresPort)
import qualified Wasp.Job as Job
Expand All @@ -29,20 +30,19 @@ import Wasp.Project.Db (databaseUrlEnvVarName)
import qualified Wasp.Project.Db.Dev.Postgres as Dev.Postgres
import Wasp.Project.Env (dotEnvServer)
import Wasp.Util (checkExitSuccess)
import Wasp.Util.Docker (DockerImageName, DockerVolumeMountPath)
import qualified Wasp.Util.Docker as Docker

startPostgresDevDb :: Path' Abs (Dir WaspProjectDir) -> String -> Maybe PortNumber -> DockerImageName -> DockerVolumeMountPath -> Command ()
startPostgresDevDb waspProjectDir appName requestedDbPort dbDockerImage dbDockerVolumeMountPath =
withPostgresDevDb waspProjectDir appName requestedDbPort dbDockerImage dbDockerVolumeMountPath $ \waitForDbExit -> do
startPostgresDevDb :: Path' Abs (Dir WaspProjectDir) -> String -> DevDbOptions -> Command ()
startPostgresDevDb waspProjectDir appName devDbOptions =
withPostgresDevDb waspProjectDir appName devDbOptions $ \waitForDbExit -> do
cliSendMessageC $ Msg.Info "PostgreSQL dev database is ready. Press Ctrl+C to stop it."
waitForDbExit

-- | Starts the project's PostgreSQL dev database, and runs the action once the
-- database accepts connections. The action gets a way to wait for the database
-- to exit. The database is stopped and removed when the action finishes.
withPostgresDevDb :: forall a. Path' Abs (Dir WaspProjectDir) -> String -> Maybe PortNumber -> DockerImageName -> DockerVolumeMountPath -> (Command () -> Command a) -> Command a
withPostgresDevDb waspProjectDir appName requestedDbPort dbDockerImage dbDockerVolumeMountPath action = do
withPostgresDevDb :: forall a. Path' Abs (Dir WaspProjectDir) -> String -> DevDbOptions -> (Command () -> Command a) -> Command a
withPostgresDevDb waspProjectDir appName devDbOptions action = do
throwIfExeIsNotAvailable
"docker"
"To run PostgreSQL dev database, Wasp needs `docker` installed and in PATH."
Expand All @@ -69,7 +69,7 @@ withPostgresDevDb waspProjectDir appName requestedDbPort dbDockerImage dbDockerV
resolveDevDbPort :: Command PortNumber
resolveDevDbPort =
resolvePort
requestedDbPort
devDbOptions.dbPort
defaultPostgresPort
[]
"Choose a different port with --db-port, or free up this one."
Expand Down Expand Up @@ -103,7 +103,7 @@ withPostgresDevDb waspProjectDir appName requestedDbPort dbDockerImage dbDockerV
Left _exitCode -> throwDbError "The database stopped before accepting connections."

runDbJob :: Dev.Postgres.DevDbSpec -> IO ExitCode
runDbJob devDbSpec = Job.run $ Dev.Postgres.runDevPostgresDb devDbSpec dbDockerImage dbDockerVolumeMountPath
runDbJob devDbSpec = Job.run $ Dev.Postgres.runDevPostgresDb devDbSpec devDbOptions.dbImage devDbOptions.dbVolumeMountPath

throwIfDbFailed :: ExitCode -> Command ()
throwIfDbFailed exitCode =
Expand All @@ -130,8 +130,8 @@ withPostgresDevDb waspProjectDir appName requestedDbPort dbDockerImage dbDockerV
-- invocation's arguments.
dockerRunInfoLines :: [String]
dockerRunInfoLines =
[ " ℹ Using Docker image: " <> dbDockerImage,
" with the data volume mounted at: " <> dbDockerVolumeMountPath
[ " ℹ Using Docker image: " <> devDbOptions.dbImage,
" with the data volume mounted at: " <> devDbOptions.dbVolumeMountPath
]

throwIfCustomDbAlreadyInUse :: AS.AppSpec -> Command ()
Expand Down
36 changes: 36 additions & 0 deletions waspc/cli/src/Wasp/Cli/DevDb/ArgumentsParser.hs
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
module Wasp.Cli.DevDb.ArgumentsParser
( DevDbOptions (..),
devDbOptionsParser,
)
where

import Network.Socket (PortNumber)
import qualified Options.Applicative as Opt
import Wasp.Cli.Util.PortArgument (portParser)
import Wasp.Db.Postgres (defaultPostgresDockerImageSpec, defaultPostgresPort)
import Wasp.Util.Docker (DockerImageName, DockerVolumeMountPath)

data DevDbOptions = DevDbOptions
{ dbPort :: Maybe PortNumber,
dbImage :: DockerImageName,
dbVolumeMountPath :: DockerVolumeMountPath
}

devDbOptionsParser :: Opt.Parser DevDbOptions
devDbOptionsParser =
DevDbOptions
<$> 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)
)
1 change: 1 addition & 0 deletions waspc/waspc.cabal
Original file line number Diff line number Diff line change
Expand Up @@ -517,6 +517,7 @@ library cli-lib
Wasp.Cli.Common
Wasp.Cli.Compile
Wasp.Cli.DevDb
Wasp.Cli.DevDb.ArgumentsParser
Wasp.Cli.EnvVarWithCtx
Wasp.Cli.FileSystem
Wasp.Cli.GithubRepo
Expand Down