From 1c23162b58c45ef4a01d77f0d302c4ed0ec0ce83 Mon Sep 17 00:00:00 2001 From: Jari Kolehmainen Date: Tue, 2 May 2023 16:21:56 +0300 Subject: [PATCH] chore: extract event-emitter from core Signed-off-by: Jari Kolehmainen --- package-lock.json | 24 +++++++ packages/core/package.json | 1 + .../app-event-bus/app-event-bus.injectable.ts | 2 +- packages/core/src/common/k8s-api/json-api.ts | 2 +- .../src/extensions/common-api/event-bus.ts | 2 +- .../extension-loader/extension-loader.ts | 2 +- packages/open-lens/package.json | 1 + .../event-emitter/.eslintrc.js | 6 ++ .../event-emitter/.prettierrc | 1 + .../utility-features/event-emitter/index.ts | 1 + .../event-emitter/jest.config.js | 1 + .../event-emitter/package.json | 41 +++++++++++ .../event-emitter/src}/event-emitter.test.ts | 69 +++++++++++++------ .../event-emitter/src}/event-emitter.ts | 7 -- .../event-emitter/tsconfig.json | 4 ++ .../event-emitter/webpack.config.js | 1 + 16 files changed, 134 insertions(+), 31 deletions(-) create mode 100644 packages/utility-features/event-emitter/.eslintrc.js create mode 100644 packages/utility-features/event-emitter/.prettierrc create mode 100644 packages/utility-features/event-emitter/index.ts create mode 100644 packages/utility-features/event-emitter/jest.config.js create mode 100644 packages/utility-features/event-emitter/package.json rename packages/{core/src/common/__tests__ => utility-features/event-emitter/src}/event-emitter.test.ts (60%) rename packages/{core/src/common => utility-features/event-emitter/src}/event-emitter.ts (84%) create mode 100644 packages/utility-features/event-emitter/tsconfig.json create mode 100644 packages/utility-features/event-emitter/webpack.config.js diff --git a/package-lock.json b/package-lock.json index 0869d25cd9..00847486b0 100644 --- a/package-lock.json +++ b/package-lock.json @@ -3918,6 +3918,10 @@ "resolved": "packages/infrastructure/eslint-config", "link": true }, + "node_modules/@k8slens/event-emitter": { + "resolved": "packages/utility-features/event-emitter", + "link": true + }, "node_modules/@k8slens/extensions": { "resolved": "packages/extension-api", "link": true @@ -35963,6 +35967,7 @@ "@k8slens/button": "^1.0.0-alpha.5", "@k8slens/cluster-settings": "^6.5.0-alpha.1", "@k8slens/error-boundary": "^1.0.0-alpha.5", + "@k8slens/event-emitter": "^1.0.0-alpha.1", "@k8slens/kubectl-versions": "^1.0.0-alpha.0", "@k8slens/legacy-extensions": "^1.0.0-alpha.0", "@k8slens/messaging": "^1.0.0-alpha.1", @@ -36832,6 +36837,7 @@ "@k8slens/application-for-electron-main": "^6.5.0-alpha.3", "@k8slens/core": "^6.5.0-alpha.8", "@k8slens/ensure-binaries": "^6.5.0-alpha.4", + "@k8slens/event-emitter": "^1.0.0-alpha.1", "@k8slens/feature-core": "^6.5.0-alpha.3", "@k8slens/keyboard-shortcuts": "^1.0.0-alpha.3", "@k8slens/kubectl-versions": "^1.0.0-alpha.2", @@ -37556,6 +37562,15 @@ "@testing-library/dom": ">=7.21.4" } }, + "packages/utility-features/event-emitter": { + "version": "1.0.0-alpha.1", + "license": "MIT", + "devDependencies": { + "@k8slens/eslint-config": "^6.5.0-alpha.2", + "@k8slens/jest": "^6.5.0-alpha.4", + "@k8slens/typescript": "^6.5.0-alpha.2" + } + }, "packages/utility-features/react-testing-library-discovery": { "name": "@k8slens/react-testing-library-discovery", "version": "1.0.0-alpha.3", @@ -40765,6 +40780,14 @@ "version": "file:packages/infrastructure/eslint-config", "requires": {} }, + "@k8slens/event-emitter": { + "version": "file:packages/utility-features/event-emitter", + "requires": { + "@k8slens/eslint-config": "^6.5.0-alpha.2", + "@k8slens/jest": "^6.5.0-alpha.4", + "@k8slens/typescript": "^6.5.0-alpha.2" + } + }, "@k8slens/extensions": { "version": "file:packages/extension-api", "requires": { @@ -59388,6 +59411,7 @@ "@k8slens/application-for-electron-main": "^6.5.0-alpha.3", "@k8slens/core": "^6.5.0-alpha.8", "@k8slens/ensure-binaries": "^6.5.0-alpha.4", + "@k8slens/event-emitter": "^1.0.0-alpha.1", "@k8slens/feature-core": "^6.5.0-alpha.3", "@k8slens/generate-tray-icons": "^6.5.0-alpha.4", "@k8slens/keyboard-shortcuts": "^1.0.0-alpha.3", diff --git a/packages/core/package.json b/packages/core/package.json index 341f5d6963..ffa710dfc3 100644 --- a/packages/core/package.json +++ b/packages/core/package.json @@ -316,6 +316,7 @@ "@k8slens/application-for-electron-main": "^6.5.0-alpha.0", "@k8slens/button": "^1.0.0-alpha.5", "@k8slens/error-boundary": "^1.0.0-alpha.5", + "@k8slens/event-emitter": "^1.0.0-alpha.1", "@k8slens/resizing-anchor": "^1.0.0-alpha.5", "@k8slens/routing": "^1.0.0-alpha.5", "@k8slens/cluster-settings": "^6.5.0-alpha.1", diff --git a/packages/core/src/common/app-event-bus/app-event-bus.injectable.ts b/packages/core/src/common/app-event-bus/app-event-bus.injectable.ts index 3dee975f7b..9126a05620 100644 --- a/packages/core/src/common/app-event-bus/app-event-bus.injectable.ts +++ b/packages/core/src/common/app-event-bus/app-event-bus.injectable.ts @@ -3,7 +3,7 @@ * Licensed under MIT License. See LICENSE in root directory for more information. */ import { getInjectable } from "@ogre-tools/injectable"; -import { EventEmitter } from "../event-emitter"; +import { EventEmitter } from "@k8slens/event-emitter"; import type { AppEvent } from "./event-bus"; const appEventBusInjectable = getInjectable({ diff --git a/packages/core/src/common/k8s-api/json-api.ts b/packages/core/src/common/k8s-api/json-api.ts index ad29cfae4c..8221a20129 100644 --- a/packages/core/src/common/k8s-api/json-api.ts +++ b/packages/core/src/common/k8s-api/json-api.ts @@ -12,7 +12,7 @@ import type { Response, RequestInit } from "@k8slens/node-fetch"; import { stringify } from "querystring"; import type { Patch } from "rfc6902"; import type { PartialDeep, ValueOf } from "type-fest"; -import { EventEmitter } from "../../common/event-emitter"; +import { EventEmitter } from "@k8slens/event-emitter"; import type { Logger } from "../../common/logger"; import type { Fetch } from "../fetch/fetch.injectable"; import type { Defaulted } from "@k8slens/utilities"; diff --git a/packages/core/src/extensions/common-api/event-bus.ts b/packages/core/src/extensions/common-api/event-bus.ts index 31c5446295..95f443e70e 100644 --- a/packages/core/src/extensions/common-api/event-bus.ts +++ b/packages/core/src/extensions/common-api/event-bus.ts @@ -6,7 +6,7 @@ import appEventBusInjectable from "../../common/app-event-bus/app-event-bus.injectable"; import { asLegacyGlobalForExtensionApi } from "../as-legacy-globals-for-extension-api/as-legacy-global-object-for-extension-api"; import type { AppEvent } from "../../common/app-event-bus/event-bus"; -import type { EventEmitter, EventEmitterCallback, EventEmitterOptions } from "../../common/event-emitter"; +import type { EventEmitter, EventEmitterCallback, EventEmitterOptions } from "@k8slens/event-emitter"; export type { AppEvent, diff --git a/packages/core/src/extensions/extension-loader/extension-loader.ts b/packages/core/src/extensions/extension-loader/extension-loader.ts index c81d071714..fccb9014b4 100644 --- a/packages/core/src/extensions/extension-loader/extension-loader.ts +++ b/packages/core/src/extensions/extension-loader/extension-loader.ts @@ -14,7 +14,7 @@ import type { LensExtension } from "../lens-extension"; import { extensionLoaderFromMainChannel, extensionLoaderFromRendererChannel } from "../../common/ipc/extension-handling"; import { requestExtensionLoaderInitialState } from "../../renderer/ipc"; import assert from "assert"; -import { EventEmitter } from "../../common/event-emitter"; +import { EventEmitter } from "@k8slens/event-emitter"; import type { Extension } from "./extension/extension.injectable"; import type { Logger } from "../../common/logger"; import type { JoinPaths } from "../../common/path/join-paths.injectable"; diff --git a/packages/open-lens/package.json b/packages/open-lens/package.json index 553cd430da..417cf5cdde 100644 --- a/packages/open-lens/package.json +++ b/packages/open-lens/package.json @@ -184,6 +184,7 @@ "@k8slens/application-for-electron-main": "^6.5.0-alpha.3", "@k8slens/core": "^6.5.0-alpha.8", "@k8slens/ensure-binaries": "^6.5.0-alpha.4", + "@k8slens/event-emitter": "^1.0.0-alpha.1", "@k8slens/feature-core": "^6.5.0-alpha.3", "@k8slens/keyboard-shortcuts": "^1.0.0-alpha.3", "@k8slens/kubectl-versions": "^1.0.0-alpha.2", diff --git a/packages/utility-features/event-emitter/.eslintrc.js b/packages/utility-features/event-emitter/.eslintrc.js new file mode 100644 index 0000000000..19a14e85a4 --- /dev/null +++ b/packages/utility-features/event-emitter/.eslintrc.js @@ -0,0 +1,6 @@ +module.exports = { + extends: "@k8slens/eslint-config/eslint", + parserOptions: { + project: "./tsconfig.json", + }, +}; \ No newline at end of file diff --git a/packages/utility-features/event-emitter/.prettierrc b/packages/utility-features/event-emitter/.prettierrc new file mode 100644 index 0000000000..edd47b479e --- /dev/null +++ b/packages/utility-features/event-emitter/.prettierrc @@ -0,0 +1 @@ +"@k8slens/eslint-config/prettier" diff --git a/packages/utility-features/event-emitter/index.ts b/packages/utility-features/event-emitter/index.ts new file mode 100644 index 0000000000..b4b6cd54f8 --- /dev/null +++ b/packages/utility-features/event-emitter/index.ts @@ -0,0 +1 @@ +export * from "./src/event-emitter"; diff --git a/packages/utility-features/event-emitter/jest.config.js b/packages/utility-features/event-emitter/jest.config.js new file mode 100644 index 0000000000..38d54ab7b6 --- /dev/null +++ b/packages/utility-features/event-emitter/jest.config.js @@ -0,0 +1 @@ +module.exports = require("@k8slens/jest").monorepoPackageConfig(__dirname).configForReact; diff --git a/packages/utility-features/event-emitter/package.json b/packages/utility-features/event-emitter/package.json new file mode 100644 index 0000000000..dd3b268420 --- /dev/null +++ b/packages/utility-features/event-emitter/package.json @@ -0,0 +1,41 @@ +{ + "name": "@k8slens/event-emitter", + "private": false, + "version": "1.0.0-alpha.1", + "description": "Event emitter", + "type": "commonjs", + "publishConfig": { + "access": "public", + "registry": "https://registry.npmjs.org/" + }, + "files": [ + "dist" + ], + "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", + "clean": "rimraf dist/", + "dev": "webpack --mode=development --watch", + "test": "jest --coverage --runInBand", + "lint": "lens-lint", + "lint:fix": "lens-lint --fix" + }, + "peerDependencies": { + }, + "devDependencies": { + "@k8slens/eslint-config": "^6.5.0-alpha.2", + "@k8slens/jest": "^6.5.0-alpha.4", + "@k8slens/typescript": "^6.5.0-alpha.2" + } +} diff --git a/packages/core/src/common/__tests__/event-emitter.test.ts b/packages/utility-features/event-emitter/src/event-emitter.test.ts similarity index 60% rename from packages/core/src/common/__tests__/event-emitter.test.ts rename to packages/utility-features/event-emitter/src/event-emitter.test.ts index cc71922182..0a0a3255fe 100644 --- a/packages/core/src/common/__tests__/event-emitter.test.ts +++ b/packages/utility-features/event-emitter/src/event-emitter.test.ts @@ -1,9 +1,4 @@ -/** - * Copyright (c) OpenLens Authors. All rights reserved. - * Licensed under MIT License. See LICENSE in root directory for more information. - */ - -import { EventEmitter } from "../event-emitter"; +import { EventEmitter } from "./event-emitter"; describe("EventEmitter", () => { it("should stop early if a listener returns false", () => { @@ -11,7 +6,9 @@ describe("EventEmitter", () => { const e = new EventEmitter<[]>(); e.addListener(() => false, {}); - e.addListener(() => { called = true; }, {}); + e.addListener(() => { + called = true; + }, {}); e.emit(); expect(called).toBe(false); @@ -22,7 +19,9 @@ describe("EventEmitter", () => { const e = new EventEmitter<[]>(); e.addListener(() => 0 as never, {}); - e.addListener(() => { called = true; }, {}); + e.addListener(() => { + called = true; + }, {}); e.emit(); expect(called).toBe(true); @@ -32,9 +31,18 @@ describe("EventEmitter", () => { const callOrder: number[] = []; const e = new EventEmitter<[]>(); - e.addListener(() => { callOrder.push(1); }, {}); - e.addListener(() => { callOrder.push(2); }, {}); - e.addListener(() => { callOrder.push(3); }, { prepend: true }); + e.addListener(() => { + callOrder.push(1); + }, {}); + e.addListener(() => { + callOrder.push(2); + }, {}); + e.addListener( + () => { + callOrder.push(3); + }, + { prepend: true }, + ); e.emit(); expect(callOrder).toStrictEqual([3, 1, 2]); @@ -44,9 +52,18 @@ describe("EventEmitter", () => { const callOrder: number[] = []; const e = new EventEmitter<[]>(); - e.addListener(() => { callOrder.push(1); }, {}); - e.addListener(() => { callOrder.push(2); }, {}); - e.addListener(() => { callOrder.push(3); }, { once: true }); + e.addListener(() => { + callOrder.push(1); + }, {}); + e.addListener(() => { + callOrder.push(2); + }, {}); + e.addListener( + () => { + callOrder.push(3); + }, + { once: true }, + ); e.emit(); e.emit(); @@ -56,10 +73,16 @@ describe("EventEmitter", () => { it("removeListener should stop the listener from being called", () => { const callOrder: number[] = []; const e = new EventEmitter<[]>(); - const r = () => { callOrder.push(3); }; + const r = () => { + callOrder.push(3); + }; - e.addListener(() => { callOrder.push(1); }, {}); - e.addListener(() => { callOrder.push(2); }, {}); + e.addListener(() => { + callOrder.push(1); + }, {}); + e.addListener(() => { + callOrder.push(2); + }, {}); e.addListener(r); e.emit(); @@ -73,9 +96,15 @@ describe("EventEmitter", () => { const callOrder: number[] = []; const e = new EventEmitter<[]>(); - e.addListener(() => { callOrder.push(1); }); - e.addListener(() => { callOrder.push(2); }); - e.addListener(() => { callOrder.push(3); }); + e.addListener(() => { + callOrder.push(1); + }); + e.addListener(() => { + callOrder.push(2); + }); + e.addListener(() => { + callOrder.push(3); + }); e.emit(); e.removeAllListeners(); diff --git a/packages/core/src/common/event-emitter.ts b/packages/utility-features/event-emitter/src/event-emitter.ts similarity index 84% rename from packages/core/src/common/event-emitter.ts rename to packages/utility-features/event-emitter/src/event-emitter.ts index 982cbdadc8..dd4f7038eb 100644 --- a/packages/core/src/common/event-emitter.ts +++ b/packages/utility-features/event-emitter/src/event-emitter.ts @@ -1,10 +1,3 @@ -/** - * Copyright (c) OpenLens Authors. All rights reserved. - * Licensed under MIT License. See LICENSE in root directory for more information. - */ - -// Custom event emitter - export interface EventEmitterOptions { once?: boolean; // call once and remove prepend?: boolean; // put listener to the beginning diff --git a/packages/utility-features/event-emitter/tsconfig.json b/packages/utility-features/event-emitter/tsconfig.json new file mode 100644 index 0000000000..1819203dc1 --- /dev/null +++ b/packages/utility-features/event-emitter/tsconfig.json @@ -0,0 +1,4 @@ +{ + "extends": "@k8slens/typescript/config/base.json", + "include": ["**/*.ts"] +} diff --git a/packages/utility-features/event-emitter/webpack.config.js b/packages/utility-features/event-emitter/webpack.config.js new file mode 100644 index 0000000000..c1089b1b44 --- /dev/null +++ b/packages/utility-features/event-emitter/webpack.config.js @@ -0,0 +1 @@ +module.exports = require("@k8slens/webpack").configForNode; \ No newline at end of file