Merge pull request #13 from platformsh/dedicated

Dedicated not enterprise.

Author: Crell

CHANGELOG.md

@@ -0,0 +1,53 @@
+# Changelog
+
+## [2.3.1] - 2019-11-04
+
+### Added
+
+* `CHANGELOG` added.
+* `onDedicated` method that determines if the current environment is a Platform.sh Dedicated environment. Replaces deprecated `onEnterprise` method.
+
+### Changed
+
+* Deprecates `onEnterprise` method - which is for now made to wrap around the added `onDedicated` method. `onEnterprise` **will be removed** in a future release, so update your projects to use `onDedicated` instead as soon as possible.
+
+## [2.3.0] - 2019-09-19
+
+### Added
+
+* `getPrimaryRoute` method for accessing routes marked "primary" in `routes.yaml`.
+* `getUpstreamRoutes` method returns an object map that includes only those routes that point to a valid upstream.
+
+## [2.2.5] - 2019-06-04
+
+### Added
+
+* Credential formatter `puppeteerFormatter` that returns Puppeteer connection string for using [Headless Chrome](https://docs.platform.sh/configuration/services/headless-chrome.html) on Platform.sh.
+
+## [2.2.1] - 2019-04-30
+
+### Removed
+
+* Removes the strict guard in place on the `variables` method.
+
+## [2.2.0] - 2019-04-24
+
+### Changed
+
+* Checks for valid environments were relaxed to unbreak use during local development.
+
+## [2.1.0] - 2019-03-22
+
+### Added
+
+* `hasRelationship` method to verify relationship has been defined before attempting to access credentials for it.
+
+### Changed
+
+* BSD-2-Clause to MIT license.
+
+## [2.0.3] - 2019-03-06
+
+### Added
+
+* CircleCI deploy hook added to publish to npm.

README.md

@@ -61,11 +61,17 @@ config.inBuild();
 
 config.inRuntime();
 
-config.onEnterprise();
+config.onDedicated();
 
 config.onProduction();
 ```
 
+> **Note:**
+>
+> Platform.sh will no longer refer to its [99.99% uptime SLA product](https://platform.sh/solutions/) as "Enterprise", but rather as "Dedicated". Configuration Reader libraries have in turn been updated to include an `onDedicated` method to replace `onEnterprise`. For now `onEnterprise` remains available. It now calls the new method and no breaking changes have been introduced.
+>
+> It is recommended that you update your projects to use `onDedicated` as soon as possible, as `onEnterprise` will be removed in a future version of this library.
+
 ### Read environment variables
 
 The following magic properties return the corresponding environment variable value.  See the [Platform.sh documentation](https://docs.platform.sh/development/variables.html) for a description of each.

package.json

@@ -1,6 +1,6 @@
 {
   "name": "platformsh-config",
-  "version": "2.3.0",
+  "version": "2.3.1",
   "description": "Helper for running nodejs applications on Platform.sh",
   "main": "lib/platformsh.js",
   "keywords": [

src/platformsh.js

@@ -148,12 +148,31 @@ class Config {
     }
 
     /**
-     * Determines if the current environment is a Platform.sh Enterprise environment.
+     * Determines if the current environment is a Platform.sh Dedicated environment.
+     *
+     * @deprecated
+     *
+     * The Platform.sh "Enterprise" will soon be referred to exclusively as
+     * "Dedicated". the `onEnterprise` method remains available for now, but it
+     * will be removed in a future version of this library.
+     *
+     * It is recommended that you update your projects to use `onDedicated` as
+     * soon as possible.
      *
      * @return {boolean}
-     *   True on an Enterprise environment, False otherwise.
+     *   True on an Dedicated environment, False otherwise.
      */
     onEnterprise() {
+        return this.onDedicated();
+    }
+
+    /**
+     * Determines if the current environment is a Platform.sh Dedicated environment.
+     *
+     * @return {boolean}
+     *   True on an Dedicated environment, False otherwise.
+     */
+    onDedicated() {
         return this.isValidPlatform() && this._getValue('MODE') === 'enterprise';
     }
 
@@ -613,4 +632,3 @@ module.exports = {
 if (process.env.NODE_ENV === 'test') {
     module.exports.Config = Config;
 }
-

test/tests.js

@@ -92,41 +92,41 @@ describe("Config tests", () => {
         });
     });
 
-    describe("onEnterprise() tests", () => {
+    describe("onDedicated() tests", () => {
 
-        it('Returns true in enterprise environment', () => {
-            let mockEnvironmentEnterprise = deepClone(mockEnvironmentRuntime);
-            mockEnvironmentEnterprise['PLATFORM_MODE'] = 'enterprise';
+        it('Returns true in Dedicated environment', () => {
+            let mockEnvironmentDedicated = deepClone(mockEnvironmentRuntime);
+            mockEnvironmentDedicated['PLATFORM_MODE'] = 'enterprise';
 
-            let c = new psh.Config(mockEnvironmentEnterprise);
+            let c = new psh.Config(mockEnvironmentDedicated);
 
-            assert.ok(c.onEnterprise());
+            assert.ok(c.onDedicated());
         });
 
         it('Returns false in standard environment', () => {
             let c = new psh.Config(mockEnvironmentRuntime);
 
-            assert.ok(!c.onEnterprise());
+            assert.ok(!c.onDedicated());
         });
     });
 
     describe("onProduction() tests", () => {
 
-        it('Returns true on enterprise production', () => {
-            let mockEnvironmentEnterprise = deepClone(mockEnvironmentRuntime);
-            mockEnvironmentEnterprise['PLATFORM_MODE'] = 'enterprise';
-            mockEnvironmentEnterprise['PLATFORM_BRANCH'] = 'production';
+        it('Returns true on Dedicated production', () => {
+            let mockEnvironmentDedicated = deepClone(mockEnvironmentRuntime);
+            mockEnvironmentDedicated['PLATFORM_MODE'] = 'enterprise';
+            mockEnvironmentDedicated['PLATFORM_BRANCH'] = 'production';
 
-            let c = new psh.Config(mockEnvironmentEnterprise);
+            let c = new psh.Config(mockEnvironmentDedicated);
 
             assert.ok(c.onProduction());
         });
 
-        it('Returns false on enterprise staging', () => {
-            let mockEnvironmentEnterprise = deepClone(mockEnvironmentRuntime);
-            mockEnvironmentEnterprise['PLATFORM_MODE'] = 'enterprise';
+        it('Returns false on Dedicated staging', () => {
+            let mockEnvironmentDedicated = deepClone(mockEnvironmentRuntime);
+            mockEnvironmentDedicated['PLATFORM_MODE'] = 'enterprise';
 
-            let c = new psh.Config(mockEnvironmentEnterprise);
+            let c = new psh.Config(mockEnvironmentDedicated);
 
             assert.ok(!c.onProduction());
         });