feat: allow maximum http request size to be configurable (#268)

This change allows the maximum HTTP request size to be configurable.
GoogleContainerTools · May 25, 2023 · 088c268 · 088c268
1 parent df9ce8f
commit 088c268
Show file tree

Hide file tree

Showing 4 changed files with 22 additions and 3 deletions.
diff --git a/plugins/cad-backend/README.md b/plugins/cad-backend/README.md
@@ -59,6 +59,9 @@ configAsData:
   # Determines the GitOps delivery tool to use.
   gitOpsDeliveryTool: config-sync
 
+  # Optional. Determines the maximum http request body size.
+  maxRequestSize: 1mb
+
   clusterLocatorMethod:
     # Determines how the client will locate the Kubernetes cluster.
     type: current-context
@@ -77,6 +80,9 @@ configAsData:
 
 `gitOpsDeliveryTool` determines what tool to use for GitOps
 
+`maxRequestSize` determines the maximum http request body size. Default is 1mb.
+HTTP Status Code 413 will be returned for any requests exceeding this size.
+
 Valid values:
 | Values | Description |
 | ------ | ----------- |

diff --git a/plugins/cad-backend/src/service/config.ts b/plugins/cad-backend/src/service/config.ts
@@ -39,6 +39,12 @@ export enum OIDCTokenProvider {
   OKTA = 'okta',
 }
 
+export const getMaxRequestSize = (config: Config): string => {
+  const maxRequestSize = config.getOptionalString('maxRequestSize') ?? '1mb';
+
+  return maxRequestSize;
+};
+
 export const getResourcesNamespace = (config: Config): string => {
   const namespace = config.getString('resourcesNamespace');
 

diff --git a/plugins/cad-backend/src/service/router.ts b/plugins/cad-backend/src/service/router.ts
@@ -27,6 +27,7 @@ import {
   getClusterLocatorMethodServiceAccountToken,
   getClusterLocatorMethodType,
   getGitOpsDeliveryTool,
+  getMaxRequestSize,
   getResourcesNamespace,
   OIDCTokenProvider,
 } from './config';
@@ -74,13 +75,11 @@ export async function createRouter({
   config,
   logger,
 }: RouterOptions): Promise<express.Router> {
-  const router = Router();
-  router.use(express.json());
-
   const cadConfig = config.getConfig('configAsData');
 
   const namespace = getResourcesNamespace(cadConfig);
   const gitOpsTool = getGitOpsDeliveryTool(cadConfig);
+  const maxRequestSize = getMaxRequestSize(cadConfig);
 
   const clusterLocatorMethodType = getClusterLocatorMethodType(cadConfig);
   const clusterLocatorMethodAuthProvider =
@@ -184,6 +183,9 @@ export async function createRouter({
     });
   };
 
+  const router = Router();
+  router.use(express.json({ limit: maxRequestSize }));
+
   router.get('/health', healthCheck);
   router.get('/v1/features', getFeatures);
   router.get('/v1/function-catalog', getFunctionCatalog);

diff --git a/plugins/cad/config.d.ts b/plugins/cad/config.d.ts
@@ -29,6 +29,11 @@ export interface Config {
      */
     gitOpsDeliveryTool: 'none' | 'config-sync';
 
+    /**
+     * Optional. Determines the maximum http request body size.
+     */
+    maxRequestSize?: string;
+
     /**
      * Determines where to receive the cluster configuration from.
      */