Add aggregation policy action proxyOptions property

Allows setting global proxyTimeout.

Author: remvee

README.org

@@ -452,6 +452,20 @@ brew:
    If keepResponseHeaders is not specified all headers will be
    returned.
 
+*** ~proxyOptions~
+
+Allow setting global ~proxyOptions~ (can be overwritten per backend).
+
+#+begin_src yaml
+  - aggregation:
+      - action:
+          proxyOptions:
+            proxyTimeout: 10000
+#+end_src
+
+The above will set a global timeout for requests going to backends of
+10 seconds.
+
 * Building deployable images
 
   The repository includes a [[./Dockerfile][Dockerfile]] that can be used to build a

policies/aggregation/aggregation.js

@@ -198,9 +198,11 @@ module.exports = (config, { gatewayConfig: { serviceEndpoints } }) => {
           proxy.on('error', () => res.sendStatus(httpcode.BadGateway))
         }
 
+        const proxyOptions = config.proxyOptions || {}
         const opts = await proxyOptionsForEndpoint({ db, endpoint })
         opts.headers.traceParent = outgoingTraceParent.toString()
         proxy.web(req, res, {
+          ...proxyOptions,
           ...opts,
           target: endpoint.url,
           changeOrigin: true,

policies/aggregation/index.js

@@ -35,6 +35,10 @@ module.exports = {
       metricsPrefix: {
         type: 'string',
         description: 'Prefix for metrics for outgoing HTTP requests'
+      },
+      proxyOptions: {
+        type: 'object',
+        description: 'Global proxy options'
       }
 
     },

test/config/gateway.config.v4.yml

@@ -104,6 +104,8 @@ serviceEndpoints:
     #   proxyTimeout: 500
     proxyOptionsEncoded: >-
       1ad6802a2431e8d09a03f7d9e7dbaf28:VyJb/QWzTZ/2jIU41q0zQGuJdRoZrr0yJ6W/pUE9jq8=
+  'OtherSlow.Backend':
+    url: '${OOAPI_SLOW_BACKEND_URL:-http://localhost:8086/}'
 
 policies:
   - basic-auth
@@ -211,6 +213,8 @@ pipelines:
                       paths: ['/']
                     - endpoint: 'Slow.Backend'
                       paths: ['/']
+                    - endpoint: 'OtherSlow.Backend'
+                      paths: ['/']
 
       - request-transformer:
           - action:
@@ -252,6 +256,8 @@ pipelines:
                 - 'traceparent'
                 - 'content-type'
                 - 'content-length'
+              proxyOptions:
+                proxyTimeout: 2000
   not_found:
     apiEndpoints:
       - not_found

test/config/gateway.config.v5.yml

@@ -111,6 +111,8 @@ serviceEndpoints:
     url: '${OOAPI_SLOW_BACKEND_URL:-http://localhost:8086/}'
     proxyOptions:
       proxyTimeout: 500
+  'OtherSlow.Backend':
+    url: '${OOAPI_SLOW_BACKEND_URL:-http://localhost:8086/}'
 
 policies:
   - basic-auth
@@ -233,6 +235,8 @@ pipelines:
                       paths: ['/']
                     - endpoint: 'Slow.Backend'
                       paths: ['/']
+                    - endpoint: 'OtherSlow.Backend'
+                      paths: ['/']
 
       - request-transformer:
           - action:
@@ -274,6 +278,8 @@ pipelines:
                 - 'content-type'
                 - 'content-length'
                 - 'traceparent'
+              proxyOptions:
+                proxyTimeout: 2000
   not_found:
     apiEndpoints:
       - not_found

test/timeout.integration.test.js

@@ -28,7 +28,7 @@ const {
 integrationContext('endpoint timeouts', function () {
   describe('slow backend', () => {
     it('backend response status code is 0 when sleeping longer than configured 500ms', async () => {
-      const res = await httpGet(gatewayUrl('bubbles', `/?sleep=${1000 * 60 * 60 * 24}`), {
+      const res = await httpGet(gatewayUrl('bubbles', `/?sleep=${60 * 60 * 24}`), {
         headers: { 'X-Route': 'endpoint=Slow.Backend' }
       })
       const { gateway: { endpoints } } = JSON.parse(res.body)
@@ -49,4 +49,28 @@ integrationContext('endpoint timeouts', function () {
       )
     })
   })
+
+  describe('other slow backend', () => {
+    it('backend response status code is 0 when sleeping longer than globally configured 2s', async () => {
+      const res = await httpGet(gatewayUrl('bubbles', `/?sleep=${60 * 60 * 24}`), {
+        headers: { 'X-Route': 'endpoint=OtherSlow.Backend' }
+      })
+      const { gateway: { endpoints } } = JSON.parse(res.body)
+      assert.equal(
+        endpoints['OtherSlow.Backend'].responseCode,
+        0
+      )
+    })
+
+    it('backend response status code is OK when fast enough', async () => {
+      const res = await httpGet(gatewayUrl('bubbles', '/?sleep=1'), {
+        headers: { 'X-Route': 'endpoint=OtherSlow.Backend' }
+      })
+      const { gateway: { endpoints } } = JSON.parse(res.body)
+      assert.equal(
+        endpoints['OtherSlow.Backend'].responseCode,
+        httpcode.OK
+      )
+    })
+  })
 })