Merge pull request #3 from ubiquibot/development

Merge development into main

.cspell.json

@@ -1,7 +1,7 @@
 {
   "$schema": "https://raw.githubusercontent.com/streetsidesoftware/cspell/main/cspell.schema.json",
   "version": "0.2",
-  "ignorePaths": ["**/*.json", "**/*.css", "node_modules", "**/*.log", "./src/adapters/supabase/**/**.ts"],
+  "ignorePaths": ["**/*.json", "**/*.css", "node_modules", "**/*.log", "./src/adapters/supabase/**/**.ts", "./src/types/database.ts", "./supabase/config.toml"],
   "useGitignore": true,
   "language": "en",
   "words": [
@@ -20,7 +20,9 @@
     "Typeguards",
     "sonarjs",
     "knip",
-    "mischeck"
+    "mischeck",
+    "commentbody",
+    "issuebody"
   ],
   "dictionaries": ["typescript", "node", "software-terms"],
   "import": ["@cspell/dict-typescript/cspell-ext.json", "@cspell/dict-node/cspell-ext.json", "@cspell/dict-software-terms"],

.dev.vars.example

@@ -1 +1,3 @@
-MY_SECRET="MY_SECRET"
+SUPABASE_URL=""
+SUPABASE_KEY=""
+OPENAI_API_KEY=""

.env.example

@@ -1 +1,3 @@
-MY_SECRET="MY_SECRET"
+SUPABASE_URL=
+SUPABASE_KEY=
+OPENAI_API_KEY=

.github/knip.ts

@@ -3,10 +3,10 @@ import type { KnipConfig } from "knip";
 const config: KnipConfig = {
   entry: ["build/index.ts"],
   project: ["src/**/*.ts"],
-  ignore: ["src/types/config.ts", "**/__mocks__/**", "**/__fixtures__/**"],
+  ignore: ["src/types/config.ts", "**/__mocks__/**", "**/__fixtures__/**", "src/types/database.ts"],
   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: "@ubiquity-os/comment-vector-embeddings"
 
 on:
   workflow_dispatch:
@@ -18,12 +18,13 @@ on:
 
 jobs:
   compute:
-    name: "plugin name"
+    name: "Comment Embedding Store"
     runs-on: ubuntu-latest
     permissions: write-all
     env:
       SUPABASE_URL: ${{ secrets.SUPABASE_URL }}
       SUPABASE_KEY: ${{ secrets.SUPABASE_KEY }}
+      OPENAI_API_KEY: ${{ secrets.OPENAI_API_KEY }}
 
     steps:
       - uses: actions/checkout@v4
@@ -38,7 +39,8 @@ jobs:
 
       - name: execute directive
         run: npx tsx ./src/main.ts
-        id: plugin-name
+        id: issue-comment-embeddings
         env:
           SUPABASE_URL: ${{ secrets.SUPABASE_URL }}
           SUPABASE_KEY: ${{ secrets.SUPABASE_KEY }}
+          OPENAI_API_KEY: ${{ secrets.OPENAI_API_KEY }}

.github/workflows/database.yml

@@ -0,0 +1,67 @@
+name: Database
+
+on:
+  push:
+    branches:
+      - main
+
+env:
+  SUPABASE_ACCESS_TOKEN: ${{ secrets.SUPABASE_ACCESS_TOKEN }}
+  SUPABASE_DB_PASSWORD: ${{ secrets.SUPABASE_DB_PASSWORD }}
+  SUPABASE_PROJECT_ID: ${{ secrets.SUPABASE_PROJECT_ID }}
+
+jobs:
+  run-migration:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Set up Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: "20.10.0"
+
+      - uses: supabase/setup-cli@v1
+        with:
+          version: latest
+
+      - name: Link Supabase project
+        run: supabase link --project-ref $SUPABASE_PROJECT_ID
+
+      - name: Run migrations
+        run: supabase db push
+
+  generate_types:
+    runs-on: ubuntu-latest
+    needs:
+      - run-migration
+    permissions:
+      contents: write
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Set up Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: "20.10.0"
+
+      - name: Generate Supabase Types
+        run: |
+          yarn install
+          yarn run "supabase:generate:remote"
+
+      - 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 src/types/database.ts
+          if [ -n "$(git diff-index --cached --name-only HEAD)" ]; then
+            git commit -m "chore: updated generated Supabase types" || echo "Lint-staged check failed"
+            git push origin main
+          else
+            echo "No changes to commit"
+          fi
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.gitignore

@@ -1,3 +1,5 @@
+#vscode
+.vscode
 # macOS
 .DS_Store
 # node

README.md

@@ -1,86 +1,55 @@
-# `@ubiquibot/plugin-template`
-
-## Prerequisites
-
-- 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 [manifest.json](./manifest.json) with a proper description of your plugin.
-5. 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:
-
-```yml
-plugins:
-  - name: hello-world
-    id: hello-world
-    uses:
-      - plugin: http://localhost:4000
-        with:
-          # Define configurable items here and the kernel will pass these to the plugin.
-          configurableResponse: "Hello, is it me you are looking for?"
+# `@ubiquibot/issue-comment-embeddings`
+
+This is a plugin for [Ubiquibot](https://github.com/ubiquity/ubiquibot-kernel). It listens for issue comments, and adds them to a vector store. It handles comment edits and deletions as well.
+
+## Configuration
+- Host the plugin on a server that Ubiquibot can access.
+To set up the `.dev.vars` file, you will need to provide the following variables:
+- `SUPABASE_URL`: The URL for your Supabase instance.
+- `SUPABASE_KEY`: The key for your Supabase instance.
+- `OPENAI_API_KEY`: The API key for OpenAI.
+
+## Usage
+- Add the following to your `.ubiquibot.config.yml` file with the appropriate URL:
+```javascript
+  -plugin: http://127.0.0.1:4000
+      runsOn: [ "issue_comment.created", "issue_comment.edited", "issue_comment.deleted" ]
 ```
 
-###### 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.
-
-6. Start building your plugin by adding your logic to the [plugin.ts](./src/plugin.ts) file.
-
-## Testing a plugin
-
-### Worker Plugins
-
-- `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: "",
-  }),
-});
+## Testing Locally
+- Run `yarn install` to install the dependencies.
+- Run `yarn worker` to start the server.
+- Make HTTP requests to the server to test the plugin with content type `Application/JSON`
 ```
+{
+    "stateId": "",
+    "eventName": "issue_comment.created",
+    "eventPayload": {
+        "comment": {
+            "user": {
+                "login" : "COMMENTER"
+            },
+            "body": "<COMMENT_BODY>" ,
+            "id": <UNIQUE_COMMENT_ID>
+        },
+        "repository" : {
+            "name" : "REPONAME",
+            "owner":{
+                "login" : "USERNAME"
+            }
+        },
+        "issue": {
+            "number": <ISSUE_NUMBER>,
+            "body": "<ISSUE_TEXT>"
+        }
+    },
+    "env": {},
+    "settings": {},
+    "ref": "",
+    "authToken": ""
+}
+```
+- Replace the placeholders with the appropriate values.
 
-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
+## Testing
+- Run `yarn test` to run the tests.

eslint.config.mjs

@@ -9,7 +9,7 @@ export default tsEslint.config({
     "@typescript-eslint": tsEslint.plugin,
     "check-file": checkFile,
   },
-  ignores: [".github/knip.ts"],
+  ignores: [".github/knip.ts", "src/types/database.ts"],
   extends: [eslint.configs.recommended, ...tsEslint.configs.recommended, sonarjs.configs.recommended],
   languageOptions: {
     parser: tsEslint.parser,

manifest.json

@@ -1,11 +1,5 @@
 {
-  "name": "ts-template",
-  "description": "ts-template for Ubiquibot plugins.",
-  "ubiquity:listeners": ["issue_comment.created"],
-  "commands": {
-    "command1": {
-      "ubiquity:example": "/command1 argument",
-      "description": "Command 1 with an argument."
-    }
-  }
+  "name": "@ubiquity-os/comment-vector-embeddings",
+  "description": "Issue comment plugin for Ubiquibot. It enables the storage, updating, and deletion of issue comment embeddings.",
+  "ubiquity:listeners": ["issue_comment.created", "issue_comment.edited", "issue_comment.deleted"]
 }

package.json

@@ -1,7 +1,7 @@
 {
-  "name": "plugin-template",
+  "name": "@ubiquibot/issue-comment-embeddings",
   "version": "1.0.0",
-  "description": "Ubiquibot plugin template repository with TypeScript support.",
+  "description": "Generates vector embeddings of GitHub comments and stores them in Supabase.",
   "author": "Ubiquity DAO",
   "license": "MIT",
   "main": "src/worker.ts",
@@ -17,7 +17,9 @@
     "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"
+    "worker": "wrangler dev --env dev --port 4000",
+    "supabase:generate:local": "supabase gen types typescript --local > src/types/database.ts",
+    "supabase:generate:remote": "cross-env-shell \"supabase gen types typescript --project-id $SUPABASE_PROJECT_ID --schema public > src/types/database.ts\""
   },
   "keywords": [
     "typescript",
@@ -32,8 +34,10 @@
     "@octokit/rest": "20.1.1",
     "@octokit/webhooks": "13.2.7",
     "@sinclair/typebox": "0.32.33",
+    "@supabase/supabase-js": "^2.45.2",
     "@ubiquity-dao/ubiquibot-logger": "^1.3.0",
     "dotenv": "16.4.5",
+    "openai": "^4.56.0",
     "typebox-validators": "0.3.5"
   },
   "devDependencies": {
@@ -47,6 +51,7 @@
     "@mswjs/data": "0.16.1",
     "@types/jest": "^29.5.12",
     "@types/node": "20.14.5",
+    "cross-env": "7.0.3",
     "cspell": "8.9.0",
     "eslint": "9.5.0",
     "eslint-config-prettier": "9.1.0",
@@ -61,11 +66,12 @@
     "lint-staged": "15.2.7",
     "npm-run-all": "4.1.5",
     "prettier": "3.3.2",
+    "supabase": "1.191.3",
     "ts-jest": "29.1.5",
     "tsx": "4.15.6",
     "typescript": "5.4.5",
     "typescript-eslint": "7.13.1",
-    "wrangler": "3.60.3"
+    "wrangler": "3.62.0"
   },
   "lint-staged": {
     "*.ts": [

src/adapters/index.ts

@@ -0,0 +1,20 @@
+import { SupabaseClient } from "@supabase/supabase-js";
+import { Context } from "../types";
+import { Comment } from "./supabase/helpers/comment";
+import { SuperSupabase } from "./supabase/helpers/supabase";
+import { SuperOpenAi } from "./openai/helpers/openai";
+import OpenAI from "openai";
+import { Embedding } from "./openai/helpers/embedding";
+
+export function createAdapters(supabaseClient: SupabaseClient, openai: OpenAI, context: Context) {
+  return {
+    supabase: {
+      comment: new Comment(supabaseClient, context),
+      super: new SuperSupabase(supabaseClient, context),
+    },
+    openai: {
+      embedding: new Embedding(openai, context),
+      super: new SuperOpenAi(openai, context),
+    },
+  };
+}