chore: more deprecations and reworking more routeRefs to subRouteRefs

Signed-off-by: blam <ben@blam.sh>

plugins/catalog/src/components/Router.tsx

@@ -16,8 +16,6 @@
 import { ENTITY_DEFAULT_NAMESPACE } from '@backstage/catalog-model';
 import {
   AsyncEntityProvider,
-  entityRoute,
-  rootRoute,
   useEntity,
   useEntityFromUrl,
 } from '@backstage/plugin-catalog-react';
@@ -87,9 +85,9 @@ export const Router = ({
   EntityPage?: ComponentType;
 }) => (
   <Routes>
-    <Route path={`${rootRoute.path}`} element={<CatalogPage />} />
+    <Route path="/" element={<CatalogPage />} />
     <Route
-      path={`${entityRoute.path}`}
+      path="/:namespace/:kind/:name"
       element={
         <EntityLoader>
           <EntityPageSwitch EntityPage={EntityPage} />

plugins/circleci/src/components/BuildsPage/lib/CITable/CITable.tsx

@@ -26,7 +26,7 @@ import {
 import RetryIcon from '@material-ui/icons/Replay';
 import GitHubIcon from '@material-ui/icons/GitHub';
 import LaunchIcon from '@material-ui/icons/Launch';
-import { Link as RouterLink, generatePath } from 'react-router-dom';
+import { Link as RouterLink } from 'react-router-dom';
 import { durationHumanized, relativeTimeTo } from '../../../../util';
 import { circleCIBuildRouteRef } from '../../../../route-refs';
 import {
@@ -38,6 +38,7 @@ import {
   Table,
   TableColumn,
 } from '@backstage/core-components';
+import { useRouteRef } from '@backstage/core-plugin-api';
 
 export type CITableBuildInfo = {
   id: string;
@@ -144,16 +145,21 @@ const generatedColumns: TableColumn[] = [
     field: 'buildName',
     highlight: true,
     width: '20%',
-    render: (row: Partial<CITableBuildInfo>) => (
-      <Link
-        component={RouterLink}
-        to={`${generatePath(circleCIBuildRouteRef.path, {
-          buildId: row.id!,
-        })}`}
-      >
-        {row.buildName ? row.buildName : row?.workflow?.name}
-      </Link>
-    ),
+    render: (row: Partial<CITableBuildInfo>) => {
+      // eslint-disable-next-line react-hooks/rules-of-hooks
+      const routeLink = useRouteRef(circleCIBuildRouteRef);
+
+      return (
+        <Link
+          component={RouterLink}
+          to={`${routeLink({
+            buildId: row.id!,
+          })}`}
+        >
+          {row.buildName ? row.buildName : row?.workflow?.name}
+        </Link>
+      );
+    },
   },
   {
     title: 'Job',

plugins/circleci/src/components/Router.tsx

@@ -16,7 +16,7 @@
 
 import React from 'react';
 import { Routes, Route } from 'react-router';
-import { circleCIRouteRef, circleCIBuildRouteRef } from '../route-refs';
+import { circleCIBuildRouteRef } from '../route-refs';
 import { BuildWithStepsPage } from './BuildWithStepsPage/';
 import { BuildsPage } from './BuildsPage';
 import { CIRCLECI_ANNOTATION } from '../constants';
@@ -41,9 +41,9 @@ export const Router = (_props: Props) => {
 
   return (
     <Routes>
-      <Route path={`/${circleCIRouteRef.path}`} element={<BuildsPage />} />
+      <Route path="/" element={<BuildsPage />} />
       <Route
-        path={`/${circleCIBuildRouteRef.path}`}
+        path={`${circleCIBuildRouteRef.path}`}
         element={<BuildWithStepsPage />}
       />
     </Routes>

plugins/circleci/src/route-refs.tsx

@@ -14,12 +14,14 @@
  * limitations under the License.
  */
 
-import { createRouteRef } from '@backstage/core-plugin-api';
+import { createRouteRef, createSubRouteRef } from '@backstage/core-plugin-api';
 
 export const circleCIRouteRef = createRouteRef({
   id: 'circle-ci',
 });
 
-export const circleCIBuildRouteRef = createRouteRef({
+export const circleCIBuildRouteRef = createSubRouteRef({
   id: 'circle-ci/build',
+  parent: circleCIRouteRef,
+  path: '/:buildId',
 });

plugins/cloudbuild/src/components/Router.tsx

@@ -17,7 +17,7 @@ import React from 'react';
 import { Entity } from '@backstage/catalog-model';
 import { useEntity } from '@backstage/plugin-catalog-react';
 import { Routes, Route } from 'react-router';
-import { rootRouteRef, buildRouteRef } from '../routes';
+import { buildRouteRef } from '../routes';
 import { WorkflowRunDetails } from './WorkflowRunDetails';
 import { WorkflowRunsTable } from './WorkflowRunsTable';
 import { CLOUDBUILD_ANNOTATION } from './useProjectName';
@@ -40,15 +40,11 @@ export const Router = (_props: Props) => {
   }
   return (
     <Routes>
+      <Route path="/" element={<WorkflowRunsTable entity={entity} />} />
       <Route
-        path={`/${rootRouteRef.path}`}
-        element={<WorkflowRunsTable entity={entity} />}
-      />
-      <Route
-        path={`/${buildRouteRef.path}`}
+        path={`${buildRouteRef.path}`}
         element={<WorkflowRunDetails entity={entity} />}
       />
-      )
     </Routes>
   );
 };

plugins/cloudbuild/src/components/WorkflowRunsTable/WorkflowRunsTable.tsx

@@ -17,7 +17,7 @@ import React from 'react';
 import { Link, Typography, Box, IconButton, Tooltip } from '@material-ui/core';
 import RetryIcon from '@material-ui/icons/Replay';
 import GoogleIcon from '@material-ui/icons/CloudCircle';
-import { Link as RouterLink, generatePath } from 'react-router-dom';
+import { Link as RouterLink } from 'react-router-dom';
 import { useWorkflowRuns, WorkflowRun } from '../useWorkflowRuns';
 import { WorkflowRunStatus } from '../WorkflowRunStatus';
 import SyncIcon from '@material-ui/icons/Sync';
@@ -26,6 +26,7 @@ import { Entity } from '@backstage/catalog-model';
 import { buildRouteRef } from '../../routes';
 import { DateTime } from 'luxon';
 import { Table, TableColumn } from '@backstage/core-components';
+import { useRouteRef } from '@backstage/core-plugin-api';
 
 const generatedColumns: TableColumn[] = [
   {
@@ -54,15 +55,19 @@ const generatedColumns: TableColumn[] = [
     field: 'source',
     highlight: true,
     width: '200px',
-    render: (row: Partial<WorkflowRun>) => (
-      <Link
-        component={RouterLink}
-        data-testid="cell-source"
-        to={generatePath(buildRouteRef.path, { id: row.id! })}
-      >
-        {row.message}
-      </Link>
-    ),
+    render: (row: Partial<WorkflowRun>) => {
+      // eslint-disable-next-line react-hooks/rules-of-hooks
+      const routeLink = useRouteRef(buildRouteRef);
+      return (
+        <Link
+          component={RouterLink}
+          data-testid="cell-source"
+          to={routeLink({ id: row.id! })}
+        >
+          {row.message}
+        </Link>
+      );
+    },
   },
   {
     title: 'Ref',

plugins/cloudbuild/src/routes.ts

@@ -13,12 +13,14 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-import { createRouteRef } from '@backstage/core-plugin-api';
+import { createRouteRef, createSubRouteRef } from '@backstage/core-plugin-api';
 
 export const rootRouteRef = createRouteRef({
   id: 'cloudbuild',
 });
 
-export const buildRouteRef = createRouteRef({
+export const buildRouteRef = createSubRouteRef({
   id: 'cloudbuild/run',
+  path: '/:id',
+  parent: rootRouteRef,
 });

plugins/github-actions/src/components/Router.tsx

@@ -17,7 +17,7 @@ import React from 'react';
 import { Entity } from '@backstage/catalog-model';
 import { useEntity } from '@backstage/plugin-catalog-react';
 import { Routes, Route } from 'react-router';
-import { rootRouteRef, buildRouteRef } from '../routes';
+import { buildRouteRef } from '../routes';
 import { WorkflowRunDetails } from './WorkflowRunDetails';
 import { WorkflowRunsTable } from './WorkflowRunsTable';
 import { GITHUB_ACTIONS_ANNOTATION } from './useProjectName';
@@ -41,12 +41,9 @@ export const Router = (_props: Props) => {
   }
   return (
     <Routes>
+      <Route path="/" element={<WorkflowRunsTable entity={entity} />} />
       <Route
-        path={`/${rootRouteRef.path}`}
-        element={<WorkflowRunsTable entity={entity} />}
-      />
-      <Route
-        path={`/${buildRouteRef.path}`}
+        path={`${buildRouteRef.path}`}
         element={<WorkflowRunDetails entity={entity} />}
       />
       )

plugins/github-actions/src/components/WorkflowRunsTable/WorkflowRunsTable.tsx

@@ -24,7 +24,7 @@ import {
 } from '@material-ui/core';
 import RetryIcon from '@material-ui/icons/Replay';
 import GitHubIcon from '@material-ui/icons/GitHub';
-import { Link as RouterLink, generatePath } from 'react-router-dom';
+import { Link as RouterLink } from 'react-router-dom';
 import { useWorkflowRuns, WorkflowRun } from '../useWorkflowRuns';
 import { WorkflowRunStatus } from '../WorkflowRunStatus';
 import SyncIcon from '@material-ui/icons/Sync';
@@ -34,7 +34,7 @@ import { Entity } from '@backstage/catalog-model';
 import { readGitHubIntegrationConfigs } from '@backstage/integration';
 
 import { EmptyState, Table, TableColumn } from '@backstage/core-components';
-import { configApiRef, useApi } from '@backstage/core-plugin-api';
+import { configApiRef, useApi, useRouteRef } from '@backstage/core-plugin-api';
 
 const generatedColumns: TableColumn[] = [
   {
@@ -47,14 +47,15 @@ const generatedColumns: TableColumn[] = [
     title: 'Message',
     field: 'message',
     highlight: true,
-    render: (row: Partial<WorkflowRun>) => (
-      <Link
-        component={RouterLink}
-        to={generatePath(buildRouteRef.path, { id: row.id! })}
-      >
-        {row.message}
-      </Link>
-    ),
+    render: (row: Partial<WorkflowRun>) => {
+      // eslint-disable-next-line react-hooks/rules-of-hooks
+      const routeLink = useRouteRef(buildRouteRef);
+      return (
+        <Link component={RouterLink} to={routeLink({ id: row.id! })}>
+          {row.message}
+        </Link>
+      );
+    },
   },
   {
     title: 'Source',

plugins/github-actions/src/routes.ts

@@ -14,13 +14,14 @@
  * limitations under the License.
  */
 
-import { createRouteRef } from '@backstage/core-plugin-api';
+import { createRouteRef, createSubRouteRef } from '@backstage/core-plugin-api';
 
 export const rootRouteRef = createRouteRef({
   id: 'github-actions',
 });
 
-export const buildRouteRef = createRouteRef({
+export const buildRouteRef = createSubRouteRef({
   id: 'github-actions/build',
-  params: ['id'],
+  path: '/:id',
+  parent: rootRouteRef,
 });