feat(fab): add new mountpoints support for providers and listeners #2199

debsmita1 · 2025-01-16T19:12:51Z

Description:

https://issues.redhat.com/browse/RHIDP-5478
https://issues.redhat.com/browse/RHIDP-5399

How to test changes / Special notes to the reviewer:

Testing in your local

In your local rhdh repo, add the following snippet in your app-config.yaml file

dynamicPlugins:
  rootDirectory: dynamic-plugins-root
  frontend:
    red-hat-developer-hub.backstage-plugin-bulk-import:
      mountPoints:
         - mountPoint: global.floatingactionbutton/component
          importName: BulkImportPage
          config:
            slot: 'page-end'
            icon: bulkImportIcon
            label: 'Bulk import'
            toolTip: 'Register multiple repositories in bulk'
            to: /bulk-import/repositories
            excludeOnPaths: ['/catalog']
      appIcons:
        - name: bulkImportIcon
          importName: BulkImportIcon
      dynamicRoutes:
        - path: /bulk-import/repositories
          importName: BulkImportPage
          menuItem:
            icon: bulkImportIcon
            text: Bulk import
    red-hat-developer-hub.backstage-plugin-global-floating-action-button:
      mountPoints:
        - mountPoint: application/listener
          importName: DynamicGlobalFloatingActionButton
        - mountPoint: global.floatingactionbutton/component
          importName: NullComponent
          config:
            icon: github
            label: 'Git'
            toolTip: 'Github'
            to: https://github.com/redhat-developer/rhdh

In your local rhdh repo, run yarn install followed by yarn dev

Testing on a cluster

dynamic-plugins.yaml: |
    includes:
    - dynamic-plugins.default.yaml
    plugins:
      - package: '@red-hat-developer-hub/[email protected]'
        integrity: 'sha512-4k/D6YjVfLX8jiCOlZJ+CG0hcE55hk2UxyKO/SwsRWc+qjwuny1A+MO0vz+KgKcwkFvg1tw7kkPCjV8w1k4lUg=='
        pluginConfig:
          dynamicPlugins:
            frontend:
              red-hat-developer-hub.backstage-plugin-application-provider-test:
                dynamicRoutes:
                  - path: /countpage
                    importName: CountPage
                mountPoints:
                  - mountPoint: application/provider
                    importName: CountProvider
      - package: ./dynamic-plugins/dist/red-hat-developer-hub-backstage-plugin-bulk-import
        disabled: false
        pluginConfig:
          dynamicPlugins:
            frontend:
              red-hat-developer-hub.backstage-plugin-bulk-import:
                mountPoints:
                  - mountPoint: global.floatingactionbutton/component
                    importName: BulkImportPage
                    config:
                      slot: 'page-end'
                      icon: bulkImportIcon
                      label: 'Bulk import'
                      toolTip: 'Register multiple repositories in bulk'
                      to: /bulk-import/repositories
                      excludeOnPaths: ['/catalog']
                appIcons:
                  - name: bulkImportIcon
                    importName: BulkImportIcon
                dynamicRoutes:
                  - path: /bulk-import/repositories
                    importName: BulkImportPage
                    menuItem:
                      icon: bulkImportIcon
                      text: Bulk import
      - package: ./dynamic-plugins/dist/red-hat-developer-hub-backstage-plugin-global-floating-action-button
        disabled: false
        pluginConfig:
          dynamicPlugins:
            frontend:
              red-hat-developer-hub.backstage-plugin-global-floating-action-button:
                mountPoints:
                  - mountPoint: application/listener
                    importName: DynamicGlobalFloatingActionButton
                  - mountPoint: global.floatingactionbutton/component
                    importName: NullComponent
                    config:
                      icon: github
                      label: 'Git'
                      toolTip: 'Github'
                      to: https://github.com/redhat-developer/rhdh

Screenshot/GIF

Screen.Recording.2025-01-30.at.4.34.46.PM.mov

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

openshift-ci · 2025-01-16T19:13:00Z

[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 debsmita1. 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:

OWNERS

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

ciiay

Looks good!
Tested locally and it seems that it works functionally, only with a few UI issues. Check out the screen recording:

pr_2199_review.mp4

dynamic-plugins.default.yaml

christoph-jerolimov

Hi, I know it's WIP. The first version looks good!
Two suggestion I have: I think we should move the integration part into AppBase and create new components for Listener and Provider.

And then I think this PR should also include some new documentation in https://github.com/redhat-developer/rhdh/blob/main/docs/dynamic-plugins/frontend-plugin-wiring.md

Similar to #2168: I I think a good spot would be after "Customizing and Adding Entity tabs" (before "Provide additional Utility APIs"). Merge conflicts, here we go. I'm fine if you want do that in a 2nd PR, but IMO it should be part of that story. :)

packages/app/src/components/DynamicRoot/DynamicRoot.tsx

packages/app/src/components/Root/Root.tsx

yarn.lock

github-actions · 2025-01-28T15:15:07Z

The image is available at:

github-actions · 2025-01-28T17:10:41Z

The image is available at:

github-actions · 2025-01-29T08:12:33Z

The image is available at:

github-actions · 2025-01-30T12:24:36Z

The image is available at:

christoph-jerolimov

Hi, great so far, but I have added some comments to simplify the documentation.

It looks to me that the Provider and Listener are currently the same thing, just somewhere else.

What would help for both (esp. for the provider to see the issue) is that you add some unit tests for both.

app-config.dynamic-plugins.yaml

docs/dynamic-plugins/frontend-plugin-wiring.md

christoph-jerolimov · 2025-01-30T18:17:31Z

.../wrappers/red-hat-developer-hub-backstage-plugin-global-floating-action-button/tsconfig.json

+    }
+  }


Intention could be improved

...ins/wrappers/red-hat-developer-hub-backstage-plugin-global-floating-action-button/turbo.json

packages/app/src/components/Root/ApplicationProvider.tsx

docker/Dockerfile

.rhdh/docker/Dockerfile

github-actions · 2025-01-31T17:23:39Z

The image is available at:

openshift-ci · 2025-01-31T17:41:30Z

@debsmita1: The following test failed, say /retest to rerun all failed tests or /retest-required to rerun all mandatory failed tests:

Test name	Commit	Details	Required	Rerun command
ci/prow/periodic-e2e-tests-gke-helm-nightly	`e7a41b7`	link	false	`/test periodic-e2e-tests-gke-helm-nightly`

Full PR test history. Your PR dashboard.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository. I understand the commands that are listed here.

github-actions · 2025-02-03T10:58:24Z

The image is available at:

openshift-ci bot added the do-not-merge/work-in-progress label Jan 16, 2025

debsmita1 requested a review from christoph-jerolimov January 16, 2025 19:12

openshift-ci bot requested review from dzemanov and its-mitesh-kumar January 16, 2025 19:12

debsmita1 force-pushed the dynamic-fab branch from cf55126 to 497eb35 Compare January 16, 2025 19:14

debsmita1 requested review from ciiay and removed request for dzemanov and its-mitesh-kumar January 16, 2025 19:15

ciiay reviewed Jan 23, 2025

View reviewed changes

dynamic-plugins.default.yaml Outdated Show resolved Hide resolved

ciiay mentioned this pull request Jan 23, 2025

feat(fab): created dynamic fab to be integrated in the RHDH app redhat-developer/rhdh-plugins#307

Merged

4 tasks

christoph-jerolimov suggested changes Jan 23, 2025

View reviewed changes

packages/app/src/components/DynamicRoot/DynamicRoot.tsx Outdated Show resolved Hide resolved

packages/app/src/components/Root/Root.tsx Outdated Show resolved Hide resolved

packages/app/src/components/Root/Root.tsx Outdated Show resolved Hide resolved

yarn.lock Outdated Show resolved Hide resolved

christoph-jerolimov mentioned this pull request Jan 24, 2025

feat(fab): add application listener and provider test plugins redhat-developer/rhdh-plugins#318

Merged

4 tasks

debsmita1 force-pushed the dynamic-fab branch 3 times, most recently from 91c69f3 to d61135e Compare January 28, 2025 14:38

debsmita1 force-pushed the dynamic-fab branch from d61135e to e6129c4 Compare January 28, 2025 16:31

debsmita1 changed the title ~~[WIP] feat(fab): add new mountpoints to support provider~~ [WIP] feat(fab): add new mountpoints support for providers and listeners Jan 28, 2025

debsmita1 force-pushed the dynamic-fab branch from e6129c4 to 011d027 Compare January 28, 2025 16:36

debsmita1 force-pushed the dynamic-fab branch from 011d027 to b833dde Compare January 29, 2025 07:37

debsmita1 changed the title ~~[WIP] feat(fab): add new mountpoints support for providers and listeners~~ feat(fab): add new mountpoints support for providers and listeners Jan 30, 2025

openshift-ci bot removed the do-not-merge/work-in-progress label Jan 30, 2025

debsmita1 force-pushed the dynamic-fab branch from b833dde to 080016d Compare January 30, 2025 11:49

christoph-jerolimov suggested changes Jan 30, 2025

View reviewed changes

karthikjeeyar reviewed Jan 31, 2025

View reviewed changes

docker/Dockerfile Outdated Show resolved Hide resolved

karthikjeeyar reviewed Jan 31, 2025

View reviewed changes

.rhdh/docker/Dockerfile Outdated Show resolved Hide resolved

This was referenced Jan 31, 2025

feat(application-listener-test): add CrashListener and update readme redhat-developer/rhdh-plugins#368

Merged

feat(application-provider-test): add CrashProvider and exports now two seperate context providers and cards redhat-developer/rhdh-plugins#370

Merged

debsmita1 force-pushed the dynamic-fab branch from 080016d to e7a41b7 Compare January 31, 2025 16:47

debsmita1 force-pushed the dynamic-fab branch from e7a41b7 to e79acd7 Compare February 3, 2025 10:18

feat(fab): add new mountpoints support for providers and listeners

51623c8

debsmita1 force-pushed the dynamic-fab branch from e79acd7 to 51623c8 Compare February 3, 2025 10:23

debsmita1 requested a review from christoph-jerolimov February 3, 2025 10:23

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(fab): add new mountpoints support for providers and listeners #2199

feat(fab): add new mountpoints support for providers and listeners #2199

debsmita1 commented Jan 16, 2025 •

edited

Loading

openshift-ci bot commented Jan 16, 2025

ciiay left a comment •

edited

Loading

christoph-jerolimov left a comment

github-actions bot commented Jan 28, 2025

github-actions bot commented Jan 28, 2025

github-actions bot commented Jan 29, 2025

github-actions bot commented Jan 30, 2025

christoph-jerolimov left a comment

christoph-jerolimov Jan 30, 2025

github-actions bot commented Jan 31, 2025

openshift-ci bot commented Jan 31, 2025

github-actions bot commented Feb 3, 2025

feat(fab): add new mountpoints support for providers and listeners #2199

Are you sure you want to change the base?

feat(fab): add new mountpoints support for providers and listeners #2199

Conversation

debsmita1 commented Jan 16, 2025 • edited Loading

Description:

How to test changes / Special notes to the reviewer:

Testing in your local

Testing on a cluster

Screenshot/GIF

PR acceptance criteria

openshift-ci bot commented Jan 16, 2025

ciiay left a comment • edited Loading

Choose a reason for hiding this comment

christoph-jerolimov left a comment

Choose a reason for hiding this comment

github-actions bot commented Jan 28, 2025

github-actions bot commented Jan 28, 2025

github-actions bot commented Jan 29, 2025

github-actions bot commented Jan 30, 2025

christoph-jerolimov left a comment

Choose a reason for hiding this comment

christoph-jerolimov Jan 30, 2025

Choose a reason for hiding this comment

github-actions bot commented Jan 31, 2025

openshift-ci bot commented Jan 31, 2025

github-actions bot commented Feb 3, 2025

debsmita1 commented Jan 16, 2025 •

edited

Loading

ciiay left a comment •

edited

Loading