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

feat(app): dynamic authentication provider support (release-1.4) #2217

Open
wants to merge 1 commit into
base: release-1.4
Choose a base branch
from

Conversation

gashcrumb
Copy link
Member

@gashcrumb gashcrumb commented Jan 21, 2025

Description

This change adds support for loading authentication providers or modules from dynamic plugins. An environment variable
ENABLE_AUTH_PROVIDER_MODULE_OVERRIDE controls whether or not the backend installs the default authentication provider module. When this override is enabled dynamic plugins can be used to supply custom authentication providers. This change also adds a "components" configuration for frontend dynamic plugins, which can be used to supply overrides for the AppComponents option. This is required for dynamic plugins to be able to provide a custom SignInPage component, for example:

frontend:
  my-plugin-package:
    components:
      - name: SignInPage
        module: PluginRoot
        importName: SignInPage

Where the named export SignInPage will be mapped to components.SignInPage when the frontend is initialized.

Which issue(s) does this PR fix

This is a manual cherry-pick of #2167 onto release-1.4

PR acceptance criteria

Please make sure that the following steps are complete:

  • GitHub Actions are completed and successful
  • Unit Tests are updated and passing
  • E2E Tests are updated and passing
  • Documentation is updated if necessary (requirement for new features)
  • Add a screenshot if the change is UX/UI related

How to test changes / Special notes to the reviewer

It's mostly enough to ensure that this change does not break the existing e2e tests. However to actually try this out locally I've prepared this example here.

This change adds support for loading authentication providers or modules
from dynamic plugins.  An environment variable
ENABLE_AUTH_PROVIDER_MODULE_OVERRIDE controls whether or not the backend
installs the default authentication provider module.  When this override
is enabled dynamic plugins can be used to supply custom authentication
providers.  This change also adds a "components" configuration for
frontend dynamic plugins, which can be used to supply overrides for the
AppComponents option.  This is required for dynamic plugins to be able to
provide a custom SignInPage component, for example:

```
frontend:
  my-plugin-package:
    components:
      - name: SignInPage
        module: PluginRoot
        importName: SignInPage
```

Where the named export SignInPage will be mapped to
`components.SignInPage` when the frontend is initialized.

Signed-off-by: Stan Lewis <[email protected]>
Copy link

openshift-ci bot commented Jan 21, 2025

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by:
Once this PR has been reviewed and has the lgtm label, please ask for approval from gashcrumb. For more information see the Code Review Process.

The full list of commands accepted by this bot can be found here.

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@nickboldt
Copy link
Member

nickboldt commented Jan 21, 2025

Just to clarify why this is labelled with [do-not-merge/hold](https://github.com/redhat-developer/rhdh/labels/do-not-merge%2Fhold) -- this is a proof of concept for a feature coming in 1.5, to see if it also works in 1.4.z. But it is not currently planned to be merged into the 1.4 code base, as we are trying to avoid feature-creep by adding new features in z-stream maintenance.

For an image that won't expire immediately, see quay.io/rhdh-community/rhdh:pr-2217-5aabfbde or the :RHDH-5484 tag.

Copy link
Contributor

Copy link
Contributor

This PR is stale because it has been open 7 days with no activity. Remove stale label or comment or this will be closed in 21 days.

@github-actions github-actions bot added the Stale label Jan 29, 2025
@gashcrumb gashcrumb removed the Stale label Jan 29, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants