Add GitLab Statistics

Added star and fork statistics on detailed project view for projects with an
valid GitLab URL.

Ref: #4301

Author: am-on

tests/unit/packaging/test_models.py

@@ -328,6 +328,36 @@ def test_github_repo_info_url(self, db_session, home_page, expected):
         release = DBReleaseFactory.create(home_page=home_page)
         assert release.github_repo_info_url == expected
 
+    @pytest.mark.parametrize(
+        ("home_page", "expected"),
+        [
+            (None, None),
+            (
+                "https://gitlab.com/user/project",
+                "https://gitlab.com/api/v4/projects/user%2Fproject",
+            ),
+            (
+                "https://gitlab.com/user/project/",
+                "https://gitlab.com/api/v4/projects/user%2Fproject",
+            ),
+            (
+                "https://gitlab.com/user/project/tree/master",
+                "https://gitlab.com/api/v4/projects/user%2Fproject",
+            ),
+            (
+                "https://www.gitlab.com/user/project",
+                "https://gitlab.com/api/v4/projects/user%2Fproject",
+            ),
+            ("https://gitlab.com/user/", None),
+            ("https://google.com/user/project/tree/master", None),
+            ("https://google.com", None),
+            ("incorrect url", None),
+        ],
+    )
+    def test_gitlab_repo_info_url(self, db_session, home_page, expected):
+        release = DBReleaseFactory.create(home_page=home_page)
+        assert release.gitlab_repo_info_url == expected
+
 
 class TestFile:
     def test_requires_python(self, db_session):

tests/unit/test_csp.py

@@ -201,6 +201,7 @@ def test_includeme():
                     "connect-src": [
                         "'self'",
                         "https://github.com/api/repos/",
+                        "https://gitlab.com/api/v4/projects/",
                         "*.fastly-insights.com",
                         "sentry.io",
                         "https://2p66nmmycsj3.statuspage.io",

warehouse/csp.py

@@ -81,6 +81,7 @@ def includeme(config):
                 "connect-src": [
                     SELF,
                     "https://github.com/api/repos/",
+                    "https://gitlab.com/api/v4/projects/",
                     "*.fastly-insights.com",
                     "sentry.io",
                 ]

warehouse/packaging/models.py

@@ -413,6 +413,18 @@ def github_repo_info_url(self):
                 user_name, repo_name = segments[:2]
                 return f"https://github.com/api/repos/{user_name}/{repo_name}"
 
+    @property
+    def gitlab_repo_info_url(self):
+        # import pdb; pdb.set_trace()
+        for parsed in [urlparse(url) for url in self.urls.values()]:
+            segments = parsed.path.strip("/").rstrip("/").split("/")
+
+            if (
+                parsed.netloc == "gitlab.com" or parsed.netloc == "www.gitlab.com"
+            ) and len(segments) >= 2:
+                user_name, repo_name = segments[:2]
+                return f"https://gitlab.com/api/v4/projects/{user_name}%2F{repo_name}"
+
     @property
     def has_meta(self):
         return any(

warehouse/static/js/warehouse/utils/repository-info.js

@@ -12,46 +12,53 @@
  */
 
 export default () => {
-  const repoInfoContainer = document.querySelector(".github-repo-info");
-  if (repoInfoContainer !== null){
-    const url = repoInfoContainer.dataset.url;
-    fetch(url, {
-      method: "GET",
-      mode: "cors",
-    }).then((response) => {
-      if (response.ok){
-        return response.json();
-      } else {
-        return null;
-      }
-    }).then((json) => {
-      if (json === null){
-        return;
-      }
-      repoInfoContainer.classList.remove("hidden");
-      const items = document.querySelectorAll(".github-repo-info__item");
-      items.forEach(function(elem) {
-        const jsonKey = elem.dataset.key;
-        let jsonValue = json[jsonKey];
-        if(jsonValue !== undefined){
-          const supplement = elem.dataset.supplement;
-          if (supplement !== undefined) {
-            jsonValue += supplement;
-          }
-          if (jsonKey.includes("_count")) {
-            // Number formatting for count keys.
-            jsonValue = jsonValue.toLocaleString();
-          }
-          const attr = elem.dataset.attr;
-          if (attr !== undefined) {
-            elem[attr] = jsonValue;
-          } else {
-            elem.innerText = jsonValue;
-          }
+  const services = [
+    {wrapper: ".github-repo-info", items: ".github-repo-info__item"},
+    {wrapper: ".gitlab-repo-info", items: ".gitlab-repo-info__item"}
+  ]
+
+  services.forEach((service) => {
+    let repoInfoContainer = document.querySelector(service.wrapper);
+    if (repoInfoContainer !== null){
+      const url = repoInfoContainer.dataset.url;
+      fetch(url, {
+        method: "GET",
+        mode: "cors",
+      }).then((response) => {
+        if (response.ok){
+          return response.json();
+        } else {
+          return null;
+        }
+      }).then((json) => {
+        if (json === null){
+          return;
         }
-      }, this);
-    }).catch(function() {
+        repoInfoContainer.classList.remove("hidden");
+        const items = document.querySelectorAll(service.items);
+        items.forEach(function(elem) {
+          const jsonKey = elem.dataset.key;
+          let jsonValue = json[jsonKey];
+          if(jsonValue !== undefined){
+            const supplement = elem.dataset.supplement;
+            if (supplement !== undefined) {
+              jsonValue += supplement;
+            }
+            if (jsonKey.includes("_count")) {
+              // Number formatting for count keys.
+              jsonValue = jsonValue.toLocaleString();
+            }
+            const attr = elem.dataset.attr;
+            if (attr !== undefined) {
+              elem[attr] = jsonValue;
+            } else {
+              elem.innerText = jsonValue;
+            }
+          }
+        }, this);
+      }).catch(function() {
 
-    });
-  }
+      });
+    }
+  });
 };

warehouse/templates/includes/packaging/project-data.html

@@ -54,6 +54,26 @@ <h3 class="sidebar-section__title">Statistics</h3>
     </a>
   </div>
   {% endif %}
+
+  {% if release.gitlab_repo_info_url %}
+  <div class="gitlab-repo-info hidden" data-url="{{release.gitlab_repo_info_url}}">
+    <em>GitLab statistics:</em>
+    <a class="vertical-tabs__tab vertical-tabs__tab--with-icon vertical-tabs__tab--condensed gitlab-repo-info__item"
+       data-key="html_url" data-attr="href" data-supplement="/stargazers" rel="noopener"
+       target="_blank">
+      <i class="fa fa-star" aria-hidden="true"></i>
+      <strong>Stars: </strong>
+      <span class="gitlab-repo-info__item" data-key="star_count"></span>
+    </a>
+    <a class="vertical-tabs__tab vertical-tabs__tab--with-icon vertical-tabs__tab--condensed gitlab-repo-info__item"
+       data-key="html_url" data-attr="href" data-supplement="/network" rel="noopener"
+       target="_blank">
+      <i class="fa fa-code-branch" aria-hidden="true"></i>
+      <strong>Forks: </strong>
+      <span class="gitlab-repo-info__item" data-key="forks_count"></span>
+    </a>
+  </div>
+  {% endif %}
   <p>View statistics for this project via <a
           href="https://libraries.io/pypi/{{ release.project.name }}">Libraries.io</a>, or by using
     <a href="https://packaging.python.org/guides/analyzing-pypi-package-downloads/">Google