Switch to using messaging and startable stoppable from NPM package (#7368)

* Add custom jest resolver to fix requiring "uuid" module Signed-off-by: Janne Savolainen <janne.savolainen@live.fi> * Update dependencies Signed-off-by: Janne Savolainen <janne.savolainen@live.fi> * Introduce test utils for rendering and running with thrown mobx reactions Signed-off-by: Janne Savolainen <janne.savolainen@live.fi> * Extract startable-stoppable to NPM package Signed-off-by: Janne Savolainen <janne.savolainen@live.fi> * Extract messaging to NPM package Co-authored-by: Mikko Aspiala <mikko.aspiala@gmail.com> Signed-off-by: Janne Savolainen <janne.savolainen@live.fi> * Switch to using startable-stoppable from NPM package Signed-off-by: Janne Savolainen <janne.savolainen@live.fi> * Switch to using messaging from the Feature Signed-off-by: Janne Savolainen <janne.savolainen@live.fi> * Remove old implementation of messaging Signed-off-by: Janne Savolainen <janne.savolainen@live.fi> * Make setupping app paths happen earlier in renderer Signed-off-by: Janne Savolainen <janne.savolainen@live.fi> * Fix typo Signed-off-by: Janne Savolainen <janne.savolainen@live.fi> * Add kludge to make testing-library work properly from test-utils package Signed-off-by: Janne Savolainen <janne.savolainen@live.fi> * Fix code style Signed-off-by: Janne Savolainen <janne.savolainen@live.fi> * Add lint:fix -root script Signed-off-by: Janne Savolainen <janne.savolainen@live.fi> * Fix unrelated failing unit tests Signed-off-by: Janne Savolainen <janne.savolainen@live.fi> * Turn of no-floating-promises from typescript linting for being broken Signed-off-by: Janne Savolainen <janne.savolainen@live.fi> * Make linting not happen for dist -directories Signed-off-by: Janne Savolainen <janne.savolainen@live.fi> * Make linting failures appear as failure Signed-off-by: Janne Savolainen <janne.savolainen@live.fi> * Stop running prettier twice It already gets ran as eslint-plugin. Signed-off-by: Janne Savolainen <janne.savolainen@live.fi> * Make CI run unit tests for all packages by consolidating name of NPM script Co-authored-by: Mikko Aspiala <mikko.aspiala@gmail.com> Signed-off-by: Janne Savolainen <janne.savolainen@live.fi> * Add missing unit tests for coverage Co-authored-by: Mikko Aspiala <mikko.aspiala@gmail.com> Signed-off-by: Janne Savolainen <janne.savolainen@live.fi> * Skip coverage for test utils Co-authored-by: Mikko Aspiala <mikko.aspiala@gmail.com> Signed-off-by: Janne Savolainen <janne.savolainen@live.fi> * Remove check for coverage in packages which are not ready for it Signed-off-by: Janne Savolainen <janne.savolainen@live.fi> * Stop collecting coverage from index.ts files them being indirections to the implementation Co-authored-by: Mikko Aspiala <mikko.aspiala@gmail.com> Signed-off-by: Janne Savolainen <janne.savolainen@live.fi> * Implement sending message to channel in main Signed-off-by: Janne Savolainen <janne.savolainen@live.fi> * Add missing feature dependencies Signed-off-by: Janne Savolainen <janne.savolainen@live.fi> * Add dummy implementations for requesting in main from renderer Signed-off-by: Janne Savolainen <janne.savolainen@live.fi> * Re-enable communicating from main to cluster frames Signed-off-by: Janne Savolainen <janne.savolainen@live.fi> * Ignore trivial files from coverage Signed-off-by: Janne Savolainen <janne.savolainen@live.fi> * Update package-lock Signed-off-by: Janne Savolainen <janne.savolainen@live.fi> * Extract message-bridge to separate NPM package to prevent dev dependencies being in the production bundle Signed-off-by: Janne Savolainen <janne.savolainen@live.fi> * Extract computed channel to own NPM package for clear dependencies Signed-off-by: Janne Savolainen <janne.savolainen@live.fi> * Consolidate electron related stuff to a directory Signed-off-by: Janne Savolainen <janne.savolainen@live.fi> * Add missing publish configurations Signed-off-by: Janne Savolainen <janne.savolainen@live.fi> * Ignore test implementation from coverage being not interesting Signed-off-by: Janne Savolainen <janne.savolainen@live.fi> --------- Signed-off-by: Janne Savolainen <janne.savolainen@live.fi>
2025-05-20 05:10:56 +00:00 · 2023-03-21 11:38:43 +02:00
1 parent df49ff9b96
commit 0f1f030a06
@@ -0,0 +1,6 @@
+{
+  "extends": "@k8slens/eslint-config/eslint",
+  "parserOptions": {
+    "project": "./tsconfig.json"
+  }
+}
@@ -0,0 +1 @@
+"@k8slens/eslint-config/prettier"
@@ -0,0 +1,3 @@
+export type { StartableStoppable, Starter, Stopper } from "./src/get-startable-stoppable";
+
+export { getStartableStoppable } from "./src/get-startable-stoppable";
@@ -0,0 +1 @@
+module.exports = require("@k8slens/jest").monorepoPackageConfig(__dirname).configForReact;
@@ -0,0 +1,38 @@
+{
+  "name": "@k8slens/startable-stoppable",
+  "private": false,
+  "version": "1.0.0-alpha.1",
+  "description": "TBD",
+  "type": "commonjs",
+
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org/"
+  },
+
+  "files": [
+    "build"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/lensapp/lens.git"
+  },
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "author": {
+    "name": "OpenLens Authors",
+    "email": "info@k8slens.dev"
+  },
+  "license": "MIT",
+  "homepage": "https://github.com/lensapp/lens",
+  "scripts": {
+    "build": "webpack",
+    "dev": "webpack --mode=development --watch",
+    "test:unit": "jest --coverage --runInBand",
+    "lint": "lens-lint",
+    "lint:fix": "lens-lint --fix"
+  },
+  "devDependencies": {
+    "@k8slens/eslint-config": "^6.5.0-alpha.1"
+  }
+}
@@ -0,0 +1,62 @@
+import type { StartableStoppable } from "./get-startable-stoppable";
+import { getStartableStoppable } from "./get-startable-stoppable";
+
+describe("getStartableStoppable", () => {
+  let stopMock: jest.MockedFunction<() => void>;
+  let startMock: jest.MockedFunction<() => () => void>;
+  let actual: StartableStoppable;
+
+  beforeEach(() => {
+    stopMock = jest.fn();
+    startMock = jest.fn().mockImplementation(() => stopMock);
+    actual = getStartableStoppable("some-id", startMock);
+  });
+
+  it("does not start yet", () => {
+    expect(startMock).not.toHaveBeenCalled();
+  });
+
+  it("does not stop yet", () => {
+    expect(stopMock).not.toHaveBeenCalled();
+  });
+
+  it("when stopping before ever starting, throws", () => {
+    expect(() => actual.stop()).toThrow('Tried to stop "some-id", but it is already stopped.');
+  });
+
+  it("is not started", () => {
+    expect(actual.started).toBe(false);
+  });
+
+  describe("when started", () => {
+    beforeEach(() => {
+      actual.start();
+    });
+
+    it("calls start function", () => {
+      expect(startMock).toHaveBeenCalled();
+    });
+
+    it("is started", () => {
+      expect(actual.started).toBe(true);
+    });
+
+    it("when started again, throws", () => {
+      expect(() => actual.start()).toThrow('Tried to start "some-id", but it is already started.');
+    });
+
+    describe("when stopped", () => {
+      beforeEach(() => {
+        actual.stop();
+      });
+
+      it("calls stop function", () => {
+        expect(stopMock).toBeCalled();
+      });
+
+      it("is stopped", () => {
+        expect(actual.started).toBe(false);
+      });
+    });
+  });
+});
@@ -0,0 +1,40 @@
+export type Stopper = () => void;
+export type Starter = () => Stopper;
+
+export interface StartableStoppable {
+  readonly started: boolean;
+  start: () => void;
+  stop: () => void;
+}
+
+type StartableStoppableState = "stopped" | "started" | "starting";
+
+export function getStartableStoppable(id: string, startAndGetStopper: Starter): StartableStoppable {
+  let stop: Stopper;
+  let state: StartableStoppableState = "stopped";
+
+  return {
+    get started() {
+      return state === "started";
+    },
+
+    start: () => {
+      if (state !== "stopped") {
+        throw new Error(`Tried to start "${id}", but it is already ${state}.`);
+      }
+
+      state = "starting";
+      stop = startAndGetStopper();
+      state = "started";
+    },
+
+    stop: () => {
+      if (state !== "started") {
+        throw new Error(`Tried to stop "${id}", but it is already ${state}.`);
+      }
+
+      stop();
+      state = "stopped";
+    },
+  };
+}
@@ -0,0 +1,4 @@
+{
+  "extends": "@k8slens/typescript/config/base.json",
+  "include": ["**/*.ts"]
+}
@@ -0,0 +1 @@
+module.exports = require("@k8slens/webpack").configForNode;
				`@@ -0,0 +1 @@`
				`module.exports = require("@k8slens/jest").monorepoPackageConfig(__dirname).configForReact;`
				`@@ -0,0 +1 @@`
				`module.exports = require("@k8slens/webpack").configForNode;`