feat!: add database adapter provider for better injection (#46)

Author: wschurman

.eslintrc

@@ -8,7 +8,7 @@
     "eslint-plugin-tsdoc"
   ],
   "rules": {
-    "no-restricted-imports": ["error",{ "paths": [".", ".."] }],
+    "no-restricted-imports": ["error",{ "paths": [".", "..", "../.."] }],
     "tsdoc/syntax": "warn"
   },
   "overrides": [

packages/entity-cache-adapter-redis/package.json

@@ -12,7 +12,7 @@
     "tsc": "tsc",
     "clean": "rm -rf build coverage coverage-integration",
     "lint": "eslint src --ext '.ts'",
-    "test": "jest --config ../../resources/jest.config.js --rootDir",
+    "test": "jest --rootDir --config ../../resources/jest.config.js",
     "integration": "../../resources/run-with-docker yarn integration-no-setup",
     "integration-no-setup": "jest --config ../../resources/jest-integration.config.js --rootDir --runInBand --passWithNoTests",
     "barrelsby": "barrelsby --directory src --location top --exclude tests__ --singleQuotes --exportDefault --delete"

packages/entity-cache-adapter-redis/src/testfixtures/createRedisIntegrationTestEntityCompanionProvider.ts

@@ -4,8 +4,8 @@ import {
   EntityCompanionProvider,
   CacheAdapterFlavor,
   DatabaseAdapterFlavor,
-  StubDatabaseAdapter,
   StubQueryContextProvider,
+  StubDatabaseAdapterProvider,
 } from '@expo/entity';
 
 import { RedisCacheAdapterContext } from '../RedisCacheAdapter';
@@ -19,7 +19,7 @@ export const createRedisIntegrationTestEntityCompanionProvider = (
     metricsAdapter,
     {
       [DatabaseAdapterFlavor.POSTGRES]: {
-        adapter: StubDatabaseAdapter,
+        adapterProvider: new StubDatabaseAdapterProvider(),
         queryContextProvider: StubQueryContextProvider,
       },
     },

packages/entity-database-adapter-knex/package.json

@@ -12,7 +12,7 @@
     "tsc": "tsc",
     "clean": "rm -rf build coverage coverage-integration",
     "lint": "eslint src --ext '.ts'",
-    "test": "jest --config ../../resources/jest.config.js --rootDir --passWithNoTests",
+    "test": "jest --rootDir --config ../../resources/jest.config.js --passWithNoTests",
     "integration": "../../resources/run-with-docker yarn integration-no-setup",
     "integration-no-setup": "jest --config ../../resources/jest-integration.config.js --rootDir --runInBand --passWithNoTests",
     "barrelsby": "barrelsby --directory src --location top --exclude tests__ --singleQuotes --exportDefault --delete"

packages/entity-database-adapter-knex/src/PostgresEntityDatabaseAdapterProvider.ts

@@ -0,0 +1,16 @@
+import {
+  IEntityDatabaseAdapterProvider,
+  EntityConfiguration,
+  EntityDatabaseAdapter,
+} from '@expo/entity';
+
+import PostgresEntityDatabaseAdapter from './PostgresEntityDatabaseAdapter';
+
+export default class PostgresEntityDatabaseAdapterProvider
+  implements IEntityDatabaseAdapterProvider {
+  getDatabaseAdapter<TFields>(
+    entityConfiguration: EntityConfiguration<TFields>
+  ): EntityDatabaseAdapter<TFields> {
+    return new PostgresEntityDatabaseAdapter(entityConfiguration);
+  }
+}

packages/entity-database-adapter-knex/src/testfixtures/createKnexIntegrationTestEntityCompanionProvider.ts

@@ -8,7 +8,7 @@ import {
 } from '@expo/entity';
 import Knex from 'knex';
 
-import PostgresEntityDatabaseAdapter from '../PostgresEntityDatabaseAdapter';
+import PostgresEntityDatabaseAdapterProvider from '../PostgresEntityDatabaseAdapterProvider';
 import PostgresEntityQueryContextProvider from '../PostgresEntityQueryContextProvider';
 
 export const createKnexIntegrationTestEntityCompanionProvider = (
@@ -19,7 +19,7 @@ export const createKnexIntegrationTestEntityCompanionProvider = (
     metricsAdapter,
     {
       [DatabaseAdapterFlavor.POSTGRES]: {
-        adapter: PostgresEntityDatabaseAdapter,
+        adapterProvider: new PostgresEntityDatabaseAdapterProvider(),
         queryContextProvider: new PostgresEntityQueryContextProvider(knex),
       },
     },

packages/entity-example/package.json

@@ -7,7 +7,7 @@
     "tsc": "tsc",
     "clean": "rm -rf build coverage coverage-integration",
     "lint": "eslint src --ext '.ts'",
-    "test": "jest --config ../../resources/jest.config.js --rootDir",
+    "test": "jest --rootDir --config ../../resources/jest.config.js",
     "integration": "../../resources/run-with-docker yarn integration-no-setup",
     "integration-no-setup": "jest --config ../../resources/jest-integration.config.js --rootDir --runInBand --passWithNoTests",
     "barrelsby": "barrelsby --directory src --location top --exclude tests__ --singleQuotes --exportDefault --delete",

packages/entity-example/src/adapters/InMemoryDatabaseAdapter.ts

@@ -7,17 +7,26 @@ import {
   TableQuerySelectionModifiers,
   getDatabaseFieldForEntityField,
   EntityConfiguration,
+  IEntityDatabaseAdapterProvider,
 } from '@expo/entity';
 import invariant from 'invariant';
 import { v4 as uuidv4 } from 'uuid';
 
 const dbObjects: Readonly<{ [key: string]: any }>[] = [];
 
+export class InMemoryDatabaseAdapterProvider implements IEntityDatabaseAdapterProvider {
+  getDatabaseAdapter<TFields>(
+    entityConfiguration: EntityConfiguration<TFields>
+  ): EntityDatabaseAdapter<TFields> {
+    return new InMemoryDatabaseAdapter(entityConfiguration);
+  }
+}
+
 /**
  * In-memory database adapter for entity for the purposes of this example. Normally `@expo/entity-database-adapter-knex`
  * or another production adapter would be used. Very similar to StubDatabaseAdapter but shared in a way more akin to a normal database.
  */
-export default class InMemoryDatabaseAdapter<T> extends EntityDatabaseAdapter<T> {
+class InMemoryDatabaseAdapter<T> extends EntityDatabaseAdapter<T> {
   protected getFieldTransformerMap(): FieldTransformerMap {
     return new Map();
   }

packages/entity-example/src/data.ts

@@ -7,7 +7,7 @@ import {
   DatabaseAdapterFlavor,
 } from '@expo/entity';
 
-import InMemoryDatabaseAdapter from './adapters/InMemoryDatabaseAdapter';
+import { InMemoryDatabaseAdapterProvider } from './adapters/InMemoryDatabaseAdapter';
 import InMemoryQueryContextProvider from './adapters/InMemoryQueryContextProvider';
 
 /**
@@ -25,7 +25,7 @@ export const createEntityCompanionProvider = (
       // An in-memory DB is used for demonstration purposes, but generally this would be
       // instantiated with PostgresEntityDatabaseAdapter and PostgresEntityQueryContextProvider
       [DatabaseAdapterFlavor.POSTGRES]: {
-        adapter: InMemoryDatabaseAdapter,
+        adapterProvider: new InMemoryDatabaseAdapterProvider(),
         queryContextProvider: new InMemoryQueryContextProvider(),
       },
     },

packages/entity/package.json

@@ -12,7 +12,7 @@
     "tsc": "tsc",
     "clean": "rm -rf build coverage coverage-integration",
     "lint": "eslint src --ext '.ts'",
-    "test": "jest --config ../../resources/jest.config.js --rootDir",
+    "test": "jest --rootDir --config ../../resources/jest.config.js",
     "integration": "../../resources/run-with-docker yarn integration-no-setup",
     "integration-no-setup": "jest --config ../../resources/jest-integration.config.js --rootDir --runInBand --passWithNoTests",
     "barrelsby": "barrelsby --directory src --location top --exclude tests__ --singleQuotes --exportDefault --delete"