feat(integrations): add ArchiveTeam Warrior widget by darbyjack · Pull Request #5784 · homarr-labs/homarr

darbyjack · 2026-05-24T14:54:08Z

Homarr

Thank you for your contribution. Please ensure that your pull request meets the following pull request:

Builds without warnings or errors (pnpm build, autofix with pnpm format:fix)
Pull request targets dev branch
Commits follow the conventional commits guideline
No shorthand variable names are used (eg. x, y, i or any abbrevation)
Documentation is up to date. Create a pull request here.

Summary

Adds a read-only ArchiveTeam Warrior integration and widget.

The widget connects to the Warrior web interface and reads the Seesaw/SockJS status stream to display:

current Warrior status
selected/current project
running, completed, failed, and canceled item counts
current download/upload bandwidth
broadcast message when available

This first iteration intentionally does not expose control actions such as stopping the Warrior, changing projects, or modifying settings.

Testing

dokploy-homarr-labs · 2026-05-24T14:54:14Z

🚨 Preview Deployment Blocked - Security Protection

Your pull request was blocked from triggering preview deployments

Why was this blocked?

User: darbyjack
Repository: homarr
Permission Level: read
Required Level: write, maintain, or admin

How to resolve this:

Option 1: Get Collaborator Access (Recommended)
Ask a repository maintainer to invite you as a collaborator with write permissions or higher.

Option 2: Request Permission Override
Ask a repository administrator to disable security validation for this specific application if appropriate.

For Repository Administrators:

To disable this security check (⚠️ not recommended for public repositories):
Enter to preview settings and disable the security check.

This security measure protects against malicious code execution in preview deployments. Only trusted collaborators should have the ability to trigger deployments.

🛡️ Learn more about this security feature

This protection prevents unauthorized users from:

Executing malicious code on the deployment server
Accessing environment variables and secrets
Potentially compromising the infrastructure

Preview deployments are powerful but require trust. Only users with repository write access can trigger them.

manuel-rw · 2026-05-24T18:48:46Z

+  archiveTeamWarrior: {
+    name: "ArchiveTeam Warrior",
+    secretKinds: [[], ["username", "password"]],
+    iconUrl: "https://cdn.jsdelivr.net/gh/homarr-labs/dashboard-icons@master/svg/archivebox.svg",


Is this really yours? If you have a more specific logo, you can add it via https://dashboardicons.com

I do not maintain the project, I'm just a user of it. I did find their logo on that site and I will swap it over.

manuel-rw · 2026-05-24T18:49:15Z

+const seesawFrameSchema = z.object({
+  event_name: z.string(),
+  message: z.unknown(),
+});
+
+const warriorStatusMessageSchema = z.object({
+  status: z.string(),
+});
+
+const warriorBroadcastMessageSchema = z.object({
+  message: z.string().nullable(),
+});
+
+const warriorProjectSelectedMessageSchema = z.object({
+  project: z.string().nullable(),
+});
+
+const warriorProjectSchema = z.object({
+  project_id: z.number().optional(),
+  title: z.string().optional(),
+  project_html: z.string().optional(),
+  utc_deadline: z.string().nullable().optional(),
+});
+
+const warriorItemSchema = z.object({
+  id: z.string(),
+  name: z.string(),
+  status: z.string().nullable().optional(),
+  project: z.string().nullable().optional(),
+  start_time: z.number().optional(),
+});
+
+const projectRefreshMessageSchema = z
+  .object({
+    project: warriorProjectSchema.optional(),
+    status: z.string().optional(),
+    items: z.array(warriorItemSchema).optional(),
+  })
+  .nullable();
+
+const itemStatusMessageSchema = z.object({
+  item_id: z.string(),
+});
+
+const pipelineStartItemMessageSchema = z.object({
+  item: warriorItemSchema,
+});
+
+const bandwidthMessageSchema = z.object({
+  received: z.number().optional(),
+  sent: z.number().optional(),
+  receiving: z.number().optional(),
+  sending: z.number().optional(),
+  session_id: z.string().optional(),
+});
+
+type WarriorProject = z.infer<typeof warriorProjectSchema>;
+type WarriorItem = z.infer<typeof warriorItemSchema>;
+type SeesawFrame = z.infer<typeof seesawFrameSchema>;


Can you put this in a separate file?

manuel-rw · 2026-05-24T18:50:17Z

+        const frames = this.parseSockJsMessage(event.data);
+
+        for (const frame of frames) {
+          switch (frame.event_name) {


I think this should be put in a separate function to reduce cognitive complexity

manuel-rw · 2026-05-24T18:53:02Z

+    const integrationInstance = await createIntegrationAsync(integration);
+    return await integrationInstance.getStatusAsync();
+  },
+  cacheDuration: dayjs.duration(10, "seconds"),


10 seconds is very short, does it really need to be that short?

Most likely not. I'll update it to every minute.

manuel-rw · 2026-05-24T18:55:57Z

+          <Stack gap={0}>
+            <Text fw={700} lineClamp={1}>
+              ArchiveTeam Warrior
+            </Text>


We mostly remove the names of widgets now from them.
Can you remove this one too?

For sure! First time here, thanks for letting me know.

manuel-rw · 2026-05-24T18:56:20Z

+const formatBytesPerSecond = (value?: number) => {
+  if (!value) return "0 KB/s";
+
+  if (value >= 1024 * 1024) {
+    return `${(value / 1024 / 1024).toFixed(1)} MB/s`;
+  }
+
+  return `${Math.round(value / 1024)} KB/s`;
+};


We already have a method for this. Please remove and use the existing one.

Will do, thank you.

manuel-rw · 2026-05-24T18:57:53Z

I think we can still improve the spacing and padding of the widget.
Would you like me to give some suggestions or do you want to try yourself?

darbyjack · 2026-05-24T19:08:09Z

I think we can still improve the spacing and padding of the widget. Would you like me to give some suggestions or do you want to try yourself?

I'm more than happy to give it a shot. I'd definitely appreciate your input as well :)

darbyjack · 2026-05-24T19:20:36Z

Thanks for the review. I pushed updates addressing the requested changes:

Removed the duplicated widget title from the widget body
Updated the widget layout/spacing and changed the metric grid to be less cramped
Replaced the local bandwidth formatter with Homarr's existing helper
Moved the ArchiveTeam Warrior websocket schemas into a dedicated schema file
Split websocket frame handling into smaller methods to reduce cognitive complexity
Increased the request-handler cache duration from 10 seconds to 1 minute
Updated to the ArchiveTeam Warrior icon from https://dashboardicons.com/

manuel-rw · 2026-05-28T18:40:29Z

Did you resolve the comments from my review? If yes, please always mark them as "resolved".
I'll review again.... 🕐

manuel-rw · 2026-05-28T18:41:49Z

+    const integrationInstance = await createIntegrationAsync(integration);
+    return await integrationInstance.getStatusAsync();
+  },
+  cacheDuration: dayjs.duration(1, "minute"),


Is 1 minute really needed here? 5 minutes should be enough too

darbyjack requested a review from a team as a code owner May 24, 2026 14:54

feat(integrations): add ArchiveTeam Warrior widget

dde277e

darbyjack force-pushed the feat/archive-team-warrior-widget branch from 56226e1 to dde277e Compare May 24, 2026 14:55

manuel-rw assigned darbyjack May 24, 2026

manuel-rw requested changes May 24, 2026

View reviewed changes

feat(integrations): add support for basic auth for archive warrior

44a223d

refactor(integrations): address ArchiveTeam Warrior review feedback

389c80f

darbyjack requested a review from manuel-rw May 24, 2026 19:20

manuel-rw requested changes May 28, 2026

View reviewed changes

manuel-rw assigned Meierschlumpf May 28, 2026

Uh oh!

Conversation

darbyjack commented May 24, 2026

Homarr

Summary

Testing

Uh oh!

dokploy-homarr-labs Bot commented May 24, 2026

🚨 Preview Deployment Blocked - Security Protection

Why was this blocked?

How to resolve this:

For Repository Administrators:

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

manuel-rw commented May 24, 2026

Uh oh!

darbyjack commented May 24, 2026

Uh oh!

darbyjack commented May 24, 2026

Uh oh!

manuel-rw commented May 28, 2026

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants