Skip to content

Conversation

@wa0x6e
Copy link
Contributor

@wa0x6e wa0x6e commented Aug 8, 2024

Fix failing starknet E2E tests, due to the account name associated to the address being updated

Summary by CodeRabbit

  • Bug Fixes
    • Updated expected responses in API tests for consistency in capitalization of the string "Checkpoint."
    • Ensured that test assertions align with the current specifications of the API response format.

@coderabbitai
Copy link

coderabbitai bot commented Aug 8, 2024

Walkthrough

The recent changes involve updates to the expected outputs in the end-to-end (E2E) API tests. Specifically, the string values for two hexadecimal keys have been standardized from 'checkpoint.stark' to 'Checkpoint', ensuring consistent capitalization. This adjustment clarifies the test assertions to align with the anticipated API response format, while the overall test logic remains unchanged.

Changes

Files Change Summary
test/e2e/api.test.ts Updated expected responses for two hexadecimal keys from 'checkpoint.stark' to 'Checkpoint', enhancing consistency in capitalization.

Sequence Diagram(s)

sequenceDiagram
    participant Client
    participant API
    participant TestSuite

    Client->>API: Request data
    API-->>Client: Return data with keys
    TestSuite->>TestSuite: Validate response
    TestSuite->>Client: Confirm expected output matches actual response
Loading

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>.
    • 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 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.
    • @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 as 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 resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

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

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.

@wa0x6e wa0x6e marked this pull request as ready for review August 8, 2024 08:20
@wa0x6e wa0x6e requested review from ChaituVR and mktcode August 8, 2024 08:20
Copy link

@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: 0

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 3c00957 and e5d6e70.

Files selected for processing (1)
  • test/e2e/api.test.ts (2 hunks)
Additional comments not posted (2)
test/e2e/api.test.ts (2)

103-104: LGTM! Consistent capitalization update.

The change to 'Checkpoint' ensures consistency with the updated API response format.


121-122: LGTM! Consistent capitalization update.

The change to 'Checkpoint' ensures consistency with the updated API response format.

@wa0x6e
Copy link
Contributor Author

wa0x6e commented Aug 8, 2024

Actionable comments posted: 0

Review details
Configuration used: CodeRabbit UI Review profile: CHILL

Commits
Files selected for processing (1)
Additional comments not posted (2)

Unless starknet require all username to be capitalized (which seems doubtful), this bot is just spouting nonsense

@mktcode
Copy link
Contributor

mktcode commented Aug 8, 2024

this bot is just spouting nonsense

There have been occasions where it made good suggestions but I'd certainly switch a few things off and make them opt-in. This PR moves the config to the repo but I closed most of my PRs to remove noise and focus only on what's urgent for a release.

@mktcode mktcode removed their request for review August 8, 2024 08:40
@wa0x6e wa0x6e requested a review from mktcode August 8, 2024 11:32
Copy link
Contributor

@mktcode mktcode left a comment

Choose a reason for hiding this comment

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

I approve these changes, but this is a good example for the type of PRs I'd merge without approval. It's a purely formal step that doesn't serve its original purpose. I didn't fix the test myself because I wasn't sure what the new correct value is, and I still didn't look that up. @wa0x6e seems to have figured that out and fixed the test correctly. If I had submitted this PR, then @wa0x6e would now approve and merge it. And what's the consequence of a late approval? Currently all other changes are also blocked by these failing tests, even though it's just a small thing. It must be done. What exactly am I supposed to approve here? Should we delete the tests instead? Should I just approve or merge too? Idk.

In cases where the changes:

  • contain only very obvious fixes or improvements
  • don't go much beyond the complexity of this example
  • don't change any behavior (as that mostly needs to be discussed)

I'd open the PR, to send everyone a notification, and then turn it purple right away.

On the other hand, I believe reviews of important feature PRs profit from more extensive discussion and preparation upfront. This is where I'd dogmatically implement a process that ensures ideas have been properly evaluated and technically explored to a degree, that implementation can actually start and in a way others can understand, especially in an open source context where you ideally want external contributors to just pick up work and get it done. For me that doesn't work if I have to come back to a title + one sentence issue after ten minutes of exploring the thing and then wait 3 hours (or forever) for clarification.

I know there's just not much time for this project right now and I simply have too much. But I hope such thoughts will be considered once one or two more devs work on this more regularly, at least if I'm then one of them.

@wa0x6e wa0x6e merged commit 2f34cba into master Aug 9, 2024
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.

3 participants