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.

Sign up for GitHub

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

Jump to bottom

sig#796: SST Clearinghouse - Implement Feature Toggle for Clearinghouse Self-Description Connectivity #792

Closed
Tracked by #796
jjeroch opened this issue Jun 18, 2024 · 2 comments
Closed
Tracked by #796

sig#796: SST Clearinghouse - Implement Feature Toggle for Clearinghouse Self-Description Connectivity #792

jjeroch opened this issue Jun 18, 2024 · 2 comments
Assignees
@Phil91
Labels
enhancement New feature or request
Milestone
Release 2.0.0 (24...

Comments

@jjeroch
Copy link
Contributor

jjeroch commented Jun 18, 2024 •
edited by Phil91
Loading

Description

We require an enhancement to the current implementation of the clearinghouse connection within the portal-backend project. The goal is to introduce a feature toggle that allows disabling the connection to the clearinghouse for Self-Description (SD) functions. This should affect both Legal Person and Participant Self-Descriptions. When the toggle is set to disable the connectivity, the system should still be able to complete the application process and connector registration without establishing a connection to the clearinghouse.

Acceptance Criteria

  1. Feature Toggle Implementation:

    • Introduce a feature toggle (e.g., CLEARINGHOUSE_CONNECT_DISABLED) that can be switched on or off to enable or disable the clearinghouse SD connectivity.
    • The toggle does not need to be accessible and changeable at runtime, I would actually suggest a system restart need instead. Reason: we should not switch easily around.

  2. Application Process Handling:

    • Ensure that with the toggle is set to true (clearinghouseConnect is disabled), the application process for Legal Person and Participant can be completed successfully without any clearinghouse connectivity.
    • Ensure that with the toggle set to true (clearinghouseConnect is disabled), the connector registration and connector change flow can be completed successfully without any clearinghouse connectivity.
      • The status of the connector is set to pending
    • Ensure that with the toggle is set to false (clearinghouseConnect is enabled), the process stays as it is and the call to Legal Person and Participant calls are made.
    • Ensure that with the toggle set to false (clearinghouseConnect is enabled), the connector registration and connector change flow stays as it is and the connector is registered with a sd factory is made.
      • The status of the connector is set to pending

  3. Runtime Activation Handling:

    • SD Factory/Clearinghouse Application: In case the toggle is active, set the respective process status to "skipped"
    • Connector: In case the toggle is active, with a creation of a connector registration by the customer the status is immediately set to active

4. User Interface Notification:
- Propose a method to inform users via the UI about the status of the clearinghouse SD connectivity, especially if it impacts their current state.
- This UI information should be clear and informative, providing users with an understanding of the implications of the SD connectivity status.

  1. Validation Scenarios:

    • Define and document specific scenarios to validate the behavior of the system with the toggle switched on and off.

  2. Documentation:

    • Update the project documentation to include the new feature toggle and its implications on the system's operation.

  3. Error Handling and Logging:

    • Ensure that relevant logs are generated for monitoring and debugging purposes. //Note: I expect this to be in place, this is just to recheck

Implementation Notes

  • The feature toggle should be implemented in a way that it can be easily accessed and modified by system administrators (under the above defined processes).
  • The system's behavior when the toggle is switched needs to get thoroughly tested to prevent any unexpected issues.
@jjeroch jjeroch added the enhancement New feature or request label Jun 18, 2024
@jjeroch jjeroch added this to the Release 2.1.0 milestone Jun 18, 2024
@jjeroch jjeroch added this to Portal Jun 18, 2024
@github-project-automation github-project-automation bot moved this to NEW USER REQUEST in Portal Jun 18, 2024
@jjeroch jjeroch moved this from NEW USER REQUEST to BACKLOG in Portal Jun 18, 2024
@Phil91 Phil91 moved this from BACKLOG to IN PROGRESS in Portal Jun 18, 2024
Phil91 added a commit to eclipse-tractusx/portal that referenced this issue Jun 19, 2024
@Phil91
feat(clearinghouse): add feature toggle for sd connectivity
86ea04f 
Refs: eclipse-tractusx/portal-backend#792
@Phil91 Phil91 mentioned this issue Jun 19, 2024
Merged
4 tasks
Phil91 added a commit that referenced this issue Jun 19, 2024
@Phil91
feat(clearinghouse): add feature toggle for sd connectivity
075ab73 
Refs: #792
@Phil91 Phil91 mentioned this issue Jun 19, 2024
Merged
8 tasks
Phil91 added a commit that referenced this issue Jun 20, 2024
@Phil91
feat(clearinghouse): add feature toggle for sd connectivity
93538b7 
Refs: #792
Phil91 added a commit to eclipse-tractusx/portal that referenced this issue Jun 20, 2024
@Phil91
feat(clearinghouse): add feature toggle for sd connectivity
e2d815a 
Refs: eclipse-tractusx/portal-backend#792
Phil91 added a commit that referenced this issue Jun 24, 2024
@Phil91
feat(clearinghouse): add feature toggle for sd connectivity
e7795a4 
Refs: #792
Phil91 added a commit to eclipse-tractusx/portal that referenced this issue Jun 25, 2024
@Phil91
feat(clearinghouse): add feature toggle for sd connectivity (#344)
cd2e22e 
Refs: eclipse-tractusx/portal-backend#792
Reviewed-By: Evelyn Gurschler <[email protected]>
Phil91 added a commit that referenced this issue Jun 25, 2024
@Phil91
feat(clearinghouse): add feature toggle for sd connectivity (#793)
03f9dcb 
Refs: #792
Reviewed-By: Evelyn Gurschler <[email protected]>
@jjeroch jjeroch mentioned this issue Jul 15, 2024
Closed
9 tasks
@jjeroch jjeroch changed the title SST Clearinghouse - Implement Feature Toggle for Clearinghouse Self-Description Connectivity sig#796: SST Clearinghouse - Implement Feature Toggle for Clearinghouse Self-Description Connectivity Jul 15, 2024
@jjeroch jjeroch mentioned this issue Jul 15, 2024
Closed
@Phil91 Phil91 moved this from IN PROGRESS to IN REVIEW in Portal Jul 17, 2024
Phil91 added a commit that referenced this issue Jul 25, 2024
@Phil91
fix(sdDoc): set process step to skipped if ClearinghouseConnectDisabl…
acafde1 
…ed is true

Refs: #792
@Phil91 Phil91 mentioned this issue Jul 25, 2024
Merged
8 tasks
Phil91 added a commit that referenced this issue Jul 25, 2024
@Phil91
fix(sdDoc): set process step to skipped if ClearinghouseConnectDisabl…
9e4ff07 
…ed is true (#874)

Refs: #792
Reviewed-By: Evelyn Gurschler <[email protected]>
Phil91 added a commit that referenced this issue Jul 26, 2024
@Phil91
fix(sdDoc): set process step to skipped if ClearinghouseConnectDisabl…
61d54f9 
…ed is true (#874)

Refs: #792
Reviewed-By: Evelyn Gurschler <[email protected]>
Phil91 added a commit that referenced this issue Jul 26, 2024
@Phil91
fix(sdDoc): set process step to skipped if ClearinghouseConnectDisabl…
2e9ba1a 
…ed is true (#874)

Refs: #792
Reviewed-By: Evelyn Gurschler <[email protected]>
ntruchsess pushed a commit that referenced this issue Jul 29, 2024
@Phil91 @ntruchsess
fix(sdDoc): set process step to skipped if ClearinghouseConnectDisabl…
efacf04 
…ed is true (#874)

Refs: #792
Reviewed-By: Evelyn Gurschler <[email protected]>
ntruchsess added a commit that referenced this issue Jul 29, 2024
@ntruchsess
Merge pull request #884 from eclipse-tractusx/chore/merge_to_main
9dfa228 
* fix(apps): remove leading '/' from the activate subscription endpoint (#861)
Refs: #856
* bug(offersubscription): suppress activation of external serviceaccounts in keycloak on subscription-activation (#864)
Refs: #856
* fix(dim): fix callback logic for dim requests (#863)
Refs: #862
chore(dependencies): bump efcore to 8.0.7 (#857)
* increase efcore version to latest 8.0.7 to resolve security-issue in transitive dependency in System.Text.Json
* fix(offersubscription): skip optional autosetupprovidercallback  if it is not configured (#865)
* add clientPrefix  to workers appsettings (#870)
* fix: enhance subscription/provider endpoint with external Service data (#867)
Refs: #841
* fix(sdDoc): set process step to skipped if ClearinghouseConnectDisabled is true (#874)
Refs: #792
* build(deps): bump MimeKit from 4.3.0 to 4.7.1 (#833)
eclipse-tractusx/portal#369
* build(deps): bump MimeKit from 4.3.0 to 4.7.1 in /tests/endtoend
Bumps MimeKit from 4.3.0 to 4.7.1.
---
updated-dependencies:
- dependency-name: MimeKit
  dependency-type: direct:production
...
* chore: upgrade mimekit in sendmail project
* chore: update dependencies file
---------
* upgrade implicit dependencies on System.Text.Json (#875)
* Serilog.Settings.Configuration to 8.0.2
* remove redundant dependencies on Microsoft.Extensions.Hosting
* bump framework version to 2.4.2 after merge of main
---------
Signed-off-by: dependabot[bot] <[email protected]>
Co-authored-by: Norbert Truchsess <[email protected]>
Co-authored-by: Phil Schneider <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: Evelyn Gurschler <[email protected]>
Reviewed-By: Evelyn Gurschler <[email protected]>
Reviewed-By: Norbert Truchsess <[email protected]>
Reviewed-By: Phil Schneider <[email protected]>
@jjeroch
Copy link
Contributor Author

jjeroch commented Aug 5, 2024

Bug found: #887

@MaximilianHauer
Copy link

tested and approved

@github-project-automation github-project-automation bot moved this from IN REVIEW to USER READY in Portal Sep 4, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@Phil91 Phil91

Labels
enhancement New feature or request
Projects
Portal
Archived in project
Milestone
Release 2.0.0 (24.05)
Development

No branches or pull requests
3 participants
@Phil91 @jjeroch @MaximilianHauer