Skip to content
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

fix: fix-the-url-type #509

Merged
merged 5 commits into from
Dec 9, 2024
Merged

fix: fix-the-url-type #509

merged 5 commits into from
Dec 9, 2024

Conversation

ryanbas21
Copy link
Contributor

Type issue which i changed the structure of. This caused a few test failures because it is an api change

JIRA Ticket

Please link jira ticket here

Description

Type of Change

Please Delete options that are not relevant

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • This change requires a documentation update

How Has This Been Tested?

Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration

Definition of Done

Check all that apply

  • Acceptance criteria is met.
  • All tasks listed in the user story have been completed.
  • Coded to standards.
  • Code peer-reviewed.
  • Ensure backward compatibility (special attention).
  • API reference docs is updated.
  • Unit tests are written.
  • Integration tests are written.
  • e2e tests are written.
  • CI build passing on the feature branch.
  • Functional spec is written/updated
  • contains example code snippets.
  • Change log updated.
  • Documentation story is created and tracked.
  • UI is completed or ticket is created.
  • Demo to PO and team.
  • Tech debts and remaining tasks are tracked in separated ticket(s).

Documentation

  • Acceptance criteria met
  • Spell-check run
  • Peer reviewed
  • Proofread

Copy link

changeset-bot bot commented Dec 4, 2024

🦋 Changeset detected

Latest commit: 717e542

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

This PR includes changesets to release 1 package
Name Type
@forgerock/davinci-client 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

@github-actions github-actions bot added the test label Dec 4, 2024
Copy link

nx-cloud bot commented Dec 4, 2024

☁️ Nx Cloud Report

CI is running/has finished running commands for commit 717e542. As they complete they will appear below. Click to see the status, the terminal output, and the build insights.

📂 See all runs for this CI Pipeline Execution


✅ Successfully ran 2 targets

Sent with 💌 from NxCloud.

Copy link
Contributor

@cerebrl cerebrl left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just really a question, so I understand our intent here.

type: string;
url: string | null;
};
output: ActionCollectorOutputTypes;
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not entirely sure what we are doing here. This interface is named ActionCollectorWithUrl, but the output may or may not have a url. That seems a bit wonky.

May I ask why we are going to such lengths to avoid just having a single type that has url as an optional property? I've noticed this complexity, and I'm just not sure what value we get from it. But, I'm probably missing something.

@ryanbas21 ryanbas21 force-pushed the davinci-client-fixes branch from c08ab2c to ae0c074 Compare December 6, 2024 22:14
Comment on lines 16 to 22
* DaVinci configuration options that extends the Forgerock SDK configuration options
*/
// export type InternalDaVinciConfig =
// | ((DavinciConfigWithResponseType | AsyncConfigOptions) & {
// | ((DaVinciConfigWithResponseType | AsyncConfigOptions) & {
// openIdConfiguration: OpenIdResponse;
// })
// | (DavinciConfigWithResponseType | AsyncConfigOptions);
// | (DaVinciConfigWithResponseType | AsyncConfigOptions);
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If we no longer need these, let's remove them. I commented them out as I wasn't sure if I was going to need them or not.

Comment on lines 87 to 90
| ActionCollector<'SocialLoginCollector'>
| ActionCollector<'ActionCollector'>
| ActionCollector<'FlowCollector'>
| ActionCollector<'SubmitCollector'>;
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's make sure this and the associated types get reverted back to the previous state.

Type issue which i changed the structure of. This caused a few test
failures because it is an api change
fixed action collector type to be more clear of intent
@ryanbas21 ryanbas21 force-pushed the davinci-client-fixes branch from 176c5e3 to 59605c2 Compare December 9, 2024 21:15
@ryanbas21 ryanbas21 merged commit 4f76d1d into develop Dec 9, 2024
5 checks passed
@github-actions github-actions bot mentioned this pull request Dec 10, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Development

Successfully merging this pull request may close these issues.

2 participants