perf(postgres,comlink): Improve historical-pnl/parentSubaccount query

[teddyding]

Changelist

Instead of passing in all possible childSubaccountid into findAll, add a subquery that retrieves existing subaccounts.

Test Plan

• Current unit tests passed
• Tested hotfix on internal mainnet

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 filtering options by introducing parent subaccount details, allowing users to refine data queries based on hierarchical account relationships.
  • Implemented validations to ensure only one filter type (child or parent account) is applied, improving data accuracy.
  • Updated query configurations to support the new parent account structure, offering more precise historical data retrieval.

[coderabbitai]

Walkthrough

This pull request introduces support for handling parent subaccounts in query operations. It adds a new parameter, parentSubaccount, to the findAll function in the PnL ticks table, along with validation to prevent conflicting parameters. The changes extend type definitions by including a new enum value and interface for parent subaccounts. Furthermore, the historical PnL controller now uses a structured parent subaccount object for querying instead of an array of child subaccount IDs.

Changes

File(s)	Summary
indexer/packages/postgres/src/stores/pnl-ticks-table.ts indexer/packages/postgres/src/types/query-types.ts	Added support for parent subaccounts: introduced a new parentSubaccount parameter in findAll, added validation against simultaneous use with subaccountId, incorporated subquery logic with constants (MAX_PARENT_SUBACCOUNTS, CHILD_SUBACCOUNT_MULTIPLIER), added enum value PARENT_SUBACCOUNT and new interface ParentSubaccount, and updated PnlTicksQueryConfig accordingly.
indexer/services/comlink/src/controllers/api/v4/historical-pnl-controller.ts	Modified the getHistoricalPnlForParentSubaccount method to replace the previous use of child subaccount IDs with a structured parentSubaccount object containing address and subaccountNumber.
indexer/packages/postgres/src/types/subaccount-types.ts	Added a new interface ParentSubaccount with properties address and subaccountNumber.

Possibly related PRs

• Fix subaccount validation to account for updated subaccount limit. #1513: Adjusts validation logic for parent subaccount numbers and uses constants like MAX_PARENT_SUBACCOUNTS, similar to the current changes.
• [TRA-568] Initial vault PnL endpoints. #2121: Adds a parentSubaccount parameter to the findAll function and revises query filtering for profit and loss data.
• feat(fills): Improve fills/parentSubaccount query #2735: Introduces the getFillsForParentSubaccount function, involving similar parent subaccount handling in queries.

Suggested reviewers

• vincentwschau
• tqin7

Poem

Oh, I’m a rabbit with a codebound beat,
Hoping through lines where logic and queries meet.
Parent subaccounts now pave the way,
Guiding my hops in a structured display.
With carrots and keys, my heart takes flight,
Celebrating changes with a joyful byte! 🐇✨

✨ Finishing Touches

• 📝 Generate Docstrings

---

🪧 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.
• @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

🧹 Nitpick comments (1)

indexer/packages/postgres/src/types/subaccount-types.ts (1)

26-29: Clean interface addition for parent subaccount support.

The new ParentSubaccount interface is well-structured and focused, containing just the necessary fields to identify a parent subaccount. It aligns with the PR objective of optimizing the historical PnL queries by using parent subaccount information instead of passing all child subaccount IDs.

Consider adding a JSDoc comment explaining the purpose of this interface and how it relates to the query optimization:

+/**
+ * Interface representing a parent subaccount identifier.
+ * Used for querying child subaccounts in historical PnL queries
+ * instead of passing all possible childSubaccountIds.
+ */
export interface ParentSubaccount {
  address: string,
  subaccountNumber: number,
}

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 08a046f and 520acd1.

📒 Files selected for processing (2)

• indexer/packages/postgres/src/types/query-types.ts (3 hunks)
• indexer/packages/postgres/src/types/subaccount-types.ts (1 hunks)

🚧 Files skipped from review as they are similar to previous changes (1)

• indexer/packages/postgres/src/types/query-types.ts

⏰ Context from checks skipped due to timeout of 90000ms (13)

• GitHub Check: test / run_command
• GitHub Check: call-build-ecs-service-vulcan / (vulcan) Check docker image build
• GitHub Check: call-build-ecs-service-socks / (socks) Check docker image build
• GitHub Check: call-build-ecs-service-roundtable / (roundtable) Check docker image build
• GitHub Check: call-build-ecs-service-ender / (ender) Check docker image build
• GitHub Check: call-build-ecs-service-comlink / (comlink) Check docker image build
• GitHub Check: check-build-bazooka
• GitHub Check: check-build-auxo
• GitHub Check: lint
• GitHub Check: run_command
• GitHub Check: Analyze (javascript-typescript)
• GitHub Check: Analyze (go)
• GitHub Check: Summary