Merge pull request #651 from LIT-Protocol/LIT-3896-wrappedkeys-requestid-errorlogs

LIT-3896 - Better error logs & request id tracking and submission for wrapped-keys service client

Author: MaximusHaximus

packages/wrapped-keys/src/lib/api/sign-message-with-encrypted-key.ts

@@ -25,8 +25,6 @@ export async function signMessageWithEncryptedKey(
     litNetwork: litNodeClient.config.litNetwork,
   });
 
-  console.log('fetched metadata', storedKeyMetadata);
-
   const allowPkpAddressToDecrypt = getPkpAccessControlCondition(
     storedKeyMetadata.pkpAddress
   );

packages/wrapped-keys/src/lib/service-client/client.ts

@@ -1,5 +1,5 @@
 import { FetchKeyParams, ListKeysParams, StoreKeyParams } from './types';
-import { getBaseRequestParams, makeRequest } from './utils';
+import { generateRequestId, getBaseRequestParams, makeRequest } from './utils';
 import {
   StoredKeyData,
   StoredKeyMetadata,
@@ -19,17 +19,20 @@ export async function listPrivateKeyMetadata(
 ): Promise<StoredKeyMetadata[]> {
   const { litNetwork, sessionSig } = params;
 
+  const requestId = generateRequestId();
   const { baseUrl, initParams } = getBaseRequestParams({
     litNetwork,
     sessionSig,
     method: 'GET',
+    requestId,
   });
 
   const pkpAddress = getPkpAddressFromSessionSig(sessionSig);
 
   return makeRequest<StoredKeyMetadata[]>({
     url: `${baseUrl}/${pkpAddress}`,
     init: initParams,
+    requestId,
   });
 }
 
@@ -44,16 +47,19 @@ export async function fetchPrivateKey(
 ): Promise<StoredKeyData> {
   const { litNetwork, sessionSig, id } = params;
 
+  const requestId = generateRequestId();
   const { baseUrl, initParams } = getBaseRequestParams({
     litNetwork,
     sessionSig,
     method: 'GET',
+    requestId,
   });
   const pkpAddress = getPkpAddressFromSessionSig(sessionSig);
 
   return makeRequest<StoredKeyData>({
     url: `${baseUrl}/${pkpAddress}/${id}`,
     init: initParams,
+    requestId,
   });
 }
 
@@ -67,10 +73,12 @@ export async function storePrivateKey(
 ): Promise<StoreEncryptedKeyResult> {
   const { litNetwork, sessionSig, storedKeyMetadata } = params;
 
+  const requestId = generateRequestId();
   const { baseUrl, initParams } = getBaseRequestParams({
     litNetwork,
     sessionSig,
     method: 'POST',
+    requestId,
   });
 
   const { pkpAddress, id } = await makeRequest<StoreEncryptedKeyResult>({
@@ -79,6 +87,7 @@ export async function storePrivateKey(
       ...initParams,
       body: JSON.stringify(storedKeyMetadata),
     },
+    requestId,
   });
 
   return { pkpAddress, id };

packages/wrapped-keys/src/lib/service-client/types.ts

@@ -34,4 +34,5 @@ export interface BaseRequestParams {
   sessionSig: AuthSig;
   method: 'GET' | 'POST';
   litNetwork: LIT_NETWORKS_KEYS;
+  requestId: string;
 }

packages/wrapped-keys/src/lib/service-client/utils.ts

@@ -57,6 +57,7 @@ export function getBaseRequestParams(requestParams: BaseRequestParams): {
     initParams: {
       method,
       headers: {
+        'x-correlation-id': requestParams.requestId,
         'Content-Type': 'application/json',
         'Lit-Network': litNetwork,
         Authorization: composeAuthHeader(sessionSig), // As Base64 string to avoid escaping issues
@@ -104,29 +105,40 @@ async function getResponseJson<T>(response: Response): Promise<T | string> {
   }
 }
 
+export function generateRequestId(): string {
+  return Math.random().toString(16).slice(2);
+}
+
 export async function makeRequest<T>({
   url,
   init,
+  requestId,
 }: {
   url: string;
   init: RequestInit;
+  requestId: string;
 }) {
-  console.log('Fetching from URL', url);
-  const response = await fetch(url, { ...init });
+  try {
+    const response = await fetch(url, { ...init });
 
-  if (!response.ok) {
-    const errorMessage = await getResponseErrorMessage(response);
-    throw new Error(`Failed to make request for wrapped key: ${errorMessage}`);
-  }
+    if (!response.ok) {
+      const errorMessage = await getResponseErrorMessage(response);
+      throw new Error(`HTTP(${response.status}): ${errorMessage}`);
+    }
 
-  /**
-   *
-   */
-  const result = await getResponseJson<T>(response);
+    const result = await getResponseJson<T>(response);
 
-  if (typeof result === 'string') {
-    throw new Error(`Unexpected response from wrapped key service: ${result}`);
-  }
+    if (typeof result === 'string') {
+      throw new Error(`HTTP(${response.status}): ${result}`);
+    }
 
-  return result;
+    return result;
+  } catch (e: unknown) {
+    throw new Error(
+      `Request(${requestId}) for wrapped key failed. Error: ${
+        (e as Error).message
+        // @ts-expect-error Unknown, but `cause` is on `TypeError: fetch failed` errors
+      }${e.cause ? ' - ' + e.cause : ''}`
+    );
+  }
 }