From 905578d59042be028a1f6d6c796b2873cad62638 Mon Sep 17 00:00:00 2001 From: "Fabien \"egg\" O'Carroll" Date: Tue, 9 May 2023 18:46:48 -0400 Subject: [PATCH] Added @tryghost/in-memory-repository This is the first pass at an abstract class for our in-memory repository implementations. This should speed up local development and deduplicate code --- .github/dev.js | 10 + .gitignore | 3 + ghost/in-memory-repository/.eslintrc.js | 11 ++ ghost/in-memory-repository/README.md | 21 +++ ghost/in-memory-repository/package.json | 33 ++++ .../src/InMemoryRepository.ts | 80 ++++++++ .../src/InMemoryRepository.ts~ | 80 ++++++++ ghost/in-memory-repository/src/index.ts | 1 + ghost/in-memory-repository/test/.eslintrc.js | 7 + .../test/InMemoryRepository.test.ts | 175 ++++++++++++++++++ ghost/in-memory-repository/tsconfig.json | 113 +++++++++++ 11 files changed, 534 insertions(+) create mode 100644 ghost/in-memory-repository/.eslintrc.js create mode 100644 ghost/in-memory-repository/README.md create mode 100644 ghost/in-memory-repository/package.json create mode 100644 ghost/in-memory-repository/src/InMemoryRepository.ts create mode 100644 ghost/in-memory-repository/src/InMemoryRepository.ts~ create mode 100644 ghost/in-memory-repository/src/index.ts create mode 100644 ghost/in-memory-repository/test/.eslintrc.js create mode 100644 ghost/in-memory-repository/test/InMemoryRepository.test.ts create mode 100644 ghost/in-memory-repository/tsconfig.json diff --git a/.github/dev.js b/.github/dev.js index 43e49c3da4..e75c20f20b 100644 --- a/.github/dev.js +++ b/.github/dev.js @@ -50,6 +50,16 @@ if (DASH_DASH_ARGS.includes('revisions') || DASH_DASH_ARGS.includes('all')) { }); } +if (DASH_DASH_ARGS.includes('in-memory-repository') || DASH_DASH_ARGS.includes('all')) { + commands.push({ + name: 'in-memory-repository', + command: 'yarn dev', + cwd: path.resolve(__dirname, '../ghost/in-memory-repository'), + prefixColor: 'pink', + env: {} + }); +} + if (DASH_DASH_ARGS.includes('portal') || DASH_DASH_ARGS.includes('all')) { commands.push({ name: 'portal', diff --git a/.gitignore b/.gitignore index ca1075a8ad..5c598fc3db 100644 --- a/.gitignore +++ b/.gitignore @@ -138,3 +138,6 @@ Caddyfile /ghost/post-revisions/build /ghost/post-revisions/tsconfig.tsbuildinfo + +/ghost/in-memory-repository/build +/ghost/in-memory-repository/tsconfig.tsbuildinfo diff --git a/ghost/in-memory-repository/.eslintrc.js b/ghost/in-memory-repository/.eslintrc.js new file mode 100644 index 0000000000..f643d2ce74 --- /dev/null +++ b/ghost/in-memory-repository/.eslintrc.js @@ -0,0 +1,11 @@ +module.exports = { + parser: '@typescript-eslint/parser', + plugins: ['ghost', '@typescript-eslint'], + extends: [ + 'plugin:ghost/node' + ], + rules: { + 'no-unused-vars': 'off', + '@typescript-eslint/no-unused-vars': ['error'] + } +}; diff --git a/ghost/in-memory-repository/README.md b/ghost/in-memory-repository/README.md new file mode 100644 index 0000000000..565a633d15 --- /dev/null +++ b/ghost/in-memory-repository/README.md @@ -0,0 +1,21 @@ +# In Memory Repository + + +## 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 + diff --git a/ghost/in-memory-repository/package.json b/ghost/in-memory-repository/package.json new file mode 100644 index 0000000000..63e0397cc3 --- /dev/null +++ b/ghost/in-memory-repository/package.json @@ -0,0 +1,33 @@ +{ + "name": "@tryghost/in-memory-repository", + "version": "0.0.0", + "repository": "https://github.com/TryGhost/Ghost/tree/main/packages/in-memory-repository", + "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": { + "c8": "7.13.0", + "mocha": "10.2.0", + "sinon": "15.0.4", + "ts-node": "10.9.1", + "typescript": "5.0.4" + }, + "dependencies": { + "@tryghost/nql": "^0.11.0" + } +} diff --git a/ghost/in-memory-repository/src/InMemoryRepository.ts b/ghost/in-memory-repository/src/InMemoryRepository.ts new file mode 100644 index 0000000000..5dfc4de21d --- /dev/null +++ b/ghost/in-memory-repository/src/InMemoryRepository.ts @@ -0,0 +1,80 @@ +import nql from '@tryghost/nql'; + +type Entity = { + id: T; + deleted: boolean; +} + +type Order = { + field: keyof T; + direction: 'asc' | 'desc'; +} + +type OrderOption> = Order[]; + +export abstract class InMemoryRepository> { + private store: T[] = []; + private ids: Map = new Map(); + + constructor() {} + + protected abstract toPrimitive(entity: T): object; + + public async save(entity: T): Promise { + if (entity.deleted) { + this.store = this.store.filter(item => item.id !== entity.id); + this.ids.delete(entity.id); + return; + } + + if (this.ids.has(entity.id)) { + this.store = this.store.map((item) => { + if (item.id === entity.id) { + return entity; + } + return item; + }); + } else { + this.store.push(entity); + this.ids.set(entity.id, true); + } + } + + public async getById(id: string): Promise { + return this.store.find(item => item.id === id) || null; + } + + public async getAll(options: { filter?: string; order?: OrderOption } = {}): Promise { + const filter = nql(options.filter); + + const results = this.store.slice().filter(item => filter.queryJSON(this.toPrimitive(item))); + + if (options.order) { + for (const order of options.order) { + results.sort((a, b) => { + if (order.direction === 'asc') { + return a[order.field] as any > (b[order.field] as any) ? 1 : -1; + } else { + return a[order.field] < b[order.field] ? 1 : -1; + } + }); + } + } + + return results; + } + + public async getPage(options: { filter?: string; page: number; limit: number; order?: Order[] } = {page: 1, limit: 15}): Promise { + const results = await this.getAll(options); + + const start = (options.page - 1) * options.limit; + const end = start + options.limit; + + return results.slice(start, end); + } + + public async getCount(options: { filter?: string }): Promise { + const results = await this.getAll(options); + return results.length; + } +} diff --git a/ghost/in-memory-repository/src/InMemoryRepository.ts~ b/ghost/in-memory-repository/src/InMemoryRepository.ts~ new file mode 100644 index 0000000000..5dfc4de21d --- /dev/null +++ b/ghost/in-memory-repository/src/InMemoryRepository.ts~ @@ -0,0 +1,80 @@ +import nql from '@tryghost/nql'; + +type Entity = { + id: T; + deleted: boolean; +} + +type Order = { + field: keyof T; + direction: 'asc' | 'desc'; +} + +type OrderOption> = Order[]; + +export abstract class InMemoryRepository> { + private store: T[] = []; + private ids: Map = new Map(); + + constructor() {} + + protected abstract toPrimitive(entity: T): object; + + public async save(entity: T): Promise { + if (entity.deleted) { + this.store = this.store.filter(item => item.id !== entity.id); + this.ids.delete(entity.id); + return; + } + + if (this.ids.has(entity.id)) { + this.store = this.store.map((item) => { + if (item.id === entity.id) { + return entity; + } + return item; + }); + } else { + this.store.push(entity); + this.ids.set(entity.id, true); + } + } + + public async getById(id: string): Promise { + return this.store.find(item => item.id === id) || null; + } + + public async getAll(options: { filter?: string; order?: OrderOption } = {}): Promise { + const filter = nql(options.filter); + + const results = this.store.slice().filter(item => filter.queryJSON(this.toPrimitive(item))); + + if (options.order) { + for (const order of options.order) { + results.sort((a, b) => { + if (order.direction === 'asc') { + return a[order.field] as any > (b[order.field] as any) ? 1 : -1; + } else { + return a[order.field] < b[order.field] ? 1 : -1; + } + }); + } + } + + return results; + } + + public async getPage(options: { filter?: string; page: number; limit: number; order?: Order[] } = {page: 1, limit: 15}): Promise { + const results = await this.getAll(options); + + const start = (options.page - 1) * options.limit; + const end = start + options.limit; + + return results.slice(start, end); + } + + public async getCount(options: { filter?: string }): Promise { + const results = await this.getAll(options); + return results.length; + } +} diff --git a/ghost/in-memory-repository/src/index.ts b/ghost/in-memory-repository/src/index.ts new file mode 100644 index 0000000000..426b0dcefa --- /dev/null +++ b/ghost/in-memory-repository/src/index.ts @@ -0,0 +1 @@ +export {InMemoryRepository} from './InMemoryRepository'; diff --git a/ghost/in-memory-repository/test/.eslintrc.js b/ghost/in-memory-repository/test/.eslintrc.js new file mode 100644 index 0000000000..6fe6dc1504 --- /dev/null +++ b/ghost/in-memory-repository/test/.eslintrc.js @@ -0,0 +1,7 @@ +module.exports = { + parser: '@typescript-eslint/parser', + plugins: ['ghost'], + extends: [ + 'plugin:ghost/test' + ] +}; diff --git a/ghost/in-memory-repository/test/InMemoryRepository.test.ts b/ghost/in-memory-repository/test/InMemoryRepository.test.ts new file mode 100644 index 0000000000..ec6064dd81 --- /dev/null +++ b/ghost/in-memory-repository/test/InMemoryRepository.test.ts @@ -0,0 +1,175 @@ +import assert from 'assert'; +import {InMemoryRepository} from '../src/index'; + +type SimpleEntity = { + id: string; + deleted: boolean; + name: string; + age: number; +} + +class SimpleInMemoryRepository extends InMemoryRepository { + constructor() { + super(); + } + protected toPrimitive(entity: SimpleEntity): object { + return { + name: entity.name, + age: entity.age + }; + } +} + +describe('InMemoryRepository', function () { + it('Can save, retrieve, update and delete entities', async function () { + const repository = new SimpleInMemoryRepository(); + + checkRetrieving: { + const entity = { + id: '1', + deleted: false, + name: 'John', + age: 30 + }; + + await repository.save(entity); + const result = await repository.getById('1'); + + assert(result); + assert(result.name === 'John'); + assert(result.age === 30); + assert(result.id === '1'); + + break checkRetrieving; + } + + checkUpdating: { + const entity = { + id: '2', + deleted: false, + name: 'John', + age: 24 + }; + + await repository.save(entity); + + entity.name = 'Kym'; + + await repository.save(entity); + + const result = await repository.getById('2'); + + assert(result); + assert(result.name === 'Kym'); + assert(result.age === 24); + assert(result.id === '2'); + + break checkUpdating; + } + + checkDeleting: { + const entity = { + id: '3', + deleted: false, + name: 'Egg', + age: 180 + }; + + await repository.save(entity); + + assert(await repository.getById('3')); + + entity.deleted = true; + + await repository.save(entity); + + assert(!await repository.getById('3')); + + break checkDeleting; + } + }); + + it('Can save and retrieve all entities', async function () { + const repository = new SimpleInMemoryRepository(); + const entities = [{ + id: '1', + deleted: false, + name: 'Kym', + age: 24 + }, { + id: '2', + deleted: false, + name: 'John', + age: 30 + }, { + id: '3', + deleted: false, + name: 'Kevin', + age: 5 + }]; + + for (const entity of entities) { + await repository.save(entity); + } + + const result = await repository.getAll({ + order: [{ + field: 'age', + direction: 'desc' + }] + }); + + assert(result); + assert(result.length === 3); + assert(result[0].age === 30); + assert(result[1].age === 24); + assert(result[2].age === 5); + }); + + it('Can save and retrieve a page of entities', async function () { + const repository = new SimpleInMemoryRepository(); + const entities = [{ + id: '1', + deleted: false, + name: 'John', + age: 30 + }, { + id: '2', + deleted: false, + name: 'Kym', + age: 24 + }, { + id: '3', + deleted: false, + name: 'Egg', + age: 180 + }, { + id: '4', + deleted: false, + name: 'Kevin', + age: 36 + }]; + + for (const entity of entities) { + await repository.save(entity); + } + + const result = await repository.getPage({ + filter: 'age:>25', + page: 1, + limit: 3, + order: [{ + field: 'age', + direction: 'asc' + }] + }); + + const count = await repository.getCount({ + filter: 'name:John' + }); + + assert(result); + assert(result.length === 3); + assert(count === 1); + }); +}); diff --git a/ghost/in-memory-repository/tsconfig.json b/ghost/in-memory-repository/tsconfig.json new file mode 100644 index 0000000000..8467c9ff7e --- /dev/null +++ b/ghost/in-memory-repository/tsconfig.json @@ -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 ''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/**/*"] +}