Add a get primary route method.

Author: Crell

src/platformsh.js

@@ -198,6 +198,26 @@ class Config {
         return this.routesDef;
     }
 
+    /**
+     * Returns the primary route.
+     *
+     * The primary route is the one marked primary in `routes.yaml`, or else
+     * the first non-redirect route in that file if none are marked.
+     *
+     * @return {object}
+     *   The route definition.  The generated URL of the route is added as a "url" key.
+     */
+    getPrimaryRoute() {
+        // eslint-disable-next-line no-unused-vars
+        for (const [url, route] of Object.entries(this.routes())) {
+            if (route.primary === true) {
+                return route;
+            }
+        }
+
+        throw new Error(`No primary route found. This isn't supposed to happen.`);
+    }
+
     /**
      * Returns a single route definition.
      *

test/tests.js

@@ -166,6 +166,14 @@ describe("Config tests", () => {
             });
         });
 
+        it('gets the primary route', () => {
+            let c = new psh.Config(mockEnvironmentRuntime);
+
+            let route = c.getPrimaryRoute();
+
+            assert.equal(route['original_url'], 'https://www.{default}/');
+        });
+
         it('gets a route by id', () => {
             let c = new psh.Config(mockEnvironmentRuntime);