hendrik/lens
1
0
Fork 0
mirror of https://github.com/lensapp/lens.git synced 2025-05-20 05:10:56 +00:00
Code Issues Projects Releases Wiki Activity

Require messages for MessageChannels be JsonValues for serialization

Browse Source 
Co-authored-by: Janne Savolainen <janne.savolainen@live.fi>

Signed-off-by: Iku-turso <mikko.aspiala@gmail.com>
This commit is contained in:
Iku-turso 2022-05-30 13:01:11 +03:00
parent 81db46f69c
commit c156dcf4ae
10 changed files with 20 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
src/common/application-update/application-update-status-channel.injectable.ts
View File

@ -3,6 +3,7 @@
* Licensed under MIT License. See LICENSE in root directory for more information.
*/
import { getInjectable } from "@ogre-tools/injectable";
import type { JsonObject } from "type-fest";
import type { MessageChannel } from "../channel/message-channel-injection-token";
import { messageChannelInjectionToken } from "../channel/message-channel-injection-token";
@ -12,7 +13,7 @@ export type ApplicationUpdateStatusEventId =
| "download-for-update-started"
| "download-for-update-failed";
export interface ApplicationUpdateStatusChannelMessage { eventId: ApplicationUpdateStatusEventId; version?: string }
export interface ApplicationUpdateStatusChannelMessage extends JsonObject { eventId: ApplicationUpdateStatusEventId; version?: string }
export type ApplicationUpdateStatusChannel = MessageChannel<ApplicationUpdateStatusChannelMessage>;
const applicationUpdateStatusChannelInjectable = getInjectable({

3
src/common/ask-boolean/ask-boolean-question-channel.injectable.ts
View File

@ -3,10 +3,11 @@
* Licensed under MIT License. See LICENSE in root directory for more information.
*/
import { getInjectable } from "@ogre-tools/injectable";
import type { JsonObject } from "type-fest";
import type { MessageChannel } from "../channel/message-channel-injection-token";
import { messageChannelInjectionToken } from "../channel/message-channel-injection-token";
export interface AskBooleanQuestionParameters { id: string; title: string; question: string }
export interface AskBooleanQuestionParameters extends JsonObject { id: string; title: string; question: string }
export type AskBooleanQuestionChannel = MessageChannel<AskBooleanQuestionParameters>;
const askBooleanQuestionChannelInjectable = getInjectable({

2
src/common/channel/enlist-message-channel-listener-injection-token.ts
View File

@ -7,7 +7,7 @@ import type { MessageChannel } from "./message-channel-injection-token";
import type { MessageChannelListener } from "./message-channel-listener-injection-token";
export type EnlistMessageChannelListener = <
TChannel extends MessageChannel<unknown>,
TChannel extends MessageChannel<any>,
>(listener: MessageChannelListener<TChannel>) => () => void;
export const enlistMessageChannelListenerInjectionToken =

3
src/common/channel/message-channel-injection-token.ts
View File

@ -4,8 +4,9 @@
*/
import { getInjectionToken } from "@ogre-tools/injectable";
import type { JsonValue } from "type-fest";
export interface MessageChannel<Message = void> {
export interface MessageChannel<Message extends JsonValue | void = void> {
id: string;
_messageSignature?: Message;
}

5
src/common/channel/message-to-channel-injection-token.ts
View File

@ -3,6 +3,7 @@
* Licensed under MIT License. See LICENSE in root directory for more information.
*/
import { getInjectionToken } from "@ogre-tools/injectable";
import type { SetRequired } from "type-fest";
import type { MessageChannel } from "./message-channel-injection-token";
export interface MessageToChannel {
@ -10,9 +11,9 @@ export interface MessageToChannel {
channel: TChannel,
): void;
<TChannel extends MessageChannel<TMessage>, TMessage>(
<TChannel extends MessageChannel<any>>(
channel: TChannel,
message: TMessage
message: SetRequired<TChannel, "_messageSignature">["_messageSignature"],
): void;
}

2
src/main/channel/message-to-channel.injectable.ts
View File

@ -17,7 +17,7 @@ const messageToChannelInjectable = getInjectable({
// TODO: Figure out way to improve typing in internals
// Notice that this should be injected using "messageToChannelInjectionToken" which is typed correctly.
return (channel: MessageChannel<unknown>, message?: unknown) => {
return (channel: MessageChannel<any>, message?: unknown) => {
const visibleWindows = pipeline(
getAllLensWindows(),
filter((lensWindow) => !!lensWindow.visible),

2
src/renderer/channel/message-to-channel.injectable.ts
View File

@ -15,7 +15,7 @@ const messageToChannelInjectable = getInjectable({
// TODO: Figure out way to improve typing in internals
// Notice that this should be injected using "messageToChannelInjectionToken" which is typed correctly.
return (channel: MessageChannel<unknown>, message?: unknown) => {
return (channel: MessageChannel<any>, message?: unknown) => {
sendToMain(channel.id, message);
};
},

3
src/renderer/channel/send-to-main.injectable.ts
View File

@ -3,6 +3,7 @@
* Licensed under MIT License. See LICENSE in root directory for more information.
*/
import { getInjectable } from "@ogre-tools/injectable";
import type { JsonValue } from "type-fest";
import ipcRendererInjectable from "./ipc-renderer.injectable";
const sendToMainInjectable = getInjectable({
@ -12,7 +13,7 @@ const sendToMainInjectable = getInjectable({
const ipcRenderer = di.inject(ipcRendererInjectable);
// TODO: Figure out way to improve typing in internals
return (channelId: string, message: any) => {
return <T>(channelId: string, message: JsonValue extends T ? T : never ) => {
ipcRenderer.send(channelId, ...(message ? [message] : []));
};
},

6
src/test-utils/channel-fakes/override-messaging-from-main-to-window.ts
View File

@ -13,7 +13,7 @@ import assert from "assert";
export const overrideMessagingFromMainToWindow = (mainDi: DiContainer) => {
const messageChannelListenerFakesForRenderer = new Map<
string,
Set<MessageChannelListener<MessageChannel<unknown>>>
Set<MessageChannelListener<MessageChannel<any>>>
>();
mainDi.override(
@ -73,14 +73,14 @@ export const overrideMessagingFromMainToWindow = (mainDi: DiContainer) => {
// TODO: Figure out typing
listeners.add(
listener as unknown as MessageChannelListener<MessageChannel<unknown>>,
listener as unknown as MessageChannelListener<MessageChannel<any>>,
);
return () => {
// TODO: Figure out typing
listeners.delete(
listener as unknown as MessageChannelListener<
MessageChannel<unknown>
MessageChannel<any>
>,
);
};

6
src/test-utils/channel-fakes/override-messaging-from-window-to-main.ts
View File

@ -12,7 +12,7 @@ import sendToMainInjectable from "../../renderer/channel/send-to-main.injectable
export const overrideMessagingFromWindowToMain = (mainDi: DiContainer) => {
const messageChannelListenerFakesForMain = new Map<
string,
Set<MessageChannelListener<MessageChannel<unknown>>>
Set<MessageChannelListener<MessageChannel<any>>>
>();
mainDi.override(
@ -33,13 +33,13 @@ export const overrideMessagingFromWindowToMain = (mainDi: DiContainer) => {
// TODO: Figure out typing
listeners.add(
listener as unknown as MessageChannelListener<MessageChannel<unknown>>,
listener as unknown as MessageChannelListener<MessageChannel<any>>,
);
return () => {
// TODO: Figure out typing
listeners.delete(
listener as unknown as MessageChannelListener<MessageChannel<unknown>>,
listener as unknown as MessageChannelListener<MessageChannel<any>>,
);
};
},