feat(app) an AdminPage for admin plugins #932

gashcrumb · 2024-01-26T19:57:23Z

Description

This change adds a Administration navigation tab and page intended for plugins that are for administration of an Janus/RHDH instance. This commit adds two routes /admin/rbac and /admin/plugins and related mountpoints so that dynamic plugins can contribute UI components to this page. The page can also deal with a few edge cases and will also not be visible should no plugins be configured to show up on it. A test is provided that covers these cases. This change also adds the dynamic-plugins-info dynamic plugin which is one of two components intended to appear on this page.

Which issue(s) does this PR fix

Part of RHIDP-980. This is an approach to provide a home for dynamic plugins that fall under the "Administration" tab, for example:

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

The dynamic-plugins-info plugin is added to the showcase

To enable the Administration tab and see the installed dynamic plugins, use the following configuration in your app-config.local.yaml to enable the "Administration" nav and "Plugins" tab:

dynamicPlugins:
  frontend:
    janus-idp.backstage-plugin-dynamic-plugins-info:
      dynamicRoutes:
        - path: /admin/plugins
          importName: DynamicPluginsInfo
      mountPoints:
        - mountPoint: admin.page.plugins/cards
          importName: DynamicPluginsInfo
          config:
            layout:
              gridColumn: "1 / -1"
              width: 100vw

It should be possible to browse the list of installed plugins using the pagination arrows:

and searching should work:

Removing the configuration for the tab/plugin shouldn't leave the user with a blank page:

changeset-bot · 2024-01-26T19:57:26Z

🦋 Changeset detected

Latest commit: ec2bc58

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

This PR includes changesets to release 1 package

Name	Type
app	Patch

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

janus-idp · 2024-01-26T20:21:51Z

backstage-showcase Tests on commit b0c9c29 finished successfully.
View test log

github-actions · 2024-01-26T20:39:21Z

The image is available at: quay.io/janus-idp/backstage-showcase:pr-932!

invincibleJai · 2024-01-30T07:21:24Z

packages/app/src/components/AppBase/AppBase.tsx

@@ -64,6 +65,16 @@ const AppBase = () => {
            <Route path="/settings" element={<UserSettingsPage />} />
            <Route path="/catalog-graph" element={<CatalogGraphPage />} />
            <Route path="/learning-paths" element={<LearningPaths />} />
+            <Route path="/admin" element={<AdminPage />} />
+            {dynamicRoutes


as you are handling the routes here for admin and below there is a map run on all dynamicRoutes again so can that be an issue?

https://github.com/janus-idp/backstage-showcase/pull/932/files#diff-4ecb4d92de7b045a6d54c1e7327fb3f2e41f34316fd87dfa01a629d08a93f971R78-R88

This I have to revisit, as I figured I should be able to just map these pages to the admin route and then filter them from the other block (it would be before this map) where these are mounted. But I was surprised to find it didn't work at the time, so yep this needs a closer look. I might have just confused myself with my test plugin 😄

invincibleJai · 2024-01-30T07:26:53Z

packages/app/src/components/admin/AdminPage.tsx

+    );
+  }
+  if (invalidTab(selectedTab)) {
+    // in this case the page will navigate to a tab, so avoid


which tab will it navigate to? in this case? and if am getting it right currently on rbac and plugins tab would be allowed right? in future, if any other tab needs to be added then it will require code change in this file?

Correct. So this page will either navigate to the "rbac" tab or the "plugin" tab depending on what's available, and if there's no configured tab, for example let's say the configuration for all of this is removed while a user is at one of these pages then the page resorts to showing the standard error page which provides the user a link out of this area.

Oh yes, and for this page additional tabs can be added by modifying this array

packages/app/src/components/admin/AdminPage.tsx

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

gashcrumb · 2024-01-30T15:03:44Z

Ah turns out some last minute changes to fix lint errors introduced a bug, will need to fix that 😄

gashcrumb · 2024-01-30T15:40:21Z

Rebased, and I have updated this to handle the case where the user might be on the admin page when there's no configuration for it, and some comments in there too.

github-actions · 2024-01-30T16:05:40Z

The image is available at: quay.io/janus-idp/backstage-showcase:pr-932!

github-actions · 2024-02-05T16:31:15Z

The image is available at: quay.io/janus-idp/backstage-showcase:pr-932!

debsmita1 · 2024-02-06T19:19:37Z

Verified it locally

@gashcrumb Would you mind taking a look at the code smells ?

gashcrumb · 2024-02-06T19:51:18Z

@gashcrumb Would you mind taking a look at the code smells ?

Ah, of course, didn't spot that. Thanks!

This change adds a Administration navigation tab and page intended for plugins that are for administration of an Janus/RHDH instance. This commit adds two routes /admin/rbac and /admin/plugins and related mountpoints so that dynamic plugins can contribute UI components to this page. The page can also deal with a few edge cases and will also not be visible should no plugins be configured to show up on it. A test is added to cover these edge cases. This commit also adds the dynamic-plugins-info dynamic plugin. Signed-off-by: Stan Lewis <gashcrumb@gmail.com>

sonarcloud · 2024-02-06T20:05:18Z

Quality Gate passed

Kudos, no new issues were introduced!

0 New issues
0 Security Hotspots
No data about Coverage
0.0% Duplication on New Code

See analysis details on SonarCloud

gashcrumb · 2024-02-06T20:07:32Z

Code smells should be sorted now...

github-actions · 2024-02-06T20:35:43Z

The image is available at: quay.io/janus-idp/backstage-showcase:pr-932!

invincibleJai

/lgtm

openshift-ci · 2024-02-07T05:51:32Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: invincibleJai

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

The pull request process is described here

Needs approval from an approver in each of these files:

~~OWNERS~~ [invincibleJai]

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

invincibleJai · 2024-02-07T05:52:10Z

Thanks @gashcrumb, this looks good :)

gashcrumb requested a review from a team as a code owner January 26, 2024 19:57

openshift-ci bot requested review from davidfestal and tumido January 26, 2024 19:57

gashcrumb force-pushed the RHIDP-167 branch from 0000f7f to 2647e30 Compare January 26, 2024 20:09

gashcrumb mentioned this pull request Jan 29, 2024

feat(plugins): ui for dynamic-plugins-info-backend janus-idp/backstage-plugins#1138

Merged

invincibleJai reviewed Jan 30, 2024

View reviewed changes

packages/app/src/components/admin/AdminPage.tsx Show resolved Hide resolved

gashcrumb commented Jan 30, 2024

View reviewed changes

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

openshift-merge-robot added the needs-rebase label Jan 30, 2024

gashcrumb force-pushed the RHIDP-167 branch from 2647e30 to 3b9f080 Compare January 30, 2024 15:37

openshift-merge-robot removed the needs-rebase label Jan 30, 2024

This was referenced Jan 31, 2024

Add a test for AdminPage #940

Closed

Add dynamic-plugins-info plugin to the showcase image #941

Open

invincibleJai mentioned this pull request Jan 31, 2024

feat(rbac): add rbac dynamic plugin #937

Merged

5 tasks

gashcrumb marked this pull request as draft February 1, 2024 13:05

openshift-ci bot added the do-not-merge/work-in-progress label Feb 1, 2024

gashcrumb force-pushed the RHIDP-167 branch 4 times, most recently from 9b7df3a to 15263b2 Compare February 5, 2024 15:58

gashcrumb marked this pull request as ready for review February 5, 2024 16:08

openshift-ci bot removed the do-not-merge/work-in-progress label Feb 5, 2024

openshift-ci bot requested review from kadel and PatAKnight February 5, 2024 16:08

gashcrumb force-pushed the RHIDP-167 branch from 15263b2 to ecb4184 Compare February 6, 2024 19:59

gashcrumb force-pushed the RHIDP-167 branch from ecb4184 to ec2bc58 Compare February 6, 2024 20:04

invincibleJai approved these changes Feb 7, 2024

View reviewed changes

openshift-ci bot assigned invincibleJai Feb 7, 2024

openshift-ci bot added the lgtm label Feb 7, 2024

openshift-ci bot added the approved label Feb 7, 2024

openshift-merge-bot bot merged commit c02d68a into janus-idp:main Feb 7, 2024
7 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(app) an AdminPage for admin plugins #932

feat(app) an AdminPage for admin plugins #932

gashcrumb commented Jan 26, 2024 •

edited

Loading

changeset-bot bot commented Jan 26, 2024 •

edited

Loading

janus-idp bot commented Jan 26, 2024 •

edited

Loading

github-actions bot commented Jan 26, 2024

invincibleJai Jan 30, 2024

gashcrumb Jan 30, 2024

invincibleJai Jan 30, 2024

gashcrumb Jan 30, 2024

gashcrumb Jan 30, 2024

gashcrumb commented Jan 30, 2024

gashcrumb commented Jan 30, 2024

github-actions bot commented Jan 30, 2024

github-actions bot commented Feb 5, 2024

debsmita1 commented Feb 6, 2024

gashcrumb commented Feb 6, 2024

sonarcloud bot commented Feb 6, 2024

gashcrumb commented Feb 6, 2024

github-actions bot commented Feb 6, 2024

invincibleJai left a comment

openshift-ci bot commented Feb 7, 2024

invincibleJai commented Feb 7, 2024

feat(app) an AdminPage for admin plugins #932

feat(app) an AdminPage for admin plugins #932

Conversation

gashcrumb commented Jan 26, 2024 • edited Loading

Description

Which issue(s) does this PR fix

PR acceptance criteria

How to test changes / Special notes to the reviewer

changeset-bot bot commented Jan 26, 2024 • edited Loading

🦋 Changeset detected

janus-idp bot commented Jan 26, 2024 • edited Loading

github-actions bot commented Jan 26, 2024

invincibleJai Jan 30, 2024

Choose a reason for hiding this comment

gashcrumb Jan 30, 2024

Choose a reason for hiding this comment

invincibleJai Jan 30, 2024

Choose a reason for hiding this comment

gashcrumb Jan 30, 2024

Choose a reason for hiding this comment

gashcrumb Jan 30, 2024

Choose a reason for hiding this comment

gashcrumb commented Jan 30, 2024

gashcrumb commented Jan 30, 2024

github-actions bot commented Jan 30, 2024

github-actions bot commented Feb 5, 2024

debsmita1 commented Feb 6, 2024

gashcrumb commented Feb 6, 2024

sonarcloud bot commented Feb 6, 2024

Quality Gate passed

gashcrumb commented Feb 6, 2024

github-actions bot commented Feb 6, 2024

invincibleJai left a comment

Choose a reason for hiding this comment

openshift-ci bot commented Feb 7, 2024

invincibleJai commented Feb 7, 2024

gashcrumb commented Jan 26, 2024 •

edited

Loading

changeset-bot bot commented Jan 26, 2024 •

edited

Loading

janus-idp bot commented Jan 26, 2024 •

edited

Loading