Implement Tech Insights backend

* Add common types and interfaces for Tech Insights. Exposing components needed to use and modify tech-insights-backend module and to implement individual Fact Retrievers, Fact Checkers and their persistence options.

* Implement a framework to run fact retrievers and store fact data into the database. Add migration scripts to create a new database for `tech_insights`.

* Create a default implementation of a FactChecker enabling users to construct checks and run them and generate scorecards based on checks.

* To be able to use tech insights in your application you need to implement `FactRetriever`s to retrieve and return data for facts and register them to the tech-insights-backend. If you want to use fact checking functionality, you need to create `check`s and register them to an implementation of a `FactChecker`.

For more information see documentation on the README.md files of the respective packages.

Signed-off-by: Jussi Hallila <jussi@hallila.com>

packages/backend/package.json

@@ -48,6 +48,9 @@
     "@backstage/plugin-search-backend-module-elasticsearch": "^0.0.4",
     "@backstage/plugin-search-backend-module-pg": "^0.2.1",
     "@backstage/plugin-techdocs-backend": "^0.10.5",
+    "@backstage/plugin-tech-insights-backend": "^0.1.0",
+    "@backstage/plugin-tech-insights-common": "^0.1.0",
+    "@backstage/plugin-tech-insights-backend-module-jsonfc": "^0.1.0",
     "@backstage/plugin-todo-backend": "^0.1.13",
     "@gitbeaker/node": "^30.2.0",
     "@octokit/rest": "^18.5.3",

packages/backend/src/index.ts

@@ -53,6 +53,7 @@ import graphql from './plugins/graphql';
 import app from './plugins/app';
 import badges from './plugins/badges';
 import jenkins from './plugins/jenkins';
+import techInsights from './plugins/techInsights';
 import { PluginEnvironment } from './types';
 
 function makeCreateEnv(config: Config) {
@@ -107,12 +108,16 @@ async function main() {
   const appEnv = useHotMemoize(module, () => createEnv('app'));
   const badgesEnv = useHotMemoize(module, () => createEnv('badges'));
   const jenkinsEnv = useHotMemoize(module, () => createEnv('jenkins'));
+  const techInsightsEnv = useHotMemoize(module, () =>
+    createEnv('tech_insights'),
+  );
 
   const apiRouter = Router();
   apiRouter.use('/catalog', await catalog(catalogEnv));
   apiRouter.use('/code-coverage', await codeCoverage(codeCoverageEnv));
   apiRouter.use('/rollbar', await rollbar(rollbarEnv));
   apiRouter.use('/scaffolder', await scaffolder(scaffolderEnv));
+  apiRouter.use('/tech-insights', await techInsights(techInsightsEnv));
   apiRouter.use('/auth', await auth(authEnv));
   apiRouter.use('/azure-devops', await azureDevOps(azureDevOpsEnv));
   apiRouter.use('/search', await search(searchEnv));

packages/backend/src/plugins/techInsights.ts

@@ -0,0 +1,47 @@
+/*
+ * Copyright 2020 The Backstage Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import {
+  createRouter,
+  DefaultTechInsightsBuilder,
+} from '@backstage/plugin-tech-insights-backend';
+import { Router } from 'express';
+import { PluginEnvironment } from '../types';
+import { JsonRulesEngineFactCheckerFactory } from '@backstage/plugin-tech-insights-backend-module-jsonfc';
+
+export default async function createPlugin({
+  logger,
+  config,
+  discovery,
+  database,
+}: PluginEnvironment): Promise<Router> {
+  const builder = new DefaultTechInsightsBuilder({
+    logger,
+    config,
+    database,
+    discovery,
+    factRetrievers: [],
+    factCheckerFactory: new JsonRulesEngineFactCheckerFactory({
+      checks: [],
+      logger,
+    }),
+  });
+
+  return await createRouter({
+    ...(await builder.build()),
+    logger,
+    config,
+  });
+}