disable loading page feature

README.md

@@ -47,6 +47,7 @@ The following top-level properties can be configured:
 Property | Meaning
 ---------|--------|
 `proxyListeningPort` | The port ContainerNursery should listen on for new http connections. Defaults to `80`.
+`disableDefaultLoadingPage` | Boolean for disable the default loading page. By disabling the default loading page the request waits for the container and responds when the container is ready. Defaults to `false`.
 
 The virtual hosts the proxy should handle can be configured by adding an object to the `proxyHosts` key.
 
@@ -68,6 +69,8 @@ The following properties are optional:
 | `proxyUseHttps`                | Boolean indicating if the proxy should use HTTPS to connect to the container. Defaults to `false`. This should only be used if the container only accepts HTTPS requests. It provides no additional security.                                                                                                                                                                                            |
 | `stopOnTimeoutIfCpuUsageBelow` | If set, prevents the container from stopping when reaching the configured timeout if the averaged CPU usage (percentage between 0 and 100*core count) of the **main** container (first in the list of container names) is above this value. This is great for containers that should remain running while their doing intensive work even when nobody is doing any http requests, for example handbrake. |
 | `proxyUseCustomMethod` | Can be set to a HTTP method (`HEAD`,`GET`, ...) which should be used for the ready check. Some services only respond to certain HTTP methods correctly. |
+| `enableDefaultLoadingPage` | Boolean for enable the default loading page when `disableDefaultLoadingPage` is set to `true`. |
+| `customHttpStatusReadyChecking` | Custom Http status number use to check if the container is ready and running. |
 
 ### Example Configuration
 ```yaml

config/config.yml.example

@@ -1,4 +1,5 @@
 proxyListeningPort: 80
+disableDefaultLoadingPage: true
 proxyHosts:
   - domain: handbrake.yourdomain.io
     containerName: handbrake
@@ -7,6 +8,7 @@ proxyHosts:
     proxyPort: 5800
     timeoutSeconds: 15
     stopOnTimeoutIfCpuUsageBelow: 50
+    enableDefaultLoadingPage: true
   - domain:
       - wordpress.yourdomain.io
       - wordpress.otherdomain.io

src/ConfigManager.ts

@@ -18,21 +18,27 @@ type ProxyHostConfig = {
   proxyUseCustomMethod: string
   timeoutSeconds: number
   stopOnTimeoutIfCpuUsageBelow?: number
+  disableDefaultLoadingPage?: boolean
+  enableDefaultLoadingPage?: boolean
+  customHttpStatusReadyChecking?: number
 }
 type ApplicationConfig = {
   proxyListeningPort: number,
+  disableDefaultLoadingPage: boolean,
   proxyHosts: ProxyHostConfig[]
 }
 
 export default class ConfigManager {
   private configFile = 'config/config.yml';
   private proxyHosts: Map<string, ProxyHost>;
   private proxyListeningPort: number | null;
+  public disableDefaultLoadingPage: boolean | undefined;
   private eventEmitter: EventEmitter;
 
   constructor(proxyHosts: Map<string, ProxyHost>) {
     this.proxyHosts = proxyHosts;
     this.proxyListeningPort = null;
+    this.disableDefaultLoadingPage = false;
     this.eventEmitter = new EventEmitter();
     this.createIfNotExist();
     this.parseConfig();
@@ -96,6 +102,9 @@ export default class ConfigManager {
     if (!config || !config.proxyHosts) {
       logger.error({ invalidProperty: 'proxyHosts' }, 'Config is invalid, missing property');
     } else {
+      if (config.disableDefaultLoadingPage) {
+        this.disableDefaultLoadingPage = config.disableDefaultLoadingPage;
+      }
       this.loadProxyHosts(config.proxyHosts);
       if (config.proxyListeningPort) {
         const prevPort = this.proxyListeningPort;
@@ -141,6 +150,18 @@ export default class ConfigManager {
           proxyHost.stopOnTimeoutIfCpuUsageBelow = proxyHostConfig.stopOnTimeoutIfCpuUsageBelow as number;
         }
 
+        if (this.disableDefaultLoadingPage && !proxyHostConfig.enableDefaultLoadingPage) {
+          proxyHost.disableDefaultLoadingPage = this.disableDefaultLoadingPage;
+        }
+
+        if (proxyHostConfig.disableDefaultLoadingPage) {
+          proxyHost.disableDefaultLoadingPage = proxyHostConfig.disableDefaultLoadingPage;
+        }
+
+        if (proxyHostConfig.customHttpStatusReadyChecking) {
+          proxyHost.customHttpStatusReadyChecking = proxyHostConfig.customHttpStatusReadyChecking;
+        }
+
         if (proxyHostConfig.domain instanceof Array) {
           proxyHostConfig.domain.forEach(domain => {
             this.proxyHosts.set(

src/ProxyHost.ts

@@ -13,9 +13,12 @@ export default class ProxyHost {
   private proxyHost: string;
   private proxyPort: number;
   public proxyUseHttps = false;
+  public customHttpStatusReadyChecking: number | undefined
   public proxyUseCustomMethod: string | undefined;
   private timeoutSeconds: number;
   public stopOnTimeoutIfCpuUsageBelow = Infinity;
+  public disableDefaultLoadingPage = false
+  public enableDefaultLoadingPage = false
 
   private activeSockets: Set<internal.Duplex> = new Set();
   private containerEventEmitter: EventEmitter | null = null;
@@ -137,6 +140,18 @@ export default class ProxyHost {
     this.startingHost = false;
   }
 
+  public async isContainerRunning():Promise<boolean> {
+    let interval:NodeJS.Timer;
+    return new Promise((resolve) => {
+      interval = setInterval(async () => {
+        if (this.containerRunning) {
+          resolve(true);
+          clearInterval(interval);
+        }
+      }, 250);
+    });
+  }
+
   private checkContainerReady() {
     if (this.containerReadyChecking) return;
 
@@ -155,7 +170,10 @@ export default class ProxyHost {
           headers: res.headers
         }, 'Checked if target is ready');
 
-        if (res.status === 200 || (res.status >= 300 && res.status <= 399)) {
+        if (
+          res.status === 200 || (res.status >= 300 && res.status <= 399)
+          || (this.customHttpStatusReadyChecking && res.status === this.customHttpStatusReadyChecking)
+        ) {
           clearInterval(checkInterval);
           this.containerReadyChecking = false;
           this.containerRunning = true;

src/index.ts

@@ -120,8 +120,18 @@ placeholderServer.use((_, res, next) => {
   res.setHeader('x-powered-by', 'ContainerNursery');
   next();
 });
-placeholderServer.get('*', (req, res) => {
-  res.render('placeholder', { containerName: req.headers['x-container-nursery-container-name'] });
+placeholderServer.all('*', async (req, res) => {
+  const proxyHost = proxyHosts.get(req.headers.host as string);
+  if (proxyHost?.disableDefaultLoadingPage) {
+    await proxyHost?.isContainerRunning();
+    proxyHost?.newConnection();
+    proxy.web(req, res, {
+      target: proxyHost?.getTarget(),
+      headers: proxyHost?.getHeaders()
+    });
+  } else {
+    res.render('placeholder', { containerName: req.headers['x-container-nursery-container-name'] });
+  }
 });
 placeholderServer.listen(placeholderServerListeningPort, placeholderServerListeningHost);
 logger.info({ port: placeholderServerListeningPort, host: placeholderServerListeningHost }, 'Proxy placeholder server listening');