Merge pull request #9 from platformsh/add-chrome-formatter

Add chrome/puppeteer formatter

Author: Crell

README.md

@@ -136,7 +136,7 @@ config.registerFormatter("my_service", formatMyService);
 
 // Then call this method to get the formatted version
 
-formatted = config.FormattedCredentials("database", "my_service");
+formatted = config.formattedCredentials("database", "my_service");
 ```
 
 The first parameter is the name of a relationship defined in `.platform.app.yaml`.  The second is a formatter that was previously registered with `registerFormatter()`.  If either the service or formatter is missing an exception will be thrown.  The type of `formatted` will depend on the formatter function and can be safely passed directly to the client library.

src/platformsh.js

@@ -52,6 +52,7 @@ class Config {
 
         this.registerFormatter('solr-node', nodeSolrFormatter);
         this.registerFormatter('mongodb', mongodbFormatter);
+        this.registerFormatter('puppeteer', puppeteerFormatter);
 
         let variables = this._getValue('VARIABLES');
         if (variables) {
@@ -525,6 +526,17 @@ function mongodbFormatter(credentials) {
     return `mongodb://${credentials["username"]}:${credentials["password"]}@${credentials["host"]}:${credentials["port"]}/${credentials["path"]}`;
 }
 
+/**
+ * Returns a connection string appropriate for Puppeteer and headless Chrome.
+ * @param cretentials
+ *   A chrome-headless credentials object
+ * @returns {string}
+ *   A connection string to pass to puppeteer.connect().
+ */
+function puppeteerFormatter(credentials) {
+    return `http://${credentials["ip"]}:${credentials["port"]}`;
+}
+
 /**
  * Creates a new Config instance that represents the current environment.
  *

test/testdata/PLATFORM_RELATIONSHIPS.json

@@ -52,5 +52,18 @@
          "hostname" : "dg3c6xro44gl5tuxqbqf5flvhu.solr.service._.eu-3.platformsh.site",
          "scheme" : "solr"
       }
+   ],
+   "headless": [
+      {
+          "service": "headless",
+          "ip": "169.254.16.215",
+          "hostname": "vjteswvo72bpyb33rgijkpooja.headless.service._.eu-3.platformsh.site",
+          "cluster": "moqwtrvgc63mo-pr-5-kehpj4q",
+          "host": "headless.internal",
+          "rel": "http",
+          "scheme": "http",
+          "type": "chrome-headless:73",
+          "port": 9222
+      }
    ]
 }

test/tests.js

@@ -345,7 +345,13 @@ describe("Config tests", () => {
             });
         });
 
+        it('formatts a puppeteer connection', () => {
+            let c = new psh.Config(mockEnvironmentRuntime);
 
-    });
+            let formatted = c.formattedCredentials('headless', 'puppeteer')
+
+            assert.equal(formatted, 'http://169.254.16.215:9222')
+        });
+     });
 
 });