unleash-server 3.3.3 → 3.4.0

package/CHANGELOG.md

@@ -1,5 +1,23 @@
 # Changelog
 
+## 3.4.0
+
+- feat: Adds server.create() (#606)
+
+## 3.3.6
+
+- fix: upgrade unleash-frontend to verson 3.3.5
+
+## 3.3.5
+
+- fix: upgrade unleash-frontend to verson 3.3.3
+
+## 3.3.4
+
+- fix: we now support node 14 :hurray
+- fix: upgrade db-migrate-pg to version 1.2.2
+- fix: upgrade unleash-frontend to version 3.3.2
+
 ## 3.3.3
 
 - chore: add a few more community client SDKs

package/README.md

@@ -55,7 +55,7 @@ Clients written by awesome enthusiasts: :fire:
 - [uekoetter.dev/unleash-client-dart](https://pub.dev/packages/unleash) (Dart)
 - [minds/unleash-client-php](https://gitlab.com/minds/unleash-client-php) (PHP)
 - [afontaine/unleash_ex](https://gitlab.com/afontaine/unleash_ex) (Elixir)
-- [mikefrancis/laravel-unleash](https://github.com/mikefrancis/laravel-unleash) (Larvel - PHP)
+- [mikefrancis/laravel-unleash](https://github.com/mikefrancis/laravel-unleash) (Laravel - PHP)
 
 ### The Client API
 

package/docs/getting-started.md

@@ -59,7 +59,26 @@ Available unleash options include:
 - **ui** (object) - Set of UI specific overrides. You may set the following keys: `headerBackground`, `environment`, `slogan`.
 - **getLogger** (function) - Used to register a [custom log provider](#How do I configure the log output).
 - **eventHook** (`function(event, data)`) - If provided, this function will be invoked whenever a feature is mutated. The possible values for `event` are `'feature-created'`, `'feature-updated'`, `'feature-archived'`, `'feature-revived'`. The `data` argument contains information about the mutation. Its fields are `type` (string) - the event type (same as `event`); `createdBy` (string) - the user who performed the mutation; `data` - the contents of the change. The contents in `data` differs based on the event type; For `'feature-archived'` and `'feature-revived'`, the only field will be `name` - the name of the feature. For `'feature-created'` and `'feature-updated'` the data follows a schema defined in the code [here](https://github.com/Unleash/unleash/blob/master/lib/routes/admin-api/feature-schema.js#L38-L59). See an example [here](./guides/feautre-updates-to-slack.md).
-- **baseUriPath** (string) - use to register a base path for all routes on the application. For example `my/unleash/base`. Defaults to `/`.
+- **baseUriPath** (string) - use to register a base path for all routes on the application. For example `/my/unleash/base` (note the starting /). Defaults to `/`. Can also be configured through the environment variable `BASE_URI_PATH`.
+
+#### Disabling Auto-Start
+
+If you're using unleash as part of a larger express app, you can disable the automatic server start by calling `server.create`. It takes the same options as `sevrer.start`, but will not begin listening for connections.
+
+```js
+const unleash = require('unleash-server');
+// ... const app = express();
+
+unleash
+  .create({
+    databaseUrl: 'postgres://unleash_user:password@localhost:5432/unleash',
+    port: 4242,
+  })
+  .then(result => {
+    app.use(result.app);
+    console.log(`Unleash app generated and attached to parent application`);
+  });
+```
 
 ### 3. Docker
 

package/lib/authentication-required.js

@@ -1,9 +1,10 @@
 'use strict';
 
 module.exports = class AuthenticationRequired {
-    constructor({ type, path, message }) {
+    constructor({ type, path, message, options }) {
         this.type = type;
         this.path = path;
         this.message = message;
+        this.options = options;
     }
 };

package/lib/options.js

@@ -51,6 +51,7 @@ function defaultOptions() {
         getLogger: defaultLogProvider,
         customContextFields: [],
         disableDBMigration: false,
+        start: true,
     };
 }
 

package/lib/server-impl.js

@@ -53,22 +53,26 @@ async function createApp(options) {
         });
     }
 
-    const server = app.listen(options.listen, () =>
-        logger.info('Unleash has started.', server.address()),
-    );
-
     return new Promise((resolve, reject) => {
-        server.on('listening', () =>
-            resolve({
-                app,
-                config,
-                stores,
-                server,
-                eventBus,
-                stateService,
-            }),
-        );
-        server.on('error', reject);
+        const payload = {
+            app,
+            config,
+            stores,
+            eventBus,
+            stateService,
+        };
+
+        if (options.start) {
+            const server = app.listen(options.listen, () =>
+                logger.info('Unleash has started.', server.address()),
+            );
+            server.on('listening', () => {
+                resolve({ ...payload, server });
+            });
+            server.on('error', reject);
+        } else {
+            resolve({ ...payload });
+        }
     });
 }
 
@@ -90,8 +94,13 @@ async function start(opts) {
     return createApp(options);
 }
 
+async function create(opts) {
+    return start({ ...opts, start: false });
+}
+
 module.exports = {
     start,
+    create,
     User,
     AuthenticationRequired,
     permissions,

package/lib/server-impl.test.js

@@ -82,3 +82,20 @@ test('should call eventHook', async t => {
     eventStore.emit('feature-created', {});
     t.true(called === 1);
 });
+
+test('should auto-create server on start()', async t => {
+    const { server } = await serverImpl.start({
+        port: 0,
+        getLogger,
+        start: true,
+    });
+    t.false(typeof server === 'undefined');
+});
+
+test('should not create a server using create()', async t => {
+    const { server } = await serverImpl.create({
+        port: 0,
+        getLogger,
+    });
+    t.true(typeof server === 'undefined');
+});

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "unleash-server",
   "description": "Unleash is an enterprise ready feature toggles service. It provides different strategies for handling feature toggles.",
-  "version": "3.3.3",
+  "version": "3.4.0",
   "keywords": [
     "unleash",
     "feature toggle",
@@ -24,7 +24,7 @@
     "url": "https://github.com/unleash/unleash/issues"
   },
   "engines": {
-    "node": ">=12 <14"
+    "node": ">=12"
   },
   "license": "Apache-2.0",
   "main": "./lib/server-impl.js",
@@ -68,7 +68,7 @@
     "cookie-parser": "^1.4.4",
     "cookie-session": "^2.0.0-beta.3",
     "db-migrate": "^0.11.10",
-    "db-migrate-pg": "^1.2.1",
+    "db-migrate-pg": "^1.2.2",
     "db-migrate-shared": "^1.2.0",
     "deep-diff": "^1.0.2",
     "deepmerge": "^4.2.2",
@@ -87,7 +87,7 @@
     "prom-client": "^12.0.0",
     "response-time": "^2.3.2",
     "serve-favicon": "^2.5.0",
-    "unleash-frontend": "3.3.1",
+    "unleash-frontend": "3.3.5",
     "yargs": "^15.1.0"
   },
   "devDependencies": {