Merge pull request #234 from ubiquity-os-marketplace/development

Merge development into main

package.json

@@ -34,7 +34,7 @@
     "@supabase/supabase-js": "2.42.0",
     "@ubiquity-dao/rpc-handler": "1.3.0",
     "@ubiquity-os/permit-generation": "^2.0.6",
-    "@ubiquity-os/plugin-sdk": "^1.1.1",
+    "@ubiquity-os/plugin-sdk": "^2.0.0",
     "@ubiquity-os/ubiquity-os-logger": "^1.3.2",
     "decimal.js": "10.4.3",
     "ethers": "^5.7.2",

src/parser/github-comment-module.ts

@@ -28,11 +28,6 @@ interface SortedTasks {
 export class GithubCommentModule extends BaseModule {
   private readonly _configuration: GithubCommentConfiguration | null = this.context.config.incentives.githubComment;
   private readonly _debugFilePath = "./output.html";
-  /**
-   * COMMENT_ID can be set in the environment to reference the id of the last comment created during this workflow.
-   * See also compute.yml to understand how it is set.
-   */
-  private _lastCommentId: number | null = process.env.COMMENT_ID ? Number(process.env.COMMENT_ID) : null;
 
   /**
    * Ensures that a string containing special characters get HTML encoded.
@@ -117,7 +112,7 @@ export class GithubCommentModule extends BaseModule {
     if (this._configuration?.post) {
       try {
         if (Object.values(result).some((v) => v.permitUrl) || isIssueCollaborative || isUserAdmin) {
-          await this.postComment(body);
+          await postComment(this.context, this.context.logger.info(body), { raw: true, updateComment: true });
         } else {
           const errorLog = this.context.logger.error("Issue is non-collaborative. Skipping permit generation.");
           await postComment(this.context, errorLog);
@@ -137,31 +132,6 @@ export class GithubCommentModule extends BaseModule {
     return true;
   }
 
-  async postComment(body: string, updateLastComment = true) {
-    const { payload, logger } = this.context;
-    if (!this._configuration?.post) {
-      logger.debug("Won't post a comment since posting is disabled.", { body });
-      return;
-    }
-    if (updateLastComment && this._lastCommentId !== null) {
-      await this.context.octokit.rest.issues.updateComment({
-        body,
-        repo: payload.repository.name,
-        owner: payload.repository.owner.login,
-        issue_number: payload.issue.number,
-        comment_id: this._lastCommentId,
-      });
-    } else {
-      const comment = await this.context.octokit.rest.issues.createComment({
-        body,
-        repo: payload.repository.name,
-        owner: payload.repository.owner.login,
-        issue_number: payload.issue.number,
-      });
-      this._lastCommentId = comment.data.id;
-    }
-  }
-
   _createContributionRows(result: Result[0], sortedTasks: SortedTasks | undefined) {
     const content: string[] = [];
 

src/types/env.d.ts

@@ -11,7 +11,6 @@ declare global {
       PERMIT_FEE_RATE: string;
       PERMIT_TREASURY_GITHUB_USERNAME: string;
       PERMIT_ERC20_TOKENS_NO_FEE_WHITELIST: string;
-      COMMENT_ID: string | undefined;
     }
   }
 }

src/web/api/index.ts

@@ -27,7 +27,7 @@ const baseApp = createPlugin<PluginSettings, EnvConfig, null, SupportedEvents>(
     logLevel: (process.env.LOG_LEVEL as LogLevel) ?? "info",
     settingsSchema: pluginSettingsSchema,
     envSchema: envConfigSchema,
-    postCommentOnError: false,
+    postCommentOnError: true,
     bypassSignatureVerification: true,
   }
 );
@@ -37,7 +37,7 @@ const app = {
     if (
       request.method === "POST" &&
       new URL(request.url).pathname === "/" &&
-      request.headers.get("origin") === "http://localhost:4000"
+      request.headers.get("referer")?.includes("http://localhost:4000")
     ) {
       try {
         const originalBody = await request.json();

tests/action.test.ts

@@ -9,6 +9,7 @@ import { customOctokit as Octokit } from "@ubiquity-os/plugin-sdk/octokit";
 beforeAll(() => server.listen());
 beforeEach(() => {
   jest.unstable_mockModule("@actions/github", () => ({
+    default: {},
     context: {
       runId: "1",
       payload: {

tests/fees.test.ts

@@ -13,6 +13,7 @@ jest.unstable_mockModule("../src/helpers/web3", () => ({
 }));
 
 jest.unstable_mockModule("@actions/github", () => ({
+  default: {},
   context: {
     runId: "1",
     payload: {

tests/permit-generatable.test.ts

@@ -22,6 +22,7 @@ jest.unstable_mockModule("../src/helpers/web3", () => ({
 }));
 
 jest.unstable_mockModule("@actions/github", () => ({
+  default: {},
   context: {
     runId: "1",
     payload: {

tests/pre-check.test.ts

@@ -11,16 +11,22 @@ import { customOctokit as Octokit } from "@ubiquity-os/plugin-sdk/octokit";
 
 const issueUrl = "https://github.com/ubiquity/work.ubq.fi/issues/69";
 
-jest.unstable_mockModule("@actions/github", () => ({
-  context: {
+jest.unstable_mockModule("@actions/github", () => {
+  const context = {
     runId: "1",
     payload: {
       repository: {
         html_url: "https://github.com/ubiquity-os/conversation-rewards",
       },
     },
-  },
-}));
+  };
+  return {
+    default: {
+      context,
+    },
+    context,
+  };
+});
 
 beforeAll(() => server.listen());
 afterEach(() => server.resetHandlers());

tests/process.issue.test.ts

@@ -31,6 +31,7 @@ jest.unstable_mockModule("../src/helpers/web3", () => ({
 }));
 
 jest.unstable_mockModule("@actions/github", () => ({
+  default: {},
   context: {
     runId: "1",
     payload: {

tests/rewards.test.ts

@@ -17,6 +17,7 @@ import cfg from "./__mocks__/results/valid-configuration.json";
 const issueUrl = "https://github.com/ubiquity/work.ubq.fi/issues/69";
 
 jest.unstable_mockModule("@actions/github", () => ({
+  default: {},
   context: {
     runId: "1",
     payload: {