Refactor unfurling related types (#6730)

* wip

* fix: refactor unfurl types

plugins/github/server/github.ts

@@ -6,45 +6,17 @@ import {
 } from "@octokit/auth-app";
 import { Octokit } from "octokit";
 import pluralize from "pluralize";
-import { IntegrationService, IntegrationType, Unfurl } from "@shared/types";
+import {
+  IntegrationService,
+  IntegrationType,
+  JSONObject,
+  UnfurlResourceType,
+} from "@shared/types";
 import Logger from "@server/logging/Logger";
 import { Integration, User } from "@server/models";
-import { GitHubUtils } from "../shared/GitHubUtils";
+import { UnfurlSignature } from "@server/types";
 import env from "./env";
 
-enum Resource {
-  PR = "pull",
-  Issue = "issue",
-}
-
-type PreviewData = {
-  [Resource.PR]: {
-    url: string;
-    type: Resource.PR;
-    title: string;
-    description: string;
-    author: { name: string; avatarUrl: string };
-    createdAt: string;
-    meta: {
-      identifier: string;
-      status: { name: string; color: string };
-    };
-  };
-  [Resource.Issue]: {
-    url: string;
-    type: Resource.Issue;
-    title: string;
-    description: string;
-    author: { name: string; avatarUrl: string };
-    createdAt: string;
-    meta: {
-      identifier: string;
-      labels: Array<{ name: string; color: string }>;
-      status: { name: string; color: string };
-    };
-  };
-};
-
 const requestPlugin = (octokit: Octokit) => ({
   requestPR: async (params: ReturnType<typeof GitHub.parseUrl>) =>
     octokit.request(`GET /repos/{owner}/{repo}/pulls/{id}`, {
@@ -84,11 +56,11 @@ const requestPlugin = (octokit: Octokit) => ({
    */
   requestResource: async function requestResource(
     resource: ReturnType<typeof GitHub.parseUrl>
-  ) {
+  ): Promise<{ data?: JSONObject }> {
     switch (resource?.type) {
-      case Resource.PR:
+      case UnfurlResourceType.PR:
         return this.requestPR(resource);
-      case Resource.Issue:
+      case UnfurlResourceType.Issue:
         return this.requestIssue(resource);
       default:
         return { data: undefined };
@@ -119,57 +91,7 @@ export class GitHub {
 
   private static appOctokit: Octokit;
 
-  private static supportedResources = Object.values(Resource);
-
-  private static transformPRData = (
-    resource: ReturnType<typeof GitHub.parseUrl>,
-    data: Record<string, any>
-  ): PreviewData[Resource.PR] => ({
-    url: resource!.url,
-    type: Resource.PR,
-    title: data.title,
-    description: data.body,
-    author: {
-      name: data.user.login,
-      avatarUrl: data.user.avatar_url,
-    },
-    createdAt: data.created_at,
-    meta: {
-      identifier: `#${data.number}`,
-      status: {
-        name: data.merged ? "merged" : data.state,
-        color: GitHubUtils.getColorForStatus(
-          data.merged ? "merged" : data.state
-        ),
-      },
-    },
-  });
-
-  private static transformIssueData = (
-    resource: ReturnType<typeof GitHub.parseUrl>,
-    data: Record<string, any>
-  ): PreviewData[Resource.Issue] => ({
-    url: resource!.url,
-    type: Resource.Issue,
-    title: data.title,
-    description: data.body_text,
-    author: {
-      name: data.user.login,
-      avatarUrl: data.user.avatar_url,
-    },
-    createdAt: data.created_at,
-    meta: {
-      identifier: `#${data.number}`,
-      labels: data.labels.map((label: { name: string; color: string }) => ({
-        name: label.name,
-        color: `#${label.color}`,
-      })),
-      status: {
-        name: data.state,
-        color: GitHubUtils.getColorForStatus(data.state),
-      },
-    },
-  });
+  private static supportedResources = Object.values(UnfurlResourceType);
 
   /**
    * Parses a given URL and returns resource identifiers for GitHub specific URLs
@@ -187,7 +109,7 @@ export class GitHub {
     const owner = parts[1];
     const repo = parts[2];
     const type = parts[3]
-      ? (pluralize.singular(parts[3]) as Resource)
+      ? (pluralize.singular(parts[3]) as UnfurlResourceType)
       : undefined;
     const id = parts[4];
 
@@ -253,38 +175,13 @@ export class GitHub {
         }),
     }) as Promise<InstanceType<typeof CustomOctokit>>;
 
-  /**
-   * Transforms resource data obtained from GitHub to our own pre-defined preview data
-   * which will be consumed by our API clients
-   *
-   * @param resourceType Resource type for which to transform the data, e.g, an issue
-   * @param data Resource data obtained from GitHub via REST calls
-   * @returns {PreviewData} Transformed data suitable for our API clients
-   */
-  public static transformResourceData = (
-    resource: ReturnType<typeof GitHub.parseUrl>,
-    data: Record<string, any>
-  ) => {
-    switch (resource?.type) {
-      case Resource.PR:
-        return GitHub.transformPRData(resource, data);
-      case Resource.Issue:
-        return GitHub.transformIssueData(resource, data);
-      default:
-        return;
-    }
-  };
-
   /**
    *
    * @param url GitHub resource url
    * @param actor User attempting to unfurl resource url
-   * @returns {object} An object containing resource details e.g, a GitHub Pull Request details
+   * @returns An object containing resource details e.g, a GitHub Pull Request details
    */
-  public static unfurl = async (
-    url: string,
-    actor: User
-  ): Promise<Unfurl | undefined> => {
+  public static unfurl: UnfurlSignature = async (url: string, actor: User) => {
     const resource = GitHub.parseUrl(url);
 
     if (!resource) {
@@ -311,7 +208,7 @@ export class GitHub {
       if (!data) {
         return;
       }
-      return GitHub.transformResourceData(resource, data);
+      return { ...data, type: resource.type };
     } catch (err) {
       Logger.warn("Failed to fetch resource from GitHub", err);
       return;

plugins/iframely/server/iframely.ts

@@ -1,15 +1,16 @@
-import type { Unfurl } from "@shared/types";
-import { InternalError } from "@server/errors";
+import { JSONObject, UnfurlResourceType } from "@shared/types";
+import Logger from "@server/logging/Logger";
+import { UnfurlSignature } from "@server/types";
 import fetch from "@server/utils/fetch";
 import env from "./env";
 
 class Iframely {
   public static defaultUrl = "https://iframe.ly";
 
-  public static async fetch(
+  public static async requestResource(
     url: string,
     type = "oembed"
-  ): Promise<Unfurl | void> {
+  ): Promise<JSONObject | undefined> {
     const isDefaultHost = env.IFRAMELY_URL === this.defaultUrl;
 
     // Cloud Iframely requires /api path, while self-hosted does not.
@@ -23,19 +24,20 @@ class Iframely {
       );
       return res.json();
     } catch (err) {
-      throw InternalError(err);
+      Logger.error(`Error fetching data from Iframely for url: ${url}`, err);
+      return;
     }
   }
 
   /**
-   * Fetches the preview data for the given url using Iframely oEmbed API
    *
-   * @param url
-   * @returns Preview data for the url
+   * @param url Resource url
+   * @returns An object containing resource details e.g, resource title, description etc.
    */
-  public static async unfurl(url: string): Promise<Unfurl | void> {
-    return Iframely.fetch(url);
-  }
+  public static unfurl: UnfurlSignature = async (url: string) => {
+    const data = await Iframely.requestResource(url);
+    return { ...data, type: UnfurlResourceType.OEmbed };
+  };
 }
 
 export default Iframely;