Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
14 changes: 11 additions & 3 deletions src/comlink.ts
Original file line number Diff line number Diff line change
Expand Up @@ -380,7 +380,7 @@ export function expose(
.catch((error) => {
// Send Serialization Error To Caller
const [wireValue, transferables] = toWireValue({
value: new TypeError("Unserializable return value"),
value: new TypeError(getUnserializableErrorMessage(error)),
[throwMarker]: 0,
});
ep.postMessage({ ...wireValue, id }, transferables);
Expand All @@ -399,8 +399,16 @@ function closeEndPoint(endpoint: Endpoint) {
if (isMessagePort(endpoint)) endpoint.close();
}

function getUnserializableErrorMessage(error: unknown) {
const details = error instanceof Error ? error.message : String(error);

return details
? `Unserializable return value: ${details}`
: "Unserializable return value";
}

export function wrap<T>(ep: Endpoint, target?: any): Remote<T> {
const pendingListeners : PendingListenersMap = new Map();
const pendingListeners: PendingListenersMap = new Map();

ep.addEventListener("message", function handleMessage(ev: Event) {
const { data } = ev as MessageEvent;
Expand Down Expand Up @@ -643,7 +651,7 @@ function requestResponseMessage(
ep.start();
}
ep.postMessage({ id, ...msg }, transfers);
});
});
}

function generateUUID(): string {
Expand Down
32 changes: 31 additions & 1 deletion tests/same_window.comlink.test.js
Original file line number Diff line number Diff line change
Expand Up @@ -645,7 +645,37 @@ describe("Comlink in the same realm", function () {
try {
await thing.value;
} catch (err) {
expect(err.message).to.equal("Unserializable return value");
expect(err.message).to.contain("Unserializable return value");
}
});

it("includes serialization error details for unserializable return values", async function () {
const transferHandlerName = "throwing-test";
Comlink.transferHandlers.set(transferHandlerName, {
canHandle(value) {
return value && value.throwOnSerialize === true;
},
serialize() {
throw new Error("custom serialization failed");
},
deserialize() {},
});

try {
const thing = Comlink.wrap(this.port1, { value: {} });
Comlink.expose({ value: { throwOnSerialize: true } }, this.port2);

try {
await thing.value;
throw "Should have thrown";
} catch (err) {
expect(err).to.not.equal("Should have thrown");
expect(err.message).to.equal(
"Unserializable return value: custom serialization failed"
);
}
} finally {
Comlink.transferHandlers.delete(transferHandlerName);
}
});
});
Expand Down