feat: schema validation

.github/workflows/update-configuration.yml

@@ -0,0 +1,58 @@
+name: "Update Configuration"
+
+on:
+  workflow_dispatch:
+  push:
+
+jobs:
+  update:
+    name: "Update Configuration in manifest.json"
+    runs-on: ubuntu-latest
+    permissions: write-all
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Setup node
+        uses: actions/setup-node@v4
+        with:
+          node-version: "20.10.0"
+
+      - name: Install deps and run configuration update
+        run: |
+          yarn install --immutable --immutable-cache --check-cache
+          yarn tsc --noCheck --project tsconfig.json
+
+      - name: Update manifest configuration using GitHub Script
+        uses: actions/github-script@v7
+        with:
+          script: |
+            const fs = require('fs');
+            const path = require('path');
+
+            const { pluginSettingsSchema } = require('./src/types');
+
+            const manifestPath = path.resolve("${{ github.workspace }}", './manifest.json');
+            const manifest = JSON.parse(fs.readFileSync(manifestPath, 'utf8'));
+
+            const configuration = JSON.stringify(pluginSettingsSchema);
+
+            manifest["configuration"] = JSON.parse(configuration);
+
+            const updatedManifest = JSON.stringify(manifest, null, 2)
+            console.log('Updated manifest:', updatedManifest);
+            fs.writeFileSync(manifestPath, updatedManifest);
+
+      - name: Commit and Push generated types
+        run: |
+          git config --global user.name 'github-actions[bot]'
+          git config --global user.email 'github-actions[bot]@users.noreply.github.com'
+          git add ./manifest.json
+          if [ -n "$(git diff-index --cached --name-only HEAD)" ]; then
+            git commit -m "chore: updated generated configuration" || echo "Lint-staged check failed"
+            git push origin HEAD:${{ github.ref_name }}
+          else
+            echo "No changes to commit"
+          fi
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

manifest.json

@@ -1,5 +1,87 @@
 {
   "name": "Automated merging",
   "description": "Automatically merge pull-requests.",
-  "ubiquity:listeners": ["push", "issue_comment.created"]
-}
+  "ubiquity:listeners": [
+    "push",
+    "issue_comment.created"
+  ],
+  "configuration": {
+    "type": "object",
+    "properties": {
+      "approvalsRequired": {
+        "default": {},
+        "type": "object",
+        "properties": {
+          "collaborator": {
+            "default": 1,
+            "minimum": 1,
+            "type": "number"
+          },
+          "contributor": {
+            "default": 2,
+            "minimum": 1,
+            "type": "number"
+          }
+        },
+        "required": [
+          "collaborator",
+          "contributor"
+        ]
+      },
+      "mergeTimeout": {
+        "default": {},
+        "type": "object",
+        "properties": {
+          "collaborator": {
+            "default": "3.5 days",
+            "type": "string"
+          },
+          "contributor": {
+            "default": "7 days",
+            "type": "string"
+          }
+        },
+        "required": [
+          "collaborator",
+          "contributor"
+        ]
+      },
+      "repos": {
+        "default": {},
+        "type": "object",
+        "properties": {
+          "monitor": {
+            "default": [],
+            "type": "array",
+            "items": {
+              "minLength": 1,
+              "type": "string"
+            }
+          },
+          "ignore": {
+            "default": [],
+            "type": "array",
+            "items": {
+              "type": "string"
+            }
+          }
+        },
+        "required": [
+          "monitor",
+          "ignore"
+        ]
+      },
+      "allowedReviewerRoles": {
+        "default": [
+          "COLLABORATOR",
+          "MEMBER",
+          "OWNER"
+        ],
+        "type": "array",
+        "items": {
+          "type": "string"
+        }
+      }
+    }
+  }
+}

package.json

@@ -68,8 +68,8 @@
     "npm-run-all": "4.1.5",
     "prettier": "3.3.2",
     "ts-jest": "29.1.5",
-    "typescript": "5.4.5",
-    "typescript-eslint": "7.13.1"
+    "typescript": "5.6.2",
+    "typescript-eslint": "8.8.0"
   },
   "lint-staged": {
     "*.ts": [

src/action.ts

@@ -11,27 +11,27 @@ export async function run() {
   const payload = github.context.payload.inputs;
 
   payload.env = { ...(payload.env || {}), workflowName: github.context.workflow };
-  const { envDecoded, settingsDecoded } = validateAndDecodeSchemas(payload.env, JSON.parse(payload.settings));
+  const { decodedSettings, decodedEnv } = validateAndDecodeSchemas(payload.env, JSON.parse(payload.settings));
   const inputs: PluginInputs = {
     stateId: payload.stateId,
     eventName: payload.eventName,
     eventPayload: JSON.parse(payload.eventPayload),
-    settings: settingsDecoded,
+    settings: decodedSettings,
     authToken: payload.authToken,
     ref: payload.ref,
   };
 
-  await plugin(inputs, envDecoded);
+  await plugin(inputs, decodedEnv);
 
   return returnDataToKernel(process.env.GITHUB_TOKEN, inputs.stateId, {});
 }
 
-async function returnDataToKernel(repoToken: string, stateId: string, output: object) {
+export async function returnDataToKernel(repoToken: string, stateId: string, output: object, eventType = "return_data_to_ubiquibot_kernel") {
   const octokit = new Octokit({ auth: repoToken });
   return octokit.repos.createDispatchEvent({
     owner: github.context.repo.owner,
     repo: github.context.repo.repo,
-    event_type: "return_data_to_ubiquibot_kernel",
+    event_type: eventType,
     client_payload: {
       state_id: stateId,
       output: JSON.stringify(output),

src/handlers/summary.ts

@@ -9,7 +9,7 @@ export interface ResultInfo {
 
 function generateGitHubSummary(context: Context, urls: ResultInfo[]): string {
   const target = `https://github.com/${context.payload.repository.owner?.login}`;
-  const output: string[] = ["## Merge report\n\n"];
+  const output: (string | undefined)[] = ["## Merge report\n\n"];
   output.push("<samp>\n");
   output.push("| Merged | ID |");
   output.push("|---|---|");
@@ -29,9 +29,9 @@ function generateGitHubSummary(context: Context, urls: ResultInfo[]): string {
   output.push("\n</samp>\n");
   output.push("## Configuration\n\n");
   output.push("### Watching Repositories\n\n");
-  output.push(context.config.repos.monitor.map((o) => `- [${o}](${target}/${o})`).join("\n"));
+  output.push(context.config.repos?.monitor.map((o) => `- [${o}](${target}/${o})`).join("\n"));
   output.push("### Ignored Repositories\n\n");
-  output.push(context.config.repos.ignore.map((o) => `- [${o}](${target}/${o})`).join("\n"));
+  output.push(context.config.repos?.ignore.map((o) => `- [${o}](${target}/${o})`).join("\n"));
   return output.join("\n");
 }
 

src/helpers/github.ts

@@ -23,20 +23,22 @@ export interface Requirements {
  * Gets the merge timeout depending on the status of the assignee. If there are multiple assignees with different
  * statuses, the longest timeout is chosen.
  */
-export async function getMergeTimeoutAndApprovalRequiredCount(context: Context, authorAssociation: string): Promise<Requirements> {
-  const { config: { mergeTimeout, approvalsRequired } } = context;
+export async function getMergeTimeoutAndApprovalRequiredCount(context: Context, authorAssociation: string) {
+  const {
+    config: { mergeTimeout, approvalsRequired },
+  } = context;
   const timeoutCollaborator = {
-    mergeTimeout: mergeTimeout.collaborator,
-    requiredApprovalCount: approvalsRequired.collaborator,
+    mergeTimeout: mergeTimeout?.collaborator,
+    requiredApprovalCount: approvalsRequired?.collaborator,
   };
   const timeoutContributor = {
-    mergeTimeout: mergeTimeout.contributor,
-    requiredApprovalCount: approvalsRequired.contributor,
+    mergeTimeout: mergeTimeout?.contributor,
+    requiredApprovalCount: approvalsRequired?.contributor,
   };
 
   /**
    * Hardcoded roles here because we need to determine the timeouts
-   * separate from `allowedReviewerRoles` which introduces 
+   * separate from `allowedReviewerRoles` which introduces
    * potential unintended user errors and logic issues.
    */
   return ["COLLABORATOR", "MEMBER", "OWNER"].includes(authorAssociation) ? timeoutCollaborator : timeoutContributor;
@@ -49,7 +51,7 @@ export async function getApprovalCount({ octokit, logger, config: { allowedRevie
       repo,
       pull_number: pullNumber,
     });
-    return reviews.filter((review) => allowedReviewerRoles.includes(review.author_association)).filter((review) => review.state === "APPROVED").length;
+    return reviews.filter((review) => allowedReviewerRoles?.includes(review.author_association)).filter((review) => review.state === "APPROVED").length;
   } catch (e) {
     logger.error(`Error fetching reviews' approvals: ${e}`);
     return 0;

src/helpers/update-pull-requests.ts

@@ -2,7 +2,7 @@ import { RestEndpointMethodTypes } from "@octokit/rest";
 import ms from "ms";
 import { getAllTimelineEvents } from "../handlers/github-events";
 import { generateSummary, ResultInfo } from "../handlers/summary";
-import { Context } from "../types";
+import { Context, ReposWatchSettings } from "../types";
 import {
   getApprovalCount,
   getMergeTimeoutAndApprovalRequiredCount,
@@ -30,7 +30,7 @@ export async function updatePullRequests(context: Context) {
   const { logger } = context;
   const results: ResultInfo[] = [];
 
-  if (!context.config.repos.monitor.length) {
+  if (!context.config.repos?.monitor.length) {
     const owner = context.payload.repository.owner;
     if (owner) {
       logger.info(`No organizations or repo have been specified, will default to the organization owner: ${owner.login}.`);
@@ -39,7 +39,7 @@ export async function updatePullRequests(context: Context) {
     }
   }
 
-  const pullRequests = await getOpenPullRequests(context, context.config.repos);
+  const pullRequests = await getOpenPullRequests(context, context.config.repos as ReposWatchSettings);
 
   if (!pullRequests?.length) {
     return logger.info("Nothing to do.");
@@ -74,8 +74,14 @@ export async function updatePullRequests(context: Context) {
       );
       if (isNaN(lastActivityDate.getTime())) {
         logger.info(`PR ${html_url} does not seem to have any activity, nothing to do.`);
-      } else if (isPastOffset(lastActivityDate, requirements.mergeTimeout)) {
-        isMerged = await attemptMerging(context, { gitHubUrl, htmlUrl: html_url, requirements, lastActivityDate, pullRequestDetails });
+      } else if (requirements?.mergeTimeout && isPastOffset(lastActivityDate, requirements?.mergeTimeout)) {
+        isMerged = await attemptMerging(context, {
+          gitHubUrl,
+          htmlUrl: html_url,
+          requirements: requirements as Requirements,
+          lastActivityDate,
+          pullRequestDetails,
+        });
       } else {
         logger.info(`PR ${html_url} has activity up until (${lastActivityDate}), nothing to do.`);
       }

src/helpers/validator.ts

@@ -1,30 +1,39 @@
-import { Value } from "@sinclair/typebox/value";
-import { envSchema, envValidator, PluginSettings, pluginSettingsSchema, pluginSettingsValidator } from "../types";
+import { TransformDecodeCheckError, TransformDecodeError, Value, ValueError } from "@sinclair/typebox/value";
+import { Env, envSchema, envValidator, PluginSettings, pluginSettingsSchema, pluginSettingsValidator } from "../types";
 
-export function validateAndDecodeSchemas(env: object, rawSettings: object) {
+export function validateAndDecodeSchemas(rawEnv: object, rawSettings: object) {
+  const errors: ValueError[] = [];
+
+  console.log(rawEnv, rawSettings);
+  const env = Value.Default(envSchema, rawEnv) as Env;
   if (!envValidator.test(env)) {
-    const errors: object[] = [];
     for (const error of envValidator.errors(env)) {
-      const errorMessage = { path: error.path, message: error.message, value: error.value };
-      console.error(errorMessage);
-      errors.push(errorMessage);
+      console.error(error);
+      errors.push(error);
     }
-    throw new Error(`Invalid environment provided. ${errors}`);
   }
-  const envDecoded = Value.Decode(envSchema, env || {});
 
   const settings = Value.Default(pluginSettingsSchema, rawSettings) as PluginSettings;
   if (!pluginSettingsValidator.test(settings)) {
-    const errors: object[] = [];
     for (const error of pluginSettingsValidator.errors(settings)) {
-      const errorMessage = { path: error.path, message: error.message, value: error.value };
-      console.error(errorMessage);
-      errors.push(errorMessage);
+      console.error(error);
+      errors.push(error);
     }
-    throw new Error(`Invalid settings provided. ${errors}`);
   }
 
-  const settingsDecoded = Value.Decode(pluginSettingsSchema, settings);
+  if (errors.length) {
+    throw { errors };
+  }
 
-  return { envDecoded, settingsDecoded };
+  try {
+    const decodedSettings = Value.Decode(pluginSettingsSchema, settings);
+    const decodedEnv = Value.Decode(envSchema, rawEnv || {});
+    return { decodedEnv, decodedSettings };
+  } catch (e) {
+    console.error("validateAndDecodeSchemas", e);
+    if (e instanceof TransformDecodeCheckError || e instanceof TransformDecodeError) {
+      throw { errors: [e.error] };
+    }
+    throw e;
+  }
 }