Ignore https errors using environment variable (#59)

Makes it possible to configure puppeteer with ignoreHttpsErrors when 
launching chrome.

Fixes #33

Author: marefr

README.md

@@ -34,6 +34,19 @@ for rendering and using remote rendering, see [Remote Rendering Using Docker](#r
 
 If you still want to install the plugin in the Grafana docker image we provide instructions for how to build a custom Grafana image, see [Grafana Docker documentation](https://grafana.com/docs/installation/docker/#custom-image-with-grafana-image-renderer-plugin-pre-installed) for further instructions.
 
+### Environment variables
+
+You can override certain settings by using environment variables and making sure that those are available for the Grafana process.
+
+**Ignore HTTPS errors:**
+
+Instruct headless Chrome Whether to ignore HTTPS errors during navigation. Per default HTTPS errors is not ignored.
+Due to the security risk it's not recommended to ignore HTTPS errors.
+
+```bash
+export GF_RENDERER_PLUGIN_IGNORE_HTTPS_ERRORS=true
+```
+
 ## Remote Rendering Using Docker
 
 Instead of installing and running the image renderer as a plugin, you can run it as a remote image rendering service using Docker. Read more about [remote rendering using Docker](https://github.com/grafana/grafana-image-renderer/blob/master/docs/remote_rendering_using_docker.md).

docs/remote_rendering_using_docker.md

@@ -4,6 +4,19 @@ As an alternative to installing and running the image renderer as a plugin you c
 
 The docker image are published at [Docker Hub](https://hub.docker.com/r/grafana/grafana-image-renderer).
 
+## Environment variables
+
+You can override certain settings by using environment variables and making sure that those are available for the Grafana process.
+
+**Ignore HTTPS errors:**
+
+Instruct headless Chrome Whether to ignore HTTPS errors during navigation. Per default HTTPS errors is not ignored.
+Due to the security risk it's not recommended to ignore HTTPS errors.
+
+```bash
+export IGNORE_HTTPS_ERRORS=true
+```
+
 ## Docker Compose example
 
 The following docker-compose example can also be found in [docker/](https://github.com/grafana/grafana-image-renderer/tree/master/docker).

src/browser.ts

@@ -6,8 +6,13 @@ import uniqueFilename = require('unique-filename');
 
 export function newPluginBrowser(log: Logger): Browser {
   const env = Object.assign({}, process.env);
-  let chromeBin: any;
+  let ignoreHttpsErrors = false;
+
+  if (env['GF_RENDERER_PLUGIN_IGNORE_HTTPS_ERRORS']) {
+    ignoreHttpsErrors = env['GF_RENDERER_PLUGIN_IGNORE_HTTPS_ERRORS'] === 'true';
+  }
 
+  let chromeBin: any;
   if (env['GF_RENDERER_PLUGIN_CHROME_BIN']) {
     chromeBin = env['GF_RENDERER_PLUGIN_CHROME_BIN'];
   } else if ((process as any).pkg) {
@@ -19,24 +24,31 @@ export function newPluginBrowser(log: Logger): Browser {
     chromeBin = [path.dirname(process.execPath), ...parts].join(path.sep);
   }
 
-  return new Browser(log, chromeBin);
+  return new Browser(log, ignoreHttpsErrors, chromeBin);
 }
 
 export function newServerBrowser(log: Logger): Browser {
   const env = Object.assign({}, process.env);
-  let chromeBin: any;
+  let ignoreHttpsErrors = false;
+
+  if (env['IGNORE_HTTPS_ERRORS']) {
+    ignoreHttpsErrors = env['IGNORE_HTTPS_ERRORS'] === 'true';
+  }
 
+  let chromeBin: any;
   if (env['CHROME_BIN']) {
     chromeBin = env['CHROME_BIN'];
   }
 
-  return new Browser(log, chromeBin);
+  return new Browser(log, ignoreHttpsErrors, chromeBin);
 }
 
 export class Browser {
   chromeBin?: string;
+  ignoreHttpsErrors: boolean;
 
-  constructor(private log: Logger, chromeBin?: string) {
+  constructor(private log: Logger, ignoreHttpsErrors: boolean, chromeBin?: string) {
+    this.ignoreHttpsErrors = ignoreHttpsErrors;
     this.chromeBin = chromeBin;
   }
 
@@ -67,6 +79,7 @@ export class Browser {
 
       let launcherOptions: any = {
         env: env,
+        ignoreHttpsErrors: this.ignoreHttpsErrors,
         args: ['--no-sandbox'],
       };
 

src/grpc-plugin.ts

@@ -28,9 +28,15 @@ export class GrpcPlugin {
     console.log(`1|1|tcp|${SERVER_ADDRESS}|grpc`);
 
     if (this.browser.chromeBin) {
-      this.log.info('Renderer plugin started', 'chromeBin', this.browser.chromeBin);
+      this.log.info(
+        'Renderer plugin started',
+        'chromeBin',
+        this.browser.chromeBin,
+        'ignoreHttpsErrors',
+        this.browser.ignoreHttpsErrors
+      );
     } else {
-      this.log.info('Renderer plugin started');
+      this.log.info('Renderer plugin started', 'ignoreHttpsErrors', this.browser.ignoreHttpsErrors);
     }
   }
 

src/http-server.ts

@@ -27,6 +27,10 @@ export class HttpServer {
       this.log.info(`Using chromeBin ${this.browser.chromeBin}`);
     }
 
+    if (this.browser.ignoreHttpsErrors) {
+      this.log.info(`Ignoring HTTPS errors`);
+    }
+
     this.app.listen(this.options.port);
     this.log.info(`HTTP Server started, listening on ${this.options.port}`);
   }

src/logger.ts

@@ -34,11 +34,11 @@ export class PluginLogger {
     }
 
     if (optionalParams) {
-      for (let n = 0; n < optionalParams.length; n = n + 2) {
+      for (let n = 0; n < optionalParams.length; n += 2) {
         const key = optionalParams[n];
         const value = optionalParams[n + 1];
 
-        if (key && value) {
+        if (key !== null && value !== null) {
           logEntry[key] = value;
         }
       }