Update algorithms to use new processing model. #30

wes-smith · 2024-08-27T19:51:02Z

index.html

TallTed · 2024-08-28T19:27:59Z

index.html

+that is needed to compress or decompress to/from CBOR-LD. During compression and decompression, the 
+<a href="top-level-term-codec-map-generation-algorithm"></a> is run once during setup, and the 
+<a href="update-term-codec-map-with-type-scoped-context-algorithm"></a> and 
+<a href="update-term-codec-map-with-property-scoped-context-algorithm"></a> are run on an as-needed basis.


Suggested change

that is needed to compress or decompress to/from CBOR-LD. During compression and decompression, the

<a href="top-level-term-codec-map-generation-algorithm"></a> is run once during setup, and the

<a href="update-term-codec-map-with-type-scoped-context-algorithm"></a> and

<a href="update-term-codec-map-with-property-scoped-context-algorithm"></a> are run on an as-needed basis.

that is needed to compress to or decompress from CBOR-LD. For compression and decompression, the

<a href="top-level-term-codec-map-generation-algorithm"></a> is run once during setup, and the

<a href="update-term-codec-map-with-type-scoped-context-algorithm"></a> and

<a href="update-term-codec-map-with-property-scoped-context-algorithm"></a> are run on an as-needed basis.

TallTed · 2024-08-28T19:29:46Z

index.html

+      <section>
+        <h2>Top-level Term Codec Map Generation Algorithm</h2>
+        <p>
+This algorithm takes a map `typeTable` and an array of JSON-LD contexts `contexts` and 


Shouldn't this be like the other algorithms, with ({datatype} {name}) or similar for each input and output?

Suggested change

This algorithm takes a map `typeTable` and an array of JSON-LD contexts `contexts` and

This algorithm takes a map `typeTable` and an array of JSON-LD contexts `contexts` as inputs, and

TallTed · 2024-08-28T19:30:06Z

index.html

+          <li>Let `termToEncodedValue` be an ordered map.</li>
+          <li>
+For each value in `contextUrls`, dereference the JSON-LD contexts and process
+every entry at the top level (i.e. ignoring type and property-scoped contexts).


Is the parenthetical meant to be read as ignoring type-scoped and property-scoped contexts? or ignoring (type) and (property-scoped contexts)? or something else? I'm guessing it's the first, which calls for the addition of this hyphen —

Suggested change

every entry at the top level (i.e. ignoring type and property-scoped contexts).

every entry at the top level (i.e., ignoring type- and property-scoped contexts).

TallTed · 2024-08-28T19:34:41Z

index.html

+            </ol>
+          </li>
+          <li>
+Sort the keys in `termToEncodedValue` by value.


This sort order should be more explicit. I'm guessing it should be by codepoint value, which sometimes means we need to force a codepage or call for it to be declared (e.g., UTF-8, UTF-16, UTF-32, etc.)....

TallTed · 2024-08-28T19:43:12Z

index.html

+          <li>
+For each entry in the typeTables array in the CBOR-LD Varint Registry Entry associated with
+`registryEntryId`, dereference the URL if necessary and add ${type}: ${table} from the resulting
+document to `typeTable`. If "callerProvidedTable" appears in contextTables, populate `typeTables`


Suggested change

document to `typeTable`. If "callerProvidedTable" appears in contextTables, populate `typeTables`

document to `typeTable`. If "callerProvidedTable" appears in `contextTables`, populate `typeTables`

TallTed · 2024-08-28T19:43:32Z

index.html

+      <section>
+        <h2>Get CBOR-LD Registry Entry ID Algorithm</h2>
+        <p>
+This algorithm takes a CBOR-LD payload `cborldBytes` as input and returns


Suggested change

This algorithm takes a CBOR-LD payload `cborldBytes` as input and returns

This algorithm takes a CBOR-LD payload `cborldBytes` as input, and returns

TallTed · 2024-08-28T19:44:32Z

index.html

+If the CBOR tag on `cborldBytes` is not in the range `0x0600-0x06FF`, throw an
+ERR_NON_CBOR_LD_TAG error.
+          </li>
+          <li>
+Otherwise if the CBOR tag on `cborldBytes` is in the range `0x0600-0x067F`, set `registryEntryId` to


Suggested change

If the CBOR tag on `cborldBytes` is not in the range `0x0600-0x06FF`, throw an

ERR_NON_CBOR_LD_TAG error.

</li>

<li>

Otherwise if the CBOR tag on `cborldBytes` is in the range `0x0600-0x067F`, set `registryEntryId` to

If the CBOR tag on `cborldBytes` is not in the range `0x0600`–`0x06FF`, throw an

`ERR_NON_CBOR_LD_TAG` error.

</li>

<li>

Otherwise if the CBOR tag on `cborldBytes` is in the range `0x0600`–`0x067F`, set `registryEntryId` to

TallTed · 2024-08-28T19:44:43Z

index.html

+            <ol>
+              <li>
+If the last byte of the CBOR tag does not form the first byte of a valid varint, throw an
+ERR_INVALID_VARINT_VALUE error.


Suggested change

ERR_INVALID_VARINT_VALUE error.

`ERR_INVALID_VARINT_VALUE` error.

TallTed · 2024-08-28T19:44:59Z

index.html

+Generate Decompressed JSON-LD Algorithm
+        </h2>
+        <p>
+This algorithm takes as input CBOR-LD payload `cborldBytes` and a map `typeTable` and returns a JSON-LD document.


Suggested change

This algorithm takes as input CBOR-LD payload `cborldBytes` and a map `typeTable` and returns a JSON-LD document.

This algorithm takes a CBOR-LD payload `cborldBytes` and a map `typeTable` as inputs, and returns a JSON-LD document.

…ssor algorithms.

…letons.

dlongley

I think this is a significant improvement over what we have in the spec today, so we should merge this and iterate from there.

index.html

@TallTed

From @TallTed. Co-authored-by: Ted Thibodeau Jr <[email protected]>

dlongley · 2025-01-06T15:49:21Z

I believe I've applied all of @TallTed's suggestions that still remained after the most recent edits.

wes-smith · 2025-01-06T17:26:51Z

@TallTed How do you want to proceed here? This PR is pretty huge - do you intend to do a full rereview, and if so, how long do you think it will take?

TallTed

Editorial. Almost only commas and code fences, for clarity.

TallTed · 2025-01-06T21:19:13Z

index.html

+Set `state.strategy` to "decompression".
+          </li>
+          <li>
+For each entry `type`: `map` in the `typeTables` array in the CBOR-LD Varint Registry Entry


There should be something that sets `type`: `map` aside from the rest of the text. <em> might be enough. I'm open to better ideas.

Suggested change

For each entry `type`: `map` in the `typeTables` array in the CBOR-LD Varint Registry Entry

For each entry <em>`type`: `map`</em> in the `typeTables` array in the CBOR-LD Varint Registry Entry

TallTed · 2025-01-06T21:20:45Z

index.html

+        <h3>Convert Document Algorithm</h3>
+        <p>
+This algorithm takes a map `state` and a map or array of
+maps `inputDocuments` and returns a map containing a map `state` and a map or


Suggested change

maps `inputDocuments` and returns a map containing a map `state` and a map or

maps `inputDocuments`, and returns a map containing a map `state` and a map or

TallTed · 2025-01-06T21:21:22Z

index.html

+        <section>
+          <h4>Convert Value for Compression Algorithm</h4>
+          <p>
+This algorithm takes maps `state` and `termInfo` and values `valueToEncode` and `termType`


Suggested change

This algorithm takes maps `state` and `termInfo` and values `valueToEncode` and `termType`

This algorithm takes maps `state` and `termInfo`, and values `valueToEncode` and `termType`,

TallTed · 2025-01-06T21:21:48Z

index.html

+        <section>
+          <h4>Get Input Entries for Compression Algorithm</h4>
+          <p>
+This algorithm takes maps `state`, `activeContext`, and `input` and returns a map `state` and an array `entries`.


Suggested change

This algorithm takes maps `state`, `activeContext`, and `input` and returns a map `state` and an array `entries`.

This algorithm takes maps `state`, `activeContext`, and `input`, and returns a map `state` and an array `entries`.

TallTed · 2025-01-06T21:22:07Z

index.html

+        <section>
+          <h4>Get Object Types for Compression Algorithm</h4>
+          <p>
+This algorithm takes maps `activeContext` and `input` and returns a set


Suggested change

This algorithm takes maps `activeContext` and `input` and returns a set

This algorithm takes maps `activeContext` and `input`, and returns a set

TallTed · 2025-01-06T22:06:20Z

index.html

+Set `varintArray` to an array containing the varint representation of `registryEntryId`.
+              </li>
+              <li>
+Set `varintTagValue` to `varintArray[0]` appended to the end of the bytes 0xD906.


Suggested change

Set `varintTagValue` to `varintArray[0]` appended to the end of the bytes 0xD906.

Set `varintTagValue` to `varintArray[0]` appended to the end of the bytes `0xD906`.

TallTed · 2025-01-06T22:06:32Z

index.html

+              </li>
+              <li>
+Set `varintBytesValue` to a CBOR byte string containing the rest of `varintArray` appended
+to the end of the bytes 0x82.


Suggested change

to the end of the bytes 0x82.

to the end of the bytes `0x82`.

TallTed · 2025-01-06T22:08:51Z

index.html

+                  </ol>
+                </li>
+                <li>
+Otherwise if `valueToDecode` is an integer and `state`.`typesEncodedAsBytes` does not


Suggested change

Otherwise if `valueToDecode` is an integer and `state`.`typesEncodedAsBytes` does not

Otherwise, if `valueToDecode` is an integer and `state`.`typesEncodedAsBytes` does not

TallTed · 2025-01-06T22:09:08Z

index.html

+                  </ol>
+                </li>
+                <li>
+Otherwise if `valueToDecode` is a byte array and `tableType` is not "none", set


Suggested change

Otherwise if `valueToDecode` is a byte array and `tableType` is not "none", set

Otherwise, if `valueToDecode` is a byte array and `tableType` is not "none", set

TallTed · 2025-01-06T22:09:28Z

index.html

+ERR_NON_CBOR_LD_TAG error.
+          </li>
+          <li>
+Otherwise if the CBOR tag on `cborldBytes` is in the range `0x0600`-`0x067F`, set `registryEntryId` to


Suggested change

Otherwise if the CBOR tag on `cborldBytes` is in the range `0x0600`-`0x067F`, set `registryEntryId` to

Otherwise, if the CBOR tag on `cborldBytes` is in the range `0x0600`-`0x067F`, set `registryEntryId` to

TallTed requested changes Aug 28, 2024

View reviewed changes

wes-smith force-pushed the update-algorithms branch from 1a91a6c to 48e5a18 Compare January 6, 2025 01:17

wes-smith added 28 commits January 5, 2025 20:23

Restructure algorithms section.

067e1b7

Add decompression tag processing algorithm.

7350021

Restructure algorithms section, add stub for decompression alg.

b0f1a8d

Outline context processing algorithms section.

acd0db6

Add decompression convert outline.

30e2cca

Update compression algorithm.

97d0c19

Restructure algorithms section.

47d09b3

Add active context and context loader skeletons.

1d42103

Add initialize context loader algorithm.

108a69f

Add initialize active context algorithm.

9b98efe

Begin conversion algorithm, add skeletons for compressor and decompre…

da78fa7

…ssor algorithms.

Update active context handling in state map.

ad403c4

Add general conversion algorithm.

10ad50e

Finish general conversion algorithm.

daa4e54

Add embedded contexts algorithm.

185fa29

Add apply type scoped contexts algorithm.

74c734e

Add apply property scoped contexts algorithm.

726244b

Add descriptions, add revert term map algorithm.

7ea90f9

Update descriptions for Context Loading and Active Context algorithms.

544c7eb

Add load context algorithm, begin add context algorithm.

e9cd914

Finish adding add context algorithm.

039cadf

Begin compression context conversion algorithm, add context codec ske…

e8813dd

…letons.

Finish compression context conversion, add context encoder creation.

9779e70

Begin value encoder creation.

5001768

Begin update term map algorithm.

d2b7e55

Finish update term map algorithm.

1c07a0d

Finish value encoder creation algorithm.

4c2395f

Add value encoding algorithm.

32c90ba

wes-smith added 13 commits January 5, 2025 20:23

Add value decoder creation algorithm.

a650947

Add context encode, value decode algorithms.

f8be88e

Add context decoder creation, decode algorithms.

e9f5f87

Move and update tag processing algorithms.

4da8383

Add compression value conversion and get input entries algorithms.

9ff43e5

Add get object types for compression algorithm.

aa0fc3d

Add context conversion for decompression algorithm.

450dc8e

Add value convert for decompression algorithm.

de2e9d0

Add get input entries for decompression algorithm.

7293519

Add get object types for decompression algorithm.

7f40e48

Add general value conversion algorithm.

db7308c

Update tag processing algorithms, add top-level algs.

4f0f216

Remove deprecated content.

848b34a

wes-smith force-pushed the update-algorithms branch from 48e5a18 to 848b34a Compare January 6, 2025 01:24

wes-smith marked this pull request as ready for review January 6, 2025 01:25

dlongley approved these changes Jan 6, 2025

View reviewed changes

dlongley reviewed Jan 6, 2025

View reviewed changes

Add minor grammar and markup fixes.

45da22c

From @TallTed. Co-authored-by: Ted Thibodeau Jr <[email protected]>

dlongley requested a review from TallTed January 6, 2025 15:48

Add markup fix to range expression.

3865d8b

TallTed requested changes Jan 6, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Update algorithms to use new processing model. #30

Update algorithms to use new processing model. #30

wes-smith commented Aug 27, 2024 •

edited by pr-preview bot

Loading

TallTed Aug 28, 2024

TallTed Aug 28, 2024

TallTed Aug 28, 2024

TallTed Aug 28, 2024

TallTed Aug 28, 2024

TallTed Aug 28, 2024

TallTed Aug 28, 2024

TallTed Aug 28, 2024

TallTed Aug 28, 2024

dlongley left a comment

dlongley commented Jan 6, 2025

wes-smith commented Jan 6, 2025

TallTed left a comment

TallTed Jan 6, 2025

TallTed Jan 6, 2025

TallTed Jan 6, 2025

TallTed Jan 6, 2025

TallTed Jan 6, 2025

TallTed Jan 6, 2025

TallTed Jan 6, 2025

TallTed Jan 6, 2025

TallTed Jan 6, 2025

TallTed Jan 6, 2025

	This algorithm takes a map `typeTable` and an array of JSON-LD contexts `contexts` and
	This algorithm takes a map `typeTable` and an array of JSON-LD contexts `contexts` as inputs, and

	every entry at the top level (i.e. ignoring type and property-scoped contexts).
	every entry at the top level (i.e., ignoring type- and property-scoped contexts).

	document to `typeTable`. If "callerProvidedTable" appears in contextTables, populate `typeTables`
	document to `typeTable`. If "callerProvidedTable" appears in `contextTables`, populate `typeTables`

	This algorithm takes a CBOR-LD payload `cborldBytes` as input and returns
	This algorithm takes a CBOR-LD payload `cborldBytes` as input, and returns

	ERR_INVALID_VARINT_VALUE error.
	`ERR_INVALID_VARINT_VALUE` error.

	This algorithm takes as input CBOR-LD payload `cborldBytes` and a map `typeTable` and returns a JSON-LD document.
	This algorithm takes a CBOR-LD payload `cborldBytes` and a map `typeTable` as inputs, and returns a JSON-LD document.

	For each entry `type`: `map` in the `typeTables` array in the CBOR-LD Varint Registry Entry
	For each entry <em>`type`: `map`</em> in the `typeTables` array in the CBOR-LD Varint Registry Entry

	maps `inputDocuments` and returns a map containing a map `state` and a map or
	maps `inputDocuments`, and returns a map containing a map `state` and a map or

	This algorithm takes maps `state` and `termInfo` and values `valueToEncode` and `termType`
	This algorithm takes maps `state` and `termInfo`, and values `valueToEncode` and `termType`,

	This algorithm takes maps `state`, `activeContext`, and `input` and returns a map `state` and an array `entries`.
	This algorithm takes maps `state`, `activeContext`, and `input`, and returns a map `state` and an array `entries`.

	This algorithm takes maps `activeContext` and `input` and returns a set
	This algorithm takes maps `activeContext` and `input`, and returns a set

	Set `varintTagValue` to `varintArray[0]` appended to the end of the bytes 0xD906.
	Set `varintTagValue` to `varintArray[0]` appended to the end of the bytes `0xD906`.

	to the end of the bytes 0x82.
	to the end of the bytes `0x82`.

	Otherwise if `valueToDecode` is an integer and `state`.`typesEncodedAsBytes` does not
	Otherwise, if `valueToDecode` is an integer and `state`.`typesEncodedAsBytes` does not

	Otherwise if `valueToDecode` is a byte array and `tableType` is not "none", set
	Otherwise, if `valueToDecode` is a byte array and `tableType` is not "none", set

	Otherwise if the CBOR tag on `cborldBytes` is in the range `0x0600`-`0x067F`, set `registryEntryId` to
	Otherwise, if the CBOR tag on `cborldBytes` is in the range `0x0600`-`0x067F`, set `registryEntryId` to

Update algorithms to use new processing model. #30

Are you sure you want to change the base?

Update algorithms to use new processing model. #30

Conversation

wes-smith commented Aug 27, 2024 • edited by pr-preview bot Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

dlongley left a comment

Choose a reason for hiding this comment

dlongley commented Jan 6, 2025

wes-smith commented Jan 6, 2025

TallTed left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

wes-smith commented Aug 27, 2024 •

edited by pr-preview bot

Loading