---
.changeset/many-carpets-beam.md | 14 ++++++++++++++
1 file changed, 14 insertions(+)
create mode 100644 .changeset/many-carpets-beam.md
diff --git a/.changeset/many-carpets-beam.md b/.changeset/many-carpets-beam.md
new file mode 100644
index 0000000000..e7817c638e
--- /dev/null
+++ b/.changeset/many-carpets-beam.md
@@ -0,0 +1,14 @@
+---
+'@backstage/plugin-bazaar': patch
+'@backstage/plugin-fossa': patch
+'@backstage/plugin-github-actions': patch
+'@backstage/plugin-home': patch
+'@backstage/plugin-jenkins': patch
+'@backstage/plugin-kubernetes': patch
+'@backstage/plugin-scaffolder': patch
+'@backstage/plugin-stack-overflow': patch
+'@backstage/plugin-tech-radar': patch
+'@backstage/plugin-xcmetrics': patch
+---
+
+ESLint rule to forbid in favor of MUI
From e16f80524299e2af2d8cf01a3aa19d21360b29a3 Mon Sep 17 00:00:00 2001
From: Carlos Esteban Lopez
Date: Thu, 15 Dec 2022 12:43:54 -0500
Subject: [PATCH 11/38] fix: Set eslint-plugin-react to existing version in
other packages
Signed-off-by: Carlos Esteban Lopez
---
yarn.lock | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/yarn.lock b/yarn.lock
index b64750defc..a549cab5a9 100644
--- a/yarn.lock
+++ b/yarn.lock
@@ -22071,7 +22071,7 @@ __metadata:
languageName: node
linkType: hard
-"eslint-plugin-react@npm:^7.28.0, eslint-plugin-react@npm:^7.31.11":
+"eslint-plugin-react@npm:^7.28.0":
version: 7.31.11
resolution: "eslint-plugin-react@npm:7.31.11"
dependencies:
From 2bdd1f92c15b224f119a10bd1d428e2b3168a9ee Mon Sep 17 00:00:00 2001
From: Carlos Esteban Lopez
Date: Tue, 3 Jan 2023 12:43:54 -0500
Subject: [PATCH 12/38] fix: Add paragraph prop for bottom margin
Signed-off-by: Carlos Esteban Lopez
---
.../src/layout/Breadcrumbs/Breadcrumbs.stories.tsx | 10 +++++-----
.../EntityBazaarInfoContent.tsx | 2 +-
.../HomePageBazaarInfoCard/HomePageBazaarInfoCard.tsx | 2 +-
plugins/fossa/src/components/FossaCard/FossaCard.tsx | 5 +++--
.../components/WorkflowRunsTable/WorkflowRunsTable.tsx | 8 ++++++--
.../home/src/homePageComponents/RandomJoke/Content.tsx | 6 +++---
.../src/components/BuildsPage/lib/CITable/CITable.tsx | 6 +++---
.../CustomResources/ArgoRollouts/StepsProgress.tsx | 4 ++--
.../ListTasksPage/columns/CreatedAtColumn.tsx | 4 +++-
.../ListTasksPage/columns/OwnerEntityColumn.tsx | 2 +-
.../src/home/StackOverflowQuestions/Content.tsx | 4 ++--
.../src/components/RadarLegend/RadarLegendRing.tsx | 4 +++-
plugins/tech-radar/src/components/RadarPage.tsx | 2 +-
.../src/components/BuildTimeline/BuildTimeline.tsx | 2 +-
14 files changed, 35 insertions(+), 26 deletions(-)
diff --git a/packages/core-components/src/layout/Breadcrumbs/Breadcrumbs.stories.tsx b/packages/core-components/src/layout/Breadcrumbs/Breadcrumbs.stories.tsx
index 00563be313..04363f2a4a 100644
--- a/packages/core-components/src/layout/Breadcrumbs/Breadcrumbs.stories.tsx
+++ b/packages/core-components/src/layout/Breadcrumbs/Breadcrumbs.stories.tsx
@@ -36,7 +36,7 @@ export default {
export const InHeader = () => (
Standard breadcrumbs
-
+
Underlined pages are links. This should show a hierarchical relationship.
@@ -61,14 +61,14 @@ export const OutsideOfHeader = () => {
const open = Boolean(anchorEl);
return (
-
+
It might be the case that you want to keep your breadcrumbs outside of
the header. In that case, they should be positioned above the title of
the page.
Standard breadcrumbs
-
+
Underlined pages are links. This should show a hierarchical
relationship.
@@ -82,7 +82,7 @@ export const OutsideOfHeader = () => {
Hidden breadcrumbs
-
+
Use this when you have more than three breadcrumbs. When user clicks on
ellipses, expand the breadcrumbs out.
@@ -96,7 +96,7 @@ export const OutsideOfHeader = () => {
Layered breadcrumbs
-
+
Use this when you want to show alternative breadcrumbs on the same
hierarchical level.
diff --git a/plugins/bazaar/src/components/EntityBazaarInfoContent/EntityBazaarInfoContent.tsx b/plugins/bazaar/src/components/EntityBazaarInfoContent/EntityBazaarInfoContent.tsx
index 9bb1bfae8f..e0a3a9b881 100644
--- a/plugins/bazaar/src/components/EntityBazaarInfoContent/EntityBazaarInfoContent.tsx
+++ b/plugins/bazaar/src/components/EntityBazaarInfoContent/EntityBazaarInfoContent.tsx
@@ -184,7 +184,7 @@ export const EntityBazaarInfoContent = ({
+
{bazaarProject?.title!}
}
diff --git a/plugins/bazaar/src/components/HomePageBazaarInfoCard/HomePageBazaarInfoCard.tsx b/plugins/bazaar/src/components/HomePageBazaarInfoCard/HomePageBazaarInfoCard.tsx
index 183fcd5f52..7c6491c8a5 100644
--- a/plugins/bazaar/src/components/HomePageBazaarInfoCard/HomePageBazaarInfoCard.tsx
+++ b/plugins/bazaar/src/components/HomePageBazaarInfoCard/HomePageBazaarInfoCard.tsx
@@ -257,7 +257,7 @@ export const HomePageBazaarInfoCard = ({
+
{bazaarProject.value?.title || initProject.title}
}
diff --git a/plugins/fossa/src/components/FossaCard/FossaCard.tsx b/plugins/fossa/src/components/FossaCard/FossaCard.tsx
index 28780d7b88..8aa3d18157 100644
--- a/plugins/fossa/src/components/FossaCard/FossaCard.tsx
+++ b/plugins/fossa/src/components/FossaCard/FossaCard.tsx
@@ -167,6 +167,7 @@ export const FossaCard = (props: { variant?: InfoCardVariants }) => {
>
0 || value.dependencyCount === 0
? classes.numberError
@@ -176,12 +177,12 @@ export const FossaCard = (props: { variant?: InfoCardVariants }) => {
{value.issueCount}
{value.dependencyCount > 0 && (
-
+
Number of issues
)}
{value.dependencyCount === 0 && (
-
+
No Dependencies.
Please check your FOSSA project settings.
diff --git a/plugins/github-actions/src/components/WorkflowRunsTable/WorkflowRunsTable.tsx b/plugins/github-actions/src/components/WorkflowRunsTable/WorkflowRunsTable.tsx
index 150619a799..f05a41e71b 100644
--- a/plugins/github-actions/src/components/WorkflowRunsTable/WorkflowRunsTable.tsx
+++ b/plugins/github-actions/src/components/WorkflowRunsTable/WorkflowRunsTable.tsx
@@ -68,8 +68,12 @@ const generatedColumns: TableColumn[] = [
title: 'Source',
render: (row: Partial) => (
- {row.source?.branchName}
- {row.source?.commit.hash}
+
+ {row.source?.branchName}
+
+
+ {row.source?.commit.hash}
+
),
},
diff --git a/plugins/home/src/homePageComponents/RandomJoke/Content.tsx b/plugins/home/src/homePageComponents/RandomJoke/Content.tsx
index 215a880024..80467c46fa 100644
--- a/plugins/home/src/homePageComponents/RandomJoke/Content.tsx
+++ b/plugins/home/src/homePageComponents/RandomJoke/Content.tsx
@@ -21,12 +21,12 @@ import { useRandomJoke } from './Context';
export const Content = () => {
const { joke, loading } = useRandomJoke();
- if (loading) return Loading... ;
+ if (loading) return Loading... ;
return (
- {joke.setup}
- {joke.punchline}
+ {joke.setup}
+ {joke.punchline}
);
};
diff --git a/plugins/jenkins/src/components/BuildsPage/lib/CITable/CITable.tsx b/plugins/jenkins/src/components/BuildsPage/lib/CITable/CITable.tsx
index a35b5b42c7..0217f00513 100644
--- a/plugins/jenkins/src/components/BuildsPage/lib/CITable/CITable.tsx
+++ b/plugins/jenkins/src/components/BuildsPage/lib/CITable/CITable.tsx
@@ -126,12 +126,12 @@ const generatedColumns: TableColumn[] = [
field: 'lastBuild.source.branchName',
render: (row: Partial) => (
<>
-
+
{row.lastBuild?.source?.branchName}
- {row.lastBuild?.source?.commit?.hash}
+ {row.lastBuild?.source?.commit?.hash}
>
),
},
@@ -152,7 +152,7 @@ const generatedColumns: TableColumn[] = [
render: (row: Partial) => {
return (
<>
-
+
{row.lastBuild?.tests && (
{row.lastBuild?.tests.passed} / {row.lastBuild?.tests.total}{' '}
diff --git a/plugins/kubernetes/src/components/CustomResources/ArgoRollouts/StepsProgress.tsx b/plugins/kubernetes/src/components/CustomResources/ArgoRollouts/StepsProgress.tsx
index fe4345fbbb..c93ab41d1d 100644
--- a/plugins/kubernetes/src/components/CustomResources/ArgoRollouts/StepsProgress.tsx
+++ b/plugins/kubernetes/src/components/CustomResources/ArgoRollouts/StepsProgress.tsx
@@ -50,9 +50,9 @@ const createLabelForStep = (step: ArgoRolloutCanaryStep): React.ReactNode => {
} else if (isAnalysisStep(step)) {
return (
-
analysis templates:
+
analysis templates:
{step.analysis.templates.map((t, i) => (
-
{`${t.templateName}${
+ {`${t.templateName}${
t.clusterScope ? ' (cluster scoped)' : ''
}`}
))}
diff --git a/plugins/scaffolder/src/components/ListTasksPage/columns/CreatedAtColumn.tsx b/plugins/scaffolder/src/components/ListTasksPage/columns/CreatedAtColumn.tsx
index 05d479eaf0..3b47287fd6 100644
--- a/plugins/scaffolder/src/components/ListTasksPage/columns/CreatedAtColumn.tsx
+++ b/plugins/scaffolder/src/components/ListTasksPage/columns/CreatedAtColumn.tsx
@@ -25,6 +25,8 @@ export const CreatedAtColumn = ({ createdAt }: { createdAt: string }) => {
.valueOf();
return (
- {humanizeDuration(formatted, { round: true })} ago
+
+ {humanizeDuration(formatted, { round: true })} ago
+
);
};
diff --git a/plugins/scaffolder/src/components/ListTasksPage/columns/OwnerEntityColumn.tsx b/plugins/scaffolder/src/components/ListTasksPage/columns/OwnerEntityColumn.tsx
index 375e8d44e9..b89141392c 100644
--- a/plugins/scaffolder/src/components/ListTasksPage/columns/OwnerEntityColumn.tsx
+++ b/plugins/scaffolder/src/components/ListTasksPage/columns/OwnerEntityColumn.tsx
@@ -31,7 +31,7 @@ export const OwnerEntityColumn = ({ entityRef }: { entityRef?: string }) => {
);
if (!entityRef) {
- return Unknown ;
+ return Unknown ;
}
if (loading || error) {
diff --git a/plugins/stack-overflow/src/home/StackOverflowQuestions/Content.tsx b/plugins/stack-overflow/src/home/StackOverflowQuestions/Content.tsx
index f277f8425e..8fce24bd22 100644
--- a/plugins/stack-overflow/src/home/StackOverflowQuestions/Content.tsx
+++ b/plugins/stack-overflow/src/home/StackOverflowQuestions/Content.tsx
@@ -52,11 +52,11 @@ export const Content = (props: StackOverflowQuestionsContentProps) => {
}, []);
if (loading) {
- return loading... ;
+ return loading... ;
}
if (error || !value || !value.length) {
- return could not load questions ;
+ return could not load questions ;
}
const getSecondaryText = (answer_count: Number) =>
diff --git a/plugins/tech-radar/src/components/RadarLegend/RadarLegendRing.tsx b/plugins/tech-radar/src/components/RadarLegend/RadarLegendRing.tsx
index 78232a3a88..09badecdcd 100644
--- a/plugins/tech-radar/src/components/RadarLegend/RadarLegendRing.tsx
+++ b/plugins/tech-radar/src/components/RadarLegend/RadarLegendRing.tsx
@@ -39,7 +39,9 @@ export const RadarLegendRing = ({
{ring.name}
{entries.length === 0 ? (
-
(empty)
+
+ (empty)
+
) : (
{entries.map(entry => (
diff --git a/plugins/tech-radar/src/components/RadarPage.tsx b/plugins/tech-radar/src/components/RadarPage.tsx
index 03f33f9e4c..802acef2a8 100644
--- a/plugins/tech-radar/src/components/RadarPage.tsx
+++ b/plugins/tech-radar/src/components/RadarPage.tsx
@@ -80,7 +80,7 @@ export function RadarPage(props: TechRadarPageProps) {
onChange={e => setSearchText(e.target.value)}
/>
-
+
This is used for visualizing the official guidelines of different
areas of software development such as languages, frameworks,
infrastructure and processes. You can find an explanation for the
diff --git a/plugins/xcmetrics/src/components/BuildTimeline/BuildTimeline.tsx b/plugins/xcmetrics/src/components/BuildTimeline/BuildTimeline.tsx
index 83c8288388..54d84ff6c6 100644
--- a/plugins/xcmetrics/src/components/BuildTimeline/BuildTimeline.tsx
+++ b/plugins/xcmetrics/src/components/BuildTimeline/BuildTimeline.tsx
@@ -92,7 +92,7 @@ export const BuildTimeline = ({
width,
}: BuildTimelineProps) => {
const theme = useTheme();
- if (!targets.length) return No Targets ;
+ if (!targets.length) return No Targets ;
const data = getTimelineData(targets);
From 391d03b1b4700452a055a0b0c2b972ef640fd29d Mon Sep 17 00:00:00 2001
From: Carlos Esteban Lopez
Date: Tue, 10 Jan 2023 16:27:57 -0500
Subject: [PATCH 13/38] chore: Update changeset to PR comment
Signed-off-by: Carlos Esteban Lopez
---
.changeset/many-carpets-beam.md | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/.changeset/many-carpets-beam.md b/.changeset/many-carpets-beam.md
index e7817c638e..454d404e83 100644
--- a/.changeset/many-carpets-beam.md
+++ b/.changeset/many-carpets-beam.md
@@ -11,4 +11,4 @@
'@backstage/plugin-xcmetrics': patch
---
-ESLint rule to forbid in favor of MUI
+Small updates to some paragraph components to ensure theme typography properties are inherited correctly.
From d5e43e4a09ac67c5b5a64ec8a12c1cf2dbf1ebb4 Mon Sep 17 00:00:00 2001
From: Jussi Hallila
Date: Wed, 11 Jan 2023 11:52:05 +0100
Subject: [PATCH 14/38] Make default repository impl protected Expose a
construction function instead.
Signed-off-by: Jussi Hallila
---
plugins/tech-insights-backend/api-report.md | 51 ++++---------------
plugins/tech-insights-backend/src/index.ts | 7 ++-
.../persistence/TechInsightsDatabase.ts | 2 +-
.../service/persistence/persistenceContext.ts | 7 ++-
4 files changed, 23 insertions(+), 44 deletions(-)
diff --git a/plugins/tech-insights-backend/api-report.md b/plugins/tech-insights-backend/api-report.md
index faca4a615c..7d1d7583ae 100644
--- a/plugins/tech-insights-backend/api-report.md
+++ b/plugins/tech-insights-backend/api-report.md
@@ -5,7 +5,6 @@
```ts
import { CheckResult } from '@backstage/plugin-tech-insights-common';
import { Config } from '@backstage/config';
-import { DateTime } from 'luxon';
import { Duration } from 'luxon';
import express from 'express';
import { FactChecker } from '@backstage/plugin-tech-insights-node';
@@ -14,16 +13,12 @@ import { FactLifecycle } from '@backstage/plugin-tech-insights-node';
import { FactRetriever } from '@backstage/plugin-tech-insights-node';
import { FactRetrieverRegistration } from '@backstage/plugin-tech-insights-node';
import { FactSchema } from '@backstage/plugin-tech-insights-node';
-import { FactSchemaDefinition } from '@backstage/plugin-tech-insights-node';
-import { FlatTechInsightFact } from '@backstage/plugin-tech-insights-node';
import { HumanDuration } from '@backstage/types';
-import { Knex } from 'knex';
import { Logger } from 'winston';
import { PluginDatabaseManager } from '@backstage/backend-common';
import { PluginEndpointDiscovery } from '@backstage/backend-common';
import { PluginTaskScheduler } from '@backstage/backend-tasks';
import { TechInsightCheck } from '@backstage/plugin-tech-insights-node';
-import { TechInsightFact } from '@backstage/plugin-tech-insights-node';
import { TechInsightsStore } from '@backstage/plugin-tech-insights-node';
import { TokenManager } from '@backstage/backend-common';
@@ -35,6 +30,11 @@ export const buildTechInsightsContext: <
options: TechInsightsOptions,
) => Promise>;
+// @public
+export type CreateDatabaseOptions = {
+ logger: Logger;
+};
+
// @public
export function createFactRetrieverRegistration(
options: FactRetrieverRegistrationOptions,
@@ -82,6 +82,12 @@ export interface FactRetrieverRegistry {
register(registration: FactRetrieverRegistration): Promise;
}
+// @public
+export const initializePersistenceContext: (
+ database: PluginDatabaseManager,
+ options?: CreateDatabaseOptions,
+) => Promise;
+
// @public
export type PersistenceContext = {
techInsightsStore: TechInsightsStore;
@@ -111,41 +117,6 @@ export type TechInsightsContext<
factRetrieverEngine: FactRetrieverEngine;
};
-// @public
-export class TechInsightsDatabase implements TechInsightsStore {
- constructor(db: Knex, logger: Logger);
- // (undocumented)
- getFactsBetweenTimestampsByIds(
- ids: string[],
- entityTriplet: string,
- startDateTime: DateTime,
- endDateTime: DateTime,
- ): Promise<{
- [factId: string]: FlatTechInsightFact[];
- }>;
- // (undocumented)
- getLatestFactsByIds(
- ids: string[],
- entityTriplet: string,
- ): Promise<{
- [factId: string]: FlatTechInsightFact;
- }>;
- // (undocumented)
- getLatestSchemas(ids?: string[]): Promise;
- // (undocumented)
- insertFacts({
- id,
- facts,
- lifecycle,
- }: {
- id: string;
- facts: TechInsightFact[];
- lifecycle?: FactLifecycle;
- }): Promise;
- // (undocumented)
- insertFactSchema(schemaDefinition: FactSchemaDefinition): Promise;
-}
-
// @public (undocumented)
export interface TechInsightsOptions<
CheckType extends TechInsightCheck,
diff --git a/plugins/tech-insights-backend/src/index.ts b/plugins/tech-insights-backend/src/index.ts
index 8106517a3f..2071acd263 100644
--- a/plugins/tech-insights-backend/src/index.ts
+++ b/plugins/tech-insights-backend/src/index.ts
@@ -18,13 +18,16 @@ export * from './service/router';
export type { RouterOptions } from './service/router';
export { buildTechInsightsContext } from './service/techInsightsContextBuilder';
+export { initializePersistenceContext } from './service/persistence/persistenceContext';
export type {
TechInsightsOptions,
TechInsightsContext,
} from './service/techInsightsContextBuilder';
export type { FactRetrieverEngine } from './service/fact/FactRetrieverEngine';
-export type { TechInsightsDatabase } from './service/persistence/TechInsightsDatabase';
-export type { PersistenceContext } from './service/persistence/persistenceContext';
+export type {
+ PersistenceContext,
+ CreateDatabaseOptions,
+} from './service/persistence/persistenceContext';
export { createFactRetrieverRegistration } from './service/fact/createFactRetriever';
export type { FactRetrieverRegistry } from './service/fact/FactRetrieverRegistry';
export type { FactRetrieverRegistrationOptions } from './service/fact/createFactRetriever';
diff --git a/plugins/tech-insights-backend/src/service/persistence/TechInsightsDatabase.ts b/plugins/tech-insights-backend/src/service/persistence/TechInsightsDatabase.ts
index 65db088431..0b14f80843 100644
--- a/plugins/tech-insights-backend/src/service/persistence/TechInsightsDatabase.ts
+++ b/plugins/tech-insights-backend/src/service/persistence/TechInsightsDatabase.ts
@@ -49,7 +49,7 @@ type RawDbFactSchemaRow = {
/**
* Default TechInsightsDatabase implementation.
*
- * @public
+ * @internal
*/
export class TechInsightsDatabase implements TechInsightsStore {
private readonly CHUNK_SIZE = 50;
diff --git a/plugins/tech-insights-backend/src/service/persistence/persistenceContext.ts b/plugins/tech-insights-backend/src/service/persistence/persistenceContext.ts
index 575ee67bdf..87efcd8a3d 100644
--- a/plugins/tech-insights-backend/src/service/persistence/persistenceContext.ts
+++ b/plugins/tech-insights-backend/src/service/persistence/persistenceContext.ts
@@ -36,6 +36,11 @@ export type PersistenceContext = {
techInsightsStore: TechInsightsStore;
};
+/**
+ * A Container for persistence context initialization options
+ *
+ * @public
+ */
export type CreateDatabaseOptions = {
logger: Logger;
};
@@ -45,7 +50,7 @@ const defaultOptions: CreateDatabaseOptions = {
};
/**
- * A factory method to construct persistence context for running implementation.
+ * A factory function to construct persistence context for running implementation.
*
* @public
*/
From e4a52374aed9cbd6fbe2795f2974118fd29aa084 Mon Sep 17 00:00:00 2001
From: Dominik Pfaffenbauer
Date: Wed, 11 Jan 2023 12:12:15 +0100
Subject: [PATCH 15/38] Sentry Scaffolder rename action, make slug optional and
change package version to 0.0.0
Signed-off-by: Dominik Pfaffenbauer
---
plugins/scaffolder-backend-module-sentry/package.json | 2 +-
.../src/actions/createProject.ts | 4 ++--
2 files changed, 3 insertions(+), 3 deletions(-)
diff --git a/plugins/scaffolder-backend-module-sentry/package.json b/plugins/scaffolder-backend-module-sentry/package.json
index 8eaf5c398d..56af667c1b 100644
--- a/plugins/scaffolder-backend-module-sentry/package.json
+++ b/plugins/scaffolder-backend-module-sentry/package.json
@@ -1,6 +1,6 @@
{
"name": "@backstage/plugin-scaffolder-backend-module-sentry",
- "version": "0.1.0",
+ "version": "0.0.0",
"main": "src/index.ts",
"types": "src/index.ts",
"license": "Apache-2.0",
diff --git a/plugins/scaffolder-backend-module-sentry/src/actions/createProject.ts b/plugins/scaffolder-backend-module-sentry/src/actions/createProject.ts
index a3457ae159..bfcc8f016b 100644
--- a/plugins/scaffolder-backend-module-sentry/src/actions/createProject.ts
+++ b/plugins/scaffolder-backend-module-sentry/src/actions/createProject.ts
@@ -35,10 +35,10 @@ export function createSentryCreateProjectAction(options: { config: Config }) {
organizationSlug: string;
teamSlug: string;
name: string;
- slug: string;
+ slug?: string;
authToken?: string;
}>({
- id: 'sentry:create-project',
+ id: 'sentry:project:create',
schema: {
input: {
required: ['organizationSlug', 'teamSlug', 'name'],
From 6e2248abbe8e3080ad694e92b760320f75269b8f Mon Sep 17 00:00:00 2001
From: Patrik Oldsberg
Date: Wed, 11 Jan 2023 12:05:20 +0100
Subject: [PATCH 16/38] backend-common: added compatibility wrapper for legacy
plugins
Co-authored-by: Johan Haals
Signed-off-by: Patrik Oldsberg
---
packages/backend-common/api-report.md | 53 +++++++++++
packages/backend-common/src/compat.ts | 123 ++++++++++++++++++++++++++
packages/backend-common/src/index.ts | 2 +
3 files changed, 178 insertions(+)
create mode 100644 packages/backend-common/src/compat.ts
diff --git a/packages/backend-common/api-report.md b/packages/backend-common/api-report.md
index 915049366c..a97f8b31d8 100644
--- a/packages/backend-common/api-report.md
+++ b/packages/backend-common/api-report.md
@@ -9,6 +9,7 @@
import aws from 'aws-sdk';
import { AwsS3Integration } from '@backstage/integration';
import { AzureIntegration } from '@backstage/integration';
+import { BackendFeature } from '@backstage/backend-plugin-api';
import { BitbucketCloudIntegration } from '@backstage/integration';
import { BitbucketIntegration } from '@backstage/integration';
import { BitbucketServerIntegration } from '@backstage/integration';
@@ -16,6 +17,7 @@ import { CacheClient } from '@backstage/backend-plugin-api';
import { CacheClientOptions } from '@backstage/backend-plugin-api';
import { CacheClientSetOptions } from '@backstage/backend-plugin-api';
import { Config } from '@backstage/config';
+import { ConfigService } from '@backstage/backend-plugin-api';
import cors from 'cors';
import Docker from 'dockerode';
import { Duration } from 'luxon';
@@ -26,6 +28,7 @@ import { GiteaIntegration } from '@backstage/integration';
import { GithubCredentialsProvider } from '@backstage/integration';
import { GithubIntegration } from '@backstage/integration';
import { GitLabIntegration } from '@backstage/integration';
+import { IdentityService } from '@backstage/backend-plugin-api';
import { isChildPath } from '@backstage/cli-common';
import { Knex } from 'knex';
import { KubeConfig } from '@kubernetes/client-node';
@@ -33,6 +36,7 @@ import { LoadConfigOptionsRemote } from '@backstage/config-loader';
import { Logger } from 'winston';
import { LoggerService } from '@backstage/backend-plugin-api';
import { MergeResult } from 'isomorphic-git';
+import { PermissionsService } from '@backstage/backend-plugin-api';
import { CacheService as PluginCacheManager } from '@backstage/backend-plugin-api';
import { DatabaseService as PluginDatabaseManager } from '@backstage/backend-plugin-api';
import { DiscoveryService as PluginEndpointDiscovery } from '@backstage/backend-plugin-api';
@@ -47,10 +51,12 @@ import { ReadUrlOptions } from '@backstage/backend-plugin-api';
import { ReadUrlResponse } from '@backstage/backend-plugin-api';
import { RequestHandler } from 'express';
import { Router } from 'express';
+import { SchedulerService } from '@backstage/backend-plugin-api';
import { SearchOptions } from '@backstage/backend-plugin-api';
import { SearchResponse } from '@backstage/backend-plugin-api';
import { SearchResponseFile } from '@backstage/backend-plugin-api';
import { Server } from 'http';
+import { ServiceRef } from '@backstage/backend-plugin-api';
import { TokenManagerService as TokenManager } from '@backstage/backend-plugin-api';
import { TransportStreamOptions } from 'winston-transport';
import { UrlReaderService as UrlReader } from '@backstage/backend-plugin-api';
@@ -228,6 +234,32 @@ export function createDatabaseClient(
overrides?: Partial,
): Knex;
+// @public
+export const createPluginCompat: (
+ name: string,
+ createRouterImport: Promise<{
+ default: LegacyCreateRouter<
+ TransformedEnv<
+ {
+ cache: PluginCacheManager;
+ config: ConfigService;
+ database: PluginDatabaseManager;
+ discovery: PluginEndpointDiscovery;
+ logger: LoggerService;
+ permissions: PermissionsService;
+ scheduler: SchedulerService;
+ tokenManager: TokenManager;
+ reader: UrlReader;
+ identity: IdentityService;
+ },
+ {
+ logger: (log: LoggerService) => Logger;
+ }
+ >
+ >;
+ }>,
+) => BackendFeature;
+
// @public
export function createRootLogger(
options?: winston.LoggerOptions,
@@ -500,6 +532,9 @@ export type KubernetesContainerRunnerOptions = {
timeoutMs?: number;
};
+// @public (undocumented)
+export type LegacyCreateRouter = (deps: TEnv) => Promise;
+
// @public
export function loadBackendConfig(options: {
logger: LoggerService;
@@ -513,6 +548,24 @@ export function loggerToWinstonLogger(
opts?: TransportStreamOptions,
): Logger;
+// @public
+export function makePluginCompat<
+ TEnv extends Record,
+ TEnvTransforms extends {
+ [key in keyof TEnv]?: (dep: TEnv[key]) => unknown;
+ },
+>(
+ envMapping: {
+ [key in keyof TEnv]: ServiceRef;
+ },
+ envTransforms: TEnvTransforms,
+): (
+ name: string,
+ createRouterImport: Promise<{
+ default: LegacyCreateRouter>;
+ }>,
+) => BackendFeature;
+
// @public
export function notFoundHandler(): RequestHandler;
diff --git a/packages/backend-common/src/compat.ts b/packages/backend-common/src/compat.ts
new file mode 100644
index 0000000000..16fe48dcb7
--- /dev/null
+++ b/packages/backend-common/src/compat.ts
@@ -0,0 +1,123 @@
+/*
+ * 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.
+ */
+
+import {
+ coreServices,
+ createBackendPlugin,
+ ServiceRef,
+} from '@backstage/backend-plugin-api';
+import { RequestHandler } from 'express';
+import { loggerToWinstonLogger } from './logging';
+
+/**
+ * @public
+ */
+export type LegacyCreateRouter = (deps: TEnv) => Promise;
+
+/** @ignore */
+type TransformedEnv<
+ TEnv extends Record,
+ TEnvTransforms extends { [key in keyof TEnv]?: (dep: TEnv[key]) => unknown },
+> = {
+ [key in keyof TEnv]: TEnvTransforms[key] extends (dep: TEnv[key]) => infer R
+ ? R
+ : TEnv[key];
+};
+
+/**
+ * Creates a new custom plugin compatibility wrapper.
+ *
+ * @public
+ * @remarks
+ *
+ * Usually you can use {@link createPluginCompat} directly instead, but you might
+ * need to use this if you have customized the plugin environment in your backend.
+ */
+export function makePluginCompat<
+ TEnv extends Record,
+ TEnvTransforms extends { [key in keyof TEnv]?: (dep: TEnv[key]) => unknown },
+>(
+ envMapping: { [key in keyof TEnv]: ServiceRef },
+ envTransforms: TEnvTransforms,
+) {
+ return (
+ name: string,
+ createRouterImport: Promise<{
+ default: LegacyCreateRouter>;
+ }>,
+ ) => {
+ const compatPlugin = createBackendPlugin({
+ id: name,
+ register(env) {
+ env.registerInit({
+ deps: { ...envMapping, _router: coreServices.httpRouter },
+ async init({ _router, ...envDeps }) {
+ const { default: createRouter } = await createRouterImport;
+ const pluginEnv = Object.fromEntries(
+ Object.entries(envDeps).map(([key, dep]) => {
+ const transform = envTransforms[key];
+ if (transform) {
+ return [key, transform(dep)];
+ }
+ return [key, dep];
+ }),
+ );
+ const router = await createRouter(
+ pluginEnv as TransformedEnv,
+ );
+ _router.use(router);
+ },
+ });
+ },
+ });
+
+ return compatPlugin();
+ };
+}
+
+/**
+ * Helper function to create a plugin from a legacy createRouter function and
+ * register it with the http router based on the plugin id.
+ *
+ * @public
+ * @remarks
+ *
+ * This is intended to be used by plugin authors to ease the transition to the
+ * new backend system.
+ *
+ * @example
+ *
+ *```ts
+ *backend.add(createPluginCompat('kafka', import('./plugins/kafka')));
+ *```
+ */
+export const createPluginCompat = makePluginCompat(
+ {
+ cache: coreServices.cache,
+ config: coreServices.config,
+ database: coreServices.database,
+ discovery: coreServices.discovery,
+ logger: coreServices.logger,
+ permissions: coreServices.permissions,
+ scheduler: coreServices.scheduler,
+ tokenManager: coreServices.tokenManager,
+ reader: coreServices.urlReader,
+ identity: coreServices.identity,
+ },
+ {
+ logger: log => loggerToWinstonLogger(log),
+ },
+);
diff --git a/packages/backend-common/src/index.ts b/packages/backend-common/src/index.ts
index 238e58b2a8..178a064cb9 100644
--- a/packages/backend-common/src/index.ts
+++ b/packages/backend-common/src/index.ts
@@ -20,6 +20,8 @@
* @packageDocumentation
*/
+export { makePluginCompat, createPluginCompat } from './compat';
+export type { LegacyCreateRouter } from './compat';
export * from './cache';
export { loadBackendConfig } from './config';
export * from './context';
From cdabd4eefb35c303da00232dd120df0c813965aa Mon Sep 17 00:00:00 2001
From: Patrik Oldsberg
Date: Wed, 11 Jan 2023 13:09:56 +0100
Subject: [PATCH 17/38] backend-common: rename createPluginCompat ->
legacyPlugin
Signed-off-by: Patrik Oldsberg
---
packages/backend-common/api-report.md | 54 +++++++++----------
packages/backend-common/src/index.ts | 4 +-
.../src/{compat.ts => legacy.ts} | 8 +--
3 files changed, 33 insertions(+), 33 deletions(-)
rename packages/backend-common/src/{compat.ts => legacy.ts} (93%)
diff --git a/packages/backend-common/api-report.md b/packages/backend-common/api-report.md
index a97f8b31d8..b03d6ec866 100644
--- a/packages/backend-common/api-report.md
+++ b/packages/backend-common/api-report.md
@@ -234,32 +234,6 @@ export function createDatabaseClient(
overrides?: Partial,
): Knex;
-// @public
-export const createPluginCompat: (
- name: string,
- createRouterImport: Promise<{
- default: LegacyCreateRouter<
- TransformedEnv<
- {
- cache: PluginCacheManager;
- config: ConfigService;
- database: PluginDatabaseManager;
- discovery: PluginEndpointDiscovery;
- logger: LoggerService;
- permissions: PermissionsService;
- scheduler: SchedulerService;
- tokenManager: TokenManager;
- reader: UrlReader;
- identity: IdentityService;
- },
- {
- logger: (log: LoggerService) => Logger;
- }
- >
- >;
- }>,
-) => BackendFeature;
-
// @public
export function createRootLogger(
options?: winston.LoggerOptions,
@@ -535,6 +509,32 @@ export type KubernetesContainerRunnerOptions = {
// @public (undocumented)
export type LegacyCreateRouter = (deps: TEnv) => Promise;
+// @public
+export const legacyPlugin: (
+ name: string,
+ createRouterImport: Promise<{
+ default: LegacyCreateRouter<
+ TransformedEnv<
+ {
+ cache: PluginCacheManager;
+ config: ConfigService;
+ database: PluginDatabaseManager;
+ discovery: PluginEndpointDiscovery;
+ logger: LoggerService;
+ permissions: PermissionsService;
+ scheduler: SchedulerService;
+ tokenManager: TokenManager;
+ reader: UrlReader;
+ identity: IdentityService;
+ },
+ {
+ logger: (log: LoggerService) => Logger;
+ }
+ >
+ >;
+ }>,
+) => BackendFeature;
+
// @public
export function loadBackendConfig(options: {
logger: LoggerService;
@@ -549,7 +549,7 @@ export function loggerToWinstonLogger(
): Logger;
// @public
-export function makePluginCompat<
+export function makeLegacyPlugin<
TEnv extends Record,
TEnvTransforms extends {
[key in keyof TEnv]?: (dep: TEnv[key]) => unknown;
diff --git a/packages/backend-common/src/index.ts b/packages/backend-common/src/index.ts
index 178a064cb9..46639a1923 100644
--- a/packages/backend-common/src/index.ts
+++ b/packages/backend-common/src/index.ts
@@ -20,8 +20,8 @@
* @packageDocumentation
*/
-export { makePluginCompat, createPluginCompat } from './compat';
-export type { LegacyCreateRouter } from './compat';
+export { legacyPlugin, makeLegacyPlugin } from './legacy';
+export type { LegacyCreateRouter } from './legacy';
export * from './cache';
export { loadBackendConfig } from './config';
export * from './context';
diff --git a/packages/backend-common/src/compat.ts b/packages/backend-common/src/legacy.ts
similarity index 93%
rename from packages/backend-common/src/compat.ts
rename to packages/backend-common/src/legacy.ts
index 16fe48dcb7..30e7dd9dc5 100644
--- a/packages/backend-common/src/compat.ts
+++ b/packages/backend-common/src/legacy.ts
@@ -43,10 +43,10 @@ type TransformedEnv<
* @public
* @remarks
*
- * Usually you can use {@link createPluginCompat} directly instead, but you might
+ * Usually you can use {@link legacyPlugin} directly instead, but you might
* need to use this if you have customized the plugin environment in your backend.
*/
-export function makePluginCompat<
+export function makeLegacyPlugin<
TEnv extends Record,
TEnvTransforms extends { [key in keyof TEnv]?: (dep: TEnv[key]) => unknown },
>(
@@ -101,10 +101,10 @@ export function makePluginCompat<
* @example
*
*```ts
- *backend.add(createPluginCompat('kafka', import('./plugins/kafka')));
+ *backend.add(legacyPlugin('kafka', import('./plugins/kafka')));
*```
*/
-export const createPluginCompat = makePluginCompat(
+export const legacyPlugin = makeLegacyPlugin(
{
cache: coreServices.cache,
config: coreServices.config,
From 31e2309c8cfe15d2c79c8800242fac901a17ebda Mon Sep 17 00:00:00 2001
From: Patrik Oldsberg
Date: Wed, 11 Jan 2023 13:24:39 +0100
Subject: [PATCH 18/38] changesets: added changeset for legacyPlugin wrapper
Signed-off-by: Patrik Oldsberg
---
.changeset/famous-books-matter.md | 5 +++++
1 file changed, 5 insertions(+)
create mode 100644 .changeset/famous-books-matter.md
diff --git a/.changeset/famous-books-matter.md b/.changeset/famous-books-matter.md
new file mode 100644
index 0000000000..550bfecf0b
--- /dev/null
+++ b/.changeset/famous-books-matter.md
@@ -0,0 +1,5 @@
+---
+'@backstage/backend-common': patch
+---
+
+Added `legacyPlugin` and the lower level `makeLegacyPlugin` wrappers that convert legacy plugins to the new backend system. This will be used to ease the future migration to the new backend system, but we discourage use of it for now.
From 1ad0f007444813bbc323c7f4c145dc9a6a205a66 Mon Sep 17 00:00:00 2001
From: Dominik Pfaffenbauer
Date: Wed, 11 Jan 2023 13:56:51 +0100
Subject: [PATCH 19/38] update api-report for sentry scaffolder
Signed-off-by: Dominik Pfaffenbauer
---
plugins/scaffolder-backend-module-sentry/api-report.md | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/plugins/scaffolder-backend-module-sentry/api-report.md b/plugins/scaffolder-backend-module-sentry/api-report.md
index a72e8a1524..8b0c229e03 100644
--- a/plugins/scaffolder-backend-module-sentry/api-report.md
+++ b/plugins/scaffolder-backend-module-sentry/api-report.md
@@ -13,7 +13,7 @@ export function createSentryCreateProjectAction(options: {
organizationSlug: string;
teamSlug: string;
name: string;
- slug: string;
+ slug?: string | undefined;
authToken?: string | undefined;
}>;
From bdd4b973e8ca12a46ba3e72b108db12fe0cf31e7 Mon Sep 17 00:00:00 2001
From: blam
Date: Tue, 3 Jan 2023 15:27:02 +0100
Subject: [PATCH 20/38] chore: provide all core services to the `TestBackend`
Signed-off-by: blam
Signed-off-by: blam
---
.../src/next/implementations/index.ts | 16 ++++++++
.../mockTokenManagerService.ts | 37 +++++++++++++++++++
.../src/next/wiring/TestBackend.test.ts | 37 +++++++++++++++++++
.../src/next/wiring/TestBackend.ts | 22 ++++++++++-
4 files changed, 110 insertions(+), 2 deletions(-)
create mode 100644 packages/backend-test-utils/src/next/implementations/index.ts
create mode 100644 packages/backend-test-utils/src/next/implementations/mockTokenManagerService.ts
diff --git a/packages/backend-test-utils/src/next/implementations/index.ts b/packages/backend-test-utils/src/next/implementations/index.ts
new file mode 100644
index 0000000000..073e47f5e4
--- /dev/null
+++ b/packages/backend-test-utils/src/next/implementations/index.ts
@@ -0,0 +1,16 @@
+/*
+ * 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 { mockTokenManagerFactory } from './mockTokenManagerService';
diff --git a/packages/backend-test-utils/src/next/implementations/mockTokenManagerService.ts b/packages/backend-test-utils/src/next/implementations/mockTokenManagerService.ts
new file mode 100644
index 0000000000..f68e910e0c
--- /dev/null
+++ b/packages/backend-test-utils/src/next/implementations/mockTokenManagerService.ts
@@ -0,0 +1,37 @@
+/*
+ * 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.
+ */
+import { TokenManager } from '@backstage/backend-common';
+import {
+ coreServices,
+ createServiceFactory,
+} from '@backstage/backend-plugin-api';
+
+class TokenManagerMock implements TokenManager {
+ async getToken(): Promise<{ token: string }> {
+ return { token: 'mock-token' };
+ }
+ async authenticate(): Promise {}
+}
+
+export const mockTokenManagerFactory = createServiceFactory({
+ service: coreServices.tokenManager,
+ deps: {},
+ async factory() {
+ return async () => {
+ return new TokenManagerMock();
+ };
+ },
+});
diff --git a/packages/backend-test-utils/src/next/wiring/TestBackend.test.ts b/packages/backend-test-utils/src/next/wiring/TestBackend.test.ts
index 5ea37e9106..9d71005e18 100644
--- a/packages/backend-test-utils/src/next/wiring/TestBackend.test.ts
+++ b/packages/backend-test-utils/src/next/wiring/TestBackend.test.ts
@@ -20,7 +20,9 @@ import {
createServiceFactory,
createServiceRef,
coreServices,
+ createBackendPlugin,
} from '@backstage/backend-plugin-api';
+
import { startTestBackend } from './TestBackend';
// This bit makes sure that test backends are cleaned up properly
@@ -156,4 +158,39 @@ describe('TestBackend', () => {
await backend.stop();
expect(shutdownSpy).toHaveBeenCalled();
});
+
+ it('should provide a set of default services', async () => {
+ expect.assertions(2);
+
+ const testPlugin = createBackendPlugin({
+ id: 'test',
+ register(env) {
+ env.registerInit({
+ deps: {
+ cache: coreServices.cache,
+ config: coreServices.config,
+ database: coreServices.database,
+ discovery: coreServices.discovery,
+ lifecycle: coreServices.lifecycle,
+ logger: coreServices.logger,
+ permissions: coreServices.permissions,
+ rootLifecycle: coreServices.rootLifecycle,
+ rootLogger: coreServices.rootLogger,
+ scheduler: coreServices.scheduler,
+ tokenManager: coreServices.tokenManager,
+ urlReader: coreServices.urlReader,
+ },
+ async init(deps) {
+ expect(Object.keys(deps)).toHaveLength(12);
+ expect(Object.values(deps)).not.toContain(undefined);
+ },
+ });
+ },
+ });
+
+ await startTestBackend({
+ services: [],
+ features: [testPlugin()],
+ }).then(backend => backend.stop());
+ });
});
diff --git a/packages/backend-test-utils/src/next/wiring/TestBackend.ts b/packages/backend-test-utils/src/next/wiring/TestBackend.ts
index 0295332855..7b78ad3d95 100644
--- a/packages/backend-test-utils/src/next/wiring/TestBackend.ts
+++ b/packages/backend-test-utils/src/next/wiring/TestBackend.ts
@@ -21,7 +21,15 @@ import {
rootLifecycleFactory,
loggerFactory,
rootLoggerFactory,
+ configFactory,
+ discoveryFactory,
+ cacheFactory,
+ databaseFactory,
+ permissionsFactory,
+ schedulerFactory,
+ urlReaderFactory,
} from '@backstage/backend-app-api';
+
import {
ServiceFactory,
ServiceRef,
@@ -30,6 +38,8 @@ import {
ExtensionPoint,
} from '@backstage/backend-plugin-api';
+import { mockTokenManagerFactory } from '../implementations';
+
/** @alpha */
export interface TestBackendOptions<
TServices extends any[],
@@ -55,10 +65,18 @@ export interface TestBackendOptions<
}
const defaultServiceFactories = [
- rootLoggerFactory(),
- loggerFactory(),
+ cacheFactory(),
+ configFactory(),
+ databaseFactory(),
+ discoveryFactory(),
lifecycleFactory(),
+ loggerFactory(),
+ permissionsFactory(),
rootLifecycleFactory(),
+ rootLoggerFactory(),
+ schedulerFactory(),
+ mockTokenManagerFactory(),
+ urlReaderFactory(),
];
const backendInstancesToCleanUp = new Array();
From beed5864d0d94fb7660459ec3b6d70d9e5fee692 Mon Sep 17 00:00:00 2001
From: blam
Date: Tue, 3 Jan 2023 17:02:35 +0100
Subject: [PATCH 21/38] chore: added some more mock defintions and refactoring
the `TaskManager.forPlugin`
Signed-off-by: blam
---
.../scheduler/schedulerFactory.ts | 10 +++-
.../backend-tasks/src/tasks/TaskScheduler.ts | 23 ++++++----
.../src/next/implementations/index.ts | 3 ++
.../next/implementations/mockConfigService.ts | 30 ++++++++++++
.../implementations/mockDatabaseService.ts | 46 +++++++++++++++++++
.../implementations/mockDiscoveryService.ts | 40 ++++++++++++++++
.../src/next/wiring/TestBackend.ts | 16 ++++---
7 files changed, 151 insertions(+), 17 deletions(-)
create mode 100644 packages/backend-test-utils/src/next/implementations/mockConfigService.ts
create mode 100644 packages/backend-test-utils/src/next/implementations/mockDatabaseService.ts
create mode 100644 packages/backend-test-utils/src/next/implementations/mockDiscoveryService.ts
diff --git a/packages/backend-app-api/src/services/implementations/scheduler/schedulerFactory.ts b/packages/backend-app-api/src/services/implementations/scheduler/schedulerFactory.ts
index a6edec868a..692f05f6d7 100644
--- a/packages/backend-app-api/src/services/implementations/scheduler/schedulerFactory.ts
+++ b/packages/backend-app-api/src/services/implementations/scheduler/schedulerFactory.ts
@@ -17,6 +17,7 @@
import {
coreServices,
createServiceFactory,
+ loggerToWinstonLogger,
} from '@backstage/backend-plugin-api';
import { TaskScheduler } from '@backstage/backend-tasks';
@@ -26,11 +27,16 @@ export const schedulerFactory = createServiceFactory({
deps: {
config: coreServices.config,
plugin: coreServices.pluginMetadata,
+ databaseManager: coreServices.database,
+ logger: coreServices.logger,
},
async factory({ config }) {
const taskScheduler = TaskScheduler.fromConfig(config);
- return async ({ plugin }) => {
- return taskScheduler.forPlugin(plugin.getId());
+ return async ({ plugin, databaseManager, logger }) => {
+ return taskScheduler.forPlugin(plugin.getId(), {
+ databaseManager,
+ logger: loggerToWinstonLogger(logger),
+ });
};
},
});
diff --git a/packages/backend-tasks/src/tasks/TaskScheduler.ts b/packages/backend-tasks/src/tasks/TaskScheduler.ts
index f14fb9fc2b..f35669d76e 100644
--- a/packages/backend-tasks/src/tasks/TaskScheduler.ts
+++ b/packages/backend-tasks/src/tasks/TaskScheduler.ts
@@ -14,7 +14,11 @@
* limitations under the License.
*/
-import { DatabaseManager, getRootLogger } from '@backstage/backend-common';
+import {
+ DatabaseManager,
+ getRootLogger,
+ PluginDatabaseManager,
+} from '@backstage/backend-common';
import { Config } from '@backstage/config';
import { once } from 'lodash';
import { Duration } from 'luxon';
@@ -56,9 +60,15 @@ export class TaskScheduler {
* @param pluginId - The unique ID of the plugin, for example "catalog"
* @returns A {@link PluginTaskScheduler} instance
*/
- forPlugin(pluginId: string): PluginTaskScheduler {
+ forPlugin(
+ pluginId: string,
+ options?: { databaseManager?: PluginDatabaseManager; logger?: Logger },
+ ): PluginTaskScheduler {
+ const databaseManager =
+ options?.databaseManager ?? this.databaseManager.forPlugin(pluginId);
+ const logger = options?.logger ?? this.logger.child({ plugin: pluginId });
+
const databaseFactory = once(async () => {
- const databaseManager = this.databaseManager.forPlugin(pluginId);
const knex = await databaseManager.getClient();
if (!databaseManager.migrations?.skip) {
@@ -68,16 +78,13 @@ export class TaskScheduler {
const janitor = new PluginTaskSchedulerJanitor({
knex,
waitBetweenRuns: Duration.fromObject({ minutes: 1 }),
- logger: this.logger,
+ logger,
});
janitor.start();
return knex;
});
- return new PluginTaskSchedulerImpl(
- databaseFactory,
- this.logger.child({ plugin: pluginId }),
- );
+ return new PluginTaskSchedulerImpl(databaseFactory, logger);
}
}
diff --git a/packages/backend-test-utils/src/next/implementations/index.ts b/packages/backend-test-utils/src/next/implementations/index.ts
index 073e47f5e4..ba8bb5fb5e 100644
--- a/packages/backend-test-utils/src/next/implementations/index.ts
+++ b/packages/backend-test-utils/src/next/implementations/index.ts
@@ -14,3 +14,6 @@
* limitations under the License.
*/
export { mockTokenManagerFactory } from './mockTokenManagerService';
+export { mockConfigFactory } from './mockConfigService';
+export { mockDatabaseFactory } from './mockDatabaseService';
+export { mockDiscoveryFactory } from './mockDiscoveryService';
diff --git a/packages/backend-test-utils/src/next/implementations/mockConfigService.ts b/packages/backend-test-utils/src/next/implementations/mockConfigService.ts
new file mode 100644
index 0000000000..976167b473
--- /dev/null
+++ b/packages/backend-test-utils/src/next/implementations/mockConfigService.ts
@@ -0,0 +1,30 @@
+/*
+ * Copyright 2022 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 {
+ coreServices,
+ createServiceFactory,
+} from '@backstage/backend-plugin-api';
+import { AppConfig, ConfigReader } from '@backstage/config';
+
+/** @public */
+export const mockConfigFactory = createServiceFactory({
+ service: coreServices.config,
+ deps: {},
+ async factory(_, options?: { config?: AppConfig }) {
+ return new ConfigReader(options?.config);
+ },
+});
diff --git a/packages/backend-test-utils/src/next/implementations/mockDatabaseService.ts b/packages/backend-test-utils/src/next/implementations/mockDatabaseService.ts
new file mode 100644
index 0000000000..b0d67c1f1e
--- /dev/null
+++ b/packages/backend-test-utils/src/next/implementations/mockDatabaseService.ts
@@ -0,0 +1,46 @@
+/*
+ * Copyright 2022 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 { DatabaseManager } from '@backstage/backend-common';
+import {
+ coreServices,
+ createServiceFactory,
+} from '@backstage/backend-plugin-api';
+import { ConfigReader } from '@backstage/config';
+
+/** @public */
+export const mockDatabaseFactory = createServiceFactory({
+ service: coreServices.database,
+ deps: {
+ config: coreServices.config,
+ plugin: coreServices.pluginMetadata,
+ },
+ async factory({ config }) {
+ const databaseManager = config.getOptional('backend.database')
+ ? DatabaseManager.fromConfig(config)
+ : DatabaseManager.fromConfig(
+ new ConfigReader({
+ backend: {
+ database: { client: 'better-sqlite', connection: ':memory:' },
+ },
+ }),
+ );
+
+ return async ({ plugin }) => {
+ return databaseManager.forPlugin(plugin.getId());
+ };
+ },
+});
diff --git a/packages/backend-test-utils/src/next/implementations/mockDiscoveryService.ts b/packages/backend-test-utils/src/next/implementations/mockDiscoveryService.ts
new file mode 100644
index 0000000000..3af69187e8
--- /dev/null
+++ b/packages/backend-test-utils/src/next/implementations/mockDiscoveryService.ts
@@ -0,0 +1,40 @@
+/*
+ * 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.
+ */
+import { SingleHostDiscovery } from '@backstage/backend-common';
+import {
+ coreServices,
+ createServiceFactory,
+} from '@backstage/backend-plugin-api';
+import { ConfigReader } from '@backstage/config';
+
+/** @public */
+export const mockDiscoveryFactory = createServiceFactory({
+ service: coreServices.discovery,
+ deps: {},
+ async factory() {
+ // todo(blam): we want to grab the port from the httpRouter when that's available here
+ // to provide a better way to create our mockDiscoveryService.
+ const discovery = SingleHostDiscovery.fromConfig(
+ new ConfigReader({
+ backend: { baseUrl: 'http://localhost:7000', listen: '0.0.0.0:7000' },
+ }),
+ );
+
+ return async () => {
+ return discovery;
+ };
+ },
+});
diff --git a/packages/backend-test-utils/src/next/wiring/TestBackend.ts b/packages/backend-test-utils/src/next/wiring/TestBackend.ts
index 7b78ad3d95..a4ac8be7a2 100644
--- a/packages/backend-test-utils/src/next/wiring/TestBackend.ts
+++ b/packages/backend-test-utils/src/next/wiring/TestBackend.ts
@@ -21,10 +21,7 @@ import {
rootLifecycleFactory,
loggerFactory,
rootLoggerFactory,
- configFactory,
- discoveryFactory,
cacheFactory,
- databaseFactory,
permissionsFactory,
schedulerFactory,
urlReaderFactory,
@@ -38,7 +35,12 @@ import {
ExtensionPoint,
} from '@backstage/backend-plugin-api';
-import { mockTokenManagerFactory } from '../implementations';
+import {
+ mockConfigFactory,
+ mockDatabaseFactory,
+ mockTokenManagerFactory,
+ mockDiscoveryFactory,
+} from '../implementations';
/** @alpha */
export interface TestBackendOptions<
@@ -66,9 +68,9 @@ export interface TestBackendOptions<
const defaultServiceFactories = [
cacheFactory(),
- configFactory(),
- databaseFactory(),
- discoveryFactory(),
+ mockConfigFactory(),
+ mockDatabaseFactory(),
+ mockDiscoveryFactory(),
lifecycleFactory(),
loggerFactory(),
permissionsFactory(),
From 9ec23f2d7c425a3eb11700e96daad89245768072 Mon Sep 17 00:00:00 2001
From: blam
Date: Wed, 4 Jan 2023 16:23:03 +0100
Subject: [PATCH 22/38] chore: revert the TaskScheduler
Signed-off-by: blam
---
.../backend-tasks/src/tasks/TaskScheduler.ts | 23 +++++++------------
1 file changed, 8 insertions(+), 15 deletions(-)
diff --git a/packages/backend-tasks/src/tasks/TaskScheduler.ts b/packages/backend-tasks/src/tasks/TaskScheduler.ts
index f35669d76e..f14fb9fc2b 100644
--- a/packages/backend-tasks/src/tasks/TaskScheduler.ts
+++ b/packages/backend-tasks/src/tasks/TaskScheduler.ts
@@ -14,11 +14,7 @@
* limitations under the License.
*/
-import {
- DatabaseManager,
- getRootLogger,
- PluginDatabaseManager,
-} from '@backstage/backend-common';
+import { DatabaseManager, getRootLogger } from '@backstage/backend-common';
import { Config } from '@backstage/config';
import { once } from 'lodash';
import { Duration } from 'luxon';
@@ -60,15 +56,9 @@ export class TaskScheduler {
* @param pluginId - The unique ID of the plugin, for example "catalog"
* @returns A {@link PluginTaskScheduler} instance
*/
- forPlugin(
- pluginId: string,
- options?: { databaseManager?: PluginDatabaseManager; logger?: Logger },
- ): PluginTaskScheduler {
- const databaseManager =
- options?.databaseManager ?? this.databaseManager.forPlugin(pluginId);
- const logger = options?.logger ?? this.logger.child({ plugin: pluginId });
-
+ forPlugin(pluginId: string): PluginTaskScheduler {
const databaseFactory = once(async () => {
+ const databaseManager = this.databaseManager.forPlugin(pluginId);
const knex = await databaseManager.getClient();
if (!databaseManager.migrations?.skip) {
@@ -78,13 +68,16 @@ export class TaskScheduler {
const janitor = new PluginTaskSchedulerJanitor({
knex,
waitBetweenRuns: Duration.fromObject({ minutes: 1 }),
- logger,
+ logger: this.logger,
});
janitor.start();
return knex;
});
- return new PluginTaskSchedulerImpl(databaseFactory, logger);
+ return new PluginTaskSchedulerImpl(
+ databaseFactory,
+ this.logger.child({ plugin: pluginId }),
+ );
}
}
From 875cd848fdf22e4eae6473f13efe90403ad27aad Mon Sep 17 00:00:00 2001
From: blam
Date: Wed, 4 Jan 2023 16:31:29 +0100
Subject: [PATCH 23/38] chore: reworking how we do the TaskScheduler for now
Signed-off-by: blam
Signed-off-by: Patrik Oldsberg
---
.../database/databaseFactory.ts | 12 ++++-
.../scheduler/schedulerFactory.ts | 9 ++--
.../backend-tasks/src/tasks/TaskScheduler.ts | 32 +++++++++----
.../src/next/implementations/index.ts | 1 -
.../implementations/mockDatabaseService.ts | 46 -------------------
.../implementations/mockDiscoveryService.ts | 2 +-
.../src/next/wiring/TestBackend.test.ts | 5 +-
.../src/next/wiring/TestBackend.ts | 14 ++++--
8 files changed, 51 insertions(+), 70 deletions(-)
delete mode 100644 packages/backend-test-utils/src/next/implementations/mockDatabaseService.ts
diff --git a/packages/backend-app-api/src/services/implementations/database/databaseFactory.ts b/packages/backend-app-api/src/services/implementations/database/databaseFactory.ts
index f33e825c9b..52cecdbc4d 100644
--- a/packages/backend-app-api/src/services/implementations/database/databaseFactory.ts
+++ b/packages/backend-app-api/src/services/implementations/database/databaseFactory.ts
@@ -19,6 +19,7 @@ import {
coreServices,
createServiceFactory,
} from '@backstage/backend-plugin-api';
+import { ConfigReader } from '@backstage/config';
/** @public */
export const databaseFactory = createServiceFactory({
@@ -28,7 +29,16 @@ export const databaseFactory = createServiceFactory({
plugin: coreServices.pluginMetadata,
},
async factory({ config }) {
- const databaseManager = DatabaseManager.fromConfig(config);
+ const databaseManager = config.getOptional('backend.database')
+ ? DatabaseManager.fromConfig(config)
+ : DatabaseManager.fromConfig(
+ new ConfigReader({
+ backend: {
+ database: { client: 'better-sqlite3', connection: ':memory:' },
+ },
+ }),
+ );
+
return async ({ plugin }) => {
return databaseManager.forPlugin(plugin.getId());
};
diff --git a/packages/backend-app-api/src/services/implementations/scheduler/schedulerFactory.ts b/packages/backend-app-api/src/services/implementations/scheduler/schedulerFactory.ts
index 692f05f6d7..4e472b78f4 100644
--- a/packages/backend-app-api/src/services/implementations/scheduler/schedulerFactory.ts
+++ b/packages/backend-app-api/src/services/implementations/scheduler/schedulerFactory.ts
@@ -14,10 +14,10 @@
* limitations under the License.
*/
+import { loggerToWinstonLogger } from '@backstage/backend-common';
import {
coreServices,
createServiceFactory,
- loggerToWinstonLogger,
} from '@backstage/backend-plugin-api';
import { TaskScheduler } from '@backstage/backend-tasks';
@@ -25,15 +25,14 @@ import { TaskScheduler } from '@backstage/backend-tasks';
export const schedulerFactory = createServiceFactory({
service: coreServices.scheduler,
deps: {
- config: coreServices.config,
plugin: coreServices.pluginMetadata,
databaseManager: coreServices.database,
logger: coreServices.logger,
},
- async factory({ config }) {
- const taskScheduler = TaskScheduler.fromConfig(config);
+ async factory() {
return async ({ plugin, databaseManager, logger }) => {
- return taskScheduler.forPlugin(plugin.getId(), {
+ return TaskScheduler.forPlugin({
+ pluginId: plugin.getId(),
databaseManager,
logger: loggerToWinstonLogger(logger),
});
diff --git a/packages/backend-tasks/src/tasks/TaskScheduler.ts b/packages/backend-tasks/src/tasks/TaskScheduler.ts
index f14fb9fc2b..fe81a0054e 100644
--- a/packages/backend-tasks/src/tasks/TaskScheduler.ts
+++ b/packages/backend-tasks/src/tasks/TaskScheduler.ts
@@ -14,7 +14,11 @@
* limitations under the License.
*/
-import { DatabaseManager, getRootLogger } from '@backstage/backend-common';
+import {
+ DatabaseManager,
+ getRootLogger,
+ PluginDatabaseManager,
+} from '@backstage/backend-common';
import { Config } from '@backstage/config';
import { once } from 'lodash';
import { Duration } from 'luxon';
@@ -57,27 +61,35 @@ export class TaskScheduler {
* @returns A {@link PluginTaskScheduler} instance
*/
forPlugin(pluginId: string): PluginTaskScheduler {
- const databaseFactory = once(async () => {
- const databaseManager = this.databaseManager.forPlugin(pluginId);
- const knex = await databaseManager.getClient();
+ return TaskScheduler.forPlugin({
+ pluginId,
+ databaseManager: this.databaseManager.forPlugin(pluginId),
+ logger: this.logger,
+ });
+ }
- if (!databaseManager.migrations?.skip) {
+ static forPlugin(opts: {
+ pluginId: string;
+ databaseManager: PluginDatabaseManager;
+ logger: Logger;
+ }): PluginTaskScheduler {
+ const databaseFactory = once(async () => {
+ const knex = await opts.databaseManager.getClient();
+
+ if (!opts.databaseManager.migrations?.skip) {
await migrateBackendTasks(knex);
}
const janitor = new PluginTaskSchedulerJanitor({
knex,
waitBetweenRuns: Duration.fromObject({ minutes: 1 }),
- logger: this.logger,
+ logger: opts.logger,
});
janitor.start();
return knex;
});
- return new PluginTaskSchedulerImpl(
- databaseFactory,
- this.logger.child({ plugin: pluginId }),
- );
+ return new PluginTaskSchedulerImpl(databaseFactory, opts.logger);
}
}
diff --git a/packages/backend-test-utils/src/next/implementations/index.ts b/packages/backend-test-utils/src/next/implementations/index.ts
index ba8bb5fb5e..c248502307 100644
--- a/packages/backend-test-utils/src/next/implementations/index.ts
+++ b/packages/backend-test-utils/src/next/implementations/index.ts
@@ -15,5 +15,4 @@
*/
export { mockTokenManagerFactory } from './mockTokenManagerService';
export { mockConfigFactory } from './mockConfigService';
-export { mockDatabaseFactory } from './mockDatabaseService';
export { mockDiscoveryFactory } from './mockDiscoveryService';
diff --git a/packages/backend-test-utils/src/next/implementations/mockDatabaseService.ts b/packages/backend-test-utils/src/next/implementations/mockDatabaseService.ts
deleted file mode 100644
index b0d67c1f1e..0000000000
--- a/packages/backend-test-utils/src/next/implementations/mockDatabaseService.ts
+++ /dev/null
@@ -1,46 +0,0 @@
-/*
- * Copyright 2022 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 { DatabaseManager } from '@backstage/backend-common';
-import {
- coreServices,
- createServiceFactory,
-} from '@backstage/backend-plugin-api';
-import { ConfigReader } from '@backstage/config';
-
-/** @public */
-export const mockDatabaseFactory = createServiceFactory({
- service: coreServices.database,
- deps: {
- config: coreServices.config,
- plugin: coreServices.pluginMetadata,
- },
- async factory({ config }) {
- const databaseManager = config.getOptional('backend.database')
- ? DatabaseManager.fromConfig(config)
- : DatabaseManager.fromConfig(
- new ConfigReader({
- backend: {
- database: { client: 'better-sqlite', connection: ':memory:' },
- },
- }),
- );
-
- return async ({ plugin }) => {
- return databaseManager.forPlugin(plugin.getId());
- };
- },
-});
diff --git a/packages/backend-test-utils/src/next/implementations/mockDiscoveryService.ts b/packages/backend-test-utils/src/next/implementations/mockDiscoveryService.ts
index 3af69187e8..e382d23cbd 100644
--- a/packages/backend-test-utils/src/next/implementations/mockDiscoveryService.ts
+++ b/packages/backend-test-utils/src/next/implementations/mockDiscoveryService.ts
@@ -29,7 +29,7 @@ export const mockDiscoveryFactory = createServiceFactory({
// to provide a better way to create our mockDiscoveryService.
const discovery = SingleHostDiscovery.fromConfig(
new ConfigReader({
- backend: { baseUrl: 'http://localhost:7000', listen: '0.0.0.0:7000' },
+ backend: { baseUrl: 'http://localhost:7007', listen: '0.0.0.0' },
}),
);
diff --git a/packages/backend-test-utils/src/next/wiring/TestBackend.test.ts b/packages/backend-test-utils/src/next/wiring/TestBackend.test.ts
index 9d71005e18..4c7362880e 100644
--- a/packages/backend-test-utils/src/next/wiring/TestBackend.test.ts
+++ b/packages/backend-test-utils/src/next/wiring/TestBackend.test.ts
@@ -171,9 +171,12 @@ describe('TestBackend', () => {
config: coreServices.config,
database: coreServices.database,
discovery: coreServices.discovery,
+ httpRouter: coreServices.httpRouter,
lifecycle: coreServices.lifecycle,
logger: coreServices.logger,
permissions: coreServices.permissions,
+ pluginMetadata: coreServices.pluginMetadata,
+ rootHttpRouter: coreServices.rootHttpRouter,
rootLifecycle: coreServices.rootLifecycle,
rootLogger: coreServices.rootLogger,
scheduler: coreServices.scheduler,
@@ -181,7 +184,7 @@ describe('TestBackend', () => {
urlReader: coreServices.urlReader,
},
async init(deps) {
- expect(Object.keys(deps)).toHaveLength(12);
+ expect(Object.keys(deps)).toHaveLength(14);
expect(Object.values(deps)).not.toContain(undefined);
},
});
diff --git a/packages/backend-test-utils/src/next/wiring/TestBackend.ts b/packages/backend-test-utils/src/next/wiring/TestBackend.ts
index a4ac8be7a2..35f138091d 100644
--- a/packages/backend-test-utils/src/next/wiring/TestBackend.ts
+++ b/packages/backend-test-utils/src/next/wiring/TestBackend.ts
@@ -25,6 +25,9 @@ import {
permissionsFactory,
schedulerFactory,
urlReaderFactory,
+ databaseFactory,
+ rootHttpRouterFactory,
+ httpRouterFactory,
} from '@backstage/backend-app-api';
import {
@@ -37,7 +40,6 @@ import {
import {
mockConfigFactory,
- mockDatabaseFactory,
mockTokenManagerFactory,
mockDiscoveryFactory,
} from '../implementations';
@@ -68,16 +70,18 @@ export interface TestBackendOptions<
const defaultServiceFactories = [
cacheFactory(),
- mockConfigFactory(),
- mockDatabaseFactory(),
- mockDiscoveryFactory(),
+ databaseFactory(),
+ httpRouterFactory(),
lifecycleFactory(),
loggerFactory(),
+ mockConfigFactory(),
+ mockDiscoveryFactory(),
+ mockTokenManagerFactory(),
permissionsFactory(),
+ rootHttpRouterFactory(),
rootLifecycleFactory(),
rootLoggerFactory(),
schedulerFactory(),
- mockTokenManagerFactory(),
urlReaderFactory(),
];
From 8f9d0c8fca689455305ba802bd727a8568c59fb4 Mon Sep 17 00:00:00 2001
From: blam
Date: Wed, 4 Jan 2023 17:16:11 +0100
Subject: [PATCH 24/38] chore: explore some of the options for the httpRouter
and fix the shutdown in mutliple tests
Co-authored-by: Patrik Oldsberg
Co-authored-by: Johan Haals
Signed-off-by: blam
---
packages/backend-test-utils/package.json | 6 +-
.../src/next/implementations/index.ts | 1 -
.../implementations/mockDiscoveryService.ts | 40 ---------
.../src/next/wiring/TestBackend.test.ts | 30 ++++++-
.../src/next/wiring/TestBackend.ts | 89 ++++++++++++++++---
yarn.lock | 4 +
6 files changed, 115 insertions(+), 55 deletions(-)
delete mode 100644 packages/backend-test-utils/src/next/implementations/mockDiscoveryService.ts
diff --git a/packages/backend-test-utils/package.json b/packages/backend-test-utils/package.json
index 38db9d6413..ae96f17b8e 100644
--- a/packages/backend-test-utils/package.json
+++ b/packages/backend-test-utils/package.json
@@ -40,6 +40,8 @@
"@backstage/cli": "workspace:^",
"@backstage/config": "workspace:^",
"better-sqlite3": "^8.0.0",
+ "express": "^4.17.1",
+ "express-promise-router": "^4.1.0",
"knex": "^2.0.0",
"msw": "^0.49.0",
"mysql2": "^2.2.5",
@@ -48,7 +50,9 @@
"uuid": "^8.0.0"
},
"devDependencies": {
- "@backstage/cli": "workspace:^"
+ "@backstage/cli": "workspace:^",
+ "@types/supertest": "^2.0.8",
+ "supertest": "^6.1.3"
},
"files": [
"dist",
diff --git a/packages/backend-test-utils/src/next/implementations/index.ts b/packages/backend-test-utils/src/next/implementations/index.ts
index c248502307..2068aebec5 100644
--- a/packages/backend-test-utils/src/next/implementations/index.ts
+++ b/packages/backend-test-utils/src/next/implementations/index.ts
@@ -15,4 +15,3 @@
*/
export { mockTokenManagerFactory } from './mockTokenManagerService';
export { mockConfigFactory } from './mockConfigService';
-export { mockDiscoveryFactory } from './mockDiscoveryService';
diff --git a/packages/backend-test-utils/src/next/implementations/mockDiscoveryService.ts b/packages/backend-test-utils/src/next/implementations/mockDiscoveryService.ts
deleted file mode 100644
index e382d23cbd..0000000000
--- a/packages/backend-test-utils/src/next/implementations/mockDiscoveryService.ts
+++ /dev/null
@@ -1,40 +0,0 @@
-/*
- * 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.
- */
-import { SingleHostDiscovery } from '@backstage/backend-common';
-import {
- coreServices,
- createServiceFactory,
-} from '@backstage/backend-plugin-api';
-import { ConfigReader } from '@backstage/config';
-
-/** @public */
-export const mockDiscoveryFactory = createServiceFactory({
- service: coreServices.discovery,
- deps: {},
- async factory() {
- // todo(blam): we want to grab the port from the httpRouter when that's available here
- // to provide a better way to create our mockDiscoveryService.
- const discovery = SingleHostDiscovery.fromConfig(
- new ConfigReader({
- backend: { baseUrl: 'http://localhost:7007', listen: '0.0.0.0' },
- }),
- );
-
- return async () => {
- return discovery;
- };
- },
-});
diff --git a/packages/backend-test-utils/src/next/wiring/TestBackend.test.ts b/packages/backend-test-utils/src/next/wiring/TestBackend.test.ts
index 4c7362880e..6358051c34 100644
--- a/packages/backend-test-utils/src/next/wiring/TestBackend.test.ts
+++ b/packages/backend-test-utils/src/next/wiring/TestBackend.test.ts
@@ -22,6 +22,8 @@ import {
coreServices,
createBackendPlugin,
} from '@backstage/backend-plugin-api';
+import { Router } from 'express';
+import request from 'supertest';
import { startTestBackend } from './TestBackend';
@@ -184,7 +186,7 @@ describe('TestBackend', () => {
urlReader: coreServices.urlReader,
},
async init(deps) {
- expect(Object.keys(deps)).toHaveLength(14);
+ expect(Object.keys(deps)).toHaveLength(15);
expect(Object.values(deps)).not.toContain(undefined);
},
});
@@ -194,6 +196,30 @@ describe('TestBackend', () => {
await startTestBackend({
services: [],
features: [testPlugin()],
- }).then(backend => backend.stop());
+ });
+ });
+
+ it('should allow making requests via supertest', async () => {
+ const testPlugin = createBackendPlugin({
+ id: 'test',
+ register(env) {
+ env.registerInit({
+ deps: {
+ httpRouter: coreServices.httpRouter,
+ },
+ async init({ httpRouter }) {
+ const router = Router();
+ router.use('/ping-me', (_, res) => res.json({ message: 'pong' }));
+ httpRouter.use(router);
+ },
+ });
+ },
+ });
+
+ const { server } = await startTestBackend({ features: [testPlugin()] });
+
+ const res = await request(server).get('/api/test/ping-me');
+ expect(res.status).toEqual(200);
+ expect(res.body).toEqual({ message: 'pong' });
});
});
diff --git a/packages/backend-test-utils/src/next/wiring/TestBackend.ts b/packages/backend-test-utils/src/next/wiring/TestBackend.ts
index 35f138091d..933257426e 100644
--- a/packages/backend-test-utils/src/next/wiring/TestBackend.ts
+++ b/packages/backend-test-utils/src/next/wiring/TestBackend.ts
@@ -26,23 +26,27 @@ import {
schedulerFactory,
urlReaderFactory,
databaseFactory,
- rootHttpRouterFactory,
httpRouterFactory,
} from '@backstage/backend-app-api';
-
+import {
+ createServiceBuilder,
+ SingleHostDiscovery,
+} from '@backstage/backend-common';
+import { Handler } from 'express';
+import * as http from 'http';
+import Router from 'express-promise-router';
import {
ServiceFactory,
ServiceRef,
createServiceFactory,
BackendFeature,
ExtensionPoint,
+ coreServices,
} from '@backstage/backend-plugin-api';
-import {
- mockConfigFactory,
- mockTokenManagerFactory,
- mockDiscoveryFactory,
-} from '../implementations';
+import { mockConfigFactory, mockTokenManagerFactory } from '../implementations';
+import { AddressInfo } from 'net';
+import { ConfigReader } from '@backstage/config';
/** @alpha */
export interface TestBackendOptions<
@@ -75,10 +79,8 @@ const defaultServiceFactories = [
lifecycleFactory(),
loggerFactory(),
mockConfigFactory(),
- mockDiscoveryFactory(),
mockTokenManagerFactory(),
permissionsFactory(),
- rootHttpRouterFactory(),
rootLifecycleFactory(),
rootLoggerFactory(),
schedulerFactory(),
@@ -99,6 +101,71 @@ export async function startTestBackend<
...otherOptions
} = options;
+ let server: http.Server;
+
+ const rootHttpRouterFactory = createServiceFactory({
+ service: coreServices.rootHttpRouter,
+ deps: {
+ config: coreServices.config,
+ lifecycle: coreServices.rootLifecycle,
+ },
+ async factory({ config, lifecycle }) {
+ const router = Router();
+
+ const service = createServiceBuilder(module)
+ .loadConfig(config)
+ .setPort(0);
+
+ service.addRouter('', router);
+
+ server = await service.start();
+ // Stop method isn't part of the public API, let's fix that once we move the implementation here.
+ const stoppableServer = server as typeof server & {
+ stop: (cb: (error?: Error) => void) => void;
+ };
+
+ lifecycle.addShutdownHook({
+ async fn() {
+ await new Promise((resolve, reject) => {
+ stoppableServer.stop((error?: Error) => {
+ if (error) {
+ reject(error);
+ } else {
+ resolve();
+ }
+ });
+ });
+ },
+ labels: { service: 'rootHttpRouter' },
+ });
+
+ return {
+ use: (path: string, handler: Handler) => {
+ router.use(path, handler);
+ },
+ };
+ },
+ });
+
+ const discoveryFactory = createServiceFactory({
+ service: coreServices.discovery,
+ deps: {
+ rootHttpRouter: coreServices.rootHttpRouter,
+ },
+ async factory() {
+ if (!server) {
+ throw new Error('Test server not started yet');
+ }
+ const { port } = server.address() as AddressInfo;
+ const discovery = SingleHostDiscovery.fromConfig(
+ new ConfigReader({
+ backend: { baseUrl: `http://localhost:${port}`, listen: { port } },
+ }),
+ );
+ return async () => discovery;
+ },
+ });
+
const factories = services.map(serviceDef => {
if (Array.isArray(serviceDef)) {
// if type is ExtensionPoint?
@@ -131,7 +198,7 @@ export async function startTestBackend<
const backend = createSpecializedBackend({
...otherOptions,
- services: factories,
+ services: [...factories, rootHttpRouterFactory, discoveryFactory],
});
backendInstancesToCleanUp.push(backend);
@@ -153,7 +220,7 @@ export async function startTestBackend<
await backend.start();
- return backend;
+ return Object.assign(backend, { server: server! }) as Backend;
}
let registered = false;
diff --git a/yarn.lock b/yarn.lock
index 693b5cc3dd..f8957bfc35 100644
--- a/yarn.lock
+++ b/yarn.lock
@@ -3558,11 +3558,15 @@ __metadata:
"@backstage/backend-plugin-api": "workspace:^"
"@backstage/cli": "workspace:^"
"@backstage/config": "workspace:^"
+ "@types/supertest": ^2.0.8
better-sqlite3: ^8.0.0
+ express: ^4.17.1
+ express-promise-router: ^4.1.0
knex: ^2.0.0
msw: ^0.49.0
mysql2: ^2.2.5
pg: ^8.3.0
+ supertest: ^6.1.3
testcontainers: ^8.1.2
uuid: ^8.0.0
languageName: unknown
From df6a5a9264868bebc39d5cb329d06685ac190d46 Mon Sep 17 00:00:00 2001
From: Patrik Oldsberg
Date: Tue, 10 Jan 2023 15:06:04 +0100
Subject: [PATCH 25/38] backend-app-api: refactor RestrictedIndexedRouter ->
DefaultRootHttpRouter
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
Co-authored-by: Fredrik Adelöw
Co-authored-by: blam
Co-authored-by: Johan Haals
Signed-off-by: Patrik Oldsberg
---
packages/backend-app-api/api-report.md | 16 +++++++
....test.ts => DefaultRootHttpRouter.test.ts} | 14 ++++--
...exedRouter.ts => DefaultRootHttpRouter.ts} | 43 +++++++++++++++++--
.../implementations/rootHttpRouter/index.ts | 12 ++++--
.../rootHttpRouter/rootHttpRouterFactory.ts | 8 ++--
5 files changed, 77 insertions(+), 16 deletions(-)
rename packages/backend-app-api/src/services/implementations/rootHttpRouter/{RestrictedIndexedRouter.test.ts => DefaultRootHttpRouter.test.ts} (76%)
rename packages/backend-app-api/src/services/implementations/rootHttpRouter/{RestrictedIndexedRouter.ts => DefaultRootHttpRouter.ts} (62%)
diff --git a/packages/backend-app-api/api-report.md b/packages/backend-app-api/api-report.md
index a8f077b760..b1356e93e3 100644
--- a/packages/backend-app-api/api-report.md
+++ b/packages/backend-app-api/api-report.md
@@ -12,6 +12,7 @@ import { CorsOptions } from 'cors';
import { ErrorRequestHandler } from 'express';
import { Express as Express_2 } from 'express';
import { ExtensionPoint } from '@backstage/backend-plugin-api';
+import { Handler } from 'express';
import { HelmetOptions } from 'helmet';
import * as http from 'http';
import { HttpRouterService } from '@backstage/backend-plugin-api';
@@ -79,6 +80,21 @@ export const databaseFactory: (
options?: undefined,
) => ServiceFactory;
+// @public
+export class DefaultRootHttpRouter implements RootHttpRouterService {
+ // (undocumented)
+ static create(options?: DefaultRootHttpRouterOptions): DefaultRootHttpRouter;
+ // (undocumented)
+ handler(): Handler;
+ // (undocumented)
+ use(path: string, handler: Handler): void;
+}
+
+// @public
+export interface DefaultRootHttpRouterOptions {
+ indexPath?: string | false;
+}
+
// @public (undocumented)
export const discoveryFactory: (
options?: undefined,
diff --git a/packages/backend-app-api/src/services/implementations/rootHttpRouter/RestrictedIndexedRouter.test.ts b/packages/backend-app-api/src/services/implementations/rootHttpRouter/DefaultRootHttpRouter.test.ts
similarity index 76%
rename from packages/backend-app-api/src/services/implementations/rootHttpRouter/RestrictedIndexedRouter.test.ts
rename to packages/backend-app-api/src/services/implementations/rootHttpRouter/DefaultRootHttpRouter.test.ts
index b72e87f77b..b72b30e02e 100644
--- a/packages/backend-app-api/src/services/implementations/rootHttpRouter/RestrictedIndexedRouter.test.ts
+++ b/packages/backend-app-api/src/services/implementations/rootHttpRouter/DefaultRootHttpRouter.test.ts
@@ -14,9 +14,9 @@
* limitations under the License.
*/
-import { RestrictedIndexedRouter } from './RestrictedIndexedRouter';
+import { DefaultRootHttpRouter } from './DefaultRootHttpRouter';
-describe('RestrictedIndexedRouter', () => {
+describe('DefaultRootHttpRouter', () => {
it.each([
[['/b'], '/a'],
[['/a'], '/aa/b'],
@@ -25,7 +25,7 @@ describe('RestrictedIndexedRouter', () => {
[['/b/a'], '/a'],
[['/a'], '/aa'],
])(`with existing paths %s, adds %s without conflict`, (existing, added) => {
- const router = new RestrictedIndexedRouter(false);
+ const router = DefaultRootHttpRouter.create();
for (const path of existing) {
router.use(path, () => {});
}
@@ -39,7 +39,7 @@ describe('RestrictedIndexedRouter', () => {
])(
`find conflict when existing paths %s, adds %s`,
(existing, added, conflict) => {
- const router = new RestrictedIndexedRouter(false);
+ const router = DefaultRootHttpRouter.create();
for (const path of existing) {
router.use(path, () => {});
}
@@ -48,4 +48,10 @@ describe('RestrictedIndexedRouter', () => {
);
},
);
+
+ it('should not be possible to supply an empty indexPath', () => {
+ expect(() => DefaultRootHttpRouter.create({ indexPath: '' })).toThrow(
+ 'indexPath option may not be an empty string',
+ );
+ });
});
diff --git a/packages/backend-app-api/src/services/implementations/rootHttpRouter/RestrictedIndexedRouter.ts b/packages/backend-app-api/src/services/implementations/rootHttpRouter/DefaultRootHttpRouter.ts
similarity index 62%
rename from packages/backend-app-api/src/services/implementations/rootHttpRouter/RestrictedIndexedRouter.ts
rename to packages/backend-app-api/src/services/implementations/rootHttpRouter/DefaultRootHttpRouter.ts
index 961277f34d..2acbb3833a 100644
--- a/packages/backend-app-api/src/services/implementations/rootHttpRouter/RestrictedIndexedRouter.ts
+++ b/packages/backend-app-api/src/services/implementations/rootHttpRouter/DefaultRootHttpRouter.ts
@@ -21,18 +21,53 @@ function normalizePath(path: string): string {
return path.replace(/\/*$/, '/');
}
-export class RestrictedIndexedRouter implements RootHttpRouterService {
- #indexPath?: false | string;
+/**
+ * Options for the {@link DefaultRootHttpRouter} class.
+ *
+ * @public
+ */
+export interface DefaultRootHttpRouterOptions {
+ /**
+ * The path to forward all unmatched requests to. Defaults to '/api/app' if
+ * not given. Disables index path behavior if false is given.
+ */
+ indexPath?: string | false;
+}
+
+/**
+ * The default implementation of the {@link @backstage/backend-plugin-api#RootHttpRouterService} interface for
+ * {@link @backstage/backend-plugin-api#coreServices.rootHttpRouter}.
+ *
+ * @public
+ */
+export class DefaultRootHttpRouter implements RootHttpRouterService {
+ #indexPath?: string;
#router = Router();
#namedRoutes = Router();
#indexRouter = Router();
#existingPaths = new Array();
- constructor(indexPath?: false | string) {
+ static create(options?: DefaultRootHttpRouterOptions) {
+ let indexPath;
+ if (options?.indexPath === false) {
+ indexPath = undefined;
+ } else if (options?.indexPath === undefined) {
+ indexPath = '/api/app';
+ } else if (options?.indexPath === '') {
+ throw new Error('indexPath option may not be an empty string');
+ } else {
+ indexPath = options.indexPath;
+ }
+ return new DefaultRootHttpRouter(indexPath);
+ }
+
+ private constructor(indexPath?: string) {
this.#indexPath = indexPath;
this.#router.use(this.#namedRoutes);
- this.#router.use(this.#indexRouter);
+ if (this.#indexPath) {
+ this.#router.use(this.#indexRouter);
+ }
}
use(path: string, handler: Handler) {
diff --git a/packages/backend-app-api/src/services/implementations/rootHttpRouter/index.ts b/packages/backend-app-api/src/services/implementations/rootHttpRouter/index.ts
index 1dfd72273d..e24662df05 100644
--- a/packages/backend-app-api/src/services/implementations/rootHttpRouter/index.ts
+++ b/packages/backend-app-api/src/services/implementations/rootHttpRouter/index.ts
@@ -14,8 +14,12 @@
* limitations under the License.
*/
-export { rootHttpRouterFactory } from './rootHttpRouterFactory';
-export type {
- RootHttpRouterFactoryOptions,
- RootHttpRouterConfigureOptions,
+export {
+ rootHttpRouterFactory,
+ type RootHttpRouterFactoryOptions,
+ type RootHttpRouterConfigureOptions,
} from './rootHttpRouterFactory';
+export {
+ DefaultRootHttpRouter,
+ type DefaultRootHttpRouterOptions,
+} from './DefaultRootHttpRouter';
diff --git a/packages/backend-app-api/src/services/implementations/rootHttpRouter/rootHttpRouterFactory.ts b/packages/backend-app-api/src/services/implementations/rootHttpRouter/rootHttpRouterFactory.ts
index 45cb826b4d..58f8cc2db1 100644
--- a/packages/backend-app-api/src/services/implementations/rootHttpRouter/rootHttpRouterFactory.ts
+++ b/packages/backend-app-api/src/services/implementations/rootHttpRouter/rootHttpRouterFactory.ts
@@ -27,7 +27,7 @@ import {
MiddlewareFactory,
readHttpServerOptions,
} from '../../../http';
-import { RestrictedIndexedRouter } from './RestrictedIndexedRouter';
+import { DefaultRootHttpRouter } from './DefaultRootHttpRouter';
/**
* @public
@@ -46,7 +46,8 @@ export interface RootHttpRouterConfigureOptions {
*/
export type RootHttpRouterFactoryOptions = {
/**
- * The path to forward all unmatched requests to. Defaults to '/api/app'
+ * The path to forward all unmatched requests to. Defaults to '/api/app' if
+ * not given. Disables index path behavior if false is given.
*/
indexPath?: string | false;
@@ -82,11 +83,10 @@ export const rootHttpRouterFactory = createServiceFactory({
configure = defaultConfigure,
}: RootHttpRouterFactoryOptions = {},
) {
- const router = new RestrictedIndexedRouter(indexPath ?? '/api/app');
const logger = rootLogger.child({ service: 'rootHttpRouter' });
-
const app = express();
+ const router = DefaultRootHttpRouter.create({ indexPath });
const middleware = MiddlewareFactory.create({ config, logger });
configure({
From b4b1bd66433e10a7c8e750d1f5cd2f35e055bcd2 Mon Sep 17 00:00:00 2001
From: Patrik Oldsberg
Date: Tue, 10 Jan 2023 15:09:30 +0100
Subject: [PATCH 26/38] backend-test-utils: refactor startTestBackend to use
new http implementation
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
Co-authored-by: Fredrik Adelöw
Co-authored-by: blam
Co-authored-by: Johan Haals
Signed-off-by: Patrik Oldsberg
---
packages/backend-test-utils/api-report.md | 10 ++-
.../src/next/wiring/TestBackend.ts | 88 +++++++++++--------
.../src/next/wiring/index.ts | 2 +-
3 files changed, 60 insertions(+), 40 deletions(-)
diff --git a/packages/backend-test-utils/api-report.md b/packages/backend-test-utils/api-report.md
index 3df3f3cb21..ad7ecc04dd 100644
--- a/packages/backend-test-utils/api-report.md
+++ b/packages/backend-test-utils/api-report.md
@@ -5,6 +5,7 @@
```ts
import { Backend } from '@backstage/backend-app-api';
import { BackendFeature } from '@backstage/backend-plugin-api';
+import { ExtendedHttpServer } from '@backstage/backend-app-api';
import { ExtensionPoint } from '@backstage/backend-plugin-api';
import { Knex } from 'knex';
import { ServiceFactory } from '@backstage/backend-plugin-api';
@@ -24,7 +25,14 @@ export function setupRequestMockHandlers(worker: {
export function startTestBackend<
TServices extends any[],
TExtensionPoints extends any[],
->(options: TestBackendOptions): Promise;
+>(
+ options: TestBackendOptions,
+): Promise;
+
+// @alpha (undocumented)
+export interface TestBackend extends Backend {
+ readonly server: ExtendedHttpServer;
+}
// @alpha (undocumented)
export interface TestBackendOptions<
diff --git a/packages/backend-test-utils/src/next/wiring/TestBackend.ts b/packages/backend-test-utils/src/next/wiring/TestBackend.ts
index 933257426e..00c38240a3 100644
--- a/packages/backend-test-utils/src/next/wiring/TestBackend.ts
+++ b/packages/backend-test-utils/src/next/wiring/TestBackend.ts
@@ -27,14 +27,12 @@ import {
urlReaderFactory,
databaseFactory,
httpRouterFactory,
+ MiddlewareFactory,
+ createHttpServer,
+ ExtendedHttpServer,
+ DefaultRootHttpRouter,
} from '@backstage/backend-app-api';
-import {
- createServiceBuilder,
- SingleHostDiscovery,
-} from '@backstage/backend-common';
-import { Handler } from 'express';
-import * as http from 'http';
-import Router from 'express-promise-router';
+import { SingleHostDiscovery } from '@backstage/backend-common';
import {
ServiceFactory,
ServiceRef,
@@ -45,8 +43,8 @@ import {
} from '@backstage/backend-plugin-api';
import { mockConfigFactory, mockTokenManagerFactory } from '../implementations';
-import { AddressInfo } from 'net';
import { ConfigReader } from '@backstage/config';
+import express from 'express';
/** @alpha */
export interface TestBackendOptions<
@@ -72,6 +70,17 @@ export interface TestBackendOptions<
features?: BackendFeature[];
}
+/** @alpha */
+export interface TestBackend extends Backend {
+ /**
+ * Provides access to the underling HTTP server for use with utilities
+ * such as `supertest`.
+ *
+ * If the root http router service has been replaced, this will throw an error.
+ */
+ readonly server: ExtendedHttpServer;
+}
+
const defaultServiceFactories = [
cacheFactory(),
databaseFactory(),
@@ -93,7 +102,9 @@ const backendInstancesToCleanUp = new Array();
export async function startTestBackend<
TServices extends any[],
TExtensionPoints extends any[],
->(options: TestBackendOptions): Promise {
+>(
+ options: TestBackendOptions,
+): Promise {
const {
services = [],
extensionPoints = [],
@@ -101,49 +112,43 @@ export async function startTestBackend<
...otherOptions
} = options;
- let server: http.Server;
+ let server: ExtendedHttpServer;
const rootHttpRouterFactory = createServiceFactory({
service: coreServices.rootHttpRouter,
deps: {
config: coreServices.config,
lifecycle: coreServices.rootLifecycle,
+ rootLogger: coreServices.rootLogger,
},
- async factory({ config, lifecycle }) {
- const router = Router();
+ async factory({ config, lifecycle, rootLogger }) {
+ const router = DefaultRootHttpRouter.create();
+ const logger = rootLogger.child({ service: 'rootHttpRouter' });
- const service = createServiceBuilder(module)
- .loadConfig(config)
- .setPort(0);
+ const app = express();
- service.addRouter('', router);
+ const middleware = MiddlewareFactory.create({ config, logger });
- server = await service.start();
- // Stop method isn't part of the public API, let's fix that once we move the implementation here.
- const stoppableServer = server as typeof server & {
- stop: (cb: (error?: Error) => void) => void;
- };
+ app.use(router.handler());
+ app.use(middleware.notFound());
+ app.use(middleware.error());
+
+ server = await createHttpServer(
+ app,
+ { listen: { host: '', port: 0 } },
+ { logger },
+ );
lifecycle.addShutdownHook({
async fn() {
- await new Promise((resolve, reject) => {
- stoppableServer.stop((error?: Error) => {
- if (error) {
- reject(error);
- } else {
- resolve();
- }
- });
- });
+ await server.stop();
},
- labels: { service: 'rootHttpRouter' },
+ logger,
});
- return {
- use: (path: string, handler: Handler) => {
- router.use(path, handler);
- },
- };
+ await server.start();
+
+ return router;
},
});
@@ -156,7 +161,7 @@ export async function startTestBackend<
if (!server) {
throw new Error('Test server not started yet');
}
- const { port } = server.address() as AddressInfo;
+ const port = server.port();
const discovery = SingleHostDiscovery.fromConfig(
new ConfigReader({
backend: { baseUrl: `http://localhost:${port}`, listen: { port } },
@@ -220,7 +225,14 @@ export async function startTestBackend<
await backend.start();
- return Object.assign(backend, { server: server! }) as Backend;
+ return Object.assign(backend, {
+ get server() {
+ if (!server) {
+ throw new Error('TestBackend server is not available');
+ }
+ return server;
+ },
+ });
}
let registered = false;
diff --git a/packages/backend-test-utils/src/next/wiring/index.ts b/packages/backend-test-utils/src/next/wiring/index.ts
index eb7b773e33..7c39474d4c 100644
--- a/packages/backend-test-utils/src/next/wiring/index.ts
+++ b/packages/backend-test-utils/src/next/wiring/index.ts
@@ -15,4 +15,4 @@
*/
export { startTestBackend } from './TestBackend';
-export type { TestBackendOptions } from './TestBackend';
+export type { TestBackend, TestBackendOptions } from './TestBackend';
From 3fad4ed40a7a710d67fd10f4794d02f09bd6f1fc Mon Sep 17 00:00:00 2001
From: Patrik Oldsberg
Date: Tue, 10 Jan 2023 15:13:01 +0100
Subject: [PATCH 27/38] backend-tasks: update API report + changeset for
forPlugin addition
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
Co-authored-by: Fredrik Adelöw
Co-authored-by: blam
Co-authored-by: Johan Haals
Signed-off-by: Patrik Oldsberg
---
.changeset/hungry-weeks-flash.md | 5 +++++
packages/backend-tasks/api-report.md | 7 +++++++
2 files changed, 12 insertions(+)
create mode 100644 .changeset/hungry-weeks-flash.md
diff --git a/.changeset/hungry-weeks-flash.md b/.changeset/hungry-weeks-flash.md
new file mode 100644
index 0000000000..19cb6cede8
--- /dev/null
+++ b/.changeset/hungry-weeks-flash.md
@@ -0,0 +1,5 @@
+---
+'@backstage/backend-tasks': patch
+---
+
+Added a new static `TaskScheduler.forPlugin` method.
diff --git a/packages/backend-tasks/api-report.md b/packages/backend-tasks/api-report.md
index f7b4782263..44ec4addbe 100644
--- a/packages/backend-tasks/api-report.md
+++ b/packages/backend-tasks/api-report.md
@@ -8,6 +8,7 @@ import { DatabaseManager } from '@backstage/backend-common';
import { Duration } from 'luxon';
import { HumanDuration as HumanDuration_2 } from '@backstage/types';
import { Logger } from 'winston';
+import { PluginDatabaseManager } from '@backstage/backend-common';
// @public @deprecated
export type HumanDuration = HumanDuration_2;
@@ -74,6 +75,12 @@ export class TaskScheduler {
constructor(databaseManager: DatabaseManager, logger: Logger);
forPlugin(pluginId: string): PluginTaskScheduler;
// (undocumented)
+ static forPlugin(opts: {
+ pluginId: string;
+ databaseManager: PluginDatabaseManager;
+ logger: Logger;
+ }): PluginTaskScheduler;
+ // (undocumented)
static fromConfig(
config: Config,
options?: {
From 51b7a7ed070ce1ebbf444aafcb5d77fb4d43db30 Mon Sep 17 00:00:00 2001
From: Patrik Oldsberg
Date: Tue, 10 Jan 2023 15:15:11 +0100
Subject: [PATCH 28/38] changesets: added changesets for default
implementations for test backend
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
Co-authored-by: Fredrik Adelöw
Co-authored-by: blam
Co-authored-by: Johan Haals
Signed-off-by: Patrik Oldsberg
---
.changeset/proud-cobras-chew.md | 5 +++++
.changeset/shaggy-apricots-camp.md | 5 +++++
2 files changed, 10 insertions(+)
create mode 100644 .changeset/proud-cobras-chew.md
create mode 100644 .changeset/shaggy-apricots-camp.md
diff --git a/.changeset/proud-cobras-chew.md b/.changeset/proud-cobras-chew.md
new file mode 100644
index 0000000000..ae08378715
--- /dev/null
+++ b/.changeset/proud-cobras-chew.md
@@ -0,0 +1,5 @@
+---
+'@backstage/backend-test-utils': patch
+---
+
+The backend started by `startTestBackend` now has default implementations of all core services. It now also returns a `TestBackend` instance, which provides access to the underlying `server` that can be used with testing libraries such as `supertest`.
diff --git a/.changeset/shaggy-apricots-camp.md b/.changeset/shaggy-apricots-camp.md
new file mode 100644
index 0000000000..705dcef0f0
--- /dev/null
+++ b/.changeset/shaggy-apricots-camp.md
@@ -0,0 +1,5 @@
+---
+'@backstage/backend-app-api': patch
+---
+
+Exported the default root HTTP router implementation as `DefaultRootHttpRouter`. It only implements the routing layer and needs to be exposed via an HTTP server similar to the built-in setup in the `rootHttpRouterFactory`.
From ac993deb18d2dda8668bc89e15ebf60313630bb9 Mon Sep 17 00:00:00 2001
From: Patrik Oldsberg
Date: Tue, 10 Jan 2023 15:17:05 +0100
Subject: [PATCH 29/38] backend-test-utils: tweak mockConfigFactory options
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
Co-authored-by: Fredrik Adelöw
Co-authored-by: blam
Co-authored-by: Johan Haals
Signed-off-by: Patrik Oldsberg
---
packages/backend-test-utils/package.json | 1 +
.../src/next/implementations/mockConfigService.ts | 7 ++++---
yarn.lock | 1 +
3 files changed, 6 insertions(+), 3 deletions(-)
diff --git a/packages/backend-test-utils/package.json b/packages/backend-test-utils/package.json
index ae96f17b8e..725be0d905 100644
--- a/packages/backend-test-utils/package.json
+++ b/packages/backend-test-utils/package.json
@@ -39,6 +39,7 @@
"@backstage/backend-plugin-api": "workspace:^",
"@backstage/cli": "workspace:^",
"@backstage/config": "workspace:^",
+ "@backstage/types": "workspace:^",
"better-sqlite3": "^8.0.0",
"express": "^4.17.1",
"express-promise-router": "^4.1.0",
diff --git a/packages/backend-test-utils/src/next/implementations/mockConfigService.ts b/packages/backend-test-utils/src/next/implementations/mockConfigService.ts
index 976167b473..78a670585d 100644
--- a/packages/backend-test-utils/src/next/implementations/mockConfigService.ts
+++ b/packages/backend-test-utils/src/next/implementations/mockConfigService.ts
@@ -18,13 +18,14 @@ import {
coreServices,
createServiceFactory,
} from '@backstage/backend-plugin-api';
-import { AppConfig, ConfigReader } from '@backstage/config';
+import { ConfigReader } from '@backstage/config';
+import { JsonObject } from '@backstage/types';
/** @public */
export const mockConfigFactory = createServiceFactory({
service: coreServices.config,
deps: {},
- async factory(_, options?: { config?: AppConfig }) {
- return new ConfigReader(options?.config);
+ async factory(_, options?: { data?: JsonObject }) {
+ return new ConfigReader(options?.data, 'mock-config');
},
});
diff --git a/yarn.lock b/yarn.lock
index f8957bfc35..f973dee489 100644
--- a/yarn.lock
+++ b/yarn.lock
@@ -3558,6 +3558,7 @@ __metadata:
"@backstage/backend-plugin-api": "workspace:^"
"@backstage/cli": "workspace:^"
"@backstage/config": "workspace:^"
+ "@backstage/types": "workspace:^"
"@types/supertest": ^2.0.8
better-sqlite3: ^8.0.0
express: ^4.17.1
From 5541715237ccba49e44321c375c257a1d92e59d3 Mon Sep 17 00:00:00 2001
From: Patrik Oldsberg
Date: Tue, 10 Jan 2023 15:20:11 +0100
Subject: [PATCH 30/38] backend-test-utils: make mock token manager check for
mock tokens
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
Co-authored-by: Fredrik Adelöw
Co-authored-by: blam
Co-authored-by: Johan Haals
Signed-off-by: Patrik Oldsberg
---
.../src/next/implementations/mockTokenManagerService.ts | 6 +++++-
1 file changed, 5 insertions(+), 1 deletion(-)
diff --git a/packages/backend-test-utils/src/next/implementations/mockTokenManagerService.ts b/packages/backend-test-utils/src/next/implementations/mockTokenManagerService.ts
index f68e910e0c..dd1d6b16f7 100644
--- a/packages/backend-test-utils/src/next/implementations/mockTokenManagerService.ts
+++ b/packages/backend-test-utils/src/next/implementations/mockTokenManagerService.ts
@@ -23,7 +23,11 @@ class TokenManagerMock implements TokenManager {
async getToken(): Promise<{ token: string }> {
return { token: 'mock-token' };
}
- async authenticate(): Promise {}
+ async authenticate(token: string): Promise {
+ if (token !== 'mock-token') {
+ throw new Error('Invalid token');
+ }
+ }
}
export const mockTokenManagerFactory = createServiceFactory({
From 54632b830434e26a093161205da1bd337808e6b6 Mon Sep 17 00:00:00 2001
From: blam
Date: Wed, 11 Jan 2023 14:06:45 +0100
Subject: [PATCH 31/38] chore: fix some of the tests by exporting the
`mockConfigFactory` Signed-off-by: blam
Signed-off-by: blam
---
packages/backend-test-utils/api-report.md | 11 +++++
.../src/next/implementations/index.ts | 1 -
packages/backend-test-utils/src/next/index.ts | 1 +
.../src/next/wiring/TestBackend.ts | 3 +-
...etCloudEntityProviderCatalogModule.test.ts | 46 ++++++++-----------
5 files changed, 33 insertions(+), 29 deletions(-)
diff --git a/packages/backend-test-utils/api-report.md b/packages/backend-test-utils/api-report.md
index ad7ecc04dd..85cdb201ef 100644
--- a/packages/backend-test-utils/api-report.md
+++ b/packages/backend-test-utils/api-report.md
@@ -5,8 +5,10 @@
```ts
import { Backend } from '@backstage/backend-app-api';
import { BackendFeature } from '@backstage/backend-plugin-api';
+import { ConfigService } from '@backstage/backend-plugin-api';
import { ExtendedHttpServer } from '@backstage/backend-app-api';
import { ExtensionPoint } from '@backstage/backend-plugin-api';
+import { JsonObject } from '@backstage/types';
import { Knex } from 'knex';
import { ServiceFactory } from '@backstage/backend-plugin-api';
import { ServiceRef } from '@backstage/backend-plugin-api';
@@ -14,6 +16,15 @@ import { ServiceRef } from '@backstage/backend-plugin-api';
// @public (undocumented)
export function isDockerDisabledForTests(): boolean;
+// @public (undocumented)
+export const mockConfigFactory: (
+ options?:
+ | {
+ data?: JsonObject | undefined;
+ }
+ | undefined,
+) => ServiceFactory;
+
// @public
export function setupRequestMockHandlers(worker: {
listen: (t: any) => void;
diff --git a/packages/backend-test-utils/src/next/implementations/index.ts b/packages/backend-test-utils/src/next/implementations/index.ts
index 2068aebec5..55f417f8df 100644
--- a/packages/backend-test-utils/src/next/implementations/index.ts
+++ b/packages/backend-test-utils/src/next/implementations/index.ts
@@ -13,5 +13,4 @@
* See the License for the specific language governing permissions and
* limitations under the License.
*/
-export { mockTokenManagerFactory } from './mockTokenManagerService';
export { mockConfigFactory } from './mockConfigService';
diff --git a/packages/backend-test-utils/src/next/index.ts b/packages/backend-test-utils/src/next/index.ts
index 9bb5431772..9f9edfd837 100644
--- a/packages/backend-test-utils/src/next/index.ts
+++ b/packages/backend-test-utils/src/next/index.ts
@@ -15,3 +15,4 @@
*/
export * from './wiring';
+export * from './implementations';
diff --git a/packages/backend-test-utils/src/next/wiring/TestBackend.ts b/packages/backend-test-utils/src/next/wiring/TestBackend.ts
index 00c38240a3..8fe489750a 100644
--- a/packages/backend-test-utils/src/next/wiring/TestBackend.ts
+++ b/packages/backend-test-utils/src/next/wiring/TestBackend.ts
@@ -42,7 +42,8 @@ import {
coreServices,
} from '@backstage/backend-plugin-api';
-import { mockConfigFactory, mockTokenManagerFactory } from '../implementations';
+import { mockConfigFactory } from '../implementations/mockConfigService';
+import { mockTokenManagerFactory } from '../implementations/mockTokenManagerService';
import { ConfigReader } from '@backstage/config';
import express from 'express';
diff --git a/plugins/catalog-backend-module-bitbucket-cloud/src/service/BitbucketCloudEntityProviderCatalogModule.test.ts b/plugins/catalog-backend-module-bitbucket-cloud/src/service/BitbucketCloudEntityProviderCatalogModule.test.ts
index 83e657bcfe..d44281600c 100644
--- a/plugins/catalog-backend-module-bitbucket-cloud/src/service/BitbucketCloudEntityProviderCatalogModule.test.ts
+++ b/plugins/catalog-backend-module-bitbucket-cloud/src/service/BitbucketCloudEntityProviderCatalogModule.test.ts
@@ -14,18 +14,15 @@
* limitations under the License.
*/
-import { ConfigReader } from '@backstage/config';
-import {
- getVoidLogger,
- PluginEndpointDiscovery,
- TokenManager,
-} from '@backstage/backend-common';
import { coreServices } from '@backstage/backend-plugin-api';
import {
PluginTaskScheduler,
TaskScheduleDefinition,
} from '@backstage/backend-tasks';
-import { startTestBackend } from '@backstage/backend-test-utils';
+import {
+ startTestBackend,
+ mockConfigFactory,
+} from '@backstage/backend-test-utils';
import { catalogProcessingExtensionPoint } from '@backstage/plugin-catalog-node';
import { eventsExtensionPoint } from '@backstage/plugin-events-node';
import { Duration } from 'luxon';
@@ -55,22 +52,6 @@ describe('bitbucketCloudEntityProviderCatalogModule', () => {
return runner;
},
} as unknown as PluginTaskScheduler;
- const discovery = jest.fn() as any as PluginEndpointDiscovery;
- const tokenManager = jest.fn() as any as TokenManager;
-
- const config = new ConfigReader({
- catalog: {
- providers: {
- bitbucketCloud: {
- schedule: {
- frequency: 'P1M',
- timeout: 'PT3M',
- },
- workspace: 'test-ws',
- },
- },
- },
- });
await startTestBackend({
extensionPoints: [
@@ -78,11 +59,22 @@ describe('bitbucketCloudEntityProviderCatalogModule', () => {
[eventsExtensionPoint, eventsExtensionPointImpl],
],
services: [
- [coreServices.config, config],
- [coreServices.discovery, discovery],
- [coreServices.logger, getVoidLogger()],
+ mockConfigFactory({
+ data: {
+ catalog: {
+ providers: {
+ bitbucketCloud: {
+ schedule: {
+ frequency: 'P1M',
+ timeout: 'PT3M',
+ },
+ workspace: 'test-ws',
+ },
+ },
+ },
+ },
+ }),
[coreServices.scheduler, scheduler],
- [coreServices.tokenManager, tokenManager],
],
features: [bitbucketCloudEntityProviderCatalogModule()],
});
From 8c19b84088176069622ae43511cd267007679129 Mon Sep 17 00:00:00 2001
From: blam
Date: Wed, 11 Jan 2023 14:07:02 +0100
Subject: [PATCH 32/38] chore: fix other tests
Signed-off-by: blam
---
plugins/app-backend/package.json | 1 -
.../app-backend/src/service/appPlugin.test.ts | 21 +++----------------
.../package.json | 3 +--
.../catalog-node/src/catalogService.test.ts | 9 +-------
yarn.lock | 9 --------
5 files changed, 5 insertions(+), 38 deletions(-)
diff --git a/plugins/app-backend/package.json b/plugins/app-backend/package.json
index 1f58f64796..d5fbf9f239 100644
--- a/plugins/app-backend/package.json
+++ b/plugins/app-backend/package.json
@@ -56,7 +56,6 @@
"@backstage/cli": "workspace:^",
"@backstage/types": "workspace:^",
"@types/supertest": "^2.0.8",
- "get-port": "^6.1.2",
"mock-fs": "^5.1.0",
"msw": "^0.49.0",
"node-fetch": "^2.6.7",
diff --git a/plugins/app-backend/src/service/appPlugin.test.ts b/plugins/app-backend/src/service/appPlugin.test.ts
index 80408694d6..7c57a5d685 100644
--- a/plugins/app-backend/src/service/appPlugin.test.ts
+++ b/plugins/app-backend/src/service/appPlugin.test.ts
@@ -17,18 +17,14 @@
import mockFs from 'mock-fs';
import { resolve as resolvePath } from 'path';
import fetch from 'node-fetch';
-import { coreServices } from '@backstage/backend-plugin-api';
import { startTestBackend } from '@backstage/backend-test-utils';
import { appPlugin } from './appPlugin';
import {
databaseFactory,
httpRouterFactory,
- rootHttpRouterFactory,
loggerFactory,
rootLoggerFactory,
} from '@backstage/backend-app-api';
-import { ConfigReader } from '@backstage/config';
-import getPort from 'get-port';
describe('appPlugin', () => {
beforeEach(() => {
@@ -48,23 +44,12 @@ describe('appPlugin', () => {
});
it('boots', async () => {
- const port = await getPort();
- await startTestBackend({
+ const { server } = await startTestBackend({
services: [
- [
- coreServices.config,
- new ConfigReader({
- backend: {
- listen: { port },
- database: { client: 'better-sqlite3', connection: ':memory:' },
- },
- }),
- ],
loggerFactory(),
rootLoggerFactory(),
databaseFactory(),
httpRouterFactory(),
- rootHttpRouterFactory(),
],
features: [
appPlugin({
@@ -75,12 +60,12 @@ describe('appPlugin', () => {
});
await expect(
- fetch(`http://localhost:${port}/api/app/derp.html`).then(res =>
+ fetch(`http://localhost:${server.port()}/api/app/derp.html`).then(res =>
res.text(),
),
).resolves.toBe('winning');
await expect(
- fetch(`http://localhost:${port}`).then(res => res.text()),
+ fetch(`http://localhost:${server.port()}`).then(res => res.text()),
).resolves.toBe('winning');
});
});
diff --git a/plugins/catalog-backend-module-incremental-ingestion/package.json b/plugins/catalog-backend-module-incremental-ingestion/package.json
index 06a0ab1c89..a86e27fae4 100644
--- a/plugins/catalog-backend-module-incremental-ingestion/package.json
+++ b/plugins/catalog-backend-module-incremental-ingestion/package.json
@@ -56,8 +56,7 @@
"devDependencies": {
"@backstage/backend-app-api": "workspace:^",
"@backstage/cli": "workspace:^",
- "@backstage/plugin-catalog-backend": "workspace:^",
- "get-port": "^6.1.2"
+ "@backstage/plugin-catalog-backend": "workspace:^"
},
"files": [
"alpha",
diff --git a/plugins/catalog-node/src/catalogService.test.ts b/plugins/catalog-node/src/catalogService.test.ts
index 230af79a88..ec3e5ccf1b 100644
--- a/plugins/catalog-node/src/catalogService.test.ts
+++ b/plugins/catalog-node/src/catalogService.test.ts
@@ -14,11 +14,7 @@
* limitations under the License.
*/
-import { PluginEndpointDiscovery } from '@backstage/backend-common';
-import {
- createBackendModule,
- coreServices,
-} from '@backstage/backend-plugin-api';
+import { createBackendModule } from '@backstage/backend-plugin-api';
import { startTestBackend } from '@backstage/backend-test-utils';
import { CatalogClient } from '@backstage/catalog-client';
import { catalogServiceRef } from './catalogService';
@@ -42,9 +38,6 @@ describe('catalogServiceRef', () => {
});
await startTestBackend({
- services: [
- [coreServices.discovery, {} as unknown as PluginEndpointDiscovery],
- ],
features: [testModule()],
});
});
diff --git a/yarn.lock b/yarn.lock
index f973dee489..0890ba4386 100644
--- a/yarn.lock
+++ b/yarn.lock
@@ -4518,7 +4518,6 @@ __metadata:
express: ^4.17.1
express-promise-router: ^4.1.0
fs-extra: 10.1.0
- get-port: ^6.1.2
globby: ^11.0.0
helmet: ^6.0.0
knex: ^2.0.0
@@ -5117,7 +5116,6 @@ __metadata:
"@types/luxon": ^3.0.0
express: ^4.17.1
express-promise-router: ^4.1.0
- get-port: ^6.1.2
knex: ^2.0.0
lodash: ^4.17.21
luxon: ^3.0.0
@@ -23753,13 +23751,6 @@ __metadata:
languageName: node
linkType: hard
-"get-port@npm:^6.1.2":
- version: 6.1.2
- resolution: "get-port@npm:6.1.2"
- checksum: e3c3d591492a11393455ef220f24c812a28f7da56ec3e4a2512d931a1f196d42850b50ac6138349a44622eda6dc3c0ccd8495cd91376d968e2d9e6f6f849e0a9
- languageName: node
- linkType: hard
-
"get-stdin@npm:^8.0.0":
version: 8.0.0
resolution: "get-stdin@npm:8.0.0"
From ac7fd7a8f52eda593396d6930d603b0bcccff76a Mon Sep 17 00:00:00 2001
From: "renovate[bot]" <29139614+renovate[bot]@users.noreply.github.com>
Date: Wed, 11 Jan 2023 15:12:58 +0000
Subject: [PATCH 33/38] fix(deps): update dependency eslint-plugin-jsx-a11y to
v6.7.0
Signed-off-by: Renovate Bot
---
yarn.lock | 286 ++++++++++++++++++++++++++++++++++++++----------------
1 file changed, 203 insertions(+), 83 deletions(-)
diff --git a/yarn.lock b/yarn.lock
index 08d518048b..46aec0b22f 100644
--- a/yarn.lock
+++ b/yarn.lock
@@ -3290,7 +3290,7 @@ __metadata:
languageName: node
linkType: hard
-"@babel/runtime-corejs3@npm:^7.10.2, @babel/runtime-corejs3@npm:^7.11.2, @babel/runtime-corejs3@npm:^7.18.9":
+"@babel/runtime-corejs3@npm:^7.11.2, @babel/runtime-corejs3@npm:^7.18.9":
version: 7.18.9
resolution: "@babel/runtime-corejs3@npm:7.18.9"
dependencies:
@@ -3300,12 +3300,12 @@ __metadata:
languageName: node
linkType: hard
-"@babel/runtime@npm:^7.0.0, @babel/runtime@npm:^7.1.2, @babel/runtime@npm:^7.10.1, @babel/runtime@npm:^7.10.2, @babel/runtime@npm:^7.12.1, @babel/runtime@npm:^7.12.5, @babel/runtime@npm:^7.14.6, @babel/runtime@npm:^7.15.4, @babel/runtime@npm:^7.18.6, @babel/runtime@npm:^7.18.9, @babel/runtime@npm:^7.20.1, @babel/runtime@npm:^7.3.1, @babel/runtime@npm:^7.4.4, @babel/runtime@npm:^7.5.5, @babel/runtime@npm:^7.6.0, @babel/runtime@npm:^7.7.2, @babel/runtime@npm:^7.7.6, @babel/runtime@npm:^7.8.3, @babel/runtime@npm:^7.8.4, @babel/runtime@npm:^7.8.7, @babel/runtime@npm:^7.9.2":
- version: 7.20.6
- resolution: "@babel/runtime@npm:7.20.6"
+"@babel/runtime@npm:^7.0.0, @babel/runtime@npm:^7.1.2, @babel/runtime@npm:^7.10.1, @babel/runtime@npm:^7.12.1, @babel/runtime@npm:^7.12.5, @babel/runtime@npm:^7.14.6, @babel/runtime@npm:^7.15.4, @babel/runtime@npm:^7.18.6, @babel/runtime@npm:^7.20.1, @babel/runtime@npm:^7.20.7, @babel/runtime@npm:^7.3.1, @babel/runtime@npm:^7.4.4, @babel/runtime@npm:^7.5.5, @babel/runtime@npm:^7.6.0, @babel/runtime@npm:^7.7.2, @babel/runtime@npm:^7.7.6, @babel/runtime@npm:^7.8.3, @babel/runtime@npm:^7.8.4, @babel/runtime@npm:^7.8.7, @babel/runtime@npm:^7.9.2":
+ version: 7.20.7
+ resolution: "@babel/runtime@npm:7.20.7"
dependencies:
regenerator-runtime: ^0.13.11
- checksum: 42a8504db21031b1859fbc0f52d698a3d2f5ada9519eb76c6f96a7e657d8d555732a18fe71ef428a67cc9fc81ca0d3562fb7afdc70549c5fec343190cbaa9b03
+ checksum: 4629ce5c46f06cca9cfb9b7fc00d48003335a809888e2b91ec2069a2dcfbfef738480cff32ba81e0b7c290f8918e5c22ddcf2b710001464ee84ba62c7e32a3a3
languageName: node
linkType: hard
@@ -16828,20 +16828,12 @@ __metadata:
languageName: node
linkType: hard
-"aria-query@npm:^4.2.2":
- version: 4.2.2
- resolution: "aria-query@npm:4.2.2"
+"aria-query@npm:^5.0.0, aria-query@npm:^5.1.3":
+ version: 5.1.3
+ resolution: "aria-query@npm:5.1.3"
dependencies:
- "@babel/runtime": ^7.10.2
- "@babel/runtime-corejs3": ^7.10.2
- checksum: 38401a9a400f26f3dcc24b84997461a16b32869a9893d323602bed8da40a8bcc0243b8d2880e942249a1496cea7a7de769e93d21c0baa439f01e1ee936fed665
- languageName: node
- linkType: hard
-
-"aria-query@npm:^5.0.0":
- version: 5.0.0
- resolution: "aria-query@npm:5.0.0"
- checksum: c41f98866c5a304561ee8cae55856711cddad6f3f85d8cb43cc5f79667078d9b8979ce32d244c1ff364e6463a4d0b6865804a33ccc717fed701b281cf7dc6296
+ deep-equal: ^2.0.5
+ checksum: 929ff95f02857b650fb4cbcd2f41072eee2f46159a6605ea03bf63aa572e35ffdff43d69e815ddc462e16e07de8faba3978afc2813650b4448ee18c9895d982b
languageName: node
linkType: hard
@@ -16852,13 +16844,6 @@ __metadata:
languageName: node
linkType: hard
-"array-filter@npm:^1.0.0":
- version: 1.0.0
- resolution: "array-filter@npm:1.0.0"
- checksum: 467054291f522d7f633b1f5e79aac9008ade50a7354e0178d9ec8f0091ec03bc19a41d4eb22985daf2279a5c27be6d7cf410733539e7fccb0742145b89aca438
- languageName: node
- linkType: hard
-
"array-flatten@npm:1.1.1":
version: 1.1.1
resolution: "array-flatten@npm:1.1.1"
@@ -17114,12 +17099,10 @@ __metadata:
languageName: node
linkType: hard
-"available-typed-arrays@npm:^1.0.2":
- version: 1.0.2
- resolution: "available-typed-arrays@npm:1.0.2"
- dependencies:
- array-filter: ^1.0.0
- checksum: 915a89f31bb9ba51f7396d5ae7d8eff99bc6d6ba9f337068a6916e9ba56fa47bfea7ea69f6f6ad131eac57f76582c721e5f0594e8fea7156894313fc41203fbd
+"available-typed-arrays@npm:^1.0.5":
+ version: 1.0.5
+ resolution: "available-typed-arrays@npm:1.0.5"
+ checksum: 20eb47b3cefd7db027b9bbb993c658abd36d4edd3fe1060e83699a03ee275b0c9b216cc076ff3f2db29073225fb70e7613987af14269ac1fe2a19803ccc97f1a
languageName: node
linkType: hard
@@ -17215,10 +17198,10 @@ __metadata:
languageName: node
linkType: hard
-"axe-core@npm:^4.4.3":
- version: 4.4.3
- resolution: "axe-core@npm:4.4.3"
- checksum: c3ea000d9ace3ba0bc747c8feafc24b0de62a0f7d93021d0f77b19c73fca15341843510f6170da563d51535d6cfb7a46c5fc0ea36170549dbb44b170208450a2
+"axe-core@npm:^4.6.2":
+ version: 4.6.2
+ resolution: "axe-core@npm:4.6.2"
+ checksum: 81523eeaf101a3a129545a936d448d235ecf1f8c0daccdee224d29f63bec716fa38cf1a65c8462548b1f995624277eed790d9d9977ae40ba692c4cadf1196403
languageName: node
linkType: hard
@@ -17273,10 +17256,12 @@ __metadata:
languageName: node
linkType: hard
-"axobject-query@npm:^2.2.0":
- version: 2.2.0
- resolution: "axobject-query@npm:2.2.0"
- checksum: 96b8c7d807ca525f41ad9b286186e2089b561ba63a6d36c3e7d73dc08150714660995c7ad19cda05784458446a0793b45246db45894631e13853f48c1aa3117f
+"axobject-query@npm:^3.1.1":
+ version: 3.1.1
+ resolution: "axobject-query@npm:3.1.1"
+ dependencies:
+ deep-equal: ^2.0.5
+ checksum: c12a5da10dc7bab75e1cda9b6a3b5fcf10eba426ddf1a17b71ef65a434ed707ede7d1c4f013ba1609e970bc8c0cddac01365080d376204314e9b294719acd8a5
languageName: node
linkType: hard
@@ -20492,6 +20477,31 @@ __metadata:
languageName: node
linkType: hard
+"deep-equal@npm:^2.0.5":
+ version: 2.2.0
+ resolution: "deep-equal@npm:2.2.0"
+ dependencies:
+ call-bind: ^1.0.2
+ es-get-iterator: ^1.1.2
+ get-intrinsic: ^1.1.3
+ is-arguments: ^1.1.1
+ is-array-buffer: ^3.0.1
+ is-date-object: ^1.0.5
+ is-regex: ^1.1.4
+ is-shared-array-buffer: ^1.0.2
+ isarray: ^2.0.5
+ object-is: ^1.1.5
+ object-keys: ^1.1.1
+ object.assign: ^4.1.4
+ regexp.prototype.flags: ^1.4.3
+ side-channel: ^1.0.4
+ which-boxed-primitive: ^1.0.2
+ which-collection: ^1.0.1
+ which-typed-array: ^1.1.9
+ checksum: 46a34509d2766d6c6dc5aec4756089cf0cc137e46787e91f08f1ee0bb570d874f19f0493146907df0cf18aed4a7b4b50f6f62c899240a76c323f057528b122e3
+ languageName: node
+ linkType: hard
+
"deep-extend@npm:0.6.0, deep-extend@npm:^0.6.0":
version: 0.6.0
resolution: "deep-extend@npm:0.6.0"
@@ -21394,7 +21404,7 @@ __metadata:
languageName: node
linkType: hard
-"es-abstract@npm:^1.18.0-next.1, es-abstract@npm:^1.18.0-next.2, es-abstract@npm:^1.19.0, es-abstract@npm:^1.19.2, es-abstract@npm:^1.19.5, es-abstract@npm:^1.20.4":
+"es-abstract@npm:^1.19.0, es-abstract@npm:^1.19.2, es-abstract@npm:^1.19.5, es-abstract@npm:^1.20.4":
version: 1.20.4
resolution: "es-abstract@npm:1.20.4"
dependencies:
@@ -21426,6 +21436,22 @@ __metadata:
languageName: node
linkType: hard
+"es-get-iterator@npm:^1.1.2":
+ version: 1.1.2
+ resolution: "es-get-iterator@npm:1.1.2"
+ dependencies:
+ call-bind: ^1.0.2
+ get-intrinsic: ^1.1.0
+ has-symbols: ^1.0.1
+ is-arguments: ^1.1.0
+ is-map: ^2.0.2
+ is-set: ^2.0.2
+ is-string: ^1.0.5
+ isarray: ^2.0.5
+ checksum: f75e66acb6a45686fa08b3ade9c9421a70d36a0c43ed4363e67f4d7aab2226cb73dd977cb48abbaf75721b946d3cd810682fcf310c7ad0867802fbf929b17dcf
+ languageName: node
+ linkType: hard
+
"es-module-lexer@npm:^0.9.0, es-module-lexer@npm:^0.9.3":
version: 0.9.3
resolution: "es-module-lexer@npm:0.9.3"
@@ -21960,25 +21986,28 @@ __metadata:
linkType: hard
"eslint-plugin-jsx-a11y@npm:^6.5.1":
- version: 6.6.1
- resolution: "eslint-plugin-jsx-a11y@npm:6.6.1"
+ version: 6.7.0
+ resolution: "eslint-plugin-jsx-a11y@npm:6.7.0"
dependencies:
- "@babel/runtime": ^7.18.9
- aria-query: ^4.2.2
- array-includes: ^3.1.5
+ "@babel/runtime": ^7.20.7
+ aria-query: ^5.1.3
+ array-includes: ^3.1.6
+ array.prototype.flatmap: ^1.3.1
ast-types-flow: ^0.0.7
- axe-core: ^4.4.3
- axobject-query: ^2.2.0
+ axe-core: ^4.6.2
+ axobject-query: ^3.1.1
damerau-levenshtein: ^1.0.8
emoji-regex: ^9.2.2
has: ^1.0.3
- jsx-ast-utils: ^3.3.2
- language-tags: ^1.0.5
+ jsx-ast-utils: ^3.3.3
+ language-tags: =1.0.5
minimatch: ^3.1.2
+ object.entries: ^1.1.6
+ object.fromentries: ^2.0.6
semver: ^6.3.0
peerDependencies:
eslint: ^3 || ^4 || ^5 || ^6 || ^7 || ^8
- checksum: baae7377f0e25a0cc9b34dc333a3dc6ead9ee8365e445451eff554c3ca267a0a6cb88127fe90395c578ab1b92cfed246aef7dc8d2b48b603389e10181799e144
+ checksum: b7ea212bcf84912d264229e5e3cf255bc95a1193de1c7453d275a7afc959ce679c1bffb77cfd3d17f9b7105f41e0f62c8edb7f6d76985c79647edaa9f08aa814
languageName: node
linkType: hard
@@ -23264,7 +23293,16 @@ __metadata:
languageName: node
linkType: hard
-"foreach@npm:^2.0.4, foreach@npm:^2.0.5":
+"for-each@npm:^0.3.3":
+ version: 0.3.3
+ resolution: "for-each@npm:0.3.3"
+ dependencies:
+ is-callable: ^1.1.3
+ checksum: 6c48ff2bc63362319c65e2edca4a8e1e3483a2fabc72fbe7feaf8c73db94fc7861bd53bc02c8a66a0c1dd709da6b04eec42e0abdd6b40ce47305ae92a25e5d28
+ languageName: node
+ linkType: hard
+
+"foreach@npm:^2.0.4":
version: 2.0.5
resolution: "foreach@npm:2.0.5"
checksum: dab4fbfef0b40b69ee5eab81bcb9626b8fa8b3469c8cfa26480f3e5e1ee08c40eae07048c9a967c65aeda26e774511ccc70b3f10a604c01753c6ef24361f0fc8
@@ -24071,6 +24109,15 @@ __metadata:
languageName: node
linkType: hard
+"gopd@npm:^1.0.1":
+ version: 1.0.1
+ resolution: "gopd@npm:1.0.1"
+ dependencies:
+ get-intrinsic: ^1.1.3
+ checksum: a5ccfb8806e0917a94e0b3de2af2ea4979c1da920bc381667c260e00e7cafdbe844e2cb9c5bcfef4e5412e8bf73bab837285bc35c7ba73aaaf0134d4583393a6
+ languageName: node
+ linkType: hard
+
"got@npm:^11.8.3":
version: 11.8.5
resolution: "got@npm:11.8.5"
@@ -25377,10 +25424,24 @@ __metadata:
languageName: node
linkType: hard
-"is-arguments@npm:^1.0.4":
- version: 1.0.4
- resolution: "is-arguments@npm:1.0.4"
- checksum: a40ce1580cbb28b67790afe91d9c39a9016f165e724021f2c61da016d7382a1b04a202d9d4ea1c8b5d7fda7c15144aa5c4e92ea4ed0896e2b95f4f665a966cd5
+"is-arguments@npm:^1.0.4, is-arguments@npm:^1.1.0, is-arguments@npm:^1.1.1":
+ version: 1.1.1
+ resolution: "is-arguments@npm:1.1.1"
+ dependencies:
+ call-bind: ^1.0.2
+ has-tostringtag: ^1.0.0
+ checksum: 7f02700ec2171b691ef3e4d0e3e6c0ba408e8434368504bb593d0d7c891c0dbfda6d19d30808b904a6cb1929bca648c061ba438c39f296c2a8ca083229c49f27
+ languageName: node
+ linkType: hard
+
+"is-array-buffer@npm:^3.0.1":
+ version: 3.0.1
+ resolution: "is-array-buffer@npm:3.0.1"
+ dependencies:
+ call-bind: ^1.0.2
+ get-intrinsic: ^1.1.3
+ is-typed-array: ^1.1.10
+ checksum: f26ab87448e698285daf707e52a533920449f7abf63714140ffab9d5571aa5a71ac2fa2677e8b793ad0d5d3e40078d4d2c8a0ab39c957e3cfc6513bb6c9dfdc9
languageName: node
linkType: hard
@@ -25442,7 +25503,7 @@ __metadata:
languageName: node
linkType: hard
-"is-callable@npm:^1.1.4, is-callable@npm:^1.2.7":
+"is-callable@npm:^1.1.3, is-callable@npm:^1.1.4, is-callable@npm:^1.2.7":
version: 1.2.7
resolution: "is-callable@npm:1.2.7"
checksum: 61fd57d03b0d984e2ed3720fb1c7a897827ea174bd44402878e059542ea8c4aeedee0ea0985998aa5cc2736b2fa6e271c08587addb5b3959ac52cf665173d1ac
@@ -25480,7 +25541,7 @@ __metadata:
languageName: node
linkType: hard
-"is-date-object@npm:^1.0.1":
+"is-date-object@npm:^1.0.1, is-date-object@npm:^1.0.5":
version: 1.0.5
resolution: "is-date-object@npm:1.0.5"
dependencies:
@@ -25626,6 +25687,13 @@ __metadata:
languageName: node
linkType: hard
+"is-map@npm:^2.0.1, is-map@npm:^2.0.2":
+ version: 2.0.2
+ resolution: "is-map@npm:2.0.2"
+ checksum: ace3d0ecd667bbdefdb1852de601268f67f2db725624b1958f279316e13fecb8fa7df91fd60f690d7417b4ec180712f5a7ee967008e27c65cfd475cc84337728
+ languageName: node
+ linkType: hard
+
"is-module@npm:^1.0.0":
version: 1.0.0
resolution: "is-module@npm:1.0.0"
@@ -25800,6 +25868,13 @@ __metadata:
languageName: node
linkType: hard
+"is-set@npm:^2.0.1, is-set@npm:^2.0.2":
+ version: 2.0.2
+ resolution: "is-set@npm:2.0.2"
+ checksum: b64343faf45e9387b97a6fd32be632ee7b269bd8183701f3b3f5b71a7cf00d04450ed8669d0bd08753e08b968beda96fca73a10fd0ff56a32603f64deba55a57
+ languageName: node
+ linkType: hard
+
"is-shared-array-buffer@npm:^1.0.2":
version: 1.0.2
resolution: "is-shared-array-buffer@npm:1.0.2"
@@ -25866,16 +25941,16 @@ __metadata:
languageName: node
linkType: hard
-"is-typed-array@npm:^1.1.3":
- version: 1.1.5
- resolution: "is-typed-array@npm:1.1.5"
+"is-typed-array@npm:^1.1.10, is-typed-array@npm:^1.1.3":
+ version: 1.1.10
+ resolution: "is-typed-array@npm:1.1.10"
dependencies:
- available-typed-arrays: ^1.0.2
+ available-typed-arrays: ^1.0.5
call-bind: ^1.0.2
- es-abstract: ^1.18.0-next.2
- foreach: ^2.0.5
- has-symbols: ^1.0.1
- checksum: ba435c83dc1dc0f205c0169f7e93a082816c6b261631a55e473f6f4e18fdf76c1997b326e2e63ae6139e0f75fb47d76252fc76ce75e6b2a74aa41c39743774cb
+ for-each: ^0.3.3
+ gopd: ^1.0.1
+ has-tostringtag: ^1.0.0
+ checksum: aac6ecb59d4c56a1cdeb69b1f129154ef462bbffe434cb8a8235ca89b42f258b7ae94073c41b3cb7bce37f6a1733ad4499f07882d5d5093a7ba84dfc4ebb8017
languageName: node
linkType: hard
@@ -25918,6 +25993,13 @@ __metadata:
languageName: node
linkType: hard
+"is-weakmap@npm:^2.0.1":
+ version: 2.0.1
+ resolution: "is-weakmap@npm:2.0.1"
+ checksum: 1222bb7e90c32bdb949226e66d26cb7bce12e1e28e3e1b40bfa6b390ba3e08192a8664a703dff2a00a84825f4e022f9cd58c4599ff9981ab72b1d69479f4f7f6
+ languageName: node
+ linkType: hard
+
"is-weakref@npm:^1.0.2":
version: 1.0.2
resolution: "is-weakref@npm:1.0.2"
@@ -25927,6 +26009,16 @@ __metadata:
languageName: node
linkType: hard
+"is-weakset@npm:^2.0.1":
+ version: 2.0.2
+ resolution: "is-weakset@npm:2.0.2"
+ dependencies:
+ call-bind: ^1.0.2
+ get-intrinsic: ^1.1.1
+ checksum: 5d8698d1fa599a0635d7ca85be9c26d547b317ed8fd83fc75f03efbe75d50001b5eececb1e9971de85fcde84f69ae6f8346bc92d20d55d46201d328e4c74a367
+ languageName: node
+ linkType: hard
+
"is-windows@npm:^1.0.0, is-windows@npm:^1.0.1":
version: 1.0.2
resolution: "is-windows@npm:1.0.2"
@@ -25964,6 +26056,13 @@ __metadata:
languageName: node
linkType: hard
+"isarray@npm:^2.0.5":
+ version: 2.0.5
+ resolution: "isarray@npm:2.0.5"
+ checksum: bd5bbe4104438c4196ba58a54650116007fa0262eccef13a4c55b2e09a5b36b59f1e75b9fcc49883dd9d4953892e6fc007eef9e9155648ceea036e184b0f930a
+ languageName: node
+ linkType: hard
+
"isbinaryfile@npm:^4.0.10, isbinaryfile@npm:^4.0.8":
version: 4.0.10
resolution: "isbinaryfile@npm:4.0.10"
@@ -27487,13 +27586,13 @@ __metadata:
languageName: node
linkType: hard
-"jsx-ast-utils@npm:^2.4.1 || ^3.0.0, jsx-ast-utils@npm:^3.3.2":
- version: 3.3.2
- resolution: "jsx-ast-utils@npm:3.3.2"
+"jsx-ast-utils@npm:^2.4.1 || ^3.0.0, jsx-ast-utils@npm:^3.3.3":
+ version: 3.3.3
+ resolution: "jsx-ast-utils@npm:3.3.3"
dependencies:
array-includes: ^3.1.5
- object.assign: ^4.1.2
- checksum: 61d4596d44480afc03ae0a7ebb272aa6603dc4c3645805dea0fc8d9f0693542cd0959f3ba7c0c9b16c13dd5a900c7c4310108bada273132a8355efe3fed22064
+ object.assign: ^4.1.3
+ checksum: a2ed78cac49a0f0c4be8b1eafe3c5257a1411341d8e7f1ac740debae003de04e5f6372bfcfbd9d082e954ffd99aac85bcda85b7c6bc11609992483f4cdc0f745
languageName: node
linkType: hard
@@ -27682,7 +27781,7 @@ __metadata:
languageName: node
linkType: hard
-"language-tags@npm:^1.0.5":
+"language-tags@npm:=1.0.5":
version: 1.0.5
resolution: "language-tags@npm:1.0.5"
dependencies:
@@ -30483,6 +30582,16 @@ __metadata:
languageName: node
linkType: hard
+"object-is@npm:^1.1.5":
+ version: 1.1.5
+ resolution: "object-is@npm:1.1.5"
+ dependencies:
+ call-bind: ^1.0.2
+ define-properties: ^1.1.3
+ checksum: 989b18c4cba258a6b74dc1d74a41805c1a1425bce29f6cabb50dcb1a6a651ea9104a1b07046739a49a5bb1bc49727bcb00efd5c55f932f6ea04ec8927a7901fe
+ languageName: node
+ linkType: hard
+
"object-keys@npm:^1.1.1":
version: 1.1.1
resolution: "object-keys@npm:1.1.1"
@@ -30490,7 +30599,7 @@ __metadata:
languageName: node
linkType: hard
-"object.assign@npm:^4.1.0, object.assign@npm:^4.1.2, object.assign@npm:^4.1.4":
+"object.assign@npm:^4.1.0, object.assign@npm:^4.1.3, object.assign@npm:^4.1.4":
version: 4.1.4
resolution: "object.assign@npm:4.1.4"
dependencies:
@@ -38606,6 +38715,18 @@ __metadata:
languageName: node
linkType: hard
+"which-collection@npm:^1.0.1":
+ version: 1.0.1
+ resolution: "which-collection@npm:1.0.1"
+ dependencies:
+ is-map: ^2.0.1
+ is-set: ^2.0.1
+ is-weakmap: ^2.0.1
+ is-weakset: ^2.0.1
+ checksum: c815bbd163107ef9cb84f135e6f34453eaf4cca994e7ba85ddb0d27cea724c623fae2a473ceccfd5549c53cc65a5d82692de418166df3f858e1e5dc60818581c
+ languageName: node
+ linkType: hard
+
"which-module@npm:^1.0.0":
version: 1.0.0
resolution: "which-module@npm:1.0.0"
@@ -38630,18 +38751,17 @@ __metadata:
languageName: node
linkType: hard
-"which-typed-array@npm:^1.1.2":
- version: 1.1.4
- resolution: "which-typed-array@npm:1.1.4"
+"which-typed-array@npm:^1.1.2, which-typed-array@npm:^1.1.9":
+ version: 1.1.9
+ resolution: "which-typed-array@npm:1.1.9"
dependencies:
- available-typed-arrays: ^1.0.2
- call-bind: ^1.0.0
- es-abstract: ^1.18.0-next.1
- foreach: ^2.0.5
- function-bind: ^1.1.1
- has-symbols: ^1.0.1
- is-typed-array: ^1.1.3
- checksum: 369597a623b0e446eb7b6ce9e2f515c2f6a0b3f5040b9c592d9ed07fb3357a90ab45311230f7e687cf0f0d410b47e98fba620dbb7eece9f556309a3448b4fa3e
+ available-typed-arrays: ^1.0.5
+ call-bind: ^1.0.2
+ for-each: ^0.3.3
+ gopd: ^1.0.1
+ has-tostringtag: ^1.0.0
+ is-typed-array: ^1.1.10
+ checksum: fe0178ca44c57699ca2c0e657b64eaa8d2db2372a4e2851184f568f98c478ae3dc3fdb5f7e46c384487046b0cf9e23241423242b277e03e8ba3dabc7c84c98ef
languageName: node
linkType: hard
From 9a6263105669a0439c05b80347283ddd3f7db66d Mon Sep 17 00:00:00 2001
From: Jussi Hallila
Date: Wed, 11 Jan 2023 16:21:37 +0100
Subject: [PATCH 34/38] Change name of the type of passed in option object.
Signed-off-by: Jussi Hallila
---
plugins/tech-insights-backend/api-report.md | 12 ++++++------
plugins/tech-insights-backend/src/index.ts | 2 +-
.../src/service/persistence/persistenceContext.ts | 6 +++---
3 files changed, 10 insertions(+), 10 deletions(-)
diff --git a/plugins/tech-insights-backend/api-report.md b/plugins/tech-insights-backend/api-report.md
index 7d1d7583ae..a757f0d67c 100644
--- a/plugins/tech-insights-backend/api-report.md
+++ b/plugins/tech-insights-backend/api-report.md
@@ -30,11 +30,6 @@ export const buildTechInsightsContext: <
options: TechInsightsOptions,
) => Promise>;
-// @public
-export type CreateDatabaseOptions = {
- logger: Logger;
-};
-
// @public
export function createFactRetrieverRegistration(
options: FactRetrieverRegistrationOptions,
@@ -85,7 +80,7 @@ export interface FactRetrieverRegistry {
// @public
export const initializePersistenceContext: (
database: PluginDatabaseManager,
- options?: CreateDatabaseOptions,
+ options?: PersistenceContextOptions,
) => Promise;
// @public
@@ -93,6 +88,11 @@ export type PersistenceContext = {
techInsightsStore: TechInsightsStore;
};
+// @public
+export type PersistenceContextOptions = {
+ logger: Logger;
+};
+
// @public
export interface RouterOptions<
CheckType extends TechInsightCheck,
diff --git a/plugins/tech-insights-backend/src/index.ts b/plugins/tech-insights-backend/src/index.ts
index 2071acd263..e9e037cce1 100644
--- a/plugins/tech-insights-backend/src/index.ts
+++ b/plugins/tech-insights-backend/src/index.ts
@@ -26,7 +26,7 @@ export type {
export type { FactRetrieverEngine } from './service/fact/FactRetrieverEngine';
export type {
PersistenceContext,
- CreateDatabaseOptions,
+ PersistenceContextOptions,
} from './service/persistence/persistenceContext';
export { createFactRetrieverRegistration } from './service/fact/createFactRetriever';
export type { FactRetrieverRegistry } from './service/fact/FactRetrieverRegistry';
diff --git a/plugins/tech-insights-backend/src/service/persistence/persistenceContext.ts b/plugins/tech-insights-backend/src/service/persistence/persistenceContext.ts
index 87efcd8a3d..07badb038c 100644
--- a/plugins/tech-insights-backend/src/service/persistence/persistenceContext.ts
+++ b/plugins/tech-insights-backend/src/service/persistence/persistenceContext.ts
@@ -41,11 +41,11 @@ export type PersistenceContext = {
*
* @public
*/
-export type CreateDatabaseOptions = {
+export type PersistenceContextOptions = {
logger: Logger;
};
-const defaultOptions: CreateDatabaseOptions = {
+const defaultOptions: PersistenceContextOptions = {
logger: getVoidLogger(),
};
@@ -56,7 +56,7 @@ const defaultOptions: CreateDatabaseOptions = {
*/
export const initializePersistenceContext = async (
database: PluginDatabaseManager,
- options: CreateDatabaseOptions = defaultOptions,
+ options: PersistenceContextOptions = defaultOptions,
): Promise => {
const client = await database.getClient();
From 6398dd7a5b1a7c9f731d2d661eeef23c752efed8 Mon Sep 17 00:00:00 2001
From: "renovate[bot]" <29139614+renovate[bot]@users.noreply.github.com>
Date: Wed, 11 Jan 2023 16:06:26 +0000
Subject: [PATCH 35/38] fix(deps): update dependency eslint-plugin-react to
v7.32.0
Signed-off-by: Renovate Bot
---
yarn.lock | 40 +++++++++++++++++++++++-----------------
1 file changed, 23 insertions(+), 17 deletions(-)
diff --git a/yarn.lock b/yarn.lock
index 9d1f8eb5eb..af95bd40cf 100644
--- a/yarn.lock
+++ b/yarn.lock
@@ -22072,8 +22072,8 @@ __metadata:
linkType: hard
"eslint-plugin-react@npm:^7.28.0":
- version: 7.31.11
- resolution: "eslint-plugin-react@npm:7.31.11"
+ version: 7.32.0
+ resolution: "eslint-plugin-react@npm:7.32.0"
dependencies:
array-includes: ^3.1.6
array.prototype.flatmap: ^1.3.1
@@ -22087,12 +22087,12 @@ __metadata:
object.hasown: ^1.1.2
object.values: ^1.1.6
prop-types: ^15.8.1
- resolve: ^2.0.0-next.3
+ resolve: ^2.0.0-next.4
semver: ^6.3.0
string.prototype.matchall: ^4.0.8
peerDependencies:
eslint: ^3 || ^4 || ^5 || ^6 || ^7 || ^8
- checksum: a3d612f6647bef33cf2a67c81a6b37b42c075300ed079cffecf5fb475c0d6ab855c1de340d1cbf361a0126429fb906dda597527235d2d12c4404453dbc712fc6
+ checksum: b81ce2623b50a936287d8e21997bd855094e643856c99b42a9f0c10e1c7b123e469c3d75f77df9eefb719fee2b47a763862f1cdca1e7cc26edc7cde2fb8cba87
languageName: node
linkType: hard
@@ -25555,7 +25555,7 @@ __metadata:
languageName: node
linkType: hard
-"is-core-module@npm:^2.1.0, is-core-module@npm:^2.2.0, is-core-module@npm:^2.8.1, is-core-module@npm:^2.9.0":
+"is-core-module@npm:^2.1.0, is-core-module@npm:^2.8.1, is-core-module@npm:^2.9.0":
version: 2.10.0
resolution: "is-core-module@npm:2.10.0"
dependencies:
@@ -34361,13 +34361,16 @@ __metadata:
languageName: node
linkType: hard
-"resolve@npm:^2.0.0-next.3":
- version: 2.0.0-next.3
- resolution: "resolve@npm:2.0.0-next.3"
+"resolve@npm:^2.0.0-next.4":
+ version: 2.0.0-next.4
+ resolution: "resolve@npm:2.0.0-next.4"
dependencies:
- is-core-module: ^2.2.0
- path-parse: ^1.0.6
- checksum: f34b3b93ada77d64a6d590c06a83e198f3a827624c4ec972260905fa6c4d612164fbf0200d16d2beefea4ad1755b001f4a9a1293d8fc2322a8f7d6bf692c4ff5
+ is-core-module: ^2.9.0
+ path-parse: ^1.0.7
+ supports-preserve-symlinks-flag: ^1.0.0
+ bin:
+ resolve: bin/resolve
+ checksum: c438ac9a650f2030fd074219d7f12ceb983b475da2d89ad3d6dd05fbf6b7a0a8cd37d4d10b43cb1f632bc19f22246ab7f36ebda54d84a29bfb2910a0680906d3
languageName: node
linkType: hard
@@ -34403,13 +34406,16 @@ __metadata:
languageName: node
linkType: hard
-"resolve@patch:resolve@^2.0.0-next.3#~builtin":
- version: 2.0.0-next.3
- resolution: "resolve@patch:resolve@npm%3A2.0.0-next.3#~builtin::version=2.0.0-next.3&hash=07638b"
+"resolve@patch:resolve@^2.0.0-next.4#~builtin":
+ version: 2.0.0-next.4
+ resolution: "resolve@patch:resolve@npm%3A2.0.0-next.4#~builtin::version=2.0.0-next.4&hash=07638b"
dependencies:
- is-core-module: ^2.2.0
- path-parse: ^1.0.6
- checksum: 21684b4d99a4877337cdbd5484311c811b3e8910edb5d868eec85c6e6550b0f570d911f9a384f9e176172d6713f2715bd0b0887fa512cb8c6aeece018de6a9f8
+ is-core-module: ^2.9.0
+ path-parse: ^1.0.7
+ supports-preserve-symlinks-flag: ^1.0.0
+ bin:
+ resolve: bin/resolve
+ checksum: 4bf9f4f8a458607af90518ff73c67a4bc1a38b5a23fef2bb0ccbd45e8be89820a1639b637b0ba377eb2be9eedfb1739a84cde24fe4cd670c8207d8fea922b011
languageName: node
linkType: hard
From 2673cb3b5add1195c0a1eaea988fd74f071814b7 Mon Sep 17 00:00:00 2001
From: "renovate[bot]" <29139614+renovate[bot]@users.noreply.github.com>
Date: Wed, 11 Jan 2023 16:45:08 +0000
Subject: [PATCH 36/38] fix(deps): update dependency
fork-ts-checker-webpack-plugin to v7.3.0
Signed-off-by: Renovate Bot
---
yarn.lock | 6 +++---
1 file changed, 3 insertions(+), 3 deletions(-)
diff --git a/yarn.lock b/yarn.lock
index af95bd40cf..14835db18d 100644
--- a/yarn.lock
+++ b/yarn.lock
@@ -23371,8 +23371,8 @@ __metadata:
linkType: hard
"fork-ts-checker-webpack-plugin@npm:^7.0.0-alpha.8":
- version: 7.2.14
- resolution: "fork-ts-checker-webpack-plugin@npm:7.2.14"
+ version: 7.3.0
+ resolution: "fork-ts-checker-webpack-plugin@npm:7.3.0"
dependencies:
"@babel/code-frame": ^7.16.7
chalk: ^4.1.2
@@ -23393,7 +23393,7 @@ __metadata:
peerDependenciesMeta:
vue-template-compiler:
optional: true
- checksum: bf4b44e606677da14c5b8127693897003607e7f13ed93a92991665aea5ad5aa3f5629c022d95dbf9380b40bfc02d34fa42857f298525c7688194d1e94f2a2850
+ checksum: 49c2af801e264349a3fdf0afe4ad33065960c43bd7e56c8351a5e0d32c8c54146cc89d6a0b70b1e0f810de96787bd0c7fd275cc8727a9aea1a077c53de99659a
languageName: node
linkType: hard
From ee0d9b5c4e14062f055c64420de1648f2d94bcce Mon Sep 17 00:00:00 2001
From: Carlos Esteban Lopez
Date: Wed, 11 Jan 2023 13:52:48 -0500
Subject: [PATCH 37/38] fix: Remove duplicated Typography import from master
merge
Signed-off-by: Carlos Esteban Lopez
---
plugins/fossa/src/components/FossaCard/FossaCard.tsx | 1 -
1 file changed, 1 deletion(-)
diff --git a/plugins/fossa/src/components/FossaCard/FossaCard.tsx b/plugins/fossa/src/components/FossaCard/FossaCard.tsx
index a8dc5f46cc..c31f5b9d0c 100644
--- a/plugins/fossa/src/components/FossaCard/FossaCard.tsx
+++ b/plugins/fossa/src/components/FossaCard/FossaCard.tsx
@@ -16,7 +16,6 @@
import { useEntity } from '@backstage/plugin-catalog-react';
import { Grid, Tooltip } from '@material-ui/core';
-import Typography from '@material-ui/core/Typography';
import { makeStyles } from '@material-ui/core/styles';
import Typography from '@material-ui/core/Typography';
import { DateTime } from 'luxon';
From 69e1e5bb6354029b4e557513583e7ad3cd041bb1 Mon Sep 17 00:00:00 2001
From: Johan Haals
Date: Thu, 12 Jan 2023 13:38:00 +0100
Subject: [PATCH 38/38] chore: trim slashes with lodash
Signed-off-by: Johan Haals
---
packages/backend-app-api/package.json | 1 +
.../implementations/rootHttpRouter/DefaultRootHttpRouter.ts | 3 ++-
yarn.lock | 1 +
3 files changed, 4 insertions(+), 1 deletion(-)
diff --git a/packages/backend-app-api/package.json b/packages/backend-app-api/package.json
index a6ecb5f455..01eaeaecaf 100644
--- a/packages/backend-app-api/package.json
+++ b/packages/backend-app-api/package.json
@@ -48,6 +48,7 @@
"express-promise-router": "^4.1.0",
"fs-extra": "10.1.0",
"helmet": "^6.0.0",
+ "lodash": "^4.17.21",
"minimatch": "^5.0.0",
"morgan": "^1.10.0",
"node-forge": "^1.3.1",
diff --git a/packages/backend-app-api/src/services/implementations/rootHttpRouter/DefaultRootHttpRouter.ts b/packages/backend-app-api/src/services/implementations/rootHttpRouter/DefaultRootHttpRouter.ts
index 2acbb3833a..0a144af494 100644
--- a/packages/backend-app-api/src/services/implementations/rootHttpRouter/DefaultRootHttpRouter.ts
+++ b/packages/backend-app-api/src/services/implementations/rootHttpRouter/DefaultRootHttpRouter.ts
@@ -16,9 +16,10 @@
import { RootHttpRouterService } from '@backstage/backend-plugin-api';
import { Handler, Router } from 'express';
+import trimEnd from 'lodash/trimEnd';
function normalizePath(path: string): string {
- return path.replace(/\/*$/, '/');
+ return `${trimEnd(path, '/')}/`;
}
/**
diff --git a/yarn.lock b/yarn.lock
index 0890ba4386..cdb2142850 100644
--- a/yarn.lock
+++ b/yarn.lock
@@ -3400,6 +3400,7 @@ __metadata:
fs-extra: 10.1.0
helmet: ^6.0.0
http-errors: ^2.0.0
+ lodash: ^4.17.21
minimatch: ^5.0.0
morgan: ^1.10.0
node-forge: ^1.3.1