fix: use Gatsby's digest function instead of sha

Author: alvis

source/node.ts

@@ -13,8 +13,6 @@
  * -------------------------------------------------------------------------
  */
 
-import { createHash } from 'crypto';
-
 import { name } from '#.';
 
 import type { NodeInput, NodePluginArgs } from 'gatsby';
@@ -86,7 +84,7 @@ export class NodeManager {
     const oldMap = new Map<string, NormalisedEntity>(
       (await this.cache.get('entityMap')) ?? [],
     );
-    const newMap = computeEntityMap(entities);
+    const newMap = computeEntityMap(entities, this.createContentDigest);
 
     // for the usage of createNode
     // see https://www.gatsbyjs.com/docs/reference/config-files/actions/#createNode
@@ -283,10 +281,12 @@ export class NodeManager {
 /**
  * attach parent-child relationship to gatsby node
  * @param entities all sort of entities including database and page
+ * @param hashFn a hash function for generating the content digest
  * @returns a map of entities with parent and children linked
  */
 export function computeEntityMap(
   entities: FullEntity[],
+  hashFn: (content: string | FullEntity) => string,
 ): Map<string, NormalisedEntity> {
   // create a new working set
   const map = new Map<string, NormalisedEntity>();
@@ -295,7 +295,7 @@ export function computeEntityMap(
       ...entity,
       parent: normaliseParent(entity.parent),
       children: [],
-      digest: createHash('sha256').update(JSON.stringify(entity)).digest('hex'),
+      digest: hashFn(entity),
     });
   }
 

spec/node.spec.ts

@@ -14,6 +14,7 @@
  */
 
 import { caching } from 'cache-manager';
+import { createHash } from 'crypto';
 
 import { computeEntityMap, normaliseParent, NodeManager } from '#node';
 
@@ -74,13 +75,17 @@ function generatePage({
   };
 }
 
+function hashFn(content: string | FullDatabase | FullPage): string {
+  return createHash('sha256').update(JSON.stringify(content)).digest('hex');
+}
+
 describe('fn:computeEntityMap', () => {
   it('pass with a workspace parent', () => {
     const workspaceDatabase = generateDatabase({
       databaseID: 'database_under_a_workspace',
     });
 
-    const map = computeEntityMap([workspaceDatabase]);
+    const map = computeEntityMap([workspaceDatabase], hashFn);
     const normalised = map.get('database:database_under_a_workspace');
     expect(normalised!.id).toEqual('database_under_a_workspace');
     expect(normalised!.parent).toEqual(null);
@@ -93,7 +98,7 @@ describe('fn:computeEntityMap', () => {
       parent: { type: 'page_id', page_id: 'parent-page' },
     });
 
-    const map = computeEntityMap([pageDatabase]);
+    const map = computeEntityMap([pageDatabase], hashFn);
     const normalised = map.get('database:database_under_a_page');
     expect(normalised!.id).toEqual('database_under_a_page');
     expect(normalised!.parent).toEqual({ object: 'page', id: 'parent-page' });
@@ -106,7 +111,7 @@ describe('fn:computeEntityMap', () => {
       parent: { type: 'database_id', database_id: 'missing' },
     });
 
-    const map = computeEntityMap([dangledPage]);
+    const map = computeEntityMap([dangledPage], hashFn);
     const normalised = map.get('page:dangled_page');
     expect(normalised!.id).toEqual('dangled_page');
     expect(normalised!.parent).toEqual({ object: 'database', id: 'missing' });
@@ -129,7 +134,10 @@ describe('fn:computeEntityMap', () => {
       parent: { type: 'page_id', page_id: 'page_with_pages' },
     });
 
-    const map = computeEntityMap([database, ...database.pages, page, subpage]);
+    const map = computeEntityMap(
+      [database, ...database.pages, page, subpage],
+      hashFn,
+    );
     expect(map.size).toEqual(4);
 
     const normalisedDB = map.get('database:database_with_pages');
@@ -194,7 +202,7 @@ describe('cl:NodeManager', () => {
     it('always keep gatsby synced', async () => {
       const createNode = jest.fn();
       const deleteNode = jest.fn();
-      const createContentDigest = jest.fn(() => 'digest');
+      const createContentDigest = jest.fn(hashFn);
       const createNodeId = jest.fn((id) => id);
 
       const manager = new NodeManager({