@expo/entity-database-adapter-knex-testing-utils 0.57.0

package/src/__tests__/createUnitTestPostgresEntityCompanionProvider-test.ts

@@ -0,0 +1,16 @@
+import { EntityCompanionProvider, ViewerContext } from '@expo/entity';
+import { describe, expect, it } from '@jest/globals';
+
+import { TestEntity } from '../__testfixtures__/TestEntity';
+import { createUnitTestPostgresEntityCompanionProvider } from '../createUnitTestPostgresEntityCompanionProvider';
+
+describe(createUnitTestPostgresEntityCompanionProvider, () => {
+  it('creates a new EntityCompanionProvider', async () => {
+    const companionProvider = createUnitTestPostgresEntityCompanionProvider();
+    expect(companionProvider).toBeInstanceOf(EntityCompanionProvider);
+    const viewerContext = new ViewerContext(companionProvider);
+    await expect(TestEntity.creator(viewerContext).createAsync()).resolves.toBeInstanceOf(
+      TestEntity,
+    );
+  });
+});

package/src/createUnitTestPostgresEntityCompanionProvider.ts

@@ -0,0 +1,42 @@
+import {
+  EntityCompanionProvider,
+  IEntityMetricsAdapter,
+  NoOpEntityMetricsAdapter,
+} from '@expo/entity';
+import {
+  InMemoryFullCacheStubCacheAdapterProvider,
+  StubQueryContextProvider,
+} from '@expo/entity-testing-utils';
+
+import { StubPostgresDatabaseAdapterProvider } from './StubPostgresDatabaseAdapterProvider';
+
+const queryContextProvider = new StubQueryContextProvider();
+
+/**
+ * Entity companion provider for use in knex unit tests. All database and cache implementations
+ * are replaced with in-memory simulations.
+ */
+export const createUnitTestPostgresEntityCompanionProvider = (
+  metricsAdapter: IEntityMetricsAdapter = new NoOpEntityMetricsAdapter(),
+): EntityCompanionProvider => {
+  return new EntityCompanionProvider(
+    metricsAdapter,
+    new Map([
+      [
+        'postgres',
+        {
+          adapterProvider: new StubPostgresDatabaseAdapterProvider(),
+          queryContextProvider,
+        },
+      ],
+    ]),
+    new Map([
+      [
+        'redis',
+        {
+          cacheAdapterProvider: new InMemoryFullCacheStubCacheAdapterProvider(),
+        },
+      ],
+    ]),
+  );
+};

package/src/index.ts

@@ -0,0 +1,9 @@
+/* eslint-disable tsdoc/syntax */
+/**
+ * @packageDocumentation
+ * @module @expo/entity-database-adapter-knex-testing-utils
+ */
+
+export * from './createUnitTestPostgresEntityCompanionProvider';
+export * from './StubPostgresDatabaseAdapter';
+export * from './StubPostgresDatabaseAdapterProvider';