feat: pull requests are automatically merged based on their activity

.cspell.json

@@ -4,7 +4,7 @@
   "ignorePaths": ["**/*.json", "**/*.css", "node_modules", "**/*.log", "./src/adapters/supabase/**/**.ts"],
   "useGitignore": true,
   "language": "en",
-  "words": ["Nektos", "dataurl", "devpool", "outdir", "servedir", "Supabase", "SUPABASE", "typebox", "ubiquibot", "Smee"],
+  "words": ["Nektos", "dataurl", "devpool", "outdir", "servedir", "Supabase", "SUPABASE", "typebox", "ubiquibot", "Smee", "typeorm", "timespan", "mswjs"],
   "dictionaries": ["typescript", "node", "software-terms"],
   "import": ["@cspell/dict-typescript/cspell-ext.json", "@cspell/dict-node/cspell-ext.json", "@cspell/dict-software-terms"],
   "ignoreRegExpList": ["[0-9a-fA-F]{6}"]

.github/CODEOWNERS

@@ -1 +1 @@
-
+./** @gentlementlegen

.github/knip.ts

@@ -6,7 +6,7 @@ const config: KnipConfig = {
   ignore: ["src/types/config.ts", "**/__mocks__/**", "**/__fixtures__/**"],
   ignoreExportsUsedInFile: true,
   // eslint can also be safely ignored as per the docs: https://knip.dev/guides/handling-issues#eslint--jest
-  ignoreDependencies: ["eslint-config-prettier", "eslint-plugin-prettier", "@mswjs/data"],
+  ignoreDependencies: ["eslint-config-prettier", "eslint-plugin-prettier"],
   eslint: true,
 };
 

.github/workflows/compute.yml

@@ -1,4 +1,4 @@
-name: "the name of the plugin"
+name: "Automated Merging"
 
 on:
   workflow_dispatch:
@@ -16,29 +16,81 @@ on:
       ref:
         description: "Ref"
 
+# Limits to one job at a time
+#concurrency:
+#  group: ${{ github.workflow }}
+
 jobs:
   compute:
-    name: "plugin name"
+    name: "Automated Merging"
     runs-on: ubuntu-latest
     permissions: write-all
-    env:
-      SUPABASE_URL: ${{ secrets.SUPABASE_URL }}
-      SUPABASE_KEY: ${{ secrets.SUPABASE_KEY }}
 
     steps:
       - uses: actions/checkout@v4
 
-      - name: setup node
+      - name: Setup node
         uses: actions/setup-node@v4
         with:
           node-version: "20.10.0"
 
-      - name: install dependencies
-        run: yarn
+      - name: Install dependencies
+        run: yarn install --immutable --immutable-cache --check-cache
+
+      - run: ${{ toJSON(inputs) }}
+        shell: cat {0}
 
-      - name: execute directive
+      - name: Execute directive
         run: npx tsx ./src/main.ts
-        id: plugin-name
+        id: automated-merging
         env:
-          SUPABASE_URL: ${{ secrets.SUPABASE_URL }}
-          SUPABASE_KEY: ${{ secrets.SUPABASE_KEY }}
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
+      # Will try to upload the changes made within the DB during the run.
+      # If all tries fail, an artifact containing the db is uploaded.
+      - name: Commit and Push DB updates with Retry
+        id: commit_and_push
+        run: |
+          git config --global user.name 'github-actions[bot]'
+          git config --global user.email 'github-actions[bot]@users.noreply.github.com'
+          git config --global pull.rebase false
+          git add database/sql.db
+
+          attempts=0
+          max_attempts=10
+          success=false
+
+          while [ $attempts -lt $max_attempts ]; do
+            if [ -n "$(git diff-index --cached --name-only HEAD)" ]; then
+              if git commit -m "chore: [skip ci] updated database"; then
+                git pull -X ours
+                if git push origin main; then
+                  success=true
+                  break
+                fi
+              else
+                echo "Commit failed, retrying..."
+              fi
+            else
+              echo "No changes to commit"
+              success=true
+              break
+            fi
+            attempts=$((attempts + 1))
+            echo "Attempt $attempts/$max_attempts failed, retrying in 10 seconds..."
+            sleep 10
+          done
+
+          if [ "$success" = false ]; then
+            echo "Failed to commit and push changes after $max_attempts attempts" | tee failure.log
+            exit 1
+          fi
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Upload Failure Log
+        if: steps.commit_and_push.outcome == 'failure'
+        uses: actions/upload-artifact@v4
+        with:
+           name: sql.db
+           path: database/sql.db

.github/workflows/jest-testing.yml

@@ -21,6 +21,8 @@ jobs:
 
       - name: Jest With Coverage
         run: yarn install --immutable --immutable-cache --check-cache && yarn test
+        env:
+          GITHUB_TOKEN: "gh_token"
 
       - name: Add Jest Report to Summary
         if: always()

.github/workflows/release-please.yml

@@ -17,3 +17,4 @@ jobs:
       - uses: googleapis/release-please-action@v4
         with:
           release-type: simple
+          target-branch: main

.gitignore

@@ -14,4 +14,6 @@ coverage
 junit.xml
 cypress/screenshots
 script.ts
-.wrangler
+.wrangler
+test-dashboard.md
+database/tests/*

README.md

@@ -1,93 +1,26 @@
-# `@ubiquibot/plugin-template`
+# `@ubiquibot/automated-merging`
 
-## Prerequisites
+Automatically merge pull-requests based on the reviewer count, the time elapsed since the last activity, depending 
+on the association of the pull-request author.
 
-- A good understanding of how the [kernel](https://github.com/ubiquity/ubiquibot-kernel) works and how to interact with it.
-- A basic understanding of the Ubiquibot configuration and how to define your plugin's settings.
-
-## Getting Started
-
-1. Create a new repository using this template.
-2. Clone the repository to your local machine.
-3. Install the dependencies preferably using `yarn` or `bun`.
-
-## Creating a new plugin
-
-- If your plugin is to be used as a slash command which should have faster response times as opposed to longer running GitHub action tasks, you should use the `worker` type.
-
-1. Ensure you understand and have setup the [kernel](https://github.com/ubiquity/ubiquibot-kernel).
-2. Update [compute.yml](./.github/workflows/compute.yml) with your plugin's name and update the `id`.
-3. Update [context.ts](./src/types/context.ts) with the events that your plugin will fire on.
-4. Update [plugin-inputs.ts](./src/types/plugin-inputs.ts) to match the `with:` settings in your org or repo level configuration.
-
-- Your plugin config should look similar to this:
+## Configuration example
 
 ```yml
-- plugin: <plugin-org/owner>/<plugin-repo-name>:compute.yml@development
-  name: plugin-name
-  id: plugin-name-command
-  description: "Plugin description" # small description of what the plugin does
-  command: "<regex for command>" # if you are creating a plugin with a slash command
-  example: "<example usage>" # how to invoke the slash command
-  with: # these are the example settings, the kernel passes these to the plugin.
-    disabledCommands: []
-    timers:
-      reviewDelayTolerance: 86000
-      taskStaleTimeoutDuration: 2580000
-    miscellaneous:
-      maxConcurrentTasks: 3
-    labels:
-      time: []
-      priority: []
+- plugin: ubiquibot/automated-merging
+  name: automated-merging
+  id: automated-merging
+  description: "Automatically merge pull-requests."
+  with:
+    approvalsRequired:
+      collaborator: 1 # defaults to 1
+      contributor: 2 # defaults to 2
+    mergeTimeout:
+      collaborator: "3.5 days" # defaults to 3.5 days
+      contributor: "7 days" # defaults to 7 days
 ```
 
-###### At this stage, your plugin will fire on your defined events with the required settings passed in from the kernel. You can now start writing your plugin's logic.
-
-5. Start building your plugin by adding your logic to the [plugin.ts](./src/plugin.ts) file.
-
-## Testing a plugin
-
-### Worker Plugins
+## Testing
 
-- `yarn/bun worker` - to run the worker locally.
-- To trigger the worker, `POST` requests to http://localhost:4000/ with an event payload similar to:
-
-```ts
-await fetch("http://localhost:4000/", {
-  method: "POST",
-  headers: {
-    "Content-Type": "application/json",
-  },
-  body: JSON.stringify({
-    stateId: "",
-    eventName: "",
-    eventPayload: "",
-    settings: "",
-    ref: "",
-    authToken: "",
-  }),
-});
+```shell
+yarn test
 ```
-
-A full example can be found [here](https://github.com/ubiquibot/assistive-pricing/blob/623ea3f950f04842f2d003bda3fc7b7684e41378/tests/http/request.http).
-
-### Action Plugins
-
-- Ensure the kernel is running and listening for events.
-- Fire an event in/to the repo where the kernel is installed. This can be done in a number of ways, the easiest being via the GitHub UI or using the GitHub API, such as posting a comment, opening an issue, etc in the org/repo where the kernel is installed.
-- The kernel will process the event and dispatch it using the settings defined in your `.ubiquibot-config.yml`.
-- The `compute.yml` workflow will run and execute your plugin's logic.
-- You can view the logs in the Actions tab of your repo.
-
-[Nektos Act](https://github.com/nektos/act) - a tool for running GitHub Actions locally.
-
-## More information
-
-- [Full Ubiquibot Configuration](https://github.com/ubiquity/ubiquibot/blob/0fde7551585499b1e0618ec8ea5e826f11271c9c/src/types/configuration-types.ts#L62) - helpful for defining your plugin's settings as they are strongly typed and will be validated by the kernel.
-- [Ubiquibot V1](https://github.com/ubiquity/ubiquibot) - helpful for porting V1 functionality to V2, helper/utility functions, types, etc. Everything is based on the V1 codebase but with a more modular approach. When using V1 code, keep in mind that most all code will need refactored to work with the new V2 architecture.
-
-## Examples
-
-- [Start/Stop Slash Command](https://github.com/ubq-testing/start-stop-module) - simple
-- [Assistive Pricing Plugin](https://github.com/ubiquibot/assistive-pricing) - complex
-- [Conversation Rewards](https://github.com/ubiquibot/conversation-rewards) - really complex

manifest.json

@@ -0,0 +1,5 @@
+{
+  "name": "Automated merging",
+  "description": "Automatically merge pull-requests.",
+  "ubiquity:listeners": [ "push", "pull_request.opened", "pull_request.reopened" ]
+}

package.json

@@ -1,10 +1,10 @@
 {
-  "name": "plugin-template",
+  "name": "@ubiquibot/automated-merging",
   "version": "1.0.0",
-  "description": "Ubiquibot plugin template repository with TypeScript support.",
+  "description": "Conditionally merge pull requests after a timeout.",
   "author": "Ubiquity DAO",
   "license": "MIT",
-  "main": "src/worker.ts",
+  "main": "src/main.ts",
   "engines": {
     "node": ">=20.10.0"
   },
@@ -16,8 +16,7 @@
     "knip": "knip --config .github/knip.ts",
     "knip-ci": "knip --no-exit-code --reporter json --config .github/knip.ts",
     "prepare": "husky install",
-    "test": "jest --setupFiles dotenv/config --coverage",
-    "worker": "wrangler dev --env dev --port 4000"
+    "test": "jest --setupFiles dotenv/config --coverage"
   },
   "keywords": [
     "typescript",
@@ -32,9 +31,14 @@
     "@octokit/rest": "20.1.1",
     "@octokit/webhooks": "13.2.7",
     "@sinclair/typebox": "0.32.33",
-    "@supabase/supabase-js": "2.43.5",
+    "@ubiquity-dao/ubiquibot-logger": "1.2.0",
     "dotenv": "16.4.5",
-    "typebox-validators": "0.3.5"
+    "ms": "2.1.3",
+    "reflect-metadata": "0.2.2",
+    "sqlite3": "5.1.7",
+    "ts-retry": "4.2.5",
+    "typebox-validators": "0.3.5",
+    "typeorm": "0.3.20"
   },
   "devDependencies": {
     "@commitlint/cli": "19.3.0",
@@ -45,6 +49,7 @@
     "@eslint/js": "9.5.0",
     "@jest/globals": "29.7.0",
     "@mswjs/data": "0.16.1",
+    "@types/ms": "0.7.34",
     "@types/node": "20.14.5",
     "cspell": "8.9.0",
     "eslint": "9.5.0",
@@ -58,13 +63,13 @@
     "jest-md-dashboard": "0.8.0",
     "knip": "5.21.2",
     "lint-staged": "15.2.7",
+    "msw": "2.3.1",
     "npm-run-all": "4.1.5",
     "prettier": "3.3.2",
     "ts-jest": "29.1.5",
     "tsx": "4.15.6",
     "typescript": "5.4.5",
-    "typescript-eslint": "7.13.1",
-    "wrangler": "3.60.3"
+    "typescript-eslint": "7.13.1"
   },
   "lint-staged": {
     "*.ts": [

src/action.ts

@@ -0,0 +1,60 @@
+import * as github from "@actions/github";
+import { Octokit } from "@octokit/rest";
+import { Value } from "@sinclair/typebox/value";
+import { plugin } from "./plugin";
+import { envSchema, envValidator, PluginInputs, pluginSettingsSchema, pluginSettingsValidator } from "./types";
+
+/**
+ * How a GitHub action executes the plugin.
+ */
+export async function run() {
+  const payload = github.context.payload.inputs;
+
+  payload.env = { ...(payload.env || {}), workflowName: github.context.workflow };
+  if (!envValidator.test(payload.env)) {
+    const errors: string[] = [];
+    for (const error of envValidator.errors(payload.env)) {
+      console.error(error);
+      errors.push(`${error.path}: ${error.message}`);
+    }
+    throw new Error(`Invalid environment provided:\n${errors.join(";\n")}`);
+  }
+  const env = Value.Decode(envSchema, payload.env || {});
+
+  payload.settings = Value.Default(pluginSettingsSchema, JSON.parse(payload.settings));
+  if (!pluginSettingsValidator.test(payload.settings)) {
+    const errors: string[] = [];
+    for (const error of pluginSettingsValidator.errors(payload.settings)) {
+      console.error(error);
+      errors.push(`${error.path}: ${error.message}`);
+    }
+    throw new Error(`Invalid settings provided:\n${errors.join(";\n")}`);
+  }
+
+  const settings = Value.Decode(pluginSettingsSchema, payload.settings);
+  const inputs: PluginInputs = {
+    stateId: payload.stateId,
+    eventName: payload.eventName,
+    eventPayload: JSON.parse(payload.eventPayload),
+    settings,
+    authToken: payload.authToken,
+    ref: payload.ref,
+  };
+
+  await plugin(inputs, env);
+
+  return returnDataToKernel(process.env.GITHUB_TOKEN, inputs.stateId, {});
+}
+
+async function returnDataToKernel(repoToken: string, stateId: string, output: object) {
+  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",
+    client_payload: {
+      state_id: stateId,
+      output: JSON.stringify(output),
+    },
+  });
+}