Typing improvements for `io` and fixes for `websocketclient`, and a few others by cmidgley · Pull Request #1429 · Moddable-OpenSource/moddable · GitHub

This is the work I've done to date with io focused on making websocketclient to be reliable and strongly typed with TypeScript. It's a fairly substantial set of changes, mostly in the .d.ts files but some implementation (especially websocketclient).

Type changes:

New types for embedded:io/socket/tcp/tls, embedded:network/http/server, embedded:network/http/server/options/webpage, embedded:network/https/server/options/websocket, and embedded:network/websocket/client
Improvements to types embedded:io/socket/listener, embedded:io/socket/tcp, embedded:io/socket/udp, embedded:network/dns/resolver/udp, embedded:network/http/client, embedded:provider/builtin
Added Device (for global variable device) into global types to eliminate requirement for import
Extend the global namespace for Device for when imports of extended modules are used (support for embedded:network/http/server, embedded:network/websocket/client)

Implementation changes:

Bug fixes/improvements for websocketclient:
- Implement error property via onError(error: string) (new feature)
- Fix issue where control message payloads were not being decoded with the mask (data corruption)
- Fix an issue where masks were used on both client and server (spec requires masking on client to server only)
- Fixed issue where fragmented reads used an improper mask (data corruption)
Fix a bug in websocket where using attached sockets would fail (reported in embedded:io/socket/listener locks up Win simulator #1428)
Add common HTTP status codes to httpserver on the HTTP/1.1 <status> <code> header
Added options feature to embedded:network/http/server/options/webpage to support .contentType and .status.

I typed everything based on the current implementation and not ECMA-419 (many modules are inconsistent with the published 2nd edition of the spec).

…cket extend Device; improvements overall on types

… on callbacks

…ts), fix bug with masks on fragmented reads, and add mask decode to control messages

…ypes

I'm not sure about this change. It must fix a problem you see. But, it also would require the caller to set host, port, and path in the options object, which isn't what we want.

Good catch - on review I see I misunderstood what it was doing. I'll fix...

Fixes are in place. Let me know what else you find..

- tls extends tcp instead of full definition - Add 'undefined' as possible `read` result

I'm no TypeScript expert, but don't you need to define that the TLSSocket constructor uses TLSOptions instead of TCPOptions for the options object argument?

Thank you for filling this in. The change is good. I don't want even more copies of the HTTP status code map in the repo. I'll make a module for those so it can be shared. But that doesn't need to hold this up.

419 UDP only specifies udp.read() - no argument and returns ArrayBuffer augmented with port and address. It does not specify multicast (though that's definitely on the roadmap)

There's no requirement that this is a DNS using UDP. It could be another resolution transport. But, for the moment this is probably OK?

I'd say we add a generic DNS type when we have more, and change ClientOptions to use that (or just DNSUDPDevice | DNSOtherDevice here). Either way, it won't be a breaking change as it is just expanding the type. But using 'any' (or 'undefined') isn't a good alternative as it isn't strongly typed.

…pstream changes), fix TLSSocket constructor type, remove paramaterized UDP.read

…ce is defined; remove udp.read(buffer); add TLSSocket.constructor with TLSOptions definition

Merged latest code and resolved conflicts. Reviewed io changes since initial PR and applied typing changes as needed. Removed some no-longer-needed code changes as they are now in base. Applied changes based on review comments from Peter. This has been working great for me for the last seven months (on an older version of Moddable) and compiles/passes all my tests with latest code.

Ready for review and possible merging.

Finally coming back around to this.... there's so much here that it is a little challenging to review. I'm not asking that you split it up, but it is a bit of an adventure to understand and review.

That said, a lot of it looks good and we should get it merged. The *-device stuff is a bit confusing. I think I'm starting to understand it though.

cmidgley added 15 commits October 17, 2024 14:55

Start of io typings work

6bc4f6a

Adjust namespace for 'config' to websocketclient/config

f3c862b

Merge branch 'public' into io-typings

e42b93c

Revert config.js

2fe80d7

Reverse webclient manfiest

65d177e

Revert TLS include

201906a

Define Device into global namespace to allow augmentation; have WebSo…

9a3aa33

…cket extend Device; improvements overall on types

Removed unused import

afeb566

Fixed module imports to be within declare

04a118f

More refinements/improvements to tcp/udp/dns/websocket types

b6e275e

More io types, expanded webpage w/status and headers, fixed up 'this'…

365854b

… on callbacks

Add status codes to http/1.1 response

72b162a

Fix bug with attach socket

2d935cb

Further type improvements for websocketclient

e002eab

Add onError error messages, don't use masks on server (attached socke…

a0c86df

…ts), fix bug with masks on fragmented reads, and add mask decode to control messages

cmidgley changed the title Typing improvements for io and fixes for websocketclient`, and a few others Typing improvements for io and fixes for websocketclient, and a few others Oct 21, 2024

cmidgley mentioned this pull request Oct 22, 2024

Unnecessary manifest_typings.json entry for embedded:network/* causes warning #1365

Closed

cmidgley added 3 commits October 22, 2024 08:53

Fix bug with reversed client/server on mask

f88cff5

Switch builtin-global to builtin-device to be consistent with other t…

b318fce

…ypes

Remove unnecessary import

629663f

phoddie reviewed Oct 23, 2024

View reviewed changes

Comment thread typings/embedded_network/websocket/client.d.ts Outdated

cmidgley added 2 commits October 24, 2024 07:01

Revert prior and apply new fix for attached sockets

47168b1

Fix type of buffer on onControl

876f4e0

Small improvements on types

08e1cee

- tls extends tcp instead of full definition - Add 'undefined' as possible `read` result

phoddie reviewed Oct 28, 2024

View reviewed changes

phoddie reviewed Nov 1, 2024

View reviewed changes

cmidgley added 4 commits May 2, 2025 08:38

Merge latest Moddable public; remove Websocket code fixes (too many u…

1c711f2

…pstream changes), fix TLSSocket constructor type, remove paramaterized UDP.read

Import embedded:provider/builtin-device in global.d.ts to ensure Devi…

ae61e2d

…ce is defined; remove udp.read(buffer); add TLSSocket.constructor with TLSOptions definition

Adjust for changes to io since initial PR

37055ec

Minor cleanup for PR

188fc24

+                  socket: TCPDevice | TLSDevice;
+                  port?: number;
+                  host: string;
+                  dns: DNSUDPDevice;

Typing improvements for `io` and fixes for `websocketclient`, and a few others by cmidgley · Pull Request #1429 · Moddable-OpenSource/moddable · GitHub

Uh oh!

Typing improvements for io and fixes for websocketclient, and a few others - #1429

Typing improvements for io and fixes for websocketclient, and a few others#1429
cmidgley wants to merge 25 commits into
Moddable-OpenSource:publicfrom
Nexstrum:io-typings

cmidgley commented Oct 21, 2024

Uh oh!

phoddie Oct 23, 2024

Uh oh!

cmidgley Oct 24, 2024

Uh oh!

Uh oh!

cmidgley commented Oct 24, 2024

Uh oh!

phoddie Oct 28, 2024

Uh oh!

phoddie Nov 1, 2024

Uh oh!

phoddie Nov 1, 2024

Uh oh!

phoddie Nov 1, 2024

Uh oh!

cmidgley May 3, 2025

Uh oh!

cmidgley commented May 3, 2025

Uh oh!

phoddie commented May 15, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

-              		set format(format: string);
-              		get format(): string;
-              	}
+              	export default class TLSSocket extends TCP {}

Typing improvements for `io` and fixes for `websocketclient`, and a few others by cmidgley · Pull Request #1429 · Moddable-OpenSource/moddable · GitHub

Uh oh!

Typing improvements for io and fixes for websocketclient, and a few others - #1429

Typing improvements for io and fixes for websocketclient, and a few others#1429cmidgley wants to merge 25 commits intoModdable-OpenSource:publicModdable-OpenSource/moddable:publicfrom Nexstrum:io-typingsNexstrum/moddable:io-typingsCopy head branch name to clipboard

Conversation

cmidgley commented Oct 21, 2024

Uh oh!

phoddie Oct 23, 2024

Choose a reason for hiding this comment

Uh oh!

cmidgley Oct 24, 2024

Choose a reason for hiding this comment

Uh oh!

Uh oh!

cmidgley commented Oct 24, 2024

Uh oh!

phoddie Oct 28, 2024

Choose a reason for hiding this comment

Uh oh!

phoddie Nov 1, 2024

Choose a reason for hiding this comment

Uh oh!

phoddie Nov 1, 2024

Choose a reason for hiding this comment

Uh oh!

phoddie Nov 1, 2024

Choose a reason for hiding this comment

Uh oh!

cmidgley May 3, 2025

Choose a reason for hiding this comment

Uh oh!

cmidgley commented May 3, 2025

Uh oh!

phoddie commented May 15, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Typing improvements for io and fixes for websocketclient, and a few others#1429
cmidgley wants to merge 25 commits into
Moddable-OpenSource:publicfrom
Nexstrum:io-typings