Adding Http proxy (#134)

* initial changes

* fixed http proxy in index and config

* adding helm

* Fix some type errors

Co-authored-by: Josef Kříž <[email protected]>

Author: albthali

README.md

@@ -82,21 +82,22 @@ GITLAB_AUTH_TOKEN="<token>" yarn run start
 
 #### Configuration options
 
-| Env variable | Default value |  |
-|-------------------|--------------------|-------------------|
-| `GITLAB_URL` | `https://gitlab.com` | GitLab instance URL  |
-| `GITLAB_AUTH_TOKEN` |  | `required` Your GitLab token |
-| `CI_CHECK_INTERVAL` | `10` | Time between CI checks (in seconds) |
-| `MR_CHECK_INTERVAL` | `20` | Time between merge-requests checks (in seconds) |
-| `REMOVE_BRANCH_AFTER_MERGE` | `true` | It'll remove branch after merge |
-| `SQUASH_MERGE_REQUEST` | `true` | It'll squash commits on merge |
-| `AUTORUN_MANUAL_BLOCKING_JOBS` | `true` | It'll autorun manual blocking jobs before merge |
-| `SKIP_SQUASHING_LABEL` | `bot:skip-squash` | It'll skip squash when MR contains this label |
-| `HI_PRIORITY_LABEL` | `bot:high-priority` | It'll put MR with this label to the beginning of the queue |
-| `SENTRY_DSN` | `` | It'll enable Sentry monitoring |
-| `HTTP_SERVER_ENABLE` | `false` | It'll enable experimental API and dashboard support |
-| `HTTP_SERVER_PORT` | `4000` | It'll use different http server port |
-| `WEB_HOOK_TOKEN` | `` | It'll enable experimental web hook support |
+| Env variable                   | Default value        |                                                            |
+|--------------------------------|----------------------|------------------------------------------------------------|
+| `GITLAB_URL`                   | `https://gitlab.com` | GitLab instance URL                                        |
+| `GITLAB_AUTH_TOKEN`            |                      | `required` Your GitLab token                               |
+| `HTTP_PROXY`                   | ``                   | Use HTTP proxy for API communication                       |
+| `CI_CHECK_INTERVAL`            | `10`                 | Time between CI checks (in seconds)                        |
+| `MR_CHECK_INTERVAL`            | `20`                 | Time between merge-requests checks (in seconds)            |
+| `REMOVE_BRANCH_AFTER_MERGE`    | `true`               | It'll remove branch after merge                            |
+| `SQUASH_MERGE_REQUEST`         | `true`               | It'll squash commits on merge                              |
+| `AUTORUN_MANUAL_BLOCKING_JOBS` | `true`               | It'll autorun manual blocking jobs before merge            |
+| `SKIP_SQUASHING_LABEL`         | `bot:skip-squash`    | It'll skip squash when MR contains this label              |
+| `HI_PRIORITY_LABEL`            | `bot:high-priority`  | It'll put MR with this label to the beginning of the queue |
+| `SENTRY_DSN`                   | ``                   | It'll enable Sentry monitoring                             |
+| `HTTP_SERVER_ENABLE`           | `false`              | It'll enable experimental API and dashboard support        |
+| `HTTP_SERVER_PORT`             | `4000`               | It'll use different http server port                       |
+| `WEB_HOOK_TOKEN`               | ``                   | It'll enable experimental web hook support                 |
 
 ## Development
 

charts/gitlab-merger-bot/templates/deployment.yaml

@@ -64,6 +64,13 @@ spec:
           value: "{{ .Values.settings.httpServerPort }}"
         - name: WEB_HOOK_TOKEN
           value: "{{ .Values.settings.webHookToken }}"
+        {{- if .Values.settings.httpProxy }}
+        - name: HTTP_PROXY
+          valueFrom:
+            secretKeyRef:
+              key: httpProxy
+              name: {{ .Values.settings.httpProxySecretName }}
+        {{- end }}
 {{- range $key, $value := .Values.env }}
         - name: "{{ $key }}"
           value: "{{ $value }}"

charts/gitlab-merger-bot/templates/http-proxy.yaml

@@ -0,0 +1,10 @@
+{{- if .Values.settings.httpProxy}}
+Kind: Secret
+metadata:
+  name: {{ .Values.settings.httpProxySecretName  }}
+  namespace: {{ include "gitlab-merger-bot.namespace" . }}
+type: Opaque
+data:
+  httpProxy: {{ .Values.settings.httpProxy | b64enc  }}
+
+{{- end }}

charts/gitlab-merger-bot/values.yaml

@@ -68,3 +68,5 @@ settings:
   httpServerEnable: false
   httpServerPort: 4000
   webHookToken: ""
+  httpProxySecretName: http-proxy
+  httpProxy: ""

server/package.json

@@ -23,7 +23,8 @@
 		"express": "^4.17.1",
 		"fast-deep-equal": "^3.1.3",
 		"graphql": "^14.7.0",
-		"node-fetch": "^2.6.1",
+		"https-proxy-agent": "^5.0.1",
+		"node-fetch": "^2.6.7",
 		"serve-static": "^1.14.1",
 		"uuid": "^8.3.0"
 	},
@@ -37,7 +38,7 @@
 		"@types/express": "^4.17.7",
 		"@types/jest": "^26.0.10",
 		"@types/node": "^14.6.0",
-		"@types/node-fetch": "^2.5.7",
+		"@types/node-fetch": "^2.6.1",
 		"@types/uuid": "^8.3.0",
 		"@types/webpack": "^4.41.21",
 		"@types/webpack-node-externals": "^2.5.0",

server/src/Config.ts

@@ -14,6 +14,7 @@ export const defaultConfig = {
 	HTTP_SERVER_PORT: 4000,
 	WEB_HOOK_TOKEN: '',
 	DRY_RUN: false,
+	HTTP_PROXY: '',
 };
 
 export const getConfig = (): Config => ({
@@ -55,6 +56,7 @@ export const getConfig = (): Config => ({
 		.asPortNumber(),
 	WEB_HOOK_TOKEN: env.get('WEB_HOOK_TOKEN').default(defaultConfig.WEB_HOOK_TOKEN).asString(),
 	DRY_RUN: env.get('DRY_RUN').default(`${defaultConfig.DRY_RUN}`).asBoolStrict(),
+	HTTP_PROXY: env.get('HTTP_PROXY').default('').asString(),
 });
 
 export type Config = typeof defaultConfig;

server/src/GitlabApi.ts

@@ -1,6 +1,7 @@
 import fetch, { FetchError, RequestInit, Response } from 'node-fetch';
 import queryString, { ParsedUrlQueryInput } from 'querystring';
 import { sleep } from './Utils';
+import { HttpsProxyAgent } from 'https-proxy-agent';
 
 export interface User {
 	id: number;
@@ -135,10 +136,12 @@ export enum RequestMethod {
 export class GitlabApi {
 	private readonly gitlabUrl: string;
 	private readonly authToken: string;
+	private readonly httpProxy: HttpsProxyAgent | undefined;
 
-	constructor(gitlabUrl: string, authToken: string) {
+	constructor(gitlabUrl: string, authToken: string, httpProxy: string | undefined) {
 		this.gitlabUrl = gitlabUrl;
 		this.authToken = authToken;
+		this.httpProxy = httpProxy ? new HttpsProxyAgent(httpProxy) : undefined;
 	}
 
 	public async getMe(): Promise<User> {
@@ -331,6 +334,7 @@ export class GitlabApi {
 				'Private-Token': this.authToken,
 				'Content-Type': 'application/json',
 			},
+			agent: this.httpProxy,
 		};
 
 		if (body !== undefined) {

server/src/index.ts

@@ -13,7 +13,11 @@ if (SENTRY_DSN !== '') {
 }
 
 const config = getConfig();
-const gitlabApi = new GitlabApi(config.GITLAB_URL, config.GITLAB_AUTH_TOKEN);
+const gitlabApi = new GitlabApi(
+	config.GITLAB_URL,
+	config.GITLAB_AUTH_TOKEN,
+	config.HTTP_PROXY !== '' ? config.HTTP_PROXY : undefined,
+);
 const pubSub = new PubSub();
 const worker = new Worker(pubSub, config);
 

yarn.lock

@@ -2667,14 +2667,22 @@
     "@types/node" "*"
     form-data "^3.0.0"
 
-"@types/[email protected]", "@types/node-fetch@^2.5.7":
+"@types/[email protected]":
   version "2.5.7"
   resolved "https://registry.yarnpkg.com/@types/node-fetch/-/node-fetch-2.5.7.tgz#20a2afffa882ab04d44ca786449a276f9f6bbf3c"
   integrity sha512-o2WVNf5UhWRkxlf6eq+jMZDu7kjgpgJfl4xVNlvryc95O/6F2ld8ztKX+qu+Rjyet93WAWm5LjeX9H5FGkODvw==
   dependencies:
     "@types/node" "*"
     form-data "^3.0.0"
 
+"@types/node-fetch@^2.6.1":
+  version "2.6.1"
+  resolved "https://registry.yarnpkg.com/@types/node-fetch/-/node-fetch-2.6.1.tgz#8f127c50481db65886800ef496f20bbf15518975"
+  integrity sha512-oMqjURCaxoSIsHSr1E47QHzbmzNR5rK8McHuNb11BOM9cHcIK3Avy0s/b2JlXHoQGTYS3NsvWzV1M0iK7l0wbA==
+  dependencies:
+    "@types/node" "*"
+    form-data "^3.0.0"
+
 "@types/node@*":
   version "13.11.1"
   resolved "https://registry.yarnpkg.com/@types/node/-/node-13.11.1.tgz#49a2a83df9d26daacead30d0ccc8762b128d53c7"
@@ -3077,9 +3085,9 @@ [email protected]:
     regex-parser "2.2.10"
 
 agent-base@6:
-  version "6.0.1"
-  resolved "https://registry.yarnpkg.com/agent-base/-/agent-base-6.0.1.tgz#808007e4e5867decb0ab6ab2f928fbdb5a596db4"
-  integrity sha512-01q25QQDwLSsyfhrKbn8yuur+JNw0H+0Y4JiGIKd3z9aYk/w/2kxD/Upc+t2ZBBSUNff50VjPsSW2YxM8QYKVg==
+  version "6.0.2"
+  resolved "https://registry.yarnpkg.com/agent-base/-/agent-base-6.0.2.tgz#49fff58577cfee3f37176feab4c22e00f86d7f77"
+  integrity sha512-RZNwNclF7+MS/8bDg70amg32dyeZGZxiDuQmZxKLAlQjr3jGyLx+4Kkk58UO7D2QdgFIQCovuSuZESne6RG6XQ==
   dependencies:
     debug "4"
 
@@ -6525,6 +6533,14 @@ [email protected], https-proxy-agent@^5.0.0:
     agent-base "6"
     debug "4"
 
+https-proxy-agent@^5.0.1:
+  version "5.0.1"
+  resolved "https://registry.yarnpkg.com/https-proxy-agent/-/https-proxy-agent-5.0.1.tgz#c59ef224a04fe8b754f3db0063a25ea30d0005d6"
+  integrity sha512-dFcAjpTQFgoLMzC2VwU+C/CbS7uRL0lWmxDITmqm7C+7F0Odmj6s9l6alZc6AELXhrnggM2CeWSXHGOdX2YtwA==
+  dependencies:
+    agent-base "6"
+    debug "4"
+
 human-signals@^1.1.1:
   version "1.1.1"
   resolved "https://registry.yarnpkg.com/human-signals/-/human-signals-1.1.1.tgz#c5b1cd14f50aeae09ab6c59fe63ba3395fe4dfa3"
@@ -8606,11 +8622,18 @@ node-fetch@^1.0.1, node-fetch@^1.7.3:
     encoding "^0.1.11"
     is-stream "^1.0.1"
 
-node-fetch@^2.1.2, node-fetch@^2.2.0, node-fetch@^2.6.1:
+node-fetch@^2.1.2, node-fetch@^2.2.0:
   version "2.6.1"
   resolved "https://registry.yarnpkg.com/node-fetch/-/node-fetch-2.6.1.tgz#045bd323631f76ed2e2b55573394416b639a0052"
   integrity sha512-V4aYg89jEoVRxRb2fJdAg8FHvI7cEyYdVAh94HH0UIK8oJxUfkjlDQN9RbMx+bEjP7+ggMiFRprSti032Oipxw==
 
+node-fetch@^2.6.7:
+  version "2.6.7"
+  resolved "https://registry.yarnpkg.com/node-fetch/-/node-fetch-2.6.7.tgz#24de9fba827e3b4ae44dc8b20256a379160052ad"
+  integrity sha512-ZjMPFEfVx5j+y2yF35Kzx5sF7kDzxuDj6ziH4FFbOp87zKDZNx8yExJIb05OGF4Nlt9IHFIMBkRl41VdvcNdbQ==
+  dependencies:
+    whatwg-url "^5.0.0"
+
 node-html-parser@^1.2.19:
   version "1.2.20"
   resolved "https://registry.yarnpkg.com/node-html-parser/-/node-html-parser-1.2.20.tgz#37e9ebc627dbe3ff446eea4ac93e3d254b7c6ee4"
@@ -11185,6 +11208,11 @@ tr46@^2.0.2:
   dependencies:
     punycode "^2.1.1"
 
+tr46@~0.0.3:
+  version "0.0.3"
+  resolved "https://registry.yarnpkg.com/tr46/-/tr46-0.0.3.tgz#8184fd347dac9cdc185992f3a6622e14b9d9ab6a"
+  integrity sha1-gYT9NH2snNwYWZLzpmIuFLnZq2o=
+
 [email protected]:
   version "0.6.6"
   resolved "https://registry.yarnpkg.com/traverse/-/traverse-0.6.6.tgz#cbdf560fd7b9af632502fed40f918c157ea97137"
@@ -11702,6 +11730,11 @@ [email protected]:
   resolved "https://registry.yarnpkg.com/web-vitals/-/web-vitals-0.2.1.tgz#60782fa690243fe35613759a0c26431f57ba7b2d"
   integrity sha512-2pdRlp6gJpOCg0oMMqwFF0axjk5D9WInc09RSYtqFgPXQ15+YKNQ7YnBBEqAL5jvmfH9WvoXDMb8DHwux7pIew==
 
+webidl-conversions@^3.0.0:
+  version "3.0.1"
+  resolved "https://registry.yarnpkg.com/webidl-conversions/-/webidl-conversions-3.0.1.tgz#24534275e2a7bc6be7bc86611cc16ae0a5654871"
+  integrity sha1-JFNCdeKnvGvnvIZhHMFq4KVlSHE=
+
 webidl-conversions@^4.0.2:
   version "4.0.2"
   resolved "https://registry.yarnpkg.com/webidl-conversions/-/webidl-conversions-4.0.2.tgz#a855980b1f0b6b359ba1d5d9fb39ae941faa63ad"
@@ -11818,6 +11851,14 @@ whatwg-mimetype@^2.3.0:
   resolved "https://registry.yarnpkg.com/whatwg-mimetype/-/whatwg-mimetype-2.3.0.tgz#3d4b1e0312d2079879f826aff18dbeeca5960fbf"
   integrity sha512-M4yMwr6mAnQz76TbJm914+gPpB/nCwvZbJU28cUD6dR004SAxDLOOSUaB1JDRqLtaOV/vi0IC5lEAGFgrjGv/g==
 
+whatwg-url@^5.0.0:
+  version "5.0.0"
+  resolved "https://registry.yarnpkg.com/whatwg-url/-/whatwg-url-5.0.0.tgz#966454e8765462e37644d3626f6742ce8b70965d"
+  integrity sha1-lmRU6HZUYuN2RNNib2dCzotwll0=
+  dependencies:
+    tr46 "~0.0.3"
+    webidl-conversions "^3.0.0"
+
 whatwg-url@^7.0.0:
   version "7.1.0"
   resolved "https://registry.yarnpkg.com/whatwg-url/-/whatwg-url-7.1.0.tgz#c2c492f1eca612988efd3d2266be1b9fc6170d06"