Skip to content

chore: add test for error when calling getData() on an in-memory request#1551

Draft
MantisClone wants to merge 11 commits intomasterfrom
add-in-memory-get-data-test
Draft

chore: add test for error when calling getData() on an in-memory request#1551
MantisClone wants to merge 11 commits intomasterfrom
add-in-memory-get-data-test

Conversation

@MantisClone
Copy link
Member

@MantisClone MantisClone commented Jan 17, 2025 •
edited by coderabbitai bot
Loading

Motivation

The In-Memory Request docs mentioned that we cannot call getData() on an In-memory request and I wanted to write a test to prove this is true.

Changes

  • chore: add test for error when calling getData() on an in-memory request

Summary by CodeRabbit

  • Tests
    • Enhanced test coverage for RequestNetwork functionality
    • Added a new test case to verify getData method behavior with skipPersistence option

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Jan 17, 2025 •
edited
Loading

Important

Review skipped

Draft detected.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Walkthrough

The pull request modifies the in-memory-request.test.ts test file by adding new import statements for EventEmitter and ClientTypes. A new test case is introduced to verify the getData method's behavior when a request is created with the skipPersistence option set to true. The test ensures that the method returns an empty EventEmitter object typed as ClientTypes.IRequestDataWithEvents. The existing test suite's structure and core logic remain unchanged.

Changes

File Change Summary
packages/request-client.js/test/in-memory-request.test.ts - Added import for EventEmitter from 'events' module
- Added import for ClientTypes from '@requestnetwork/types'
- Introduced new test case for getData method with skipPersistence option

Suggested Reviewers

  • leoslr
  • yomarion
  • sstefdev
  • alexandre-abrioux
  • rodrigopavezi

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.

@MantisClone
fix: remove unnecessary assertions
3e1efec
@MantisClone
fix: error message
2def6ef
@MantisClone
fix: remove await because getData() is not async
cf2c2d6
@MantisClone
fix: remove rejects because getData() doesn't return a promise
d43e5d1
@MantisClone
fix: test
d27d33c
@MantisClone
fix: test per error output
b075b54 
* expect(received).toBe(expected) // Object.is equality
  If it should pass with deep equality, replace "toBe" with "toStrictEqual"
  Expected: {"_events": {}, "_eventsCount": 0, "_maxListeners": undefined, Symbol(kCapture): false}
  Received: serializes to the same string
@MantisClone
refactor: cleanup
7156a98
@MantisClone MantisClone marked this pull request as ready for review January 18, 2025 21:10
@MantisClone MantisClone requested review from rodrigopavezi and removed request for kevindavee and yomarion January 18, 2025 21:10
@MantisClone MantisClone self-assigned this Jan 18, 2025
@MantisClone MantisClone linked an issue Jan 18, 2025 that may be closed by this pull request
"In-memory Request" "Pay before Persist" Documentation Guide RequestNetwork/docs.request.network#74
Closed
@MantisClone MantisClone mentioned this pull request Jan 18, 2025
Closed
@MantisClone MantisClone marked this pull request as draft January 23, 2025 12:34
@MantisClone MantisClone linked an issue Jan 23, 2025 that may be closed by this pull request
Fix request.getData() to return inMemoryInfo.requestData when called on an in-memory request #1557
Open
@MantisClone
Copy link
Member Author

MantisClone commented Jan 23, 2025

We discussed this and created a new issue to fix it.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@aimensahnoun aimensahnoun Awaiting requested review from aimensahnoun

@sstefdev sstefdev Awaiting requested review from sstefdev

@rodrigopavezi rodrigopavezi Awaiting requested review from rodrigopavezi

At least 2 approving reviews are required to merge this pull request.

Assignees

@MantisClone MantisClone

Labels

None yet

Projects

None yet

Milestone

No milestone

1 participant

@MantisClone