Skip to content

fix(decode): preserve mapKeyConverter in Decoder#clone() #295

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
maximilliangrand wants to merge 1 commit into
base: main
Choose a base branch
from
+28 −0
Open

fix(decode): preserve mapKeyConverter in Decoder#clone() #295

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions src/Decoder.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -264,6 +264,7 @@ export class Decoder<ContextType = undefined> {
maxMapLength: this.maxMapLength,
maxExtLength: this.maxExtLength,
keyDecoder: this.keyDecoder,
mapKeyConverter: this.mapKeyConverter,
} as any);
}

Expand Down
27 changes: 27 additions & 0 deletions test/reuse-instances-with-extensions.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,4 +45,31 @@ describe("reuse instances with extensions", () => {
const data = context.decode(buf);
deepStrictEqual(data, [BigInt(1), BigInt(2), BigInt(3)]);
});

it("keeps mapKeyConverter for maps decoded re-entrantly inside an extension", () => {
const MSGPACK_EXT_TYPE_WRAP = 1;
const extensionCodec = new ExtensionCodec();
const encoder = new Encoder({ extensionCodec });
const decoder = new Decoder({ extensionCodec, mapKeyConverter: (key) => String(key).toUpperCase() });

class Wrapped {
readonly inner: unknown;
constructor(inner: unknown) {
this.inner = inner;
}
}
extensionCodec.register({
type: MSGPACK_EXT_TYPE_WRAP,
encode: (value) => (value instanceof Wrapped ? encoder.encode(value.inner) : null),
// decode re-enters the same decoder instance, which triggers Decoder#clone()
decode: (data) => new Wrapped(decoder.decode(data)),
});

const buf = encoder.encode({ a: 1, nested: new Wrapped({ b: 2 }) });
const decoded = decoder.decode(buf) as Record<string, Wrapped>;

// The nested map is decoded on the cloned decoder; it must use the same converter.
deepStrictEqual(Object.keys(decoded), ["A", "NESTED"]);
deepStrictEqual(decoded["NESTED"]!.inner, { B: 2 });
});
});