refactor: prepare getWorkflowLandingUrl for alternative genome keys (#137)

Author: hunterckx

app/apis/catalog/brc-analytics-catalog/common/constants.ts

@@ -1,8 +1,7 @@
-import { ANALYSIS_METHOD } from "./entities";
+import { ANALYSIS_METHOD, WORKFLOW_ID } from "./entities";
 
 export const WORKFLOW_IDS_BY_ANALYSIS_METHOD: Partial<
-  Record<ANALYSIS_METHOD, string>
+  Record<ANALYSIS_METHOD, WORKFLOW_ID>
 > = {
-  [ANALYSIS_METHOD.REGULATION]:
-    "https://dockstore.org/api/ga4gh/trs/v2/tools/#workflow/github.com/iwc-workflows/chipseq-pe/main/versions/v0.12",
+  [ANALYSIS_METHOD.REGULATION]: WORKFLOW_ID.REGULATION,
 };

app/apis/catalog/brc-analytics-catalog/common/entities.ts

@@ -34,3 +34,7 @@ export interface EntitiesResponsePagination {
   size: number;
   total: number;
 }
+
+export enum WORKFLOW_ID {
+  REGULATION = "https://dockstore.org/api/ga4gh/trs/v2/tools/#workflow/github.com/iwc-workflows/chipseq-pe/main/versions/v0.12",
+}

app/utils/galaxy-api.ts

@@ -1,11 +1,14 @@
 import ky from "ky";
+import { WORKFLOW_ID } from "../apis/catalog/brc-analytics-catalog/common/entities";
 
 interface WorkflowLandingsBody {
-  request_state: { reference_genome: string };
+  request_state: WorkflowLandingsBodyRequestState;
   workflow_id: string;
   workflow_target_type: "trs_url";
 }
 
+type WorkflowLandingsBodyRequestState = { reference_genome: string };
+
 interface WorkflowLanding {
   uuid: string;
 }
@@ -23,13 +26,11 @@ const WORKFLOW_LANDING_URL_PREFIX =
  * @returns workflow landing URL.
  */
 export async function getWorkflowLandingUrl(
-  workflowId: string,
+  workflowId: WORKFLOW_ID,
   referenceGenome: string
 ): Promise<string> {
   const body: WorkflowLandingsBody = {
-    request_state: {
-      reference_genome: referenceGenome,
-    },
+    request_state: getWorkflowLandingsRequestState(workflowId, referenceGenome),
     workflow_id: workflowId,
     workflow_target_type: "trs_url",
   };
@@ -42,3 +43,16 @@ export async function getWorkflowLandingUrl(
   const id = (await res.json()).uuid;
   return WORKFLOW_LANDING_URL_PREFIX + encodeURIComponent(id);
 }
+
+/**
+ * Get the appropriate `request_state` object for the given workflow ID and reference genome.
+ * @param workflowId - Workflow ID.
+ * @param referenceGenome - Reference genome.
+ * @returns `request_state` value for the workflow landings request body.
+ */
+function getWorkflowLandingsRequestState(
+  workflowId: WORKFLOW_ID,
+  referenceGenome: string
+): WorkflowLandingsBodyRequestState {
+  return { reference_genome: referenceGenome };
+}