feat(enhance): Prisma Pulse support #1658
Conversation
WalkthroughWalkthroughThe code changes involve significant modifications to several classes and methods related to data handling and processing logic in a Prisma-based application. Key updates include the introduction of a new streaming capability, enhancements to the existing subscription methods, and refinements to authorization logic. Additionally, new tests have been implemented to validate policy enforcement and data integrity across various scenarios. Changes
Sequence Diagram(s)sequenceDiagram
participant User
participant PrismaProxyHandler
participant OmitHandler
participant PolicyProxyHandler
participant DbOperations
User->>PrismaProxyHandler: Call stream(args)
PrismaProxyHandler->>PolicyProxyHandler: handleSubscribeStream('stream', args)
PolicyProxyHandler->>OmitHandler: processResultEntity(method, data)
OmitHandler-->>PolicyProxyHandler: Return processed data
PolicyProxyHandler-->>PrismaProxyHandler: Return subscription data
PrismaProxyHandler-->>User: Return results
Assessment against linked issues
Possibly related issues
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? TipsChatThere are 3 ways to chat with CodeRabbit:
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)
Additionally, you can add CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (7)
- packages/runtime/src/enhancements/omit.ts (1 hunks)
- packages/runtime/src/enhancements/policy/handler.ts (1 hunks)
- packages/runtime/src/enhancements/policy/policy-utils.ts (1 hunks)
- packages/runtime/src/enhancements/proxy.ts (4 hunks)
- packages/runtime/src/types.ts (1 hunks)
- packages/testtools/src/schema.ts (3 hunks)
- tests/integration/tests/enhancements/with-policy/prisma-pulse.test.ts (1 hunks)
Additional comments not posted (15)
packages/runtime/src/types.ts (1)
26-26: Addition ofstreammethod is appropriate.The introduction of the
streammethod in theDbOperationsinterface is consistent with the existing method signatures and aligns with the PR objectives.packages/runtime/src/enhancements/omit.ts (1)
29-60: Enhanced handling ofsubscribeandstreammethods is effective.The changes to the
processResultEntitymethod improve its ability to handle different data processing scenarios based on themethodparameter. This enhances the functionality and control flow.packages/runtime/src/enhancements/proxy.ts (2)
58-58: Addition ofstreammethod toPrismaProxyHandleris appropriate.The introduction of the
streammethod enhances the interface's functionality and aligns with the PR objectives.
169-190: Implementation ofdoSubscribeStreammethod is well-structured.The
doSubscribeStreammethod effectively handles both subscription and streaming, ensuring proper processing of iteration results.packages/testtools/src/schema.ts (2)
240-240: Caution: Potential data loss with--accept-data-loss.The addition of
--accept-data-lossin theprisma db pushcommand allows for data loss during the operation. Ensure that this is intentional and properly documented to avoid unintended consequences.
392-395: LGTM: Dynamic module loading withloadModule.The
loadModulefunction enhances modularity by dynamically resolving module paths. This approach improves error handling and path resolution.tests/integration/tests/enhancements/with-policy/prisma-pulse.test.ts (6)
20-77: LGTM: Comprehensive authorization check test.The test case effectively verifies authorization checks for the
streamAPI, covering both anonymous and authenticated user scenarios.
79-132: LGTM: Thorough model-level policy test.The test case effectively validates model-level policies using the
streamAPI, ensuring policy enforcement based on model attributes.
134-187: LGTM: Effective partial subscription test.The test case successfully validates the partial subscription functionality of the
streamAPI.
189-257: LGTM: Comprehensive policy and filter combination test.The test case thoroughly evaluates the interaction between policies and user-provided filters using the
streamAPI.
259-309: LGTM: Field-level policy enforcement test.The test case effectively validates field-level policy enforcement using the
streamAPI.
311-364: LGTM:@omitdirective test.The test case successfully verifies the functionality of the
@omitdirective using thestreamAPI.packages/runtime/src/enhancements/policy/policy-utils.ts (1)
598-598: LGTM! Explicitly settingargs.whereto false enhances clarity.The change ensures that no records are returned when authorization fails, improving the robustness of the authorization logic.
packages/runtime/src/enhancements/policy/handler.ts (2)
1542-1543: Refactoredsubscribemethod looks good.The refactoring to use
handleSubscribeStreamimproves maintainability by centralizing logic.
1546-1547: Refactoredstreammethod looks good.The refactoring to use
handleSubscribeStreamimproves maintainability by centralizing logic.
Fixes #1473