feat(world): add types for v2 config resolvers #2389

alvrs · 2024-03-07T14:08:26Z

No description provided.

changeset-bot · 2024-03-07T14:08:29Z

⚠️ No Changeset found

Latest commit: 781e02f

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

…o do this?)

alvrs · 2024-03-11T16:47:36Z

.eslintrc

+    "@typescript-eslint/ban-types": [
+      "error",
+      {
+        "extendDefaults": true,
+        "types": {
+          "{}": false,
+        },
+      },
+    ],


this is disabling the error when defining a type as "empty object" (= {})

can we add a comment here? I think eslintrc supports it and, if not, we could switch this to .eslintrc.js
https://eslint.org/docs/latest/use/configure/configuration-files#configuration-file-formats

alvrs · 2024-03-11T16:49:11Z

.vscode/settings.json

+{
+  "typescript.tsdk": "node_modules/typescript/lib"
+}


This makes sure vscode uses the repo version of ts instead of a different one in vscode. This is important because some of the type inference only works with the newer versions of typescript, so the dev experience would be much worse if there is accidentally an old version configured

we should add this to the templates too?

alvrs · 2024-03-11T16:59:27Z

packages/world/tsconfig.json

@@ -13,7 +13,8 @@
    "esModuleInterop": true,
    "forceConsistentCasingInFileNames": true,
    "strict": true,
-    "skipLibCheck": true
+    "skipLibCheck": true,
+    "noErrorTruncation": true


this makes increases the length of types before being truncated, which is useful for development

holic · 2024-03-11T18:09:48Z

packages/store/ts/config/v2/store.test.ts

+      enums: {},
+      namespace: "",
+    } as const;
+    attest<typeof expected>(config);


holic · 2024-03-11T18:11:08Z

packages/store/ts/config/v2/store.test.ts

+
+  it("should use the root namespace as default namespace", () => {
+    const config = resolveStoreConfig({ tables: { Example: {} } });
+    attest<"">(config.namespace);


should we have a test for when namespace is set?

also I thought namespaces were meant to be a world thing, not a store thing?

protocol wise yes, but tablegen also needs namespaces, so it feels fine to add it to the store config (so it can be part of the expected resolved table config)

holic · 2024-03-11T18:12:43Z

packages/store/ts/config/v2/store.ts

    : key extends "userTypes"
      ? UserTypes
      : key extends "enums"
        ? narrow<input[key]>
        : input[key];
 };

+export type resolveEnums<enums> = { [key in keyof enums]: Readonly<enums[key]> };


do we have a rule for when we use readonly keys vs not? (I don't see one here on enum keys, for example)

Should probably always be readonly. I think the test is passing in this case because of the const input parameter, so the incoming enum config is already readonly, which makes the enum object on the output readonly too. Will still add it here for consistency.

holic · 2024-03-11T18:13:19Z

packages/store/ts/config/v2/store.ts

 }>;

-export function resolveStoreConfig<input>(input: validateStoreConfig<input>): resolveStoreConfig<input> {
+export function resolveStoreConfig<const input>(input: validateStoreConfig<input>): resolveStoreConfig<input> {


does this make it so a regular object input gets used as if it were a const/strongly typed?

yes basically! https://xebia.com/blog/typescript-5-0-and-the-new-const-modifier-on-type-parameters/

holic · 2024-03-11T18:17:54Z

packages/world/ts/config/v2/world.test.ts

+      namespace: "",
+    } as const;
+
+    attest<typeof expected>(config);


the extra line break above is helpful for readability, wouldn't mind if all of these attest statements had this

holic · 2024-03-11T18:24:47Z

packages/world/ts/config/v2/world.test.ts

+            },
+            Second: {
+              schema: { secondKey: "address", secondName: "string", secondAge: "uint256" },
+              // @ts-expect-error Type '"firstKey"' is not assignable to type '"secondKey" | "secondAge"'


not at all blocking, but where this condition lives, do we have room to expand on/improve this error type?

like a branch that outputs one of the following:

firstKey field was not found in the schema
firstKey field is not a static ABI type

either of those feel more actionable to me than "this item is not one of this union of items", but I also haven't been working with these types a ton to say if this is actually better

this one is a native typescript error, it's probably possible to create a validator function that routes this condition to a custom string error, but would leave that for later

holic · 2024-03-11T18:29:07Z

packages/world/ts/config/v2/world.test.ts

+            Second: {
+              schema: { secondKey: "address", secondName: "string", secondAge: "uint256" },
+              // @ts-expect-error Type '"firstKey"' is not assignable to type '"secondKey" | "secondAge"'
+              primaryKey: ["firstKey", "secondAge"],


do we have/want/need any checks around "unique fields" defined here so we don't allow for ["firstKey", "firstKey"]?

Don't have it yet, unclear if it's possible at a type level, but will ask david about ideas. Maybe we can map the tuple to an object that has the tuple values as keys, then convert it back to a tuple and check the length? Would also keep this one for later though.

holic · 2024-03-11T18:31:23Z

packages/world/ts/config/v2/world.ts

+
+export type NamespacesInput = { [key: string]: NamespaceInput };
+
+export type NamespaceInput = Omit<StoreConfigInput, "userTypes" | "enums">;


do you think this will be annoying to maintain vs the inverse? Pick<StoreConfigInput, "tables">?

agree it might be nicer to explicitly pick the things we want there than adding a store config option and forgetting about it here

holic · 2024-03-11T18:34:11Z

packages/world/ts/config/v2/world.ts

+      ? {
+          readonly [key in namespacedTableKeys<input>]: key extends `${infer namespace}__${infer table}`
+            ? resolveTableConfig<
+                get<get<get<get<input, "namespaces">, namespace>, "tables">, table>,


yeah haha, there might be a prettier way to do this with some kind of deepGet type that takes a tuple of keys but i opted against it for the moment bc 1. don't have a deepGet type yet and 2. it might be the case that this manual nesting here takes better advantage of the typescript cache (can only really know that once we do some type benchmarking)

holic

looks great! mostly just questions/curiosities, nothing blocking

alvrs force-pushed the alvrs/world-config-v2 branch from 1d82bbe to 546cbec Compare March 7, 2024 14:09

vercel bot deployed to Preview March 7, 2024 14:12 View deployment

vercel bot deployed to Preview March 7, 2024 16:22 View deployment

vercel bot deployed to Preview March 7, 2024 19:03 View deployment

vercel bot deployed to Preview March 7, 2024 21:11 View deployment

vercel bot deployed to Preview March 7, 2024 21:20 View deployment

vercel bot deployed to Preview March 7, 2024 21:56 View deployment

vercel bot deployed to Preview March 7, 2024 22:58 View deployment

vercel bot deployed to Preview March 8, 2024 12:29 View deployment

vercel bot had a problem deploying to Preview March 8, 2024 12:34 Failure

vercel bot had a problem deploying to Preview March 8, 2024 12:40 Failure

vercel bot had a problem deploying to Preview March 8, 2024 12:58 Failure

vercel bot had a problem deploying to Preview March 8, 2024 13:09 Failure

vercel bot had a problem deploying to Preview March 11, 2024 12:36 Failure

vercel bot had a problem deploying to Preview March 11, 2024 12:52 Failure

vercel bot had a problem deploying to Preview March 11, 2024 12:55 Failure

vercel bot had a problem deploying to Preview March 11, 2024 13:32 Failure

vercel bot had a problem deploying to Preview March 11, 2024 16:07 Failure

vercel bot had a problem deploying to Preview March 11, 2024 16:24 Failure

alvrs and others added 10 commits March 11, 2024 16:35

world config is a wrapper for store config

3ca8a9c

add store config tests to world config (is there a more elegant way t…

2be3df5

…o do this?)

trying to extend store config in world config

2d4398a

nested primaryKey is not correctly narrowed

8f59396

conform instead of intersection

7b7e527

prefer homomorphic mapped type

b4db4ad

add const parameter, simplify some types, remove EmptyObject

bbd2358

update typescript

4ad3fbd

pretter, update eslint, disable useless eslint rule

f2ed610

properly resolve namespaced tables

16c10b1

cleanup

33c99ec

alvrs force-pushed the alvrs/world-config-v2 branch from 9db9060 to 33c99ec Compare March 11, 2024 16:39

vercel bot deployed to Preview March 11, 2024 16:41 View deployment

alvrs commented Mar 11, 2024

View reviewed changes

cleanup

d4ee4fe

alvrs commented Mar 11, 2024

View reviewed changes

alvrs changed the title ~~[WIP]: v2 world config type foundation~~ feat(world): v2 config types foundation Mar 11, 2024

vercel bot deployed to Preview March 11, 2024 17:00 View deployment

alvrs changed the title ~~feat(world): v2 config types foundation~~ feat(world): add types for v2 config resolvers Mar 11, 2024

alvrs marked this pull request as ready for review March 11, 2024 18:06

alvrs requested review from holic and yonadaa as code owners March 11, 2024 18:06

holic reviewed Mar 11, 2024

View reviewed changes

packages/store/ts/config/v2/store.test.ts

enums: {},

namespace: "",

} as const;

attest<typeof expected>(config);

Copy link

Member

holic Mar 11, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

beautiful

holic reviewed Mar 11, 2024

View reviewed changes

holic previously approved these changes Mar 11, 2024

View reviewed changes

review feedback

781e02f

alvrs dismissed holic’s stale review via 781e02f March 11, 2024 22:30

vercel bot deployed to Preview March 11, 2024 22:32 View deployment

alvrs merged commit 711f6e2 into main Mar 11, 2024
11 checks passed

alvrs deleted the alvrs/world-config-v2 branch March 11, 2024 22:43

alvrs mentioned this pull request Mar 13, 2024

feat(world): add config resolution at runtime #2421

Merged

holic mentioned this pull request Jul 21, 2024

add vscode settings to templates #2795

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(world): add types for v2 config resolvers #2389

feat(world): add types for v2 config resolvers #2389

alvrs commented Mar 7, 2024

changeset-bot bot commented Mar 7, 2024 •

edited

Loading

alvrs Mar 11, 2024

holic Mar 11, 2024

alvrs Mar 11, 2024

holic Mar 11, 2024

alvrs Mar 11, 2024

holic Mar 11, 2024

holic Mar 11, 2024

holic Mar 11, 2024

alvrs Mar 11, 2024

holic Mar 11, 2024 •

edited

Loading

alvrs Mar 11, 2024

holic Mar 11, 2024

alvrs Mar 11, 2024

holic Mar 11, 2024

holic Mar 11, 2024 •

edited

Loading

alvrs Mar 11, 2024

holic Mar 11, 2024

alvrs Mar 11, 2024

holic Mar 11, 2024

alvrs Mar 11, 2024

holic Mar 11, 2024

alvrs Mar 11, 2024

holic left a comment


		export type NamespacesInput = { [key: string]: NamespaceInput };

		export type NamespaceInput = Omit<StoreConfigInput, "userTypes" \| "enums">;

feat(world): add types for v2 config resolvers #2389

feat(world): add types for v2 config resolvers #2389

Conversation

alvrs commented Mar 7, 2024

changeset-bot bot commented Mar 7, 2024 • edited Loading

⚠️ No Changeset found

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

holic Mar 11, 2024 • edited Loading

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

holic Mar 11, 2024 • edited Loading

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

holic left a comment

Choose a reason for hiding this comment

changeset-bot bot commented Mar 7, 2024 •

edited

Loading

holic Mar 11, 2024 •

edited

Loading

holic Mar 11, 2024 •

edited

Loading