Merge pull request #293 from ForgeRock/feat_introduce-effect-ts

feat(davinci-client): implement logger module

Author: cerebrl

.changeset/deep-hornets-hunt.md

@@ -1,5 +1,5 @@
 ---
-
-## '@forgerock/davinci-client': minor
+'@forgerock/davinci-client': minor
+---
 
 provide a client type that handles the awaiting of the davinci client initalization and a type for handling getClient call so consumers have the type available easily

.changeset/happy-dots-nail.md

@@ -0,0 +1,5 @@
+---
+'@forgerock/davinci-client': minor
+---
+
+Implement the logger module to DaVinci Client

.changeset/wide-cooks-show.md

@@ -0,0 +1,5 @@
+---
+'@forgerock/sdk-logger': minor
+---
+
+Add custom logger API option to logger module

.gitignore

@@ -76,3 +76,5 @@ packages/davinci-client/src/lib/mock-data/*.d.ts.map
 **/**/tsconfig.spec.vitest-temp.json
 
 test-output
+.cursor/rules/nx-rules.mdc
+.github/instructions/nx.instructions.md

e2e/davinci-app/main.ts

@@ -9,10 +9,11 @@ import './style.css';
 import { Config, FRUser, TokenManager } from '@forgerock/javascript-sdk';
 import { davinci } from '@forgerock/davinci-client';
 import type {
+  CustomLogger,
   DaVinciConfig,
-  RequestMiddleware,
   DavinciClient,
   GetClient,
+  RequestMiddleware,
 } from '@forgerock/davinci-client/types';
 
 import textComponent from './components/text.js';
@@ -27,12 +28,34 @@ import multiValueComponent from './components/multi-value.js';
 import labelComponent from './components/label.js';
 import objectValueComponent from './components/object-value.js';
 
+const loggerFn = {
+  error: () => {
+    console.error(`[ERROR] This is a custom logger function output.`);
+  },
+  warn: () => {
+    console.warn(`[WARN] This is a custom logger function output.`);
+  },
+  info: () => {
+    console.info(`[INFO] This is a custom logger function output.`);
+  },
+  debug: () => {
+    console.debug(`[DEBUG] This is a custom logger function output.`);
+  },
+} satisfies CustomLogger;
+
 const qs = window.location.search;
 const searchParams = new URLSearchParams(qs);
 
 const config: DaVinciConfig =
   serverConfigs[searchParams.get('clientId') || '724ec718-c41c-4d51-98b0-84a583f450f9'];
 
+const logger: { level: 'debug'; custom?: typeof loggerFn } = {
+  level: 'debug' as const,
+};
+if (searchParams.get('logFn') === 'true') {
+  logger.custom = loggerFn;
+}
+
 const requestMiddleware: RequestMiddleware<'DAVINCI_NEXT' | 'DAVINCI_START'>[] = [
   (fetchArgs, action, next) => {
     if (action.type === 'DAVINCI_START') {
@@ -53,7 +76,7 @@ const requestMiddleware: RequestMiddleware<'DAVINCI_NEXT' | 'DAVINCI_START'>[] =
 const urlParams = new URLSearchParams(window.location.search);
 
 (async () => {
-  const davinciClient: DavinciClient = await davinci({ config, requestMiddleware });
+  const davinciClient: DavinciClient = await davinci({ config, logger, requestMiddleware });
   const continueToken = urlParams.get('continueToken');
   const formEl = document.getElementById('form') as HTMLFormElement;
   let resumed: any;

e2e/davinci-app/package.json

@@ -15,7 +15,8 @@
   },
   "dependencies": {
     "@forgerock/davinci-client": "workspace:*",
-    "@forgerock/javascript-sdk": "4.7.0"
+    "@forgerock/javascript-sdk": "4.7.0",
+    "@forgerock/sdk-logger": "workspace:*"
   },
   "devDependencies": {}
 }

e2e/davinci-app/tsconfig.app.json

@@ -12,6 +12,9 @@
     "components/**/*.ts"
   ],
   "references": [
+    {
+      "path": "../../packages/sdk-effects/logger/tsconfig.lib.json"
+    },
     {
       "path": "../../packages/davinci-client/tsconfig.lib.json"
     }

e2e/davinci-app/tsconfig.json

@@ -14,6 +14,9 @@
     "skipLibCheck": true
   },
   "references": [
+    {
+      "path": "../../packages/sdk-effects/logger"
+    },
     {
       "path": "../../packages/davinci-client"
     },

e2e/davinci-suites/src/logging.test.ts

@@ -0,0 +1,70 @@
+/*
+ * Copyright (c) 2025 Ping Identity Corporation. All rights reserved.
+ *
+ * This software may be modified and distributed under the terms
+ * of the MIT license. See the LICENSE file for details.
+ */
+import { expect, test } from '@playwright/test';
+import { asyncEvents } from './utils/async-events.js';
+import { password, username } from './utils/demo-user.js';
+
+test('Test debug log level and custom logger functions', async ({ page }) => {
+  const { navigate } = asyncEvents(page);
+  const messageArray: string[] = [];
+
+  // Listen for events on page
+  page.on('console', async (msg) => {
+    messageArray.push(msg.text());
+    return Promise.resolve(true);
+  });
+
+  await navigate('/?logFn=true');
+
+  expect(page.url()).toBe('http://localhost:5829/?logFn=true');
+
+  await expect(page.getByText('Username/Password Form')).toBeVisible();
+
+  await page.getByLabel('Username').fill(username);
+  await page.getByLabel('Password').fill(password);
+
+  await page.getByRole('button', { name: 'Sign On' }).click();
+
+  await expect(page.getByText('Complete')).toBeVisible();
+
+  // Just test if the custom debug function is called
+  expect(
+    messageArray.includes('[DEBUG] This is a custom logger function output.'),
+    'Custom debug function output string should be present',
+  ).toBe(true);
+});
+
+test('Test log level without custom logger', async ({ page }) => {
+  const { navigate } = asyncEvents(page);
+  const messageArray: string[] = [];
+
+  // Listen for events on page
+  page.on('console', async (msg) => {
+    messageArray.push(msg.text());
+    return Promise.resolve(true);
+  });
+
+  await navigate('/');
+
+  expect(page.url()).toBe('http://localhost:5829/');
+
+  await expect(page.getByText('Username/Password Form')).toBeVisible();
+
+  await page.getByLabel('Username').fill(username);
+  await page.getByLabel('Password').fill(password);
+
+  await page.getByRole('button', { name: 'Sign On' }).click();
+
+  await expect(page.getByText('Complete')).toBeVisible();
+
+  messageArray.forEach((msg) => {
+    // Ensure a debug message is present, but don't check the whole contents
+    if (msg.includes('DaVinci API Request')) {
+      expect(msg).toContain('DaVinci API Response');
+    }
+  });
+});

packages/davinci-client/package.json

@@ -23,6 +23,7 @@
     "test:watch": "pnpm nx nxTest --watch"
   },
   "dependencies": {
+    "@forgerock/sdk-logger": "workspace:*",
     "@forgerock/sdk-oidc": "workspace:*",
     "@forgerock/sdk-request-middleware": "workspace:*",
     "@forgerock/sdk-types": "workspace:*",