;
-// @public
+// @alpha
export const atlassianAuthApiRef: ApiRef<
OAuthApi & ProfileInfoApi & BackstageIdentityApi & SessionApi
>;
@@ -208,7 +206,7 @@ export function attachComponentData(
data: unknown,
): void;
-// @public
+// @public @deprecated
export const auth0AuthApiRef: ApiRef<
OpenIdConnectApi & ProfileInfoApi & BackstageIdentityApi & SessionApi
>;
@@ -236,18 +234,21 @@ export type AuthRequestOptions = {
instantPopup?: boolean;
};
-// @public
-export type BackstageIdentity = {
- id: string;
- idToken: string;
- token: string;
-};
+// @public @deprecated
+export type BackstageIdentity = BackstageIdentityResponse;
// @public
export type BackstageIdentityApi = {
getBackstageIdentity(
options?: AuthRequestOptions,
- ): Promise;
+ ): Promise;
+};
+
+// @public
+export type BackstageIdentityResponse = {
+ id: string;
+ token: string;
+ identity: BackstageUserIdentity;
};
// @public
@@ -258,12 +259,20 @@ export type BackstagePlugin<
getId(): string;
output(): PluginOutput[];
getApis(): Iterable;
+ getFeatureFlags(): Iterable;
provide(extension: Extension): T;
routes: Routes;
externalRoutes: ExternalRoutes;
};
// @public
+export type BackstageUserIdentity = {
+ type: 'user';
+ userEntityRef: string;
+ ownershipEntityRefs: string[];
+};
+
+// @alpha
export const bitbucketAuthApiRef: ApiRef<
OAuthApi & ProfileInfoApi & BackstageIdentityApi & SessionApi
>;
@@ -463,7 +472,7 @@ export type FeatureFlag = {
pluginId: string;
};
-// @public
+// @public @deprecated
export type FeatureFlagOutput = {
type: 'feature-flag';
name: string;
@@ -503,17 +512,17 @@ export function getComponentData(
type: string,
): T | undefined;
-// @public
+// @alpha
export const githubAuthApiRef: ApiRef<
OAuthApi & ProfileInfoApi & BackstageIdentityApi & SessionApi
>;
-// @public
+// @alpha
export const gitlabAuthApiRef: ApiRef<
OAuthApi & ProfileInfoApi & BackstageIdentityApi & SessionApi
>;
-// @public
+// @alpha
export const googleAuthApiRef: ApiRef<
OAuthApi &
OpenIdConnectApi &
@@ -530,8 +539,13 @@ export type IconComponent = ComponentType<{
// @public
export type IdentityApi = {
getUserId(): string;
- getProfile(): ProfileInfo;
getIdToken(): Promise;
+ getProfile(): ProfileInfo;
+ getProfileInfo(): Promise;
+ getBackstageIdentity(): Promise;
+ getCredentials(): Promise<{
+ token?: string;
+ }>;
signOut(): Promise;
};
@@ -556,7 +570,7 @@ export type MergeParams<
P2 extends AnyParams,
> = (P1[keyof P1] extends never ? {} : P1) & (P2 extends undefined ? {} : P2);
-// @public
+// @alpha
export const microsoftAuthApiRef: ApiRef<
OAuthApi &
OpenIdConnectApi &
@@ -565,7 +579,7 @@ export const microsoftAuthApiRef: ApiRef<
SessionApi
>;
-// @public
+// @public @deprecated
export const oauth2ApiRef: ApiRef<
OAuthApi &
OpenIdConnectApi &
@@ -602,7 +616,7 @@ export type Observable = Observable_2;
// @public @deprecated
export type Observer = Observer_2;
-// @public
+// @public @deprecated
export const oidcAuthApiRef: ApiRef<
OAuthApi &
OpenIdConnectApi &
@@ -611,7 +625,7 @@ export const oidcAuthApiRef: ApiRef<
SessionApi
>;
-// @public
+// @alpha
export const oktaAuthApiRef: ApiRef<
OAuthApi &
OpenIdConnectApi &
@@ -623,7 +637,7 @@ export const oktaAuthApiRef: ApiRef<
// @public
export type OldIconComponent = ComponentType;
-// @public
+// @alpha
export const oneloginAuthApiRef: ApiRef<
OAuthApi &
OpenIdConnectApi &
@@ -682,14 +696,20 @@ export type PluginConfig<
register?(hooks: PluginHooks): void;
routes?: Routes;
externalRoutes?: ExternalRoutes;
+ featureFlags?: PluginFeatureFlagConfig[];
};
// @public
+export type PluginFeatureFlagConfig = {
+ name: string;
+};
+
+// @public @deprecated
export type PluginHooks = {
featureFlags: FeatureFlagsHooks;
};
-// @public
+// @public @deprecated
export type PluginOutput = FeatureFlagOutput;
// @public
@@ -718,7 +738,7 @@ export type RouteRef = {
title?: string;
};
-// @public
+// @public @deprecated
export const samlAuthApiRef: ApiRef<
ProfileInfoApi & BackstageIdentityApi & SessionApi
>;
@@ -738,10 +758,10 @@ export enum SessionState {
// @public
export type SignInPageProps = {
- onResult(result: SignInResult): void;
+ onSignInSuccess(identityApi: IdentityApi_2): void;
};
-// @public
+// @public @deprecated
export type SignInResult = {
userId: string;
profile: ProfileInfo_2;
diff --git a/packages/core-plugin-api/package.json b/packages/core-plugin-api/package.json
index 6679e89645..72827bde73 100644
--- a/packages/core-plugin-api/package.json
+++ b/packages/core-plugin-api/package.json
@@ -1,7 +1,7 @@
{
"name": "@backstage/core-plugin-api",
"description": "Core API used by Backstage plugins",
- "version": "0.1.13",
+ "version": "0.3.0",
"private": false,
"publishConfig": {
"access": "public",
@@ -30,22 +30,24 @@
},
"dependencies": {
"@backstage/config": "^0.1.11",
- "@backstage/theme": "^0.2.13",
+ "@backstage/theme": "^0.2.14",
"@backstage/types": "^0.1.1",
- "@backstage/version-bridge": "^0.1.0",
+ "@backstage/version-bridge": "^0.1.1",
"@material-ui/core": "^4.12.2",
- "@types/react": "*",
"history": "^5.0.0",
"prop-types": "^15.7.2",
- "react": "^16.12.0",
"react-router-dom": "6.0.0-beta.0",
"react-use": "^17.2.4",
"zen-observable": "^0.8.15"
},
+ "peerDependencies": {
+ "@types/react": "^16.13.1 || ^17.0.0",
+ "react": "^16.13.1 || ^17.0.0"
+ },
"devDependencies": {
- "@backstage/cli": "^0.8.2",
- "@backstage/core-app-api": "^0.1.20",
- "@backstage/test-utils": "^0.1.21",
+ "@backstage/cli": "^0.10.1",
+ "@backstage/core-app-api": "^0.2.0",
+ "@backstage/test-utils": "^0.1.24",
"@testing-library/jest-dom": "^5.10.1",
"@testing-library/react": "^11.2.5",
"@testing-library/react-hooks": "^7.0.2",
diff --git a/packages/core-plugin-api/src/analytics/AnalyticsContext.tsx b/packages/core-plugin-api/src/analytics/AnalyticsContext.tsx
index bb2141d47f..075cdff3ff 100644
--- a/packages/core-plugin-api/src/analytics/AnalyticsContext.tsx
+++ b/packages/core-plugin-api/src/analytics/AnalyticsContext.tsx
@@ -62,13 +62,12 @@ export const useAnalyticsContext = (): AnalyticsContextValue => {
*
* @public
*/
-export const AnalyticsContext = ({
- attributes,
- children,
-}: {
+export const AnalyticsContext = (options: {
attributes: Partial;
children: ReactNode;
}) => {
+ const { attributes, children } = options;
+
const parentValues = useAnalyticsContext();
const combinedValue = {
...parentValues,
diff --git a/packages/core-plugin-api/src/apis/definitions/IdentityApi.ts b/packages/core-plugin-api/src/apis/definitions/IdentityApi.ts
index 9f68a8b2cc..fe4de89106 100644
--- a/packages/core-plugin-api/src/apis/definitions/IdentityApi.ts
+++ b/packages/core-plugin-api/src/apis/definitions/IdentityApi.ts
@@ -14,7 +14,7 @@
* limitations under the License.
*/
import { ApiRef, createApiRef } from '../system';
-import { ProfileInfo } from './auth';
+import { BackstageUserIdentity, ProfileInfo } from './auth';
/**
* The Identity API used to identify and get information about the signed in user.
@@ -26,25 +26,45 @@ export type IdentityApi = {
* The ID of the signed in user. This ID is not meant to be presented to the user, but used
* as an opaque string to pass on to backends or use in frontend logic.
*
- * TODO: The intention of the user ID is to be able to tie the user to an identity
- * that is known by the catalog and/or identity backend. It should for example
- * be possible to fetch all owned components using this ID.
+ * @deprecated use {@link IdentityApi.getBackstageIdentity} instead.
*/
getUserId(): string;
- /**
- * The profile of the signed in user.
- */
- getProfile(): ProfileInfo;
-
/**
* An OpenID Connect ID Token which proves the identity of the signed in user.
*
* The ID token will be undefined if the signed in user does not have a verified
* identity, such as a demo user or mocked user for e2e tests.
+ *
+ * @deprecated use {@link IdentityApi.getCredentials} instead.
*/
getIdToken(): Promise;
+ /**
+ * The profile of the signed in user.
+ *
+ * @deprecated use {@link IdentityApi.getProfileInfo} instead.
+ */
+ getProfile(): ProfileInfo;
+
+ /**
+ * The profile of the signed in user.
+ */
+ getProfileInfo(): Promise;
+
+ /**
+ * User identity information within Backstage.
+ */
+ getBackstageIdentity(): Promise;
+
+ /**
+ * Provides credentials in the form of a token which proves the identity of the signed in user.
+ *
+ * The token will be undefined if the signed in user does not have a verified
+ * identity, such as a demo user or mocked user for e2e tests.
+ */
+ getCredentials(): Promise<{ token?: string }>;
+
/**
* Sign out the current user
*/
diff --git a/packages/core-plugin-api/src/apis/definitions/auth.ts b/packages/core-plugin-api/src/apis/definitions/auth.ts
index 8fe532f3a6..8b799b2dd6 100644
--- a/packages/core-plugin-api/src/apis/definitions/auth.ts
+++ b/packages/core-plugin-api/src/apis/definitions/auth.ts
@@ -160,31 +160,65 @@ export type BackstageIdentityApi = {
*/
getBackstageIdentity(
options?: AuthRequestOptions,
- ): Promise;
+ ): Promise;
};
/**
- * A (user id, token) pair.
+ * User identity information within Backstage.
*
* @public
*/
-export type BackstageIdentity = {
+export type BackstageUserIdentity = {
/**
- * The backstage user ID.
+ * The type of identity that this structure represents. In the frontend app
+ * this will currently always be 'user'.
*/
- id: string;
+ type: 'user';
/**
- * @deprecated This is deprecated, use `token` instead.
+ * The entityRef of the user in the catalog.
+ * For example User:default/sandra
*/
- idToken: string;
+ userEntityRef: string;
+
+ /**
+ * The user and group entities that the user claims ownership through
+ */
+ ownershipEntityRefs: string[];
+};
+
+/**
+ * Token and Identity response, with the users claims in the Identity.
+ *
+ * @public
+ */
+export type BackstageIdentityResponse = {
+ /**
+ * The backstage user ID.
+ *
+ * @deprecated The identity is now provided via the `identity` field instead.
+ */
+ id: string;
/**
* The token used to authenticate the user within Backstage.
*/
token: string;
+
+ /**
+ * Identity information derived from the token.
+ */
+ identity: BackstageUserIdentity;
};
+/**
+ * The old exported symbol for {@link BackstageIdentityResponse}.
+ *
+ * @public
+ * @deprecated use {@link BackstageIdentityResponse} instead.
+ */
+export type BackstageIdentity = BackstageIdentityResponse;
+
/**
* Profile information of the user.
*
@@ -248,14 +282,14 @@ export type SessionApi = {
/**
* Provides authentication towards Google APIs and identities.
*
+ * @alpha This API is **EXPERIMENTAL** and might change in the future.
+ *
* @remarks
*
* See {@link https://developers.google.com/identity/protocols/googlescopes} for a full list of supported scopes.
*
* Note that the ID token payload is only guaranteed to contain the user's numerical Google ID,
* email and expiration information. Do not rely on any other fields, as they might not be present.
- *
- * @public
*/
export const googleAuthApiRef: ApiRef<
OAuthApi &
@@ -270,12 +304,12 @@ export const googleAuthApiRef: ApiRef<
/**
* Provides authentication towards GitHub APIs.
*
+ * @alpha This API is **EXPERIMENTAL** and might change in the future.
+ *
* @remarks
*
* See {@link https://developer.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/}
* for a full list of supported scopes.
- *
- * @public
*/
export const githubAuthApiRef: ApiRef<
OAuthApi & ProfileInfoApi & BackstageIdentityApi & SessionApi
@@ -286,12 +320,12 @@ export const githubAuthApiRef: ApiRef<
/**
* Provides authentication towards Okta APIs.
*
+ * @alpha This API is **EXPERIMENTAL** and might change in the future.
+ *
* @remarks
*
* See {@link https://developer.okta.com/docs/guides/implement-oauth-for-okta/scopes/}
* for a full list of supported scopes.
- *
- * @public
*/
export const oktaAuthApiRef: ApiRef<
OAuthApi &
@@ -306,12 +340,12 @@ export const oktaAuthApiRef: ApiRef<
/**
* Provides authentication towards GitLab APIs.
*
+ * @alpha This API is **EXPERIMENTAL** and might change in the future.
+ *
* @remarks
*
* See {@link https://docs.gitlab.com/ee/user/profile/personal_access_tokens.html#limiting-scopes-of-a-personal-access-token}
* for a full list of supported scopes.
- *
- * @public
*/
export const gitlabAuthApiRef: ApiRef<
OAuthApi & ProfileInfoApi & BackstageIdentityApi & SessionApi
@@ -328,6 +362,7 @@ export const gitlabAuthApiRef: ApiRef<
* for a full list of supported scopes.
*
* @public
+ * @deprecated See https://backstage.io/docs/api/deprecations#generic-auth-api-refs
*/
export const auth0AuthApiRef: ApiRef<
OpenIdConnectApi & ProfileInfoApi & BackstageIdentityApi & SessionApi
@@ -338,13 +373,13 @@ export const auth0AuthApiRef: ApiRef<
/**
* Provides authentication towards Microsoft APIs and identities.
*
+ * @alpha This API is **EXPERIMENTAL** and might change in the future.
+ *
* @remarks
*
* For more info and a full list of supported scopes, see:
* - {@link https://docs.microsoft.com/en-us/azure/active-directory/develop/v2-permissions-and-consent}
* - {@link https://docs.microsoft.com/en-us/graph/permissions-reference}
- *
- * @public
*/
export const microsoftAuthApiRef: ApiRef<
OAuthApi &
@@ -360,6 +395,7 @@ export const microsoftAuthApiRef: ApiRef<
* Provides authentication for custom identity providers.
*
* @public
+ * @deprecated See https://backstage.io/docs/api/deprecations#generic-auth-api-refs
*/
export const oauth2ApiRef: ApiRef<
OAuthApi &
@@ -375,6 +411,7 @@ export const oauth2ApiRef: ApiRef<
* Provides authentication for custom OpenID Connect identity providers.
*
* @public
+ * @deprecated See https://backstage.io/docs/api/deprecations#generic-auth-api-refs
*/
export const oidcAuthApiRef: ApiRef<
OAuthApi &
@@ -390,6 +427,7 @@ export const oidcAuthApiRef: ApiRef<
* Provides authentication for SAML-based identity providers.
*
* @public
+ * @deprecated See https://backstage.io/docs/api/deprecations#generic-auth-api-refs
*/
export const samlAuthApiRef: ApiRef<
ProfileInfoApi & BackstageIdentityApi & SessionApi
@@ -400,7 +438,7 @@ export const samlAuthApiRef: ApiRef<
/**
* Provides authentication towards OneLogin APIs.
*
- * @public
+ * @alpha This API is **EXPERIMENTAL** and might change in the future.
*/
export const oneloginAuthApiRef: ApiRef<
OAuthApi &
@@ -415,12 +453,11 @@ export const oneloginAuthApiRef: ApiRef<
/**
* Provides authentication towards Bitbucket APIs.
*
+ * @alpha This API is **EXPERIMENTAL** and might change in the future.
* @remarks
*
* See {@link https://support.atlassian.com/bitbucket-cloud/docs/use-oauth-on-bitbucket-cloud/}
* for a full list of supported scopes.
- *
- * @public
*/
export const bitbucketAuthApiRef: ApiRef<
OAuthApi & ProfileInfoApi & BackstageIdentityApi & SessionApi
@@ -431,12 +468,11 @@ export const bitbucketAuthApiRef: ApiRef<
/**
* Provides authentication towards Atlassian APIs.
*
+ * @alpha This API is **EXPERIMENTAL** and might change in the future.
* @remarks
*
* See {@link https://developer.atlassian.com/cloud/jira/platform/scopes-for-connect-and-oauth-2-3LO-apps/}
* for a full list of supported scopes.
- *
- * @public
*/
export const atlassianAuthApiRef: ApiRef<
OAuthApi & ProfileInfoApi & BackstageIdentityApi & SessionApi
diff --git a/packages/core-plugin-api/src/extensions/extensions.tsx b/packages/core-plugin-api/src/extensions/extensions.tsx
index ca5ada8478..19da082ee1 100644
--- a/packages/core-plugin-api/src/extensions/extensions.tsx
+++ b/packages/core-plugin-api/src/extensions/extensions.tsx
@@ -51,8 +51,27 @@ export type ComponentLoader =
export function createRoutableExtension<
T extends (props: any) => JSX.Element | null,
>(options: {
+ /**
+ * A loader for the component that is rendered by this extension.
+ */
component: () => Promise;
+
+ /**
+ * The mount point to bind this routable extension to.
+ *
+ * If this extension is placed somewhere in the app element tree of a Backstage
+ * app, callers will be able to route to this extensions by calling,
+ * `useRouteRef` with this mount point.
+ */
mountPoint: RouteRef;
+
+ /**
+ * The name of this extension that will represent it at runtime. It is for example
+ * used to identify this extension in analytics data.
+ *
+ * If possible the name should always be the same as the name of the exported
+ * variable for this extension.
+ */
name?: string;
}): Extension {
const { component, mountPoint, name } = options;
@@ -127,7 +146,21 @@ export function createRoutableExtension<
*/
export function createComponentExtension<
T extends (props: any) => JSX.Element | null,
->(options: { component: ComponentLoader; name?: string }): Extension {
+>(options: {
+ /**
+ * A loader or synchronously supplied component that is rendered by this extension.
+ */
+ component: ComponentLoader;
+
+ /**
+ * The name of this extension that will represent it at runtime. It is for example
+ * used to identify this extension in analytics data.
+ *
+ * If possible the name should always be the same as the name of the exported
+ * variable for this extension.
+ */
+ name?: string;
+}): Extension {
const { component, name } = options;
return createReactExtension({ component, name });
}
@@ -148,8 +181,23 @@ export function createComponentExtension<
export function createReactExtension<
T extends (props: any) => JSX.Element | null,
>(options: {
+ /**
+ * A loader or synchronously supplied component that is rendered by this extension.
+ */
component: ComponentLoader;
+
+ /**
+ * Additional component data that is attached to the top-level extension component.
+ */
data?: Record;
+
+ /**
+ * The name of this extension that will represent it at runtime. It is for example
+ * used to identify this extension in analytics data.
+ *
+ * If possible the name should always be the same as the name of the exported
+ * variable for this extension.
+ */
name?: string;
}): Extension {
const { data = {}, name } = options;
diff --git a/packages/core-plugin-api/src/extensions/useElementFilter.test.tsx b/packages/core-plugin-api/src/extensions/useElementFilter.test.tsx
index 4d42a0c969..8795ecdded 100644
--- a/packages/core-plugin-api/src/extensions/useElementFilter.test.tsx
+++ b/packages/core-plugin-api/src/extensions/useElementFilter.test.tsx
@@ -18,11 +18,8 @@ import { useElementFilter } from './useElementFilter';
import { renderHook } from '@testing-library/react-hooks';
import { attachComponentData } from './componentData';
import { featureFlagsApiRef } from '../apis';
-import {
- ApiProvider,
- ApiRegistry,
- LocalStorageFeatureFlags,
-} from '@backstage/core-app-api';
+import { LocalStorageFeatureFlags } from '@backstage/core-app-api';
+import { TestApiProvider } from '@backstage/test-utils';
const WRAPPING_COMPONENT_KEY = 'core.blob.testing';
const INNER_COMPONENT_KEY = 'core.blob2.testing';
@@ -45,9 +42,9 @@ const FeatureFlagComponent = (_props: {
attachComponentData(FeatureFlagComponent, 'core.featureFlagged', true);
const mockFeatureFlagsApi = new LocalStorageFeatureFlags();
const Wrapper = ({ children }: { children?: React.ReactNode }) => (
-
+
{children}
-
+
);
describe('useElementFilter', () => {
diff --git a/packages/core-plugin-api/src/plugin/Plugin.test.tsx b/packages/core-plugin-api/src/plugin/Plugin.test.tsx
new file mode 100644
index 0000000000..d3758543a1
--- /dev/null
+++ b/packages/core-plugin-api/src/plugin/Plugin.test.tsx
@@ -0,0 +1,89 @@
+/*
+ * Copyright 2021 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 { createPlugin } from './Plugin';
+
+describe('Plugin Feature Flag', () => {
+ it('should be able to register and receive feature flags', () => {
+ expect(
+ createPlugin({
+ id: 'test',
+ featureFlags: [{ name: 'test' }],
+ }).getFeatureFlags(),
+ ).toEqual([{ name: 'test' }]);
+
+ expect(
+ createPlugin({
+ id: 'test',
+ register({ featureFlags }) {
+ featureFlags.register('blob');
+ },
+ }).getFeatureFlags(),
+ ).toEqual([{ name: 'blob' }]);
+
+ expect(
+ createPlugin({
+ id: 'test',
+ register({ featureFlags }) {
+ featureFlags.register('blob');
+ },
+ featureFlags: [{ name: 'test' }],
+ }).getFeatureFlags(),
+ ).toEqual([{ name: 'test' }, { name: 'blob' }]);
+
+ expect(
+ createPlugin({
+ id: 'test',
+ }).getFeatureFlags(),
+ ).toEqual([]);
+
+ /* deprecated tests */
+
+ expect(
+ createPlugin({
+ id: 'test',
+ featureFlags: [{ name: 'test' }],
+ }).output(),
+ ).toEqual([{ name: 'test', type: 'feature-flag' }]);
+
+ expect(
+ createPlugin({
+ id: 'test',
+ register({ featureFlags }) {
+ featureFlags.register('blob');
+ },
+ }).output(),
+ ).toEqual([{ name: 'blob', type: 'feature-flag' }]);
+ expect(
+ createPlugin({
+ id: 'test',
+ register({ featureFlags }) {
+ featureFlags.register('blob');
+ },
+ featureFlags: [{ name: 'test' }],
+ }).output(),
+ ).toEqual([
+ { name: 'test', type: 'feature-flag' },
+ { name: 'blob', type: 'feature-flag' },
+ ]);
+
+ expect(
+ createPlugin({
+ id: 'test',
+ }).output(),
+ ).toEqual([]);
+ });
+});
diff --git a/packages/core-plugin-api/src/plugin/Plugin.tsx b/packages/core-plugin-api/src/plugin/Plugin.tsx
index 52ca0e76e3..0fb7574cd7 100644
--- a/packages/core-plugin-api/src/plugin/Plugin.tsx
+++ b/packages/core-plugin-api/src/plugin/Plugin.tsx
@@ -21,6 +21,7 @@ import {
Extension,
AnyRoutes,
AnyExternalRoutes,
+ PluginFeatureFlagConfig,
} from './types';
import { AnyApiFactory } from '../apis';
@@ -44,6 +45,14 @@ export class PluginImpl<
return this.config.apis ?? [];
}
+ getFeatureFlags(): Iterable {
+ const registeredFlags = this.output()
+ .filter(({ type }) => type === 'feature-flag')
+ .map(({ name }) => ({ name }));
+
+ return registeredFlags;
+ }
+
get routes(): Routes {
return this.config.routes ?? ({} as Routes);
}
@@ -56,11 +65,18 @@ export class PluginImpl<
if (this.storedOutput) {
return this.storedOutput;
}
- if (!this.config.register) {
- return [];
+ const outputs = new Array();
+ this.storedOutput = outputs;
+
+ if (this.config.featureFlags) {
+ for (const flag of this.config.featureFlags) {
+ outputs.push({ type: 'feature-flag', name: flag.name });
+ }
}
- const outputs = new Array();
+ if (!this.config.register) {
+ return outputs;
+ }
this.config.register({
featureFlags: {
@@ -70,7 +86,6 @@ export class PluginImpl<
},
});
- this.storedOutput = outputs;
return this.storedOutput;
}
diff --git a/packages/core-plugin-api/src/plugin/index.ts b/packages/core-plugin-api/src/plugin/index.ts
index d3272607ef..4f7609fd9c 100644
--- a/packages/core-plugin-api/src/plugin/index.ts
+++ b/packages/core-plugin-api/src/plugin/index.ts
@@ -25,4 +25,5 @@ export type {
PluginConfig,
PluginHooks,
PluginOutput,
+ PluginFeatureFlagConfig,
} from './types';
diff --git a/packages/core-plugin-api/src/plugin/types.ts b/packages/core-plugin-api/src/plugin/types.ts
index aeb7037c51..0f8d3404d8 100644
--- a/packages/core-plugin-api/src/plugin/types.ts
+++ b/packages/core-plugin-api/src/plugin/types.ts
@@ -19,7 +19,7 @@ import { AnyApiFactory } from '../apis/system';
/**
* Replace with using {@link RouteRef}s.
- *
+ * @deprecated will be removed
* @public
*/
export type FeatureFlagOutput = {
@@ -31,6 +31,7 @@ export type FeatureFlagOutput = {
* {@link FeatureFlagOutput} type.
*
* @public
+ * @deprecated Use {@link BackstagePlugin.getFeatureFlags} instead.
*/
export type PluginOutput = FeatureFlagOutput;
@@ -71,13 +72,30 @@ export type BackstagePlugin<
ExternalRoutes extends AnyExternalRoutes = {},
> = {
getId(): string;
+ /**
+ * @deprecated use getFeatureFlags instead.
+ * */
output(): PluginOutput[];
getApis(): Iterable;
+ /**
+ * Returns all registered feature flags for this plugin.
+ */
+ getFeatureFlags(): Iterable;
provide(extension: Extension): T;
routes: Routes;
externalRoutes: ExternalRoutes;
};
+/**
+ * Plugin feature flag configuration.
+ *
+ * @public
+ */
+export type PluginFeatureFlagConfig = {
+ /** Feature flag name */
+ name: string;
+};
+
/**
* Plugin descriptor type.
*
@@ -89,14 +107,17 @@ export type PluginConfig<
> = {
id: string;
apis?: Iterable;
+ /** @deprecated use featureFlags property instead for defining feature flags */
register?(hooks: PluginHooks): void;
routes?: Routes;
externalRoutes?: ExternalRoutes;
+ featureFlags?: PluginFeatureFlagConfig[];
};
/**
* Holds hooks registered by the plugin.
*
+ * @deprecated - feature flags are now registered in plugin config under featureFlags
* @public
*/
export type PluginHooks = {
diff --git a/packages/core-plugin-api/src/routing/RouteRef.ts b/packages/core-plugin-api/src/routing/RouteRef.ts
index a926b775e6..8bd3d604f6 100644
--- a/packages/core-plugin-api/src/routing/RouteRef.ts
+++ b/packages/core-plugin-api/src/routing/RouteRef.ts
@@ -23,7 +23,6 @@ import {
} from './types';
import { OldIconComponent } from '../icons/types';
-// TODO(Rugvip): Remove this in the next breaking release, it's exported but unused
/**
* @deprecated
* @internal
@@ -49,21 +48,45 @@ export class RouteRefImpl
private readonly id: string,
readonly params: ParamKeys,
private readonly config: {
+ /** @deprecated */
path?: string;
+ /** @deprecated */
icon?: OldIconComponent;
+ /** @deprecated */
title?: string;
},
- ) {}
+ ) {
+ if (config.path) {
+ // eslint-disable-next-line no-console
+ console.warn(
+ `DEPRECATION WARNING: Passing a path to createRouteRef is deprecated, please remove the path for ${this}.`,
+ );
+ }
+
+ if (config.icon) {
+ // eslint-disable-next-line no-console
+ console.warn(
+ `DEPRECATION WARNING: Passing an icon to createRouteRef is deprecated, please remove the icon for ${this}.`,
+ );
+ }
+
+ if (config.title) {
+ // eslint-disable-next-line no-console
+ console.warn(
+ `DEPRECATION WARNING: Passing a title to createRouteRef is deprecated, please remove the title for ${this}.`,
+ );
+ }
+ }
+
+ /** @deprecated use `useRouteRef` instead */
+ get path() {
+ return this.config.path ?? '';
+ }
get icon() {
return this.config.icon;
}
- // TODO(Rugvip): Remove this, routes are looked up via the registry instead
- get path() {
- return this.config.path ?? '';
- }
-
get title() {
return this.config.title ?? this.id;
}
diff --git a/packages/create-app/CHANGELOG.md b/packages/create-app/CHANGELOG.md
index 7e53d0cde5..cdcf7f4952 100644
--- a/packages/create-app/CHANGELOG.md
+++ b/packages/create-app/CHANGELOG.md
@@ -1,5 +1,168 @@
# @backstage/create-app
+## 0.4.7
+
+### Patch Changes
+
+- 9603827bb5: Addressed some peer dependency warnings
+- 1bada775a9: TechDocs Backend may now (optionally) leverage a cache store to improve
+ performance when reading content from a cloud storage provider.
+
+ To apply this change to an existing app, pass the cache manager from the plugin
+ environment to the `createRouter` function in your backend:
+
+ ```diff
+ // packages/backend/src/plugins/techdocs.ts
+
+ export default async function createPlugin({
+ logger,
+ config,
+ discovery,
+ reader,
+ + cache,
+ }: PluginEnvironment): Promise {
+
+ // ...
+
+ return await createRouter({
+ preparers,
+ generators,
+ publisher,
+ logger,
+ config,
+ discovery,
+ + cache,
+ });
+ ```
+
+ If your `PluginEnvironment` does not include a cache manager, be sure you've
+ applied [the cache management change][cm-change] to your backend as well.
+
+ [Additional configuration][td-rec-arch] is required if you wish to enable
+ caching in TechDocs.
+
+ [cm-change]: https://github.com/backstage/backstage/blob/master/packages/create-app/CHANGELOG.md#patch-changes-6
+ [td-rec-arch]: https://backstage.io/docs/features/techdocs/architecture#recommended-deployment
+
+- 4862fbc64f: Bump @spotify/prettier-config
+- 36bb4fb2e9: Removed the `scaffolder.github.visibility` configuration that is no longer used from the default app template.
+
+## 0.4.6
+
+### Patch Changes
+
+- 24d2ce03f3: Search Modal now relies on the Search Context to access state and state setter. If you use the SidebarSearchModal as described in the [getting started documentation](https://backstage.io/docs/features/search/getting-started#using-the-search-modal), make sure to update your code with the SearchContextProvider.
+
+ ```diff
+ export const Root = ({ children }: PropsWithChildren<{}>) => (
+
+
+
+ -
+ +
+ +
+ +
+
+ ...
+ ```
+
+- 905dd952ac: Incorporate usage of the tokenManager into the backend created using `create-app`.
+
+ In existing backends, update the `PluginEnvironment` to include a `tokenManager`:
+
+ ```diff
+ // packages/backend/src/types.ts
+
+ ...
+ import {
+ ...
+ + TokenManager,
+ } from '@backstage/backend-common';
+
+ export type PluginEnvironment = {
+ ...
+ + tokenManager: TokenManager;
+ };
+ ```
+
+ Then, create a `ServerTokenManager`. This can either be a `noop` that requires no secret and validates all requests by default, or one that uses a secret from your `app-config.yaml` to generate and validate tokens.
+
+ ```diff
+ // packages/backend/src/index.ts
+
+ ...
+ import {
+ ...
+ + ServerTokenManager,
+ } from '@backstage/backend-common';
+ ...
+
+ function makeCreateEnv(config: Config) {
+ ...
+ // CHOOSE ONE
+ // TokenManager not requiring a secret
+ + const tokenManager = ServerTokenManager.noop();
+ // OR TokenManager requiring a secret
+ + const tokenManager = ServerTokenManager.fromConfig(config);
+
+ ...
+ return (plugin: string): PluginEnvironment => {
+ ...
+ - return { logger, cache, database, config, reader, discovery };
+ + return { logger, cache, database, config, reader, discovery, tokenManager };
+ };
+ }
+ ```
+
+## 0.4.5
+
+### Patch Changes
+
+- dcaeaac174: Cleaned out the `peerDependencies` in the published version of the package, making it much quicker to run `npx @backstage/create-app` as it no longer needs to install a long list of unnecessary.
+- a5a5d7e1f1: DefaultTechDocsCollator is now included in the search backend, and the Search Page updated with the SearchType component that includes the techdocs type
+- bab752e2b3: Change default port of backend from 7000 to 7007.
+
+ This is due to the AirPlay Receiver process occupying port 7000 and preventing local Backstage instances on MacOS to start.
+
+ You can change the port back to 7000 or any other value by providing an `app-config.yaml` with the following values:
+
+ ```
+ backend:
+ listen: 0.0.0.0:7123
+ baseUrl: http://localhost:7123
+ ```
+
+ More information can be found here: https://backstage.io/docs/conf/writing
+
+- 42ebbc18c0: Bump gitbeaker to the latest version
+
+## 0.4.4
+
+### Patch Changes
+
+- 4ebc9fd277: Create backstage.json file
+
+ `@backstage/create-app` will create a new `backstage.json` file. At this point, the file will contain a `version` property, representing the version of `@backstage/create-app` used for creating the application. If the backstage's application has been bootstrapped using an older version of `@backstage/create-app`, the `backstage.json` file can be created and kept in sync, together with all the changes of the latest version of backstage, by running the following script:
+
+ ```bash
+ yarn backstage-cli versions:bump
+ ```
+
+- e21e3c6102: Bumping minimum requirements for `dockerode` and `testcontainers`
+- 014cbf8cb9: Migrated the app template use the new `@backstage/app-defaults` for the `createApp` import, since the `createApp` exported by `@backstage/app-core-api` will be removed in the future.
+
+ To migrate an existing application, add the latest version of `@backstage/app-defaults` as a dependency in `packages/app/package.json`, and make the following change to `packages/app/src/App.tsx`:
+
+ ```diff
+ -import { createApp, FlatRoutes } from '@backstage/core-app-api';
+ +import { createApp } from '@backstage/app-defaults';
+ +import { FlatRoutes } from '@backstage/core-app-api';
+ ```
+
+- 2163e83fa2: Refactor and add regression tests for create-app tasks
+- Updated dependencies
+ - @backstage/cli-common@0.1.6
+
## 0.4.3
### Patch Changes
diff --git a/packages/create-app/README.md b/packages/create-app/README.md
index 9f86cdb448..d5b5039d4e 100644
--- a/packages/create-app/README.md
+++ b/packages/create-app/README.md
@@ -22,4 +22,4 @@ yarn backstage-create-app
## Documentation
- [Backstage Readme](https://github.com/backstage/backstage/blob/master/README.md)
-- [Backstage Documentation](https://github.com/backstage/backstage/blob/master/docs/README.md)
+- [Backstage Documentation](https://backstage.io/docs/)
diff --git a/packages/create-app/package.json b/packages/create-app/package.json
index 7c1feec683..e5108f540b 100644
--- a/packages/create-app/package.json
+++ b/packages/create-app/package.json
@@ -1,7 +1,7 @@
{
"name": "@backstage/create-app",
"description": "A CLI that helps you create your own Backstage app",
- "version": "0.4.3",
+ "version": "0.4.7",
"private": false,
"publishConfig": {
"access": "public"
@@ -25,10 +25,12 @@
"lint": "backstage-cli lint",
"test": "backstage-cli test",
"clean": "backstage-cli clean",
+ "prepack": "node scripts/prepack.js",
+ "postpack": "node scripts/postpack.js",
"start": "nodemon --"
},
"dependencies": {
- "@backstage/cli-common": "^0.1.5",
+ "@backstage/cli-common": "^0.1.6",
"chalk": "^4.0.0",
"commander": "^6.1.0",
"fs-extra": "9.1.0",
@@ -39,7 +41,8 @@
},
"devDependencies": {
"@types/fs-extra": "^9.0.1",
- "@types/inquirer": "^7.3.1",
+ "@types/inquirer": "^8.1.3",
+ "@types/node": "^14.14.32",
"@types/recursive-readdir": "^2.2.0",
"mock-fs": "^5.1.1",
"ts-node": "^10.0.0"
diff --git a/packages/create-app/scripts/postpack.js b/packages/create-app/scripts/postpack.js
new file mode 100644
index 0000000000..f13db11e76
--- /dev/null
+++ b/packages/create-app/scripts/postpack.js
@@ -0,0 +1,37 @@
+#!/usr/bin/env node
+/*
+ * Copyright 2021 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.
+ */
+
+/* eslint-disable no-restricted-syntax */
+
+const fs = require('fs-extra');
+const path = require('path');
+
+async function main() {
+ const pkgPath = path.resolve(__dirname, '../package.json');
+ const pkgBackupPath = path.resolve(__dirname, '../package.json-prepack');
+
+ try {
+ await fs.move(pkgBackupPath, pkgPath, { overwrite: true });
+ } catch (err) {
+ console.error(`Failed to restore package.json during postpack, ${err}`);
+ }
+}
+
+main().catch(err => {
+ console.error(err.stack);
+ process.exit(1);
+});
diff --git a/packages/create-app/scripts/prepack.js b/packages/create-app/scripts/prepack.js
new file mode 100644
index 0000000000..2caf865280
--- /dev/null
+++ b/packages/create-app/scripts/prepack.js
@@ -0,0 +1,36 @@
+#!/usr/bin/env node
+/*
+ * Copyright 2021 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.
+ */
+
+/* eslint-disable no-restricted-syntax */
+
+const fs = require('fs-extra');
+const path = require('path');
+
+async function main() {
+ const pkgPath = path.resolve(__dirname, '../package.json');
+ const pkgBackupPath = path.resolve(__dirname, '../package.json-prepack');
+
+ const pkg = await fs.readJson(pkgPath);
+ await fs.writeJson(pkgBackupPath, pkg, { encoding: 'utf8', spaces: 2 });
+ delete pkg.peerDependencies;
+ await fs.writeJson(pkgPath, pkg, { encoding: 'utf8', spaces: 2 });
+}
+
+main().catch(err => {
+ console.error(err.stack);
+ process.exit(1);
+});
diff --git a/packages/create-app/src/createApp.test.ts b/packages/create-app/src/createApp.test.ts
index 09099e2d15..ee01e8fd42 100644
--- a/packages/create-app/src/createApp.test.ts
+++ b/packages/create-app/src/createApp.test.ts
@@ -59,7 +59,7 @@ describe('command entrypoint', () => {
test('should call expected tasks with no path option', async () => {
const cmd = {} as unknown as Command;
- await createApp(cmd);
+ await createApp(cmd, '1.0.0');
expect(checkAppExistsMock).toHaveBeenCalled();
expect(createTemporaryAppFolderMock).toHaveBeenCalled();
expect(templatingMock).toHaveBeenCalled();
@@ -69,7 +69,7 @@ describe('command entrypoint', () => {
it('should call expected tasks with path option', async () => {
const cmd = { path: 'myDirectory' } as unknown as Command;
- await createApp(cmd);
+ await createApp(cmd, '1.0.0');
expect(checkPathExistsMock).toHaveBeenCalled();
expect(templatingMock).toHaveBeenCalled();
expect(buildAppMock).toHaveBeenCalled();
@@ -77,7 +77,7 @@ describe('command entrypoint', () => {
it('should not call `buildAppTask` when `skipInstall` is supplied', async () => {
const cmd = { skipInstall: true } as unknown as Command;
- await createApp(cmd);
+ await createApp(cmd, '1.0.0');
expect(buildAppMock).not.toHaveBeenCalled();
});
});
diff --git a/packages/create-app/src/createApp.ts b/packages/create-app/src/createApp.ts
index 8823e6c858..ac42ed0ff3 100644
--- a/packages/create-app/src/createApp.ts
+++ b/packages/create-app/src/createApp.ts
@@ -30,7 +30,7 @@ import {
templatingTask,
} from './lib/tasks';
-export default async (cmd: Command): Promise => {
+export default async (cmd: Command, version: string): Promise => {
/* eslint-disable-next-line no-restricted-syntax */
const paths = findPaths(__dirname);
@@ -65,7 +65,7 @@ export default async (cmd: Command): Promise => {
const templateDir = paths.resolveOwn('templates/default-app');
const tempDir = resolvePath(os.tmpdir(), answers.name);
- // Use `--path` argument as applicaiton directory when specified, otherwise
+ // Use `--path` argument as application directory when specified, otherwise
// create a directory using `answers.name`
const appDir = cmd.path
? resolvePath(paths.targetDir, cmd.path)
@@ -82,7 +82,7 @@ export default async (cmd: Command): Promise => {
await checkPathExistsTask(appDir);
Task.section('Preparing files');
- await templatingTask(templateDir, cmd.path, answers);
+ await templatingTask(templateDir, cmd.path, answers, version);
} else {
// Template to temporary location, and then move files
@@ -93,7 +93,7 @@ export default async (cmd: Command): Promise => {
await createTemporaryAppFolderTask(tempDir);
Task.section('Preparing files');
- await templatingTask(templateDir, tempDir, answers);
+ await templatingTask(templateDir, tempDir, answers, version);
Task.section('Moving to final location');
await moveAppTask(tempDir, appDir, answers.name);
diff --git a/packages/create-app/src/index.ts b/packages/create-app/src/index.ts
index 1f37be56d2..8a2da2fad8 100644
--- a/packages/create-app/src/index.ts
+++ b/packages/create-app/src/index.ts
@@ -38,7 +38,7 @@ const main = (argv: string[]) => {
'--skip-install',
'Skip the install and builds steps after creating the app',
)
- .action(createApp);
+ .action(cmd => createApp(cmd, version));
program.parse(argv);
};
diff --git a/packages/create-app/src/lib/tasks.test.ts b/packages/create-app/src/lib/tasks.test.ts
index d69526cb49..24df97c694 100644
--- a/packages/create-app/src/lib/tasks.test.ts
+++ b/packages/create-app/src/lib/tasks.test.ts
@@ -195,9 +195,12 @@ describe('templatingTask', () => {
name: 'SuperCoolBackstageInstance',
dbTypeSqlite: true,
};
- await templatingTask(templateDir, destinationDir, context);
+ await templatingTask(templateDir, destinationDir, context, '1.0.0');
expect(fs.existsSync('templatedApp/package.json')).toBe(true);
expect(fs.existsSync('templatedApp/.dockerignore')).toBe(true);
+ await expect(fs.readJson('templatedApp/backstage.json')).resolves.toEqual({
+ version: '1.0.0',
+ });
// catalog was populated with `context.name`
expect(
fs.readFileSync('templatedApp/catalog-info.yaml', 'utf-8'),
diff --git a/packages/create-app/src/lib/tasks.ts b/packages/create-app/src/lib/tasks.ts
index 3961e84753..2793088892 100644
--- a/packages/create-app/src/lib/tasks.ts
+++ b/packages/create-app/src/lib/tasks.ts
@@ -14,6 +14,7 @@
* limitations under the License.
*/
+import { BACKSTAGE_JSON } from '@backstage/cli-common';
import chalk from 'chalk';
import fs from 'fs-extra';
import handlebars from 'handlebars';
@@ -22,6 +23,7 @@ import recursive from 'recursive-readdir';
import {
basename,
dirname,
+ join,
resolve as resolvePath,
relative as relativePath,
} from 'path';
@@ -84,6 +86,7 @@ export async function templatingTask(
templateDir: string,
destinationDir: string,
context: any,
+ version: string,
) {
const files = await recursive(templateDir).catch(error => {
throw new Error(`Failed to read template directory: ${error.message}`);
@@ -133,6 +136,12 @@ export async function templatingTask(
});
}
}
+ await Task.forItem('creating', BACKSTAGE_JSON, () =>
+ fs.writeFile(
+ join(destinationDir, BACKSTAGE_JSON),
+ `{\n "version": ${JSON.stringify(version)}\n}\n`,
+ ),
+ );
}
/**
diff --git a/packages/create-app/templates/default-app/app-config.production.yaml b/packages/create-app/templates/default-app/app-config.production.yaml
index 92f4574fd1..5e36c2319f 100644
--- a/packages/create-app/templates/default-app/app-config.production.yaml
+++ b/packages/create-app/templates/default-app/app-config.production.yaml
@@ -1,8 +1,8 @@
app:
# Should be the same as backend.baseUrl when using the `app-backend` plugin
- baseUrl: http://localhost:7000
+ baseUrl: http://localhost:7007
backend:
- baseUrl: http://localhost:7000
+ baseUrl: http://localhost:7007
listen:
- port: 7000
+ port: 7007
diff --git a/packages/create-app/templates/default-app/app-config.yaml.hbs b/packages/create-app/templates/default-app/app-config.yaml.hbs
index 9c35c58c33..c804b4b561 100644
--- a/packages/create-app/templates/default-app/app-config.yaml.hbs
+++ b/packages/create-app/templates/default-app/app-config.yaml.hbs
@@ -6,9 +6,14 @@ organization:
name: My Company
backend:
- baseUrl: http://localhost:7000
+ # Used for enabling authentication, secret is shared by all backend plugins
+ # See backend-to-backend-auth.md in the docs for information on the format
+ # auth:
+ # keys:
+ # - secret: ${BACKEND_SECRET}
+ baseUrl: http://localhost:7007
listen:
- port: 7000
+ port: 7007
csp:
connect-src: ["'self'", 'http:', 'https:']
# Content-Security-Policy directives follow the Helmet format: https://helmetjs.github.io/#reference
@@ -32,7 +37,9 @@ backend:
user: ${POSTGRES_USER}
password: ${POSTGRES_PASSWORD}
# https://node-postgres.com/features/ssl
- # ssl: require # see https://www.postgresql.org/docs/current/libpq-ssl.html Table 33.1. SSL Mode Descriptions (e.g. require)
+ # you can set the sslmode configuration option via the `PGSSLMODE` environment variable
+ # see https://www.postgresql.org/docs/current/libpq-ssl.html Table 33.1. SSL Mode Descriptions (e.g. require)
+ # ssl:
# ca: # if you have a CA file and want to verify it you can uncomment this section
# $file: /ca/server.crt
{{/if}}
@@ -70,9 +77,7 @@ auth:
providers: {}
scaffolder:
- github:
- token: ${GITHUB_TOKEN}
- visibility: public # or 'internal' or 'private'
+ # see https://backstage.io/docs/features/software-templates/configuration for software template options
catalog:
rules:
diff --git a/packages/create-app/templates/default-app/package.json.hbs b/packages/create-app/templates/default-app/package.json.hbs
index bdae71d9e3..a73045c050 100644
--- a/packages/create-app/templates/default-app/package.json.hbs
+++ b/packages/create-app/templates/default-app/package.json.hbs
@@ -31,14 +31,14 @@
},
"devDependencies": {
"@backstage/cli": "^{{version '@backstage/cli'}}",
- "@spotify/prettier-config": "^11.0.0",
+ "@spotify/prettier-config": "^12.0.0",
"concurrently": "^6.0.0",
"lerna": "^4.0.0",
"prettier": "^2.3.2"
},
"prettier": "@spotify/prettier-config",
"lint-staged": {
- "*.{js,jsx,ts,tsx}": [
+ "*.{js,jsx,ts,tsx,mjs,cjs}": [
"eslint --fix",
"prettier --write"
],
diff --git a/packages/create-app/templates/default-app/packages/app/package.json.hbs b/packages/create-app/templates/default-app/packages/app/package.json.hbs
index 9e15608a01..68848d2de9 100644
--- a/packages/create-app/templates/default-app/packages/app/package.json.hbs
+++ b/packages/create-app/templates/default-app/packages/app/package.json.hbs
@@ -22,7 +22,6 @@
"@backstage/plugin-tech-radar": "^{{version '@backstage/plugin-tech-radar'}}",
"@backstage/plugin-techdocs": "^{{version '@backstage/plugin-techdocs'}}",
"@backstage/plugin-user-settings": "^{{version '@backstage/plugin-user-settings'}}",
- "@backstage/test-utils": "^{{version '@backstage/test-utils'}}",
"@backstage/theme": "^{{version '@backstage/theme'}}",
"@material-ui/core": "^4.12.2",
"@material-ui/icons": "^4.9.1",
@@ -34,6 +33,7 @@
"react-use": "^15.3.3"
},
"devDependencies": {
+ "@backstage/test-utils": "^{{version '@backstage/test-utils'}}",
"@testing-library/jest-dom": "^5.10.1",
"@testing-library/react": "^10.4.1",
"@testing-library/user-event": "^12.0.7",
@@ -48,11 +48,11 @@
"scripts": {
"start": "backstage-cli app:serve",
"build": "backstage-cli app:build",
- "test": "backstage-cli test",
- "lint": "backstage-cli lint",
"clean": "backstage-cli clean",
+ "test": "backstage-cli test",
"test:e2e": "cross-env PORT=3001 start-server-and-test start http://localhost:3001 cy:dev",
"test:e2e:ci": "cross-env PORT=3001 start-server-and-test start http://localhost:3001 cy:run",
+ "lint": "backstage-cli lint",
"cy:dev": "cypress open",
"cy:run": "cypress run"
},
diff --git a/packages/create-app/templates/default-app/packages/app/src/App.test.tsx b/packages/create-app/templates/default-app/packages/app/src/App.test.tsx
index 82bc479858..b94cac73b3 100644
--- a/packages/create-app/templates/default-app/packages/app/src/App.test.tsx
+++ b/packages/create-app/templates/default-app/packages/app/src/App.test.tsx
@@ -10,9 +10,9 @@ describe('App', () => {
{
data: {
app: { title: 'Test' },
- backend: { baseUrl: 'http://localhost:7000' },
+ backend: { baseUrl: 'http://localhost:7007' },
techdocs: {
- storageUrl: 'http://localhost:7000/api/techdocs/static/docs',
+ storageUrl: 'http://localhost:7007/api/techdocs/static/docs',
},
},
context: 'test',
diff --git a/packages/create-app/templates/default-app/packages/app/src/components/Root/Root.tsx b/packages/create-app/templates/default-app/packages/app/src/components/Root/Root.tsx
index ec59b0b116..b4fa04f1fc 100644
--- a/packages/create-app/templates/default-app/packages/app/src/components/Root/Root.tsx
+++ b/packages/create-app/templates/default-app/packages/app/src/components/Root/Root.tsx
@@ -25,7 +25,10 @@ import LogoFull from './LogoFull';
import LogoIcon from './LogoIcon';
import { NavLink } from 'react-router-dom';
import { Settings as SidebarSettings } from '@backstage/plugin-user-settings';
-import { SidebarSearchModal } from '@backstage/plugin-search';
+import {
+ SidebarSearchModal,
+ SearchContextProvider,
+} from '@backstage/plugin-search';
import {
Sidebar,
SidebarPage,
@@ -74,7 +77,9 @@ export const Root = ({ children }: PropsWithChildren<{}>) => (
-
+
+
+
{/* Global nav, not org-specific */}
diff --git a/packages/create-app/templates/default-app/packages/app/src/components/search/SearchPage.tsx b/packages/create-app/templates/default-app/packages/app/src/components/search/SearchPage.tsx
index 7b3c2b29d4..50ffbadb76 100644
--- a/packages/create-app/templates/default-app/packages/app/src/components/search/SearchPage.tsx
+++ b/packages/create-app/templates/default-app/packages/app/src/components/search/SearchPage.tsx
@@ -2,10 +2,13 @@ import React from 'react';
import { makeStyles, Theme, Grid, List, Paper } from '@material-ui/core';
import { CatalogResultListItem } from '@backstage/plugin-catalog';
+import { DocsResultListItem } from '@backstage/plugin-techdocs';
+
import {
SearchBar,
SearchFilter,
SearchResult,
+ SearchType,
DefaultResultListItem,
} from '@backstage/plugin-search';
import { Content, Header, Page } from '@backstage/core-components';
@@ -39,6 +42,11 @@ const SearchPage = () => {
+
+