feat(oidc-client): improving types and completing userinfo #363

cerebrl · 2025-08-06T02:34:04Z

JIRA Ticket

SDKS-4251

Description

Complete userinfo endpoint work and improve error typing across SDK.

changeset-bot · 2025-08-06T02:34:08Z

🦋 Changeset detected

Latest commit: 6c06e70

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

This PR includes changesets to release 9 packages

Name	Type
@forgerock/oidc-client	Minor
@forgerock/storage	Minor
@forgerock/davinci-client	Minor
@forgerock/sdk-types	Minor
@forgerock/sdk-oidc	Minor
@forgerock/sdk-utilities	Minor
@forgerock/iframe-manager	Minor
@forgerock/sdk-logger	Minor
@forgerock/sdk-request-middleware	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-06T02:34:47Z

View your CI Pipeline Execution ↗ for commit 6c06e70

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

☁️ Nx Cloud last updated this comment at 2025-08-07 22:06:36 UTC

codecov-commenter · 2025-08-06T02:37:23Z

Codecov Report

❌ Patch coverage is 33.33333% with 2 lines in your changes missing coverage. Please review.
✅ Project coverage is 60.42%. Comparing base (ccf3fc1) to head (6c06e70).
⚠️ Report is 2 commits behind head on main.

Files with missing lines	Patch %	Lines
packages/davinci-client/src/lib/node.slice.ts	33.33%	2 Missing ⚠️

❌ Your patch status has failed because the patch coverage (33.33%) is below the target coverage (40.00%). You can increase the patch coverage or adjust the target coverage.

Additional details and impacted files

@@            Coverage Diff             @@
##             main     #363      +/-   ##
==========================================
+ Coverage   52.26%   60.42%   +8.15%     
==========================================
  Files          20       32      +12     
  Lines        1588     2044     +456     
  Branches      188      290     +102     
==========================================
+ Hits          830     1235     +405     
- Misses        758      809      +51

Files with missing lines	Coverage Δ
packages/davinci-client/src/lib/client.types.ts	`100.00% <ø> (ø)`
packages/davinci-client/src/lib/node.types.ts	`100.00% <ø> (ø)`
packages/davinci-client/src/lib/node.slice.ts	`78.44% <33.33%> (ø)`

... and 13 files with indirect coverage changes

🚀 New features to boost your workflow:

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

github-actions · 2025-08-06T02:37:43Z

Deployed 943b676 to https://ForgeRock.github.io/ping-javascript-sdk/pr-363/943b676a92368e29712bfb59020adf8ee6b86cad branch gh-pages in ForgeRock/ping-javascript-sdk

github-actions · 2025-08-06T02:37:47Z

📦 Bundle Size Analysis

🚨 Significant Changes

🔺 @forgerock/oidc-client - 17.9 KB (+4.3 KB, +31.3%)

📊 Minor Changes

📉 @forgerock/davinci-client - 34.1 KB (-0.2 KB)
📈 @forgerock/sdk-types - 5.9 KB (+0.3 KB)
📉 @forgerock/storage - 1.4 KB (-0.0 KB)

➖ No Changes

➖ @pingidentity/protect - 108.4 KB
➖ @forgerock/device-client - 9.2 KB
➖ @forgerock/sdk-utilities - 4.0 KB
➖ @forgerock/sdk-oidc - 3.5 KB
➖ @forgerock/sdk-request-middleware - 4.2 KB
➖ @forgerock/sdk-logger - 1.6 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}

ryanbas21 · 2025-08-06T14:58:09Z

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

  config: OidcConfig,
  options: GetAuthorizationUrlOptions,
-) {
+): Micro.Micro<never, AuthorizeErrorResponse, never> {


We may have spoken about this but why do we only return an error here? it feels odd?

I believe we spoke about this very piece of code in our meeting, but let me know if you have any follow up questions.

ancheetah

Looks good. Left a few comments just for typos.

ancheetah · 2025-08-07T19:01:55Z

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

+       * @param code - The authorization code received from the authorization server.
+       * @param state - The state parameter from the authorization URL creation.
+       * @param options - Optional storage configuration for persisting tokens.


params are missing documented types

ancheetah · 2025-08-07T19:02:47Z

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

+       * @param code - The authorization code received from the authorization server.
+       * @param state - The state parameter from the authorization URL creation.
+       * @param options - Optional storage configuration for persisting tokens.
+       * @returns {Promise<TokenExchangeErrorResponse | OauthTokens>}


Looks like the return type here should be updated to Promise<TokenExchangeResponse | GenericError | TokenExchangeErrorResponse>

ancheetah · 2025-08-07T19:04:51Z

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

+      /**
+       * @function info - Retrieves user information using the userinfo endpoint from the wellknown configuration.
+       *                  It requires an access token stored in the configured storage.
+       * @returns {Promise<AuthorizeErrorResponse | any>} - Returns a promise that resolves to user information or an error response.


return type should be Promise<GenericError | TokenExchangeResponse>

ancheetah · 2025-08-07T19:17:38Z

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

+ * @param {WellKnownResponse} wellknown - The well-known configuration for the OIDC server.
+ * @param {OidcConfig} config - The OIDC client configuration.
+ * @param {OptionalAuthorizeOptions} options - Optional parameters for the authorization request.
+ * @description Builds the authorization options for the OIDC client.


duplicate. already a description above

ancheetah · 2025-08-07T19:22:04Z

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

  config: OidcConfig,
  options: GetAuthorizationUrlOptions,
-) {
+): Micro.Micro<[string, OidcConfig, GetAuthorizationUrlOptions], AuthorizeErrorResponse, never> {


Nothing wrong here. Just wanted to mention that I really like when you include the return types for effects on functions like you did here. It helps me better understand the return type without having to hover over for intellisense.

ryanbas21

just two small comments

ryanbas21 · 2025-08-07T20:17:29Z

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

+          ),
+        ).pipe(
+          Micro.map(({ data, error }) => {
+            if (error) {


Should we not fail here? I know RTK doesn't error, but i'm curious if there's any benefit to us manually handling it this way instead?

The benefit I see is more explicit handling of error paths rather than inter-mixing it as much in the success.

Small benefit perhaps. Nothing major.

Yeah, I can make this change.

ryanbas21 · 2025-08-07T20:18:32Z

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

+              if ('status' in error) {
+                status = error.status;
+              }
+              return {


I am curious if we added readonly _tag property if we would get the benefit of Error discrimination without using the Micro.TaggedError class

ryanbas21 reviewed Aug 6, 2025

View reviewed changes

cerebrl force-pushed the oidc-userinfo branch from 2065d4b to af36747 Compare August 6, 2025 22:49

ancheetah requested changes Aug 7, 2025

View reviewed changes

ryanbas21 approved these changes Aug 7, 2025

View reviewed changes

feat(oidc-client): improving types and completing userinfo

6c06e70

cerebrl force-pushed the oidc-userinfo branch from af36747 to 6c06e70 Compare August 7, 2025 22:04

ancheetah approved these changes Aug 8, 2025

View reviewed changes

cerebrl merged commit b917bb2 into main Aug 8, 2025
3 checks passed

cerebrl deleted the oidc-userinfo branch August 8, 2025 16:59

ryanbas21 mentioned this pull request Aug 8, 2025

Release PR #345

Open

feat(oidc-client): improving types and completing userinfo #363

feat(oidc-client): improving types and completing userinfo #363

Uh oh!

Conversation

cerebrl commented Aug 6, 2025

JIRA Ticket

Description

Uh oh!

changeset-bot bot commented Aug 6, 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 6, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

codecov-commenter commented Aug 6, 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 6, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

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

Uh oh!

📦 Bundle Size Analysis

📦 Bundle Size Analysis

🚨 Significant Changes

Legend

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

ancheetah left a comment

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!

ryanbas21 left a comment

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!

Uh oh!

Reviewers

Assignees

Labels

Milestone

Development

Uh oh!

4 participants

changeset-bot bot commented Aug 6, 2025 •

edited

Loading

nx-cloud bot commented Aug 6, 2025 •

edited

Loading

codecov-commenter commented Aug 6, 2025 •

edited

Loading

github-actions bot commented Aug 6, 2025 •

edited

Loading

github-actions bot commented Aug 6, 2025 •

edited

Loading