feat(js-api-client): Add server timings to profiling.

Author: Plopix

package.json

@@ -1,7 +1,7 @@
 {
     "name": "@crystallize/js-api-client",
     "license": "MIT",
-    "version": "1.11.0",
+    "version": "1.12.0",
     "author": "Crystallize <[email protected]> (https://crystallize.com)",
     "contributors": [
         "Sébastien Morel <[email protected]>"

src/core/client.ts

@@ -11,8 +11,18 @@ export type ClientConfiguration = {
 };
 
 type ProfilingOptions = {
-    onRequest: (query: string, variables?: VariablesType) => void;
-    onRequestResolved: (processingTimeMs: number, query: string, variables?: VariablesType) => void;
+    onRequest?: (query: string, variables?: VariablesType) => void;
+    onRequestResolved: (
+        {
+            resolutionTimeMs,
+            serverTimeMs,
+        }: {
+            resolutionTimeMs: number;
+            serverTimeMs: number;
+        },
+        query: string,
+        variables?: VariablesType,
+    ) => void;
 };
 
 export type CreateClientOptions = {
@@ -69,7 +79,9 @@ async function post<T>(
         let start: number = 0;
         if (profiling) {
             start = Date.now();
-            profiling.onRequest(query, variables);
+            if (profiling.onRequest) {
+                profiling.onRequest(query, variables);
+            }
         }
 
         const response = await fetch(path, {
@@ -81,7 +93,16 @@ async function post<T>(
 
         if (profiling) {
             const ms = Date.now() - start;
-            profiling.onRequestResolved(ms, query, variables);
+            const serverTiming = response.headers.get('server-timing') ?? undefined;
+            const duration = serverTiming?.split(';')[1]?.split('=')[1] ?? -1;
+            profiling.onRequestResolved(
+                {
+                    resolutionTimeMs: ms,
+                    serverTimeMs: Number(duration),
+                },
+                query,
+                variables,
+            );
         }
         if (response.ok && 204 === response.status) {
             return <T>{};

tests/catalogue-profiled.test.js

@@ -26,11 +26,12 @@ test('Test with Profiling 1 ', async () => {
                         },
                     };
                 },
-                onRequestResolved: (processingTimeMs, query, variables) => {
+                onRequestResolved: ({ resolutionTimeMs, serverTimeMs }, query, variables) => {
                     profiledQuery = {
                         ...profiledQuery,
                         onRequestResolved: {
-                            processingTimeMs,
+                            resolutionTimeMs,
+                            serverTimeMs,
                             query,
                             variables,
                         },
@@ -67,5 +68,6 @@ test('Test with Profiling 1 ', async () => {
 
     expect(profiledQuery.onRequestResolved.query).toBe(expectedQuery);
     expect(profiledQuery.onRequestResolved.variables).toBe(variables);
-    expect(profiledQuery.onRequestResolved.processingTimeMs).toBeGreaterThan(0);
+    expect(profiledQuery.onRequestResolved.resolutionTimeMs).toBeGreaterThan(0);
+    expect(profiledQuery.onRequestResolved.serverTimeMs).toBeGreaterThan(0);
 });