Merge pull request #15 from gentlementlegen/feat/configuration

feat: configuration is now fetched from Ubiquibot package

.github/workflows/compute.yml

@@ -28,9 +28,6 @@ jobs:
       SUPABASE_KEY: ${{ secrets.SUPABASE_KEY }}
       NFT_MINTER_PRIVATE_KEY: ${{ secrets.NFT_MINTER_PRIVATE_KEY }}
       NFT_CONTRACT_ADDRESS: ${{ secrets.NFT_CONTRACT_ADDRESS }}
-      EVM_PRIVATE_ENCRYPTED: ${{ secrets.EVM_PRIVATE_ENCRYPTED }}
-      APP_ID: ${{ secrets.APP_ID }}
-      UBIQUIBOT_APP_PRIVATE_KEY: ${{ secrets.UBIQUIBOT_APP_PRIVATE_KEY }}
 
     steps:
       - name: Checkout code
@@ -41,9 +38,8 @@ jobs:
         with:
           node-version: "20.10.0"
 
+      - run: ${{ toJSON(inputs) }}
+        shell: cat {0}
+
       - name: Generate Rewards
         uses: ./
-        with:
-          issueUrl: "${{ fromJSON(inputs.eventPayload).issue.html_url }}"
-          evmPrivateEncrypted: "${{ secrets.EVM_PRIVATE_ENCRYPTED }}"
-          evmNetworkId: "${{ fromJSON(inputs.settings).evmNetworkId }}"

.github/workflows/jest-testing.yml

@@ -3,6 +3,9 @@ name: Run Jest Tests
 on:
   workflow_dispatch:
   pull_request:
+  push:
+    branches:
+      - development
 
 jobs:
   test:

action.yml

@@ -1,15 +1,5 @@
 name: "Conversation Rewards"
 description: "Compute rewards for contributors' discussion on issues that are closed as complete."
-inputs:
-  issueUrl:
-    description: "The URL the the issue needing to be parsed"
-    required: true
-  evmNetworkId:
-    description: "The EVM network ID to use"
-    required: true
-  evmPrivateEncrypted:
-    description: "The encrypted EVM private key"
-    required: true
 outputs:
   result:
     description: "The result containing all the rewards of the users"
@@ -19,11 +9,8 @@ runs:
   steps:
     - run: |
         yarn --cwd ${{ github.action_path }} --production=true
-        yarn --cwd ${{ github.action_path }} start --issue "${{ inputs.issueUrl }}" --file "${{ github.action_path }}/results.json"
-        output=$(cat ${{ github.action_path }}/results.json | tr -s ' ' | tr -d '\n')
-        echo "Output of calculations:"
-        echo "$output"
-        echo "Pushing results to REWARDS output"
-        echo "REWARDS=$output" >> $GITHUB_OUTPUT
-      id: main
+      id: install
+      shell: bash
+    - run: yarn --cwd ${{ github.action_path }} start
       shell: bash
+      id: main

package.json

@@ -25,20 +25,22 @@
     "open-source"
   ],
   "dependencies": {
+    "@actions/core": "1.10.1",
     "@actions/github": "6.0.0",
-    "@commander-js/extra-typings": "12.0.1",
     "@octokit/rest": "20.1.0",
-    "@sinclair/typebox": "0.32.20",
+    "@octokit/webhooks": "13.2.7",
+    "@sinclair/typebox": "0.32.23",
     "@supabase/supabase-js": "2.42.0",
     "@ubiquibot/permit-generation": "1.2.2",
-    "commander": "12.0.0",
     "decimal.js": "10.4.3",
     "dotenv": "16.4.5",
     "js-tiktoken": "1.0.10",
     "jsdom": "24.0.0",
+    "lodash": "4.17.21",
     "markdown-it": "14.1.0",
     "openai": "4.29.1",
     "tsx": "4.7.1",
+    "typebox-validators": "0.3.5",
     "yaml": "2.4.1"
   },
   "devDependencies": {

src/configuration/comment-types.ts

@@ -0,0 +1,38 @@
+export enum CommentType {
+  /**
+   * Review related item
+   */
+  REVIEW = 0b1,
+  /**
+   * Issue related item
+   */
+  ISSUE = 0b10,
+  /**
+   * User assigned to the {@link CommentType.ISSUE} or {@link CommentType.REVIEW}
+   */
+  ASSIGNEE = 0b100,
+  /**
+   * The author of the {@link CommentType.ISSUE} or {@link CommentType.REVIEW}
+   */
+  ISSUER = 0b1000,
+  /**
+   * A user that is part of the organization or owner of the repo
+   */
+  COLLABORATOR = 0b10000,
+  /**
+   * A user that is NOT part of the organization nor owner of the repo
+   */
+  CONTRIBUTOR = 0b100000,
+  /**
+   * A user comment action on a {@link CommentType.ISSUE} or {@link CommentType.REVIEW}
+   */
+  COMMENTED = 0b1000000,
+  /**
+   * Pull request opening item
+   */
+  TASK = 0b10000000,
+  /**
+   * Issue opening item
+   */
+  SPECIFICATION = 0b100000000,
+}

src/configuration/config-reader.ts

@@ -1,8 +1,27 @@
-import * as fs from "fs";
-import YAML from "yaml";
 import program from "../parser/command-line";
+import { IncentivesConfiguration, incentivesConfigurationSchema, validateIncentivesConfiguration } from "./incentives";
+import { Value } from "@sinclair/typebox/value";
+import { merge } from "lodash";
 
-const file = fs.readFileSync(program.opts().config, "utf8");
-const configuration = YAML.parse(file);
+let configuration: IncentivesConfiguration | null = null;
 
-export default configuration;
+try {
+  const defaultConf = Value.Create(incentivesConfigurationSchema);
+  configuration = Value.Decode(incentivesConfigurationSchema, defaultConf);
+} catch (e) {
+  console.error(e);
+}
+
+if (program.settings) {
+  const settings = merge(configuration, JSON.parse(program.settings));
+  if (validateIncentivesConfiguration.test(settings)) {
+    configuration = settings;
+  } else {
+    console.warn("Invalid incentives configuration detected, will revert to defaults.");
+    for (const error of validateIncentivesConfiguration.errors(settings)) {
+      console.warn(error);
+    }
+  }
+}
+
+export default configuration as IncentivesConfiguration;

src/configuration/constants.ts

@@ -1,5 +1,4 @@
 import { config } from "dotenv";
 
 config();
-export const GITHUB_TOKEN = process.env.GITHUB_TOKEN;
 export const OPENAI_API_KEY = process.env.OPENAI_API_KEY;

src/configuration/content-evaluator-config.ts

@@ -1,9 +1,10 @@
 import { Static, Type } from "@sinclair/typebox";
 
-const contentEvaluatorConfigurationType = Type.Object({
-  enabled: Type.Boolean(),
+export const contentEvaluatorConfigurationType = Type.Object({
+  /**
+   * Enables or disables this module
+   */
+  enabled: Type.Boolean({ default: true }),
 });
 
 export type ContentEvaluatorConfiguration = Static<typeof contentEvaluatorConfigurationType>;
-
-export default contentEvaluatorConfigurationType;

src/configuration/data-purge-config.ts

@@ -0,0 +1,10 @@
+import { Type, Static } from "@sinclair/typebox";
+
+export const dataPurgeConfigurationType = Type.Object({
+  /**
+   * Enables or disables this module
+   */
+  enabled: Type.Boolean({ default: true }),
+});
+
+export type DataPurgeConfiguration = Static<typeof dataPurgeConfigurationType>;