From 202d72d365be841055ac7aca0fd45d79bc087704 Mon Sep 17 00:00:00 2001
From: guoxudong <guoxudong.dev@gmail.com>
Date: Fri, 29 Jul 2022 05:05:54 +0800
Subject: [PATCH] feat: add [GitlabForks] server (#8208)
* feat: add gitlab forks server
* add test case
* fix
* fix test
* link message to /forks
Co-authored-by: chris48s <chris.shaw480@gmail.com>
Co-authored-by: chris48s <chris48s@users.noreply.github.com>
---
services/gitlab/gitlab-forks.service.js | 77 +++++++++++++++++++++++++
services/gitlab/gitlab-forks.tester.js | 35 +++++++++++
2 files changed, 112 insertions(+)
create mode 100644 services/gitlab/gitlab-forks.service.js
create mode 100644 services/gitlab/gitlab-forks.tester.js
diff --git a/services/gitlab/gitlab-forks.service.js b/services/gitlab/gitlab-forks.service.js
new file mode 100644
index 0000000000..29b31b290c
--- /dev/null
+++ b/services/gitlab/gitlab-forks.service.js
@@ -0,0 +1,77 @@
+import Joi from 'joi'
+import { optionalUrl, nonNegativeInteger } from '../validators.js'
+import { metric } from '../text-formatters.js'
+import GitLabBase from './gitlab-base.js'
+
+const schema = Joi.object({
+ forks_count: nonNegativeInteger,
+}).required()
+
+const queryParamSchema = Joi.object({
+ gitlab_url: optionalUrl,
+}).required()
+
+const documentation = `
+<p>
+ You may use your GitLab Project Id (e.g. 278964) or your Project Path (e.g. gitlab-org/gitlab ).
+ Note that only internet-accessible GitLab instances are supported, for example https://jihulab.com, https://gitlab.gnome.org, or https://gitlab.com/.
+</p>
+`
+
+export default class GitlabForks extends GitLabBase {
+ static category = 'social'
+
+ static route = {
+ base: 'gitlab/forks',
+ pattern: ':project+',
+ queryParamSchema,
+ }
+
+ static examples = [
+ {
+ title: 'GitLab forks',
+ namedParams: {
+ project: 'gitlab-org/gitlab',
+ },
+ queryParams: { gitlab_url: 'https://gitlab.com' },
+ staticPreview: {
+ label: 'Fork',
+ message: '6.4k',
+ style: 'social',
+ },
+ documentation,
+ },
+ ]
+
+ static defaultBadgeData = { label: 'forks', namedLogo: 'gitlab' }
+
+ static render({ baseUrl, project, forkCount }) {
+ return {
+ message: metric(forkCount),
+ color: 'blue',
+ link: [
+ `${baseUrl}/${project}/-/forks/new`,
+ `${baseUrl}/${project}/-/forks`,
+ ],
+ }
+ }
+
+ async fetch({ project, baseUrl }) {
+ // https://docs.gitlab.com/ee/api/projects.html#get-single-project
+ return super.fetch({
+ schema,
+ url: `${baseUrl}/api/v4/projects/${encodeURIComponent(project)}`,
+ errorMessages: {
+ 404: 'project not found',
+ },
+ })
+ }
+
+ async handle({ project }, { gitlab_url: baseUrl = 'https://gitlab.com' }) {
+ const { forks_count: forkCount } = await this.fetch({
+ project,
+ baseUrl,
+ })
+ return this.constructor.render({ baseUrl, project, forkCount })
+ }
+}
diff --git a/services/gitlab/gitlab-forks.tester.js b/services/gitlab/gitlab-forks.tester.js
new file mode 100644
index 0000000000..ca30f03b2c
--- /dev/null
+++ b/services/gitlab/gitlab-forks.tester.js
@@ -0,0 +1,35 @@
+import { isMetric } from '../test-validators.js'
+import { createServiceTester } from '../tester.js'
+
+export const t = await createServiceTester()
+
+t.create('Forks')
+ .get('/gitlab-org/gitlab.json')
+ .expectBadge({
+ label: 'forks',
+ message: isMetric,
+ color: 'blue',
+ link: [
+ 'https://gitlab.com/gitlab-org/gitlab/-/forks/new',
+ 'https://gitlab.com/gitlab-org/gitlab/-/forks',
+ ],
+ })
+
+t.create('Forks (self-managed)')
+ .get('/gitlab-cn/gitlab.json?gitlab_url=https://jihulab.com')
+ .expectBadge({
+ label: 'forks',
+ message: isMetric,
+ color: 'blue',
+ link: [
+ 'https://jihulab.com/gitlab-cn/gitlab/-/forks/new',
+ 'https://jihulab.com/gitlab-cn/gitlab/-/forks',
+ ],
+ })
+
+t.create('Forks (project not found)')
+ .get('/user1/gitlab-does-not-have-this-repo.json')
+ .expectBadge({
+ label: 'forks',
+ message: 'project not found',
+ })
--
GitLab