[TRA-109] Add parent subaccount websocket #1463

vincentwschau · 2024-05-03T21:18:58Z

Changelist

Update socks to be able to forward messages from a single topic to multiple websocket channels.
Add V4 parent subaccounts channel and forward messages from subaccounts topic to the parent websocket channel.
Add subaccount number as a top-level value in the websocket messages forwarded to clients.

Misc:

fixed some flakiness / issues with the message fowarding unit tests

TODO: Filtering out transfer messages from parent to a child / child to a child is not implemented.

Test Plan

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 · 2024-05-03T21:19:01Z

TRA-109 Add new websocket channel to subscribe to parent subaccounts

coderabbitai · 2024-05-03T21:19:03Z

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.

…ngle topic.

Christopher-Li · 2024-05-08T20:37:55Z

indexer/packages/postgres/__tests__/lib/parent-subaccount-helpers.ts

+  });
+
+  it('Throws an error if the child subaccount number is greater than the max child subaccount number', () => {
+    expect(() => getParentSubaccountNum(128001)).toThrowError('Child subaccount number must be less than 128000');


nit: test edge case of 128000

128000 isn't an edge case for errors, but the error message implies that. Updated the error message.

shrenujb · 2024-05-08T20:52:56Z

indexer/packages/postgres/src/lib/parent-subaccount-helpers.ts

+  MAX_PARENT_SUBACCOUNTS,
+} from '../constants';
+
+export function getParentSubaccountNum(childSubaccountNum: number): number {


Any reason to move this to a separate file?

Is this so that it can be used by both comlink and socks?

Yes, that's the reason.

shrenujb · 2024-05-09T15:15:47Z

indexer/services/socks/src/lib/subscription.ts

@@ -417,6 +412,9 @@ export class Subscriptions {

        return resolution !== undefined;
      }
+      case (Channel.V4_PARENT_ACCOUNTS): {


Why is the channel called "ACCOUNT" vs "SUBACCOUNTS"

No reason besides old code.

vincentwschau · 2024-05-09T16:23:33Z

@Mergifyio backport release/indexer/v5.x

mergify · 2024-05-09T16:24:00Z

backport release/indexer/v5.x

✅ Backports have been created

#1486 [TRA-109] Add parent subaccount websocket (backport #1463) has been created for branch release/indexer/v5.x but encountered conflicts

(cherry picked from commit 355d9e9) # Conflicts: # indexer/services/socks/src/lib/message-forwarder.ts

* [TRA-109] Add parent subaccount websocket (#1463) (cherry picked from commit 355d9e9) # Conflicts: # indexer/services/socks/src/lib/message-forwarder.ts * Fix conflicts. * Fix lint. --------- Co-authored-by: vincentwschau <99756290+vincentwschau@users.noreply.github.com>

Multi-cast message forwarding.

75aad66

github-actions bot added the indexer label May 3, 2024

vincentwschau added 26 commits May 6, 2024 11:26

Move parent subaccount helper to postgres package.

fe23c3c

Fix validation.

db6856c

Add parent subaccount subscription.

c78bc4f

Fix lint.

f061b5f

Fix lint.

bfd05c2

Fix tests.

cedd4e5

Send messages to both subaccounts/parent subaccounts channels from si…

be7dcfe

…ngle topic.

Add test for forwarding messages.

59a4364

Fix test.

a5e333d

Remove test.

c020283

Add back initial message.

cbd1861

Add back parent subaccount test.

c8a7d5f

Switch tests.

7f99cd5

Add extra channel.

5c25763

Send subaccount messages for child.

3319ca9

Add back subaccounts channel test.

428f91f

Skip forwarding test.

614577c

Remove messages in beforeAll

1f1edaf

Only delete trade records.

cadfe73

Separate into 2 tests.

bc3acee

Fix lint.

3fa1049

Add subaccountNumber to data messages.

8e4240b

Break test.

0481fe7

Try to break the test.

bdf0bb6

Fix subaccount number sending.

a0d8136

Log test case.

fde7b25

vincentwschau added 11 commits May 7, 2024 16:11

Enable test.

445c621

Get test to work.

52f125e

All tests in one file.

fae1504

Change up test setup.

826dab7

Remove test.

9810769

Change test ordering.

d8e6f65

Don't wait for wss to start.

2556bc5

Change increment for ws host.

41a4cf8

Re-order.

6a4e443

Remove unneeded tests.

8441db2

Fix lint.

dc7f488

vincentwschau marked this pull request as ready for review May 8, 2024 18:29

vincentwschau changed the title ~~[WIP] [TRA-109] Add parent subaccount websocket~~ [TRA-109] Add parent subaccount websocket May 8, 2024

Test batching 2 different child subaccount's messages.

27950a8

vincentwschau added the isolated-markets label May 8, 2024

Christopher-Li reviewed May 8, 2024

View reviewed changes

shrenujb reviewed May 8, 2024

View reviewed changes

shrenujb reviewed May 9, 2024

View reviewed changes

Update error message.

b916ba1

shrenujb approved these changes May 9, 2024

View reviewed changes

vincentwschau merged commit 355d9e9 into main May 9, 2024
11 checks passed

vincentwschau deleted the vincentc/tra-109-parent-subaccount-websockets branch May 9, 2024 15:45

mergify bot pushed a commit that referenced this pull request May 9, 2024

[TRA-109] Add parent subaccount websocket (#1463)

38b00fb

(cherry picked from commit 355d9e9) # Conflicts: # indexer/services/socks/src/lib/message-forwarder.ts

mergify bot mentioned this pull request May 9, 2024

[TRA-109] Add parent subaccount websocket (backport #1463) #1486

Merged

6 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[TRA-109] Add parent subaccount websocket #1463

[TRA-109] Add parent subaccount websocket #1463

vincentwschau commented May 3, 2024 •

edited

Loading

linear bot commented May 3, 2024

coderabbitai bot commented May 3, 2024

Auto Review Skipped

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configration File (`.coderabbit.yaml`)

Documentation and Community

Christopher-Li May 8, 2024

vincentwschau May 9, 2024

shrenujb May 8, 2024

shrenujb May 8, 2024

vincentwschau May 9, 2024

shrenujb May 9, 2024

vincentwschau May 9, 2024

vincentwschau commented May 9, 2024

mergify bot commented May 9, 2024 •

edited

Loading

[TRA-109] Add parent subaccount websocket #1463

[TRA-109] Add parent subaccount websocket #1463

Conversation

vincentwschau commented May 3, 2024 • edited Loading

Changelist

Test Plan

Author/Reviewer Checklist

linear bot commented May 3, 2024

coderabbitai bot commented May 3, 2024

Auto Review Skipped

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configration File (.coderabbit.yaml)

Documentation and Community

Christopher-Li May 8, 2024

Choose a reason for hiding this comment

vincentwschau May 9, 2024

Choose a reason for hiding this comment

shrenujb May 8, 2024

Choose a reason for hiding this comment

shrenujb May 8, 2024

Choose a reason for hiding this comment

vincentwschau May 9, 2024

Choose a reason for hiding this comment

shrenujb May 9, 2024

Choose a reason for hiding this comment

vincentwschau May 9, 2024

Choose a reason for hiding this comment

vincentwschau commented May 9, 2024

mergify bot commented May 9, 2024 • edited Loading

✅ Backports have been created

vincentwschau commented May 3, 2024 •

edited

Loading

CodeRabbit Configration File (`.coderabbit.yaml`)

mergify bot commented May 9, 2024 •

edited

Loading