@backstage/core-app-api 0.6.0 → 1.0.1-next.1

package/CHANGELOG.md

@@ -1,5 +1,38 @@
 # @backstage/core-app-api
 
+## 1.0.1-next.1
+
+### Patch Changes
+
+- 24254fd433: build(deps): bump `@testing-library/user-event` from 13.5.0 to 14.0.0
+- 3ff2bfb66e: Refactored the route collection logic to prepare for future changes and avoid duplicate element tree traversal for the analytics context.
+- 230ad0826f: Bump to using `@types/node` v16
+- Updated dependencies
+  - @backstage/core-plugin-api@1.0.1-next.0
+
+## 1.0.1-next.0
+
+### Patch Changes
+
+- a7bb762dab: fixed empty body issue for POST requests using FetchAPI with 'plugin://' prefix
+- c47509e1a0: Implemented changes suggested by Deepsource.io including multiple double non-null assertion operators and unexpected awaits for non-promise values.
+
+## 1.0.0
+
+### Major Changes
+
+- b58c70c223: This package has been promoted to v1.0! To understand how this change affects the package, please check out our [versioning policy](https://backstage.io/docs/overview/versioning-policy).
+
+### Patch Changes
+
+- a422d7ce5e: chore(deps): bump `@testing-library/react` from 11.2.6 to 12.1.3
+- f24ef7864e: Minor typo fixes
+- Updated dependencies
+  - @backstage/core-plugin-api@1.0.0
+  - @backstage/version-bridge@1.0.0
+  - @backstage/config@1.0.0
+  - @backstage/types@1.0.0
+
 ## 0.6.0
 
 ### Minor Changes

package/README.md

@@ -6,9 +6,8 @@ This package provides the core API used by Backstage apps.
 
 Install the package via Yarn:
 
-```sh
-cd packages/app
-yarn add @backstage/core-app-api
+```bash
+yarn add --cwd packages/app @backstage/core-app-api
 ```
 
 ## Documentation

package/dist/index.d.ts

@@ -648,7 +648,7 @@ declare type AppOptions = {
     apis?: Iterable<AnyApiFactory>;
     /**
      * A collection of ApiFactories to register in the application as default APIs.
-     * Theses APIs can not be overridden by plugin factories, but can be overridden
+     * These APIs cannot be overridden by plugin factories, but can be overridden
      * by plugin APIs provided through the
      * A collection of ApiFactories to register in the application to either
      * add new ones, or override factories provided by default or by plugins.

package/dist/index.esm.js

@@ -1,4 +1,4 @@
-import React, { useContext, Children, isValidElement, useMemo, useEffect, useState } from 'react';
+import React, { useContext, Children, isValidElement, useEffect, useMemo, useState, createContext } from 'react';
 import PropTypes from 'prop-types';
 import { createVersionedContext, createVersionedValueMap, getOrCreateGlobalSingleton } from '@backstage/version-bridge';
 import ObservableImpl from 'zen-observable';
@@ -1402,7 +1402,7 @@ class PluginProtocolResolverFetchMiddleware {
         base = `${baseUrl.protocol}//${authority}${baseUrl.host}${baseUrl.pathname}`;
       }
       const target = `${join(base, pathname)}${search}${hash}`;
-      return next(target, request);
+      return next(target, typeof input === "string" ? init : input);
     };
   }
 }
@@ -1671,88 +1671,64 @@ const FeatureFlagged = (props) => {
 };
 attachComponentData(FeatureFlagged, "core.featureFlagged", true);
 
-function getMountPoint(node) {
-  var _a;
-  const element = (_a = node.props) == null ? void 0 : _a.element;
-  let routeRef = getComponentData(node, "core.mountPoint");
-  if (!routeRef && isValidElement(element)) {
-    routeRef = getComponentData(element, "core.mountPoint");
-  }
-  return routeRef;
-}
-const routePathCollector = createCollector(() => /* @__PURE__ */ new Map(), (acc, node, parent, ctxPath) => {
-  var _a, _b;
-  let currentCtxPath = ctxPath;
+const MATCH_ALL_ROUTE = {
+  caseSensitive: false,
+  path: "/*",
+  element: "match-all",
+  routeRefs: /* @__PURE__ */ new Set()
+};
+const routingV1Collector = createCollector(() => ({
+  paths: /* @__PURE__ */ new Map(),
+  parents: /* @__PURE__ */ new Map(),
+  objects: new Array()
+}), (acc, node, parent, ctx) => {
+  var _a, _b, _c, _d, _e;
   if ((parent == null ? void 0 : parent.props.element) === node) {
-    return currentCtxPath;
+    return ctx;
   }
+  let currentObj = ctx == null ? void 0 : ctx.obj;
+  let currentParentRouteRef = ctx == null ? void 0 : ctx.routeRef;
+  let sticky = ctx == null ? void 0 : ctx.sticky;
+  const path = (_a = node.props) == null ? void 0 : _a.path;
+  const parentChildren = (_b = currentObj == null ? void 0 : currentObj.children) != null ? _b : acc.objects;
+  const caseSensitive = Boolean((_c = node.props) == null ? void 0 : _c.caseSensitive);
+  let currentCtxPath = ctx == null ? void 0 : ctx.path;
   if (getComponentData(node, "core.gatherMountPoints")) {
-    const path = (_a = node.props) == null ? void 0 : _a.path;
     if (!path) {
       throw new Error("Mount point gatherer must have a path");
     }
     currentCtxPath = path;
   }
-  const routeRef = getMountPoint(node);
+  const element = (_d = node.props) == null ? void 0 : _d.element;
+  let routeRef = getComponentData(node, "core.mountPoint");
+  if (!routeRef && isValidElement(element)) {
+    routeRef = getComponentData(element, "core.mountPoint");
+  }
   if (routeRef) {
-    let path = (_b = node.props) == null ? void 0 : _b.path;
+    let routePath = path;
     if (currentCtxPath) {
-      if (path) {
+      if (routePath) {
         currentCtxPath = void 0;
       } else {
-        path = currentCtxPath;
+        routePath = currentCtxPath;
       }
     }
-    if (!path) {
+    if (!routePath) {
       throw new Error("Mounted routable extension must have a path");
     }
-    acc.set(routeRef, path);
-  }
-  return currentCtxPath;
-});
-const routeParentCollector = createCollector(() => /* @__PURE__ */ new Map(), (acc, node, parent, parentRouteRef) => {
-  var _a;
-  if ((parent == null ? void 0 : parent.props.element) === node) {
-    return parentRouteRef;
-  }
-  let nextParent = parentRouteRef;
-  const routeRef = getMountPoint(node);
-  if (routeRef) {
-    if (parentRouteRef && "sticky" in parentRouteRef) {
-      acc.set(routeRef, parentRouteRef.sticky);
-      if ((_a = node.props) == null ? void 0 : _a.path) {
-        nextParent = routeRef;
-      } else {
-        nextParent = parentRouteRef;
+    acc.paths.set(routeRef, routePath);
+    if (currentParentRouteRef && sticky) {
+      acc.parents.set(routeRef, currentParentRouteRef);
+      if (path) {
+        currentParentRouteRef = routeRef;
+        sticky = false;
       }
     } else {
-      acc.set(routeRef, parentRouteRef);
-      nextParent = routeRef;
+      acc.parents.set(routeRef, currentParentRouteRef);
+      currentParentRouteRef = routeRef;
     }
-  }
-  if (getComponentData(node, "core.gatherMountPoints")) {
-    return { sticky: nextParent };
-  }
-  return nextParent;
-});
-const MATCH_ALL_ROUTE = {
-  caseSensitive: false,
-  path: "/*",
-  element: "match-all",
-  routeRefs: /* @__PURE__ */ new Set()
-};
-const routeObjectCollector = createCollector(() => Array(), (acc, node, parent, parentObj) => {
-  var _a, _b, _c;
-  const parentChildren = (_a = parentObj == null ? void 0 : parentObj.children) != null ? _a : acc;
-  if ((parent == null ? void 0 : parent.props.element) === node) {
-    return parentObj;
-  }
-  const path = (_b = node.props) == null ? void 0 : _b.path;
-  const caseSensitive = Boolean((_c = node.props) == null ? void 0 : _c.caseSensitive);
-  const routeRef = getMountPoint(node);
-  if (routeRef) {
     if (path) {
-      const newObject = {
+      currentObj = {
         caseSensitive,
         path,
         element: "mounted",
@@ -1760,28 +1736,37 @@ const routeObjectCollector = createCollector(() => Array(), (acc, node, parent,
         children: [MATCH_ALL_ROUTE],
         plugin: getComponentData(node.props.element, "core.plugin")
       };
-      parentChildren.push(newObject);
-      return newObject;
+      parentChildren.push(currentObj);
+    } else {
+      currentObj == null ? void 0 : currentObj.routeRefs.add(routeRef);
     }
-    parentObj == null ? void 0 : parentObj.routeRefs.add(routeRef);
+  }
+  if (getComponentData(node, "core.gatherMountPoints")) {
+    sticky = true;
   }
   const isGatherer = getComponentData(node, "core.gatherMountPoints");
   if (isGatherer) {
     if (!path) {
       throw new Error("Mount point gatherer must have a path");
     }
-    const newObject = {
-      caseSensitive,
-      path,
-      element: "gathered",
-      routeRefs: /* @__PURE__ */ new Set(),
-      children: [MATCH_ALL_ROUTE],
-      plugin: parentObj == null ? void 0 : parentObj.plugin
-    };
-    parentChildren.push(newObject);
-    return newObject;
+    if (!routeRef) {
+      currentObj = {
+        caseSensitive,
+        path,
+        element: "gathered",
+        routeRefs: /* @__PURE__ */ new Set(),
+        children: [MATCH_ALL_ROUTE],
+        plugin: (_e = ctx == null ? void 0 : ctx.obj) == null ? void 0 : _e.plugin
+      };
+      parentChildren.push(currentObj);
+    }
   }
-  return parentObj;
+  return {
+    obj: currentObj,
+    path: currentCtxPath,
+    routeRef: currentParentRouteRef,
+    sticky
+  };
 });
 const featureFlagCollector = createCollector(() => /* @__PURE__ */ new Set(), (acc, node) => {
   if (node.type === FeatureFlagged) {
@@ -1964,17 +1949,10 @@ const TrackNavigation = ({
   }, [analytics, pathname, search, hash]);
   return null;
 };
-const RouteTracker = ({ tree }) => {
+const RouteTracker = ({
+  routeObjects
+}) => {
   const { pathname, search, hash } = useLocation();
-  const { routeObjects } = useMemo(() => {
-    return traverseElementTree({
-      root: tree,
-      discoverers: [childDiscoverer, routeElementDiscoverer],
-      collectors: {
-        routeObjects: routeObjectCollector
-      }
-    });
-  }, [tree]);
   return /* @__PURE__ */ React.createElement(AnalyticsContext, {
     attributes: getExtensionContext(pathname, routeObjects)
   }, /* @__PURE__ */ React.createElement(TrackNavigation, {
@@ -2239,6 +2217,7 @@ function resolveRouteBindings(bindRoutes) {
   return result;
 }
 
+const InternalAppContext = createContext({ routeObjects: [] });
 function getBasePath(configApi) {
   var _a;
   let { pathname } = new URL((_a = configApi.getOptionalString("app.baseUrl")) != null ? _a : "/", "http://dummy.dev");
@@ -2313,20 +2292,12 @@ class AppManager {
     let routesHaveBeenValidated = false;
     const Provider = ({ children }) => {
       const appThemeApi = useMemo(() => AppThemeSelector.createWithStorage(this.themes), []);
-      const {
-        routePaths,
-        routeParents,
-        routeObjects,
-        featureFlags,
-        routeBindings
-      } = useMemo(() => {
+      const { routing, featureFlags, routeBindings } = useMemo(() => {
         const result = traverseElementTree({
           root: children,
           discoverers: [childDiscoverer, routeElementDiscoverer],
           collectors: {
-            routePaths: routePathCollector,
-            routeParents: routeParentCollector,
-            routeObjects: routeObjectCollector,
+            routing: routingV1Collector,
             collectedPlugins: pluginCollector,
             featureFlags: featureFlagCollector
           }
@@ -2341,7 +2312,7 @@ class AppManager {
       }, [children]);
       if (!routesHaveBeenValidated) {
         routesHaveBeenValidated = true;
-        validateRouteParameters(routePaths, routeParents);
+        validateRouteParameters(routing.paths, routing.parents);
         validateRouteBindings(routeBindings, this.plugins);
       }
       const loadedConfig = useConfigLoader(this.configLoader, this.components, appThemeApi);
@@ -2386,12 +2357,14 @@ class AppManager {
       }, /* @__PURE__ */ React.createElement(AppContextProvider, {
         appContext
       }, /* @__PURE__ */ React.createElement(ThemeProvider, null, /* @__PURE__ */ React.createElement(RoutingProvider, {
-        routePaths,
-        routeParents,
-        routeObjects,
+        routePaths: routing.paths,
+        routeParents: routing.parents,
+        routeObjects: routing.objects,
         routeBindings,
         basePath: getBasePath(loadedConfig.api)
-      }, children))));
+      }, /* @__PURE__ */ React.createElement(InternalAppContext.Provider, {
+        value: { routeObjects: routing.objects }
+      }, children)))));
     };
     return Provider;
   }
@@ -2413,6 +2386,7 @@ class AppManager {
     const AppRouter = ({ children }) => {
       const configApi = useApi(configApiRef);
       const mountPath = `${getBasePath(configApi)}/*`;
+      const { routeObjects } = useContext(InternalAppContext);
       if (!SignInPageComponent) {
         this.appIdentityProxy.setTarget({
           getUserId: () => "guest",
@@ -2435,14 +2409,14 @@ class AppManager {
           }
         });
         return /* @__PURE__ */ React.createElement(RouterComponent, null, /* @__PURE__ */ React.createElement(RouteTracker, {
-          tree: children
+          routeObjects
         }), /* @__PURE__ */ React.createElement(Routes, null, /* @__PURE__ */ React.createElement(Route, {
           path: mountPath,
           element: /* @__PURE__ */ React.createElement(React.Fragment, null, children)
         })));
       }
       return /* @__PURE__ */ React.createElement(RouterComponent, null, /* @__PURE__ */ React.createElement(RouteTracker, {
-        tree: children
+        routeObjects
       }), /* @__PURE__ */ React.createElement(SignInPageWrapper, {
         component: SignInPageComponent
       }, /* @__PURE__ */ React.createElement(Routes, null, /* @__PURE__ */ React.createElement(Route, {