Skip to content

fix(sdk): exclude prisma module from barrel file to avoid eager loading of prisma packages #1255

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 3 commits into from
Apr 14, 2024
Merged

fix(sdk): exclude prisma module from barrel file to avoid eager loading of prisma packages #1255

merged 3 commits into from
Apr 14, 2024

Conversation

ymc9
Copy link
Member

@ymc9 ymc9 commented Apr 14, 2024 •
edited by coderabbitai bot
Loading

  • Solves the problem that launching language server triggers loading "@prisma/internals"
  • Removes several old logic for detecting Prisma versions

Summary by CodeRabbit

  • Refactor
    • Streamlined import paths and reorganized imports for improved clarity and maintainability.
  • Documentation
    • Updated internal documentation to align with new import paths and module restructuring.
  • Chores
    • Enhanced SDK's package.json with explicit export mappings for better module resolution and usage.
  • New Features
    • Exported the DMMF type from @prisma/generator-helper.

@ymc9
fix(sdk): exclude prisma module from barrel file to avoid eager loadi…
ea227cb 
…ng of prisma packages

- Solves the problem that launching language server triggers loading "@prisma/internals"
- Removes several old logic for detecting Prisma versions
@coderabbitai coderabbitai
Copy link
Contributor

coderabbitai bot commented Apr 14, 2024 •
edited
Loading

Walkthrough

Walkthrough

The recent updates primarily involve reorganizing the import paths for DMMF and related utilities across various modules within the @zenstackhq/sdk. This restructuring indicates a consolidation of Prisma-related functionalities into a specific sub-module (@zenstackhq/sdk/prisma). Changes also include the removal of redundant imports and adjustments in logic handling based on the Prisma version, reflecting a cleaner and more structured approach to managing dependencies and functionalities.

Changes

Files Change Summary
.../openapi/src/generator-base.ts
.../openapi/src/rest-generator.ts
.../openapi/src/rpc-generator.ts
.../trpc/src/generator.ts
.../trpc/src/helpers.ts
.../cli/plugin-runner.ts
.../plugins/enhancer/enhance/index.ts
.../plugins/enhancer/policy/policy-guard-generator.ts
.../plugins/prisma/index.ts
.../plugins/zod/generator.ts
.../plugins/zod/transformer.ts
.../plugins/zod/types.ts
.../telemetry.ts
.../tests/generator/prisma-builder.test.ts
.../tests/generator/prisma-generator.test.ts
.../sdk/src/dmmf-helpers/...
.../testtools/src/schema.ts		 Updated import paths for DMMF, getPrismaClientImportSpec, and other related imports from @zenstackhq/sdk to @zenstackhq/sdk/prisma. Simplified logic related to Prisma version handling.
.../plugins/swr/src/generator.ts
.../plugins/tanstack-query/src/generator.ts		 Removed getPrismaVersion and semver imports. Adjusted import statements for DMMF and streamlined Prisma version logic in generateModelHooks.
.../plugins/prisma/schema-generator.ts Updated import for getPrismaVersion and modified logic for handling previewFeatures based on the Prisma version.
.../sdk/package.json Added explicit export mappings for various modules indicating a restructured approach to module exports within the SDK.
.../sdk/src/index.ts
.../sdk/src/prisma.ts
.../sdk/src/types.ts		 Reorganized exports related to DMMF and Prisma functionalities, consolidating exports in prisma.ts and cleaning up index.ts and types.ts.

This table summarizes the key changes across multiple files, highlighting the consolidation and reorganization of import paths and functionalities related to Prisma within the @zenstackhq/sdk package.

Recent Review Details

Configuration used: CodeRabbit UI

Commits Files that changed from the base of the PR and between 84daa32 and 50e8c17.
Files selected for processing (1)
  • packages/schema/src/plugins/zod/transformer.ts (3 hunks)
Files skipped from review as they are similar to previous changes (1)
  • packages/schema/src/plugins/zod/transformer.ts

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share
Tips

Chat

There are 3 ways to chat with CodeRabbit:

Note: Auto-reply has been disabled for this repository by the repository owner. The CodeRabbit bot will not respond to your replies unless it is explicitly tagged.

  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

coderabbitai[bot]
coderabbitai bot reviewed Apr 14, 2024
View reviewed changes
Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 1

@ymc9 ymc9 merged commit c37bf92 into v2 Apr 14, 2024
@ymc9 ymc9 deleted the fix/prisma-internals-deps branch April 14, 2024 14:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@coderabbitai coderabbitai[bot] coderabbitai[bot] approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
1 participant
@ymc9