fix: made type-metadata.storage.ts much faster

Changed the data modeling of type-metadata storage to store the data in maps instead of arrays.
This results in a dramatic improvement of application startup time since many of the lookups for metadata are now in O(1) instead of O(n)

Author: roypeled

packages/graphql/lib/schema-builder/collections/array.collection.ts

@@ -1,5 +1,5 @@
 export class ArrayCollection<T> {
-  private array: T[] = [];
+  private readonly array: T[] = [];
 
   constructor(private globalArray: Array<T>) {}
 

packages/graphql/lib/schema-builder/collections/field.directive.collection.ts renamed to packages/graphql/lib/schema-builder/collections/field-directive.collection.ts

@@ -1,18 +1,19 @@
-import { MetadataListByNameCollection } from './metadata.list.by.name.collection';
+import { MetadataListByNameCollection } from './metadata-list-by-name.collection';
 import { PropertyDirectiveMetadata } from '../metadata';
 
 export class FieldDirectiveCollection extends MetadataListByNameCollection<PropertyDirectiveMetadata> {
   sdls = new Set<string>();
   fieldNames = new Set<string>();
 
   add(value: PropertyDirectiveMetadata) {
-    if (this.sdls.has(value.sdl) && this.fieldNames.has(value.fieldName))
+    if (this.sdls.has(value.sdl) && this.fieldNames.has(value.fieldName)) {
       return;
+    }
 
     super.add(value, value.fieldName);
 
     this.sdls.add(value.sdl);
     this.fieldNames.add(value.fieldName);
-    this.globalArray && this.globalArray.push(value);
+    this.globalArray?.push(value);
   }
 }

packages/graphql/lib/schema-builder/collections/index.ts

@@ -1,7 +1,7 @@
 export * from './metadata.storage.collection.list';
-export * from './field.directive.collection';
+export * from './field-directive.collection';
 export * from './array.collection';
 export * from './metada.collection.model.interface';
-export * from './metadata.by.name.collection';
-export * from './metadata.list.by.name.collection';
+export * from './metadata-by-name.collection';
+export * from './metadata-list-by-name.collection';
 export * from './metadata.storage.collection';

packages/graphql/lib/schema-builder/collections/metadata.by.name.collection.ts renamed to packages/graphql/lib/schema-builder/collections/metadata-by-name.collection.ts

@@ -1,4 +1,4 @@
-import { MetadataByNameCollection } from './metadata.by.name.collection';
+import { MetadataByNameCollection } from './metadata-by-name.collection';
 
 export class MetadataListByNameCollection<T> extends MetadataByNameCollection<
   T[]

packages/graphql/lib/schema-builder/collections/metadata.list.by.name.collection.ts renamed to packages/graphql/lib/schema-builder/collections/metadata-list-by-name.collection.ts

@@ -1,4 +1,4 @@
-import { MetadataByNameCollection } from './metadata.by.name.collection';
+import { MetadataByNameCollection } from './metadata-by-name.collection';
 import {
   ClassDirectiveMetadata,
   ClassExtensionsMetadata,
@@ -8,8 +8,8 @@ import {
   PropertyMetadata,
   ResolverClassMetadata,
 } from '../metadata';
-import { MetadataListByNameCollection } from './metadata.list.by.name.collection';
-import { FieldDirectiveCollection } from './field.directive.collection';
+import { MetadataListByNameCollection } from './metadata-list-by-name.collection';
+import { FieldDirectiveCollection } from './field-directive.collection';
 import { ObjectTypeMetadata } from '../metadata/object-type.metadata';
 import { ArrayCollection } from './array.collection';
 import { MetadataCollectionModelInterface } from './metada.collection.model.interface';
@@ -35,6 +35,7 @@ export class MetadataStorageCollection {
     this._argumentType = val;
     this.all.argumentType.push(val);
   }
+
   get argumentType() {
     return this._argumentType;
   }
@@ -43,6 +44,7 @@ export class MetadataStorageCollection {
     this._interface = val;
     this.all.interface.push(val);
   }
+
   get interface() {
     return this._interface;
   }
@@ -51,6 +53,7 @@ export class MetadataStorageCollection {
     this._inputType = val;
     this.all.inputType.push(val);
   }
+
   get inputType() {
     return this._inputType;
   }
@@ -59,6 +62,7 @@ export class MetadataStorageCollection {
     this._objectType = val;
     this.all.objectType.push(val);
   }
+
   get objectType() {
     return this._objectType;
   }
@@ -67,6 +71,7 @@ export class MetadataStorageCollection {
     this._resolver = val;
     this.all.resolver.push(val);
   }
+
   get resolver() {
     return this._resolver;
   }

packages/graphql/lib/schema-builder/collections/metadata.storage.collection.ts

@@ -0,0 +1,76 @@
+import { FieldDirectiveCollection } from '../../../lib/schema-builder/collections/';
+import { PropertyDirectiveMetadata } from '../../../lib/schema-builder/metadata';
+
+describe('FieldDirectiveCollection', () => {
+  const directive1: PropertyDirectiveMetadata = {
+    fieldName: 'foo',
+    sdl: '@foo',
+    target: () => {},
+  };
+  const directive2: PropertyDirectiveMetadata = {
+    fieldName: 'bar',
+    sdl: '@bar',
+    target: () => {},
+  };
+  const directive3: PropertyDirectiveMetadata = {
+    fieldName: 'baz',
+    sdl: '@baz',
+    target: () => {},
+  };
+
+  it('should keep a list of all SDLs added', () => {
+    const map = new FieldDirectiveCollection();
+    map.add(directive1);
+    map.add(directive2);
+    map.add(directive3);
+
+    expect([...map.sdls]).toEqual(['@foo', '@bar', '@baz']);
+  });
+
+  it('should keep a list of all fieldName added', () => {
+    const map = new FieldDirectiveCollection();
+    map.add(directive1);
+    map.add(directive2);
+    map.add(directive3);
+
+    expect([...map.fieldNames]).toEqual(['foo', 'bar', 'baz']);
+  });
+
+  it('should add 2 different directives on the same field', () => {
+    const map = new FieldDirectiveCollection();
+    const directive1Alt: PropertyDirectiveMetadata = {
+      fieldName: 'foo',
+      sdl: '@bar',
+      target: () => {},
+    };
+    map.add(directive1);
+    map.add(directive1Alt);
+
+    expect(map.getByName('foo')).toEqual([directive1, directive1Alt]);
+  });
+
+  it('should add 2 different fields with the same directive', () => {
+    const map = new FieldDirectiveCollection();
+    const directive1Alt: PropertyDirectiveMetadata = {
+      fieldName: 'bar',
+      sdl: '@foo',
+      target: () => {},
+    };
+    map.add(directive1);
+    map.add(directive1Alt);
+
+    expect(map.getByName('foo')).toEqual([directive1]);
+    expect(map.getByName('bar')).toEqual([directive1Alt]);
+  });
+
+  it('should NOT the same directive on the same field twice', () => {
+    const map = new FieldDirectiveCollection();
+    map.add(directive1);
+    map.add(directive1);
+
+    const directives = map.getByName('foo');
+
+    expect(directives).toEqual([directive1]);
+    expect(directives.length).toEqual(1);
+  });
+});

packages/graphql/tests/schema-builder/storages/field-directive.collection.spec.ts

@@ -0,0 +1,36 @@
+import { MetadataByNameCollection } from '../../../lib/schema-builder/collections/';
+
+describe('MetadataByNameCollection', () => {
+  it('should not add multiple values under the same name', () => {
+    const map = new MetadataByNameCollection<string>();
+    map.add('foo', 'uniqueName1');
+    map.add('bar', 'uniqueName2');
+    map.add('baz', 'uniqueName1');
+
+    expect(map.getByName('uniqueName1')).toBe('foo');
+    expect(map.getByName('uniqueName2')).toBe('bar');
+    expect(map.getAll().length).toBe(2);
+  });
+
+  it('should not add multiple values under the same name even in reverse', () => {
+    const map = new MetadataByNameCollection<string>();
+    map.unshift('foo', 'uniqueName1');
+    map.unshift('bar', 'uniqueName2');
+    map.unshift('baz', 'uniqueName1');
+
+    expect(map.getByName('uniqueName1')).toBe('foo');
+    expect(map.getByName('uniqueName2')).toBe('bar');
+    expect(map.getAll().length).toBe(2);
+  });
+
+  it('should add items in reverse', () => {
+    const map = new MetadataByNameCollection<string>();
+    map.add('foo', 'uniqueName1');
+    map.unshift('bar', 'uniqueName2');
+
+    const [first, second] = map.getAll();
+
+    expect(first).toBe('bar');
+    expect(second).toBe('foo');
+  });
+});

packages/graphql/tests/schema-builder/storages/metadata-by-name.collection.spec.ts

@@ -0,0 +1,34 @@
+import { MetadataListByNameCollection } from '../../../lib/schema-builder/collections/';
+
+describe('MapArrayByName', () => {
+  it('should return an empty array if a name is not found', () => {
+    const map = new MetadataListByNameCollection<string>();
+    const possibleArray = map.getByName('unknown');
+    expect(Array.isArray(possibleArray)).toBe(true);
+    expect(possibleArray.length).toBe(0);
+  });
+
+  it('should continuously add values to an array', () => {
+    const map = new MetadataListByNameCollection<string>();
+    map.add('foo', 'uniqueName1');
+    map.add('baz', 'uniqueName1');
+    map.add('bar', 'uniqueName2');
+
+    const uniqueName1Value = map.getByName('uniqueName1');
+    const uniqueName2Value = map.getByName('uniqueName2');
+
+    expect(uniqueName1Value).toEqual(['foo', 'baz']);
+    expect(uniqueName2Value).toEqual(['bar']);
+  });
+
+  it('should return a flat array of all values', () => {
+    const map = new MetadataListByNameCollection<string>();
+    map.add('foo', 'uniqueName1');
+    map.add('baz', 'uniqueName1');
+    map.add('bar', 'uniqueName2');
+
+    const allValues = map.getAll();
+
+    expect(allValues).toEqual(['foo', 'baz', 'bar']);
+  });
+});