Small fixes in the generator #2269

sodic · 2024-09-06T16:02:19Z

Small stuff I noticed while working on #2202.

sodic · 2024-09-06T16:02:40Z

waspc/src/Wasp/AppSpec/Job.hs

 -- These are optional executor-specific JSON options we pass
 -- directly through to the executor when submitting jobs.
 data ExecutorOptions = ExecutorOptions
  { pgBoss :: Maybe JSON,
-    simple :: Maybe JSON


We don't use this as far as I can see, and it's not documented.

Origin story:

Martinsos · 2024-09-06T18:48:15Z

waspc/src/Wasp/Project/Analyze.hs

        && (length (toFilePath path) > length (".wasp" :: String))

+hasExtension :: Path' s (File f) -> String -> Bool


What I don't like about this function is that it isnt' obvious if it takes .ext or ext as second argument, but it will not always work correctly in the latter case. Actually, if I had to guess, I would think it takes ext -> since that is extension, not .ext. I would either make so it exxpects ext + document that in a short comment, or remove the function and just inline this logic where it is used.

Another thing: you can go with (Path s) r (File f) as it doesn't matter if its Win or Posix path.

Martinsos · 2024-09-06T18:54:11Z

waspc/src/Wasp/Project/Analyze.hs

+    findWaspTsFile files = WaspTsFile . (waspDir </>) <$> find (`hasExtension` ".wasp.mts") files
+    findWaspLangFile files = WaspLangFile . (waspDir </>) <$> find isWaspLangFile files
+    isWaspLangFile path =
+      path `hasExtension` ".wasp"
        && (length (toFilePath path) > length (".wasp" :: String))


Hm this is an interesting line of code -> we are making sure we don't pick up .wasp dir as wasp file.
When I saw this, I felt like we should also do it for .wasp.mts. I know it is not likely that there will be .wasp.mts directory, but this way we are sure + we are consistent.

So what seems best to me now is to take this piece of logic that checks length and also add it to hasExtension, that because it really belongs there I think, and you also that way got it applied for both cases here + it is nicer to read.

Martinsos · 2024-09-06T19:16:53Z

waspc/src/Wasp/Project/Analyze.hs

+              [ SP.fromAbsDir workingDir ++ "node_modules/wasp-ts-sdk/dist/run.js",
+                SP.fromAbsDir workingDir ++ ".wasp/config/main.wasp.mjs"


This won't work on Win, because workingDir will have Win separators and you have posix separators on the right.
In general I recommend converting from StrongPath at the last moment possible, that will save you from mistakes like this.
So in this case:

SP.fromAbsFile $ workingDir </> [relfile|node_modules/wasp-ts-sdk/dist/run.js|], ...

Martinsos · 2024-09-06T19:20:46Z

waspc/src/Wasp/Project/Analyze.hs

+  case tscExitCode of
+    ExitFailure _status -> return $ Left ["Error while running TypeScript compiler on the *.wasp.mts file."]
+    ExitSuccess -> do
+      otherChan <- newChan


wow otherChan, what happened here :D

Martinsos · 2024-09-06T19:21:39Z

waspc/src/Wasp/Project/Analyze.hs

+              otherChan
+          )
+      case runExitCode of
+        ExitFailure _status -> return $ Left ["Error while running the compiled *.wasp.mts file."]


Why not use actual file name here. You have it available. And you avoid a bit of hardcoding.

Martinsos · 2024-09-06T19:22:33Z

waspc/src/Wasp/Project/Analyze.hs

+          )
+      case runExitCode of
+        ExitFailure _status -> return $ Left ["Error while running the compiled *.wasp.mts file."]
+        ExitSuccess -> return $ Right []


No decls? Aha I guess we don't yet have that?

https://arewetssdkyet.com

Martinsos · 2024-09-06T19:24:32Z

waspc/src/Wasp/Project/Analyze.hs

+          -- let payload:: String = read $ T.unpack text
+          liftIO $ putStrLn "Ovo smo dobili na stdout"
+          -- parse payload as json
+          let json = Aeson.toJSON payload


Aha this is still WIP! Sorry I thought this PR is ready for review since it wasn't draft PR.

Aw man, I made a git error.
The Analyze.hs file was never supposed to be here, I must have committed it by accident.

Sorry for wasting your time, my bad!

What worries me is that you got through the entire review without noticing that the code is too horrible for something I'd send to code review.

Commenting with a straight face at all the atrocities and only realizing something was off when you encountered a string in Croatian.

Is that what you think of me, Martin? I don't know whether to praise your patience or worry about your perception 😄

Anyway, I'll remove this file from the PR. Please take a look at the other files. :)

Hah, I believed in you!

All right, I will take another look. Maybe of some the change syou did in this file though, and that I commented on, are still present in the version of the code you are woroking on? In that case do take a look at my comments on Analyze.hs and see if you can apply them.

Or maybe this is just your sneaky way of giving up on a bad PR :D? "ha it was a joke from the very start"

Martinsos · 2024-09-06T19:31:28Z

waspc/src/Wasp/Project/Analyze.hs

+data WaspFile
+  = WaspLangFile {_path :: !(Path' Abs File')}
+  | WaspTsFile {_path :: !(Path' Abs File')}
+  deriving (Show)


Interesting, feels a bit unusual. I get why you did it though, you want to be able to say it is one of them but you don't want to yet know which one. Records in sum types are usually an anti-pattern, but these records are identical except for the data constructor, so it works.

What if you want to specify somewhere that a function needs specifically path to WaspTS file? Or Sepcifically WaspLangFile? We have that knowledge but we didn't put it in StrongPath.

I guess soltuion would be

data WaspLangFile data WaspTsFile data WaspFile = WaspLang (Path' Abs WaspLangFile) | WaspTs (Path' Abs WaspTsFile)

And I wouldn't bother with _path, I probably won't be needing that anyway as I will most likely always want to deconstruct hm.
But ok, this is verbose a bit, and it is all quite localized so I guess it is not important. Although you do export WaspFile (..), which makes it less localized hm. Ok, I am ok with this what you have, although I would be tempted to go this extra step.

Martinsos · 2024-09-06T19:32:31Z

Ha small fixes you say, but then there is also the flow for main.wasp.ts vs main.wasp.lang!

This reverts commit a1842e8.

sodic · 2024-09-11T14:37:00Z

waspc/src/Wasp/Generator/Monad.hs

@@ -25,7 +25,7 @@ import Data.List.NonEmpty (NonEmpty, fromList)
 -- The mechanism to catch errors is only there to assist in collecting more errors, not recover.
 -- There may optionally be additional errors or non-fatal warnings logged in the State.
 newtype Generator a = Generator
-  { _runGenerator :: ExceptT GeneratorError (StateT GeneratorState Identity) a
+  { _runGenerator :: ExceptT GeneratorError (State GeneratorState) a


I changed this just so I could ask what's the purpose of using StateT s Identity instead of State s).

Hah, can't remember at the moment! I guess it is the same thing?

From what I know, it is.

Martinsos · 2024-09-15T10:03:36Z

waspc/src/Wasp/Generator/Monad.hs

@@ -25,7 +25,7 @@ import Data.List.NonEmpty (NonEmpty, fromList)
 -- The mechanism to catch errors is only there to assist in collecting more errors, not recover.
 -- There may optionally be additional errors or non-fatal warnings logged in the State.
 newtype Generator a = Generator
-  { _runGenerator :: ExceptT GeneratorError (StateT GeneratorState Identity) a
+  { _runGenerator :: ExceptT GeneratorError (State GeneratorState) a


Hah, can't remember at the moment! I guess it is the same thing?

sodic added 2 commits September 6, 2024 17:04

Fix small mistakes in generator

27ca30d

Merge branch 'main' into filip-small-generator-fixes

8eaee7a

sodic commented Sep 6, 2024

View reviewed changes

sodic added 4 commits September 6, 2024 18:12

Fix syntax error

a1842e8

Revert mistake with Job decl

02dc4d8

Fix syntax error

93a0eee

Fix tests

4fbbf52

Martinsos reviewed Sep 6, 2024

View reviewed changes

sodic added 3 commits September 9, 2024 17:08

Revert "Fix syntax error"

78b2be9

This reverts commit a1842e8.

Fix formatting

0253937

Simplify Generator Monad

fc2830c

sodic commented Sep 11, 2024

View reviewed changes

Remove redundant genRealSdk

ec1df7b

Martinsos approved these changes Sep 15, 2024

View reviewed changes

sodic added 2 commits September 19, 2024 12:52

Update e2e tests

ebfe696

Merge branch 'main' into filip-small-generator-fixes

6a13097

sodic merged commit 0dbd797 into main Sep 27, 2024
6 checks passed

sodic deleted the filip-small-generator-fixes branch September 27, 2024 15:30

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Small fixes in the generator #2269

Small fixes in the generator #2269

sodic commented Sep 6, 2024

sodic Sep 6, 2024

infomiho Sep 16, 2024

Martinsos Sep 6, 2024

Martinsos Sep 6, 2024

Martinsos Sep 6, 2024

Martinsos Sep 6, 2024

Martinsos Sep 6, 2024

Martinsos Sep 6, 2024

infomiho Sep 16, 2024

Martinsos Sep 6, 2024

sodic Sep 9, 2024 •

edited

Loading

Martinsos Sep 15, 2024

Martinsos Sep 15, 2024 •

edited

Loading

Martinsos Sep 6, 2024

Martinsos commented Sep 6, 2024

sodic Sep 11, 2024

Martinsos Sep 15, 2024

sodic Sep 19, 2024

Martinsos Sep 15, 2024

		&& (length (toFilePath path) > length (".wasp" :: String))

		hasExtension :: Path' s (File f) -> String -> Bool

		[ SP.fromAbsDir workingDir ++ "node_modules/wasp-ts-sdk/dist/run.js",
		SP.fromAbsDir workingDir ++ ".wasp/config/main.wasp.mjs"

Small fixes in the generator #2269

Small fixes in the generator #2269

Conversation

sodic commented Sep 6, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

sodic Sep 9, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Martinsos Sep 15, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Martinsos commented Sep 6, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

sodic Sep 9, 2024 •

edited

Loading

Martinsos Sep 15, 2024 •

edited

Loading