screwdriver-api 8.0.67 → 8.0.69

package/config/custom-environment-variables.yaml

@@ -361,32 +361,32 @@ scms:
   #         # SCM clone type (https or ssh)
   #         cloneType: SCM_GITLAB_RO_CLONE_TYPE
 webhooks:
-  # Object keyed by scm name with value webhook settings.
-  # Value of webhook settings is an object with the following properties:
-  # Example:
-  # {
-  #  "github": {
-  #   # Obtains the SCM token for a given user. If a user does not have a valid SCM token registered with Screwdriver, it will use this user's token instead.
-  #   "username": "sd-buildbot",
-  #   # Ignore commits made by these users
-  #   "ignoreCommitsBy": [],
-  #   # Restrict PR: all, none, branch, or fork
-  #   "restrictPR": "none",
-  #   # Chain PR: true or false
-  #   "chainPR": false,
-  #   # Upper limit on incoming uploads to builds
-  #   "maxBytes": 1048576 #1MB
-  #   },
-  #  "github.example.com": {
-  #     "username": "someuser",
-  #     "ignoreCommitsBy": ["someuser", "anotheruser"],
-  #     "restrictPR": "branch",
-  #     "chainPR": true,
-  #     "maxBytes": 2097152 #2MB
-  #   }
-  # }
-  __name: WEBHOOK_SETTINGS
-  __format: json
+  scms:
+    # Object keyed by scm name with value webhook settings.
+    # Value of webhook settings is an object with the following properties:
+    # Example:
+    # {
+    #  "github": {
+    #   # Obtains the SCM token for a given user. If a user does not have a valid SCM token registered with Screwdriver, it will use this user's token instead.
+    #   "username": "sd-buildbot",
+    #   # Ignore commits made by these users
+    #   "ignoreCommitsBy": [],
+    #   # Restrict PR: all, none, branch, or fork
+    #   "restrictPR": "none",
+    #   # Chain PR: true or false
+    #   "chainPR": false
+    #   },
+    #  "github.example.com": {
+    #     "username": "someuser",
+    #     "ignoreCommitsBy": ["someuser", "anotheruser"],
+    #     "restrictPR": "branch",
+    #     "chainPR": true
+    #   }
+    # }
+    __name: WEBHOOK_SETTINGS
+    __format: json
+  maxBytes: WEBHOOK_MAX_BYTES
+
 
 bookends:
   # Object keyed by cluster name with value setup/teardown bookend.

package/config/default.yaml

@@ -277,42 +277,40 @@ scms: {}
 #         accessToken: headlesstoken
 #         # SCM clone type (https or ssh)
 #         cloneType: https
-webhooks: 
-  github: 
-    # Obtains the SCM token for a given user. If a user does not have a valid SCM token registered with Screwdriver, it will use this user's token instead.
-    username: sd-buildbot
-    # Ignore commits made by these users
-    ignoreCommitsBy: []
-    # Restrict PR: all, none, branch, or fork
-    restrictPR: none
-    # Chain PR: true or false
-    chainPR: false
-    # Upper limit on incoming uploads to builds
-    maxBytes: 1048576 #1MB
-  # Object keyed by scm name with value webhook settings.
-  # Value of webhook settings is an object with the following properties:
-  # Example:
-  # {
-  #  "github:github.com": {
-  #   # Obtains the SCM token for a given user. If a user does not have a valid SCM token registered with Screwdriver, it will use this user's token instead.
-  #   "username": "sd-buildbot",
-  #   # Ignore commits made by these users
-  #   "ignoreCommitsBy": [],
-  #   # Restrict PR: all, none, branch, or fork
-  #   "restrictPR": "none",
-  #   # Chain PR: true or false
-  #   "chainPR": false,
-  #   # Upper limit on incoming uploads to builds
-  #   "maxBytes": 1048576 #1MB
-  #   },
-  #  "github.example.com": {
-  #     "username": "someuser",
-  #     "ignoreCommitsBy": ["someuser", "anotheruser"],
-  #     "restrictPR": "branch",
-  #     "chainPR": true,
-  #     "maxBytes": 2097152 #2MB
-  #   }
-  # }
+webhooks:
+  scms:
+    github:
+      # Obtains the SCM token for a given user. If a user does not have a valid SCM token registered with Screwdriver, it will use this user's token instead.
+      username: sd-buildbot
+      # Ignore commits made by these users
+      ignoreCommitsBy: []
+      # Restrict PR: all, none, branch, or fork
+      restrictPR: none
+      # Chain PR: true or false
+      chainPR: false
+    # Object keyed by scm name with value webhook settings.
+    # Value of webhook settings is an object with the following properties:
+    # Example:
+    # {
+    #  "github:github.com": {
+    #   # Obtains the SCM token for a given user. If a user does not have a valid SCM token registered with Screwdriver, it will use this user's token instead.
+    #   "username": "sd-buildbot",
+    #   # Ignore commits made by these users
+    #   "ignoreCommitsBy": [],
+    #   # Restrict PR: all, none, branch, or fork
+    #   "restrictPR": "none",
+    #   # Chain PR: true or false
+    #   "chainPR": false
+    #   },
+    #  "github.example.com": {
+    #     "username": "someuser",
+    #     "ignoreCommitsBy": ["someuser", "anotheruser"],
+    #     "restrictPR": "branch",
+    #     "chainPR": true
+    #   }
+    # }
+  # Upper limit on incoming uploads to builds
+  maxBytes: 1048576 # 1MB
 coverage:
   default: "false"
   plugin: sonar

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "screwdriver-api",
-  "version": "8.0.67",
+  "version": "8.0.69",
   "description": "API server for the Screwdriver.cd service",
   "main": "index.js",
   "scripts": {

package/plugins/webhooks/index.js

@@ -6,8 +6,7 @@ const boom = require('@hapi/boom');
 const { ValidationError } = require('joi');
 const { startHookEvent } = require('./helper');
 
-const DEFAULT_MAX_BYTES = 1048576;
-const MAX_BYTES_UPPER_BOUND = 5242880; // 5MB
+const DEFAULT_MAX_BYTES = 1048576; // 1MB
 const providerSchema = joi
     .object({
         username: joi.string().required(),
@@ -41,7 +40,7 @@ const webhooksPlugin = {
     name: 'webhooks',
     async register(server, options) {
         const pluginOptions = joi.attempt(
-            options,
+            options.scms,
             joi.object().pattern(joi.string(), providerSchema).min(1).required(),
             'Invalid config for plugin-webhooks'
         );
@@ -59,7 +58,7 @@ const webhooksPlugin = {
                     }
                 },
                 payload: {
-                    maxBytes: MAX_BYTES_UPPER_BOUND,
+                    maxBytes: parseInt(pluginOptions.maxBytes, 10) || DEFAULT_MAX_BYTES,
                     parse: false,
                     output: 'stream'
                 },
@@ -71,17 +70,10 @@ const webhooksPlugin = {
                     let hookId;
 
                     try {
-                        let size = 0;
                         const chunks = [];
 
                         for await (const chunk of request.payload) {
-                            size += chunk.length;
                             chunks.push(chunk);
-                            if (size > DEFAULT_MAX_BYTES) {
-                                throw boom.entityTooLarge(
-                                    `Payload size exceeds the maximum limit of ${DEFAULT_MAX_BYTES} bytes`
-                                );
-                            }
                         }
 
                         const data = Buffer.concat(chunks).toString();