feat: unifi controller integration #2236

pitschi · 2025-02-03T18:00:27Z

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 · 2025-02-03T18:01:35Z

Here's the code health analysis summary for commits d9720ac..aab769f. 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.

packages/definitions/src/integration.ts

packages/integrations/src/unifi-controller/unifi-controller-integration.ts

packages/widgets/src/network-controller/summary/component.tsx

manuel-rw · 2025-02-03T21:52:13Z

Thanks a lot for this contribution, @pitschi .
I'm looking forward to this integration because I use UniFi myself! Great work 🚀

pitschi · 2025-02-04T13:36:06Z

Thanks a lot for this contribution, @pitschi . I'm looking forward to this integration because I use UniFi myself! Great work 🚀
omg... Manuel... I thank YOU so much for taking the time to comment. I will take care of those points and resubmit a new pr.

Meierschlumpf · 2025-02-04T15:55:03Z

@pitschi you can simply continue in this pr if you want to address the comments

pitschi · 2025-02-04T17:27:20Z

ups... ok, thanks. have to get into the flow again.

manuel-rw · 2025-02-04T17:57:56Z

ups... ok, thanks. have to get into the flow again.

No worries. Here's how it works:

You open a pull request
You set it to "ready for review" as soon as you finished implementation and completed all TODO tasks in the first comment
We review your PR and provide feedback
You implement feedback
Start over from point 3 unless all feedback has been addressed (in which case we approve)
We merge your PR
You must wait for the next weekly release (Friday evening CEST) and then you can pull the new version with your change included!

packages/integrations/src/unifi-controller/unifi-controller-integration.ts

packages/log/src/index.mjs

packages/request-handler/src/network-controller.ts

manuel-rw · 2025-03-08T19:52:08Z

Since there is no further activity on this PR, I will take over this pull request. Thank you for the initial contribution @pitschi

packages/widgets/src/network-controller/summary/component.tsx

Meierschlumpf · 2025-03-09T13:29:33Z

packages/api/src/router/widgets/network-controller.ts

+              id: integration.id,
+              name: integration.name,
+              kind: integration.kind,
+              updatedAt: timestamp,


Maybe it makes more sense to put this one level out?

Meierschlumpf · 2025-03-09T13:34:11Z

...s/integrations/src/interfaces/network-controller-summary/network-controller-summary-types.ts

+  wwwStatus: "enabled" | "disabled";
+  wwwLatency: number;
+  wwwPing: number;
+  wwwUptime: number;


What about using objects instead? Like

const a = { www: { status: "enabled", latency: 5, ping: 3, uptime: 99999 } };

Meierschlumpf · 2025-03-09T13:35:45Z

packages/integrations/src/unifi-controller/error-by-status-code.ts

+export const throwByUnifiControllerResponseStatusCode = (statusCode: number) => {
+  switch (statusCode) {
+    case 400:
+      throw new IntegrationTestConnectionError("badRequest");
+    case 401:
+      throw new IntegrationTestConnectionError("unauthorized");
+    case 403:
+      throw new IntegrationTestConnectionError("forbidden");
+    case 404:
+      throw new IntegrationTestConnectionError("notFound");
+    case 429:
+      throw new IntegrationTestConnectionError("tooManyRequests");
+    case 500:
+      throw new IntegrationTestConnectionError("internalServerError");
+    case 503:
+      throw new IntegrationTestConnectionError("serviceUnavailable");
+    default:
+      throw new IntegrationTestConnectionError("commonError");
+  }


Use throwErrorByStatusCode instead and add the missing codes

Meierschlumpf · 2025-03-09T13:43:58Z

packages/integrations/src/unifi-controller/unifi-controller-integration.ts

+    const responseHeaders = loginResponse.headers;
+    const newHeaders: Record<string, string> = {};
+    const loginToken = UnifiControllerIntegration.extractLoginTokenFromCookies(responseHeaders);
+    newHeaders.Cookie = `${loginToken};`;


What about storing this login token with session-store? Then it will also be persisted for nextjs etc. I would suggest to do it similar to what I did with pi-hole v6 (always fetch new session for test connection)

Meierschlumpf · 2025-03-09T13:45:03Z

packages/integrations/src/unifi-controller/unifi-controller-integration.ts

+    const result = unifiSummaryResponseSchema.safeParse(await statsResponse.json());
+
+    if (!result.success) {
+      throw new Error("Error parsing response from unifi controller.", result.error);


throw new ParseError()

Meierschlumpf · 2025-03-09T13:52:45Z

packages/widgets/src/index.tsx

@@ -51,6 +53,8 @@ export const widgetImports = {
  downloads,
  "mediaRequests-requestList": mediaRequestsList,
  "mediaRequests-requestStats": mediaRequestsStats,
+  networkControllerSummary,
+  networkControllerNetworkStatus: networkControllerStatus,


Make them the same name

Meierschlumpf · 2025-03-09T13:53:51Z

packages/widgets/src/network-controller/network-status/component.tsx

+            }
+
+            return prevData.map((item) =>
+              item.integration.id === data.integration.id ? { ...item, summary: data.summary } : item,


You may also need to update the updatedAt when you want it existing. If not needed, just remove it

Meierschlumpf · 2025-03-09T13:56:03Z

apps/nextjs/src/app/[locale]/boards/(content)/_theme.tsx

+      xl2: rem(24),
+      xl3: rem(28),
+      xl4: rem(36),


What about 2xl instead of xl2?

Meierschlumpf · 2025-03-09T13:58:53Z

packages/widgets/src/network-controller/network-status/variants/wifi-variant.tsx

The two variants are very similar. Why not just one generic component for example with properties

interface NetworkStatusContentProps { icon: TablerIcon; title: string; stats: StatRowProps[] }

Then the design will always be consistent and we don't need to change (now 2) multiple components

Meierschlumpf · 2025-03-09T14:00:46Z

packages/widgets/src/network-controller/summary/component.tsx

+    <Box h="100%" p="sm">
+      <Center h={"100%"}>
+        <List spacing={"xs"} center>
+          <List.Item icon={<StatusIcon status={data[0]?.wanStatus} />}>WAN</List.Item>


Can't we just make it no longer an array if we only use [0]?

pitschi requested a review from a team as a code owner February 3, 2025 18:00

pitschi changed the title ~~Feat unifi controller integration~~ feat: unifi controller integration Feb 3, 2025

manuel-rw requested changes Feb 3, 2025

View reviewed changes

manuel-rw assigned pitschi Feb 3, 2025

manuel-rw added enhancement New feature or request integration New integration labels Feb 3, 2025

pitschi closed this Feb 4, 2025

pitschi reopened this Feb 4, 2025

manuel-rw requested changes Feb 18, 2025

View reviewed changes

manuel-rw assigned manuel-rw and unassigned pitschi Mar 8, 2025

manuel-rw force-pushed the feat-unifi-controller-integration branch 4 times, most recently from a738c45 to 8cd2d71 Compare March 8, 2025 21:20

manuel-rw requested changes Mar 8, 2025

View reviewed changes

packages/widgets/src/network-controller/summary/component.tsx Show resolved Hide resolved

manuel-rw force-pushed the feat-unifi-controller-integration branch from 8cd2d71 to b221a88 Compare March 8, 2025 22:13

manuel-rw marked this pull request as draft March 8, 2025 22:13

manuel-rw force-pushed the feat-unifi-controller-integration branch 5 times, most recently from af4fd14 to b9970e6 Compare March 9, 2025 11:27

manuel-rw force-pushed the feat-unifi-controller-integration branch 2 times, most recently from 31ee449 to 4ff6d7d Compare March 9, 2025 11:32

feat: unifi controller integration

aab769f

manuel-rw force-pushed the feat-unifi-controller-integration branch from 4ff6d7d to aab769f Compare March 9, 2025 11:36

manuel-rw marked this pull request as ready for review March 9, 2025 11:42

manuel-rw requested a review from a team March 9, 2025 11:43

Meierschlumpf requested changes Mar 9, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: unifi controller integration #2236

feat: unifi controller integration #2236

pitschi commented Feb 3, 2025 •

edited by manuel-rw

Loading

deepsource-io bot commented Feb 3, 2025 •

edited

Loading

Analysis Summary

manuel-rw commented Feb 3, 2025

pitschi commented Feb 4, 2025

Meierschlumpf commented Feb 4, 2025

pitschi commented Feb 4, 2025

manuel-rw commented Feb 4, 2025

manuel-rw commented Mar 8, 2025

Meierschlumpf Mar 9, 2025

Meierschlumpf Mar 9, 2025

Meierschlumpf Mar 9, 2025

Meierschlumpf Mar 9, 2025

Meierschlumpf Mar 9, 2025

Meierschlumpf Mar 9, 2025

Meierschlumpf Mar 9, 2025

Meierschlumpf Mar 9, 2025

Meierschlumpf Mar 9, 2025

Meierschlumpf Mar 9, 2025

feat: unifi controller integration #2236

Are you sure you want to change the base?

feat: unifi controller integration #2236

Conversation

pitschi commented Feb 3, 2025 • edited by manuel-rw Loading

Homarr

deepsource-io bot commented Feb 3, 2025 • edited Loading

Analysis Summary

manuel-rw commented Feb 3, 2025

pitschi commented Feb 4, 2025

Meierschlumpf commented Feb 4, 2025

pitschi commented Feb 4, 2025

manuel-rw commented Feb 4, 2025

manuel-rw commented Mar 8, 2025

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

pitschi commented Feb 3, 2025 •

edited by manuel-rw

Loading

deepsource-io bot commented Feb 3, 2025 •

edited

Loading