Add WebSocket plugin #1092
Add WebSocket plugin #1092
Conversation
fetsorn
requested review from
dOrgJelli,
krisbitney,
namesty and
nerfZael
as code owners
| # optional fields are `Number | null` instead of `Option<i32>` | ||
| type Number { | ||
| value: Int! | ||
| } |
There was a problem hiding this comment.
Why are we doing this?
There was a problem hiding this comment.
Optional Int is currently implemented as Option<i32> in wasm and schema/bind.
But to omit optional fields from the function parameters we need a | null union type.
So we wrap Int in a reference type and make it optional, Number | null.
I mentioned this in #944, but now I think we might want to implement Optional Int as Option<i32> | null and always use null instead of Option.None<i32>(), to no longer require wrapping such as this one.
There was a problem hiding this comment.
Why don't we use Box instead in that case?
There was a problem hiding this comment.
i.e. Box<i32> | null instead of Option<i32> | null
There was a problem hiding this comment.
Exactly, created an issue for that #1132.
Resolves #575. WebSocket plugin allows Polywrap Client to interact with WebSocket servers.
Every incoming WebSocket message can be passed to a callback function in another wrapper. Use
addCallbackto start passing messages andremoveCallbackto stop. The callback function is expected to have a parameterdata, i.e.foo(data: string).Incoming WebSocket messages can also be stored in the plugin and retrieved as an array later. Use
addCacheto start caching messages andremoveCacheto stop. Usereceiveto get an array of cached messages and empty the cache. Optionally, wait for a timeout, or a minimum number of cached messages before retrieving the array.See the README.md and src/tests/e2e/e2e.spec.ts for more info.