Add isPaused crawler util function for frontend

Author: tw4l

frontend/src/features/archived-items/crawl-status.ts

@@ -5,11 +5,8 @@ import startCase from "lodash/fp/startCase";
 
 import { TailwindElement } from "@/classes/TailwindElement";
 import { labelWithIcon } from "@/layouts/labelWithIcon";
-import {
-  PAUSED_STATES,
-  RUNNING_STATES,
-  type CrawlState,
-} from "@/types/crawlState";
+import { RUNNING_STATES, type CrawlState } from "@/types/crawlState";
+import { isPaused } from "@/utils/crawler";
 import { animatePulse } from "@/utils/css";
 
 type CrawlType = "crawl" | "qa";
@@ -377,10 +374,7 @@ export class CrawlStatus extends TailwindElement {
     ) {
       return "pausing";
     }
-    if (
-      !this.shouldPause &&
-      (PAUSED_STATES as readonly string[]).includes(this.state || "")
-    ) {
+    if (!this.shouldPause && isPaused(this.state || "")) {
       return "resuming";
     }
     return this.state;

frontend/src/features/crawl-workflows/workflow-action-menu/workflow-action-menu.ts

@@ -10,8 +10,7 @@ import { BtrixElement } from "@/classes/BtrixElement";
 import { ClipboardController } from "@/controllers/clipboard";
 import { WorkflowTab } from "@/routes";
 import type { Crawl, ListWorkflow, Workflow } from "@/types/crawler";
-import { PAUSED_STATES } from "@/types/crawlState";
-import { isNotFailed, isSuccessfullyFinished } from "@/utils/crawler";
+import { isNotFailed, isPaused, isSuccessfullyFinished } from "@/utils/crawler";
 import { isArchivingDisabled } from "@/utils/orgs";
 
 @customElement("btrix-workflow-action-menu")
@@ -42,9 +41,7 @@ export class WorkflowActionMenu extends BtrixElement {
 
     const canCrawl = this.appState.isCrawler;
     const archivingDisabled = isArchivingDisabled(this.org, true);
-    const paused = (PAUSED_STATES as readonly string[]).includes(
-      workflow.lastCrawlState || "",
-    );
+    const paused = isPaused(workflow.lastCrawlState || "");
     const crawling =
       workflow.isCrawlRunning &&
       !workflow.lastCrawlStopping &&

frontend/src/pages/org/workflow-detail.ts

@@ -32,13 +32,14 @@ import { pageNav, type Breadcrumb } from "@/layouts/pageHeader";
 import { WorkflowTab } from "@/routes";
 import { deleteConfirmation, noData, notApplicable } from "@/strings/ui";
 import type { APIPaginatedList, APIPaginationQuery } from "@/types/api";
-import { PAUSED_STATES, type CrawlState } from "@/types/crawlState";
+import { type CrawlState } from "@/types/crawlState";
 import { type StorageSeedFile } from "@/types/workflow";
 import { isApiError } from "@/utils/api";
 import { settingsForDuplicate } from "@/utils/crawl-workflows/settingsForDuplicate";
 import {
   DEFAULT_MAX_SCALE,
   isActive,
+  isPaused,
   isSkipped,
   isSuccessfullyFinished,
   renderName,
@@ -367,9 +368,7 @@ export class WorkflowDetail extends BtrixElement {
   }
 
   private get isPaused() {
-    return (PAUSED_STATES as readonly string[]).includes(
-      this.workflow?.lastCrawlState || "",
-    );
+    return isPaused(this.workflow?.lastCrawlState || "");
   }
 
   private get isResuming() {
@@ -920,9 +919,8 @@ export class WorkflowDetail extends BtrixElement {
 
     return (
       this.workflow.lastCrawlShouldPause ===
-        !(PAUSED_STATES as readonly string[]).includes(
-          this.workflow.lastCrawlState || "",
-        ) || isLoading(this.pauseResumeTask)
+        !isPaused(this.workflow.lastCrawlState || "") ||
+      isLoading(this.pauseResumeTask)
     );
   }
 

frontend/src/utils/crawler.ts

@@ -5,6 +5,7 @@ import { html, type TemplateResult } from "lit";
 import type { ArchivedItem, Crawl, Upload, Workflow } from "@/types/crawler";
 import {
   FAILED_STATES,
+  PAUSED_STATES,
   RUNNING_AND_WAITING_STATES,
   SUCCESSFUL_AND_FAILED_STATES,
   SUCCESSFUL_STATES,
@@ -51,6 +52,10 @@ export function isNotFailed({ state }: { state: string | null }) {
   );
 }
 
+export function isPaused(state: string | null) {
+  return state && (PAUSED_STATES as readonly string[]).includes(state);
+}
+
 export function isPageScopeType(
   scope?: (typeof WorkflowScopeType)[keyof typeof WorkflowScopeType],
 ) {