fix(client, generator): Fix TS issues with generated client and add tests #1117
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
Closed
msfstef
force-pushed
the
msfstef/fix-generator-ts-errors
branch
from
c3ca593
to
005af03
Compare
kevin-dp
approved these changes
Apr 3, 2024
clients/typescript/test/cli/migrations/migrate.generation.test.ts
Outdated
Show resolved
Hide resolved
clients/typescript/test/cli/migrations/migrate.generation.test.ts
Outdated
Show resolved
Hide resolved
clients/typescript/test/cli/migrations/migrate.generation.test.ts
Outdated
Show resolved
Hide resolved
clients/typescript/test/cli/migrations/migrate.generation.test.ts
Outdated
Show resolved
Hide resolved
clients/typescript/test/cli/migrations/migrate.generation.test.ts
Outdated
Show resolved
Hide resolved
generator/test/functions/writeSingleFileImportStatements.test.ts
Outdated
Show resolved
Hide resolved
kevin-dp
approved these changes
Apr 3, 2024
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.
Relevant issues: #1001 #925 #1114
Only one thing is fixed in this PR, the
Relationis no longer imported if the data model has no relations in order to avoidunused importsTS errors.Main changes are moving all of the generator tests into their own test directory rather than inside the source code, for consistency with the TS client, ease of use, and improved reusability of test utilities.
I've also added a sort of integration test for the CLI generation step, which is crucial to getting a working, compileable TS client as it modifies some of the Prisma generated typings. This test generates the client given a Prisma schema and performs all appropriate modifications to it, and then attempts to compile it with TS and specified compiler options.
Also found that with TS version >=5.4 we have stricter conditional type checking which breaks clients generated with Prisma versions earlier than 4.16.0 (see issue #1114), however 4.16.0 introduces breaking changes with the "extensions" feature, so I've added a hacky workaround for it:
https://github.com/electric-sql/electric/pull/1117/files#diff-fb0a50df4fc86f09b81a210162984d7822276fe19c8ae6496cf5ffe7d09f5adb
We can add more tests that would test various compiler options, making it easier to avoid regressions when users report them with more complicated schemas and TS compiler options.
Finally, I've added a Caution banner in our Usage section in the docs about requiring TS
strictmode, since Zod has that as a requirement as well and its the reason why we see some inconsistencies in bug reports.