Feature: gitlab service widget (#4317)

Co-authored-by: shamoon <[email protected]>

Author: UrsKroell

docs/widgets/services/gitlab.md

@@ -0,0 +1,20 @@
+---
+title: Gitlab
+description: Gitlab Widget Configuration
+---
+
+Learn more about [Gitlab](https://gitlab.com).
+
+API requires a personal access token with either `read_api` or `api` permission. See the [gitlab documentation](https://docs.gitlab.com/ee/user/profile/personal_access_tokens.html#create-a-personal-access-token) for details on generating one.
+
+Your Gitlab user ID can be found on [your profile page](https://support.circleci.com/hc/en-us/articles/20761157174043-How-to-find-your-GitLab-User-ID).
+
+Allowed fields: `["events", "issues", "merges", "projects"]`.
+
+```yaml
+widget:
+  type: gitlab
+  url: http://gitlab.host.or.ip:port
+  key: personal-access-token
+  user_id: 123456
+```

docs/widgets/services/index.md

@@ -41,6 +41,7 @@ You can also find a list of all available service widgets in the sidebar navigat
 - [Gatus](gatus.md)
 - [Ghostfolio](ghostfolio.md)
 - [Gitea](gitea.md)
+- [Gitlab](gitlab.md)
 - [Glances](glances.md)
 - [Gluetun](gluetun.md)
 - [Gotify](gotify.md)

mkdocs.yml

@@ -64,6 +64,7 @@ nav:
           - widgets/services/gatus.md
           - widgets/services/ghostfolio.md
           - widgets/services/gitea.md
+          - widgets/services/gitlab.md
           - widgets/services/glances.md
           - widgets/services/gluetun.md
           - widgets/services/gotify.md

public/locales/en/common.json

@@ -1001,5 +1001,11 @@
     },
     "spoolman": {
         "loading": "Loading"
+    },
+    "gitlab": {
+        "groups": "Groups",
+        "issues": "Issues",
+        "merges": "Merge Requests",
+        "projects": "Projects"
     }
 }

src/utils/proxy/handlers/credentialed.js

@@ -94,6 +94,8 @@ export default async function credentialedProxyHandler(req, res, map) {
         }
       } else if (widget.type === "wgeasy") {
         headers.Authorization = widget.password;
+      } else if (widget.type === "gitlab") {
+        headers["PRIVATE-TOKEN"] = widget.key;
       } else {
         headers["X-API-Key"] = `${widget.key}`;
       }

src/widgets/components.js

@@ -38,6 +38,7 @@ const components = {
   gatus: dynamic(() => import("./gatus/component")),
   ghostfolio: dynamic(() => import("./ghostfolio/component")),
   gitea: dynamic(() => import("./gitea/component")),
+  gitlab: dynamic(() => import("./gitlab/component")),
   glances: dynamic(() => import("./glances/component")),
   gluetun: dynamic(() => import("./gluetun/component")),
   gotify: dynamic(() => import("./gotify/component")),

src/widgets/gitlab/component.jsx

@@ -0,0 +1,36 @@
+import { useTranslation } from "next-i18next";
+
+import Container from "components/services/widget/container";
+import Block from "components/services/widget/block";
+import useWidgetAPI from "utils/proxy/use-widget-api";
+
+export default function Component({ service }) {
+  const { t } = useTranslation();
+  const { widget } = service;
+
+  const { data: gitlabCounts, error: gitlabCountsError } = useWidgetAPI(widget, "counts");
+
+  if (gitlabCountsError) {
+    return <Container service={service} error={gitlabCountsError} />;
+  }
+
+  if (!gitlabCounts) {
+    return (
+      <Container service={service}>
+        <Block label="gitlab.groups" />
+        <Block label="gitlab.issues" />
+        <Block label="gitlab.merges" />
+        <Block label="gitlab.projects" />
+      </Container>
+    );
+  }
+
+  return (
+    <Container service={service}>
+      <Block label="gitlab.groups" value={t("common.number", { value: gitlabCounts.groups_count })} />
+      <Block label="gitlab.issues" value={t("common.number", { value: gitlabCounts.issues_count })} />
+      <Block label="gitlab.merges" value={t("common.number", { value: gitlabCounts.merge_requests_count })} />
+      <Block label="gitlab.projects" value={t("common.number", { value: gitlabCounts.projects_count })} />
+    </Container>
+  );
+}

src/widgets/gitlab/widget.js

@@ -0,0 +1,13 @@
+import credentialedProxyHandler from "utils/proxy/handlers/credentialed";
+
+const widget = {
+  api: "{url}/api/v4/{endpoint}",
+  proxyHandler: credentialedProxyHandler,
+  mappings: {
+    counts: {
+      endpoint: "users/{user_id}/associations_count",
+    },
+  },
+};
+
+export default widget;

src/widgets/widgets.js

@@ -32,6 +32,7 @@ import gamedig from "./gamedig/widget";
 import gatus from "./gatus/widget";
 import ghostfolio from "./ghostfolio/widget";
 import gitea from "./gitea/widget";
+import gitlab from "./gitlab/widget";
 import glances from "./glances/widget";
 import gluetun from "./gluetun/widget";
 import gotify from "./gotify/widget";
@@ -164,6 +165,7 @@ const widgets = {
   gatus,
   ghostfolio,
   gitea,
+  gitlab,
   glances,
   gluetun,
   gotify,