[TRA-103] Add subaccountNumber field in fills response result

[shrenujb]

Changelist

Add subAccountNumber as a field on FillResponseObject

Test Plan

Existing unit tests

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.

[linear]

TRA-103 Add API to get fills for parent subaccounts

[coderabbitai]

Walkthrough

The recent update introduces a new field subaccountNumber of type number (double) to the FillResponse schema in the API documentation, enhancing the response object structure. Additionally, the backend implementation has been adjusted to correctly handle and include this new field, ensuring that subaccountNumber is properly processed and integrated into the FillResponseObject. This involves modifications in the controller to handle the data type and updates to the request transformer and type definitions to support this new field.

Changes

Files	Change Summary
.../comlink/public/api-documentation.md	Added subaccountNumber field to the FillResponse schema.
.../comlink/src/controllers/api/v4/fills-controller.ts	Updated getFills method to handle subaccountNumber as a number.
.../comlink/src/request-helpers/request-transformer.ts	Added subaccountNumber parameter to fillToResponseObject function, updating its signature.
.../comlink/src/types.ts	Added subaccountNumber field of type number to the FillResponseObject interface.

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-tests 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 tests 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 tests.
  • @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.
• The JSON schema for the configuration file is available here.
• 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/coderabbit-overrides.v2.json

CodeRabbit Discord Community

Join our Discord Community to get help, request features, and share feedback.

[coderabbitai]

Review Status

Actionable comments generated: 0

Configuration used: CodeRabbit UI

Commits

Files that changed from the base of the PR and between 1482a88 and 62997b1.

Files ignored due to path filters (1)

• indexer/services/comlink/public/swagger.json is excluded by: !**/*.json

Files selected for processing (5)

• indexer/services/comlink/tests/controllers/api/v4/fills-controller.test.ts (1 hunks)
• indexer/services/comlink/public/api-documentation.md (4 hunks)
• indexer/services/comlink/src/controllers/api/v4/fills-controller.ts (2 hunks)
• indexer/services/comlink/src/request-helpers/request-transformer.ts (2 hunks)
• indexer/services/comlink/src/types.ts (1 hunks)

Additional comments: 7

indexer/services/comlink/src/controllers/api/v4/fills-controller.ts (3)

• 93-93: The addition of subaccountNumber as a parameter to fillToResponseObject ensures that the new field is included in the response object. This change aligns with the PR's objective to add subaccountNumber to the FillResponseObject.
• 142-144: The conversion of subaccountNumber from a string to a number using the unary plus operator is a straightforward and effective way to ensure the correct data type is passed to the getFills method. However, it's important to ensure that the input is always a valid number to avoid unexpected results.

Verification successful

---

The verification process confirms that subaccountNumber is expected to be a number at the point of receiving it as a query parameter, as indicated by @Query() subaccountNumber: number,. This suggests that there is an inherent validation ensuring subaccountNumber is a valid number before its conversion with the unary plus operator. Therefore, the review comment is consistent with the codebase, emphasizing the importance of ensuring the input is always a valid number to avoid unexpected results.

Scripts Executed

The following scripts were executed for the analysis:

---

Script:

#!/bin/bash
# Verify that subaccountNumber is always a valid number before conversion.
rg --type ts "subaccountNumber" src/controllers/api/v4/fills-controller.ts | grep -v "const subaccountNum"

Length of output: 189

---

---

Script:

#!/bin/bash
# First, find the correct path of fills-controller.ts
fd fills-controller.ts

# If found, the correct path will be used in a subsequent script to verify the handling of subaccountNumber

Length of output: 92

---

---

Script:

#!/bin/bash
# Verify that subaccountNumber is always a valid number before conversion using the correct file path.
rg --type ts "subaccountNumber" indexer/services/comlink/src/controllers/api/v4/fills-controller.ts | grep -v "const subaccountNum"

Length of output: 455

* 151-151: Passing the converted `subaccountNum` to the `getFills` method is correctly implemented. This ensures that the `subaccountNumber` is treated as a number throughout the method's logic, aligning with the changes made to support the new field in the response object.

indexer/services/comlink/__tests__/controllers/api/v4/fills-controller.test.ts (1)

• 110-110: Adding subaccountNumber to the expected object in the test case is a necessary update to align the tests with the changes made to the FillResponseObject. This ensures that the tests accurately reflect the new structure of the response object, including the subaccountNumber field.

indexer/services/comlink/src/types.ts (1)

• 132-132: The addition of the subaccountNumber field of type number to the FillResponseObject interface is correctly implemented. This change is essential for integrating the new field into the application's data structure, ensuring that the subaccountNumber is included in the fill response objects as intended.

indexer/services/comlink/src/request-helpers/request-transformer.ts (1)

• 134-140: > 📝 NOTE

This review was outside the diff hunks and was mapped to the diff hunk with the greatest overlap. Original lines [137-153]

The addition of the subaccountNumber parameter to the fillToResponseObject function and its inclusion in the returned object is correctly implemented. This change ensures that the subaccountNumber is properly transformed and included in response objects, aligning with the PR's objective to add this field to the FillResponseObject.

indexer/services/comlink/public/api-documentation.md (1)

• 583-584: The addition of the subaccountNumber field to the FillResponseObject is correctly documented. This change aligns with the PR's objective to enhance data structure for transaction or order processing by including subaccount identification. Ensure that all relevant API responses and schemas are updated accordingly to reflect this new field.