Enable npm workspace for user project and generated code

waspc/data/Generator/templates/Dockerfile

@@ -49,7 +49,7 @@ RUN cd .wasp/build/server && npm run bundle
 
 # Depending on `npm`'s dependency resolution, these folders may or may not exist.
 # We ensure they are created so that the COPY instruction later does not fail.
-RUN mkdir -p /app/node_modules /app/.wasp/build/server/node_modules
+RUN mkdir -p ./node_modules ./.wasp/build/server/node_modules
 
 
 # TODO: Use pm2?

waspc/src/Wasp/Generator/NpmDependencies.hs

@@ -8,7 +8,6 @@ module Wasp.Generator.NpmDependencies
     getUserNpmDepsForPackage,
     getNpmDepsConflicts,
     NpmDepsForPackage (..),
-    NpmDepsForPackageError (..),
     conflictErrorToMessage,
     genNpmDepsForPackage,
     NpmDepsForFramework,
@@ -68,12 +67,6 @@ instance ToJSON NpmDepsForUser
 
 instance FromJSON NpmDepsForUser
 
-data NpmDepsForPackageError = NpmDepsForPackageError
-  { dependenciesConflictErrors :: [DependencyConflictError],
-    devDependenciesConflictErrors :: [DependencyConflictError]
-  }
-  deriving (Show, Eq)
-
 data DependencyConflictError = DependencyConflictError
   { waspDependency :: D.Dependency,
     userDependency :: D.Dependency
@@ -83,33 +76,32 @@ data DependencyConflictError = DependencyConflictError
 -- | Generate a NpmDepsForPackage by combining wasp dependencies with user dependencies
 --   derived from AppSpec, or if there are conflicts, fail with error messages.
 genNpmDepsForPackage :: AppSpec -> NpmDepsForWasp -> Generator NpmDepsForPackage
-genNpmDepsForPackage spec npmDepsForWasp =
-  case getNpmDepsConflicts npmDepsForWasp (getUserNpmDepsForPackage spec) of
-    Nothing -> return $ waspDepsToPackageDeps npmDepsForWasp
-    Just conflictErrorDeps ->
+genNpmDepsForPackage spec npmDepsForWasp
+  | null conflictErrors = return $ waspDepsToPackageDeps npmDepsForWasp
+  | otherwise =
       logAndThrowGeneratorError $
         GenericGeneratorError $
           intercalate "\n " $
             map
               conflictErrorToMessage
-              ( dependenciesConflictErrors conflictErrorDeps
-                  ++ devDependenciesConflictErrors conflictErrorDeps
-              )
+              conflictErrors
+  where
+    conflictErrors = getNpmDepsConflicts npmDepsForWasp (getUserNpmDepsForPackage spec)
 
 buildWaspFrameworkNpmDeps :: AppSpec -> NpmDepsForWasp -> NpmDepsForWasp -> Either String NpmDepsForFramework
-buildWaspFrameworkNpmDeps spec forServer forWebApp =
-  case (serverDepConflicts, webAppDepConflicts) of
-    (Nothing, Nothing) ->
-      Right
+buildWaspFrameworkNpmDeps spec forServer forWebApp
+  | hasConflicts = Left "Could not construct npm dependencies due to a previously reported conflict."
+  | otherwise =
+      Right $
         NpmDepsForFramework
           { npmDepsForServer = waspDepsToPackageDeps forServer,
             npmDepsForWebApp = waspDepsToPackageDeps forWebApp
           }
-    _ -> Left "Could not construct npm dependencies due to a previously reported conflict."
   where
-    userDeps = getUserNpmDepsForPackage spec
+    hasConflicts = not $ null serverDepConflicts && null webAppDepConflicts
     serverDepConflicts = getNpmDepsConflicts forServer userDeps
     webAppDepConflicts = getNpmDepsConflicts forWebApp userDeps
+    userDeps = getUserNpmDepsForPackage spec
 
 getUserNpmDepsForPackage :: AppSpec -> NpmDepsForUser
 getUserNpmDepsForPackage spec =
@@ -150,27 +142,20 @@ waspDepsToPackageDeps npmDepsForWasp =
     }
 
 -- | Checks the user's dependencies compatibility against Wasp's declared npm dependencies.
-getNpmDepsConflicts :: NpmDepsForWasp -> NpmDepsForUser -> Maybe NpmDepsForPackageError
+getNpmDepsConflicts :: NpmDepsForWasp -> NpmDepsForUser -> [DependencyConflictError]
 getNpmDepsConflicts npmDepsForWasp npmDepsForUser =
-  if null conflictErrors && null devConflictErrors
-    then Nothing
-    else
-      Just $
-        NpmDepsForPackageError
-          { dependenciesConflictErrors = conflictErrors,
-            devDependenciesConflictErrors = devConflictErrors
-          }
+  conflictErrors ++ devConflictErrors
   where
+    conflictErrors = determineConflictErrors allWaspDepsByName userDepsByName
+    devConflictErrors = determineConflictErrors allWaspDepsByName userDevDepsByName
+
+    allWaspDepsByName = (Map.union `on` makeDepsByName) waspDeps waspDevDeps
     waspDeps = waspDependencies npmDepsForWasp
     waspDevDeps = waspDevDependencies npmDepsForWasp
-    allWaspDepsByName = (Map.union `on` makeDepsByName) waspDeps waspDevDeps
 
     userDepsByName = makeDepsByName $ userDependencies npmDepsForUser
     userDevDepsByName = makeDepsByName $ userDevDependencies npmDepsForUser
 
-    conflictErrors = determineConflictErrors allWaspDepsByName userDepsByName
-    devConflictErrors = determineConflictErrors allWaspDepsByName userDevDepsByName
-
 type DepsByName = Map.Map String D.Dependency
 
 -- Given a map of wasp dependencies and a map of user dependencies, construct a

waspc/src/Wasp/Generator/NpmWorkspaces.hs

@@ -1,54 +1,47 @@
 module Wasp.Generator.NpmWorkspaces
   ( serverPackageName,
-    toWorkspacesField,
     webAppPackageName,
-    workspaces,
+    workspaceGlobs,
   )
 where
 
-import Control.Exception (Exception (displayException))
-import Data.List (sort)
-import StrongPath (Dir, Path, Posix, Rel, fromRelDirP, relDirToPosix, reldirP, (</>))
+import Data.Either (fromRight)
+import StrongPath (Dir, Path, Path', Posix, Rel, (</>))
+import qualified StrongPath as SP
 import qualified System.FilePath.Posix as FP.Posix
 import Wasp.AppSpec (AppSpec, isBuild)
-import Wasp.Project.Common (WaspProjectDir, buildDirInDotWaspDir, dotWaspDirInWaspProjectDir, generatedCodeDirInDotWaspDir)
+import Wasp.Generator.Common (ProjectRootDir)
+import Wasp.Project.Common
+  ( WaspProjectDir,
+    buildDirInDotWaspDir,
+    dotWaspDirInWaspProjectDir,
+    generatedCodeDirInDotWaspDir,
+  )
 
--- | Returns the list of workspaces that should be included in the generated package.json file. Each
+-- | Returns the list of workspaces that should be included in the user's `package.json` file. Each
 -- workspace is a glob that matches all packages in a certain directory.
--- The path syntax here is always POSIX, because Windows syntax does not allow globs, and `npm`
--- prefers it.
 --
--- Order doesn't matter, but we sort the packages to ensure a deterministic order. Otherwise, we
--- might inadvertently change the order and the compiler will complain about it in user's projects.
-workspaces :: [Path Posix (Rel WaspProjectDir) (Dir ())]
-workspaces =
-  sort
-    [ globFor generatedCodeDirInDotWaspDir,
-      globFor buildDirInDotWaspDir
-      -- TODO: Add SDK as a workspace:
-      -- Currently a overly-zealous resolution makes an incompatible resolution for `@types/react`
-      -- that would make the workspace installation fail.
-      -- Review when we upgrade React 19 (#2482).
-    ]
+-- The glob syntax is POSIX-path-like, but not actually a path, so it's represented as a String.
+workspaceGlobs :: [String]
+workspaceGlobs =
+  FP.Posix.dropTrailingPathSeparator . SP.fromRelDirP
+    <$> [ makeGlobFromProjectRoot $ dotWaspDirInWaspProjectDir </> generatedCodeDirInDotWaspDir,
+          makeGlobFromProjectRoot $ dotWaspDirInWaspProjectDir </> buildDirInDotWaspDir
+          -- TODO: Add SDK as a workspace (#3233)
+        ]
   where
-    globFor dir =
-      forceRelDirToPosix (dotWaspDirInWaspProjectDir </> dir)
-        </> packageWildcard
-    packageWildcard = [reldirP|*|]
+    makeGlobFromProjectRoot :: Path' (Rel WaspProjectDir) (Dir ProjectRootDir) -> Path Posix (Rel WaspProjectDir) (Dir a)
+    makeGlobFromProjectRoot projectRootDir = (forceRelDirToPosix projectRootDir) </> packageWildcard
 
-    forceRelDirToPosix = either nonPosixError id . relDirToPosix
-    nonPosixError exception =
-      error $
-        unlines
-          [ "This should never happen: our paths should always be POSIX-compatible, but they're not.",
-            displayException exception
-          ]
+    -- We force this to be POSIX because Windows-style paths do not accept wildcard characters.
+    packageWildcard = [SP.reldirP|*|]
 
-toWorkspacesField :: [Path Posix (Rel WaspProjectDir) (Dir ())] -> [String]
-toWorkspacesField =
-  -- While the trailing slashes do not matter, we drop them because they will be user-visible in
-  -- their `package.json`, and it is more customary without them.
-  fmap (FP.Posix.dropTrailingPathSeparator . fromRelDirP)
+    forceRelDirToPosix inputDir = fromRight (makeNonPosixError inputDir) $ SP.relDirToPosix inputDir
+    makeNonPosixError inputDir =
+      error $
+        "This should never happen: our paths should always be POSIX-compatible, but they're not. (Received: "
+          ++ show inputDir
+          ++ ")"
 
 serverPackageName :: AppSpec -> String
 serverPackageName = workspacePackageName "server"
@@ -57,6 +50,8 @@ webAppPackageName :: AppSpec -> String
 webAppPackageName = workspacePackageName "webapp"
 
 workspacePackageName :: String -> AppSpec -> String
-workspacePackageName baseName spec = "@wasp.sh/generated-" ++ baseName ++ "-" ++ mode
+workspacePackageName baseName spec = "@wasp.sh/generated-" ++ baseName ++ "-" ++ modeName
   where
-    mode = if isBuild spec then "build" else "dev"
+    modeName
+      | isBuild spec = "build"
+      | otherwise = "dev"

waspc/src/Wasp/Generator/Valid/PackageJson.hs

@@ -8,7 +8,6 @@ import qualified Data.Map as M
 import qualified Wasp.ExternalConfig.Npm.PackageJson as P
 import Wasp.Generator.DepVersions (prismaVersion, typescriptVersion)
 import Wasp.Generator.Monad (GeneratorError (GenericGeneratorError))
-import Wasp.Generator.NpmWorkspaces (toWorkspacesField)
 import qualified Wasp.Generator.NpmWorkspaces as NW
 import Wasp.Generator.ServerGenerator.DepVersions (expressTypesVersion)
 import Wasp.Generator.Valid.Common (FullyQualifiedFieldName (FieldName), validateArrayFieldIncludesRequired)
@@ -67,7 +66,7 @@ validateWorkspaces packageJson =
   validateArrayFieldIncludesRequired
     "package.json"
     (FieldName ["workspaces"])
-    (toWorkspacesField NW.workspaces)
+    NW.workspaceGlobs
     (P.workspaces packageJson)
 
 validatePackageJsonDependency :: P.PackageJson -> PackageSpecification -> PackageRequirement -> [GeneratorError]

waspc/tests/AppSpec/ValidTest.hs

@@ -33,7 +33,6 @@ import qualified Wasp.AppSpec.Route as AS.Route
 import qualified Wasp.AppSpec.Valid as ASV
 import qualified Wasp.ExternalConfig.Npm.PackageJson as Npm.PackageJson
 import qualified Wasp.ExternalConfig.TsConfig as T
-import Wasp.Generator.NpmWorkspaces (toWorkspacesField)
 import qualified Wasp.Generator.NpmWorkspaces as NW
 import qualified Wasp.Psl.Ast.Argument as Psl.Argument
 import qualified Wasp.Psl.Ast.Attribute as Psl.Attribute
@@ -508,7 +507,7 @@ spec_AppSpecValid = do
               { Npm.PackageJson.name = "testApp",
                 Npm.PackageJson.dependencies = M.empty,
                 Npm.PackageJson.devDependencies = M.empty,
-                Npm.PackageJson.workspaces = Just $ toWorkspacesField NW.workspaces
+                Npm.PackageJson.workspaces = Just $ NW.workspaceGlobs
               },
           AS.isBuild = False,
           AS.migrationsDir = Nothing,