Merge pull request #10 from ubiquibot/development

Merge development into main

.cspell.json

@@ -1,10 +1,10 @@
 {
   "$schema": "https://raw.githubusercontent.com/streetsidesoftware/cspell/main/cspell.schema.json",
   "version": "0.2",
-  "ignorePaths": ["**/*.json", "**/*.css", "node_modules", "**/*.log", "**/*.toml", "src/adapters/supabase/types/database.ts"],
+  "ignorePaths": ["**/*.json", "**/*.css", "node_modules", "**/*.log", "**/*.toml", "**/*.http", "src/adapters/supabase/types/database.ts"],
   "useGitignore": true,
   "language": "en",
-  "words": ["dataurl", "devpool", "outdir", "servedir", "supabase", "typebox", "typeguards"],
+  "words": ["dataurl", "devpool", "outdir", "servedir", "supabase", "typebox", "typeguards", "mswjs", "ubiquibot"],
   "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}"]

.dev.vars.example

@@ -0,0 +1,3 @@
+SUPABASE_URL=
+SUPABASE_KEY=
+UBIQUIBOT_PUBLIC_KEY=

.env.example

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

.github/knip.ts

@@ -1,11 +1,11 @@
 import type { KnipConfig } from "knip";
 
 const config: KnipConfig = {
-  entry: ["build/index.ts"],
+  entry: ["src/index.ts"],
   project: ["src/**/*.ts"],
-  ignore: ["src/types/config.ts"],
+  ignore: ["src/types/config.ts", "src/adapters/supabase/types/database.ts"],
   ignoreExportsUsedInFile: true,
-  ignoreDependencies: [],
+  ignoreDependencies: ["ts-node", "@types/jest"],
 };
 
 export default config;

.github/workflows/compute.yml

@@ -34,8 +34,23 @@ jobs:
         with:
           node-version: "20"
 
-      - name: Install Bun
-        run: npm install -g bun
+      - uses: oven-sh/setup-bun@v1
+
+      - name: Generate Supabase Types
+        run: |
+          yarn install
+          yarn run "supabase:generate:remote"
+        env:
+          SUPABASE_PROJECT_ID: ${{ secrets.SUPABASE_PROJECT_ID }}
+          SUPABASE_ACCESS_TOKEN: ${{ secrets.SUPABASE_ACCESS_TOKEN }}
+
+      - name: Generate Supabase Types
+        run: |
+          yarn install
+          yarn run "supabase:generate:remote"
+        env:
+          SUPABASE_PROJECT_ID: ${{ secrets.SUPABASE_PROJECT_ID }}
+          SUPABASE_ACCESS_TOKEN: ${{ secrets.SUPABASE_ACCESS_TOKEN }}
 
       - name: Calling action
         uses: ./

.github/workflows/jest-testing.yml

@@ -1,7 +1,7 @@
 name: Run Jest testing suite
 on:
   workflow_dispatch:
-  pull_request_target:
+  pull_request:
     types: [ opened, synchronize ]
 
 env:

.github/workflows/knip-reporter.yml

@@ -0,0 +1,40 @@
+name: Knip-reporter
+
+on:
+  workflow_run:
+    workflows: ["Knip"]
+    types:
+      - completed
+
+permissions: write-all
+
+jobs:
+  knip-reporter:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/download-artifact@v4
+        with:
+          name: knip-results
+          run-id: ${{ github.event.workflow_run.id }}
+          github-token: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Read pr number
+        id: pr-number
+        uses: juliangruber/read-file-action@v1
+        with:
+          path: ./pr-number.txt
+          trim: true
+
+      - name: Report knip results to pull request
+        if: ${{ github.event.workflow_run.conclusion != 'success' }}
+        uses: gitcoindev/knip-reporter@main
+        with:
+          verbose: true
+          comment_id: ${{ github.workflow }}-reporter
+          command_script_name: knip-ci
+          annotations: true
+          ignore_results: false
+          json_input: true
+          json_input_file_name: knip-results.json
+          pull_request_number: ${{ steps.pr-number.outputs.content }}
+          token: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/knip.yml

@@ -1,11 +1,9 @@
 name: Knip
 
 on:
-  pull_request_target:
+  pull_request:
   workflow_dispatch:
 
-permissions: write-all
-
 jobs:
   run-knip:
     runs-on: ubuntu-latest
@@ -21,11 +19,17 @@ jobs:
       - name: Install toolchain
         run: yarn install
 
-      - name: Report knip results to pull request
-        uses: Codex-/knip-reporter@v2
+      - name: Store PR number
+        run: echo ${{ github.event.number }} > pr-number.txt
+
+      - name: Run Knip
+        run: yarn knip || yarn knip --reporter json > knip-results.json
+
+      - name: Upload knip result
+        if: failure()
+        uses: actions/upload-artifact@v4
         with:
-          verbose: true
-          comment_id: ${{ github.workflow }}-reporter
-          command_script_name: knip-ci
-          annotations: true
-          ignore_results: false
+          name: knip-results
+          path: |
+            knip-results.json
+            pr-number.txt

.github/workflows/release-please.yml

@@ -0,0 +1,20 @@
+name: release-please
+
+on:
+  workflow_dispatch:
+  push:
+    branches:
+      - $default-branch
+
+permissions:
+  contents: write
+  pull-requests: write
+
+jobs:
+  release-please:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: google-github-actions/release-please-action@v4
+        with:
+          release-type: simple

.github/workflows/worker-deploy.yml

@@ -0,0 +1,30 @@
+name: Deploy
+
+on:
+  workflow_dispatch:
+  push:
+    branches:
+      - main
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    name: Deploy
+    steps:
+      - name: Setup Node
+        uses: actions/setup-node@v4
+        with:
+          node-version: "20.10.0"
+      - uses: actions/checkout@v4
+      - uses: cloudflare/wrangler-action@v3
+        with:
+          wranglerVersion: '3.57.0'
+          apiToken: ${{ secrets.CLOUDFLARE_API_TOKEN }}
+          secrets: |
+            SUPABASE_URL
+            SUPABASE_KEY
+            UBIQUIBOT_PUBLIC_KEY
+        env:
+          SUPABASE_URL: ${{ secrets.SUPABASE_URL }}
+          SUPABASE_KEY: ${{ secrets.SUPABASE_KEY }}
+          UBIQUIBOT_PUBLIC_KEY: ${{ secrets.UBIQUIBOT_PUBLIC_KEY }}

.gitignore

@@ -11,3 +11,6 @@ static/dist
 coverage
 junit.xml
 cypress/screenshots
+
+.dev.vars
+/tests/http/http-client.private.env.json

README.md

@@ -1,25 +1,62 @@
-# `@ubiquity/ts-template`
+# `@ubiquibot/assistive-pricing`
 
-This template repository includes support for the following:
+Helps settings prices and adds label to the issues accordingly.
 
-- TypeScript
-- Environment Variables
-- Conventional Commits
-- Automatic deployment to Cloudflare Pages
-
-## Testing
+## Usage
+Example of valid configuration:
+```yml
+ - plugin: https://ubiquibot-assistive-pricing.ubq.fi
+   type: github
+   with:
+     labels:
+       time:
+         - "Time: <1 Hour"
+         - "Time: <2 Hours"
+         - "Time: <4 Hours"
+         - "Time: <1 Day"
+         - "Time: <1 Week"
+       priority:
+         - "Priority: 1 (Normal)"
+         - "Priority: 2 (Medium)"
+         - "Priority: 3 (High)"
+         - "Priority: 4 (Urgent)"
+         - "Priority: 5 (Emergency)"
+     basePriceMultiplier: 1
+     publicAccessControl:
+       setLabel: true
+       fundExternalClosedIssue: false
+```
 
-### Cypress
-To test with Cypress Studio UI, run
+## Running locally
+### Supabase
+Supabase can be started through the CLI running
 ```shell
-yarn cy:open
+supabase start
 ```
 
-Otherwise to simply run the tests through the console, run
+### Worker
+Start the Worker by running
 ```shell
-yarn cy:run
+yarn worker
 ```
 
+### Make requests
+To trigger the worker, `POST` requests should be made to http://localhost:4000 with a `Content-Type: application/json` 
+header and a body 
+looking like
+```json
+{
+  "stateId": "",
+  "eventName": "",
+  "eventPayload": "",
+  "settings": "",
+  "ref": ""
+}
+```
+For convenience you can find an `.http` file with a valid request [here](/tests/http/request.http).
+
+## Testing
+
 ### Jest
 To start Jest tests, run
 ```shell