rename pausing -> shouldPause, lastCrawlPausing -> lastCrawlShouldPause, except actual derived 'pausing' state in frontend

ensure resources are available for paused state

Author: ikreymer

backend/btrixcloud/basecrawls.py

@@ -24,7 +24,7 @@
     User,
     StorageRef,
     RUNNING_AND_WAITING_STATES,
-    SUCCESSFUL_STATES,
+    SUCCESSFUL_AND_PAUSED_STATES,
     QARun,
     UpdatedResponse,
     DeletedResponseQuota,
@@ -448,7 +448,7 @@ async def _resolve_crawl_refs(
 
         if (
             files
-            and crawl.state in SUCCESSFUL_STATES
+            and crawl.state in SUCCESSFUL_AND_PAUSED_STATES
             and isinstance(crawl, CrawlOutWithResources)
         ):
             crawl.resources = await self._files_to_resources(files, org, crawl.id)

backend/btrixcloud/crawlconfigs.py

@@ -771,7 +771,7 @@ async def _add_running_curr_crawl_stats(self, crawlconfig: CrawlConfigOut):
         crawlconfig.lastCrawlState = crawl.state
         crawlconfig.lastCrawlSize = crawl.stats.size if crawl.stats else 0
         crawlconfig.lastCrawlStopping = crawl.stopping
-        crawlconfig.lastCrawlPausing = crawl.pausing
+        crawlconfig.lastCrawlShouldPause = crawl.shouldPause
         crawlconfig.lastCrawlPausedAt = crawl.pausedAt
         crawlconfig.lastCrawlPausedExpiry = None
         if crawl.pausedAt:

backend/btrixcloud/crawls.py

@@ -792,7 +792,7 @@ async def pause_crawl(
             if result.get("success"):
                 await self.crawls.find_one_and_update(
                     {"_id": crawl_id, "type": "crawl", "oid": org.id},
-                    {"$set": {"pausing": pause, "pausedAt": paused_at}},
+                    {"$set": {"shouldPause": pause, "pausedAt": paused_at}},
                 )
 
                 return {"success": True}

backend/btrixcloud/models.py

@@ -244,6 +244,7 @@ class UserOrgInfoOut(BaseModel):
     "stopped_org_readonly",
 ]
 SUCCESSFUL_STATES = get_args(TYPE_SUCCESSFUL_STATES)
+SUCCESSFUL_AND_PAUSED_STATES = ["paused", *SUCCESSFUL_STATES]
 
 TYPE_RUNNING_AND_WAITING_STATES = Literal[TYPE_WAITING_STATES, TYPE_RUNNING_STATES]
 RUNNING_AND_WAITING_STATES = [*WAITING_STATES, *RUNNING_STATES]
@@ -481,7 +482,7 @@ class CrawlConfigOut(CrawlConfigCore, CrawlConfigAdditional):
     id: UUID
 
     lastCrawlStopping: Optional[bool] = False
-    lastCrawlPausing: Optional[bool] = False
+    lastCrawlShouldPause: Optional[bool] = False
     lastCrawlPausedAt: Optional[datetime] = None
     lastCrawlPausedExpiry: Optional[datetime] = None
     profileName: Optional[str] = None
@@ -869,7 +870,7 @@ class CrawlOut(BaseMongoModel):
     seedCount: Optional[int] = None
     profileName: Optional[str] = None
     stopping: Optional[bool] = False
-    pausing: Optional[bool] = False
+    shouldPause: Optional[bool] = False
     pausedAt: Optional[datetime] = None
     manual: bool = False
     cid_rev: Optional[int] = None
@@ -1025,7 +1026,7 @@ class Crawl(BaseCrawl, CrawlConfigCore):
     manual: bool = False
 
     stopping: Optional[bool] = False
-    pausing: Optional[bool] = False
+    shouldPause: Optional[bool] = False
 
     qaCrawlExecSeconds: int = 0
 

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

@@ -26,7 +26,7 @@ export class CrawlStatus extends TailwindElement {
   stopping = false;
 
   @property({ type: Boolean })
-  pausing = false;
+  shouldPause = false;
 
   @property({ type: Boolean })
   hoist = false;
@@ -132,7 +132,7 @@ export class CrawlStatus extends TailwindElement {
         label = msg("Pausing");
         break;
 
-      case "unpausing":
+      case "resuming":
         icon = html`<sl-icon
           name="play-circle"
           class="animatePulse"
@@ -306,11 +306,11 @@ export class CrawlStatus extends TailwindElement {
     if (this.stopping && this.state === "running") {
       return "stopping";
     }
-    if (this.pausing && this.state === "running") {
+    if (this.shouldPause && this.state === "running") {
       return "pausing";
     }
-    if (!this.pausing && this.state === "paused") {
-      return "unpausing";
+    if (!this.shouldPause && this.state === "paused") {
+      return "resuming";
     }
     return this.state;
   }

frontend/src/features/crawl-workflows/live-workflow-status.ts

@@ -107,7 +107,7 @@ export class LiveWorkflowStatus extends BtrixElement {
           class="block"
           state=${lastCrawlState}
           ?stopping=${workflow.lastCrawlStopping}
-          ?pausing=${workflow.lastCrawlPausing}
+          ?shouldPause=${workflow.lastCrawlShouldPause}
         ></btrix-crawl-status>
       `;
     });

frontend/src/features/crawl-workflows/workflow-list.ts

@@ -250,7 +250,7 @@ export class WorkflowListItem extends BtrixElement {
               <btrix-crawl-status
                 state=${workflow.lastCrawlState || msg("No Crawls Yet")}
                 ?stopping=${workflow.lastCrawlStopping}
-                ?pausing=${workflow.lastCrawlPausing}
+                ?shouldPause=${workflow.lastCrawlShouldPause}
               ></btrix-crawl-status>
             `,
           )}

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

@@ -569,10 +569,10 @@ export class WorkflowDetail extends BtrixElement {
       this.isCancelingOrStoppingCrawl ||
       this.workflow.lastCrawlStopping;
     // disable pause/resume button if desired state is already in the process of being set.
-    // if crawl is running, and already pausing, don't allow clicking Pausing
-    // if crawl not running, and already unpausing (lastCrawlPausing is false), don't allow clicking Resume
+    // if crawl is running, and pause requested (shouldPause is true), don't allow clicking Pausing
+    // if crawl not running, and resume requested (shouldPause is false), don't allow clicking Resume
     const disablePauseResume =
-      this.workflow.lastCrawlPausing ===
+      this.workflow.lastCrawlShouldPause ===
       (this.workflow.lastCrawlState === "running");
 
     return html`
@@ -738,7 +738,7 @@ export class WorkflowDetail extends BtrixElement {
             <btrix-crawl-status
               state=${workflow.lastCrawlState || msg("No Crawls Yet")}
               ?stopping=${workflow.lastCrawlStopping}
-              ?pausing=${workflow.lastCrawlPausing}
+              ?shouldPause=${workflow.lastCrawlShouldPause}
             ></btrix-crawl-status>
           `,
         )}

frontend/src/types/crawler.ts

@@ -92,7 +92,7 @@ export type Workflow = CrawlConfig & {
   lastCrawlSize: number | null;
   lastStartedByName: string | null;
   lastCrawlStopping: boolean | null;
-  lastCrawlPausing: boolean | null;
+  lastCrawlShouldPause: boolean | null;
   lastRun: string;
   totalSize: string | null;
   inactive: boolean;