1
0
mirror of https://github.com/bitwarden/browser.git synced 2024-11-16 10:45:20 +01:00

[EC-598] feat: add initial one-way support for aborting

This commit is contained in:
Andreas Coroiu 2023-01-27 15:38:01 +01:00
parent 18dbaf2a4e
commit 3c5900250d
No known key found for this signature in database
GPG Key ID: E70B5FFC81DFEC1A
3 changed files with 85 additions and 27 deletions

View File

@ -40,10 +40,12 @@ export type CredentialGetResponse = {
export type AbortRequest = {
type: MessageType.AbortRequest;
abortedRequestId: string;
};
export type AbortResponse = {
type: MessageType.AbortResponse;
abortedRequestId: string;
};
export type Message =

View File

@ -18,8 +18,8 @@ describe("Messenger", () => {
handlerA = new TestMessageHandler();
handlerB = new TestMessageHandler();
messengerA.addHandler(handlerA.handler);
messengerB.addHandler(handlerB.handler);
messengerA.handler = handlerA.handler;
messengerB.handler = handlerB.handler;
});
it("should deliver message to B when sending request from A", () => {
@ -43,6 +43,25 @@ describe("Messenger", () => {
expect(returned).toMatchObject(response);
});
it("should deliver abort signal to B when requesting abort", () => {
const abortController = new AbortController();
messengerA.request(createRequest(), abortController);
abortController.abort();
const received = handlerB.recieve();
expect(received[0].abortController.signal.aborted).toBe(true);
});
it.skip("should abort request and throw error when abort is requested from A", () => {
const abortController = new AbortController();
const requestPromise = messengerA.request(createRequest(), abortController);
abortController.abort();
expect(requestPromise).toThrow();
});
});
type TestMessage = Message & { testId: string };
@ -78,16 +97,23 @@ class TestChannelPair {
}
class TestMessageHandler {
readonly handler: (message: TestMessage) => Promise<Message | undefined>;
readonly handler: (
message: TestMessage,
abortController?: AbortController
) => Promise<Message | undefined>;
private recievedMessages: { message: TestMessage; respond: (response: TestMessage) => void }[] =
[];
private recievedMessages: {
message: TestMessage;
respond: (response: TestMessage) => void;
abortController?: AbortController;
}[] = [];
constructor() {
this.handler = (message) =>
this.handler = (message, abortController) =>
new Promise((resolve, reject) => {
this.recievedMessages.push({
message,
abortController,
respond: (response) => resolve(response),
});
});

View File

@ -1,6 +1,6 @@
import { concatMap, filter, firstValueFrom, Observable } from "rxjs";
import { Message } from "./message";
import { Message, MessageType } from "./message";
type PostMessageFunction = (message: MessageWithMetadata) => void;
@ -11,6 +11,10 @@ export type Channel = {
export type Metadata = { requestId: string };
export type MessageWithMetadata = Message & { metadata: Metadata };
type Handler = (
message: Message,
abortController?: AbortController
) => Promise<Message | undefined>;
// TODO: This class probably duplicates functionality but I'm not especially familiar with
// the inner workings of the browser extension yet.
@ -32,9 +36,42 @@ export class Messenger {
});
}
constructor(private channel: Channel) {}
handler?: Handler;
abortControllers = new Map<string, AbortController>();
request(request: Message): Promise<Message> {
constructor(private channel: Channel) {
this.channel.messages$
.pipe(
concatMap(async (message) => {
if (this.handler === undefined) {
return;
}
const abortController = new AbortController();
this.abortControllers.set(message.metadata.requestId, abortController);
const handlerResponse = await this.handler(message, abortController);
this.abortControllers.delete(message.metadata.requestId);
if (handlerResponse === undefined) {
return;
}
const metadata: Metadata = { requestId: message.metadata.requestId };
this.channel.postMessage({ ...handlerResponse, metadata });
})
)
.subscribe();
this.channel.messages$.subscribe((message) => {
if (message.type !== MessageType.AbortRequest) {
return;
}
this.abortControllers.get(message.abortedRequestId)?.abort();
});
}
request(request: Message, abortController?: AbortController): Promise<Message> {
const requestId = Date.now().toString();
const metadata: Metadata = { requestId };
@ -46,25 +83,18 @@ export class Messenger {
)
);
const abortListener = () =>
this.channel.postMessage({
metadata: { requestId: `${requestId}-abort` },
type: MessageType.AbortRequest,
abortedRequestId: requestId,
});
abortController?.signal.addEventListener("abort", abortListener);
this.channel.postMessage({ ...request, metadata });
return promise;
}
addHandler(handler: (message: Message) => Promise<Message | undefined>) {
this.channel.messages$
.pipe(
concatMap(async (message) => {
const handlerResponse = await handler(message);
if (handlerResponse === undefined) {
return;
}
const metadata: Metadata = { requestId: message.metadata.requestId };
this.channel.postMessage({ ...handlerResponse, metadata });
})
)
.subscribe();
return promise.finally(() =>
abortController?.signal.removeEventListener("abort", abortListener)
);
}
}