Merge development into main

.cspell.json

@@ -15,7 +15,7 @@
     "supabase",
     "SUPABASE",
     "typebox",
-    "ubiquibot",
+    "ubiquity-os",
     "signoff",
     "sonarjs",
     "mswjs",

.dev.vars.example

@@ -1,2 +1,3 @@
 SUPABASE_URL=
 SUPABASE_KEY=
+BOT_USER_ID=

.github/workflows/update-configuration.yml

@@ -0,0 +1,61 @@
+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: Enable corepack
+        run: corepack enable
+
+      - name: Install deps and run configuration update
+        run: |
+          yarn install
+          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/plugin-input');
+
+            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 'ubiquity-os[bot]'
+          git config --global user.email 'ubiquity-os[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 }}

.github/workflows/worker-delete.yml

@@ -7,6 +7,7 @@ jobs:
   delete:
     runs-on: ubuntu-latest
     name: Delete Deployment
+    environment: ${{ github.ref == 'refs/heads/main' && 'main' || 'development' }}
     steps:
       - name: Setup Node
         uses: actions/setup-node@v4

.github/workflows/worker-deploy.yml

@@ -8,6 +8,7 @@ jobs:
   deploy:
     runs-on: ubuntu-latest
     name: Deploy
+    environment: ${{ github.ref == 'refs/heads/main' && 'main' || 'development' }}
     steps:
       - name: Setup Node
         uses: actions/setup-node@v4
@@ -35,17 +36,17 @@ jobs:
         id: wrangler_deploy
         uses: cloudflare/wrangler-action@v3
         with:
-          wranglerVersion: "3.57.0"
+          wranglerVersion: "3.79.0"
           apiToken: ${{ secrets.CLOUDFLARE_API_TOKEN }}
           accountId: ${{ secrets.CLOUDFLARE_ACCOUNT_ID }}
           secrets: |
             SUPABASE_URL
             SUPABASE_KEY
-            APP_ID
+            BOT_USER_ID
         env:
           SUPABASE_URL: ${{ secrets.SUPABASE_URL }}
           SUPABASE_KEY: ${{ secrets.SUPABASE_KEY }}
-          APP_ID: ${{ secrets.APP_ID }}
+          BOT_USER_ID: ${{ secrets.BOT_USER_ID }}
 
       - name: Write Deployment URL to Summary
         run: |

.gitignore

@@ -15,4 +15,5 @@ junit.xml
 cypress/screenshots
 script.ts
 .wrangler
-test-dashboard.md
+test-dashboard.md
+*.env.json

README.md

@@ -1,4 +1,4 @@
-# `@ubiquibot/command-start-stop`
+# `@ubiquity-os/command-start-stop`
 
 This plugin allows a hunter to begin a task as well as gracefully stop a task without incurring a negative impact on the hunter's XP or karma.
 
@@ -24,9 +24,9 @@ To stop a task, a hunter should use the `/stop` command. This will unassign them
 
 ### [Configuration](./src/types/plugin-input.ts)
 
-#### Note: The command name is `"start"` when configuring your `.ubiquibot-config.yml` file.
+#### Note: The command name is `"start"` when configuring your `.ubiquity-os.config.yml` file.
 
-To configure your Ubiquibot to run this plugin, add the following to the `.ubiquibot-config.yml` file in your organization configuration repository.
+To configure your Ubiquibot to run this plugin, add the following to the `.ubiquity-os.config.yml` file in your organization configuration repository.
 
 ```yml
 - plugin: http://localhost:4000 # or the URL where the plugin is hosted
@@ -38,9 +38,12 @@ To configure your Ubiquibot to run this plugin, add the following to the `.ubiqu
   with:
     reviewDelayTolerance: "3 Days"
     taskStaleTimeoutDuration: "30 Days"
-    maxConcurrentTasks: 3
+    maxConcurrentTasks: # Default concurrent task limits per role.
+      member: 5
+      contributor: 3
     startRequiresWallet: true # default is true
     emptyWalletText: "Please set your wallet address with the /wallet command first and try again."
+    rolesWithReviewAuthority: ["MEMBER", "OWNER"]
 ```
 
 # Testing

graphql.config.yml

@@ -0,0 +1,6 @@
+schema:
+  - https://api.github.com/graphql:
+      headers:
+        Authorization: Bearer ${GITHUB_TOKEN}
+documents: src/**.ts
+projects: {}

manifest.json

@@ -1,7 +1,13 @@
 {
   "name": "Start | Stop",
   "description": "Assign or un-assign yourself from an issue.",
-  "ubiquity:listeners": ["issue_comment.created", "issues.assigned"],
+  "ubiquity:listeners": [
+    "issue_comment.created",
+    "issues.assigned",
+    "issues.unassigned",
+    "pull_request.opened",
+    "pull_request.edited"
+  ],
   "commands": {
     "start": {
       "ubiquity:example": "/start",
@@ -11,5 +17,59 @@
       "ubiquity:example": "/stop",
       "description": "Unassign yourself from the issue."
     }
+  },
+  "configuration": {
+    "default": {},
+    "type": "object",
+    "properties": {
+      "reviewDelayTolerance": {
+        "default": "1 Day",
+        "type": "string"
+      },
+      "taskStaleTimeoutDuration": {
+        "default": "30 Days",
+        "type": "string"
+      },
+      "startRequiresWallet": {
+        "default": true,
+        "type": "boolean"
+      },
+      "maxConcurrentTasks": {
+        "default": {
+          "member": 10,
+          "contributor": 2
+        },
+        "type": "object",
+        "patternProperties": {
+          "^(.*)$": {
+            "type": "integer"
+          }
+        }
+      },
+      "emptyWalletText": {
+        "default": "Please set your wallet address with the /wallet command first and try again.",
+        "type": "string"
+      },
+      "rolesWithReviewAuthority": {
+        "default": [
+          "COLLABORATOR",
+          "OWNER",
+          "MEMBER",
+          "ADMIN"
+        ],
+        "type": "array",
+        "items": {
+          "type": "string"
+        }
+      }
+    },
+    "required": [
+      "reviewDelayTolerance",
+      "taskStaleTimeoutDuration",
+      "startRequiresWallet",
+      "maxConcurrentTasks",
+      "emptyWalletText",
+      "rolesWithReviewAuthority"
+    ]
   }
-}
+}

package.json

@@ -1,5 +1,5 @@
 {
-  "name": "@ubiquibot/command-start-stop",
+  "name": "@ubiquity-os/command-start-stop",
   "version": "1.0.0",
   "description": "Enables the assignment and graceful unassignment of tasks to contributors.",
   "main": "src/worker.ts",
@@ -9,8 +9,6 @@
     "node": ">=20.10.0"
   },
   "scripts": {
-    "start": "tsx build/esbuild-server.ts",
-    "build": "tsx build/esbuild-build.ts",
     "format": "run-s format:lint format:prettier format:cspell",
     "format:lint": "eslint --fix .",
     "format:prettier": "prettier --write .",
@@ -29,11 +27,14 @@
     "open-source"
   ],
   "dependencies": {
+    "@octokit/graphql-schema": "15.25.0",
+    "@octokit/plugin-paginate-graphql": "5.2.2",
     "@octokit/rest": "20.1.1",
+    "@octokit/types": "^13.6.1",
     "@octokit/webhooks": "13.2.7",
     "@sinclair/typebox": "^0.32.5",
     "@supabase/supabase-js": "2.42.0",
-    "@ubiquity-dao/ubiquibot-logger": "^1.3.1",
+    "@ubiquity-os/ubiquity-os-logger": "^1.3.2",
     "dotenv": "^16.4.4",
     "ms": "^2.1.3",
     "typebox-validators": "^0.3.5"
@@ -66,9 +67,9 @@
     "prettier": "3.3.2",
     "ts-jest": "29.1.5",
     "tsx": "4.15.6",
-    "typescript": "5.4.5",
+    "typescript": "5.6.2",
     "typescript-eslint": "7.13.1",
-    "wrangler": "3.60.3"
+    "wrangler": "^3.79.0"
   },
   "lint-staged": {
     "*.ts": [

src/adapters/supabase/helpers/user.ts

@@ -17,10 +17,8 @@ export class User extends Super {
     if ((error && !data) || !data.wallets?.address) {
       this.context.logger.error("No wallet address found", { userId, issueNumber });
       if (this.context.config.startRequiresWallet) {
-        await addCommentToIssue(this.context, this.context.config.emptyWalletText);
+        await addCommentToIssue(this.context, this.context.logger.error(this.context.config.emptyWalletText, { userId, issueNumber }).logMessage.diff);
         throw new Error("No wallet address found");
-      } else {
-        await addCommentToIssue(this.context, this.context.config.emptyWalletText);
       }
     } else {
       this.context.logger.info("Successfully fetched wallet", { userId, address: data.wallets?.address });

src/handlers/shared/check-assignments.ts

@@ -2,6 +2,9 @@ import { Context } from "../../types";
 import { getOwnerRepoFromHtmlUrl } from "../../utils/issue";
 
 async function getUserStopComments(context: Context, username: string): Promise<number> {
+  if (!("issue" in context.payload)) {
+    throw new Error("The context does not contain an issue.");
+  }
   const { payload, octokit, logger } = context;
   const { number, html_url } = payload.issue;
   const { owner, repo } = getOwnerRepoFromHtmlUrl(html_url);
@@ -21,7 +24,7 @@ async function getUserStopComments(context: Context, username: string): Promise<
 
 export async function hasUserBeenUnassigned(context: Context, username: string): Promise<boolean> {
   const {
-    env: { APP_ID },
+    env: { BOT_USER_ID },
   } = context;
   const events = await getAssignmentEvents(context);
   const userAssignments = events.filter((event) => event.assignee === username);
@@ -33,9 +36,9 @@ export async function hasUserBeenUnassigned(context: Context, username: string):
   const unassignedEvents = userAssignments.filter((event) => event.event === "unassigned");
   // all bot unassignments (/stop, disqualification,  etc)
   // TODO: task-xp-guard: will also prevent future assignments so we need to add a comment tracker we can use here
-  const botUnassigned = unassignedEvents.filter((event) => event.actorId === APP_ID);
+  const botUnassigned = unassignedEvents.filter((event) => event.actorId === BOT_USER_ID);
   // UI assignment
-  const adminUnassigned = unassignedEvents.filter((event) => event.actor !== username && event.actorId !== APP_ID);
+  const adminUnassigned = unassignedEvents.filter((event) => event.actor !== username && event.actorId !== BOT_USER_ID);
   // UI assignment
   const userUnassigned = unassignedEvents.filter((event) => event.actor === username);
   const userStopComments = await getUserStopComments(context, username);
@@ -52,6 +55,9 @@ export async function hasUserBeenUnassigned(context: Context, username: string):
 }
 
 async function getAssignmentEvents(context: Context) {
+  if (!("issue" in context.payload)) {
+    throw new Error("The context does not contain an issue.");
+  }
   const { repository, issue } = context.payload;
   try {
     const data = await context.octokit.paginate(context.octokit.issues.listEventsForTimeline, {

src/handlers/shared/generate-assignment-comment.ts

@@ -11,12 +11,12 @@ export const options: Intl.DateTimeFormatOptions = {
   timeZoneName: "short",
 };
 
-export function getDeadline(issue: Context["payload"]["issue"]): string | null {
-  if (!issue?.labels) {
+export function getDeadline(labels: Context<"issue_comment.created">["payload"]["issue"]["labels"] | undefined | null): string | null {
+  if (!labels?.length) {
     throw new Error("No labels are set.");
   }
   const startTime = new Date().getTime();
-  const duration: number = calculateDurations(issue.labels).shift() ?? 0;
+  const duration: number = calculateDurations(labels).shift() ?? 0;
   if (!duration) return null;
   const endTime = new Date(startTime + duration * 1000);
   return endTime.toLocaleString("en-US", options);
@@ -30,12 +30,16 @@ export async function generateAssignmentComment(context: Context, issueCreatedAt
     deadline: deadline ?? null,
     registeredWallet:
       (await context.adapters.supabase.user.getWalletByUserId(senderId, issueNumber)) ||
-      "Register your wallet address using the following slash command: `/wallet 0x0000...0000`",
-    tips: `<h6>Tips:</h6>
-    <ul>
-    <li>Use <code>/wallet 0x0000...0000</code> if you want to update your registered payment wallet address.</li>
-    <li>Be sure to open a draft pull request as soon as possible to communicate updates on your progress.</li>
-    <li>Be sure to provide timely updates to us when requested, or you will be automatically unassigned from the task.</li>
-    <ul>`,
+      `
+
+> [!WARNING]
+> Register your wallet to be eligible for rewards.
+
+`,
+    tips: `
+> [!TIP]
+> - Use <code>/wallet 0x0000...0000</code> if you want to update your registered payment wallet address.
+> - Be sure to open a draft pull request as soon as possible to communicate updates on your progress.
+> - Be sure to provide timely updates to us when requested, or you will be automatically unassigned from the task.`,
   };
 }