Introduce Lighthouse Backend with Scheduling of Audits

Signed-off-by: Dominik Pfaffenbauer <dominik@pfaffenbauer.at>

plugins/lighthouse-backend/src/config.ts

@@ -0,0 +1,86 @@
+/*
+ * 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 { Config } from '@backstage/config';
+import { HumanDuration as HumanDuration } from '@backstage/types';
+
+export interface LighthouseAuditScheduleConfig {
+  schedule: HumanDuration;
+  timeout: HumanDuration;
+  auditDetail: HumanDuration;
+}
+
+/** @public */
+export type LighthouseAuditSchedule = {
+  getSchedule: () => HumanDuration;
+  getTimeout: () => HumanDuration;
+};
+
+/** @public */
+export class LighthouseAuditScheduleImpl implements LighthouseAuditSchedule {
+  static fromConfig(config: Config) {
+    const lighthouse = config.getOptionalConfig('lighthouse');
+
+    let schedule: HumanDuration = { days: 1 };
+    let timeout: HumanDuration = {};
+
+    if (lighthouse) {
+      const scheduleConfig = lighthouse.getOptionalConfig('schedule');
+      const timeoutConfig = lighthouse.getOptionalConfig('timeout');
+
+      if (scheduleConfig) {
+        schedule = {
+          milliseconds: scheduleConfig.getOptionalNumber('milliseconds'),
+          seconds: scheduleConfig.getOptionalNumber('seconds'),
+          minutes: scheduleConfig.getOptionalNumber('minutes'),
+          hours: scheduleConfig.getOptionalNumber('hours'),
+          days: scheduleConfig.getOptionalNumber('days'),
+          weeks: scheduleConfig.getOptionalNumber('weeks'),
+          months: scheduleConfig.getOptionalNumber('months'),
+          years: scheduleConfig.getOptionalNumber('years'),
+        };
+      }
+
+      if (timeoutConfig) {
+        timeout = {
+          milliseconds: timeoutConfig.getOptionalNumber('milliseconds'),
+          seconds: timeoutConfig.getOptionalNumber('seconds'),
+          minutes: timeoutConfig.getOptionalNumber('minutes'),
+          hours: timeoutConfig.getOptionalNumber('hours'),
+          days: timeoutConfig.getOptionalNumber('days'),
+          weeks: timeoutConfig.getOptionalNumber('weeks'),
+          months: timeoutConfig.getOptionalNumber('months'),
+          years: timeoutConfig.getOptionalNumber('years'),
+        };
+      }
+    }
+
+    return new LighthouseAuditScheduleImpl(schedule, timeout);
+  }
+
+  constructor(
+    private schedule: HumanDuration,
+    private timeout: HumanDuration,
+  ) {}
+
+  getSchedule(): HumanDuration {
+    return this.schedule;
+  }
+
+  getTimeout(): HumanDuration {
+    return this.timeout;
+  }
+}

plugins/lighthouse-backend/src/index.ts

@@ -0,0 +1,17 @@
+/*
+ * 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.
+ */
+
+export * from './service/plugin';

plugins/lighthouse-backend/src/service/EntitiesLoader.ts

@@ -0,0 +1,32 @@
+/*
+ * 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 {
+  CatalogClient,
+  CATALOG_FILTER_EXISTS,
+} from '@backstage/catalog-client';
+
+export async function loadLighthouseEntities(catalogClient: CatalogClient) {
+  const filter: Record<string, symbol | string> = {
+    kind: 'Component',
+    'spec.type': 'website',
+    ['lighthouse.com/website-url']: CATALOG_FILTER_EXISTS,
+  };
+
+  return await catalogClient.getEntities({
+    filter: [filter],
+  });
+}

plugins/lighthouse-backend/src/service/plugin.ts

@@ -0,0 +1,124 @@
+/*
+ * 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 { Logger } from 'winston';
+import { PluginTaskScheduler } from '@backstage/backend-tasks';
+import {
+  CATALOG_FILTER_EXISTS,
+  CatalogClient,
+} from '@backstage/catalog-client';
+import { Config } from '@backstage/config';
+import { LighthouseRestApi } from '@backstage/plugin-lighthouse-common';
+import { stringifyEntityRef } from '@backstage/catalog-model';
+import { LighthouseAuditScheduleImpl } from '../config';
+
+export interface RouterOptions {
+  logger: Logger;
+  config: Config;
+  scheduler?: PluginTaskScheduler;
+  catalogClient: CatalogClient;
+}
+
+export async function create(options: RouterOptions) {
+  const { logger, scheduler, catalogClient, config } = options;
+  const lighthouseApi = LighthouseRestApi.fromConfig(config);
+
+  const lighthouseAuditConfig = LighthouseAuditScheduleImpl.fromConfig(config);
+  const formFactorToScreenEmulationMap = {
+    // the default is mobile, so no need to override
+    mobile: undefined,
+    // Values from lighthouse's cli "desktop" preset
+    // https://github.com/GoogleChrome/lighthouse/blob/a6738e0033e7e5ca308b97c1c36f298b7d399402/lighthouse-core/config/constants.js#L71-L77
+    desktop: {
+      mobile: false,
+      width: 1350,
+      height: 940,
+      deviceScaleFactor: 1,
+      disabled: false,
+    },
+  };
+
+  logger.info(
+    `Running with Scheduler Config ${JSON.stringify(
+      lighthouseAuditConfig.getSchedule(),
+    )} and timeout ${JSON.stringify(lighthouseAuditConfig.getTimeout())}`,
+  );
+
+  if (scheduler) {
+    await scheduler.scheduleTask({
+      id: 'lighthouse_audit',
+      frequency: lighthouseAuditConfig.getSchedule(),
+      timeout: lighthouseAuditConfig.getTimeout(),
+      initialDelay: { minutes: 15 },
+      fn: async () => {
+        const filter: Record<string, symbol | string> = {
+          kind: 'Component',
+          'spec.type': 'website',
+          ['metadata.annotations.lighthouse.com/website-url']:
+            CATALOG_FILTER_EXISTS,
+        };
+
+        logger.info('Running Lighthouse Audit Task');
+
+        const websitesWithUrl = await catalogClient.getEntities({
+          filter: [filter],
+        });
+
+        let index = 0;
+        for (const entity of websitesWithUrl.items) {
+          const websiteUrl =
+            entity.metadata.annotations?.['lighthouse.com/website-url'] ?? '';
+
+          if (!websiteUrl) {
+            continue;
+          }
+
+          const controller = new AbortController();
+
+          await scheduler.scheduleTask({
+            id: `lighthouse_audit_${stringifyEntityRef(entity)}`,
+            frequency: {},
+            timeout: {},
+            initialDelay: { minutes: index * 2 },
+            signal: controller.signal,
+            fn: async () => {
+              logger.info(
+                `Processing Website Url ${websiteUrl} for Entity ${entity.metadata.name}`,
+              );
+
+              await lighthouseApi.triggerAudit({
+                url: websiteUrl,
+                options: {
+                  lighthouseConfig: {
+                    settings: {
+                      formFactor: 'mobile',
+                      emulatedFormFactor: 'mobile',
+                      screenEmulation: formFactorToScreenEmulationMap.mobile,
+                    },
+                  },
+                },
+              });
+
+              logger.info('Stop Scheduled Task');
+              controller.abort();
+            },
+          });
+          index++;
+        }
+      },
+    });
+  }
+}

plugins/lighthouse-backend/src/setupTests.ts

@@ -0,0 +1,17 @@
+/*
+ * 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.
+ */
+
+export {};