refactor: using enum for message channel (#484)

axel7083 · web-flow · commit 40d97c304346 · 2024-03-11T16:03:33.000Z
* refactor: using enum for message channel

Signed-off-by: axel7083 &lt;42176370+axel7083@users.noreply.github.com&gt;

* refactor: rename MESSAGES to Messages

Signed-off-by: axel7083 &lt;42176370+axel7083@users.noreply.github.com&gt;

* fix: rebase with proper enum message

Signed-off-by: axel7083 &lt;42176370+axel7083@users.noreply.github.com&gt;

---------

Signed-off-by: axel7083 &lt;42176370+axel7083@users.noreply.github.com&gt;
diff --git a/packages/backend/src/managers/applicationManager.ts b/packages/backend/src/managers/applicationManager.ts
@@ -40,7 +40,7 @@ import type { LocalRepositoryRegistry } from '../registries/LocalRepositoryRegis
 import { LABEL_MODEL_ID, LABEL_MODEL_PORTS } from './playground';
 import type { ApplicationState } from '@shared/src/models/IApplicationState';
 import type { PodmanConnection } from './podmanConnection';
-import { MSG_APPLICATIONS_STATE_UPDATE } from '@shared/Messages';
+import { Messages } from '@shared/Messages';
 import type { CatalogManager } from './catalogManager';
 import { ApplicationRegistry } from '../registries/ApplicationRegistry';
 import type { TaskRegistry } from '../registries/TaskRegistry';
@@ -91,7 +91,7 @@ export class ApplicationManager extends Publisher<ApplicationState[]> {
     private telemetry: TelemetryLogger,
     private localRepositories: LocalRepositoryRegistry,
   ) {
-    super(webview, MSG_APPLICATIONS_STATE_UPDATE, () => this.getApplicationsState());
+    super(webview, Messages.MSG_APPLICATIONS_STATE_UPDATE, () => this.getApplicationsState());
     this.#applications = new ApplicationRegistry<ApplicationState>();
   }
 
diff --git a/packages/backend/src/managers/catalogManager.ts b/packages/backend/src/managers/catalogManager.ts
@@ -21,7 +21,7 @@ import path from 'node:path';
 import defaultCatalog from '../ai.json';
 import type { Recipe } from '@shared/src/models/IRecipe';
 import type { ModelInfo } from '@shared/src/models/IModelInfo';
-import { MSG_NEW_CATALOG_STATE } from '@shared/Messages';
+import { Messages } from '@shared/Messages';
 import { type Disposable, type Webview } from '@podman-desktop/api';
 import { JsonWatcher } from '../utils/JsonWatcher';
 import { Publisher } from '../utils/Publisher';
@@ -34,7 +34,7 @@ export class CatalogManager extends Publisher<Catalog> implements Disposable {
     webview: Webview,
     private appUserDirectory: string,
   ) {
-    super(webview, MSG_NEW_CATALOG_STATE, () => this.getCatalog());
+    super(webview, Messages.MSG_NEW_CATALOG_STATE, () => this.getCatalog());
     // We start with an empty catalog, for the methods to work before the catalog is loaded
     this.catalog = {
       categories: [],
diff --git a/packages/backend/src/managers/inference/inferenceManager.ts b/packages/backend/src/managers/inference/inferenceManager.ts
@@ -33,7 +33,7 @@ import {
   LABEL_INFERENCE_SERVER,
 } from '../../utils/inferenceUtils';
 import { Publisher } from '../../utils/Publisher';
-import { MSG_INFERENCE_SERVERS_UPDATE } from '@shared/Messages';
+import { Messages } from '@shared/Messages';
 import type { InferenceServerConfig } from '@shared/src/models/InferenceServerConfig';
 import type { ModelsManager } from '../modelsManager';
 
@@ -52,7 +52,7 @@ export class InferenceManager extends Publisher<InferenceServer[]> implements Di
     private modelsManager: ModelsManager,
     private telemetry: TelemetryLogger,
   ) {
-    super(webview, MSG_INFERENCE_SERVERS_UPDATE, () => this.getServers());
+    super(webview, Messages.MSG_INFERENCE_SERVERS_UPDATE, () => this.getServers());
     this.#servers = new Map<string, InferenceServer>();
     this.#disposables = [];
     this.#initialized = false;
diff --git a/packages/backend/src/managers/modelsManager.ts b/packages/backend/src/managers/modelsManager.ts
@@ -20,7 +20,7 @@ import type { LocalModelInfo } from '@shared/src/models/ILocalModelInfo';
 import fs from 'fs';
 import * as path from 'node:path';
 import { type Webview, fs as apiFs, type Disposable } from '@podman-desktop/api';
-import { MSG_NEW_MODELS_STATE } from '@shared/Messages';
+import { Messages } from '@shared/Messages';
 import type { CatalogManager } from './catalogManager';
 import type { ModelInfo } from '@shared/src/models/IModelInfo';
 import * as podmanDesktopApi from '@podman-desktop/api';
@@ -75,7 +75,7 @@ export class ModelsManager implements Disposable {
   async sendModelsInfo() {
     const models = this.getModelsInfo();
     await this.webview.postMessage({
-      id: MSG_NEW_MODELS_STATE,
+      id: Messages.MSG_NEW_MODELS_STATE,
       body: models,
     });
   }
diff --git a/packages/backend/src/managers/playground.ts b/packages/backend/src/managers/playground.ts
@@ -28,7 +28,7 @@ import {
 import path from 'node:path';
 import { getFreePort } from '../utils/ports';
 import type { QueryState } from '@shared/src/models/IPlaygroundQueryState';
-import { MSG_NEW_PLAYGROUND_QUERIES_STATE, MSG_PLAYGROUNDS_STATE_UPDATE } from '@shared/Messages';
+import { Messages } from '@shared/Messages';
 import type { PlaygroundState, PlaygroundStatus } from '@shared/src/models/IPlaygroundState';
 import type { ContainerRegistry } from '../registries/ContainerRegistry';
 import type { PodmanConnection } from './podmanConnection';
@@ -144,7 +144,7 @@ export class PlayGroundManager {
   sendPlaygroundState() {
     this.webview
       .postMessage({
-        id: MSG_PLAYGROUNDS_STATE_UPDATE,
+        id: Messages.MSG_PLAYGROUNDS_STATE_UPDATE,
         body: this.getPlaygroundsState(),
       })
       .catch((err: unknown) => {
@@ -366,7 +366,7 @@ export class PlayGroundManager {
   sendQueriesState(): void {
     this.webview
       .postMessage({
-        id: MSG_NEW_PLAYGROUND_QUERIES_STATE,
+        id: Messages.MSG_NEW_PLAYGROUND_QUERIES_STATE,
         body: this.getQueriesState(),
       })
       .catch((err: unknown) => {
diff --git a/packages/backend/src/registries/LocalRepositoryRegistry.spec.ts b/packages/backend/src/registries/LocalRepositoryRegistry.spec.ts
@@ -17,7 +17,7 @@
  ***********************************************************************/
 import { beforeEach, expect, test, vi } from 'vitest';
 import { LocalRepositoryRegistry } from './LocalRepositoryRegistry';
-import { MSG_LOCAL_REPOSITORY_UPDATE } from '@shared/Messages';
+import { Messages } from '@shared/Messages';
 import type { Webview } from '@podman-desktop/api';
 
 const mocks = vi.hoisted(() => ({
@@ -51,7 +51,7 @@ test('should notify webview when register', () => {
   } as unknown as Webview);
   localRepositories.register({ path: 'random', labels: { 'recipe-id': 'random' } });
   expect(mocks.postMessageMock).toHaveBeenNthCalledWith(1, {
-    id: MSG_LOCAL_REPOSITORY_UPDATE,
+    id: Messages.MSG_LOCAL_REPOSITORY_UPDATE,
     body: [{ path: 'random', labels: { 'recipe-id': 'random' } }],
   });
 });
@@ -64,7 +64,7 @@ test('should notify webview when unregister', () => {
   localRepositories.unregister('random');
 
   expect(mocks.postMessageMock).toHaveBeenLastCalledWith({
-    id: MSG_LOCAL_REPOSITORY_UPDATE,
+    id: Messages.MSG_LOCAL_REPOSITORY_UPDATE,
     body: [],
   });
 });
diff --git a/packages/backend/src/registries/LocalRepositoryRegistry.ts b/packages/backend/src/registries/LocalRepositoryRegistry.ts
@@ -16,7 +16,7 @@
  * SPDX-License-Identifier: Apache-2.0
  ***********************************************************************/
 import type { LocalRepository } from '@shared/src/models/ILocalRepository';
-import { MSG_LOCAL_REPOSITORY_UPDATE } from '@shared/Messages';
+import { Messages } from '@shared/Messages';
 import { type Webview, Disposable } from '@podman-desktop/api';
 import { Publisher } from '../utils/Publisher';
 
@@ -28,7 +28,7 @@ export class LocalRepositoryRegistry extends Publisher<LocalRepository[]> {
   private repositories: Map<string, LocalRepository> = new Map();
 
   constructor(webview: Webview) {
-    super(webview, MSG_LOCAL_REPOSITORY_UPDATE, () => this.getLocalRepositories());
+    super(webview, Messages.MSG_LOCAL_REPOSITORY_UPDATE, () => this.getLocalRepositories());
   }
 
   register(localRepository: LocalRepository): Disposable {
diff --git a/packages/backend/src/registries/TaskRegistry.ts b/packages/backend/src/registries/TaskRegistry.ts
@@ -17,7 +17,7 @@
  ***********************************************************************/
 
 import type { Task, TaskState } from '@shared/src/models/ITask';
-import { MSG_TASKS_UPDATE } from '@shared/Messages';
+import { Messages } from '@shared/Messages';
 import type { Webview } from '@podman-desktop/api';
 
 /**
@@ -140,7 +140,7 @@ export class TaskRegistry {
   private notify() {
     this.webview
       .postMessage({
-        id: MSG_TASKS_UPDATE,
+        id: Messages.MSG_TASKS_UPDATE,
         body: this.getTasks(),
       })
       .catch((err: unknown) => {
diff --git a/packages/backend/src/utils/Publisher.spec.ts b/packages/backend/src/utils/Publisher.spec.ts
@@ -18,6 +18,7 @@
 import { expect, test, vi } from 'vitest';
 import { Publisher } from './Publisher';
 import type { Webview } from '@podman-desktop/api';
+import { Messages } from '@shared/Messages';
 
 test('ensure publisher properly use getter', async () => {
   const postMessageMock = vi.fn().mockResolvedValue(undefined);
@@ -26,14 +27,14 @@ test('ensure publisher properly use getter', async () => {
     {
       postMessage: postMessageMock,
     } as unknown as Webview,
-    'dummyChannel',
+    Messages.MSG_TASKS_UPDATE,
     getterMock,
   );
   publisher.notify();
 
   await vi.waitFor(() => {
     expect(postMessageMock).toHaveBeenCalledWith({
-      id: 'dummyChannel',
+      id: Messages.MSG_TASKS_UPDATE,
       body: 'dummyValue',
     });
   });
diff --git a/packages/backend/src/utils/Publisher.ts b/packages/backend/src/utils/Publisher.ts
@@ -16,11 +16,12 @@
  * SPDX-License-Identifier: Apache-2.0
  ***********************************************************************/
 import type { Webview } from '@podman-desktop/api';
+import type { Messages } from '@shared/Messages';
 
 export class Publisher<T> {
   constructor(
     private webview: Webview,
-    private channel: string,
+    private channel: Messages,
     private getter: () => T,
   ) {}
 
diff --git a/packages/frontend/src/stores/application-states.ts b/packages/frontend/src/stores/application-states.ts
@@ -18,12 +18,12 @@
 
 import type { Readable } from 'svelte/store';
 import { readable } from 'svelte/store';
-import { MSG_APPLICATIONS_STATE_UPDATE } from '@shared/Messages';
+import { Messages } from '@shared/Messages';
 import { rpcBrowser, studioClient } from '/@/utils/client';
 import type { ApplicationState } from '@shared/src/models/IApplicationState';
 
 export const applicationStates: Readable<ApplicationState[]> = readable<ApplicationState[]>([], set => {
-  const sub = rpcBrowser.subscribe(MSG_APPLICATIONS_STATE_UPDATE, msg => {
+  const sub = rpcBrowser.subscribe(Messages.MSG_APPLICATIONS_STATE_UPDATE, msg => {
     set(msg);
   });
   // Initialize the store manually
diff --git a/packages/frontend/src/stores/catalog.ts b/packages/frontend/src/stores/catalog.ts
@@ -18,7 +18,7 @@
 
 import type { Readable } from 'svelte/store';
 import { readable } from 'svelte/store';
-import { MSG_NEW_CATALOG_STATE } from '@shared/Messages';
+import { Messages } from '@shared/Messages';
 import { rpcBrowser, studioClient } from '/@/utils/client';
 import type { Catalog } from '@shared/src/models/ICatalog';
 
@@ -29,7 +29,7 @@ const emptyCatalog = {
 };
 
 export const catalog: Readable<Catalog> = readable<Catalog>(emptyCatalog, set => {
-  const sub = rpcBrowser.subscribe(MSG_NEW_CATALOG_STATE, msg => {
+  const sub = rpcBrowser.subscribe(Messages.MSG_NEW_CATALOG_STATE, msg => {
     set(msg);
   });
   // Initialize the store manually
diff --git a/packages/frontend/src/stores/localRepositories.ts b/packages/frontend/src/stores/localRepositories.ts
@@ -1,11 +1,11 @@
 import type { Readable } from 'svelte/store';
-import { MSG_LOCAL_REPOSITORY_UPDATE } from '@shared/Messages';
+import { Messages } from '@shared/Messages';
 import { studioClient } from '/@/utils/client';
 import type { LocalRepository } from '@shared/src/models/ILocalRepository';
 import { RPCReadable } from '/@/stores/rpcReadable';
 
 export const localRepositories: Readable<LocalRepository[]> = RPCReadable<LocalRepository[]>(
   [],
-  [MSG_LOCAL_REPOSITORY_UPDATE],
+  [Messages.MSG_LOCAL_REPOSITORY_UPDATE],
   studioClient.getLocalRepositories,
 );
diff --git a/packages/frontend/src/stores/modelsInfo.spec.ts b/packages/frontend/src/stores/modelsInfo.spec.ts
@@ -17,7 +17,7 @@
  ***********************************************************************/
 
 import { afterEach, beforeEach, expect, test, vi } from 'vitest';
-import { MSG_NEW_MODELS_STATE } from '@shared/Messages';
+import { Messages } from '@shared/Messages';
 import { rpcBrowser } from '../utils/client';
 import type { Unsubscriber } from 'svelte/store';
 import { modelsInfo } from './modelsInfo';
@@ -70,7 +70,7 @@ test('check getLocalModels is called at subscription', async () => {
 });
 
 test('check getLocalModels is called twice if event is fired (one at init, one for the event)', async () => {
-  rpcBrowser.invoke(MSG_NEW_MODELS_STATE);
+  rpcBrowser.invoke(Messages.MSG_NEW_MODELS_STATE);
   // wait for the timeout in the debouncer
   await new Promise(resolve => setTimeout(resolve, 600));
   expect(mocks.getModelsInfoMock).toHaveBeenCalledTimes(2);
diff --git a/packages/frontend/src/stores/modelsInfo.ts b/packages/frontend/src/stores/modelsInfo.ts
@@ -18,7 +18,7 @@
 
 import type { ModelInfo } from '@shared/src/models/IModelInfo';
 import { studioClient } from '/@/utils/client';
-import { MSG_NEW_MODELS_STATE } from '@shared/Messages';
+import { Messages } from '@shared/Messages';
 import { RPCReadable } from './rpcReadable';
 
-export const modelsInfo = RPCReadable<ModelInfo[]>([], [MSG_NEW_MODELS_STATE], studioClient.getModelsInfo);
+export const modelsInfo = RPCReadable<ModelInfo[]>([], [Messages.MSG_NEW_MODELS_STATE], studioClient.getModelsInfo);
diff --git a/packages/frontend/src/stores/playground-queries.ts b/packages/frontend/src/stores/playground-queries.ts
@@ -19,11 +19,11 @@
 import type { Readable } from 'svelte/store';
 import { readable } from 'svelte/store';
 import type { QueryState } from '@shared/src/models/IPlaygroundQueryState';
-import { MSG_NEW_PLAYGROUND_QUERIES_STATE } from '@shared/Messages';
+import { Messages } from '@shared/Messages';
 import { rpcBrowser, studioClient } from '/@/utils/client';
 
 export const playgroundQueries: Readable<QueryState[]> = readable<QueryState[]>([], set => {
-  const sub = rpcBrowser.subscribe(MSG_NEW_PLAYGROUND_QUERIES_STATE, msg => {
+  const sub = rpcBrowser.subscribe(Messages.MSG_NEW_PLAYGROUND_QUERIES_STATE, msg => {
     set(msg);
   });
   // Initialize the store manually
diff --git a/packages/frontend/src/stores/playground-states.ts b/packages/frontend/src/stores/playground-states.ts
@@ -18,12 +18,12 @@
 
 import type { Readable } from 'svelte/store';
 import { readable } from 'svelte/store';
-import { MSG_PLAYGROUNDS_STATE_UPDATE } from '@shared/Messages';
+import { Messages } from '@shared/Messages';
 import { rpcBrowser, studioClient } from '/@/utils/client';
 import type { PlaygroundState } from '@shared/src/models/IPlaygroundState';
 
 export const playgroundStates: Readable<PlaygroundState[]> = readable<PlaygroundState[]>([], set => {
-  const sub = rpcBrowser.subscribe(MSG_PLAYGROUNDS_STATE_UPDATE, msg => {
+  const sub = rpcBrowser.subscribe(Messages.MSG_PLAYGROUNDS_STATE_UPDATE, msg => {
     set(msg);
   });
   // Initialize the store manually
diff --git a/packages/frontend/src/stores/tasks.ts b/packages/frontend/src/stores/tasks.ts
@@ -17,8 +17,8 @@
  ***********************************************************************/
 
 import { studioClient } from '/@/utils/client';
-import { MSG_TASKS_UPDATE } from '@shared/Messages';
+import { Messages } from '@shared/Messages';
 import { RPCReadable } from './rpcReadable';
 import type { Task } from '@shared/src/models/ITask';
 
-export const tasks = RPCReadable<Task[]>([], [MSG_TASKS_UPDATE], studioClient.getTasks);
+export const tasks = RPCReadable<Task[]>([], [Messages.MSG_TASKS_UPDATE], studioClient.getTasks);
diff --git a/packages/shared/Messages.ts b/packages/shared/Messages.ts
@@ -16,14 +16,13 @@
  * SPDX-License-Identifier: Apache-2.0
  ***********************************************************************/
 
-export const MSG_PLAYGROUNDS_STATE_UPDATE = 'playgrounds-state-update';
-export const MSG_NEW_PLAYGROUND_QUERIES_STATE = 'new-playground-queries-state';
-export const MSG_NEW_CATALOG_STATE = 'new-catalog-state';
-export const MSG_NEW_RECIPE_STATE = 'new-recipe-state';
-export const MSG_TASKS_UPDATE = 'tasks-update';
-export const MSG_NEW_MODELS_STATE = 'new-models-state';
-export const MSG_APPLICATIONS_STATE_UPDATE = 'applications-state-update';
-export const MSG_LOCAL_REPOSITORY_UPDATE = 'local-repository-update';
-
-export const MSG_INFERENCE_SERVERS_UPDATE = 'inference-servers-update';
-
+export enum Messages {
+  MSG_PLAYGROUNDS_STATE_UPDATE = 'playgrounds-state-update',
+  MSG_NEW_PLAYGROUND_QUERIES_STATE = 'new-playground-queries-state',
+  MSG_NEW_CATALOG_STATE = 'new-catalog-state',
+  MSG_TASKS_UPDATE = 'tasks-update',
+  MSG_NEW_MODELS_STATE = 'new-models-state',
+  MSG_APPLICATIONS_STATE_UPDATE = 'applications-state-update',
+  MSG_LOCAL_REPOSITORY_UPDATE = 'local-repository-update',
+  MSG_INFERENCE_SERVERS_UPDATE = 'inference-servers-update',
+}
