TS Config cleanup #2393

sodic · 2024-11-29T15:56:19Z

No description provided.

sodic · 2024-11-29T16:04:27Z

waspc/packages/wasp-config/src/run.ts

+type Result<Value, Error> =
+  | { status: 'ok'; value: Value }
+  | { status: 'error'; error: Error }


I'm using this for normal control flow errors (e.g., user forgets something).

I'm using exceptions for unexpected errors/compiler bugs. For example, an exception is thrown if waspc doesn't pass the correct arguments to this executable.

For the normal control flow, I am using the Result type instead of exceptions because:

The error users see is nicer (no stack trace)

They can slip through the type system.

Nice! If only there was a language that already used this kind of approach for errors/exceptions as a default :D!

sodic · 2024-12-02T21:10:31Z

waspc/packages/wasp-config/src/mapUserSpecToAppSpecDecls.ts

+function makeDeclsArray(decls: {
+  [Type in AppSpec.Decl['declType']]: AppSpec.GetDeclForType<Type>[]
+}): AppSpec.Decl[] {
+  return Object.values(decls).flatMap((decl) => [...decl])
+}

-  return decls
+function mapToDecls<T, const DeclType extends AppSpec.Decl['declType']>(
+  configs: Map<string, T>,
+  type: DeclType,
+  configToDeclValue: (
+    config: T
+  ) => AppSpec.GetDeclForType<DeclType>['declValue']
+) {
+  return [...configs].map(([name, config]) => ({
+    declType: type,
+    declName: name,
+    declValue: configToDeclValue(config),
+  }))


This might look too complex compared to what we had before (the for loops), but comes with many benefits:

No repetition

We don't repeat the same map iteration and Decl object construction a bunch of times. Plus, the code is shorter.

The entire decls array is built at once, without pushing

Because we're functional bros.

The compiler ensures we don't forget to include any declarations

This is the biggest benefit IMO, courtesy of the makeDeclsArray function.
For example, see what happens if we forget to include Crud:

So, when we add a new declaration, the compiler tells us what to implement.

The compiler ensures we don't mix anything up

mapToDecls ensures that the Decl returned by the mapping function matches the DeclType provided as the second argument, so we can't mix different Decl types and values (we had this before, but it's preserved):

sodic · 2024-12-03T22:49:36Z

waspc/packages/wasp-config/src/mapUserSpecToAppSpecDecls.ts

+  configToDeclValue: (
+    config: T
+  ) => AppSpec.GetDeclForType<DeclType>['declValue']
+) {


I can't specify a return type of this function because of some weird error, but I stopped digging into it.

If you're curious, here's the playground.

infomiho

LGTM

Some nice code improvements. Left some minor comments.

infomiho · 2024-12-10T12:42:26Z

waspc/packages/wasp-config/src/mapUserSpecToAppSpecDecls.ts

-      declValue: mapCrud(crudConfig, parseEntityRef),
-    })
-  }
+function makeDeclsArray(decls: {


infomiho · 2024-12-10T12:42:46Z

waspc/packages/wasp-config/src/mapUserSpecToAppSpecDecls.ts


-  return decls
+function mapToDecls<T, const DeclType extends AppSpec.Decl['declType']>(


What does const do here?

Nothing, it's a leftover I think. Nice catch.

infomiho · 2024-12-10T12:45:53Z

waspc/packages/wasp-config/src/mapUserSpecToAppSpecDecls.ts

-    ...(externalAuthEntity && {
-      externalAuthEntity: parseEntityRef(externalAuthEntity),
-    }),
+    externalAuthEntity:


For entities you did entities: entities && entities.map(parseEntityRef), why are you are explicitly checking for undefined?

Because it can technically be an empty string.

infomiho · 2024-12-10T12:49:25Z

waspc/packages/wasp-config/src/userApi.ts

@@ -7,13 +7,15 @@ export class App {
  #userSpec: UserSpec;

  // NOTE: Using a non-public symbol gives us a pacakge-private property.


Suggested change

// NOTE: Using a non-public symbol gives us a pacakge-private property.

// NOTE: Using a non-public symbol gives us a package-private property.

infomiho · 2024-12-10T12:51:57Z

waspc/src/Wasp/AppSpec.hs

@@ -58,6 +58,10 @@ import qualified Wasp.SemanticVersion as SV
 -- describing the web app specification with all the details needed to generate it.
 -- It is standalone and de-coupled from other parts of the compiler and knows nothing about them,
 -- instead other parts are using it: Analyzer produces AppSpec while Generator consumes it.
+--
+-- IMPORTANT: Do not change this data structure without updating the AppSpec in


I had this random 💩 idea, run a LLM on each commit if this files changed or the TS file changed. "Are these two things the same implementation?"

Hah that would be wild but it makes sense :D!

I guess we could also do somethign more deterministic, like collect checksums of AppSpec files form haskell side and compare with the checksum written in the .ts file. Or maybe have Haskell write out types of AppSpec and all types it uses, using sometihng like Generics, in a kind of a "snapshot" file like we use for e2e tests, probably during compile time using TH. Might get a lot of false positives hm but still.

infomiho · 2024-12-10T12:53:28Z

waspc/tools/install_packages_to_data_dir.sh

@@ -9,6 +9,9 @@ dir=$(CDPATH= cd -- "$(dirname -- "$0")" && pwd)
 for package in $(ls "$dir/../packages"); do
  package_dir="$dir/../packages/$package"
  if [[ -d "$package_dir" ]]; then
+    # We're only installing the dependencines here to verify that the build
+    # works, that's why the node_modules folder is removed immediately after.
+    # The real dependency installatino happens in Haskell.


Suggested change

# The real dependency installatino happens in Haskell.

# The real dependency installation happens in Haskell.

Martinsos

@sodic nice stuff and looks good! I didn't dive into some details, but I did a high-level review and looked at some parts I remember us discussing. Left a couple of small comments, all minor.

waspc/cli/src/Wasp/Cli/Command/CreateNewProject/StarterTemplates/Templating.hs

waspc/packages/wasp-config/src/appSpec.ts

Martinsos · 2024-12-12T13:03:55Z

waspc/src/Wasp/AppSpec.hs

@@ -58,6 +58,10 @@ import qualified Wasp.SemanticVersion as SV
 -- describing the web app specification with all the details needed to generate it.
 -- It is standalone and de-coupled from other parts of the compiler and knows nothing about them,
 -- instead other parts are using it: Analyzer produces AppSpec while Generator consumes it.
+--
+-- IMPORTANT: Do not change this data structure without updating the AppSpec in


Hah that would be wild but it makes sense :D!

I guess we could also do somethign more deterministic, like collect checksums of AppSpec files form haskell side and compare with the checksum written in the .ts file. Or maybe have Haskell write out types of AppSpec and all types it uses, using sometihng like Generics, in a kind of a "snapshot" file like we use for e2e tests, probably during compile time using TH. Might get a lot of false positives hm but still.

waspc/tools/install_packages_to_data_dir.sh

sodic added 2 commits November 28, 2024 17:51

Clean up Wasp ts config files

02a6639

Add more refactors to the TS SDK

f4e3188

sodic commented Nov 29, 2024

View reviewed changes

sodic mentioned this pull request Nov 29, 2024

TS SDK Setup #2299

Merged

sodic added 2 commits December 2, 2024 21:45

Add even more refactors to the TS SDK

01038ec

Turn Decl in appSpec.ts into a generic

3584c24

sodic commented Dec 2, 2024

View reviewed changes

sodic commented Dec 3, 2024

View reviewed changes

sodic marked this pull request as ready for review December 9, 2024 15:30

Replace case with fromMaybe

e8badd2

infomiho approved these changes Dec 10, 2024

View reviewed changes

Martinsos approved these changes Dec 12, 2024

View reviewed changes

Address PR comments

ae52cd2

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

TS Config cleanup #2393

TS Config cleanup #2393

sodic commented Nov 29, 2024

sodic Nov 29, 2024

Martinsos Dec 12, 2024 •

edited

Loading

sodic Dec 2, 2024 •

edited

Loading

sodic Dec 3, 2024

infomiho left a comment

infomiho Dec 10, 2024

infomiho Dec 10, 2024

sodic Dec 10, 2024

infomiho Dec 10, 2024

sodic Dec 20, 2024

infomiho Dec 10, 2024

infomiho Dec 10, 2024

Martinsos Dec 12, 2024

infomiho Dec 10, 2024

Martinsos left a comment

Martinsos Dec 12, 2024


		return decls
		function mapToDecls<T, const DeclType extends AppSpec.Decl['declType']>(

		@@ -7,13 +7,15 @@ export class App {
		#userSpec: UserSpec;

		// NOTE: Using a non-public symbol gives us a pacakge-private property.

	# The real dependency installatino happens in Haskell.
	# The real dependency installation happens in Haskell.

TS Config cleanup #2393

Are you sure you want to change the base?

TS Config cleanup #2393

Conversation

sodic commented Nov 29, 2024

Choose a reason for hiding this comment

Martinsos Dec 12, 2024 • edited Loading

Choose a reason for hiding this comment

sodic Dec 2, 2024 • edited Loading

Choose a reason for hiding this comment

No repetition

The entire decls array is built at once, without pushing

The compiler ensures we don't forget to include any declarations

The compiler ensures we don't mix anything up

Choose a reason for hiding this comment

infomiho 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

Martinsos left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Martinsos Dec 12, 2024 •

edited

Loading

sodic Dec 2, 2024 •

edited

Loading

The entire `decls` array is built at once, without pushing