frontend-app-api: lift over resolveRouteBindings and RoutingProvider

Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
2023-10-12 16:26:38 +02:00
parent aee98148c0
commit d4400f5e27
5 changed files with 235 additions and 59 deletions
@@ -0,0 +1,66 @@
+/*
+ * Copyright 2020 The Backstage Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import React, { ReactNode } from 'react';
+import {
+  ExternalRouteRef,
+  RouteRef,
+  SubRouteRef,
+} from '@backstage/frontend-plugin-api';
+import {
+  createVersionedValueMap,
+  createVersionedContext,
+} from '@backstage/version-bridge';
+import { RouteResolver } from './RouteResolver';
+import { BackstageRouteObject } from './types';
+
+const RoutingContext = createVersionedContext<{ 1: RouteResolver }>(
+  'routing-context',
+);
+
+type ProviderProps = {
+  routePaths: Map<RouteRef, string>;
+  routeParents: Map<RouteRef, RouteRef | undefined>;
+  routeObjects: BackstageRouteObject[];
+  routeBindings: Map<ExternalRouteRef, RouteRef | SubRouteRef>;
+  basePath?: string;
+  children: ReactNode;
+};
+
+// TODO(Rugvip): Migrate to a routing API instead
+export const RoutingProvider = ({
+  routePaths,
+  routeParents,
+  routeObjects,
+  routeBindings,
+  basePath = '',
+  children,
+}: ProviderProps) => {
+  const resolver = new RouteResolver(
+    routePaths,
+    routeParents,
+    routeObjects,
+    routeBindings,
+    basePath,
+  );
+
+  const versionedValue = createVersionedValueMap({ 1: resolver });
+  return (
+    <RoutingContext.Provider value={versionedValue}>
+      {children}
+    </RoutingContext.Provider>
+  );
+};
@@ -0,0 +1,17 @@
+/*
+ * Copyright 2023 The Backstage Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+export { type AppRouteBinder } from './resolveRouteBindings';
@@ -0,0 +1,43 @@
+/*
+ * Copyright 2020 The Backstage Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import {
+  createExternalRouteRef,
+  createRouteRef,
+} from '@backstage/frontend-plugin-api';
+import { resolveRouteBindings } from './resolveRouteBindings';
+
+describe('resolveRouteBindings', () => {
+  it('runs happy path', () => {
+    const external = { myRoute: createExternalRouteRef() };
+    const ref = createRouteRef();
+    const result = resolveRouteBindings(({ bind }) => {
+      bind(external, { myRoute: ref });
+    });
+
+    expect(result.get(external.myRoute)).toBe(ref);
+  });
+
+  it('throws on unknown keys', () => {
+    const external = { myRoute: createExternalRouteRef() };
+    const ref = createRouteRef();
+    expect(() =>
+      resolveRouteBindings(({ bind }) => {
+        bind(external, { someOtherRoute: ref } as any);
+      }),
+    ).toThrow('Key someOtherRoute is not an existing external route');
+  });
+});
@@ -0,0 +1,104 @@
+/*
+ * Copyright 2020 The Backstage Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import {
+  RouteRef,
+  SubRouteRef,
+  ExternalRouteRef,
+} from '@backstage/frontend-plugin-api';
+
+/**
+ * Extracts a union of the keys in a map whose value extends the given type
+ *
+ * @ignore
+ */
+type KeysWithType<Obj extends { [key in string]: any }, Type> = {
+  [key in keyof Obj]: Obj[key] extends Type ? key : never;
+}[keyof Obj];
+
+/**
+ * Takes a map Map required values and makes all keys matching Keys optional
+ *
+ * @ignore
+ */
+type PartialKeys<
+  Map extends { [name in string]: any },
+  Keys extends keyof Map,
+> = Partial<Pick<Map, Keys>> & Required<Omit<Map, Keys>>;
+
+/**
+ * Creates a map of target routes with matching parameters based on a map of external routes.
+ *
+ * @ignore
+ */
+type TargetRouteMap<
+  ExternalRoutes extends { [name: string]: ExternalRouteRef },
+> = {
+  [name in keyof ExternalRoutes]: ExternalRoutes[name] extends ExternalRouteRef<
+    infer Params,
+    any
+  >
+    ? RouteRef<Params> | SubRouteRef<Params>
+    : never;
+};
+
+/**
+ * A function that can bind from external routes of a given plugin, to concrete
+ * routes of other plugins. See {@link createApp}.
+ *
+ * @public
+ */
+export type AppRouteBinder = <
+  TExternalRoutes extends { [name: string]: ExternalRouteRef },
+>(
+  externalRoutes: TExternalRoutes,
+  targetRoutes: PartialKeys<
+    TargetRouteMap<TExternalRoutes>,
+    KeysWithType<TExternalRoutes, ExternalRouteRef<any, true>>
+  >,
+) => void;
+
+/** @internal */
+export function resolveRouteBindings(
+  bindRoutes?: (context: { bind: AppRouteBinder }) => void,
+): Map<ExternalRouteRef, RouteRef | SubRouteRef> {
+  const result = new Map<ExternalRouteRef, RouteRef | SubRouteRef>();
+
+  if (bindRoutes) {
+    const bind: AppRouteBinder = (
+      externalRoutes,
+      targetRoutes: { [name: string]: RouteRef | SubRouteRef },
+    ) => {
+      for (const [key, value] of Object.entries(targetRoutes)) {
+        const externalRoute = externalRoutes[key];
+        if (!externalRoute) {
+          throw new Error(`Key ${key} is not an existing external route`);
+        }
+        if (!value && !externalRoute.optional) {
+          throw new Error(
+            `External route ${key} is required but was undefined`,
+          );
+        }
+        if (value) {
+          result.set(externalRoute, value);
+        }
+      }
+    };
+    bindRoutes({ bind });
+  }
+
+  return result;
+}
@@ -21,9 +21,7 @@ import {
  coreExtensionData,
  ExtensionDataRef,
  ExtensionOverrides,
-  ExternalRouteRef,
  RouteRef,
-  SubRouteRef,
  useRouteRef,
 } from '@backstage/frontend-plugin-api';
 import { Core } from '../extensions/Core';
@@ -76,10 +74,6 @@ import { defaultConfigLoaderSync } from '../../../core-app-api/src/app/defaultCo
 // eslint-disable-next-line @backstage/no-relative-monorepo-imports
 import { overrideBaseUrlConfigs } from '../../../core-app-api/src/app/overrideBaseUrlConfigs';
 // eslint-disable-next-line @backstage/no-relative-monorepo-imports
-import { RoutingProvider } from '../../../core-app-api/src/routing/RoutingProvider';
-// eslint-disable-next-line @backstage/no-relative-monorepo-imports
-import { resolveRouteBindings } from '../../../core-app-api/src/app/resolveRouteBindings';
-// eslint-disable-next-line @backstage/no-relative-monorepo-imports
 import { AppLanguageSelector } from '../../../core-app-api/src/apis/implementations/AppLanguageApi/AppLanguageSelector';
 // eslint-disable-next-line @backstage/no-relative-monorepo-imports
 import { I18nextTranslationApi } from '../../../core-app-api/src/apis/implementations/TranslationApi/I18nextTranslationApi';
@@ -98,57 +92,9 @@ import {
  appLanguageApiRef,
  translationApiRef,
 } from '@backstage/core-plugin-api/alpha';
-
-/**
- * Extracts a union of the keys in a map whose value extends the given type
- *
- * @ignore
- */
-type KeysWithType<Obj extends { [key in string]: any }, Type> = {
-  [key in keyof Obj]: Obj[key] extends Type ? key : never;
-}[keyof Obj];
-
-/**
- * Takes a map Map required values and makes all keys matching Keys optional
- *
- * @ignore
- */
-type PartialKeys<
-  Map extends { [name in string]: any },
-  Keys extends keyof Map,
-> = Partial<Pick<Map, Keys>> & Required<Omit<Map, Keys>>;
-
-/**
- * Creates a map of target routes with matching parameters based on a map of external routes.
- *
- * @ignore
- */
-type TargetRouteMap<
-  ExternalRoutes extends { [name: string]: ExternalRouteRef },
-> = {
-  [name in keyof ExternalRoutes]: ExternalRoutes[name] extends ExternalRouteRef<
-    infer Params,
-    any
-  >
-    ? RouteRef<Params> | SubRouteRef<Params>
-    : never;
-};
-
-/**
- * A function that can bind from external routes of a given plugin, to concrete
- * routes of other plugins. See {@link createApp}.
- *
- * @public
- */
-export type AppRouteBinder = <
-  TExternalRoutes extends { [name: string]: ExternalRouteRef },
->(
-  externalRoutes: TExternalRoutes,
-  targetRoutes: PartialKeys<
-    TargetRouteMap<TExternalRoutes>,
-    KeysWithType<TExternalRoutes, ExternalRouteRef<any, true>>
-  >,
-) => void;
+import { AppRouteBinder } from '../routing';
+import { RoutingProvider } from '../routing/RoutingProvider';
+import { resolveRouteBindings } from '../routing/resolveRouteBindings';

 /** @public */
 export interface ExtensionTreeNode {
@@ -365,8 +311,8 @@ export function createApp(options: {
          <AppThemeProvider>
            <RoutingProvider
              // TODO(Rugvip): Move over routing app API to new system to avoid these casts
-              {...(extractRouteInfoFromInstanceTree(coreInstance) as any)}
-              routeBindings={resolveRouteBindings(options.bindRoutes as any)}
+              {...extractRouteInfoFromInstanceTree(coreInstance)}
+              routeBindings={resolveRouteBindings(options.bindRoutes)}
            >
              {/* TODO: set base path using the logic from AppRouter */}
              <BrowserRouter>