refactor(oidc-client): move authorize requests into rtk query by cerebrl · Pull Request #378 · ForgeRock/ping-javascript-sdk

cerebrl · 2025-08-26T23:48:02Z

JIRA Ticket

Description

Migrated the fectch and iframe requests to /authorize to the OIDC API that uses RTK Query. This provides better logging and allows for middleware usage.

changeset-bot · 2025-08-26T23:48:06Z

🦋 Changeset detected

Latest commit: 4d0ee71

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 10 packages

Name	Type
@forgerock/oidc-client	Minor
@forgerock/davinci-client	Minor
@forgerock/protect	Minor
@forgerock/sdk-types	Minor
@forgerock/sdk-utilities	Minor
@forgerock/iframe-manager	Minor
@forgerock/sdk-logger	Minor
@forgerock/sdk-oidc	Minor
@forgerock/sdk-request-middleware	Minor
@forgerock/storage	Minor

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

nx-cloud · 2025-08-26T23:48:43Z

View your CI Pipeline Execution ↗ for commit 4d0ee71

Command	Status	Duration	Result
`nx run-many -t build`	✅ Succeeded	<1s	View ↗
`nx affected -t build typecheck lint test e2e-ci`	✅ Succeeded	1m 11s	View ↗
`nx-cloud record -- nx format:check`	✅ Succeeded	1s	View ↗

☁️ Nx Cloud last updated this comment at 2025-08-28 22:22:44 UTC

ancheetah · 2025-08-28T15:28:48Z

packages/oidc-client/src/lib/logout.request.ts

      Micro.promise(async () => {
-        const deleteResponse = await storageClient.remove();
+        const deleteRes = await storageClient.remove();
+        const deleteResponse = typeof deleteRes === 'undefined' ? null : deleteRes;


I wonder if this logic should live in the storage client and we should standardize the return type. Currently, if the customer is using typescript it's not possible for them to use a custom remove function that resolves to some value because remove is typed a Promise<void>. I propose we make the following change in the storage client:

Currently this is the type:

export interface StorageClient<Value> { get: () => Promise<Value | GenericError | null>; set: (value: Value) => Promise<void | { code: string; message: string; type: string; }>; remove: () => Promise<void>; }

Which can be changed to:

export interface StorageClient<Value, T = null> { get: () => Promise<Value | GenericError | null>; set: (value: Value) => Promise<GenericError | null>; remove: () => Promise<T | null>; }

I think this change makes sense, but we'd have to plan it for 2.0.

edit: Actually I suppose this isn't actually breaking

Yeah, I agree. Let's write up a quick story to handle that in the near future. I'd do it now, but I'm starting to get behind in my work :(

ancheetah · 2025-08-28T18:29:59Z

packages/oidc-client/src/lib/oidc.api.ts

+            response.error = {
+              status: responseError.status,
+              statusText: 'AUTHORIZE_ERROR',
+              data: {
+                error: details.code,
+                error_description: details.message,
+                type: 'auth_error',
+              },
+            } as FetchBaseQueryError;


This technically isn't a FetchBaseQueryError because statusText is a an added property. For it to be a FetchBaseQueryError it would have to be something like:

response.error = { status: responseError.status, data: { error: details.code, error_description: details.message, type: 'auth_error', }, error: details.message, };

You are correct. I'm intentionally doing this for reasons that are not easily articulated in a comment. Let's discuss this when we discuss errors on our upcoming call.

ancheetah · 2025-08-28T18:36:32Z

packages/oidc-client/src/lib/oidc.api.ts

+          response.error = {
+            status: responseError.status,
+            statusText: 'CONFIGURATION_ERROR',
+            data: {
+              error: 'FETCH_ERROR',
+              error_description:
+                'Configuration error. Please check your OAuth configuration, like clientId or allowed redirect URLs.',
+              type: 'network_error',
+            },
+          } as FetchBaseQueryError;


Same comment here. This isn't quite a FetchBaseQueryError. We might want to consider using status: 'CUSTOM_ERROR'

Let's talk about this.

ancheetah · 2025-08-28T18:43:31Z

packages/oidc-client/src/lib/authorize.request.ts

+          ).pipe(
+            Micro.flatMap(
+              (response): Micro.Micro<AuthorizationSuccess, AuthorizationError, never> => {
+                if ('error' in response) {


This handles FetchBaseQueryError but not SerializedError. I have an example of handling both in the device client as recommended from the RTK docs.
https://github.com/ForgeRock/ping-javascript-sdk/blob/main/packages/device-client/src/lib/device.store.utils.ts

Okay, I didn't do exactly what you suggested, but I added some handling for it.

codecov-commenter · 2025-08-28T20:10:24Z

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 55.47%. Comparing base (7176dd5) to head (4d0ee71).

Additional details and impacted files

@@           Coverage Diff           @@
##             main     #378   +/-   ##
=======================================
  Coverage   55.47%   55.47%           
=======================================
  Files          32       32           
  Lines        2044     2044           
  Branches      340      340           
=======================================
  Hits         1134     1134           
  Misses        910      910

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

github-actions · 2025-08-28T20:10:44Z

Deployed 193d2b0 to https://ForgeRock.github.io/ping-javascript-sdk/pr-378/193d2b0e55962c103c3cf3fa15bff8d0502cc660 branch gh-pages in ForgeRock/ping-javascript-sdk

github-actions · 2025-08-28T20:10:48Z

📦 Bundle Size Analysis

📊 Minor Changes

📈 @forgerock/oidc-client - 22.3 KB (+1.0 KB)

➖ No Changes

➖ @forgerock/davinci-client - 34.1 KB
➖ @forgerock/sdk-utilities - 4.0 KB
➖ @forgerock/device-client - 9.2 KB
➖ @forgerock/sdk-types - 5.9 KB
➖ @forgerock/protect - 150.1 KB
➖ @forgerock/sdk-oidc - 2.7 KB
➖ @forgerock/sdk-logger - 1.6 KB
➖ @forgerock/storage - 1.4 KB
➖ @forgerock/sdk-request-middleware - 4.4 KB
➖ @forgerock/iframe-manager - 2.4 KB

11 packages analyzed • Baseline from latest main build

Legend

🆕 New package
🔺 Size increased
🔻 Size decreased
➖ No change

ℹ️ How bundle sizes are calculated

Current Size: Total gzipped size of all files in the package's dist directory
Baseline: Comparison against the latest build from the main branch
Files included: All build outputs except source maps and TypeScript build cache
Exclusions: .map, .tsbuildinfo, and .d.ts.map files

_{🔄 Updated automatically on each push to this PR}

cerebrl force-pushed the oidc-authorize-to-rtk-query branch from f4eec22 to f127143 Compare August 28, 2025 02:21

ancheetah reviewed Aug 28, 2025

View reviewed changes

cerebrl force-pushed the oidc-authorize-to-rtk-query branch 3 times, most recently from 9cf39dc to bbfa76a Compare August 28, 2025 20:07

refactor(oidc-client): move authorize requests into rtk query

4d0ee71

cerebrl force-pushed the oidc-authorize-to-rtk-query branch from bbfa76a to 4d0ee71 Compare August 28, 2025 22:20

ancheetah approved these changes Aug 29, 2025

View reviewed changes

ryanbas21 approved these changes Aug 29, 2025

View reviewed changes

cerebrl merged commit 4d4be08 into main Sep 3, 2025
4 checks passed

cerebrl deleted the oidc-authorize-to-rtk-query branch September 3, 2025 19:45

ryanbas21 mentioned this pull request Sep 3, 2025

Release PR #345

Merged

Conversation

cerebrl commented Aug 26, 2025

JIRA Ticket

Description

Uh oh!

changeset-bot bot commented Aug 26, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

🦋 Changeset detected

Uh oh!

nx-cloud bot commented Aug 26, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

ryanbas21 Aug 28, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

codecov-commenter commented Aug 28, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

github-actions bot commented Aug 28, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

github-actions bot commented Aug 28, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

📦 Bundle Size Analysis

📦 Bundle Size Analysis

Legend

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Milestone

Development

Uh oh!

4 participants

changeset-bot bot commented Aug 26, 2025 •

edited

Loading

nx-cloud bot commented Aug 26, 2025 •

edited

Loading

ryanbas21 Aug 28, 2025 •

edited

Loading

codecov-commenter commented Aug 28, 2025 •

edited

Loading

github-actions bot commented Aug 28, 2025 •

edited

Loading

github-actions bot commented Aug 28, 2025 •

edited

Loading