@backstage-community/plugin-copilot-backend 0.1.0

package/CHANGELOG.md

@@ -0,0 +1,12 @@
+# @backstage-community/plugin-copilot-backend
+
+## 0.1.0
+
+### Minor Changes
+
+- 2d5f011: Introduced the GitHub Copilot plugin, checkout the plugin's [`README.md`](https://github.com/backstage/community-plugins/tree/main/workspaces/copilot/plugins/copilot) for more details!
+
+### Patch Changes
+
+- Updated dependencies [2d5f011]
+  - @backstage-community/plugin-copilot-common@0.1.0

package/README.md

@@ -0,0 +1,121 @@
+# GitHub Copilot Plugin
+
+This GitHub Copilot plugin integrates with Backstage to provide metrics and insights for members of your organization or enterprise.
+
+## Installation
+
+### New Backend System
+
+To configure the plugin using the new backend system:
+
+1. In the `packages/backend/src/index.ts` file, add the following:
+
+   ```typescript
+   import { createBackend } from '@backstage/backend-defaults';
+
+   const backend = createBackend();
+
+   backend.add(import('@backstage-community/plugin-copilot'));
+
+   backend.start();
+   ```
+
+### Old System
+
+To install the plugin using the old method:
+
+1. Add the `@backstage-community/plugin-copilot` package to your backend:
+
+   ```sh
+   yarn --cwd packages/backend add @backstage-community/plugin-copilot
+   ```
+
+2. In your `packages/backend/src/plugins/copilot.ts` file, add the following code:
+
+   ```typescript
+   import { TaskScheduleDefinition } from '@backstage/backend-tasks';
+   import { createRouterFromConfig } from '@backstage-community/plugin-copilot';
+
+   export default async function createPlugin(): Promise<void> {
+     const schedule: TaskScheduleDefinition = {
+       frequency: { cron: '0 2 * * *' },
+       timeout: { minutes: 15 },
+       initialDelay: { seconds: 15 },
+     };
+
+     return createRouterFromConfig({ schedule });
+   }
+   ```
+
+3. Integrate the plugin into the main backend router in `packages/backend/src/index.ts`:
+
+   ```typescript
+   import { createRouterFromConfig } from './plugins/copilot';
+
+   async function main() {
+     // Backend setup
+     const env = createEnv('copilot');
+     // Plugin registration
+     apiRouter.use('/copilot', await createRouterFromConfig(env));
+   }
+   ```
+
+## Configuration
+
+### Environment Variables
+
+To configure the GitHub Copilot plugin, you need to set the following environment variables:
+
+- **`copilot.host`**: The host URL for your GitHub Copilot instance (e.g., `github.com` or `github.enterprise.com`).
+- **`copilot.enterprise`**: The name of your GitHub Enterprise instance (e.g., `my-enterprise`).
+
+These variables are used to configure the plugin and ensure it communicates with the correct GitHub instance.
+
+### GitHub Credentials
+
+**Important:** The GitHub token, which is necessary for authentication, should be managed within your Backstage integrations configuration. The token must be added to your GitHub integration settings, and the plugin will retrieve it through the `GithubCredentialsProvider`.
+
+Ensure that your GitHub integration in the Backstage configuration includes the necessary token for the `GithubCredentialsProvider` to work correctly.
+
+### YAML Configuration Example
+
+```yaml
+copilot:
+  scheduler:
+    frequency:
+      hours: 2
+    timeout:
+      minutes: 2
+    initialDelay:
+      seconds: 15
+  host: YOUR_GITHUB_HOST_HERE
+  enterprise: YOUR_ENTERPRISE_NAME_HERE
+```
+
+### Generating GitHub Copilot Token
+
+To generate an access token for using GitHub Copilot:
+
+- Visit [Generate GitHub Access Token](https://github.com/settings/tokens).
+- Follow the instructions to create a new token with the `read:enterprise` scope.
+
+### API Documentation
+
+For more details on using the GitHub Copilot API:
+
+- Refer to the [API documentation](https://docs.github.com/en/rest/copilot/copilot-usage?apiVersion=2022-11-28) for comprehensive information on available functionalities.
+
+## Run
+
+1. Start the backend:
+
+   ```sh
+   yarn start-backend
+   ```
+
+2. Verify the plugin is running by accessing `http://localhost:7007/api/copilot/health`.
+
+## Links
+
+- [GitHub Copilot Plugin Frontend](https://github.com/backstage/backstage/tree/master/plugins/copilot)
+- [Backstage Homepage](https://backstage.io)

package/config.d.ts

@@ -0,0 +1,38 @@
+/*
+ * 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 { SchedulerServiceTaskScheduleDefinition } from '@backstage/backend-plugin-api';
+
+/**
+ * Configuration interface for the GitHub Copilot Plugin.
+ */
+export interface Config {
+  /** Configuration options for the GitHub Copilot Plugin */
+  copilot?: {
+    /**
+     * Schedule definition for the GitHub Copilot Plugin tasks.
+     */
+    schedule?: SchedulerServiceTaskScheduleDefinition;
+    /**
+     * The name of the GitHub enterprise.
+     */
+    enterprise?: string;
+    /**
+     * The host for GitHub Copilot integration.
+     */
+    host?: string;
+  };
+}

package/dist/index.cjs.js

@@ -0,0 +1,266 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var express = require('express');
+var Router = require('express-promise-router');
+var rootHttpRouter = require('@backstage/backend-defaults/rootHttpRouter');
+var backendPluginApi = require('@backstage/backend-plugin-api');
+var luxon = require('luxon');
+var errors = require('@backstage/errors');
+var fetch = require('node-fetch');
+var integration = require('@backstage/integration');
+
+function _interopDefaultCompat (e) { return e && typeof e === 'object' && 'default' in e ? e : { default: e }; }
+
+var express__default = /*#__PURE__*/_interopDefaultCompat(express);
+var Router__default = /*#__PURE__*/_interopDefaultCompat(Router);
+var fetch__default = /*#__PURE__*/_interopDefaultCompat(fetch);
+
+const migrationsDir = backendPluginApi.resolvePackagePath(
+  "@backstage-community/plugin-copilot-backend",
+  "migrations"
+);
+class DatabaseHandler {
+  constructor(db) {
+    this.db = db;
+  }
+  static async create(options) {
+    const { database } = options;
+    const client = await database.getClient();
+    if (!database.migrations?.skip) {
+      await client.migrate.latest({
+        directory: migrationsDir
+      });
+    }
+    return new DatabaseHandler(client);
+  }
+  async getByPeriod(startDate, endDate) {
+    const records = await this.db("metrics").whereBetween("day", [
+      startDate,
+      endDate
+    ]);
+    return records ?? [];
+  }
+  async getPeriodRange() {
+    const minDate = await this.db("metrics").orderBy("day", "asc").first("day");
+    const maxDate = await this.db("metrics").orderBy("day", "desc").first("day");
+    if (!minDate?.day || !maxDate?.day) return void 0;
+    return { minDate: minDate.day, maxDate: maxDate.day };
+  }
+  async batchInsert(metrics) {
+    await this.db("metrics").insert(metrics).onConflict("day").ignore();
+  }
+  async getMostRecentDayFromMetrics() {
+    try {
+      const mostRecent = await this.db("metrics").orderBy("day", "desc").first("day");
+      return mostRecent ? mostRecent.day : void 0;
+    } catch (e) {
+      return void 0;
+    }
+  }
+}
+
+class Scheduler {
+  constructor(options) {
+    this.options = options;
+  }
+  static create(options) {
+    return new Scheduler(options);
+  }
+  async run() {
+    try {
+      this.options.logger.info("Starting Github Copilot Processor");
+      const copilotMetrics = await this.options.api.getCopilotUsageDataForEnterprise();
+      this.options.logger.info(`Fetched ${copilotMetrics.length} metrics`);
+      const lastDay = await this.options.db.getMostRecentDayFromMetrics();
+      this.options.logger.info(`Found last day: ${lastDay}`);
+      const diff = copilotMetrics.sort(
+        (a, b) => luxon.DateTime.fromISO(a.day).toMillis() - luxon.DateTime.fromISO(b.day).toMillis()
+      ).filter((metric) => {
+        const metricDate = luxon.DateTime.fromISO(metric.day);
+        const lastDayDate = lastDay ? luxon.DateTime.fromISO(lastDay) : null;
+        return !lastDayDate || metricDate > lastDayDate;
+      }).map(({ breakdown, ...rest }) => ({
+        ...rest,
+        breakdown: JSON.stringify(breakdown)
+      }));
+      this.options.logger.info(`Found ${diff.length} new metrics to insert`);
+      if (diff.length > 0) {
+        await batchInsertInChunks(
+          diff,
+          30,
+          async (chunk) => {
+            await this.options.db.batchInsert(chunk);
+          }
+        );
+        this.options.logger.info("Inserted new metrics into the database");
+      } else {
+        this.options.logger.info("No new metrics found to insert");
+      }
+    } catch (error) {
+      this.options.logger.error(
+        `An error occurred while processing Github Copilot metrics: ${error}`
+      );
+    }
+  }
+}
+async function batchInsertInChunks(data, chunkSize, batchInsertFunc) {
+  for (let i = 0; i < data.length; i += chunkSize) {
+    const chunk = data.slice(i, i + chunkSize);
+    await batchInsertFunc(chunk);
+  }
+}
+
+const getGithubInfo = async (config) => {
+  const integrations = integration.ScmIntegrations.fromConfig(config);
+  const credentialsProvider = integration.DefaultGithubCredentialsProvider.fromIntegrations(integrations);
+  const host = config.getString("copilot.host");
+  const enterprise = config.getString("copilot.enterprise");
+  if (!host) {
+    throw new Error("The host configuration is missing from the config.");
+  }
+  if (!enterprise) {
+    throw new Error("The enterprise configuration is missing from the config.");
+  }
+  const githubConfig = integrations.github.byHost(host)?.config;
+  if (!githubConfig) {
+    throw new Error(
+      `GitHub configuration for host "${host}" is missing or incomplete.`
+    );
+  }
+  const apiBaseUrl = githubConfig.apiBaseUrl ?? "https://api.github.com";
+  const credentials = await credentialsProvider.getCredentials({
+    url: apiBaseUrl
+  });
+  if (!credentials.headers) {
+    throw new Error("Failed to retrieve credentials headers.");
+  }
+  return {
+    apiBaseUrl,
+    credentials,
+    enterprise
+  };
+};
+
+class GithubClient {
+  constructor(props) {
+    this.props = props;
+  }
+  static async fromConfig(config) {
+    const info = await getGithubInfo(config);
+    return new GithubClient(info);
+  }
+  async getCopilotUsageDataForEnterprise() {
+    const path = `/enterprises/${this.props.enterprise}/copilot/usage`;
+    return this.get(path);
+  }
+  async get(path) {
+    const response = await fetch__default.default(`${this.props.apiBaseUrl}${path}`, {
+      headers: {
+        ...this.props.credentials.headers,
+        Accept: "application/vnd.github+json",
+        "X-GitHub-Api-Version": "2022-11-28"
+      }
+    });
+    if (!response.ok) {
+      throw await errors.ResponseError.fromResponse(response);
+    }
+    return response.json();
+  }
+}
+
+const defaultSchedule = {
+  frequency: { cron: "0 2 * * *" },
+  timeout: { minutes: 15 },
+  initialDelay: { minutes: 1 },
+  scope: "local"
+};
+async function createRouterFromConfig(routerOptions) {
+  const { config } = routerOptions;
+  const pluginOptions = {
+    schedule: defaultSchedule
+  };
+  if (config && config.has("copilot.schedule")) {
+    pluginOptions.schedule = backendPluginApi.readSchedulerServiceTaskScheduleDefinitionFromConfig(
+      config.getConfig("copilot.schedule")
+    );
+  }
+  return createRouter(routerOptions, pluginOptions);
+}
+async function createRouter(routerOptions, pluginOptions) {
+  const { logger, database, scheduler, config } = routerOptions;
+  const { schedule } = pluginOptions;
+  const db = await DatabaseHandler.create({ database });
+  const api = await GithubClient.fromConfig(config);
+  await scheduler.scheduleTask({
+    id: "copilot-metrics",
+    ...schedule ?? defaultSchedule,
+    fn: async () => await Scheduler.create({ db, logger, api, config }).run()
+  });
+  const router = Router__default.default();
+  router.use(express__default.default.json());
+  router.get("/health", (_, response) => {
+    logger.info("PONG!");
+    response.json({ status: "ok" });
+  });
+  router.get("/metrics", async (request, response) => {
+    const { startDate, endDate } = request.query;
+    if (typeof startDate !== "string" || typeof endDate !== "string") {
+      return response.status(400).json("Invalid query parameters");
+    }
+    const parsedStartDate = luxon.DateTime.fromISO(startDate);
+    const parsedEndDate = luxon.DateTime.fromISO(endDate);
+    if (!parsedStartDate.isValid || !parsedEndDate.isValid) {
+      return response.status(400).json("Invalid date format");
+    }
+    const result = await db.getByPeriod(startDate, endDate);
+    const metrics = result.map((metric) => ({
+      ...metric,
+      breakdown: JSON.parse(metric.breakdown)
+    }));
+    return response.json(metrics);
+  });
+  router.get("/metrics/period-range", async (_, response) => {
+    const result = await db.getPeriodRange();
+    if (!result) {
+      return response.status(400).json("No available data");
+    }
+    return response.json(result);
+  });
+  router.use(rootHttpRouter.MiddlewareFactory.create({ config, logger }).error);
+  return router;
+}
+
+const copilotPlugin = backendPluginApi.createBackendPlugin({
+  pluginId: "copilot",
+  register(env) {
+    env.registerInit({
+      deps: {
+        httpRouter: backendPluginApi.coreServices.httpRouter,
+        logger: backendPluginApi.coreServices.logger,
+        database: backendPluginApi.coreServices.database,
+        scheduler: backendPluginApi.coreServices.scheduler,
+        config: backendPluginApi.coreServices.rootConfig
+      },
+      async init({ httpRouter, logger, database, scheduler, config }) {
+        httpRouter.use(
+          await createRouterFromConfig({
+            logger,
+            database,
+            scheduler,
+            config
+          })
+        );
+        httpRouter.addAuthPolicy({
+          path: "/health",
+          allow: "unauthenticated"
+        });
+      }
+    });
+  }
+});
+
+exports.createRouterFromConfig = createRouterFromConfig;
+exports.default = copilotPlugin;
+//# sourceMappingURL=index.cjs.js.map

package/dist/index.cjs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.cjs.js","sources":["../src/db/DatabaseHandler.ts","../src/task/Scheduler.ts","../src/utils/GithubUtils.ts","../src/client/GithubClient.ts","../src/service/router.ts","../src/plugin.ts"],"sourcesContent":["/*\n * Copyright 2021 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport {\n  resolvePackagePath,\n  DatabaseService,\n} from '@backstage/backend-plugin-api';\nimport {\n  Metric,\n  PeriodRange,\n} from '@backstage-community/plugin-copilot-common';\nimport { Knex } from 'knex';\n\nconst migrationsDir = resolvePackagePath(\n  '@backstage-community/plugin-copilot-backend',\n  'migrations',\n);\n\ntype Options = {\n  database: DatabaseService;\n};\n\nexport type MetricDbRow = Omit<Metric, 'breakdown'> & {\n  breakdown: string;\n};\n\nexport class DatabaseHandler {\n  static async create(options: Options): Promise<DatabaseHandler> {\n    const { database } = options;\n    const client = await database.getClient();\n\n    if (!database.migrations?.skip) {\n      await client.migrate.latest({\n        directory: migrationsDir,\n      });\n    }\n\n    return new DatabaseHandler(client);\n  }\n\n  private constructor(private readonly db: Knex) {}\n\n  async getByPeriod(\n    startDate: string,\n    endDate: string,\n  ): Promise<MetricDbRow[]> {\n    const records = await this.db<MetricDbRow>('metrics').whereBetween('day', [\n      startDate,\n      endDate,\n    ]);\n    return records ?? [];\n  }\n\n  async getPeriodRange(): Promise<PeriodRange | undefined> {\n    const minDate = await this.db<MetricDbRow>('metrics')\n      .orderBy('day', 'asc')\n      .first('day');\n    const maxDate = await this.db<MetricDbRow>('metrics')\n      .orderBy('day', 'desc')\n      .first('day');\n\n    if (!minDate?.day || !maxDate?.day) return undefined;\n\n    return { minDate: minDate.day, maxDate: maxDate.day };\n  }\n\n  async batchInsert(metrics: MetricDbRow[]): Promise<void> {\n    await this.db<MetricDbRow[]>('metrics')\n      .insert(metrics)\n      .onConflict('day')\n      .ignore();\n  }\n\n  async getMostRecentDayFromMetrics(): Promise<string | undefined> {\n    try {\n      const mostRecent = await this.db<MetricDbRow>('metrics')\n        .orderBy('day', 'desc')\n        .first('day');\n\n      return mostRecent ? mostRecent.day : undefined;\n    } catch (e) {\n      return undefined;\n    }\n  }\n}\n","/*\n * Copyright 2024 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport { LoggerService } from '@backstage/backend-plugin-api';\nimport { GithubClient } from '../client/GithubClient';\nimport { DatabaseHandler, MetricDbRow } from '../db/DatabaseHandler';\nimport { Config } from '@backstage/config';\nimport { DateTime } from 'luxon';\n\ntype Options = {\n  api: GithubClient;\n  config: Config;\n  logger: LoggerService;\n  db: DatabaseHandler;\n};\n\nexport default class Scheduler {\n  constructor(private readonly options: Options) {}\n\n  static create(options: Options) {\n    return new Scheduler(options);\n  }\n\n  async run() {\n    try {\n      this.options.logger.info('Starting Github Copilot Processor');\n\n      const copilotMetrics =\n        await this.options.api.getCopilotUsageDataForEnterprise();\n      this.options.logger.info(`Fetched ${copilotMetrics.length} metrics`);\n\n      const lastDay = await this.options.db.getMostRecentDayFromMetrics();\n      this.options.logger.info(`Found last day: ${lastDay}`);\n\n      const diff = copilotMetrics\n        .sort(\n          (a, b) =>\n            DateTime.fromISO(a.day).toMillis() -\n            DateTime.fromISO(b.day).toMillis(),\n        )\n        .filter(metric => {\n          const metricDate = DateTime.fromISO(metric.day);\n          const lastDayDate = lastDay ? DateTime.fromISO(lastDay) : null;\n          return !lastDayDate || metricDate > lastDayDate;\n        })\n        .map(({ breakdown, ...rest }) => ({\n          ...rest,\n          breakdown: JSON.stringify(breakdown),\n        }));\n\n      this.options.logger.info(`Found ${diff.length} new metrics to insert`);\n\n      if (diff.length > 0) {\n        await batchInsertInChunks<MetricDbRow>(\n          diff,\n          30,\n          async (chunk: MetricDbRow[]) => {\n            await this.options.db.batchInsert(chunk);\n          },\n        );\n        this.options.logger.info('Inserted new metrics into the database');\n      } else {\n        this.options.logger.info('No new metrics found to insert');\n      }\n    } catch (error) {\n      this.options.logger.error(\n        `An error occurred while processing Github Copilot metrics: ${error}`,\n      );\n    }\n  }\n}\n\nasync function batchInsertInChunks<T>(\n  data: T[],\n  chunkSize: number,\n  batchInsertFunc: (chunk: T[]) => Promise<void>,\n): Promise<void> {\n  for (let i = 0; i < data.length; i += chunkSize) {\n    const chunk = data.slice(i, i + chunkSize);\n    await batchInsertFunc(chunk);\n  }\n}\n","/*\n * Copyright 2024 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport { Config } from '@backstage/config';\nimport {\n  DefaultGithubCredentialsProvider,\n  GithubCredentials,\n  ScmIntegrations,\n} from '@backstage/integration';\n\nexport type GithubInfo = {\n  credentials: GithubCredentials;\n  apiBaseUrl: string;\n  enterprise: string;\n};\n\nexport const getGithubInfo = async (config: Config): Promise<GithubInfo> => {\n  const integrations = ScmIntegrations.fromConfig(config);\n  const credentialsProvider =\n    DefaultGithubCredentialsProvider.fromIntegrations(integrations);\n\n  const host = config.getString('copilot.host');\n  const enterprise = config.getString('copilot.enterprise');\n\n  if (!host) {\n    throw new Error('The host configuration is missing from the config.');\n  }\n\n  if (!enterprise) {\n    throw new Error('The enterprise configuration is missing from the config.');\n  }\n\n  const githubConfig = integrations.github.byHost(host)?.config;\n\n  if (!githubConfig) {\n    throw new Error(\n      `GitHub configuration for host \"${host}\" is missing or incomplete.`,\n    );\n  }\n\n  const apiBaseUrl = githubConfig.apiBaseUrl ?? 'https://api.github.com';\n\n  const credentials = await credentialsProvider.getCredentials({\n    url: apiBaseUrl,\n  });\n\n  if (!credentials.headers) {\n    throw new Error('Failed to retrieve credentials headers.');\n  }\n\n  return {\n    apiBaseUrl,\n    credentials,\n    enterprise,\n  };\n};\n","/*\n * Copyright 2024 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport { ResponseError } from '@backstage/errors';\nimport { Config } from '@backstage/config';\nimport { Metric } from '@backstage-community/plugin-copilot-common';\nimport fetch from 'node-fetch';\nimport { getGithubInfo, GithubInfo } from '../utils/GithubUtils';\n\ninterface GithubApi {\n  getCopilotUsageDataForEnterprise: () => Promise<Metric[]>;\n}\n\nexport class GithubClient implements GithubApi {\n  constructor(private readonly props: GithubInfo) {}\n\n  static async fromConfig(config: Config) {\n    const info = await getGithubInfo(config);\n    return new GithubClient(info);\n  }\n\n  async getCopilotUsageDataForEnterprise(): Promise<Metric[]> {\n    const path = `/enterprises/${this.props.enterprise}/copilot/usage`;\n    return this.get(path);\n  }\n\n  private async get<T>(path: string): Promise<T> {\n    const response = await fetch(`${this.props.apiBaseUrl}${path}`, {\n      headers: {\n        ...this.props.credentials.headers,\n        Accept: 'application/vnd.github+json',\n        'X-GitHub-Api-Version': '2022-11-28',\n      },\n    });\n\n    if (!response.ok) {\n      throw await ResponseError.fromResponse(response);\n    }\n\n    return response.json() as Promise<T>;\n  }\n}\n","/*\n * Copyright 2024 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\nimport express from 'express';\nimport Router from 'express-promise-router';\nimport { MiddlewareFactory } from '@backstage/backend-defaults/rootHttpRouter';\nimport {\n  DatabaseService,\n  LoggerService,\n  readSchedulerServiceTaskScheduleDefinitionFromConfig,\n  SchedulerService,\n  SchedulerServiceTaskScheduleDefinition,\n} from '@backstage/backend-plugin-api';\nimport { Config } from '@backstage/config';\nimport { Metric } from '@backstage-community/plugin-copilot-common';\nimport { DatabaseHandler } from '../db/DatabaseHandler';\nimport Scheduler from '../task/Scheduler';\nimport { GithubClient } from '../client/GithubClient';\nimport { DateTime } from 'luxon';\n\n/**\n * Options for configuring the Copilot plugin.\n *\n * @public\n */\nexport interface PluginOptions {\n  /**\n   * Schedule configuration for the plugin.\n   */\n  schedule?: SchedulerServiceTaskScheduleDefinition;\n}\n\n/**\n * Options for configuring the router used by the Copilot plugin.\n *\n * @public\n */\nexport interface RouterOptions {\n  /**\n   * Logger service for the router.\n   */\n  logger: LoggerService;\n\n  /**\n   * Database service for the router.\n   */\n  database: DatabaseService;\n\n  /**\n   * Scheduler service for the router.\n   */\n  scheduler: SchedulerService;\n\n  /**\n   * Configuration for the router.\n   */\n  config: Config;\n}\n\nconst defaultSchedule: SchedulerServiceTaskScheduleDefinition = {\n  frequency: { cron: '0 2 * * *' },\n  timeout: { minutes: 15 },\n  initialDelay: { minutes: 1 },\n  scope: 'local',\n};\n\n/**\n * Creates an Express router configured based on the provided router options and plugin options.\n *\n * This function initializes the router with the appropriate middleware and routes based on the\n * configuration and options provided. It also schedules tasks if scheduling options are provided.\n *\n * @param routerOptions - Options for configuring the router, including services and configuration.\n * @returns A promise that resolves to an Express router instance.\n *\n * @public\n */\nexport async function createRouterFromConfig(routerOptions: RouterOptions) {\n  const { config } = routerOptions;\n  const pluginOptions: PluginOptions = {\n    schedule: defaultSchedule,\n  };\n  if (config && config.has('copilot.schedule')) {\n    pluginOptions.schedule =\n      readSchedulerServiceTaskScheduleDefinitionFromConfig(\n        config.getConfig('copilot.schedule'),\n      );\n  }\n  return createRouter(routerOptions, pluginOptions);\n}\n\n/** @private */\nasync function createRouter(\n  routerOptions: RouterOptions,\n  pluginOptions: PluginOptions,\n): Promise<express.Router> {\n  const { logger, database, scheduler, config } = routerOptions;\n  const { schedule } = pluginOptions;\n\n  const db = await DatabaseHandler.create({ database });\n  const api = await GithubClient.fromConfig(config);\n\n  await scheduler.scheduleTask({\n    id: 'copilot-metrics',\n    ...(schedule ?? defaultSchedule),\n    fn: async () => await Scheduler.create({ db, logger, api, config }).run(),\n  });\n\n  const router = Router();\n  router.use(express.json());\n\n  router.get('/health', (_, response) => {\n    logger.info('PONG!');\n    response.json({ status: 'ok' });\n  });\n\n  router.get('/metrics', async (request, response) => {\n    const { startDate, endDate } = request.query;\n\n    if (typeof startDate !== 'string' || typeof endDate !== 'string') {\n      return response.status(400).json('Invalid query parameters');\n    }\n\n    const parsedStartDate = DateTime.fromISO(startDate);\n    const parsedEndDate = DateTime.fromISO(endDate);\n\n    if (!parsedStartDate.isValid || !parsedEndDate.isValid) {\n      return response.status(400).json('Invalid date format');\n    }\n\n    const result = await db.getByPeriod(startDate, endDate);\n\n    const metrics: Metric[] = result.map(metric => ({\n      ...metric,\n      breakdown: JSON.parse(metric.breakdown),\n    }));\n\n    return response.json(metrics);\n  });\n\n  router.get('/metrics/period-range', async (_, response) => {\n    const result = await db.getPeriodRange();\n\n    if (!result) {\n      return response.status(400).json('No available data');\n    }\n\n    return response.json(result);\n  });\n\n  router.use(MiddlewareFactory.create({ config, logger }).error);\n  return router;\n}\n","/*\n * Copyright 2024 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\nimport {\n  coreServices,\n  createBackendPlugin,\n} from '@backstage/backend-plugin-api';\nimport { createRouterFromConfig } from './service/router';\n\n/**\n * Backend plugin for Copilot.\n *\n * @public\n */\nexport const copilotPlugin = createBackendPlugin({\n  pluginId: 'copilot',\n  register(env) {\n    env.registerInit({\n      deps: {\n        httpRouter: coreServices.httpRouter,\n        logger: coreServices.logger,\n        database: coreServices.database,\n        scheduler: coreServices.scheduler,\n        config: coreServices.rootConfig,\n      },\n      async init({ httpRouter, logger, database, scheduler, config }) {\n        httpRouter.use(\n          await createRouterFromConfig({\n            logger,\n            database,\n            scheduler,\n            config,\n          }),\n        );\n        httpRouter.addAuthPolicy({\n          path: '/health',\n          allow: 'unauthenticated',\n        });\n      },\n    });\n  },\n});\n"],"names":["resolvePackagePath","DateTime","ScmIntegrations","DefaultGithubCredentialsProvider","fetch","ResponseError","readSchedulerServiceTaskScheduleDefinitionFromConfig","Router","express","MiddlewareFactory","createBackendPlugin","coreServices"],"mappings":";;;;;;;;;;;;;;;;;;;AA0BA,MAAM,aAAgB,GAAAA,mCAAA;AAAA,EACpB,6CAAA;AAAA,EACA,YAAA;AACF,CAAA,CAAA;AAUO,MAAM,eAAgB,CAAA;AAAA,EAcnB,YAA6B,EAAU,EAAA;AAAV,IAAA,IAAA,CAAA,EAAA,GAAA,EAAA,CAAA;AAAA,GAAW;AAAA,EAbhD,aAAa,OAAO,OAA4C,EAAA;AAC9D,IAAM,MAAA,EAAE,UAAa,GAAA,OAAA,CAAA;AACrB,IAAM,MAAA,MAAA,GAAS,MAAM,QAAA,CAAS,SAAU,EAAA,CAAA;AAExC,IAAI,IAAA,CAAC,QAAS,CAAA,UAAA,EAAY,IAAM,EAAA;AAC9B,MAAM,MAAA,MAAA,CAAO,QAAQ,MAAO,CAAA;AAAA,QAC1B,SAAW,EAAA,aAAA;AAAA,OACZ,CAAA,CAAA;AAAA,KACH;AAEA,IAAO,OAAA,IAAI,gBAAgB,MAAM,CAAA,CAAA;AAAA,GACnC;AAAA,EAIA,MAAM,WACJ,CAAA,SAAA,EACA,OACwB,EAAA;AACxB,IAAA,MAAM,UAAU,MAAM,IAAA,CAAK,GAAgB,SAAS,CAAA,CAAE,aAAa,KAAO,EAAA;AAAA,MACxE,SAAA;AAAA,MACA,OAAA;AAAA,KACD,CAAA,CAAA;AACD,IAAA,OAAO,WAAW,EAAC,CAAA;AAAA,GACrB;AAAA,EAEA,MAAM,cAAmD,GAAA;AACvD,IAAM,MAAA,OAAA,GAAU,MAAM,IAAA,CAAK,EAAgB,CAAA,SAAS,CACjD,CAAA,OAAA,CAAQ,KAAO,EAAA,KAAK,CACpB,CAAA,KAAA,CAAM,KAAK,CAAA,CAAA;AACd,IAAM,MAAA,OAAA,GAAU,MAAM,IAAA,CAAK,EAAgB,CAAA,SAAS,CACjD,CAAA,OAAA,CAAQ,KAAO,EAAA,MAAM,CACrB,CAAA,KAAA,CAAM,KAAK,CAAA,CAAA;AAEd,IAAA,IAAI,CAAC,OAAS,EAAA,GAAA,IAAO,CAAC,OAAA,EAAS,KAAY,OAAA,KAAA,CAAA,CAAA;AAE3C,IAAA,OAAO,EAAE,OAAS,EAAA,OAAA,CAAQ,GAAK,EAAA,OAAA,EAAS,QAAQ,GAAI,EAAA,CAAA;AAAA,GACtD;AAAA,EAEA,MAAM,YAAY,OAAuC,EAAA;AACvD,IAAM,MAAA,IAAA,CAAK,EAAkB,CAAA,SAAS,CACnC,CAAA,MAAA,CAAO,OAAO,CACd,CAAA,UAAA,CAAW,KAAK,CAAA,CAChB,MAAO,EAAA,CAAA;AAAA,GACZ;AAAA,EAEA,MAAM,2BAA2D,GAAA;AAC/D,IAAI,IAAA;AACF,MAAM,MAAA,UAAA,GAAa,MAAM,IAAA,CAAK,EAAgB,CAAA,SAAS,CACpD,CAAA,OAAA,CAAQ,KAAO,EAAA,MAAM,CACrB,CAAA,KAAA,CAAM,KAAK,CAAA,CAAA;AAEd,MAAO,OAAA,UAAA,GAAa,WAAW,GAAM,GAAA,KAAA,CAAA,CAAA;AAAA,aAC9B,CAAG,EAAA;AACV,MAAO,OAAA,KAAA,CAAA,CAAA;AAAA,KACT;AAAA,GACF;AACF;;ACpEA,MAAqB,SAAU,CAAA;AAAA,EAC7B,YAA6B,OAAkB,EAAA;AAAlB,IAAA,IAAA,CAAA,OAAA,GAAA,OAAA,CAAA;AAAA,GAAmB;AAAA,EAEhD,OAAO,OAAO,OAAkB,EAAA;AAC9B,IAAO,OAAA,IAAI,UAAU,OAAO,CAAA,CAAA;AAAA,GAC9B;AAAA,EAEA,MAAM,GAAM,GAAA;AACV,IAAI,IAAA;AACF,MAAK,IAAA,CAAA,OAAA,CAAQ,MAAO,CAAA,IAAA,CAAK,mCAAmC,CAAA,CAAA;AAE5D,MAAA,MAAM,cACJ,GAAA,MAAM,IAAK,CAAA,OAAA,CAAQ,IAAI,gCAAiC,EAAA,CAAA;AAC1D,MAAA,IAAA,CAAK,QAAQ,MAAO,CAAA,IAAA,CAAK,CAAW,QAAA,EAAA,cAAA,CAAe,MAAM,CAAU,QAAA,CAAA,CAAA,CAAA;AAEnE,MAAA,MAAM,OAAU,GAAA,MAAM,IAAK,CAAA,OAAA,CAAQ,GAAG,2BAA4B,EAAA,CAAA;AAClE,MAAA,IAAA,CAAK,OAAQ,CAAA,MAAA,CAAO,IAAK,CAAA,CAAA,gBAAA,EAAmB,OAAO,CAAE,CAAA,CAAA,CAAA;AAErD,MAAA,MAAM,OAAO,cACV,CAAA,IAAA;AAAA,QACC,CAAC,CAAA,EAAG,CACF,KAAAC,cAAA,CAAS,QAAQ,CAAE,CAAA,GAAG,CAAE,CAAA,QAAA,KACxBA,cAAS,CAAA,OAAA,CAAQ,CAAE,CAAA,GAAG,EAAE,QAAS,EAAA;AAAA,OACrC,CACC,OAAO,CAAU,MAAA,KAAA;AAChB,QAAA,MAAM,UAAa,GAAAA,cAAA,CAAS,OAAQ,CAAA,MAAA,CAAO,GAAG,CAAA,CAAA;AAC9C,QAAA,MAAM,WAAc,GAAA,OAAA,GAAUA,cAAS,CAAA,OAAA,CAAQ,OAAO,CAAI,GAAA,IAAA,CAAA;AAC1D,QAAO,OAAA,CAAC,eAAe,UAAa,GAAA,WAAA,CAAA;AAAA,OACrC,EACA,GAAI,CAAA,CAAC,EAAE,SAAW,EAAA,GAAG,MAAY,MAAA;AAAA,QAChC,GAAG,IAAA;AAAA,QACH,SAAA,EAAW,IAAK,CAAA,SAAA,CAAU,SAAS,CAAA;AAAA,OACnC,CAAA,CAAA,CAAA;AAEJ,MAAA,IAAA,CAAK,QAAQ,MAAO,CAAA,IAAA,CAAK,CAAS,MAAA,EAAA,IAAA,CAAK,MAAM,CAAwB,sBAAA,CAAA,CAAA,CAAA;AAErE,MAAI,IAAA,IAAA,CAAK,SAAS,CAAG,EAAA;AACnB,QAAM,MAAA,mBAAA;AAAA,UACJ,IAAA;AAAA,UACA,EAAA;AAAA,UACA,OAAO,KAAyB,KAAA;AAC9B,YAAA,MAAM,IAAK,CAAA,OAAA,CAAQ,EAAG,CAAA,WAAA,CAAY,KAAK,CAAA,CAAA;AAAA,WACzC;AAAA,SACF,CAAA;AACA,QAAK,IAAA,CAAA,OAAA,CAAQ,MAAO,CAAA,IAAA,CAAK,wCAAwC,CAAA,CAAA;AAAA,OAC5D,MAAA;AACL,QAAK,IAAA,CAAA,OAAA,CAAQ,MAAO,CAAA,IAAA,CAAK,gCAAgC,CAAA,CAAA;AAAA,OAC3D;AAAA,aACO,KAAO,EAAA;AACd,MAAA,IAAA,CAAK,QAAQ,MAAO,CAAA,KAAA;AAAA,QAClB,8DAA8D,KAAK,CAAA,CAAA;AAAA,OACrE,CAAA;AAAA,KACF;AAAA,GACF;AACF,CAAA;AAEA,eAAe,mBAAA,CACb,IACA,EAAA,SAAA,EACA,eACe,EAAA;AACf,EAAA,KAAA,IAAS,IAAI,CAAG,EAAA,CAAA,GAAI,IAAK,CAAA,MAAA,EAAQ,KAAK,SAAW,EAAA;AAC/C,IAAA,MAAM,KAAQ,GAAA,IAAA,CAAK,KAAM,CAAA,CAAA,EAAG,IAAI,SAAS,CAAA,CAAA;AACzC,IAAA,MAAM,gBAAgB,KAAK,CAAA,CAAA;AAAA,GAC7B;AACF;;ACjEa,MAAA,aAAA,GAAgB,OAAO,MAAwC,KAAA;AAC1E,EAAM,MAAA,YAAA,GAAeC,2BAAgB,CAAA,UAAA,CAAW,MAAM,CAAA,CAAA;AACtD,EAAM,MAAA,mBAAA,GACJC,4CAAiC,CAAA,gBAAA,CAAiB,YAAY,CAAA,CAAA;AAEhE,EAAM,MAAA,IAAA,GAAO,MAAO,CAAA,SAAA,CAAU,cAAc,CAAA,CAAA;AAC5C,EAAM,MAAA,UAAA,GAAa,MAAO,CAAA,SAAA,CAAU,oBAAoB,CAAA,CAAA;AAExD,EAAA,IAAI,CAAC,IAAM,EAAA;AACT,IAAM,MAAA,IAAI,MAAM,oDAAoD,CAAA,CAAA;AAAA,GACtE;AAEA,EAAA,IAAI,CAAC,UAAY,EAAA;AACf,IAAM,MAAA,IAAI,MAAM,0DAA0D,CAAA,CAAA;AAAA,GAC5E;AAEA,EAAA,MAAM,YAAe,GAAA,YAAA,CAAa,MAAO,CAAA,MAAA,CAAO,IAAI,CAAG,EAAA,MAAA,CAAA;AAEvD,EAAA,IAAI,CAAC,YAAc,EAAA;AACjB,IAAA,MAAM,IAAI,KAAA;AAAA,MACR,kCAAkC,IAAI,CAAA,2BAAA,CAAA;AAAA,KACxC,CAAA;AAAA,GACF;AAEA,EAAM,MAAA,UAAA,GAAa,aAAa,UAAc,IAAA,wBAAA,CAAA;AAE9C,EAAM,MAAA,WAAA,GAAc,MAAM,mBAAA,CAAoB,cAAe,CAAA;AAAA,IAC3D,GAAK,EAAA,UAAA;AAAA,GACN,CAAA,CAAA;AAED,EAAI,IAAA,CAAC,YAAY,OAAS,EAAA;AACxB,IAAM,MAAA,IAAI,MAAM,yCAAyC,CAAA,CAAA;AAAA,GAC3D;AAEA,EAAO,OAAA;AAAA,IACL,UAAA;AAAA,IACA,WAAA;AAAA,IACA,UAAA;AAAA,GACF,CAAA;AACF,CAAA;;AC1CO,MAAM,YAAkC,CAAA;AAAA,EAC7C,YAA6B,KAAmB,EAAA;AAAnB,IAAA,IAAA,CAAA,KAAA,GAAA,KAAA,CAAA;AAAA,GAAoB;AAAA,EAEjD,aAAa,WAAW,MAAgB,EAAA;AACtC,IAAM,MAAA,IAAA,GAAO,MAAM,aAAA,CAAc,MAAM,CAAA,CAAA;AACvC,IAAO,OAAA,IAAI,aAAa,IAAI,CAAA,CAAA;AAAA,GAC9B;AAAA,EAEA,MAAM,gCAAsD,GAAA;AAC1D,IAAA,MAAM,IAAO,GAAA,CAAA,aAAA,EAAgB,IAAK,CAAA,KAAA,CAAM,UAAU,CAAA,cAAA,CAAA,CAAA;AAClD,IAAO,OAAA,IAAA,CAAK,IAAI,IAAI,CAAA,CAAA;AAAA,GACtB;AAAA,EAEA,MAAc,IAAO,IAA0B,EAAA;AAC7C,IAAM,MAAA,QAAA,GAAW,MAAMC,sBAAM,CAAA,CAAA,EAAG,KAAK,KAAM,CAAA,UAAU,CAAG,EAAA,IAAI,CAAI,CAAA,EAAA;AAAA,MAC9D,OAAS,EAAA;AAAA,QACP,GAAG,IAAK,CAAA,KAAA,CAAM,WAAY,CAAA,OAAA;AAAA,QAC1B,MAAQ,EAAA,6BAAA;AAAA,QACR,sBAAwB,EAAA,YAAA;AAAA,OAC1B;AAAA,KACD,CAAA,CAAA;AAED,IAAI,IAAA,CAAC,SAAS,EAAI,EAAA;AAChB,MAAM,MAAA,MAAMC,oBAAc,CAAA,YAAA,CAAa,QAAQ,CAAA,CAAA;AAAA,KACjD;AAEA,IAAA,OAAO,SAAS,IAAK,EAAA,CAAA;AAAA,GACvB;AACF;;ACiBA,MAAM,eAA0D,GAAA;AAAA,EAC9D,SAAA,EAAW,EAAE,IAAA,EAAM,WAAY,EAAA;AAAA,EAC/B,OAAA,EAAS,EAAE,OAAA,EAAS,EAAG,EAAA;AAAA,EACvB,YAAA,EAAc,EAAE,OAAA,EAAS,CAAE,EAAA;AAAA,EAC3B,KAAO,EAAA,OAAA;AACT,CAAA,CAAA;AAaA,eAAsB,uBAAuB,aAA8B,EAAA;AACzE,EAAM,MAAA,EAAE,QAAW,GAAA,aAAA,CAAA;AACnB,EAAA,MAAM,aAA+B,GAAA;AAAA,IACnC,QAAU,EAAA,eAAA;AAAA,GACZ,CAAA;AACA,EAAA,IAAI,MAAU,IAAA,MAAA,CAAO,GAAI,CAAA,kBAAkB,CAAG,EAAA;AAC5C,IAAA,aAAA,CAAc,QACZ,GAAAC,qEAAA;AAAA,MACE,MAAA,CAAO,UAAU,kBAAkB,CAAA;AAAA,KACrC,CAAA;AAAA,GACJ;AACA,EAAO,OAAA,YAAA,CAAa,eAAe,aAAa,CAAA,CAAA;AAClD,CAAA;AAGA,eAAe,YAAA,CACb,eACA,aACyB,EAAA;AACzB,EAAA,MAAM,EAAE,MAAA,EAAQ,QAAU,EAAA,SAAA,EAAW,QAAW,GAAA,aAAA,CAAA;AAChD,EAAM,MAAA,EAAE,UAAa,GAAA,aAAA,CAAA;AAErB,EAAA,MAAM,KAAK,MAAM,eAAA,CAAgB,MAAO,CAAA,EAAE,UAAU,CAAA,CAAA;AACpD,EAAA,MAAM,GAAM,GAAA,MAAM,YAAa,CAAA,UAAA,CAAW,MAAM,CAAA,CAAA;AAEhD,EAAA,MAAM,UAAU,YAAa,CAAA;AAAA,IAC3B,EAAI,EAAA,iBAAA;AAAA,IACJ,GAAI,QAAY,IAAA,eAAA;AAAA,IAChB,EAAI,EAAA,YAAY,MAAM,SAAA,CAAU,MAAO,CAAA,EAAE,EAAI,EAAA,MAAA,EAAQ,GAAK,EAAA,MAAA,EAAQ,CAAA,CAAE,GAAI,EAAA;AAAA,GACzE,CAAA,CAAA;AAED,EAAA,MAAM,SAASC,uBAAO,EAAA,CAAA;AACtB,EAAO,MAAA,CAAA,GAAA,CAAIC,wBAAQ,CAAA,IAAA,EAAM,CAAA,CAAA;AAEzB,EAAA,MAAA,CAAO,GAAI,CAAA,SAAA,EAAW,CAAC,CAAA,EAAG,QAAa,KAAA;AACrC,IAAA,MAAA,CAAO,KAAK,OAAO,CAAA,CAAA;AACnB,IAAA,QAAA,CAAS,IAAK,CAAA,EAAE,MAAQ,EAAA,IAAA,EAAM,CAAA,CAAA;AAAA,GAC/B,CAAA,CAAA;AAED,EAAA,MAAA,CAAO,GAAI,CAAA,UAAA,EAAY,OAAO,OAAA,EAAS,QAAa,KAAA;AAClD,IAAA,MAAM,EAAE,SAAA,EAAW,OAAQ,EAAA,GAAI,OAAQ,CAAA,KAAA,CAAA;AAEvC,IAAA,IAAI,OAAO,SAAA,KAAc,QAAY,IAAA,OAAO,YAAY,QAAU,EAAA;AAChE,MAAA,OAAO,QAAS,CAAA,MAAA,CAAO,GAAG,CAAA,CAAE,KAAK,0BAA0B,CAAA,CAAA;AAAA,KAC7D;AAEA,IAAM,MAAA,eAAA,GAAkBP,cAAS,CAAA,OAAA,CAAQ,SAAS,CAAA,CAAA;AAClD,IAAM,MAAA,aAAA,GAAgBA,cAAS,CAAA,OAAA,CAAQ,OAAO,CAAA,CAAA;AAE9C,IAAA,IAAI,CAAC,eAAA,CAAgB,OAAW,IAAA,CAAC,cAAc,OAAS,EAAA;AACtD,MAAA,OAAO,QAAS,CAAA,MAAA,CAAO,GAAG,CAAA,CAAE,KAAK,qBAAqB,CAAA,CAAA;AAAA,KACxD;AAEA,IAAA,MAAM,MAAS,GAAA,MAAM,EAAG,CAAA,WAAA,CAAY,WAAW,OAAO,CAAA,CAAA;AAEtD,IAAM,MAAA,OAAA,GAAoB,MAAO,CAAA,GAAA,CAAI,CAAW,MAAA,MAAA;AAAA,MAC9C,GAAG,MAAA;AAAA,MACH,SAAW,EAAA,IAAA,CAAK,KAAM,CAAA,MAAA,CAAO,SAAS,CAAA;AAAA,KACtC,CAAA,CAAA,CAAA;AAEF,IAAO,OAAA,QAAA,CAAS,KAAK,OAAO,CAAA,CAAA;AAAA,GAC7B,CAAA,CAAA;AAED,EAAA,MAAA,CAAO,GAAI,CAAA,uBAAA,EAAyB,OAAO,CAAA,EAAG,QAAa,KAAA;AACzD,IAAM,MAAA,MAAA,GAAS,MAAM,EAAA,CAAG,cAAe,EAAA,CAAA;AAEvC,IAAA,IAAI,CAAC,MAAQ,EAAA;AACX,MAAA,OAAO,QAAS,CAAA,MAAA,CAAO,GAAG,CAAA,CAAE,KAAK,mBAAmB,CAAA,CAAA;AAAA,KACtD;AAEA,IAAO,OAAA,QAAA,CAAS,KAAK,MAAM,CAAA,CAAA;AAAA,GAC5B,CAAA,CAAA;AAED,EAAO,MAAA,CAAA,GAAA,CAAIQ,iCAAkB,MAAO,CAAA,EAAE,QAAQ,MAAO,EAAC,EAAE,KAAK,CAAA,CAAA;AAC7D,EAAO,OAAA,MAAA,CAAA;AACT;;AC1IO,MAAM,gBAAgBC,oCAAoB,CAAA;AAAA,EAC/C,QAAU,EAAA,SAAA;AAAA,EACV,SAAS,GAAK,EAAA;AACZ,IAAA,GAAA,CAAI,YAAa,CAAA;AAAA,MACf,IAAM,EAAA;AAAA,QACJ,YAAYC,6BAAa,CAAA,UAAA;AAAA,QACzB,QAAQA,6BAAa,CAAA,MAAA;AAAA,QACrB,UAAUA,6BAAa,CAAA,QAAA;AAAA,QACvB,WAAWA,6BAAa,CAAA,SAAA;AAAA,QACxB,QAAQA,6BAAa,CAAA,UAAA;AAAA,OACvB;AAAA,MACA,MAAM,KAAK,EAAE,UAAA,EAAY,QAAQ,QAAU,EAAA,SAAA,EAAW,QAAU,EAAA;AAC9D,QAAW,UAAA,CAAA,GAAA;AAAA,UACT,MAAM,sBAAuB,CAAA;AAAA,YAC3B,MAAA;AAAA,YACA,QAAA;AAAA,YACA,SAAA;AAAA,YACA,MAAA;AAAA,WACD,CAAA;AAAA,SACH,CAAA;AACA,QAAA,UAAA,CAAW,aAAc,CAAA;AAAA,UACvB,IAAM,EAAA,SAAA;AAAA,UACN,KAAO,EAAA,iBAAA;AAAA,SACR,CAAA,CAAA;AAAA,OACH;AAAA,KACD,CAAA,CAAA;AAAA,GACH;AACF,CAAC;;;;;"}

package/dist/index.d.ts

@@ -0,0 +1,60 @@
+import express from 'express';
+import * as _backstage_backend_plugin_api from '@backstage/backend-plugin-api';
+import { SchedulerServiceTaskScheduleDefinition, LoggerService, DatabaseService, SchedulerService } from '@backstage/backend-plugin-api';
+import { Config } from '@backstage/config';
+
+/**
+ * Options for configuring the Copilot plugin.
+ *
+ * @public
+ */
+interface PluginOptions {
+    /**
+     * Schedule configuration for the plugin.
+     */
+    schedule?: SchedulerServiceTaskScheduleDefinition;
+}
+/**
+ * Options for configuring the router used by the Copilot plugin.
+ *
+ * @public
+ */
+interface RouterOptions {
+    /**
+     * Logger service for the router.
+     */
+    logger: LoggerService;
+    /**
+     * Database service for the router.
+     */
+    database: DatabaseService;
+    /**
+     * Scheduler service for the router.
+     */
+    scheduler: SchedulerService;
+    /**
+     * Configuration for the router.
+     */
+    config: Config;
+}
+/**
+ * Creates an Express router configured based on the provided router options and plugin options.
+ *
+ * This function initializes the router with the appropriate middleware and routes based on the
+ * configuration and options provided. It also schedules tasks if scheduling options are provided.
+ *
+ * @param routerOptions - Options for configuring the router, including services and configuration.
+ * @returns A promise that resolves to an Express router instance.
+ *
+ * @public
+ */
+declare function createRouterFromConfig(routerOptions: RouterOptions): Promise<express.Router>;
+
+/**
+ * Backend plugin for Copilot.
+ *
+ * @public
+ */
+declare const copilotPlugin: _backstage_backend_plugin_api.BackendFeatureCompat;
+
+export { type PluginOptions, type RouterOptions, createRouterFromConfig, copilotPlugin as default };

package/migrations/202410131705_init.js

@@ -0,0 +1,75 @@
+/*
+ * Copyright 2021 The Backstage Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+// @ts-check
+
+/**
+ * @param {import('knex').Knex} knex
+ */
+exports.up = async function up(knex) {
+  await knex.schema.createTable('metrics', table => {
+    table.comment('Table for storing metrics');
+    table
+      .date('day')
+      .notNullable()
+      .primary()
+      .comment('Date of the metrics data');
+    table
+      .integer('total_suggestions_count')
+      .notNullable()
+      .comment('Total suggestions count for the day');
+    table
+      .integer('total_acceptances_count')
+      .notNullable()
+      .comment('Total acceptances count for the day');
+    table
+      .integer('total_lines_suggested')
+      .notNullable()
+      .comment('Total lines suggested for the day');
+    table
+      .integer('total_lines_accepted')
+      .notNullable()
+      .comment('Total lines accepted for the day');
+    table
+      .integer('total_active_users')
+      .notNullable()
+      .comment('Total active users for the day');
+    table
+      .integer('total_chat_acceptances')
+      .notNullable()
+      .comment('Total chat acceptances for the day');
+    table
+      .integer('total_chat_turns')
+      .notNullable()
+      .comment('Total chat turns for the day');
+    table
+      .integer('total_active_chat_users')
+      .notNullable()
+      .comment('Total active chat users for the day');
+    table.text('breakdown').notNullable().comment('Breakdown information');
+  });
+
+  await knex.schema.alterTable('metrics', table => {
+    table.index('day', 'idx_metrics_day');
+  });
+};
+
+/**
+ * @param {import('knex').Knex} knex
+ */
+exports.down = async function down(knex) {
+  await knex.schema.dropTable('metrics');
+};

package/package.json

@@ -0,0 +1,72 @@
+{
+  "name": "@backstage-community/plugin-copilot-backend",
+  "version": "0.1.0",
+  "homepage": "https://backstage.io",
+  "license": "Apache-2.0",
+  "main": "dist/index.cjs.js",
+  "types": "dist/index.d.ts",
+  "files": [
+    "dist",
+    "config.d.ts",
+    "migrations/**/*.{js,d.ts}"
+  ],
+  "backstage": {
+    "role": "backend-plugin",
+    "pluginId": "copilot",
+    "pluginPackages": [
+      "@backstage-community/plugin-copilot",
+      "@backstage-community/plugin-copilot-backend",
+      "@backstage-community/plugin-copilot-common"
+    ]
+  },
+  "publishConfig": {
+    "access": "public",
+    "main": "dist/index.cjs.js",
+    "types": "dist/index.d.ts"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/backstage/community-plugins",
+    "directory": "workspaces/copilot/plugins/copilot-backend"
+  },
+  "scripts": {
+    "start": "backstage-cli package start",
+    "build": "backstage-cli package build",
+    "lint": "backstage-cli package lint",
+    "test": "backstage-cli package test",
+    "clean": "backstage-cli package clean",
+    "prepack": "backstage-cli package prepack",
+    "postpack": "backstage-cli package postpack"
+  },
+  "dependencies": {
+    "@backstage-community/plugin-copilot-common": "^0.1.0",
+    "@backstage/backend-app-api": "^0.8.0",
+    "@backstage/backend-common": "^0.23.3",
+    "@backstage/backend-defaults": "^0.4.1",
+    "@backstage/backend-plugin-api": "^0.7.0",
+    "@backstage/backend-tasks": "^0.5.27",
+    "@backstage/config": "^1.2.0",
+    "@backstage/errors": "^1.2.4",
+    "@backstage/integration": "^1.13.0",
+    "@types/express": "*",
+    "express": "^4.17.1",
+    "express-promise-router": "^4.1.0",
+    "knex": "^3.0.0",
+    "luxon": "^3.5.0",
+    "node-fetch": "^2.6.7",
+    "winston": "^3.2.1",
+    "yn": "^4.0.0"
+  },
+  "devDependencies": {
+    "@backstage/backend-test-utils": "^0.4.4",
+    "@backstage/cli": "^0.26.11",
+    "@backstage/plugin-auth-backend": "^0.22.9",
+    "@backstage/plugin-auth-backend-module-guest-provider": "^0.1.8",
+    "@backstage/test-utils": "^1.5.9",
+    "@types/node-fetch": "^2.6.11",
+    "@types/supertest": "^2.0.8",
+    "msw": "^1.0.0",
+    "supertest": "^6.2.4"
+  },
+  "configSchema": "config.d.ts"
+}