Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Configurable app name #51

Open
wants to merge 7 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions demo/scripts/directives.js
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,7 @@ angular.module('my-app')
replace: true
};
})
.run(function(featureFlags, $http) {
featureFlags.set($http.get('../data/flags.json'));
.run(function($http, featureFlagConfig) {
featureFlagConfig.setAppName('myapp');
featureFlagConfig.setInitialFlags($http.get('../data/flags.json'));
});
64 changes: 52 additions & 12 deletions dist/featureFlags.js
Original file line number Diff line number Diff line change
Expand Up @@ -76,10 +76,8 @@ angular.module('feature-flags').directive('featureFlagOverrides', ['featureFlags
};
}]);

angular.module('feature-flags').service('featureFlagOverrides', ['$rootElement', function($rootElement) {
var appName = $rootElement.attr('ng-app'),
keyPrefix = 'featureFlags.' + appName + '.',

angular.module('feature-flags').service('featureFlagOverrides', ['$rootElement', 'featureFlagConfig', function($rootElement, featureFlagConfig) {
var keyPrefix = 'featureFlags.',
localStorageAvailable = (function() {
try {
localStorage.setItem('featureFlags.availableTest', 'test');
Expand Down Expand Up @@ -116,6 +114,9 @@ angular.module('feature-flags').service('featureFlagOverrides', ['$rootElement',
}
};

if (featureFlagConfig.getAppName().length > 0) {
keyPrefix += featureFlagConfig.getAppName() + '.';
}
return {
isPresent: function(key) {
var value = get(key);
Expand Down Expand Up @@ -143,7 +144,7 @@ angular.module('feature-flags').service('featureFlagOverrides', ['$rootElement',
};
}]);

function FeatureFlags($q, featureFlagOverrides, initialFlags) {
angular.module('feature-flags').service('featureFlags', ['$q', 'featureFlagOverrides', 'featureFlagConfig', function($q, featureFlagOverrides, featureFlagConfig) {
var serverFlagCache = {},
flags = [],

Expand Down Expand Up @@ -205,8 +206,9 @@ function FeatureFlags($q, featureFlagOverrides, initialFlags) {
},

init = function() {
if (initialFlags) {
set(initialFlags);
var iniFlags = featureFlagConfig.getInitialFlags();
if (iniFlags) {
set(iniFlags);
}
};
init();
Expand All @@ -221,18 +223,56 @@ function FeatureFlags($q, featureFlagOverrides, initialFlags) {
isOnByDefault: isOnByDefault,
isOverridden: isOverridden
};
}]);

function FeatureFlagConfig(initialFlags, userAppName) {
var initFlags = [],
appName = '',

getInitialFlags = function() {
return initFlags;
},
setInitialFlags = function(value) {
initFlags = value;
},
getAppName = function() {
return appName;
},
setAppName = function(value) {
appName = value;
},
init = function() {
if (initialFlags) {
initFlags = initialFlags;
}
if (userAppName) {
appName = userAppName;
}
};
init();

return {
getInitialFlags: getInitialFlags,
setInitialFlags: setInitialFlags,
getAppName: getAppName,
setAppName: setAppName
};
}

angular.module('feature-flags').provider('featureFlags', function() {
var initialFlags = [];
angular.module('feature-flags').provider('featureFlagConfig', function() {
var initialFlags = [],
appName = '';

this.setInitialFlags = function(flags) {
initialFlags = flags;
};

this.$get = ['$q', 'featureFlagOverrides', function($q, featureFlagOverrides) {
return new FeatureFlags($q, featureFlagOverrides, initialFlags);
}];
this.setAppName = function(name) {
appName = name;
};
this.$get = function() {
return new FeatureFlagConfig(initialFlags, appName);
};
});

}());
2 changes: 1 addition & 1 deletion dist/featureFlags.min.js

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

9 changes: 5 additions & 4 deletions src/featureFlagOverrides.service.js
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
angular.module('feature-flags').service('featureFlagOverrides', function($rootElement) {
var appName = $rootElement.attr('ng-app'),
keyPrefix = 'featureFlags.' + appName + '.',

angular.module('feature-flags').service('featureFlagOverrides', function($rootElement, featureFlagConfig) {
var keyPrefix = 'featureFlags.',
localStorageAvailable = (function() {
try {
localStorage.setItem('featureFlags.availableTest', 'test');
Expand Down Expand Up @@ -38,6 +36,9 @@ angular.module('feature-flags').service('featureFlagOverrides', function($rootEl
}
};

if (featureFlagConfig.getAppName().length > 0) {
keyPrefix += featureFlagConfig.getAppName() + '.';
}
return {
isPresent: function(key) {
var value = get(key);
Expand Down
19 changes: 4 additions & 15 deletions src/featureFlags.provider.js → src/featureFlags.service.js
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
function FeatureFlags($q, featureFlagOverrides, initialFlags) {
angular.module('feature-flags').service('featureFlags', function($q, featureFlagOverrides, featureFlagConfig) {
var serverFlagCache = {},
flags = [],

Expand Down Expand Up @@ -60,8 +60,9 @@ function FeatureFlags($q, featureFlagOverrides, initialFlags) {
},

init = function() {
if (initialFlags) {
set(initialFlags);
var iniFlags = featureFlagConfig.getInitialFlags();
if (iniFlags) {
set(iniFlags);
}
};
init();
Expand All @@ -76,16 +77,4 @@ function FeatureFlags($q, featureFlagOverrides, initialFlags) {
isOnByDefault: isOnByDefault,
isOverridden: isOverridden
};
}

angular.module('feature-flags').provider('featureFlags', function() {
var initialFlags = [];

this.setInitialFlags = function(flags) {
initialFlags = flags;
};

this.$get = function($q, featureFlagOverrides) {
return new FeatureFlags($q, featureFlagOverrides, initialFlags);
};
});
49 changes: 49 additions & 0 deletions src/featureFlagsConfig.provider.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
function FeatureFlagConfig(initialFlags, userAppName) {
var initFlags = [],
appName = '',

getInitialFlags = function() {
return initFlags;
},
setInitialFlags = function(value) {
initFlags = value;
},
getAppName = function() {
return appName;
},
setAppName = function(value) {
appName = value;
},
init = function() {
if (initialFlags) {
initFlags = initialFlags;
}
if (userAppName) {
appName = userAppName;
}
};
init();

return {
getInitialFlags: getInitialFlags,
setInitialFlags: setInitialFlags,
getAppName: getAppName,
setAppName: setAppName
};
}

angular.module('feature-flags').provider('featureFlagConfig', function() {
var initialFlags = [],
appName = '';

this.setInitialFlags = function(flags) {
initialFlags = flags;
};

this.setAppName = function(name) {
appName = name;
};
this.$get = function() {
return new FeatureFlagConfig(initialFlags, appName);
};
});
18 changes: 15 additions & 3 deletions test/featureFlagOverrides.service.spec.js
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,21 @@
inject = angular.mock.inject;

describe('Service: featureFlagOverrides', function() {
var service, appName = '';

beforeEach(module('feature-flags'));
var service, appName = 'myapp';

beforeEach(module('feature-flags', function($provide) {
$provide.provider('featureFlagConfig', function() {
return {
$get: function() {
return {
getAppName: function() {
return appName;
}
};
}
};
});
}));

beforeEach(inject(function(featureFlagOverrides) {
service = featureFlagOverrides;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -354,19 +354,33 @@
});
});

describe('Provider: featureFlags', function() {
describe('Service with provider config: featureFlags', function() {
var featureFlags,
flags = [{
active: true,
key: 'FLAG_KEY'
}, {
active: false,
key: 'FLAG_KEY_2'
}];
}],
appName = 'myapp';

describe('When no flags are set in the config phase', function() {
beforeEach(module('feature-flags', function(featureFlagsProvider) {
featureFlagsProvider.setInitialFlags(null);
beforeEach(module('feature-flags', function($provide) {
$provide.provider('featureFlagConfig', function() {
return {
$get: function() {
return {
getInitialFlags: function() {
return null;
},
getAppName: function() {
return appName;
}
};
}
};
});
}));

beforeEach(inject(function(_featureFlags_) {
Expand All @@ -379,8 +393,21 @@
});

describe('When flags are set in the config phase', function() {
beforeEach(module('feature-flags', function(featureFlagsProvider) {
featureFlagsProvider.setInitialFlags(flags);
beforeEach(module('feature-flags', function($provide) {
$provide.provider('featureFlagConfig', function() {
return {
$get: function() {
return {
getInitialFlags: function() {
return flags;
},
getAppName: function() {
return appName;
}
};
}
};
});
}));

beforeEach(inject(function(_featureFlags_) {
Expand Down
69 changes: 69 additions & 0 deletions test/featureFlagsConfig.provider.spec.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,69 @@
(function(angular) {
'use strict';

var module = angular.mock.module,
inject = angular.mock.inject;

describe('Provider: featureFlags', function() {
var appName = 'myapp',
featureFlagConfig,
flags = [{
active: true,
key: 'FLAG_KEY'
}, {
active: false,
key: 'FLAG_KEY_2'
}];

describe('When no flags are set in the config phase', function() {
beforeEach(module('feature-flags', function(featureFlagConfigProvider) {
featureFlagConfigProvider.setInitialFlags(null);
featureFlagConfigProvider.setAppName(null);
}));

beforeEach(inject(function(_featureFlagConfig_) {
featureFlagConfig = _featureFlagConfig_;
}));

it('should return an empty array for current feature flags', function() {
expect(featureFlagConfig).not.toBeUndefined();
expect(featureFlagConfig.getInitialFlags()).toEqual([]);
expect(featureFlagConfig.getAppName()).toEqual('');
});
});

describe('When flags are set in the config phase', function() {
beforeEach(module('feature-flags', function(featureFlagConfigProvider) {
featureFlagConfigProvider.setInitialFlags(flags);
featureFlagConfigProvider.setAppName(appName);
}));

beforeEach(inject(function(_featureFlagConfig_) {
featureFlagConfig = _featureFlagConfig_;
}));

it('should init the flags with the ones set in the config phase', function() {
expect(featureFlagConfig).not.toBeUndefined();
expect(featureFlagConfig.getInitialFlags()).toEqual(flags);
expect(featureFlagConfig.getAppName()).toEqual(appName);
});
});

describe('When flags are set in the run phase', function() {
beforeEach(module('feature-flags', function(featureFlagConfigProvider) {
featureFlagConfigProvider.setInitialFlags(null);
}));
beforeEach(inject(function(_featureFlagConfig_) {
featureFlagConfig = _featureFlagConfig_;
}));

it('should init the flags with the ones set in the run phase', function() {
expect(featureFlagConfig).not.toBeUndefined();
featureFlagConfig.setInitialFlags(flags);
featureFlagConfig.setAppName(appName);
expect(featureFlagConfig.getInitialFlags()).toEqual(flags);
expect(featureFlagConfig.getAppName()).toEqual(appName);
});
});
});
}(window.angular));