0
Fork 0
mirror of https://github.com/TryGhost/Ghost.git synced 2025-02-17 23:44:39 -05:00

Extracted model event interceptor to separate package

refs https://github.com/TryGhost/Ghost/pull/17065

- This is a follow up cleanup work after introducing even mapper when working on collections refresh mechanism.
- This module manages interception of the Model events and maps/dispatches Domain events that could later be used in different libraries.
This commit is contained in:
Naz 2023-06-28 17:22:13 +07:00 committed by naz
parent 292663f447
commit e22d8e8680
13 changed files with 451 additions and 76 deletions

View file

@ -0,0 +1,10 @@
module.exports = () => {
const DomainEvents = require('@tryghost/domain-events/lib/DomainEvents');
const {ModelToDomainEventInterceptor} = require('@tryghost/model-to-domain-event-interceptor');
const events = require('../../lib/common/events');
const eventInterceptor = new ModelToDomainEventInterceptor({
ModelEvents: events,
DomainEvents: DomainEvents
});
eventInterceptor.init();
};

View file

@ -1,74 +0,0 @@
const DomainEvents = require('@tryghost/domain-events');
const {
CollectionResourceChangeEvent,
PostDeletedEvent,
PostAddedEvent,
PostEditedEvent
} = require('@tryghost/collections');
const domainEventDispatcher = (modelEventName, data) => {
const change = Object.assign({}, {
id: data.id,
resource: modelEventName.split('.')[0]
}, data._changed);
let event;
if (modelEventName === 'post.deleted') {
event = PostDeletedEvent.create({id: data.id});
} if (modelEventName === 'post.added') {
event = PostAddedEvent.create({
id: data.id,
featured: data.featured,
status: data.attributes.status,
published_at: data.published_at
});
} if (modelEventName === 'post.edited') {
event = PostEditedEvent.create({
id: data.id,
current: {
id: data.id,
title: data.attributes.title,
status: data.attributes.status,
featured: data.attributes.featured,
published_at: data.attributes.published_at
},
// @NOTE: this will need to represent the previous state of the post
// will be needed to optimize the query for the collection
previous: {
}
});
} else {
event = CollectionResourceChangeEvent.create(modelEventName, change);
}
DomainEvents.dispatch(event);
};
const translateModelEventsToDomainEvents = () => {
const events = require('../../lib/common/events');
const ghostModelUpdateEvents = [
'post.added',
'post.deleted',
'post.edited',
// 'tag.added',
// 'tag.edited',
// 'tag.attached',
// 'tag.detached',
// 'tag.deleted',
// 'user.activated',
'user.activated.edited'
// 'user.attached',
// 'user.detached',
// 'user.deleted'
];
for (const modelEvent of ghostModelUpdateEvents) {
if (!events.hasRegisteredListener(modelEvent, 'collectionListener')) {
events.on(modelEvent, data => domainEventDispatcher(modelEvent, data));
}
}
};
module.exports = translateModelEventsToDomainEvents;

View file

@ -32,7 +32,6 @@ class CollectionsServiceWrapper {
return;
}
const translateModelEventsToDomainEvents = require('./model-to-domain-events-bridge');
const existingBuiltins = await this.api.getAll({filter: 'slug:featured'});
if (!existingBuiltins.data.length) {
@ -56,7 +55,7 @@ class CollectionsServiceWrapper {
}
this.api.subscribeToEvents();
translateModelEventsToDomainEvents();
require('./intercept-events')();
}
}

View file

@ -128,6 +128,7 @@
"@tryghost/metrics": "1.0.24",
"@tryghost/milestones": "0.0.0",
"@tryghost/minifier": "0.0.0",
"@tryghost/model-to-domain-event-interceptor": "0.0.0",
"@tryghost/mw-api-version-mismatch": "0.0.0",
"@tryghost/mw-cache-control": "0.0.0",
"@tryghost/mw-error-handler": "0.0.0",

View file

@ -0,0 +1,7 @@
module.exports = {
parser: '@typescript-eslint/parser',
plugins: ['ghost'],
extends: [
'plugin:ghost/node'
]
};

View file

@ -0,0 +1,23 @@
# Model To Domain Event Interceptor
Model event interceptor that maps legacy model events to Domain event
## Usage
## Develop
This is a monorepo package.
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.
## Test
- `yarn lint` run just eslint
- `yarn test` run lint and tests

View file

@ -0,0 +1,37 @@
{
"name": "@tryghost/model-to-domain-event-interceptor",
"version": "0.0.0",
"repository": "https://github.com/TryGhost/Ghost/tree/main/packages/model-to-domain-event-interceptor",
"author": "Ghost Foundation",
"private": true,
"main": "build/index.js",
"types": "build/index.d.ts",
"scripts": {
"dev": "tsc --watch --preserveWatchOutput --sourceMap",
"build": "tsc",
"prepare": "tsc",
"test:unit": "NODE_ENV=testing c8 --src src --all --check-coverage --100 --reporter text --reporter cobertura mocha -r ts-node/register './test/**/*.test.ts'",
"test": "yarn test:types && yarn test:unit",
"test:types": "tsc --noEmit",
"lint:code": "eslint src/ --ext .ts --cache",
"lint": "yarn lint:code && yarn lint:test",
"lint:test": "eslint -c test/.eslintrc.js test/ --ext .ts --cache"
},
"files": [
"build"
],
"devDependencies": {
"@tryghost/domain-events": "0.0.0",
"c8": "8.0.0",
"mocha": "10.2.0",
"sinon": "15.2.0",
"ts-node": "10.9.1",
"typescript": "5.1.5"
},
"dependencies": {},
"c8": {
"exclude": [
"src/**/*.d.ts"
]
}
}

View file

@ -0,0 +1,97 @@
const {
CollectionResourceChangeEvent,
PostDeletedEvent,
PostAddedEvent,
PostEditedEvent
} = require('@tryghost/collections');
type ModelToDomainEventInterceptorDeps = {
ModelEvents: {
hasRegisteredListener: (event: any, listenerName: string) => boolean;
on: (eventName: string, callback: (data: any) => void) => void;
},
DomainEvents: {
dispatch: (event: any) => void;
}
}
export class ModelToDomainEventInterceptor {
ModelEvents;
DomainEvents;
constructor(deps: ModelToDomainEventInterceptorDeps) {
this.ModelEvents = deps.ModelEvents;
this.DomainEvents = deps.DomainEvents;
}
init() {
const ghostModelUpdateEvents = [
'post.added',
'post.deleted',
'post.edited',
// @NOTE: uncomment events below once they have appropriate DomainEvent to map to
// 'tag.added',
// 'tag.edited',
// 'tag.attached',
// 'tag.detached',
// 'tag.deleted',
// 'user.activated',
'user.activated.edited'
// 'user.attached',
// 'user.detached',
// 'user.deleted'
];
for (const modelEventName of ghostModelUpdateEvents) {
if (!this.ModelEvents.hasRegisteredListener(modelEventName, 'collectionListener')) {
const dispatcher = this.domainEventDispatcher.bind(this);
const listener = function (data: any) {
dispatcher(modelEventName, data);
};
Object.defineProperty(listener, 'name', {value: `${modelEventName}.domainEventInterceptorListener`, writable: false});
this.ModelEvents.on(modelEventName, listener);
}
}
}
domainEventDispatcher(modelEventName: string, data: any) {
const change = Object.assign({}, {
id: data.id,
resource: modelEventName.split('.')[0]
}, data._changed);
let event;
if (modelEventName === 'post.deleted') {
event = PostDeletedEvent.create({id: data.id});
} else if (modelEventName === 'post.added') {
event = PostAddedEvent.create({
id: data.id,
featured: data.attributes.featured,
status: data.attributes.status,
published_at: data.attributes.published_at
});
} else if (modelEventName === 'post.edited') {
event = PostEditedEvent.create({
id: data.id,
current: {
id: data.id,
title: data.attributes.title,
status: data.attributes.status,
featured: data.attributes.featured,
published_at: data.attributes.published_at
},
// @NOTE: this will need to represent the previous state of the post
// will be needed to optimize the query for the collection
previous: {
}
});
} else {
event = CollectionResourceChangeEvent.create(modelEventName, change);
}
this.DomainEvents.dispatch(event);
}
}

View file

@ -0,0 +1 @@
export * from './ModelToDomainEventInterceptor';

View file

@ -0,0 +1 @@
declare module '@tryghost/domain-events'

View file

@ -0,0 +1,7 @@
module.exports = {
parser: '@typescript-eslint/parser',
plugins: ['ghost'],
extends: [
'plugin:ghost/test'
]
};

View file

@ -0,0 +1,153 @@
import assert from 'assert/strict';
import events from 'events';
import DomainEvents from '@tryghost/domain-events';
const {
CollectionResourceChangeEvent,
PostDeletedEvent,
PostEditedEvent,
PostAddedEvent
} = require('@tryghost/collections');
import {ModelToDomainEventInterceptor} from '../src';
class EventRegistry extends events.EventEmitter {
hasRegisteredListener(eventName: string, listenerName: string) {
// console.log(this.listeners(eventName));
// console.log('checking for: ', listenerName);
return !!(this.listeners(eventName).find(listener => (listener.name === listenerName)));
}
}
describe('ModelToDomainEventInterceptor', function () {
it('Can instantiate a ModelToDomainEventInterceptor', function () {
const modelToDomainEventInterceptor = new ModelToDomainEventInterceptor({
ModelEvents: new EventRegistry(),
DomainEvents: DomainEvents
});
assert.ok(modelToDomainEventInterceptor);
});
it('Starts event listeners after initialization', function () {
let eventRegistry = new EventRegistry();
const modelToDomainEventInterceptor = new ModelToDomainEventInterceptor({
ModelEvents: eventRegistry,
DomainEvents: DomainEvents
});
modelToDomainEventInterceptor.init();
assert.ok(eventRegistry.hasRegisteredListener('post.added', 'post.added.domainEventInterceptorListener'), 'post.added listener is registered');
});
it('Intercepts post.added Model event and dispatches PostAddedEvent Domain event', async function () {
let eventRegistry = new EventRegistry();
const modelToDomainEventInterceptor = new ModelToDomainEventInterceptor({
ModelEvents: eventRegistry,
DomainEvents: DomainEvents
});
modelToDomainEventInterceptor.init();
let interceptedEvent;
DomainEvents.subscribe(PostAddedEvent, (event: any) => {
assert.equal(event.id, '1234-added');
interceptedEvent = event;
});
eventRegistry.emit('post.added', {
id: '1234-added',
attributes: {
status: 'draft',
featured: false,
published_at: new Date()
}
});
await DomainEvents.allSettled();
assert.ok(interceptedEvent);
});
it('Intercepts post.edited Model event and dispatches PostEditedEvent Domain event', async function () {
let eventRegistry = new EventRegistry();
const modelToDomainEventInterceptor = new ModelToDomainEventInterceptor({
ModelEvents: eventRegistry,
DomainEvents: DomainEvents
});
modelToDomainEventInterceptor.init();
let interceptedEvent;
DomainEvents.subscribe(PostEditedEvent, async (event: any) => {
assert.equal(event.id, '1234-edited');
assert.ok(event.data);
assert.ok(event.data.current);
assert.equal(event.data.current.status, 'draft');
interceptedEvent = event;
});
eventRegistry.emit('post.edited', {
id: '1234-edited',
attributes: {
status: 'draft',
featured: false,
published_at: new Date()
}
});
await DomainEvents.allSettled();
assert.ok(interceptedEvent);
});
it('Intercepts post.deleted Model event and dispatches PostAddedEvent Domain event', async function () {
let eventRegistry = new EventRegistry();
const modelToDomainEventInterceptor = new ModelToDomainEventInterceptor({
ModelEvents: eventRegistry,
DomainEvents: DomainEvents
});
modelToDomainEventInterceptor.init();
let interceptedEvent;
DomainEvents.subscribe(PostDeletedEvent, (event: any) => {
assert.equal(event.id, '1234-deleted');
interceptedEvent = event;
});
eventRegistry.emit('post.deleted', {
id: '1234-deleted'
});
await DomainEvents.allSettled();
assert.ok(interceptedEvent);
});
it('Intercepts unmapped Model event and dispatches CollectionResourceChangeEvent Domain event', async function () {
let eventRegistry = new EventRegistry();
const modelToDomainEventInterceptor = new ModelToDomainEventInterceptor({
ModelEvents: eventRegistry,
DomainEvents: DomainEvents
});
modelToDomainEventInterceptor.init();
let interceptedEvent;
DomainEvents.subscribe(CollectionResourceChangeEvent, (event: any) => {
assert.equal(event.name, 'user.activated.edited');
assert.equal(event.data.id, '1234-user-edit');
interceptedEvent = event;
});
eventRegistry.emit('user.activated.edited', {
id: '1234-user-edit'
});
await DomainEvents.allSettled();
assert.ok(interceptedEvent);
});
});

View file

@ -0,0 +1,113 @@
{
"ts-node": {
"files": true
},
"compilerOptions": {
/* Visit https://aka.ms/tsconfig to read more about this file */
/* Projects */
"incremental": true, /* Save .tsbuildinfo files to allow for incremental compilation of projects. */
// "composite": true, /* Enable constraints that allow a TypeScript project to be used with project references. */
// "tsBuildInfoFile": "./.tsbuildinfo", /* Specify the path to .tsbuildinfo incremental compilation file. */
// "disableSourceOfProjectReferenceRedirect": true, /* Disable preferring source files instead of declaration files when referencing composite projects. */
// "disableSolutionSearching": true, /* Opt a project out of multi-project reference checking when editing. */
// "disableReferencedProjectLoad": true, /* Reduce the number of projects loaded automatically by TypeScript. */
/* Language and Environment */
"target": "es2022", /* Set the JavaScript language version for emitted JavaScript and include compatible library declarations. */
// "lib": ["es2019"], /* Specify a set of bundled library declaration files that describe the target runtime environment. */
// "jsx": "preserve", /* Specify what JSX code is generated. */
// "experimentalDecorators": true, /* Enable experimental support for legacy experimental decorators. */
// "emitDecoratorMetadata": true, /* Emit design-type metadata for decorated declarations in source files. */
// "jsxFactory": "", /* Specify the JSX factory function used when targeting React JSX emit, e.g. 'React.createElement' or 'h'. */
// "jsxFragmentFactory": "", /* Specify the JSX Fragment reference used for fragments when targeting React JSX emit e.g. 'React.Fragment' or 'Fragment'. */
// "jsxImportSource": "", /* Specify module specifier used to import the JSX factory functions when using 'jsx: react-jsx*'. */
// "reactNamespace": "", /* Specify the object invoked for 'createElement'. This only applies when targeting 'react' JSX emit. */
// "noLib": true, /* Disable including any library files, including the default lib.d.ts. */
// "useDefineForClassFields": true, /* Emit ECMAScript-standard-compliant class fields. */
// "moduleDetection": "auto", /* Control what method is used to detect module-format JS files. */
/* Modules */
"module": "commonjs", /* Specify what module code is generated. */
"rootDir": "src", /* Specify the root folder within your source files. */
// "moduleResolution": "node10", /* Specify how TypeScript looks up a file from a given module specifier. */
// "baseUrl": "./", /* Specify the base directory to resolve non-relative module names. */
// "paths": {}, /* Specify a set of entries that re-map imports to additional lookup locations. */
// "rootDirs": [], /* Allow multiple folders to be treated as one when resolving modules. */
// "typeRoots": [], /* Specify multiple folders that act like './node_modules/@types'. */
// "types": [], /* Specify type package names to be included without being referenced in a source file. */
// "allowUmdGlobalAccess": true, /* Allow accessing UMD globals from modules. */
// "moduleSuffixes": [], /* List of file name suffixes to search when resolving a module. */
// "allowImportingTsExtensions": true, /* Allow imports to include TypeScript file extensions. Requires '--moduleResolution bundler' and either '--noEmit' or '--emitDeclarationOnly' to be set. */
// "resolvePackageJsonExports": true, /* Use the package.json 'exports' field when resolving package imports. */
// "resolvePackageJsonImports": true, /* Use the package.json 'imports' field when resolving imports. */
// "customConditions": [], /* Conditions to set in addition to the resolver-specific defaults when resolving imports. */
"resolveJsonModule": true, /* Enable importing .json files. */
// "allowArbitraryExtensions": true, /* Enable importing files with any extension, provided a declaration file is present. */
// "noResolve": true, /* Disallow 'import's, 'require's or '<reference>'s from expanding the number of files TypeScript should add to a project. */
/* JavaScript Support */
// "allowJs": true, /* Allow JavaScript files to be a part of your program. Use the 'checkJS' option to get errors from these files. */
// "checkJs": true, /* Enable error reporting in type-checked JavaScript files. */
// "maxNodeModuleJsDepth": 1, /* Specify the maximum folder depth used for checking JavaScript files from 'node_modules'. Only applicable with 'allowJs'. */
/* Emit */
"declaration": true, /* Generate .d.ts files from TypeScript and JavaScript files in your project. */
// "declarationMap": true, /* Create sourcemaps for d.ts files. */
// "emitDeclarationOnly": true, /* Only output d.ts files and not JavaScript files. */
// "sourceMap": true, /* Create source map files for emitted JavaScript files. */
// "inlineSourceMap": true, /* Include sourcemap files inside the emitted JavaScript. */
// "outFile": "./", /* Specify a file that bundles all outputs into one JavaScript file. If 'declaration' is true, also designates a file that bundles all .d.ts output. */
"outDir": "build", /* Specify an output folder for all emitted files. */
// "removeComments": true, /* Disable emitting comments. */
// "noEmit": true, /* Disable emitting files from a compilation. */
// "importHelpers": true, /* Allow importing helper functions from tslib once per project, instead of including them per-file. */
// "importsNotUsedAsValues": "remove", /* Specify emit/checking behavior for imports that are only used for types. */
// "downlevelIteration": true, /* Emit more compliant, but verbose and less performant JavaScript for iteration. */
// "sourceRoot": "", /* Specify the root path for debuggers to find the reference source code. */
// "mapRoot": "", /* Specify the location where debugger should locate map files instead of generated locations. */
// "inlineSources": true, /* Include source code in the sourcemaps inside the emitted JavaScript. */
// "emitBOM": true, /* Emit a UTF-8 Byte Order Mark (BOM) in the beginning of output files. */
// "newLine": "crlf", /* Set the newline character for emitting files. */
// "stripInternal": true, /* Disable emitting declarations that have '@internal' in their JSDoc comments. */
// "noEmitHelpers": true, /* Disable generating custom helper functions like '__extends' in compiled output. */
// "noEmitOnError": true, /* Disable emitting files if any type checking errors are reported. */
// "preserveConstEnums": true, /* Disable erasing 'const enum' declarations in generated code. */
// "declarationDir": "./", /* Specify the output directory for generated declaration files. */
// "preserveValueImports": true, /* Preserve unused imported values in the JavaScript output that would otherwise be removed. */
/* Interop Constraints */
// "isolatedModules": true, /* Ensure that each file can be safely transpiled without relying on other imports. */
// "verbatimModuleSyntax": true, /* Do not transform or elide any imports or exports not marked as type-only, ensuring they are written in the output file's format based on the 'module' setting. */
// "allowSyntheticDefaultImports": true, /* Allow 'import x from y' when a module doesn't have a default export. */
"esModuleInterop": true, /* Emit additional JavaScript to ease support for importing CommonJS modules. This enables 'allowSyntheticDefaultImports' for type compatibility. */
// "preserveSymlinks": true, /* Disable resolving symlinks to their realpath. This correlates to the same flag in node. */
"forceConsistentCasingInFileNames": true, /* Ensure that casing is correct in imports. */
/* Type Checking */
"strict": true, /* Enable all strict type-checking options. */
"noImplicitAny": true, /* Enable error reporting for expressions and declarations with an implied 'any' type. */
// "strictNullChecks": true, /* When type checking, take into account 'null' and 'undefined'. */
// "strictFunctionTypes": true, /* When assigning functions, check to ensure parameters and the return values are subtype-compatible. */
// "strictBindCallApply": true, /* Check that the arguments for 'bind', 'call', and 'apply' methods match the original function. */
// "strictPropertyInitialization": true, /* Check for class properties that are declared but not set in the constructor. */
// "noImplicitThis": true, /* Enable error reporting when 'this' is given the type 'any'. */
// "useUnknownInCatchVariables": true, /* Default catch clause variables as 'unknown' instead of 'any'. */
// "alwaysStrict": true, /* Ensure 'use strict' is always emitted. */
// "noUnusedLocals": true, /* Enable error reporting when local variables aren't read. */
// "noUnusedParameters": true, /* Raise an error when a function parameter isn't read. */
// "exactOptionalPropertyTypes": true, /* Interpret optional property types as written, rather than adding 'undefined'. */
// "noImplicitReturns": true, /* Enable error reporting for codepaths that do not explicitly return in a function. */
// "noFallthroughCasesInSwitch": true, /* Enable error reporting for fallthrough cases in switch statements. */
// "noUncheckedIndexedAccess": true, /* Add 'undefined' to a type when accessed using an index. */
// "noImplicitOverride": true, /* Ensure overriding members in derived classes are marked with an override modifier. */
// "noPropertyAccessFromIndexSignature": true, /* Enforces using indexed accessors for keys declared using an indexed type. */
// "allowUnusedLabels": true, /* Disable error reporting for unused labels. */
// "allowUnreachableCode": true, /* Disable error reporting for unreachable code. */
/* Completeness */
// "skipDefaultLibCheck": true, /* Skip type checking .d.ts files that are included with TypeScript. */
"skipLibCheck": true /* Skip type checking all .d.ts files. */
},
"include": ["src/**/*"]
}