Fail to run db migrate-dev on Windows

[nodtem66]

Describe the bug

Wasp generator produces invalid Windows path for MyApp/.wasp/out/sdk/dev/index.ts (16,50)

To Reproduce
Steps to reproduce the behavior:

• Clone commit Better Win support: correct resolving of node/npm/npx & prisma #3258 for fixing npm on Windows shell
• Prepare the waspc/data/packages/ from waspc/packages

./waspc/tool/install_packages_to_data_dir

• Create new project

cabal run wasp-cli -- new MyApp

• Run db migrate-dev

cabal run wasp-cli -- db migrate-dev

• The console will show this error:

? --- Setting up database... -----------------------------------------------------
[   Db  !] Error: P1003
[   Db  !]
[   Db  !] Database `dev.db` does not exist at `D:\src\github\wasp\waspc\examples\MyApp\.wasp\out\db\./dev.db`.
[   Db  !]
[   Db   ] Environment variables loaded from .env
[   Db   ] Prisma schema loaded from ..\db\schema.prisma
[   Db   ]
[   Db   ] ? Generated Prisma Client (v5.19.1) to .\..\..\..\node_modules\@prisma\client in 142ms
[   Db   ]
? --- Database successfully set up. ----------------------------------------------
? --- Building SDK... ------------------------------------------------------------

[  Wasp  ] dev/index.ts(16,50): error TS1002: Unterminated string literal.
? --- [Error] Your wasp project failed to compile: -------------------------------
- SDK build failed with exit code: 2
? --- [Error] Compilation of wasp project failed: --------------------------------
1 errors found

This is the content of dev/index.ts(16,50)

export function resolveProjectPath(path: string): string {
const waspProjectDirFromWebAppDir = '..\..\..\'
return joinPaths(waspProjectDirFromWebAppDir, path)
}

Environment:

• OS: Windows 11 (Build 10.0.26100)
• Cabal 3.12.1.0
• Stack 3.3.1
• HLS 2.10.0.0
• GHC 8.10.7 (base-4.14.3.0)

PS. I'm working on this issue.

[nodtem66]

General approach for fixing this issue

The problem is mustache does not escape backslashes. For example, if path=..\..\
'{= path =}' will be compiled to '..\..\', which is an unterminated string literal.

To fix this, we need to patch all template strings within the single/double quotes in waspc/data/Generator/templates

Files that need to patch (WIP)

TS files

• data\Generator\templates\react-app\vite\detectServerImports.ts
• data\Generator\templates\react-app\package.json
• data\Generator\templates\react-app\tsconfig.app.json
• data\Generator\templates\react-app\tsconfig.vite.json
• data\Generator\templates\react-app\vite.config.ts
• data\Generator\templates\sdk\wasp\dev\index.ts
• data\Generator\templates\sdk\wasp\package.json
• data\Generator\templates\server\nodemon.json
• data\Generator\templates\server\tsconfig.json
• data\Generator\templates\server\src\jobs_job.ts
• data\Generator\templates\Dockerfile

Haskell files

• waspc/src/Wasp/Generator/SdkGenerator.hs
• waspc/src/Wasp/Generator/ServerGenerator.hs
• waspc/src/Wasp/Generator/WebAppGenerator.hs
• waspc/src/Wasp/Generator/WebAppGenerator/Test.hs
• waspc/src/Wasp/Generator/WebAppGenerator/Vite.hs
• waspc/src/Wasp/Generator/WebAppGenerator/Vite/VitePlugin.hs

[Martinsos]

Ouf yeah didn't see that coming, nice catch!

What would be the best solution? Some I can think of:

1. Don't have '{= path =}' in mustache, instead have {= pathString =}. Then we take care of escaping on the Haskell side.
2. We make sure any of those path's don't end with separator (we strip it with some helper function).

Probably (1) is better.

[nodtem66]

The first option sounds good to me. But we can also fix only Haskell files by changing the paths to Posix style.

[Martinsos]

The first option sounds good to me. But we can also fix only Haskell files by changing the paths to Posix style.

Hm fix only Haskell files by changing paths to Posix style -> Yes I guess we could, but these are paths to files on the system, so I guess they should have correct system-specific separators, right? I know JS imports can work with just posix, but I am not sure if that is correct for all possible functions that might be doing something with file paths hm. Maybe I misunderstood something though? But the whole thign we are doing wiht StrongPath library in Haskell code is knowing exactly which path is Posix, Windows, or System, so that we don't have to worry about that and we know it always uses correct separators.