[WIP] Scaffolding of various features #1453

infomiho · 2023-09-26T10:01:20Z

Working on:

Tailwind CSS scaffolding
Auth scaffolding
Email sender scaffolding

Biggest issues atm:

the DX is not where we want it to be
- we are prompting the user to edit the Wasp file by hand instead of doing it automatically
- the blocker for automatic editing is figuring out the best way to edit Wasp's AST and pretty print it

Signed-off-by: Mihovil Ilakovac <mihovil@ilakovac.com>

Martinsos

@infomiho this looks quite good to me!
Most of the comments are on extracting the logic.

I like the general structure and think it makes sense.

One thing that is not great is that we are repeating here quite a few stuff from Wasp -> this will be something we need to maintain separately, as compiler doesn't catch most of the stuff. It could catch quite more, but we are not there yet / it would require more effort. So it is a thing to keep updated, same like docs. But ok.

The fact that we are not updating main.wasp file -> yop that sucks a bit, but I think this is already valuable as the first version and we can leave that for later, since we said that is not as simple and would require quite more effort. I think this is already useful as it is.

Martinsos · 2023-10-09T14:08:59Z

waspc/cli/src/Wasp/Cli/Command/Call.hs

@@ -20,6 +20,7 @@ data Call
  | WaspLS
  | Deploy Arguments -- deploy cmd passthrough args
  | Test Arguments -- "client" | "server", then test cmd passthrough args
+  | UseRecipe Arguments -- pass through args


What are the pass through args here, why would I want to pass them through?

Martinsos · 2023-10-09T14:10:15Z

waspc/cli/src/Wasp/Cli/Command/UseRecipe.hs

+  showOption = show
+  showOptionDescription = Just . recipeDescription
+
+useRecipe :: [String] -> Command ()


If there are no args, I would just remove _args argument for now.

Martinsos · 2023-10-09T14:11:08Z

waspc/cli/src/Wasp/Cli/Command/UseRecipe/Auth.hs

+import qualified Wasp.Cli.Interactive as Interactive
+import qualified Wasp.Message as Msg
+
+data AuthMethod = Email | UsernameAndPassword | Google | Github


Are we replicating knowledge from AppSpec here? This is duplication, why not directly use the ADT from AppSpec?

If reason is that you wanted to be able to define Show and Interactive.Option instances for it, then you are better of doing newtype AuthMethodRecipe = AuthMethodRecipe AppSpec.Auth.AuthMethod -> wrapping the AppSpec ADT into a newtype that you will use here and write instances for it.

Martinsos · 2023-10-09T14:12:03Z

waspc/cli/src/Wasp/Cli/Command/UseRecipe/Auth.hs

@@ -0,0 +1,52 @@
+{-# LANGUAGE InstanceSigs #-}


Aha, you like having signature in the instance? I understand that, I also like them but I never pull the trigger on importing this extension hm, not sure why. Sounds good though.

Martinsos · 2023-10-09T14:15:47Z

waspc/cli/src/Wasp/Cli/Command/UseRecipe/Auth/Common.hs

+  let authTargetDir = waspProjectDir </> [reldir|src/client/auth|]
+  return authTargetDir


Suggested change

let authTargetDir = waspProjectDir </> [reldir|src/client/auth|]

return authTargetDir

return $ waspProjectDir </> [reldir|src/client/auth|]

Martinsos · 2023-10-09T14:30:45Z

waspc/cli/src/Wasp/Cli/Command/UseRecipe/EmailSender.hs

+import qualified Wasp.Message as Msg
+import qualified Wasp.Util.Terminal as Term
+
+data EmailProvider = SMTP | SendGrid | Mailgun


Also, consider using what we already have in AppSpec instead of repeating it here.

Martinsos · 2023-10-09T14:36:09Z

waspc/cli/src/Wasp/Cli/Command/UseRecipe/EmailSender.hs

+    useProvider SMTP = useEmailProvider "SMTP" ["SMTP_HOST", "SMTP_PORT", "SMTP_USERNAME", "SMTP_PASSWORD"]
+    useProvider SendGrid = useEmailProvider "SendGrid" ["SENDGRID_API_KEY"]
+    useProvider Mailgun = useEmailProvider "Mailgun" ["MAILGUN_API_KEY", "MAILGUN_DOMAIN"]


Would be great if this was not the only place where we have these env values encoded, but instead it was somewhere else and then we just used it here. Since it sounds like a pretty central concept.

It is the question of knowledge -> where should this knowledge be centralized?

Martinsos · 2023-10-09T14:51:16Z

waspc/cli/src/Wasp/Cli/Command/UseRecipe/EmailSender.hs

+joinForSentence :: [String] -> String
+joinForSentence [] = ""
+joinForSentence [x] = x
+joinForSentence [x, y] = x <> " and " <> y
+joinForSentence (x : xs) = x <> ", " <> joinForSentence xs


Martinsos · 2023-10-09T14:51:37Z

waspc/cli/src/Wasp/Cli/Command/UseRecipe/Tailwind.hs

+  cliSendMessageC $
+    Msg.Info $
+      unlines
+        [ "Make sure the following to your Main.css file:",


Some word missing here.

Martinsos · 2023-10-09T15:02:01Z

waspc/cli/src/Wasp/Cli/Interactive.hs

@@ -96,6 +104,12 @@ askToChoose question options = do
          Just description -> "\n" <> replicate indentLength ' ' <> description
          Nothing -> ""

+    renderDefaultOption :: o -> String


A bit wild that it renders "" if there is no default option, as I would expect it to render default option.
I think it would be better if it returned Maybe String, so it returns Nothing if there is no default option?

infomiho added 3 commits September 20, 2023 19:56

WIP: recipes

3e95782

Signed-off-by: Mihovil Ilakovac <mihovil@ilakovac.com>

Adds WIP Tailwind and Auth recipes

e58f4ec

Adds Auth and Email Sender recipes

bd9c094

Signed-off-by: Mihovil Ilakovac <mihovil@ilakovac.com>

infomiho marked this pull request as ready for review September 27, 2023 13:42

Martinsos reviewed Oct 9, 2023

View reviewed changes

Martinsos force-pushed the main branch from 9cbc333 to 799ff1d Compare October 12, 2023 12:32

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[WIP] Scaffolding of various features #1453

[WIP] Scaffolding of various features #1453

infomiho commented Sep 26, 2023 •

edited

Martinsos left a comment

Martinsos Oct 9, 2023

Martinsos Oct 9, 2023

Martinsos Oct 9, 2023

Martinsos Oct 9, 2023

Martinsos Oct 9, 2023

Martinsos Oct 9, 2023

Martinsos Oct 9, 2023

Martinsos Oct 9, 2023

Martinsos Oct 9, 2023

Martinsos Oct 9, 2023

		let authTargetDir = waspProjectDir </> [reldir\|src/client/auth\|]
		return authTargetDir

	let authTargetDir = waspProjectDir </> [reldir\|src/client/auth\|]
	return authTargetDir
	return $ waspProjectDir </> [reldir\|src/client/auth\|]

[WIP] Scaffolding of various features #1453

Are you sure you want to change the base?

[WIP] Scaffolding of various features #1453

Conversation

infomiho commented Sep 26, 2023 • edited

Martinsos left a 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

Choose a reason for hiding this comment

Choose a reason for hiding this comment

infomiho commented Sep 26, 2023 •

edited