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.

Sign up for GitHub

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

Jump to bottom

Add RPC helpers #1256

Merged
merged 97 commits into from
Mar 13, 2024
Merged

Add RPC helpers #1256

merged 97 commits into from
Mar 13, 2024

Conversation

jerelmiller
Copy link
Member

Adds an RPC implementation to make it easier to ask for data between devtools extension types.

jerelmiller added 30 commits March 9, 2024 20:45
@jerelmiller
Add additional info to test description
e393764
@jerelmiller
Add failing test on wanted API
93ffad3
@jerelmiller
Add rough implementation
5f91af7
@jerelmiller
Move message adapters to own file
30228c7
@jerelmiller
Revert change to test name
aca8e4e
@jerelmiller
Move rpc code into own module
3479bfe
@jerelmiller
Get TS types in place for rpc
b4d25e1
@jerelmiller
Tweak type of ApolloClientDevtoolsMessage to allow for flexibility
e73c781
@jerelmiller
Add message id to ApolloClientDevtoolsMessage type
70aaee1
@jerelmiller
Add working rpc implementation
a0eebab
@jerelmiller
Separate handler from client
618dc99
@jerelmiller
Return a function directly from rpc handler
872459f
@jerelmiller
Add test to check multiple messages can be sent
5f61017
@jerelmiller
Inline the result
2b87c25
@jerelmiller
Remove explanatory test
4540c43
@jerelmiller
Only allow a single rpc handler to exist
3429c84
@jerelmiller
Check for id in rpc handler
070d6c5
@jerelmiller
Only subscribe single listener from handler
be5f0f6
@jerelmiller
Some destructuring
3b585cb
@jerelmiller
Add test to ensure unsubscribe can happen
93e40e1
@jerelmiller
Add tests to check unsubscribe/resubscribe behavior
9290645
@jerelmiller
Add timeout behavior to rpc
fdd01d9
@jerelmiller
Add bridge to actor to forward all messages
c315ed1
@jerelmiller
Add test to ensure unsubscribe from bridge works correctly
1987026
@jerelmiller
Rename forward to forwardTo and remove separate bridge API
55e3d10
@jerelmiller
Add test for unsubcribing from all forwarding
94adb16
@jerelmiller
Add test to ensure multiple listeners aren't created
e256802
@jerelmiller
Use updated API to forward messages
75289c8
@jerelmiller
Only setup forwarding the first time the panel is initialized
7877dd3
@jerelmiller
Refactor check for removing listener into stop listening
c9c7dfc
@jerelmiller
Don't use Promise.race
cb7169f
@jerelmiller
Ensure timeout is cleared when processing message
ac7a16d
@jerelmiller
Don't process getClientOperations requests if there is no panel window
e66e02d
@jerelmiller
Use defined type in isRPCMessage check
12cc47e
@jerelmiller
Add a helper type to distribute omit
b6afd38
@jerelmiller
Separate rpc request/response message types
a806fee
@jerelmiller
Fix reference to outdated message type
ab50cf6
@jerelmiller
Add test to check that any parameter format will work
3380ef5
@jerelmiller
Minor refactor to remove nested ifs
8313124
@jerelmiller
Add a withTimeout function to set a timeout for a request
96858c3
@jerelmiller
Add test to check that timeout is reset after sending request
f6a82ce
@jerelmiller
Use spread args to make rpc call more like function call
6363941
@jerelmiller
Adjust test examples to use more natural rpc call
375bea6
@jerelmiller
Add example of message without params
3fede23
@jerelmiller
Fix ts error on rpc call in devtools
e2e0823
@jerelmiller jerelmiller marked this pull request as ready for review March 13, 2024 05:50
@jerelmiller jerelmiller requested a review from a team as a code owner March 13, 2024 05:50
jerelmiller
jerelmiller commented Mar 13, 2024
View reviewed changes
src/extension/messages.ts
getClientOperations(): GetContext<DevtoolsMachine>["clientContext"];
};

function isDevtoolsMessage<Message extends Record<string, unknown>>(
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For type safety, this is no longer exported. Prefer using the helper below this instead.

phryneas
phryneas approved these changes Mar 13, 2024
View reviewed changes
Copy link
Member

@phryneas phryneas left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks great to me and I can't wait to use it!
Just one more suggestion, but no matter if you take it or not: approved!

src/extension/rpc.ts Outdated Show resolved Hide resolved
src/extension/__tests__/rpc.test.ts Outdated Show resolved Hide resolved
@jerelmiller jerelmiller merged commit 28140d8 into main Mar 13, 2024
9 checks passed
@jerelmiller jerelmiller deleted the actor-rpc branch March 13, 2024 15:34
@github-actions github-actions bot mentioned this pull request Mar 13, 2024
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@phryneas phryneas phryneas approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@jerelmiller @phryneas