Merge pull request #29 from ubiquity-whilefoo/custom-context

feat: custom context

src/adapters/index.ts

@@ -1,5 +1,5 @@
 import { createClient } from "@supabase/supabase-js";
-import { BotConfig } from "../types";
+import { Context } from "../types";
 import { Access } from "./supabase/helpers/tables/access";
 import { Label } from "./supabase/helpers/tables/label";
 import { Locations } from "./supabase/helpers/tables/locations";
@@ -10,19 +10,19 @@ import { User } from "./supabase/helpers/tables/user";
 import { Wallet } from "./supabase/helpers/tables/wallet";
 import { Database } from "./supabase/types";
 
-export function createAdapters(config: BotConfig) {
-  const client = generateSupabase(config.supabase.url, config.supabase.key);
+export function createAdapters(context: Context) {
+  const client = generateSupabase(context.config.supabase.url, context.config.supabase.key);
   return {
     supabase: {
-      access: new Access(client),
-      wallet: new Wallet(client),
-      user: new User(client),
-      debit: new Settlement(client),
-      settlement: new Settlement(client),
-      label: new Label(client),
-      logs: new Logs(client),
-      locations: new Locations(client),
-      super: new Super(client),
+      access: new Access(client, context),
+      wallet: new Wallet(client, context),
+      user: new User(client, context),
+      debit: new Settlement(client, context),
+      settlement: new Settlement(client, context),
+      label: new Label(client, context),
+      logs: new Logs(client, context),
+      locations: new Locations(client, context),
+      super: new Super(client, context),
     },
   };
 }

src/adapters/supabase/helpers/tables/access.ts

@@ -4,6 +4,7 @@ import { Database } from "../../types/database";
 import { GitHubNode } from "../client";
 import { Super } from "./super";
 import { UserRow } from "./user";
+import { Context } from "../../../../types";
 type AccessRow = Database["public"]["Tables"]["access"]["Row"];
 type AccessInsert = Database["public"]["Tables"]["access"]["Insert"];
 type UserWithAccess = (UserRow & { access: AccessRow | null })[];
@@ -18,8 +19,8 @@ type _Access = {
 };
 
 export class Access extends Super {
-  constructor(supabase: SupabaseClient) {
-    super(supabase);
+  constructor(supabase: SupabaseClient, context: Context) {
+    super(supabase, context);
   }
 
   private async _getUserWithAccess(id: number): Promise<UserWithAccess> {

src/adapters/supabase/helpers/tables/label.ts

@@ -2,11 +2,14 @@ import { SupabaseClient } from "@supabase/supabase-js";
 import { Repository } from "../../../../types/payload";
 import { Database } from "../../types";
 import { Super } from "./super";
+import { Context } from "../../../../types";
 import Runtime from "../../../../bindings/bot-runtime";
+
 type LabelRow = Database["public"]["Tables"]["labels"]["Row"];
+
 export class Label extends Super {
-  constructor(supabase: SupabaseClient) {
-    super(supabase);
+  constructor(supabase: SupabaseClient, context: Context) {
+    super(supabase, context);
   }
 
   async saveLabelChange({

src/adapters/supabase/helpers/tables/locations.ts

@@ -1,6 +1,7 @@
 import { SupabaseClient } from "@supabase/supabase-js";
 import { Super } from "./super";
 import { Database } from "../../types/database";
+import { Context } from "../../../../types";
 
 // currently trying to save all of the location metadata of the event.
 // seems that focusing on the IssueComments will provide the most value
@@ -16,8 +17,8 @@ export class Locations extends Super {
   node_id: string | undefined;
   node_type: string | undefined;
 
-  constructor(supabase: SupabaseClient) {
-    super(supabase);
+  constructor(supabase: SupabaseClient, context: Context) {
+    super(supabase, context);
   }
 
   public async getLocationsFromRepo(repositoryId: number) {
@@ -61,7 +62,7 @@ export class Locations extends Super {
       }
     `;
 
-    this.locationResponse = (await this.runtime.latestEventContext.octokit.graphql(graphQlQuery)) as LocationResponse;
+    this.locationResponse = (await this.context.event.octokit.graphql(graphQlQuery)) as LocationResponse;
     console.trace(this.locationResponse);
 
     this.user_id = this.locationResponse.data.node.author.id;

src/adapters/supabase/helpers/tables/logs.ts

@@ -4,11 +4,12 @@
 // TODO: break this apart into smaller files.
 
 import { SupabaseClient } from "@supabase/supabase-js";
-import Runtime from "../../../../bindings/bot-runtime";
 import { Database } from "../../types";
 import { prettyLogs } from "../pretty-logs";
 import { Super } from "./super";
 import { execSync } from "child_process";
+import { Context } from "../../../../types";
+import Runtime from "../../../../bindings/bot-runtime";
 
 type LogFunction = (message: string, metadata?: any) => void;
 type LogInsert = Database["public"]["Tables"]["logs"]["Insert"];
@@ -221,10 +222,9 @@ export class Logs extends Super {
     });
   }
 
-  constructor(supabase: SupabaseClient) {
-    super(supabase);
-    const runtime = Runtime.getState();
-    const logConfig = runtime.botConfig.log;
+  constructor(supabase: SupabaseClient, context: Context) {
+    super(supabase, context);
+    const logConfig = this.context.config.log;
 
     this.environment = logConfig.logEnvironment;
     this.retryLimit = logConfig.retryLimit;
@@ -363,11 +363,11 @@ export class Logs extends Super {
   }
 
   private _postComment(message: string) {
-    this.runtime.latestEventContext.octokit.issues
+    this.context.event.octokit.issues
       .createComment({
-        owner: this.runtime.latestEventContext.issue().owner,
-        repo: this.runtime.latestEventContext.issue().repo,
-        issue_number: this.runtime.latestEventContext.issue().issue_number,
+        owner: this.context.event.issue().owner,
+        repo: this.context.event.issue().repo,
+        issue_number: this.context.event.issue().issue_number,
         body: message,
       })
       // .then((x) => console.trace(x))

src/adapters/supabase/helpers/tables/settlement.ts

@@ -3,6 +3,7 @@ import Decimal from "decimal.js";
 import { Comment, Payload } from "../../../../types/payload";
 import { Database } from "../../types/database";
 import { Super } from "./super";
+import { Context } from "../../../../types";
 
 type DebitInsert = Database["public"]["Tables"]["debits"]["Insert"];
 type CreditInsert = Database["public"]["Tables"]["credits"]["Insert"];
@@ -25,8 +26,8 @@ type AddCreditWithPermit = {
 };
 
 export class Settlement extends Super {
-  constructor(supabase: SupabaseClient) {
-    super(supabase);
+  constructor(supabase: SupabaseClient, context: Context) {
+    super(supabase, context);
   }
 
   private async _lookupTokenId(networkId: number, address: string): Promise<number> {

src/adapters/supabase/helpers/tables/super.ts

@@ -1,12 +1,15 @@
 import { SupabaseClient } from "@supabase/supabase-js";
 import Runtime from "../../../../bindings/bot-runtime";
+import { Context } from "../../../../types";
 
 export class Super {
-  public supabase: SupabaseClient;
-  public runtime: Runtime; // convenience accessor
+  protected supabase: SupabaseClient;
+  protected runtime: Runtime; // convenience accessor
+  protected context: Context;
 
-  constructor(supabase: SupabaseClient) {
+  constructor(supabase: SupabaseClient, context: Context) {
     this.supabase = supabase;
     this.runtime = Runtime.getState();
+    this.context = context;
   }
 }

src/adapters/supabase/helpers/tables/user.ts

@@ -1,15 +1,16 @@
 import { SupabaseClient } from "@supabase/supabase-js";
 import { Database } from "../../types/database";
 import { Super } from "./super";
+import { Context } from "../../../../types";
 
 export type UserRow = Database["public"]["Tables"]["users"]["Row"];
 export class User extends Super {
-  constructor(supabase: SupabaseClient) {
-    super(supabase);
+  constructor(supabase: SupabaseClient, context: Context) {
+    super(supabase, context);
   }
 
   public async getUserId(username: string): Promise<number> {
-    const octokit = this.runtime.latestEventContext.octokit;
+    const octokit = this.context.event.octokit;
     const { data } = await octokit.rest.users.getByUsername({ username });
     return data.id;
   }

src/adapters/supabase/helpers/tables/wallet.test.ts

@@ -1,20 +1,21 @@
 import dotenv from "dotenv";
 dotenv.config();
 
-import { Context } from "probot";
+import { Context as ProbotContext } from "probot";
 import { createAdapters } from "../../..";
 import { loadConfig } from "../../../../bindings/config";
-import { User } from "../../../../types";
+import { Context, User } from "../../../../types";
 const SUPABASE_URL = process.env.SUPABASE_URL;
 if (!SUPABASE_URL) throw new Error("SUPABASE_URL is not defined");
 const SUPABASE_KEY = process.env.SUPABASE_KEY;
 if (!SUPABASE_KEY) throw new Error("SUPABASE_KEY is not defined");
 
-const mockContext = { supabase: { url: SUPABASE_URL, key: SUPABASE_KEY } } as unknown as Context;
+const mockContext = { supabase: { url: SUPABASE_URL, key: SUPABASE_KEY } } as unknown as ProbotContext;
 
-async function getWalletAddressAndUrlTest(context: Context) {
-  const botConfig = await loadConfig(context);
-  const { wallet } = createAdapters(botConfig).supabase;
+async function getWalletAddressAndUrlTest(eventContext: ProbotContext) {
+  const botConfig = await loadConfig(eventContext);
+  const context: Context = { event: eventContext, config: botConfig };
+  const { wallet } = createAdapters(context).supabase;
   const userId = 4975670 as User["id"];
   const results = [] as unknown[];
   try {

src/adapters/supabase/helpers/tables/wallet.ts

@@ -1,7 +1,7 @@
 import { PostgrestError, SupabaseClient } from "@supabase/supabase-js";
-import { Context } from "probot/lib/context";
+import { Context as ProbotContext } from "probot/lib/context";
 import Runtime from "../../../../bindings/bot-runtime";
-import { User } from "../../../../types";
+import { Context, User } from "../../../../types";
 import { Database } from "../../types/database";
 import { Super } from "./super";
 import { UserRow } from "./user";
@@ -11,23 +11,24 @@ type WalletRow = Database["public"]["Tables"]["wallets"]["Row"];
 type WalletInsert = Database["public"]["Tables"]["wallets"]["Insert"];
 type UserWithWallet = (UserRow & { wallets: WalletRow | null })[];
 
-type IssueCommentPayload = Context<"issue_comment.created">["payload"] | Context<"issue_comment.edited">["payload"];
+type IssueCommentPayload =
+  | ProbotContext<"issue_comment.created">["payload"]
+  | ProbotContext<"issue_comment.edited">["payload"];
 
 export class Wallet extends Super {
-  constructor(supabase: SupabaseClient) {
-    super(supabase);
+  constructor(supabase: SupabaseClient, context: Context) {
+    super(supabase, context);
   }
+
   public async getAddress(id: number): Promise<string> {
     const userWithWallet = await this._getUserWithWallet(id);
     return this._validateAndGetWalletAddress(userWithWallet);
   }
 
   public async upsertWalletAddress(address: string) {
-    const runtime = Runtime.getState();
-    const eventContext = runtime.latestEventContext;
-    const payload = eventContext.payload as
-      | Context<"issue_comment.created">["payload"]
-      | Context<"issue_comment.edited">["payload"];
+    const payload = this.context.event.payload as
+      | ProbotContext<"issue_comment.created">["payload"]
+      | ProbotContext<"issue_comment.edited">["payload"];
 
     const userData = await this._getUserData(payload);
     const registeredWalletData = await this._getRegisteredWalletData(userData);
@@ -69,6 +70,7 @@ export class Wallet extends Super {
     if (error) throw error;
     return data as UserRow;
   }
+
   private async _getUserData(payload: IssueCommentPayload): Promise<UserRow> {
     const user = await this._checkIfUserExists(payload.sender.id);
     let userData = user;
@@ -78,6 +80,7 @@ export class Wallet extends Super {
     }
     return userData;
   }
+
   private async _registerNewUser(user: User, locationMetaData: LocationMetaData): Promise<UserRow> {
     // Insert the location metadata into the locations table
     const { data: locationData, error: locationError } = (await this.supabase
@@ -104,20 +107,23 @@ export class Wallet extends Super {
 
     return userData as UserRow;
   }
+
   private async _checkIfWalletExists(
     userData: UserRow
   ): Promise<{ data: WalletRow | null; error: PostgrestError | null }> {
     const { data, error } = await this.supabase.from("wallets").select("*").eq("id", userData.wallet_id).maybeSingle();
 
     return { data: data as WalletRow, error };
   }
+
   private async _updateWalletId(walletId: number, userId: number) {
     const { error } = await this.supabase.from("users").update({ wallet_id: walletId }).eq("id", userId);
 
     if (error) {
       throw error;
     }
   }
+
   private async _getRegisteredWalletData(userData: UserRow): Promise<WalletRow> {
     const walletResponse = await this._checkIfWalletExists(userData);
     const walletData = walletResponse.data as WalletRow;

src/bindings/bot-runtime.ts

@@ -1,19 +1,12 @@
-import { Context } from "probot";
-import { BotConfig } from "../types";
 import { createAdapters } from "../adapters";
 import { Logs } from "../adapters/supabase";
-import { GitHubEvent } from "../types/payload";
 
 class Runtime {
   private static instance: Runtime;
-  private _eventContext: Context[];
-  private _botConfig: BotConfig;
   private _adapters: ReturnType<typeof createAdapters>;
   private _logger: Logs;
 
   private constructor() {
-    this._eventContext = [] as Context[];
-    this._botConfig = {} as BotConfig;
     this._adapters = {} as ReturnType<typeof createAdapters>;
     this._logger = {} as Logs;
   }
@@ -25,34 +18,6 @@ class Runtime {
     return Runtime.instance;
   }
 
-  // public eventContextByKeyPair(keyPair: { [key: string]: string }) {
-  //   const [key, value] = Object.entries(keyPair)[0];
-  //   return this._eventContext.find((context) => context[key] === value);
-  // }
-  public eventContextByType(name: GitHubEvent) {
-    return this._eventContext.find((context) => context.name === name);
-  }
-  // public eventContextById(id: string) {
-  //   return this._eventContext.find((context) => context.id === id);
-  // }
-
-  public get latestEventContext() {
-    const latestContext = this._eventContext[this._eventContext.length - 1];
-    return latestContext;
-  }
-
-  public set latestEventContext(context: Context) {
-    this._eventContext.push(context);
-  }
-
-  public get botConfig(): BotConfig {
-    return this._botConfig;
-  }
-
-  public set botConfig(config: BotConfig) {
-    this._botConfig = config;
-  }
-
   public get adapters(): ReturnType<typeof createAdapters> {
     return this._adapters;
   }