Add explicit $type property in code gen #2956
Open
+21,197
−12,673
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
matthieusieben
force-pushed
the
msi/lex-gen-typefixes
branch
4 times, most recently
from
f22ff9f to
005584a
Compare
matthieusieben
force-pushed
the
msi/lex-gen-typefixes
branch
6 times, most recently
from
f5707e0 to
3e52922
Compare
matthieusieben
commented
Nov 12, 2024
matthieusieben
force-pushed
the
msi/lex-gen-typefixes
branch
5 times, most recently
from
4677431 to
35acae1
Compare
matthieusieben
changed the title
matthieusieben
force-pushed
the
msi/lex-gen-typefixes
branch
from
35acae1 to
2cc15f3
Compare
matthieusieben
changed the base branch from
main
to
msi/lex-gen-optimization
matthieusieben
force-pushed
the
msi/lex-gen-typefixes
branch
from
2cc15f3 to
c71eccc
Compare
matthieusieben
force-pushed
the
msi/lex-gen-typefixes
branch
from
c71eccc to
1f8f816
Compare
matthieusieben
force-pushed
the
msi/lex-gen-optimization
branch
from
ef8af3f to
bebca0e
Compare
matthieusieben
force-pushed
the
msi/lex-gen-typefixes
branch
from
1f8f816 to
3784372
Compare
matthieusieben
force-pushed
the
msi/lex-gen-optimization
branch
from
bebca0e to
0bea135
Compare
matthieusieben
force-pushed
the
msi/lex-gen-typefixes
branch
2 times, most recently
from
66b3c0c to
6ae8660
Compare
matthieusieben
force-pushed
the
msi/lex-gen-typefixes
branch
from
fe5bb04 to
9117a3e
Compare
matthieusieben
changed the base branch from
msi/lex-gen-optimization
to
main
matthieusieben
force-pushed
the
msi/lex-gen-typefixes
branch
4 times, most recently
from
6bd421c to
f6f0ead
Compare
matthieusieben
changed the base branch from
main
to
msi/lex-gen-optimization
rafaelbsky
approved these changes
Nov 18, 2024
matthieusieben
force-pushed
the
msi/lex-gen-typefixes
branch
from
a484578 to
e3c766c
Compare
matthieusieben
commented
Dec 12, 2024
Comment on lines
+1116
to
+1120
| return this.recordEmbedWrapper( | ||
| { ...view, $type: 'app.bsky.feed.defs#generatorView' }, | ||
| withTypeTag, | ||
| ) |
There was a problem hiding this comment.
This is a good example of the benefit of this change. Before, because $type was optional, the type system did not force the $type property to be present in unions.
Now, because it is no longer optional in unions, not specifying the $type here results in a type error.
matthieusieben
commented
Dec 12, 2024
| @@ -2,7 +2,7 @@ | |||
| "$schema": "https://json.schemastore.org/tsconfig", | |||
| "extends": "./base.json", | |||
| "compilerOptions": { | |||
| "lib": ["ES2022", "DOM", "DOM.Iterable", "ESNext.Disposable"], | |||
| "lib": ["ES2023", "DOM", "DOM.Iterable", "ESNext.Disposable"], | |||
There was a problem hiding this comment.
NodeJS 18 (our minimal version) uses ES2023.
The api package already relies on ES2023 features (Array.findLast).
matthieusieben
force-pushed
the
msi/lex-gen-typefixes
branch
2 times, most recently
from
fa6f004 to
344ac6b
Compare
matthieusieben
changed the base branch from
msi/lex-gen-optimization
to
main
matthieusieben
force-pushed
the
msi/lex-gen-typefixes
branch
from
344ac6b to
f912407
Compare
matthieusieben
changed the base branch from
main
to
msi/lex-gen-optimization
matthieusieben
force-pushed
the
msi/lex-gen-typefixes
branch
3 times, most recently
from
2bbbdeb to
7ddbc91
Compare
matthieusieben
force-pushed
the
msi/lex-gen-optimization
branch
from
6e398be to
17b3081
Compare
matthieusieben
force-pushed
the
msi/lex-gen-typefixes
branch
from
7ddbc91 to
235b34d
Compare
matthieusieben
commented
Dec 18, 2024
| } | ||
| } else { | ||
| return { | ||
| $type: 'com.atproto.admin.defs#repoViewNotFound', | ||
| $type: 'tools.ozone.moderation.defs#repoViewNotFound', |
There was a problem hiding this comment.
com.atproto.admin.defs#repoViewNotFound does not exist.
This is a bug that was outlined by the type system thanks to the changes from this PR.
matthieusieben
changed the base branch from
msi/lex-gen-optimization
to
main
matthieusieben
force-pushed
the
msi/lex-gen-typefixes
branch
from
235b34d to
ba0dfe5
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Part of #2999
Fixes #2952
Breaking changes
This PR changes the interfaces of the generated code in the following ways:
[x: string]: unknonwindex signature in objects & records. Because of this, access to un-speccified fields must be explicit.$typeproperty explicit (though optional, except in open unions). This allows to properly discriminate entity types, especially when used in open unions.isMyType(value)utilities no longer type cast thevaluebeing checked. They only type the presence of the$typeproperty. UseisValidMyTypeto assert the type through validation.Note
Using
maininstead ofmsi/lex-gen-optimization(#2999) as "base branch" to allows CI to run.Note
While reviewing, "codegen" commits can be ignored ;-)