spider: support speaking raw nouns #6943
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
in the thread-calling http interface. Specifying a content-type header of application/x-urb-jam will make the request body be interpreted as a uw-encoded jammed noun, rather than json. Specifying an accept header of application/x-urb-jam will make the thread result in the response body be rendered as a uw-encoded jammed noun, rather than json. For the latter, the output mark becomes unused, since we can just "render" the resulting noun directly, without needing to explicitly convert it. (This assumes that converting any mark to %noun will always result in the same noun, which isn't guaranteed in theory, but is always the case in practice.) This prepares spider for use in a nouns-based version of js-http-api.
Fang-
changed the title
This brings it in line with the serialization found in /mar/noun. The `@uw`-encoding was carried over from Eyre, who uses it for channels. In that context, outgoing jam bytes must be encoded, because newline characters (`0a` bytes) would break up the SSE data field. Because they're essentially part of the same protocol, Eyre mirrors this for incoming nouns. Even though PUT requests can carry arbitrary bytes just fine, the symmetry and protocol-wide consistency seems important. Here, we are dealing strictly with plain HTTP requests, and strictly with requests that have indicated support for the `application/x-urb-jam` mime type to boot. We should have no qualms about raw jam bytes. They're more compact/efficient, too.
Fang-
added a commit
to xiphiness/js-http-api
that referenced
this pull request
Mar 26, 2024
Now defaults to speaking raw nouns with spider, as supported through urbit/urbit#6943. Provides a jsonThread() fallback for speaking json. Doesn't yet support the "json one way, nouns the other" case. Factors out noun<->bytebuffer conversions into utility functions.
pkova
approved these changes
Apr 5, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
in the thread-calling http interface.
Specifying a
content-typeheader ofapplication/x-urb-jamwill make the request body be interpreted as a@uw-encoded jammed noun, rather than json.Specifying an
acceptheader ofapplication/x-urb-jamwill make the thread result in the response body be rendered asajammed noun bytes, rather than json.@uw-encodedFor the latter, the output mark becomes unused, since we can just "render" the resulting noun directly, without needing to explicitly convert it. (This assumes that converting any mark to %noun will always result in the same noun, which isn't guaranteed in theory, but is always the case in practice.)
This
maps closely tois adjacent to Eyre's "noun channels" support, and prepares spider for use in a nouns-based version of the js-http-api.Example: