[OTE-761] Affiliates comlink total volume and address

[jerryfan01234]

Changelist

replace total_volume and address endpoint stubs with real logic

Test Plan

[Describe how this PR was tested (if applicable)]

Author/Reviewer Checklist

• If this PR has changes that result in a different app state given the same prior state and transaction list, manually add the state-breaking label.
• If the PR has breaking postgres changes to the indexer add the indexer-postgres-breaking label.
• If this PR isn't state-breaking but has changes that modify behavior in PrepareProposal or ProcessProposal, manually add the label proposal-breaking.
• If this PR is one of many that implement a specific feature, manually label them all feature:[feature-name].
• If you wish to for mergify-bot to automatically create a PR to backport your change to a release branch, manually add the label backport/[branch-name].
• Manually add any of the following labels: refactor, chore, bug.

Summary by CodeRabbit

• New Features
  • Enhanced API methods for retrieving addresses and total volume with actual data retrieval and improved error handling.
• Bug Fixes
  • Improved test reliability by dynamically sourcing referral codes and addresses, ensuring accurate API behavior verification.
• Tests
  • Expanded test coverage with new cases for handling non-existent referral codes and invalid addresses.

[linear]

OTE-761 Implement GET /affiliates/address

[coderabbitai]

Walkthrough

The changes involve updates to the AffiliatesController and its associated test suite. The controller's methods for retrieving addresses and total volume now implement actual data retrieval logic and error handling instead of using placeholder responses. The test suite has been enhanced with setup and teardown procedures, dynamic data sourcing, and additional test cases to ensure comprehensive coverage of the API's behavior.

Changes

File	Change Summary
indexer/services/comlink/__tests__/controllers/api/v4/affiliates-controller.test.ts	Enhanced test suite with setup/teardown procedures, dynamic data sourcing, and additional test cases for error handling.
indexer/services/comlink/src/controllers/api/v4/affiliates-controller.ts	Updated getAddress and getTotalVolume methods to implement actual data retrieval and error handling, replacing placeholder logic.

Possibly related PRs

• [OTE-760] implement comlink affiliate metadata endpoint #2243: The changes in this PR involve the implementation of the /affiliates/metadata endpoint, which is directly related to the modifications made in the affiliates-controller.test.ts and affiliates-controller.ts files in the main PR, enhancing the testing and functionality of the affiliates controller.

Suggested labels

indexer

Poem

🐇 In the code where rabbits play,
Tests now dance in a brighter way.
With data fetched and errors caught,
Every line of code is thoughtfully wrought.
Hops of joy for changes made,
In the burrow, we’re never afraid! 🌼

Tip

OpenAI O1 model for chat

• We have deployed OpenAI's latest O1 model for chat.
• OpenAI claims that this model has superior reasoning capabilities than their GPT-4o model.
• Please share any feedback with us in the discussions post.

---

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

• X
• Mastodon
• Reddit
• LinkedIn

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

[coderabbitai]

Actionable comments posted: 0

Outside diff range and nitpick comments (1)

indexer/services/comlink/src/controllers/api/v4/affiliates-controller.ts (1)

167-167: Minor optimization suggestion

Consider directly returning the total volume instead of creating an object:

-return {
-  totalVolume: Number(walletRow.totalVolume),
-};
+return Number(walletRow.totalVolume);

This will slightly optimize the method by avoiding the creation of an unnecessary object.

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 9c3d96d and 5e7e139.

Files selected for processing (2)

• indexer/services/comlink/tests/controllers/api/v4/affiliates-controller.test.ts (2 hunks)
• indexer/services/comlink/src/controllers/api/v4/affiliates-controller.ts (2 hunks)

Additional comments not posted (7)

indexer/services/comlink/__tests__/controllers/api/v4/affiliates-controller.test.ts (5)

141-144: LGTM!

Setting up test data in the beforeEach hook is a good practice to ensure that each test case has a consistent starting state. Creating a default subaccount username is necessary for testing the /address endpoint.

---

146-148: LGTM!

Clearing the test data in the afterEach hook is a good practice to ensure that each test case starts with a clean slate and is not affected by the previous test cases.

---

150-161: LGTM!

The test case is well-structured and tests the happy path scenario. Using testConstants.defaultSubaccountUsername.username as the referral code is a good practice to ensure that the test case is not hardcoded and can be easily updated if the test data changes.

---

163-169: LGTM!

The test case is well-structured and tests the error scenario when the referral code is not found. The test case ensures that the API returns the appropriate error status code when the referral code is not found.

---

205-237: LGTM!

Setting up test data in the beforeEach hook and clearing it in the afterEach hook is a good practice to ensure that each test case has a consistent starting state and is not affected by the previous test cases.

The test cases are well-structured and test both the happy path and error scenarios. Using testConstants.defaultWallet.address as the address is a good practice to ensure that the test case is not hardcoded and can be easily updated if the test data changes.

indexer/services/comlink/src/controllers/api/v4/affiliates-controller.ts (2)

96-113: LGTM!

The getAddress method has been updated to replace the stub implementation with actual logic to retrieve the address based on the provided referral code. It correctly handles the case when the referral code doesn't exist by throwing a NotFoundError. It also handles the unexpected case when the subaccount is not found, although this should never happen due to the foreign key constraint between the subaccounts and subaccount_usernames tables.

The method achieves the goal outlined in the PR objectives.

---

158-167: LGTM!

The getTotalVolume method has been updated to replace the stub implementation with actual logic to retrieve the total volume based on the provided address. It correctly handles the case when the wallet doesn't exist by throwing a NotFoundError.

The method achieves the goal outlined in the PR objectives.