Merge pull request #3539 from magda-io/allow-disable-gzip

#3538 Add helm chart configuration option allows users to disable gateway auto-gzip response feature
magda-io · Jun 19, 2024 · 74e066b · 74e066b
2 parents 9876e04 + 3a66f58
commit 74e066b
Show file tree

Hide file tree

Showing 8 changed files with 26 additions and 5 deletions.
diff --git a/CHANGES.md b/CHANGES.md
@@ -1,5 +1,9 @@
 # CHANGELOG
 
+## v4.0.1
+
+- Add helm chart configuration option allows users to disable gateway auto-gzip response feature
+
 ## v4.0.0
 
 - Use OpenSearch (v2.14.0) as main search engine

diff --git a/deploy/helm/internal-charts/gateway/README.md b/deploy/helm/internal-charts/gateway/README.md
@@ -43,6 +43,7 @@ Kubernetes: `>= 1.14.0-0`
 | defaultWebRouteConfig.methods | list | `["GET"]` | array of string. "all" means all methods will be proxied  |
 | defaultWebRouteConfig.redirectTrailingSlash | bool | `false` | make /xxx auto redirect to /xxxx/ |
 | defaultWebRouteConfig.to | string | `""` | the default web router proxy target. Optional. If set, the default web route set via `web` option will be ignored. |
+| disableGzip | bool | `false` | By default, response will be auto-gizpped depends on MIME type. Set this to true to disable it. |
 | enableAuthEndpoint | bool | `true` | whether or not enable auth endpoint. You can turn it off if you don't need to log into any account. |
 | enableCkanRedirection | bool | `false` | wether or not enable CKAN redirection. when it's on, any incoming ckan alike URL will be redirected to the CKAN instance URL  that is specified by config option `ckanRedirectionDomain` and `ckanRedirectionPath`. |
 | enableHttpsRedirection | bool | `false` | whether or not redirect incoming request using HTTP protocol to HTTPs |

diff --git a/deploy/helm/internal-charts/gateway/templates/deployment.yaml b/deploy/helm/internal-charts/gateway/templates/deployment.yaml
@@ -59,6 +59,9 @@ spec:
 {{- if .Values.enableCkanRedirection }}
             "--enableCkanRedirection", {{ .Values.enableCkanRedirection | quote }},
 {{- end }}
+{{- if .Values.disableGzip }}
+            "--disableGzip", {{ .Values.disableGzip | quote }},
+{{- end }}
 {{- if not (kindIs "invalid" .Values.registryQueryCacheStdTTL) }}
             "--registryQueryCacheStdTTL", {{ .Values.registryQueryCacheStdTTL | quote }},
 {{- end }}

diff --git a/deploy/helm/internal-charts/gateway/values.yaml b/deploy/helm/internal-charts/gateway/values.yaml
@@ -53,6 +53,9 @@ ckanRedirectionPath:
 # -- whether or not redirect incoming request using HTTP protocol to HTTPs
 enableHttpsRedirection: false
 
+# -- By default, response will be auto-gizpped depends on MIME type. Set this to true to disable it.
+disableGzip: false
+
 # -- a list of authentication plugin config item. 
 # Each authentication plugin config item can contain the following fields:
 # <ul>

diff --git a/deploy/helm/local-auth-test-deployment/readme.md b/deploy/helm/local-auth-test-deployment/readme.md
@@ -1,14 +1,14 @@
 # magda-local-auth-test-deployment
 
-![Version: 3.0.4](https://img.shields.io/badge/Version-3.0.4-informational?style=flat-square)
+![Version: 4.0.0](https://img.shields.io/badge/Version-4.0.0-informational?style=flat-square)
 
 ## Requirements
 
 Kubernetes: `>= 1.14.0-0`
 
 | Repository | Name | Version |
 |------------|------|---------|
-| file://../magda-core | magda-core | 3.0.4 |
+| file://../magda-core | magda-core | 4.0.0 |
 
 ## Values
 

diff --git a/deploy/helm/local-deployment/readme.md b/deploy/helm/local-deployment/readme.md
@@ -1,14 +1,14 @@
 # magda-local-deployment
 
-![Version: 3.0.4](https://img.shields.io/badge/Version-3.0.4-informational?style=flat-square)
+![Version: 4.0.0](https://img.shields.io/badge/Version-4.0.0-informational?style=flat-square)
 
 ## Requirements
 
 Kubernetes: `>= 1.14.0-0`
 
 | Repository | Name | Version |
 |------------|------|---------|
-| oci://ghcr.io/magda-io/charts | magda | 4.0.0-alpha.5 |
+| file://../magda | magda | 4.0.0 |
 | oci://ghcr.io/magda-io/charts | magda-auth-arcgis | 2.0.1 |
 | oci://ghcr.io/magda-io/charts | magda-auth-facebook | 2.0.0 |
 | oci://ghcr.io/magda-io/charts | magda-auth-google | 2.0.1 |

diff --git a/magda-gateway/src/buildApp.ts b/magda-gateway/src/buildApp.ts
@@ -81,6 +81,7 @@ export type Config = {
     skipAuth?: boolean;
     registryQueryCacheMaxKeys: number;
     registryQueryCacheStdTTL: number;
+    disableGzip?: boolean;
 };
 
 export default function buildApp(app: express.Application, config: Config) {
@@ -148,7 +149,10 @@ export default function buildApp(app: express.Application, config: Config) {
     app.use(createHttpsRedirectionMiddleware(config.enableHttpsRedirection));
 
     // GZIP responses where appropriate
-    app.use(compression());
+    if (!config?.disableGzip) {
+        app.use(compression());
+        console.log("Automatic GZIP compression enabled.");
+    }
 
     // Set sensible secure headers
     app.disable("x-powered-by");

diff --git a/magda-gateway/src/index.ts b/magda-gateway/src/index.ts
@@ -175,6 +175,12 @@ const argv = addJwtSecretFromEnvVar(
             type: "boolean",
             default: false
         })
+        .option("disableGzip", {
+            describe:
+                "By default, response will be auto-gizpped depends on MIME type. Set this to true to disable it.",
+            type: "boolean",
+            default: false
+        })
         .option("userId", {
             describe:
                 "The user id to use when making authenticated requests to the registry",