feat(client): add callback/event mechanism between TypeScript and Go #2330
Conversation
client/electron/go_plugin.ts
Outdated
| * @param name The name of the event to unsubscribe from. | ||
| * @returns A Promise that resolves when the unsubscription is successful. | ||
| */ | ||
| export async function unsubscribeEvent(name: string): Promise<void> { |
There was a problem hiding this comment.
Could you link the unsubscribe action to the actual subscription instead of the event name? It's a cleaner way to manage subscriptions and allows the TypeScript code to subscribe to the same event twice if needed.
Looks like Koffi already gives you a unique callback object, so you could wrap that in some dedicated Subscription type with an unsubscribe() method. Or assign it a unique ID and pass that around.
There was a problem hiding this comment.
Sure, I also decided to differentiate a Callback and an Event handler. A Callback can be used as an Event handler, it can also be used in other MethodChannel functions as well (for example, calling TestConnectivity and have an ResultCallback to receive the result). Then we will have a general way to call TypeScript functions from Go.
There was a problem hiding this comment.
Refactored, now it accepts multiple callbacks.
client/electron/go_plugin.ts
Outdated
| * @param data The event data string passed from the source. | ||
| * @param param The param string provided during registration. | ||
| */ | ||
| export type CallbackFunction = (data: string, param: string) => void; |
There was a problem hiding this comment.
As far as I understand you are decoupling callbacks from events like we discussed. So this would have a single data parameter.
client/electron/go_plugin.ts
Outdated
| * | ||
| * @remarks Subscribing to an event will replace any previously subscribed callback for that event. | ||
| */ | ||
| export async function subscribeEvent( |
There was a problem hiding this comment.
My understanding is that this will become a regular MethodChannel call that takes a callback id?
jyyi1
force-pushed
the
junyi/vpn-callback-linux
branch
from
f617f0b to
3ced93e
Compare
This PR introduces a callback/event mechanism that allows TypeScript code to subscribe to events triggered in the Go code.
To demonstrate the functionality, this PR implements a VPN connection status change event. The TypeScript code can now subscribe to this event and receive updates on the VPN connection status.
This mechanism can be leveraged for both electron and the Cordova code.