Skip to content

devex: Refactor workflow action menus into component #2776

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 6 commits into from
Aug 12, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
77 changes: 77 additions & 0 deletions frontend/src/__mocks__/api/orgs/[id]/crawlconfigs/[id].js
Original file line number Diff line number Diff line change
@@ -0,0 +1,77 @@
import user from "@/__mocks__/api/users/me";

// API v1.18.0
export default {
name: "",
description: null,
created: "2025-01-23T06:23:32Z",
createdBy: user.id,
modified: "2025-01-28T19:53:15Z",
modifiedBy: user.id,
autoAddCollections: [],
inactive: false,
rev: 2,
crawlAttemptCount: 3,
crawlCount: 3,
crawlSuccessfulCount: 3,
totalSize: 61275,
lastCrawlId: "manual-20250205210838-a5e3cf23-f3c",
lastCrawlStartTime: "2025-02-05T21:08:38Z",
lastStartedBy: user.id,
lastCrawlTime: "2025-02-05T21:09:20Z",
lastCrawlState: "complete",
lastCrawlSize: 61275,
lastRun: "2025-02-05T21:09:20Z",
isCrawlRunning: false,
crawlFilenameTemplate: null,
id: "a5f3cf23-f3ce-4ceb-a232-f2946185370f",
schedule: "",
jobType: "custom",
config: {
seeds: null,
seedFileId: null,
scopeType: "page",
include: null,
exclude: [],
depth: -1,
limit: null,
extraHops: 0,
lang: "en",
blockAds: false,
behaviorTimeout: null,
pageLoadTimeout: null,
pageExtraDelay: null,
postLoadDelay: null,
workers: null,
headless: null,
generateWACZ: null,
combineWARC: null,
useSitemap: false,
failOnFailedSeed: false,
logging: null,
behaviors: "autoscroll,autoplay,autofetch,siteSpecific",
customBehaviors: [],
userAgent: "",
selectLinks: ["a[href]->href"],
clickSelector: "a",
},
tags: [],
crawlTimeout: 0,
maxCrawlSize: 0,
scale: 1,
browserWindows: 4,
oid: "x_example_org_id_x",
profileid: null,
crawlerChannel: "beta",
proxyId: null,
firstSeed: "https://example.com/",
seedCount: 1,
lastCrawlStopping: false,
lastCrawlShouldPause: false,
lastCrawlPausedAt: null,
lastCrawlPausedExpiry: null,
profileName: null,
createdByName: user.name,
modifiedByName: user.name,
lastStartedByName: user.name,
};
12 changes: 10 additions & 2 deletions frontend/src/components/ui/overflow-dropdown.ts
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ import {
import { ifDefined } from "lit/directives/if-defined.js";

import { TailwindElement } from "@/classes/TailwindElement";
import type { WorkflowActionMenu } from "@/features/crawl-workflows/workflow-action-menu/workflow-action-menu";

/**
* Dropdown for additional actions.
Expand Down Expand Up @@ -40,15 +41,22 @@ export class OverflowDropdown extends TailwindElement {
@query("sl-dropdown")
private readonly dropdown?: SlDropdown;

@queryAssignedElements({ selector: "sl-menu", flatten: true })
private readonly menu!: SlMenu[];
@queryAssignedElements({
selector: "sl-menu, btrix-workflow-action-menu",
flatten: true,
})
private readonly menu!: (SlMenu | WorkflowActionMenu)[];

render() {
return html`
<sl-dropdown
?disabled=${!this.hasMenuItems}
hoist
distance=${ifDefined(this.raised ? "4" : undefined)}
@btrix-select=${() => {
void this.dropdown?.hide();
this.dropdown?.focusOnTrigger();
}}
>
<btrix-button
slot="trigger"
Expand Down
7 changes: 7 additions & 0 deletions frontend/src/events/btrix-select.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
export type BtrixSelectEvent<T = unknown> = CustomEvent<{ item: T }>;

declare global {
interface GlobalEventHandlersEventMap {
"btrix-select": BtrixSelectEvent;
}
}
1 change: 1 addition & 0 deletions frontend/src/features/crawl-workflows/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ import("./link-selector-table");
import("./new-workflow-dialog");
import("./queue-exclusion-form");
import("./queue-exclusion-table");
import("./workflow-action-menu/workflow-action-menu");
import("./workflow-editor");
import("./workflow-list");
import("./workflow-schedule-filter");
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
export { WorkflowActionMenu } from "./workflow-action-menu";
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
import type { BtrixSelectEvent } from "@/events/btrix-select";

export enum Action {
Run = "run",
TogglePauseResume = "togglePauseResume",
Stop = "stop",
Cancel = "cancel",
EditBrowserWindows = "editBrowserWindows",
EditExclusions = "editExclusions",
Duplicate = "duplicate",
Delete = "delete",
}

export type BtrixSelectActionEvent = BtrixSelectEvent<{ action: Action }>;
Loading
Loading