feat: convert id to string (#180)

* feat: convert id to string

BREAKING CHANGE: InMemoryDBEntity now uses string for id

V1* versions of service, controller, module, entity have been provided
for backwards compatibility. Please update your imports if you wish to
continue to use number as id.

Author: wesleygrimes

.eslintignore

@@ -0,0 +1,2 @@
+tests/**
+**/*.spec.ts

.eslintrc.js

@@ -0,0 +1,27 @@
+
+module.exports = {
+    parser: '@typescript-eslint/parser',
+    parserOptions: {
+      project: 'tsconfig.json',
+      sourceType: 'module',
+    },
+    plugins: ['@typescript-eslint/eslint-plugin'],
+    extends: [
+      'plugin:@typescript-eslint/eslint-recommended',
+      'plugin:@typescript-eslint/recommended',
+      'prettier',
+      'prettier/@typescript-eslint',
+    ],
+    root: true,
+    env: {
+      node: true,
+      jest: true,
+    },
+    rules: {
+      '@typescript-eslint/interface-name-prefix': 'off',
+      '@typescript-eslint/explicit-function-return-type': 'off',
+      '@typescript-eslint/no-explicit-any': 'off',
+      '@typescript-eslint/no-use-before-define': 'off',
+      '@typescript-eslint/no-non-null-assertion': 'off',
+    },
+  };

.github/workflows/master.yml

@@ -6,23 +6,13 @@ on:
       - master
 
 jobs:
-  test-8:
+  test:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v1
       - uses: actions/setup-node@v1
         with:
-          node-version: 8
-      - run: npm ci
-      - run: npm run test
-
-  test-10:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v1
-      - uses: actions/setup-node@v1
-        with:
-          node-version: 10
+          node-version: 12
       - run: npm ci
       - run: npm run test
 
@@ -32,18 +22,18 @@ jobs:
       - uses: actions/checkout@v1
       - uses: actions/setup-node@v1
         with:
-          node-version: 10
+          node-version: 12
       - run: npm ci
       - run: npm run e2e
 
   publish:
-    needs: [test-8, test-10, e2e]
+    needs: [test, e2e]
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v1
       - uses: actions/setup-node@v1
         with:
-          node-version: 10
+          node-version: 12
       - run: npm ci
       - run: npm run build
       - run: npx semantic-release

.github/workflows/pull-requests.yml

@@ -12,27 +12,17 @@ jobs:
       - uses: actions/checkout@v1
       - uses: actions/setup-node@v1
         with:
-          node-version: 10
+          node-version: 12
       - run: npm ci
       - run: npm run lint
 
-  test-8:
+  test:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v1
       - uses: actions/setup-node@v1
         with:
-          node-version: 8
-      - run: npm ci
-      - run: npm run test
-
-  test-10:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v1
-      - uses: actions/setup-node@v1
-        with:
-          node-version: 10
+          node-version: 12
       - run: npm ci
       - run: npm run test
 
@@ -42,7 +32,7 @@ jobs:
       - uses: actions/checkout@v1
       - uses: actions/setup-node@v1
         with:
-          node-version: 10
+          node-version: 12
       - run: npm ci
       - run: npm run e2e
 
@@ -52,26 +42,16 @@ jobs:
       - uses: actions/checkout@v1
       - uses: actions/setup-node@v1
         with:
-          node-version: 10
+          node-version: 12
       - run: npm ci
       - run: npm run format:verify
 
-  build-8:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v1
-      - uses: actions/setup-node@v1
-        with:
-          node-version: 8
-      - run: npm ci
-      - run: npm run build
-
-  build-10:
+  build:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v1
       - uses: actions/setup-node@v1
         with:
-          node-version: 10
+          node-version: 12
       - run: npm ci
       - run: npm run build

.gitignore

@@ -21,6 +21,3 @@ npm-debug.log
 # schematics
 /schematics/**/*.js
 /schematics/**/*.d.ts
-
-# jest snapshots
-__snapshots__/

.prettierrc

@@ -1,4 +1,5 @@
 {
   "trailingComma": "all",
+  "arrowParens": "always",
   "singleQuote": true
-}
+}

e2e/jest.config.js

@@ -20,9 +20,9 @@ module.exports = {
       lines: 80,
     },
   },
-  "testPathIgnorePatterns": [
-    "<rootDir>/build/",
-    "<rootDir>/node_modules/",
-    "<rootDir>/e2e/"
+  testPathIgnorePatterns: [
+    '<rootDir>/build/',
+    '<rootDir>/node_modules/',
+    '<rootDir>/tests/',
   ],
 };

e2e/test-app/src/customer/customer.controller.ts

@@ -1,5 +1,6 @@
 import { Inject } from '@nestjs/common';
 import { getInMemoryDBServiceToken } from './in-memory-db.utils';
 
+// eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types
 export const InjectInMemoryDBService = (featureName: string) =>
   Inject(getInMemoryDBServiceToken(featureName));

e2e/test-app/src/product/product.controller.ts

@@ -1,6 +1,6 @@
 import { IN_MEMORY_DB_SERVICE } from './in-memory-db.constants';
 
-export function getInMemoryDBServiceToken(featureName?: string) {
+export function getInMemoryDBServiceToken(featureName?: string): string {
   return featureName && featureName !== IN_MEMORY_DB_SERVICE
     ? `${featureName}${IN_MEMORY_DB_SERVICE}`
     : IN_MEMORY_DB_SERVICE;

jest.config.js

@@ -12,9 +12,9 @@ describe('In Memory DB Async Controller', () => {
   let service: InMemoryDBService<TestEntity>;
 
   const sampleRecords: TestEntity[] = [
-    { id: 1, someField: 'AAA' },
-    { id: 2, someField: 'BBB' },
-    { id: 3, someField: 'CCC' },
+    { id: '1', someField: 'AAA' },
+    { id: '2', someField: 'BBB' },
+    { id: '3', someField: 'CCC' },
   ];
 
   class MockController extends InMemoryDBEntityAsyncController<TestEntity> {
@@ -37,17 +37,17 @@ describe('In Memory DB Async Controller', () => {
 
     test('should call service getAsync spy when given valid id', () => {
       // act
-      controller.get(1);
+      controller.get('1');
       // assert
-      expect(spy).toHaveBeenCalledWith(1);
+      expect(spy).toHaveBeenCalledWith('1');
     });
   });
 
   describe('getMany', () => {
     test('should call service getManyAsync spy when given list of ids', () => {
       // arrange
       const spy = spyOn(service, 'getManyAsync');
-      const testEntityMock = [1, 2, 3];
+      const testEntityMock = ['1', '2', '3'];
       // act
       controller.getMany(testEntityMock);
       // assert
@@ -96,9 +96,9 @@ describe('In Memory DB Async Controller', () => {
       // arrange
       const testEntityMock = { someField: 'DDD' };
       // act
-      controller.update(1, testEntityMock);
+      controller.update('1', testEntityMock);
       // assert
-      expect(spy).toHaveBeenCalledWith({ id: 1, ...testEntityMock });
+      expect(spy).toHaveBeenCalledWith({ id: '1', ...testEntityMock });
     });
   });
 
@@ -128,9 +128,9 @@ describe('In Memory DB Async Controller', () => {
 
     test('should call deleteAsync when give a valid id', () => {
       // act
-      controller.delete(1);
+      controller.delete('1');
       // assert
-      expect(spy).toHaveBeenCalledWith(1);
+      expect(spy).toHaveBeenCalledWith('1');
     });
   });
 
@@ -143,7 +143,7 @@ describe('In Memory DB Async Controller', () => {
 
     test('should call deleteManyAsync when given valid ids list', () => {
       // arrange
-      const testEntityMock = [1, 2, 3];
+      const testEntityMock = ['1', '2', '3'];
       // act
       controller.deleteMany(testEntityMock);
       // assert

lib/common/in-memory-db.decorators.ts

@@ -12,9 +12,9 @@ describe('In Memory DB Controller', () => {
   let service: InMemoryDBService<TestEntity>;
 
   const sampleRecords: TestEntity[] = [
-    { id: 1, someField: 'AAA' },
-    { id: 2, someField: 'BBB' },
-    { id: 3, someField: 'CCC' },
+    { id: '1', someField: 'AAA' },
+    { id: '2', someField: 'BBB' },
+    { id: '3', someField: 'CCC' },
   ];
 
   class MockController extends InMemoryDBEntityController<TestEntity> {
@@ -37,17 +37,17 @@ describe('In Memory DB Controller', () => {
 
     test('should call service get spy when given valid id', () => {
       // act
-      controller.get(1);
+      controller.get('1');
       // assert
-      expect(spy).toHaveBeenCalledWith(1);
+      expect(spy).toHaveBeenCalledWith('1');
     });
   });
 
   describe('getMany', () => {
     test('should call service getMany spy when given list of ids', () => {
       // arrange
       const spy = spyOn(service, 'getMany');
-      const testEntityMock = [1, 2, 3];
+      const testEntityMock = ['1', '2', '3'];
       // act
       controller.getMany(testEntityMock);
       // assert
@@ -96,9 +96,9 @@ describe('In Memory DB Controller', () => {
       // arrange
       const testEntityMock = { someField: 'DDD' };
       // act
-      controller.update(1, testEntityMock);
+      controller.update('1', testEntityMock);
       // assert
-      expect(spy).toHaveBeenCalledWith({ id: 1, ...testEntityMock });
+      expect(spy).toHaveBeenCalledWith({ id: '1', ...testEntityMock });
     });
   });
 
@@ -126,11 +126,11 @@ describe('In Memory DB Controller', () => {
       spy = jest.spyOn(service, 'delete');
     });
 
-    test('should call delete when give a valid id', () => {
+    test('should call delete when given a valid id', () => {
       // act
-      controller.delete(1);
+      controller.delete('1');
       // assert
-      expect(spy).toHaveBeenCalledWith(1);
+      expect(spy).toHaveBeenCalledWith('1');
     });
   });
 
@@ -143,7 +143,7 @@ describe('In Memory DB Controller', () => {
 
     test('should call delete many when given valid ids list', () => {
       // arrange
-      const testEntityMock = [1, 2, 3];
+      const testEntityMock = ['1', '2', '3'];
       // act
       controller.deleteMany(testEntityMock);
       // assert

lib/common/in-memory-db.utils.ts

@@ -1,2 +1,2 @@
-export * from './in-memory-db-async.controller';
-export * from './in-memory-db.controller';
+export { InMemoryDBEntityAsyncController } from './in-memory-db-async.controller';
+export { InMemoryDBEntityController } from './in-memory-db.controller';