Skip to content

Commit

Permalink
fixup: review suggestions
Browse files Browse the repository at this point in the history
  • Loading branch information
erights committed Apr 14, 2024
1 parent 0fa60ec commit c2a3302
Show file tree
Hide file tree
Showing 7 changed files with 104 additions and 91 deletions.
2 changes: 1 addition & 1 deletion packages/marshal/NEWS.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ User-visible changes in `@endo/marshal`:

# Next release

- JavaScript's relational comparison operators like `<` compare strings by lexicographic UTF16 code unit order, which is exposes an internal representational detail not relevant to the string's meaning as a Unicode string. Previously, `compareRank` and associated functions compared strings using this JavaScript-native comparison. Now `compareRank` and associated functions compare strings by lexicographic Unicode Code Point order. ***This change only affects strings containing so-called supplementary characters, i.e., those whose Unicode character code does not fit in 16 bits***.
- JavaScript's relational comparison operators like `<` compare strings by lexicographic UTF16 code unit order, which exposes an internal representational detail not relevant to the string's meaning as a Unicode string. Previously, `compareRank` and associated functions compared strings using this JavaScript-native comparison. Now `compareRank` and associated functions compare strings by lexicographic Unicode Code Point order. ***This change only affects strings containing so-called supplementary characters, i.e., those whose Unicode character code does not fit in 16 bits***.
- This release does not change the `encodePassable` encoding. But now, when we say it is order preserving, we need to be careful about which order we mean. `encodePassable` is rank-order preserving when the encoded strings are compared using `compareRank`.
- The key order of strings defined by the @endo/patterns module is still defined to be the same as the rank ordering of those strings. So this release changes key order among strings to also be lexicographic comparison of Unicode Code Points. To accommodate this change, you may need to adapt applications that relied on key-order being the same as JS native order. This could include the use of any patterns expressing key inequality tests, like `M.gte(string)`.
- These string ordering changes brings Endo into conformance with any string ordering components of the OCapN standard.
Expand Down
2 changes: 1 addition & 1 deletion packages/marshal/src/rankOrder.js
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ import {

/**
* @import {Passable, PassStyle} from '@endo/pass-style'
* @import {FullCompare, RankCompare, RankCover} from './types.js'
* @import {FullCompare, RankCompare, RankCover, RankComparison} from './types.js'
*/

const { entries, fromEntries, setPrototypeOf, is } = Object;
Expand Down
87 changes: 87 additions & 0 deletions packages/marshal/test/encodePassable-for-testing.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,87 @@
/* eslint-disable no-bitwise, @endo/restrict-comparison-operands */
import { Fail, q } from '@endo/errors';

import {
makeEncodePassable,
makeDecodePassable,
} from '../src/encodePassable.js';
import { compareRank, makeComparatorKit } from '../src/rankOrder.js';

const buffers = {
__proto__: null,
r: [],
'?': [],
'!': [],
};
const resetBuffers = () => {
buffers.r = [];
buffers['?'] = [];
buffers['!'] = [];
};
const cursors = {
__proto__: null,
r: 0,
'?': 0,
'!': 0,
};
const resetCursors = () => {
cursors.r = 0;
cursors['?'] = 0;
cursors['!'] = 0;
};

const encodeThing = (prefix, r) => {
buffers[prefix].push(r);
// With this encoding, all things with the same prefix have the same rank
return prefix;
};

const decodeThing = (prefix, e) => {
prefix === e ||
Fail`expected encoding ${q(e)} to simply be the prefix ${q(prefix)}`;
(cursors[prefix] >= 0 && cursors[prefix] < buffers[prefix].length) ||
Fail`while decoding ${q(e)}, expected cursors[${q(prefix)}], i.e., ${q(
cursors[prefix],
)} <= ${q(buffers[prefix].length)}`;
const thing = buffers[prefix][cursors[prefix]];
cursors[prefix] += 1;
return thing;
};

const encodePassableInternal = makeEncodePassable({
encodeRemotable: r => encodeThing('r', r),
encodePromise: p => encodeThing('?', p),
encodeError: er => encodeThing('!', er),
});

export const encodePassableInternal2 = makeEncodePassable({
encodeRemotable: r => encodeThing('r', r),
encodePromise: p => encodeThing('?', p),
encodeError: er => encodeThing('!', er),
format: 'compactOrdered',
});

export const encodePassable = passable => {
resetBuffers();
return encodePassableInternal(passable);
};

export const encodePassable2 = passable => {
resetBuffers();
return encodePassableInternal2(passable);
};
export const decodePassableInternal = makeDecodePassable({
decodeRemotable: e => decodeThing('r', e),
decodePromise: e => decodeThing('?', e),
decodeError: e => decodeThing('!', e),
});

export const decodePassable = encoded => {
resetCursors();
return decodePassableInternal(encoded);
};

const compareRemotables = (x, y) =>
compareRank(encodeThing('r', x), encodeThing('r', y));

export const { comparator: compareFull } = makeComparatorKit(compareRemotables);
95 changes: 11 additions & 84 deletions packages/marshal/test/test-encodePassable.js
Original file line number Diff line number Diff line change
Expand Up @@ -5,91 +5,20 @@ import test from '@endo/ses-ava/prepare-endo.js';
import { fc } from '@fast-check/ava';
import { Remotable } from '@endo/pass-style';
import { arbPassable } from '@endo/pass-style/tools.js';
import { Fail, q } from '@endo/errors';
import { Fail } from '@endo/errors';

import {
makePassableKit,
makeEncodePassable,
makeDecodePassable,
} from '../src/encodePassable.js';
import { compareRank, makeComparatorKit } from '../src/rankOrder.js';
import { makePassableKit, makeEncodePassable } from '../src/encodePassable.js';
import { compareRank } from '../src/rankOrder.js';
import { unsortedSample } from './marshal-test-data.js';

const buffers = {
__proto__: null,
r: [],
'?': [],
'!': [],
};
const resetBuffers = () => {
buffers.r = [];
buffers['?'] = [];
buffers['!'] = [];
};
const cursors = {
__proto__: null,
r: 0,
'?': 0,
'!': 0,
};
const resetCursors = () => {
cursors.r = 0;
cursors['?'] = 0;
cursors['!'] = 0;
};

const encodeThing = (prefix, r) => {
buffers[prefix].push(r);
// With this encoding, all things with the same prefix have the same rank
return prefix;
};

const decodeThing = (prefix, e) => {
prefix === e ||
Fail`expected encoding ${q(e)} to simply be the prefix ${q(prefix)}`;
(cursors[prefix] >= 0 && cursors[prefix] < buffers[prefix].length) ||
Fail`while decoding ${q(e)}, expected cursors[${q(prefix)}], i.e., ${q(
cursors[prefix],
)} <= ${q(buffers[prefix].length)}`;
const thing = buffers[prefix][cursors[prefix]];
cursors[prefix] += 1;
return thing;
};

const compareRemotables = (x, y) =>
compareRank(encodeThing('r', x), encodeThing('r', y));

const encodePassableInternal = makeEncodePassable({
encodeRemotable: r => encodeThing('r', r),
encodePromise: p => encodeThing('?', p),
encodeError: er => encodeThing('!', er),
});
const encodePassableInternal2 = makeEncodePassable({
encodeRemotable: r => encodeThing('r', r),
encodePromise: p => encodeThing('?', p),
encodeError: er => encodeThing('!', er),
format: 'compactOrdered',
});

export const encodePassable = passable => {
resetBuffers();
return encodePassableInternal(passable);
};
const encodePassable2 = passable => {
resetBuffers();
return encodePassableInternal2(passable);
};

const decodePassableInternal = makeDecodePassable({
decodeRemotable: e => decodeThing('r', e),
decodePromise: e => decodeThing('?', e),
decodeError: e => decodeThing('!', e),
});

export const decodePassable = encoded => {
resetCursors();
return decodePassableInternal(encoded);
};
import {
encodePassable,
encodePassable2,
encodePassableInternal2,
decodePassable,
decodePassableInternal,
compareFull,
} from './encodePassable-for-testing.js';

test('makePassableKit output shape', t => {
const kit = makePassableKit();
Expand Down Expand Up @@ -133,8 +62,6 @@ test(
(...args) => makePassableKit(...args).encodePassable,
);

const { comparator: compareFull } = makeComparatorKit(compareRemotables);

const asNumber = new Float64Array(1);
const asBits = new BigUint64Array(asNumber.buffer);
const getNaN = (hexEncoding = '0008000000000000') => {
Expand Down
4 changes: 2 additions & 2 deletions packages/marshal/test/test-string-rank-order.js
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
import { test } from './prepare-test-env-ava.js';
import test from '@endo/ses-ava/prepare-endo.js';

import { compareRank } from '../src/rankOrder.js';
import { encodePassable } from './test-encodePassable.js';
import { encodePassable } from './encodePassable-for-testing.js';

/**
* Essentially a ponyfill for Array.prototype.toSorted, for use before
Expand Down
2 changes: 1 addition & 1 deletion packages/patterns/NEWS.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ User-visible changes in `@endo/patterns`:

# Next release

- JavaScript's relational comparison operators like `<` compare strings by lexicographic UTF16 code unit order, which is exposes an internal representational detail not relevant to the string's meaning as a Unicode string. Previously, `compareKeys` and associated functions compared strings using this JavaScript-native comparison. Now `compareKeys` and associated functions compare strings by lexicographic Unicode Code Point order. ***This change only affects strings containing so-called supplementary characters, i.e., those whose Unicode character code does not fit in 16 bits***.
- JavaScript's relational comparison operators like `<` compare strings by lexicographic UTF16 code unit order, which exposes an internal representational detail not relevant to the string's meaning as a Unicode string. Previously, `compareKeys` and associated functions compared strings using this JavaScript-native comparison. Now `compareKeys` and associated functions compare strings by lexicographic Unicode Code Point order. ***This change only affects strings containing so-called supplementary characters, i.e., those whose Unicode character code does not fit in 16 bits***.
- See the NEWS.md of @endo/marshal for more on this change.

# v1.2.0 (2024-02-22)
Expand Down
3 changes: 1 addition & 2 deletions packages/patterns/test/test-string-key-order.js
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
// modeled on test-string-rank-order.js

import { test } from './prepare-test-env-ava.js';
import test from '@endo/ses-ava/prepare-endo.js';

import { compareKeys } from '../src/keys/compareKeys.js';

Expand Down

0 comments on commit c2a3302

Please sign in to comment.