Merge branch 'main' into ssaikia/RHIDP-14185-startTestBackend-spike

Author: jrichter1

workspaces/orchestrator/.changeset/orchestrator-ui-improvements.md

@@ -0,0 +1,5 @@
+---
+'@red-hat-developer-hub/backstage-plugin-orchestrator': minor
+---
+
+Improve Orchestrator UI for workflows, runs, and workflow details, and place the sidebar item under Administration.

workspaces/orchestrator/docs/dynamic-plugin-installation.md

@@ -24,7 +24,12 @@ plugins:
                 menuItem:
                   icon: orchestratorIcon
                   text: Orchestrator
+                  textKey: menuItem.orchestrator
                 path: /orchestrator
+            menuItems:
+              orchestrator:
+                parent: default.admin
+                icon: orchestratorIcon
             entityTabs:
               - path: /workflows
                 title: Workflows

workspaces/orchestrator/entities/users.yaml

@@ -1,6 +1,16 @@
 ---
 apiVersion: backstage.io/v1alpha1
 kind: User
+metadata:
+  name: guest
+  namespace: development
+spec:
+  profile:
+    displayName: Guest User
+  memberOf: []
+---
+apiVersion: backstage.io/v1alpha1
+kind: User
 metadata:
   name: mareklibra
 spec:

workspaces/orchestrator/packages/app-legacy/package.json

@@ -26,6 +26,7 @@
     "@backstage/core-app-api": "^1.20.1",
     "@backstage/core-components": "^0.18.10",
     "@backstage/core-plugin-api": "^1.12.6",
+    "@backstage/frontend-plugin-api": "^0.17.1",
     "@backstage/integration-react": "^1.2.18",
     "@backstage/plugin-api-docs": "^0.14.1",
     "@backstage/plugin-catalog": "^2.0.5",

workspaces/orchestrator/packages/app-legacy/src/apis.ts

@@ -14,22 +14,73 @@
  * limitations under the License.
  */
 
+import { isValidElement, ReactNode } from 'react';
+
 import {
+  alertApiRef,
   AnyApiFactory,
   configApiRef,
   createApiFactory,
 } from '@backstage/core-plugin-api';
+import { ToastApiMessage, toastApiRef } from '@backstage/frontend-plugin-api';
 import {
   ScmAuth,
   ScmIntegrationsApi,
   scmIntegrationsApiRef,
 } from '@backstage/integration-react';
 
+const reactNodeToString = (node: ReactNode | null | undefined): string => {
+  if (node === null || node === undefined) {
+    return '';
+  }
+  if (typeof node === 'string') {
+    return node;
+  }
+  if (Array.isArray(node)) {
+    return node.map(reactNodeToString).join(' ');
+  }
+  if (isValidElement(node)) {
+    return reactNodeToString(node.props.children);
+  }
+  return '';
+};
+
+const toastStatusToSeverity = (message: ToastApiMessage) => {
+  const toastStatus = message.status ?? 'success';
+  switch (toastStatus) {
+    case 'warning':
+      return 'warning';
+    case 'danger':
+      return 'error';
+    case 'success':
+      return 'success';
+    default:
+      return 'info';
+  }
+};
+
 export const apis: AnyApiFactory[] = [
   createApiFactory({
     api: scmIntegrationsApiRef,
     deps: { configApi: configApiRef },
     factory: ({ configApi }) => ScmIntegrationsApi.fromConfig(configApi),
   }),
   ScmAuth.createDefaultApiFactory(),
+  createApiFactory({
+    api: toastApiRef,
+    deps: { alertApi: alertApiRef },
+    factory: ({ alertApi }) => ({
+      post(toast: ToastApiMessage) {
+        alertApi.post({
+          message: reactNodeToString(toast?.title),
+          severity: toastStatusToSeverity(toast),
+          display: 'transient',
+        });
+
+        return {
+          close: () => {},
+        };
+      },
+    }),
+  }),
 ];

workspaces/orchestrator/plugins/orchestrator/app-config.yaml

@@ -14,6 +14,11 @@ dynamicPlugins:
           menuItem:
             icon: orchestratorIcon
             text: Orchestrator
+            textKey: menuItem.orchestrator
+      menuItems:
+        orchestrator:
+          parent: default.admin
+          icon: orchestratorIcon
       entityTabs:
         - path: /workflows
           title: Workflows

workspaces/orchestrator/plugins/orchestrator/report-alpha.api.md

@@ -229,18 +229,27 @@ export const orchestratorTranslationRef: TranslationRef<
     readonly 'table.headers.version': string;
     readonly 'table.headers.duration': string;
     readonly 'table.headers.status': string;
+    readonly 'table.headers.entity': string;
     readonly 'table.headers.runStatus': string;
     readonly 'table.headers.started': string;
     readonly 'table.headers.workflowStatus': string;
     readonly 'table.headers.lastRun': string;
     readonly 'table.headers.lastRunStatus': string;
+    readonly 'table.headers.runsLastMonth': string;
+    readonly 'table.headers.successRatio': string;
     readonly 'table.headers.workflowName': string;
+    readonly 'table.headers.runBy': string;
     readonly 'table.actions.run': string;
     readonly 'table.actions.runAsEvent': string;
     readonly 'table.actions.viewRuns': string;
     readonly 'table.actions.viewInputSchema': string;
+    readonly 'table.actions.viewRunVariables': string;
+    readonly 'table.filters.placeholder': string;
     readonly 'table.filters.status': string;
+    readonly 'table.filters.entity': string;
     readonly 'table.filters.started': string;
+    readonly 'table.filters.runBy': string;
+    readonly 'table.filters.clearAll': string;
     readonly 'table.filters.startedOptions.today': string;
     readonly 'table.filters.startedOptions.yesterday': string;
     readonly 'table.filters.startedOptions.last7days': string;
@@ -287,6 +296,7 @@ export const orchestratorTranslationRef: TranslationRef<
     readonly 'run.status.failed': string;
     readonly 'run.status.completed': string;
     readonly 'run.status.aborted': string;
+    readonly 'run.status.abortedWithoutTime': string;
     readonly 'run.status.completedWithMessage': string;
     readonly 'run.status.failedAt': string;
     readonly 'run.status.completedAt': string;
@@ -319,14 +329,25 @@ export const orchestratorTranslationRef: TranslationRef<
     readonly 'workflow.definition': string;
     readonly 'workflow.status.available': string;
     readonly 'workflow.status.unavailable': string;
+    readonly 'workflow.successRatio': string;
+    readonly 'workflow.inputSchema': string;
+    readonly 'workflow.inputSchemaDescription': string;
+    readonly 'workflow.successRatioDescription': string;
+    readonly 'workflow.runSuccess': string;
+    readonly 'workflow.ofTotal': string;
+    readonly 'workflow.statsSuccess': string;
+    readonly 'workflow.statsFailed': string;
     readonly 'workflow.fields.description': string;
     readonly 'workflow.fields.version': string;
     readonly 'workflow.fields.workflowId': string;
     readonly 'workflow.fields.duration': string;
+    readonly 'workflow.fields.entity': string;
     readonly 'workflow.fields.runStatus': string;
     readonly 'workflow.fields.started': string;
     readonly 'workflow.fields.workflowStatus': string;
+    readonly 'workflow.fields.runBy': string;
     readonly 'workflow.fields.workflow': string;
+    readonly 'workflow.fields.averageDuration': string;
     readonly 'workflow.fields.workflowIdCopied': string;
     readonly 'workflow.messages.areYouSureYouWantToRunThisWorkflow': string;
     readonly 'workflow.messages.userNotAuthorizedExecute': string;
@@ -336,7 +357,9 @@ export const orchestratorTranslationRef: TranslationRef<
     readonly 'workflow.buttons.running': string;
     readonly 'workflow.buttons.runWorkflow': string;
     readonly 'workflow.buttons.runAgain': string;
+    readonly 'workflow.buttons.entireWorkflow': string;
     readonly 'workflow.buttons.fromFailurePoint': string;
+    readonly 'workflow.buttons.fromAbortedPoint': string;
     readonly 'workflow.buttons.runFailedAgain': string;
     readonly 'messages.noDataAvailable': string;
     readonly 'messages.noVariablesFound': string;
@@ -353,6 +376,7 @@ export const orchestratorTranslationRef: TranslationRef<
     readonly 'tooltips.workflowDown': string;
     readonly 'tooltips.suspended': string;
     readonly 'tooltips.userNotAuthorizedAbort': string;
+    readonly 'tooltips.retriggerNotSupportedForAborted': string;
     readonly 'reviewStep.hiddenFieldsNote': string;
     readonly 'reviewStep.showHiddenParameters': string;
     readonly 'permissions.accessDenied': string;
@@ -363,6 +387,13 @@ export const orchestratorTranslationRef: TranslationRef<
     readonly 'permissions.notYourRun': string;
     readonly 'alerts.duplicateWorkflowIds.message': string;
     readonly 'alerts.duplicateWorkflowIds.learnMore': string;
+    readonly 'emptyState.workflows.title': string;
+    readonly 'emptyState.workflows.description': string;
+    readonly 'emptyState.workflows.viewDocumentation': string;
+    readonly 'emptyState.runs.title': string;
+    readonly 'emptyState.runs.description': string;
+    readonly 'emptyState.runs.runWorkflow': string;
+    readonly 'emptyState.illustrationAlt': string;
     readonly 'stepperObjectField.error': string;
     readonly 'formDecorator.error': string;
     readonly 'samlSso.body': string;

workspaces/orchestrator/plugins/orchestrator/report.api.md

@@ -45,18 +45,27 @@ export const orchestratorTranslationRef: TranslationRef<
     readonly 'table.headers.version': string;
     readonly 'table.headers.duration': string;
     readonly 'table.headers.status': string;
+    readonly 'table.headers.entity': string;
     readonly 'table.headers.runStatus': string;
     readonly 'table.headers.started': string;
     readonly 'table.headers.workflowStatus': string;
     readonly 'table.headers.lastRun': string;
     readonly 'table.headers.lastRunStatus': string;
+    readonly 'table.headers.runsLastMonth': string;
+    readonly 'table.headers.successRatio': string;
     readonly 'table.headers.workflowName': string;
+    readonly 'table.headers.runBy': string;
     readonly 'table.actions.run': string;
     readonly 'table.actions.runAsEvent': string;
     readonly 'table.actions.viewRuns': string;
     readonly 'table.actions.viewInputSchema': string;
+    readonly 'table.actions.viewRunVariables': string;
+    readonly 'table.filters.placeholder': string;
     readonly 'table.filters.status': string;
+    readonly 'table.filters.entity': string;
     readonly 'table.filters.started': string;
+    readonly 'table.filters.runBy': string;
+    readonly 'table.filters.clearAll': string;
     readonly 'table.filters.startedOptions.today': string;
     readonly 'table.filters.startedOptions.yesterday': string;
     readonly 'table.filters.startedOptions.last7days': string;
@@ -103,6 +112,7 @@ export const orchestratorTranslationRef: TranslationRef<
     readonly 'run.status.failed': string;
     readonly 'run.status.completed': string;
     readonly 'run.status.aborted': string;
+    readonly 'run.status.abortedWithoutTime': string;
     readonly 'run.status.completedWithMessage': string;
     readonly 'run.status.failedAt': string;
     readonly 'run.status.completedAt': string;
@@ -135,14 +145,25 @@ export const orchestratorTranslationRef: TranslationRef<
     readonly 'workflow.definition': string;
     readonly 'workflow.status.available': string;
     readonly 'workflow.status.unavailable': string;
+    readonly 'workflow.successRatio': string;
+    readonly 'workflow.inputSchema': string;
+    readonly 'workflow.inputSchemaDescription': string;
+    readonly 'workflow.successRatioDescription': string;
+    readonly 'workflow.runSuccess': string;
+    readonly 'workflow.ofTotal': string;
+    readonly 'workflow.statsSuccess': string;
+    readonly 'workflow.statsFailed': string;
     readonly 'workflow.fields.description': string;
     readonly 'workflow.fields.version': string;
     readonly 'workflow.fields.workflowId': string;
     readonly 'workflow.fields.duration': string;
+    readonly 'workflow.fields.entity': string;
     readonly 'workflow.fields.runStatus': string;
     readonly 'workflow.fields.started': string;
     readonly 'workflow.fields.workflowStatus': string;
+    readonly 'workflow.fields.runBy': string;
     readonly 'workflow.fields.workflow': string;
+    readonly 'workflow.fields.averageDuration': string;
     readonly 'workflow.fields.workflowIdCopied': string;
     readonly 'workflow.messages.areYouSureYouWantToRunThisWorkflow': string;
     readonly 'workflow.messages.userNotAuthorizedExecute': string;
@@ -152,7 +173,9 @@ export const orchestratorTranslationRef: TranslationRef<
     readonly 'workflow.buttons.running': string;
     readonly 'workflow.buttons.runWorkflow': string;
     readonly 'workflow.buttons.runAgain': string;
+    readonly 'workflow.buttons.entireWorkflow': string;
     readonly 'workflow.buttons.fromFailurePoint': string;
+    readonly 'workflow.buttons.fromAbortedPoint': string;
     readonly 'workflow.buttons.runFailedAgain': string;
     readonly 'messages.noDataAvailable': string;
     readonly 'messages.noVariablesFound': string;
@@ -169,6 +192,7 @@ export const orchestratorTranslationRef: TranslationRef<
     readonly 'tooltips.workflowDown': string;
     readonly 'tooltips.suspended': string;
     readonly 'tooltips.userNotAuthorizedAbort': string;
+    readonly 'tooltips.retriggerNotSupportedForAborted': string;
     readonly 'reviewStep.hiddenFieldsNote': string;
     readonly 'reviewStep.showHiddenParameters': string;
     readonly 'permissions.accessDenied': string;
@@ -179,6 +203,13 @@ export const orchestratorTranslationRef: TranslationRef<
     readonly 'permissions.notYourRun': string;
     readonly 'alerts.duplicateWorkflowIds.message': string;
     readonly 'alerts.duplicateWorkflowIds.learnMore': string;
+    readonly 'emptyState.workflows.title': string;
+    readonly 'emptyState.workflows.description': string;
+    readonly 'emptyState.workflows.viewDocumentation': string;
+    readonly 'emptyState.runs.title': string;
+    readonly 'emptyState.runs.description': string;
+    readonly 'emptyState.runs.runWorkflow': string;
+    readonly 'emptyState.illustrationAlt': string;
     readonly 'stepperObjectField.error': string;
     readonly 'formDecorator.error': string;
     readonly 'samlSso.body': string;