rox-ssr

v6.0.13

Published

8 days ago

CloudBees Feature Management JavaScript SDK for Server-Side Rendering

0High
0Medium
0Low

feature-flag feature-flags cloudbees cloudbees.io rox ssr flags flag configuration remote-control feature-management

CloudBees Feature Management - Server Side Rendering (SSR) SDK 🦆

CloudBees Feature Management is a secure feature management solution for the enterprise.

Accelerate development and minimize the risk of deploying new code with simple to create feature flags, controlled rollouts, advanced target groups & deployment rules.

Getting Started

Please see the detailed instructions in our docs on how to add CloudBees Feature Management to your project.

Documentation

Getting started guide, use cases, examples and videos can be found at CloudBees Feature Management documentation.

About

CloudBees Feature Management JavaScript SSR SDK for web applications that use server side rendering. Define and use simple and advanced feature flags, static and computed custom properties in code. Control your application features via CloudBees Feature Management dashboard.

Installation

npm i rox-ssr --save

TypeScript Support

This package includes TypeScript definitions. Import and use with full type safety:

import {RoxString, RoxNumber, Flag, Rox} from 'rox-ssr';

Usage

Basic Usage

Obtain an application key by registering at CloudBees Unify.

import {RoxString, RoxNumber, Flag, Rox} from 'rox-ssr';

const appSettingsContainer = {
  shouldShowWelcome: new Flag(),
  textColor: new RoxString('red', ['green', 'blue']),
  textSize: new RoxNumber(15, [20, 45])
};

const onRoxReady = () => {
  if (appSettingsContainer.shouldShowWelcome.isEnabled()) {
    const color = appSettingsContainer.textColor.getValue()
    const size = appSettingsContainer.textSize.getValue()
    const div = document
      .createElement('div')
      .textContent('Hello world!')
      .setAttribute('style', `color: ${color}; font-size: ${size}px`)

    const body = document.getElementsByTagName('body')[0]
    body.appendChild(div)
  }
};

Rox.register('settingsNamespace', appSettingsContainer);
Rox.setup('<app key>', {
  configurationFetchedHandler: onRoxReady
});

Hydrate browser-side Rox with flag configuration

In order to ensure the consistency of feature flags between the server and the web clients, the CloudBees Feature Management configuration can easily be sent to the clients.

React example, assuming you already have initialized Rox. Add this to the server-side code, within the <head> tag:

import {Rox} from 'rox-ssr';

// ...
// Your component render() method
render() {
  return (
    <html>
      <head>
        <script type='text/javascript' dangerouslySetInnerHTML={{ __html: `window.rolloutData = ${JSON.stringify(Rox.rolloutData)};` }} />
      <head>
    </html>)
  }

The SDK will automatically use the data inside window.rolloutData instead of fetching the configuration from CloudBees Feature Management servers.

Configure the SDK with different options

Override the default configuration by providing predefined configuration preset for Rox.setup.

For example:

import {Rox} from 'rox-ssr';

/*
- roxOptions.distinctId
- roxOptions.version
- roxOptions.configurationFetchedHandler
*/

const roxOptions = {
  distinctId: 'sessionDistinctId',
  version: '1.0',
  configurationFetchedHandler: () => {}
};

Rox.setup('<app key>', roxOptions);

Activating Manual Overrides UI

When running in the browser, you can override flags manually using a built-in UI debug utility that can be activated by invoking Rox.showOverrides().

Running it will display a UI element that allows to explicitly set values of flags. Available UI location of the UI element:

'top left'
'top right'
'bottom left'
'bottom right' (default)

LICENSE

CloudBees Feature Management JavaScript Server Side Rendering SDK is free-to-use, proprietary software. Please see the full license found under the LICENSE file for more details.

Feedback

Feedback is always welcomed [email protected]