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

refactor: remove combined asset model, closes #48 #5378

Closed
wants to merge 1 commit into from

Conversation

fbwoolf
Copy link
Contributor

@fbwoolf fbwoolf commented May 16, 2024

Try out Leather build 1d821b9Extension build, Test report, Storybook, Chromatic

Opening this as a draft @kyranjamie for feedback here on removing the combined asset model. I've refactored to use the balance and info models separately, except for I did use an AssetItem type just to help pass some data around the asset list components specifically, but that could be removed and the data can still be passed separately. Here, the loader just passes data to the lists ...and there are few send forms using the loader pattern. I do think the loader pattern works well, but we could organize our use of it a bit better.

I created a isFetchedWithSuccess function in our query-config after researching some suggestions on how to handle the react-query undefined issue, I used it in a few spots that seemed to work well.

I also started using the word token here more often just bc it is commonly used in our code already, but happy to go back to asset if people prefer it?

More to do, but wanted to get feedback before continuing. I could never get the react-router loader pattern to work bc their suggestion on how to handle typescript didn't work for me ...I still got undefined, but I can try to work on it again. I was admittedly testing a few ideas out and the error might have been on my end!

Copy link

coderabbitai bot commented May 16, 2024

Important

Auto 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.


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.

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.

@fbwoolf fbwoolf force-pushed the refactor/remove-combined-asset-model branch from 3901aea to 1d821b9 Compare May 16, 2024 21:11
@fbwoolf fbwoolf requested a review from kyranjamie May 16, 2024 21:11
@fbwoolf
Copy link
Contributor Author

fbwoolf commented May 16, 2024

Also, dropping a link here to this discussion about how to handle react-query undefined: TanStack/query#1331 (comment)

I did a test of this implementation using React context, which is similar to the loader pattern. It did work well:
https://stackblitz.com/edit/react-ts-x65k5x?file=index.tsx

It could work to use context as a way to load the data we need for certain parts of the wallet, like the asset list and send forms.

@fbwoolf
Copy link
Contributor Author

fbwoolf commented May 17, 2024

I am actually going to close this and do a bit more work on it over the weekend. I think there is more I can do before it is reviewed. isFetchedWithSuccess doesn't seem like a great solution in how it has been implemented here.

@fbwoolf fbwoolf closed this May 17, 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.

None yet

1 participant