Added Jest and tests for EventBus

.babelrc

@@ -0,0 +1,13 @@
+{
+  "presets": [
+    [
+      "@babel/preset-env",
+      {
+        "targets": {
+          "node": "current"
+        }
+      }
+    ],
+    "@babel/preset-typescript",
+  ]
+}

.eslintrc.js

@@ -2,6 +2,7 @@ module.exports = {
   env: {
     browser: true,
     es2021: true,
+    jest: true,
   },
   extends: ['standard'],
   globals: {

.gitignore

@@ -19,3 +19,4 @@ data.json
 
 dist
 .pnpm-debug.log
+coverage

jest.config.js

@@ -0,0 +1,198 @@
+/*
+ * For a detailed explanation regarding each configuration property, visit:
+ * https://jestjs.io/docs/configuration
+ */
+
+module.exports = {
+  // All imported modules in your tests should be mocked automatically
+  // automock: false,
+
+  // Stop running tests after `n` failures
+  // bail: 0,
+
+  // The directory where Jest should store its cached dependency information
+  // cacheDirectory: "C:\\Users\\cambi\\AppData\\Local\\Temp\\jest",
+
+  // Automatically clear mock calls, instances and results before every test
+  clearMocks: true,
+
+  // Indicates whether the coverage information should be collected while executing the test
+  collectCoverage: true,
+
+  // An array of glob patterns indicating a set of files for which coverage information should be collected
+  // collectCoverageFrom: undefined,
+
+  // The directory where Jest should output its coverage files
+  coverageDirectory: 'coverage',
+
+  // An array of regexp pattern strings used to skip coverage collection
+  // coveragePathIgnorePatterns: [
+  //   "\\\\node_modules\\\\"
+  // ],
+
+  // Indicates which provider should be used to instrument code for coverage
+  coverageProvider: 'v8',
+
+  // A list of reporter names that Jest uses when writing coverage reports
+  // coverageReporters: [
+  //   "json",
+  //   "text",
+  //   "lcov",
+  //   "clover"
+  // ],
+
+  // An object that configures minimum threshold enforcement for coverage results
+  // coverageThreshold: undefined,
+
+  // A path to a custom dependency extractor
+  // dependencyExtractor: undefined,
+
+  // Make calling deprecated APIs throw helpful error messages
+  // errorOnDeprecated: false,
+
+  // Force coverage collection from ignored files using an array of glob patterns
+  // forceCoverageMatch: [],
+
+  // A path to a module which exports an async function that is triggered once before all test suites
+  // globalSetup: undefined,
+
+  // A path to a module which exports an async function that is triggered once after all test suites
+  // globalTeardown: undefined,
+
+  // A set of global variables that need to be available in all test environments
+  // globals: {},
+
+  // The maximum amount of workers used to run your tests. Can be specified as % or a number. E.g. maxWorkers: 10% will use 10% of your CPU amount + 1 as the maximum worker number. maxWorkers: 2 will use a maximum of 2 workers.
+  // maxWorkers: "50%",
+
+  // An array of directory names to be searched recursively up from the requiring module's location
+  // moduleDirectories: [
+  //   "node_modules"
+  // ],
+
+  // An array of file extensions your modules use
+  moduleFileExtensions: [
+    'ts',
+    'svelte',
+    'js',
+    // "jsx",
+    // "tsx",
+    // "json",
+    // "node"
+  ],
+
+  // A map from regular expressions to module names or to arrays of module names that allow to stub out resources with a single module
+  // moduleNameMapper: {},
+
+  // An array of regexp pattern strings, matched against all module paths before considered 'visible' to the module loader
+  // modulePathIgnorePatterns: [],
+
+  // Activates notifications for test results
+  // notify: false,
+
+  // An enum that specifies notification mode. Requires { notify: true }
+  // notifyMode: "failure-change",
+
+  // A preset that is used as a base for Jest's configuration
+  // preset: undefined,
+
+  // Run tests from one or more projects
+  // projects: undefined,
+
+  // Use this configuration option to add custom reporters to Jest
+  // reporters: undefined,
+
+  // Automatically reset mock state before every test
+  // resetMocks: false,
+
+  // Reset the module registry before running each individual test
+  // resetModules: false,
+
+  // A path to a custom resolver
+  // resolver: undefined,
+
+  // Automatically restore mock state and implementation before every test
+  // restoreMocks: false,
+
+  // The root directory that Jest should scan for tests and modules within
+  // rootDir: undefined,
+
+  // A list of paths to directories that Jest should use to search for files in
+  // roots: [
+  //   "<rootDir>"
+  // ],
+
+  // Allows you to use a custom runner instead of Jest's default test runner
+  // runner: "jest-runner",
+
+  // The paths to modules that run some code to configure or set up the testing environment before each test
+  // setupFiles: [],
+
+  // A list of paths to modules that run some code to configure or set up the testing framework before each test
+  // setupFilesAfterEnv: [],
+
+  // The number of seconds after which a test is considered as slow and reported as such in the results.
+  // slowTestThreshold: 5,
+
+  // A list of paths to snapshot serializer modules Jest should use for snapshot testing
+  // snapshotSerializers: [],
+
+  // The test environment that will be used for testing
+  testEnvironment: 'jsdom',
+
+  // Options that will be passed to the testEnvironment
+  // testEnvironmentOptions: {},
+
+  // Adds a location field to test results
+  // testLocationInResults: false,
+
+  // The glob patterns Jest uses to detect test files
+  // testMatch: [
+  //   "**/__tests__/**/*.[jt]s?(x)",
+  //   "**/?(*.)+(spec|test).[tj]s?(x)"
+  // ],
+
+  // An array of regexp pattern strings that are matched against all test paths, matched tests are skipped
+  // testPathIgnorePatterns: [
+  //   "\\\\node_modules\\\\"
+  // ],
+
+  // The regexp pattern or array of patterns that Jest uses to detect test files
+  // testRegex: [],
+
+  // This option allows the use of a custom results processor
+  // testResultsProcessor: undefined,
+
+  // This option allows use of a custom test runner
+  // testRunner: "jest-circus/runner",
+
+  // This option sets the URL for the jsdom environment. It is reflected in properties such as location.href
+  // testURL: "http://localhost",
+
+  // Setting this value to "fake" allows the use of fake timers for functions such as "setTimeout"
+  // timers: "real",
+
+  // A map from regular expressions to paths to transformers
+  transform: {
+    '^.+\\.(js|ts)$': 'babel-jest',
+    '^.+\\.svelte$': 'svelte-jester',
+  },
+
+  // An array of regexp pattern strings that are matched against all source file paths, matched files will skip transformation
+  // transformIgnorePatterns: [
+  //   "\\\\node_modules\\\\",
+  //   "\\.pnp\\.[^\\\\]+$"
+  // ],
+
+  // An array of regexp pattern strings that are matched against all modules before the module loader will automatically return a mock for them
+  // unmockedModulePathPatterns: undefined,
+
+  // Indicates whether each individual test should be reported during the run
+  // verbose: undefined,
+
+  // An array of regexp patterns that are matched against all source file paths before re-running tests in watch mode
+  // watchPathIgnorePatterns: [],
+
+  // Whether to use watchman for file crawling
+  // watchman: true,
+}

package.json

@@ -7,16 +7,22 @@
     "dev": "node esbuild.config.mjs",
     "build": "tsc -noEmit -skipLibCheck && node esbuild.config.mjs production",
     "version": "node version-bump.mjs && git add manifest.json versions.json package.json",
-    "lint": "eslint . --ext .ts --fix --ignore-path .gitignore"
+    "lint": "eslint . --ext .ts --fix --ignore-path .gitignore",
+    "test": "jest"
   },
   "keywords": [],
   "author": "",
   "license": "MIT",
   "devDependencies": {
+    "@babel/preset-env": "^7.16.11",
+    "@babel/preset-typescript": "^7.16.7",
+    "@testing-library/jest-dom": "^5.16.4",
     "@tsconfig/svelte": "^3.0.0",
+    "@types/jest": "^27.4.1",
     "@types/node": "^16.11.27",
     "@typescript-eslint/eslint-plugin": "^5.20.0",
     "@typescript-eslint/parser": "^5.20.0",
+    "babel-jest": "^27.5.1",
     "builtin-modules": "^3.2.0",
     "esbuild": "0.13.12",
     "esbuild-plugin-copy": "^1.3.0",
@@ -27,10 +33,12 @@
     "eslint-plugin-node": "11.1.0",
     "eslint-plugin-promise": "5.0.0",
     "eslint-plugin-svelte3": "^3.4.1",
+    "jest": "^27.5.1",
     "obsidian": "latest",
     "prettier": "^2.6.2",
     "prettier-eslint": "^13.0.0",
     "svelte": "^3.47.0",
+    "svelte-jester": "^2.3.2",
     "svelte-preprocess": "^4.10.6",
     "tslib": "2.3.1",
     "typescript": "^4.6.3"

src/__tests__/event-bus-tests.ts

@@ -0,0 +1,123 @@
+import { EventBus } from '../event-bus'
+
+describe('EventBus', () => {
+  it('should refuse the registering of invalid ctx/event names', () => {
+    const eventBus = new EventBus()
+    expect(() => eventBus.on('@', 'event', () => {})).toThrowError(
+      'Invalid context/event name - Cannot contain @',
+    )
+    expect(() => eventBus.on('context', '@', () => {})).toThrowError(
+      'Invalid context/event name - Cannot contain @',
+    )
+  })
+
+  it('should emit different events to the same context', () => {
+    // Arrange
+    const bus = new EventBus()
+    const cb = jest.fn()
+    bus.on('context', 'event1', cb)
+    bus.on('context', 'event2', cb)
+
+    // Act
+    bus.emit('event1', 'PARAM_1')
+    bus.emit('event2', 'PARAM_2')
+
+    // Assert
+    expect(cb).toHaveBeenCalledTimes(2)
+    expect(cb).toHaveBeenNthCalledWith(1, 'PARAM_1')
+    expect(cb).toHaveBeenNthCalledWith(2, 'PARAM_2')
+  })
+
+  it('should emit the same events to different contexts', () => {
+    // Arrange
+    const bus = new EventBus()
+    const cb1 = jest.fn()
+    const cb2 = jest.fn()
+    bus.on('context1', 'event', cb1)
+    bus.on('context2', 'event', cb2)
+
+    // Act
+    bus.emit('event', 'PARAM_1')
+
+    // Assert
+    expect(cb1).toHaveBeenCalledTimes(1)
+    expect(cb1).toHaveBeenNthCalledWith(1, 'PARAM_1')
+    expect(cb2).toHaveBeenCalledTimes(1)
+    expect(cb2).toHaveBeenNthCalledWith(1, 'PARAM_1')
+  })
+
+  it('should forward multiple arguments', () => {
+    // Arrange
+    const bus = new EventBus()
+    const cb = jest.fn()
+    bus.on('context', 'event', cb)
+
+    // Act
+    bus.emit('event', 'foo', 'bar')
+
+    // Assert
+    expect(cb).toHaveBeenCalledWith('foo', 'bar')
+  })
+
+  it('should not emit events for disabled contexts', () => {
+    // Arrange
+    const bus = new EventBus()
+    const cb = jest.fn()
+    bus.on('context', 'event', cb)
+    bus.disable('context')
+
+    // Act
+    bus.emit('event', 'foo', 'bar')
+
+    // Assert
+    expect(cb).not.toHaveBeenCalled()
+  })
+
+  it('should emit events for enabled contexts', () => {
+    // Arrange
+    const bus = new EventBus()
+    const cb = jest.fn()
+    bus.on('context', 'event', cb)
+    bus.disable('context')
+    bus.enable('context')
+
+    // Act
+    bus.emit('event', 'foo', 'bar')
+
+    // Assert
+    expect(cb).toHaveBeenCalledWith('foo', 'bar')
+  })
+
+  it('should unregister contexts', () => {
+    // Arrange
+    const bus = new EventBus()
+    const cb = jest.fn()
+    bus.on('context1', 'event', cb)
+    bus.on('context2', 'event', cb)
+    bus.off('context1')
+
+    // Act
+    bus.emit('event', 'foo', 'bar')
+
+    // Assert
+    expect(cb).toHaveBeenCalledTimes(1)
+  })
+
+  it('should unregister single events', () => {
+    // Arrange
+    const bus = new EventBus()
+    const cb1 = jest.fn()
+    const cb2 = jest.fn()
+    bus.on('context', 'event1', cb1)
+    bus.on('context', 'event2', cb2)
+    bus.off('context', 'event2')
+
+    // Act
+    bus.emit('event1')
+    bus.emit('event2')
+
+    // Assert
+    expect(cb1).toHaveBeenCalled()
+    expect(cb2).not.toHaveBeenCalled()
+  })
+})

src/event-bus.ts

@@ -6,14 +6,23 @@ export class EventBus {
 
   public on(ctx: string, event: string, callback: EventBusCallback): void {
     if (ctx.includes('@') || event.includes('@')) {
-      throw new Error('Invalid ctx/event name - Cannot contain @')
+      throw new Error('Invalid context/event name - Cannot contain @')
     }
     this.handlers.set(`${ctx}@${event}`, callback)
   }
 
-  public off(ctx: string, event: string): void {
+  public off(ctx: string, event?: string): void {
+    if (event) {
       this.handlers.delete(`${ctx}@${event}`)
     }
+    else {
+      for (const [key] of this.handlers.entries()) {
+        if (key.startsWith(`${ctx}@`)) {
+          this.handlers.delete(key)
+        }
+      }
+    }
+  }
 
   public disable(ctx: string): void {
     this.enable(ctx)

tsconfig.json

@@ -3,7 +3,8 @@
   "compilerOptions": {
     "types": [
       "svelte",
-      "node"
+      "node",
+      "jest"
     ],
     "strict": true,
     "noUncheckedIndexedAccess": false,
@@ -22,5 +23,5 @@
   },
   "include": [
     "**/*.ts"
-  ]
+, "src/__tests__/event-bus-tests.mts"  ]
 }