Use ohash for cache key generation

Author: davidkna-sap

.github/dependabot.yml

@@ -30,6 +30,9 @@ updates:
       # yargs v18 needs ESM, see https://github.com/yargs/yargs/releases/tag/v18.0.0, we'll stay on v17 until we can use ESM
       - dependency-name: 'yargs'
         update-types: ['version-update:semver-major']
+      # ohash v2 needs ESM, https://github.com/unjs/ohash/releases/tag/v2.0.1, we'll stay on v1 until we can use ESM
+      - dependency-name: 'ohash'
+        update-types: ['version-update:semver-major']
   - package-ecosystem: 'github-actions'
     directory: '/'
     schedule:

packages/connectivity/src/http-agent/http-agent.ts

@@ -2,12 +2,14 @@ import { readFile } from 'node:fs/promises';
 import http from 'node:http';
 import https from 'node:https';
 import * as jks from 'jks-js';
+// @ts-expect-error - ts fails to detect that this package provides CJS exports
+import * as ohash from 'ohash';
 import { createLogger, last } from '@sap-cloud-sdk/util';
 /* Careful the proxy imports cause circular dependencies if imported from scp directly */
 // eslint-disable-next-line import/no-internal-modules
 import { getProtocolOrDefault } from '../scp-cf/get-protocol';
 // eslint-disable-next-line import/no-internal-modules
-import { Cache, hashCacheKey } from '../scp-cf/cache';
+import { Cache } from '../scp-cf/cache';
 import {
   addProxyConfigurationInternet,
   getProxyConfig,
@@ -307,8 +309,7 @@ function createAgent(
   options: https.AgentOptions
 ): HttpAgentConfig | HttpsAgentConfig {
   const protocol = getProtocolOrDefault(destination);
-  const cacheKey = hashCacheKey({ protocol, options });
-
+  const cacheKey = ohash.hash({ protocol, options });
   return agentCreateCache.getOrInsertComputed(cacheKey, () => {
     logger.debug(
       `Creating new ${protocol.toUpperCase()} agent for destination ${destination.name || '<unknown>'}`

packages/connectivity/src/scp-cf/cache.ts

@@ -1,5 +1,3 @@
-import { createHash } from 'node:crypto';
-
 interface CacheInterface<T> {
   hasKey(key: string): boolean;
   get(key: string | undefined): T | undefined;
@@ -149,17 +147,6 @@ export class Cache<T> implements CacheInterface<T> {
   }
 }
 
-/**
- * Hashes the given value to create a cache key.
- * @internal
- * @param value - The value to hash.
- * @returns A hash of the given value using a cryptographic hash function.
- */
-export function hashCacheKey(value: Record<string, unknown>): string {
-  const serialized = JSON.stringify(value);
-  return createHash('blake2s256').update(serialized).digest('hex');
-}
-
 function isExpired<T>(item: CacheEntry<T>): boolean {
   if (item.expires === undefined) {
     return false;

packages/http-client/package.json

@@ -48,6 +48,7 @@
   "devDependencies": {
     "https-proxy-agent": "^7.0.6",
     "nock": "^14.0.11",
+    "ohash": "^1.1.6",
     "typescript": "~5.9.3",
     "jsonwebtoken": "^9.0.3"
   }

yarn.lock

@@ -7342,6 +7342,11 @@ object.values@^1.2.1:
     define-properties "^1.2.1"
     es-object-atoms "^1.0.0"
 
+ohash@^1.1.6:
+  version "1.1.6"
+  resolved "https://registry.npmjs.org/ohash/-/ohash-1.1.6.tgz#9ff7b0271d7076290794537d68ec2b40a60d133e"
+  integrity sha512-TBu7PtV8YkAZn0tSxobKY2n2aAQva936lhRrj6957aDaCf9IEtqsKbgMzXE/F/sjqYOwmrukeORHNLe5glk7Cg==
+
 [email protected], on-finished@^2.4.1, on-finished@~2.4.1:
   version "2.4.1"
   resolved "https://registry.npmjs.org/on-finished/-/on-finished-2.4.1.tgz#58c8c44116e54845ad57f14ab10b03533184ac3f"