-
Notifications
You must be signed in to change notification settings - Fork 3
feat(davinci-client): add metadata collector (SDKS-5100) #727
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
ancheetah
wants to merge
1
commit into
main
Choose a base branch
from
SDKS-5100-metadata-collector
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+470
−89
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,5 @@ | ||
| --- | ||
| '@forgerock/davinci-client': minor | ||
| --- | ||
|
|
||
| Add MetadataCollector and error helper on client |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,36 @@ | ||
| /* | ||
| * Copyright (c) 2026 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 type { MetadataCollector, MetadataError, Updater } from '@forgerock/davinci-client/types'; | ||
|
|
||
| export default function metadataComponent( | ||
| formEl: HTMLFormElement, | ||
| updater: Updater<MetadataCollector>, | ||
| getMetadataError: (errorDetails: MetadataError) => MetadataError, | ||
| submitForm: () => Promise<void>, | ||
| ) { | ||
| const successBtn = document.createElement('button'); | ||
| successBtn.type = 'button'; | ||
| successBtn.innerHTML = 'Metadata Success'; | ||
|
|
||
| const errorBtn = document.createElement('button'); | ||
| errorBtn.type = 'button'; | ||
| errorBtn.innerHTML = 'Metadata Error'; | ||
|
|
||
| formEl.appendChild(successBtn); | ||
| formEl.appendChild(errorBtn); | ||
|
|
||
| successBtn.onclick = async () => { | ||
| updater({ status: 'succeeded' }); | ||
| await submitForm(); | ||
| }; | ||
|
|
||
| errorBtn.onclick = async () => { | ||
| const metadataError = getMetadataError({ code: 'ERROR_CODE', message: 'Operation cancelled' }); | ||
| updater(metadataError); | ||
| await submitForm(); | ||
| }; | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,40 @@ | ||
| /* | ||
| * Copyright (c) 2026 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'; | ||
|
|
||
| test.describe('Metadata Collector', () => { | ||
| const clientId = '31a587ce-9aa4-4f36-a09f-78cd8a0a74a0'; | ||
| const davinciPolicy = '7793be21a14dd80c1d26b367e81ea985'; | ||
|
|
||
| test('should submit with success status when metadata collection succeeds', async ({ page }) => { | ||
| const { navigate } = asyncEvents(page); | ||
| await navigate(`/?clientId=${clientId}&acr_values=${davinciPolicy}`); | ||
|
|
||
| await page.getByRole('button', { name: 'Sign On' }).click(); | ||
| await expect(page.getByRole('button', { name: 'Metadata Success' })).toBeVisible(); | ||
|
|
||
| await page.getByRole('button', { name: 'Metadata Success' }).click(); | ||
|
|
||
| await expect(page.getByRole('heading', { name: 'Message' })).toBeVisible(); | ||
| await expect(page.getByText('"status":"succeeded"')).toBeVisible(); | ||
| }); | ||
|
|
||
| test('should submit with error details when metadata collection fails', async ({ page }) => { | ||
| const { navigate } = asyncEvents(page); | ||
| await navigate(`/?clientId=${clientId}&acr_values=${davinciPolicy}`); | ||
|
|
||
| await page.getByRole('button', { name: 'Sign On' }).click(); | ||
| await expect(page.getByRole('button', { name: 'Metadata Error' })).toBeVisible(); | ||
|
|
||
| await page.getByRole('button', { name: 'Metadata Error' }).click(); | ||
|
|
||
| await expect(page.getByRole('heading', { name: 'Message' })).toBeVisible(); | ||
| await expect(page.getByText('"code":"ERROR_CODE"')).toBeVisible(); | ||
| await expect(page.getByText('"message":"Operation cancelled"')).toBeVisible(); | ||
| }); | ||
| }); |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🩺 Stability & Availability | 🟡 Minor | ⚡ Quick win
Handle rejected submission promises.
If
submitForm()rejects, both async event handlers produce an unhandled promise rejection, leaving the UI without an error path. Catch the failure and route it through the example app’s existing error handling or reporting mechanism.🤖 Prompt for AI Agents