Skip to content
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.

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

chore(request-client): expose NoPersistHttpDataAccess #1540

Closed
wants to merge 1 commit into from

Conversation

kevindavee
Copy link
Contributor

@kevindavee kevindavee commented Jan 6, 2025

Description of the changes

There is no way to use NoPersistHttpDataAccess without using the RequestNetwork class. If we want to inject NoPersistHttpDataAccess, we can't use it with RequestNetworkBase.

Example: I want to use my own custom data access or NoPersistHttpDataAccess depending on my use case.

  • If I use RequestNetwork, there's no way to inject my own custom data access.
  • If I use RequestNetworkBase, there's no option to use skipPersistence which uses NoPersistHttpDataAccess.

By exporting NoPersistHttpDataAccess, I can manage which Data Access I want to use (Custom/NoPersist) and inject it by myself to RequestNetworkBase.

Summary by CodeRabbit

  • New Features
    • Introduced a new data access method for handling HTTP requests without persistent storage.

Copy link
Contributor

coderabbitai bot commented Jan 6, 2025

Walkthrough

The pull request introduces a new import and export of NoPersistHttpDataAccess in the packages/request-client.js/src/index.ts file. This change adds a new entity to the module's public interface, allowing external code to access and use the NoPersistHttpDataAccess class or type from this package.

Changes

File Change Summary
packages/request-client.js/src/index.ts Added import and export of NoPersistHttpDataAccess from ./no-persist-http-data-access module

Note: No sequence diagram is generated as the changes are minimal and do not involve complex interactions or new functionality.


📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between a6ddcae and 1a55c93.

📒 Files selected for processing (1)
  • packages/request-client.js/src/index.ts (2 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (1)
  • GitHub Check: build-and-test
🔇 Additional comments (2)
packages/request-client.js/src/index.ts (2)

10-10: Exposed NoPersistHttpDataAccess import looks good!
This import aligns perfectly with the PR's goal of allowing consumers to directly instantiate NoPersistHttpDataAccess.


23-23: Exporting NoPersistHttpDataAccess ensures broader accessibility.
Well done making this class part of the public API. To confirm that it’s properly used and documented, consider running the following to find any direct references and add usage details:
[approve]

✅ Verification successful

NoPersistHttpDataAccess is properly integrated and documented
The class is well-used throughout the codebase with proper type checking, error handling, and clear documentation explaining its role in skipping persistence. No issues found.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Searches the codebase for references to NoPersistHttpDataAccess to ensure consistent usage
rg -A 2 'NoPersistHttpDataAccess'

Length of output: 2796


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:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • 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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @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.
    • @coderabbitai help me debug CodeRabbit configuration file.

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 using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR. (Beta)
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration 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.

@alexandre-abrioux alexandre-abrioux dismissed their stale review January 6, 2025 09:02

will re-review again after having more context

@alexandre-abrioux alexandre-abrioux self-requested a review January 6, 2025 09:02
@MantisClone
Copy link
Member

I'll take a look at this. Please don't merge until I've wrapped my head around it.

@kevindavee
Copy link
Contributor Author

Well noted @MantisClone . But it looks like I'm going to submit another PR. Apparently, using NoPersistHttpDataAccess isn't possible for our use case

Copy link
Member

@MantisClone MantisClone left a comment

Choose a reason for hiding this comment

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

This change could be useful to other app builders who use RequestNetworkBase directly, and I'm in favor of merging it. Moreover, I think it matches the existing convention - The other DataAccess implementations are exported so NoPersistHttpDataAccess should be exported too.

@MantisClone
Copy link
Member

Well noted @MantisClone . But it looks like I'm going to submit another PR. Apparently, using NoPersistHttpDataAccess isn't possible for our use case

@kevindavee can you share why NoPersistHttpDataAccess doesn't fit the Request Finance use case? I'm eager to understand your needs.

@kevindavee
Copy link
Contributor Author

At Request Finance, we're using our own custom DataAccess. Whereas NoPersistHttpDataAccess inherits from HttpDataAccess and uses Request Node. What we need is to have the same logic as NoPersistHttpDataAccess but use our custom DataAccess @MantisClone

Copy link
Member

@alexandre-abrioux alexandre-abrioux left a comment

Choose a reason for hiding this comment

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

We discussed internally with @kevindavee and this one might not fit our needs because it only applies to the HttpDataAccess, whereas we need it a lever higher, at the DataAccess level. Dave has started working on a more generic solution in #1541

@MantisClone
Copy link
Member

Sounds good. Can we still merge this PR?

@kevindavee
Copy link
Contributor Author

Replaced by #1541

@kevindavee kevindavee closed this Jan 15, 2025
@kevindavee kevindavee deleted the chore/expose-no-persist-http-data-access branch January 15, 2025 05:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants