feat: docker widget

[hillaliy]

Homarr

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

• Builds without warnings or errors (pnpm buid, 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)

[deepsource-io]

Here's the code health analysis summary for commits f19aa29..54023a0. View details on DeepSource ↗.

Analysis Summary

Analyzer	Status	Summary	Link
JavaScript	✅ Success		View Check ↗

---

💡 If you’re a repository administrator, you can configure the quality gates from the settings.

[github-actions]

Coverage Report

Status	Category	Percentage	Covered / Total
🔵	Lines	22.62%	10209 / 45119
🔵	Statements	22.62%	10209 / 45119
🔵	Functions	29.79%	426 / 1430
🔵	Branches	64.53%	1223 / 1895

File Coverage

File	Stmts	Branches	Functions	Lines	Uncovered Lines
Changed Files
packages/api/src/router/docker/docker-router.ts	64.19%	69.23%	100%	64.19%	23-56, 59-63, 67-72, 101, 115, 129, 143, 159-160, 177-178, 195-203
packages/definitions/src/widget.ts	100%	100%	100%	100%
packages/request-handler/src/docker.ts	47.22%	66.66%	0%	47.22%	23-26, 52-53, 65-67, 70-127
packages/widgets/src/index.tsx	50%	100%	0%	50%	70-86, 101-114
packages/widgets/src/docker/component.tsx	0%	0%	0%	0%	1-303
packages/widgets/src/docker/index.ts	100%	100%	50%	100%

Generated in workflow #5471 for commit 54023a0 by the Vitest Coverage Report Action

[hillaliy]

I will remove unused variables

[hillaliy]

[manuel-rw]

Hi @hillaliy , thanks for the contribution. Please see the lint and DeepSource first. After that, we'll happily review your PR. Thanks!

[hillaliy]

Lint and deepSource errors is because unused variables. I'm still thinking if need to add options so if you can review my PR and if you have an idea for widget options. Thanks

[hillaliy]

@Meierschlumpf I need your help with this widget. Refresh rate is not good enough.

[Meierschlumpf]

1. What do you mean with refresh rate?
2. How can I help you?

[hillaliy]

I mean with data refresh. Can you pull it and try it?

[Meierschlumpf]

Okay yeah currently it is cached for 5 minutes:

const dockerCache = createCacheChannel<{
  containers: (ContainerInfo & { instance: string; iconUrl: string | null; cpuUsage: number; memoryUsage: number })[];
}>("docker-containers", 5 * 60 * 1000);

I would suggest that we replace this with the request-handlers we use for other integrations as well. Then we can also add a subscription functionallity

[ajnart]

@hillaliy i think for this use case we'd want the data to be refreshed after the page loads as well as after every action (start/stop/restart)
Refreshing it in the background is not needed since the data is not shown on dashboards

[Meierschlumpf]

It's the widget and not a modal or something, so we want to refresh the data every few seconds

[Meierschlumpf]

Also there should be a background job that periodically updates the data (like every minute) and we need to decide who should be able to add this widget to a board. The interactions should be restricted to only admins I would guess.

The cqmin system was just removed, so please adjust that as well