Add upstream route filtering method.

Author: Crell

src/platformsh.js

@@ -218,6 +218,44 @@ class Config {
         throw new Error(`No primary route found. This isn't supposed to happen.`);
     }
 
+    /**
+     * Returns just those routes that point to a valid upstream.
+     *
+     * This method is similar to routes(), but filters out redirect routes that are rarely
+     * useful for app configuration.  If desired it can also filter to just those routes
+     * whose upstream is a given application name.  To retrieve routes that point to the
+     * current application where the code is being run, use:
+     *
+     * routes =  config.getUpstreamRoutes(config.applicationName);
+     *
+     * @param {string|null} appName
+     *   The name of the upstream app on which to filter, if any.
+     * @return {object}
+     *   An object map of route definitions.
+     */
+    getUpstreamRoutes(appName = null) {
+        // Because routes is an object/dictionary, we can't just filter it directly.
+        // Verbose way it is.
+
+        const routes = this.routes();
+        const filter = route => {
+            return route.type === 'upstream'
+                // On Dedicated, the upstream name sometimes is `app:http` instead of just `app`.
+                // If no name is specified then don't bother checking.
+                && (!appName || appName === route.upstream.split(':')[0]);
+        };
+
+        let ret = {};
+
+        Object.keys(routes).forEach(function(key) {
+            if (filter(routes[key])) {
+                ret[key] = routes[key];
+            }
+        });
+
+        return ret;
+    }
+
     /**
      * Returns a single route definition.
      *

test/tests.js

@@ -172,6 +172,40 @@ describe("Config tests", () => {
             let route = c.getPrimaryRoute();
 
             assert.equal(route['original_url'], 'https://www.{default}/');
+            assert.equal(route['primary'], true);
+        });
+
+        it('returns all upstream routes', () => {
+            let c = new psh.Config(mockEnvironmentRuntime);
+
+            let routes = c.getUpstreamRoutes();
+
+            assert.equal(3, Object.keys(routes).length);
+            assert.equal(routes['https://www.master-7rqtwti-gcpjkefjk4wc2.us-2.platformsh.site/']['original_url'], 'https://www.{default}/');
+        });
+
+        it('returns all upstream routes for a specific app', () => {
+            let c = new psh.Config(mockEnvironmentRuntime);
+
+            let routes = c.getUpstreamRoutes('app');
+
+            assert.equal(2, Object.keys(routes).length);
+            assert.equal(routes['https://www.master-7rqtwti-gcpjkefjk4wc2.us-2.platformsh.site/']['original_url'], 'https://www.{default}/');
+        });
+
+        it('returns all upstream routes for a specific app on dedicated', () => {
+            let env = mockEnvironmentRuntime;
+            // Simulate a Dedicated-style upstream name.
+            let routeData = loadJsonFile('PLATFORM_ROUTES');
+            routeData['https://www.master-7rqtwti-gcpjkefjk4wc2.us-2.platformsh.site/']['upstream'] = 'app:http';
+            env['PLATFORM_ROUTES'] = encode(routeData);
+
+            let c = new psh.Config(env);
+
+            let routes = c.getUpstreamRoutes('app');
+
+            assert.equal(2, Object.keys(routes).length);
+            assert.equal(routes['https://www.master-7rqtwti-gcpjkefjk4wc2.us-2.platformsh.site/']['original_url'], 'https://www.{default}/');
         });
 
         it('gets a route by id', () => {