feat(maleo-core/server): options to disable or enable gzip (#232)

airyrooms · Oct 3, 2019 · 468a427 · 468a427
1 parent 6067c57
commit 468a427
Show file tree

Hide file tree

Showing 6 changed files with 15 additions and 2 deletions.
diff --git a/packages/Maleo.js/README.md b/packages/Maleo.js/README.md
@@ -500,6 +500,11 @@ Here are the API's for the configuration:
     }</code>
     </td>
   </tr>
+  <tr>
+    <td><code>gzip</code></td>
+    <td><code>boolean?</code> [<code>true</code>]</td>
+    <td>Enable GZIP Compression</td>
+  </tr>
 </table>
 
 #### Customize Server

diff --git a/packages/Maleo.js/globals.d.ts b/packages/Maleo.js/globals.d.ts
@@ -6,3 +6,4 @@ declare const __IS_SERVER__: boolean;
 declare const __ESM__: boolean;
 declare const __FAVICON__: string;
 declare const __CSP__: boolean | IHelmetContentSecurityPolicyConfiguration;
+declare const __ENABLE_GZIP__: boolean;
diff --git a/packages/Maleo.js/src/build/webpack/webpack.ts b/packages/Maleo.js/src/build/webpack/webpack.ts
@@ -61,6 +61,7 @@ const defaultUserConfig: CustomConfig = {
   buildDir: BUILD_DIR,
   assetDir: path.resolve('.', BUILD_DIR, CLIENT_BUILD_DIR),
   distDir: path.resolve('.', 'dist'),
+  gzip: true,
 };
 
 export const createWebpackConfig = (context: Context, customConfig: CustomConfig) => {
@@ -77,6 +78,7 @@ export const createWebpackConfig = (context: Context, customConfig: CustomConfig
     whitelist: customWhitelist = [],
     favicon: _favicon,
     csp = false,
+    gzip,
   } = customConfig;
 
   const buildDirectory = buildDir || BUILD_DIR;
@@ -422,6 +424,7 @@ export const getDefaultPlugins = (
     csp,
     esModules,
   } = context;
+  const { gzip } = customConfig;
 
   const commonPlugins: Configuration['plugins'] =
     ([
@@ -497,6 +500,7 @@ export const getDefaultPlugins = (
         new DefinePlugin({
           __FAVICON__: JSON.stringify(favicon),
           __CSP__: JSON.stringify(csp),
+          __ENABLE_GZIP__: gzip,
         }),
 
         isDev &&

diff --git a/packages/Maleo.js/src/interfaces/build.ts b/packages/Maleo.js/src/interfaces/build.ts
@@ -50,6 +50,7 @@ export interface CustomConfig {
   csp?: boolean | IHelmetContentSecurityPolicyConfiguration;
 
   esModules?: boolean;
+  gzip?: boolean;
 }
 
 export interface StaticPages {

diff --git a/packages/Maleo.js/src/interfaces/server.ts b/packages/Maleo.js/src/interfaces/server.ts
@@ -5,6 +5,7 @@ export interface IOptions {
   assetDir?: string;
   runHandler?: () => any;
   csp?: IHelmetContentSecurityPolicyConfiguration;
+  gzip?: boolean;
 }
 
 // Stats

diff --git a/packages/Maleo.js/src/server/server.ts b/packages/Maleo.js/src/server/server.ts
@@ -44,6 +44,7 @@ export class Server {
       port: options.port || 3000,
       runHandler: options.runHandler || this.defaultHandler,
       csp: options.csp || typeof __CSP__ === 'boolean' ? defaultCSP : __CSP__,
+      gzip: options.gzip || __ENABLE_GZIP__,
     } as IOptions;
 
     this.options = defaultOptions;
@@ -74,7 +75,7 @@ export class Server {
 
   private setupExpress = async () => {
     // Set Compression
-    process.env.NODE_ENV !== 'development' && this.setupCompression(this.app);
+    this.setupCompression(this.app);
 
     // Set secure server
     this.setupSecureServer(this.app);
@@ -134,7 +135,7 @@ export class Server {
       level: zlib.Z_DEFAULT_COMPRESSION,
     };
 
-    app.use(compression(option));
+    this.options.gzip && app.use(compression(option));
   };
 
   protected defaultHandler = () => {