Merge pull request #11 from sevenwestmedia/feat/ExposeTheCacheKeyToUser

feat: Expose paramsCacheKey to consumers
sevenwestmedia · Sep 3, 2019 · 8c68b2e · 8c68b2e
2 parents 5234f16 + 5e653a6
commit 8c68b2e
Show file tree

Hide file tree

Showing 4 changed files with 14 additions and 3 deletions.
diff --git a/src/data-loader-resources.ts b/src/data-loader-resources.ts
@@ -2,7 +2,13 @@ import { createTypedDataLoader, DataLoaderActions } from './data-loader'
 import { LoaderStatus } from './data-loader-state'
 
 export type LoadResource<TData, TResourceParameters, TInternalState, TGlobalParameters> = (
-    params: { resourceType: string } & TResourceParameters & TInternalState & TGlobalParameters,
+    params: {
+        resourceType: string
+        /** This is the key the data loader uses for looking up the data */
+        paramsCacheKey: string
+    } & TResourceParameters &
+        TInternalState &
+        TGlobalParameters,
 ) => Promise<TData> | TData
 
 interface Resources {

diff --git a/src/data-loader-store-and-loader.ts b/src/data-loader-store-and-loader.ts
@@ -18,6 +18,10 @@ export interface ActionResult<TInternalState> {
 
 export interface LoadParams {
     resourceType: string
+
+    /** This is the key the data loader uses for looking up the data */
+    paramsCacheKey: string
+
     [param: string]: any
 }
 
@@ -168,7 +172,7 @@ export class DataLoaderStoreAndLoader {
 
         let result: any
         try {
-            result = this.performLoad(paramsObject)
+            result = this.performLoad({ ...paramsObject, paramsCacheKey: paramsObjectHash })
         } catch (err) {
             this.updateParamsHashState(paramsObjectHash, {
                 status: LoaderStatus.Idle,

diff --git a/tests/__snapshots__/data-loader.params.spec.tsx.snap b/tests/__snapshots__/data-loader.params.spec.tsx.snap
@@ -7,6 +7,7 @@ Object {
   "passedParams": Object {
     "bar": 1,
     "id": "testKey",
+    "paramsCacheKey": "7a4496e0",
     "resourceType": "testDataType",
   },
   "renderActions": Object {

diff --git a/tests/data-loader.params.spec.tsx b/tests/data-loader.params.spec.tsx
@@ -12,7 +12,7 @@ describe('data-loader', () => {
 
         await sut.testDataPromise.resolve({ result: 'Test' })
 
-        expect(sut.passedParams).toEqual(args)
+        expect(sut.passedParams).toEqual({ ...args, paramsCacheKey: '7a4496e0' })
         sut.assertState()
     })