@tryghost/domain-events 0.1.13 → 1.0.0

package/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2013-2022 Ghost Foundation
+Copyright (c) 2013-2025 Ghost Foundation
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/README.md

@@ -1,14 +1,5 @@
 # Domain Events
 
-## Install
-
-`npm install @tryghost/domain-events --save`
-
-or
-
-`yarn add @tryghost/domain-events`
-
-
 ## Usage
 
 ```js
@@ -31,25 +22,3 @@ const event = new MyEvent('hello world');
 
 DomainEvents.dispatch(event);
 ```
-
-
-## Develop
-
-This is a mono repository, managed with [lerna](https://lernajs.io/).
-
-Follow the instructions for the top-level repo.
-1. `git clone` this repo & `cd` into it as usual
-2. Run `yarn` to install top-level dependencies.
-
-
-## Run
-
-- `yarn dev`
-
-
-## Test
-
-- `yarn lint` run just eslint
-- `yarn test` run lint and tests
-
-

package/lib/DomainEvents.js

@@ -1,4 +1,5 @@
 const EventEmitter = require('events').EventEmitter;
+const logging = require('@tryghost/logging');
 
 /**
  * @template T
@@ -23,12 +24,22 @@ class DomainEvents {
      * @template Data
      * @template {IEvent<Data>} EventClass
      * @param {ConstructorOf<EventClass>} Event
-     * @param {(event: EventClass) => void} handler
+     * @param {(event: EventClass) => Promise<void> | void} handler
      *
      * @returns {void}
      */
     static subscribe(Event, handler) {
-        DomainEvents.ee.on(Event.name, handler);
+        DomainEvents.ee.on(Event.name, async (event) => {
+            try {
+                await handler(event);
+            } catch (e) {
+                logging.error('Unhandled error in event handler for event: ' + Event.name);
+                logging.error(e);
+            }
+            if (this.#trackingEnabled) {
+                this.#onProcessed();
+            }
+        });
     }
 
     /**
@@ -37,7 +48,51 @@ class DomainEvents {
      * @returns {void}
      */
     static dispatch(event) {
-        DomainEvents.ee.emit(event.constructor.name, event);
+        DomainEvents.dispatchRaw(event.constructor.name, event);
+    }
+
+    /**
+     * Dispatch an event in case you don't have an instance of the event class, but you do have the event name and event data.
+     * @template Data
+     * @param {string} name
+     * @param {Data} data
+     * @returns {void}
+     */
+    static dispatchRaw(name, data) {
+        if (this.#trackingEnabled) {
+            this.#dispatchCount += DomainEvents.ee.listenerCount(name);
+        }
+        DomainEvents.ee.emit(name, data);
+    }
+
+    // Methods and properties below are only for testing purposes
+    static #awaitQueue = [];
+    static #dispatchCount = 0;
+    static #processedCount = 0;
+    static #trackingEnabled = process.env.NODE_ENV?.startsWith('test');
+
+    /**
+     * Waits for all the events in the queue to be dispatched and fully processed (async).
+     */
+    static allSettled() {
+        return new Promise((resolve) => {
+            if (this.#processedCount >= this.#dispatchCount) {
+                // Resolve immediately if there are no events in the queue
+                resolve();
+                return;
+            }
+            this.#awaitQueue.push({resolve});
+        });
+    }
+
+    static #onProcessed() {
+        this.#processedCount += 1;
+        if (this.#processedCount >= this.#dispatchCount) {
+            for (const item of this.#awaitQueue) {
+                item.resolve();
+            }
+            this.#awaitQueue = [];
+        }
     }
 }
 

package/package.json

@@ -1,29 +1,30 @@
 {
   "name": "@tryghost/domain-events",
-  "version": "0.1.13",
-  "repository": "https://github.com/TryGhost/Members/tree/main/packages/domain-events",
+  "version": "1.0.0",
+  "publishConfig": {
+    "access": "public"
+  },
   "author": "Ghost Foundation",
   "license": "MIT",
   "main": "index.js",
   "types": "types",
   "scripts": {
     "dev": "echo \"Implement me!\"",
-    "test": "NODE_ENV=testing c8 --all --reporter text --reporter cobertura --check-coverage mocha './test/**/*.test.js'",
-    "lint": "eslint . --ext .js --cache",
-    "posttest": "yarn lint"
+    "test:unit": "NODE_ENV=testing c8 --all --reporter text --reporter cobertura --check-coverage --100 -- mocha --reporter dot './test/**/*.test.js'",
+    "test": "yarn test:unit",
+    "lint:code": "eslint *.js lib/ --ext .js --cache",
+    "lint": "yarn lint:code && yarn lint:test",
+    "lint:test": "eslint -c test/.eslintrc.js test/ --ext .js --cache"
   },
   "files": [
     "index.js",
     "lib"
   ],
-  "publishConfig": {
-    "access": "public"
-  },
   "devDependencies": {
-    "c8": "7.11.2",
-    "mocha": "10.0.0",
-    "should": "13.2.3",
-    "sinon": "14.0.0"
+    "@tryghost/logging": "2.4.21",
+    "c8": "8.0.1",
+    "mocha": "10.8.2",
+    "should": "13.2.3"
   },
-  "gitHead": "147750850f658077b0bc59162d7508daaed4c589"
+  "gitHead": "feac71f0032c5d92f56a8dfa7ccd5a2d883ad53d"
 }