Improve tests and ts docs

expo · Jun 11, 2024 · 97ef6f1 · 97ef6f1
1 parent c483e0b
commit 97ef6f1
Show file tree

Hide file tree

Showing 5 changed files with 9 additions and 9 deletions.
diff --git a/packages/entity/src/EntityCompanion.ts b/packages/entity/src/EntityCompanion.ts
@@ -7,7 +7,7 @@ import ReadonlyEntity from './ReadonlyEntity';
 import ViewerContext from './ViewerContext';
 import EntityTableDataCoordinator from './internal/EntityTableDataCoordinator';
 import IEntityMetricsAdapter from './metrics/IEntityMetricsAdapter';
-import { mergeEntityMutationTriggerConfigurations } from './utils/mergeMutationTriggers';
+import { mergeEntityMutationTriggerConfigurations } from './utils/mergeEntityMutationTriggerConfigurations';
 
 export interface IPrivacyPolicyClass<TPrivacyPolicy> {
   new (): TPrivacyPolicy;

diff --git a/packages/entity/src/EntityCompanionProvider.ts b/packages/entity/src/EntityCompanionProvider.ts
@@ -139,7 +139,7 @@ export default class EntityCompanionProvider {
    * @param metricsAdapter - An IEntityMetricsAdapter for collecting metrics on this instance
    * @param databaseAdapterFlavors - Database adapter configurations for this instance
    * @param cacheAdapterFlavors - Cache adapter configurations for this instance
-   * @param globalMutationTriggers - An optional list of EntityMutationTrigger for all entities.
+   * @param globalMutationTriggers - Optional set of EntityMutationTrigger to run for all entity mutations systemwide.
    */
   constructor(
     public readonly metricsAdapter: IEntityMetricsAdapter,

diff --git a/packages/entity/src/__tests__/EntityCompanion-test.ts b/packages/entity/src/__tests__/EntityCompanion-test.ts
@@ -70,10 +70,10 @@ describe(EntityCompanion, () => {
     const localTriggers = companion.entityCompanionDefinition.mutationTriggers;
     expect(localTriggers).toBeTruthy();
 
-    expect(mergedTriggers.afterCreate![0]).toBe(localTriggers!.afterCreate![0]);
-    expect(mergedTriggers.afterCreate![1]).toBe(globalMutationTriggers.afterCreate![0]);
-    expect(mergedTriggers.afterAll![0]).toBe(localTriggers!.afterAll![0]);
-    expect(mergedTriggers.afterAll![1]).toBe(globalMutationTriggers!.afterAll![0]);
-    expect(mergedTriggers.afterCommit![0]).toBe(localTriggers!.afterCommit![0]);
+    expect(mergedTriggers).toStrictEqual({
+      afterCreate: [localTriggers!.afterCreate![0], globalMutationTriggers.afterCreate![0]],
+      afterAll: [localTriggers!.afterAll![0], globalMutationTriggers!.afterAll![0]],
+      afterCommit: [localTriggers!.afterCommit![0]],
+    });
   });
 });
diff --git a/...s/__tests__/mergeMutationTriggers-test.ts → ...tityMutationTriggerConfigurations-test.ts b/...s/__tests__/mergeMutationTriggers-test.ts → ...tityMutationTriggerConfigurations-test.ts
@@ -1,5 +1,5 @@
 import { TestMutationTrigger } from '../../testfixtures/TestEntityWithMutationTriggers';
-import { mergeEntityMutationTriggerConfigurations } from '../mergeMutationTriggers';
+import { mergeEntityMutationTriggerConfigurations } from '../mergeEntityMutationTriggerConfigurations';
 
 describe(mergeEntityMutationTriggerConfigurations, () => {
   it('successfully merges triggers', async () => {

diff --git a/...entity/src/utils/mergeMutationTriggers.ts → ...rgeEntityMutationTriggerConfigurations.ts b/...entity/src/utils/mergeMutationTriggers.ts → ...rgeEntityMutationTriggerConfigurations.ts
@@ -35,7 +35,7 @@ export function mergeEntityMutationTriggerConfigurations<
 
   /** Remove any trigger that is an empty array */
   for (const key of Object.keys(merged) as (keyof typeof merged)[]) {
-    if (!merged[key]?.length) {
+    if (merged[key].length === 0) {
       delete merged[key];
     }
   }