1
0
mirror of https://github.com/Unleash/unleash.git synced 2024-12-22 19:07:54 +01:00

feat: Introduce specific "feature stale" events (#727)

fixes: #776
This commit is contained in:
Ivar Conradi Østhus 2021-02-18 09:18:04 +01:00 committed by GitHub
parent d017ec7cdc
commit b17e9a4bda
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
9 changed files with 130 additions and 4 deletions

View File

@ -5,6 +5,8 @@ const {
FEATURE_UPDATED, FEATURE_UPDATED,
FEATURE_ARCHIVED, FEATURE_ARCHIVED,
FEATURE_REVIVED, FEATURE_REVIVED,
FEATURE_STALE_ON,
FEATURE_STALE_OFF,
} = require('../event-type'); } = require('../event-type');
module.exports = { module.exports = {
@ -52,6 +54,8 @@ module.exports = {
FEATURE_UPDATED, FEATURE_UPDATED,
FEATURE_ARCHIVED, FEATURE_ARCHIVED,
FEATURE_REVIVED, FEATURE_REVIVED,
FEATURE_STALE_ON,
FEATURE_STALE_OFF,
], ],
tagTypes: [ tagTypes: [
{ {

View File

@ -8,6 +8,8 @@ const {
FEATURE_UPDATED, FEATURE_UPDATED,
FEATURE_ARCHIVED, FEATURE_ARCHIVED,
FEATURE_REVIVED, FEATURE_REVIVED,
FEATURE_STALE_ON,
FEATURE_STALE_OFF,
} = require('../event-type'); } = require('../event-type');
const definition = require('./slack-definition'); const definition = require('./slack-definition');
@ -32,7 +34,15 @@ class SlackAddon extends Addon {
slackChannels.push(defaultChannel); slackChannels.push(defaultChannel);
} }
const text = this.generateText(event); let text;
if (event.type === FEATURE_STALE_ON) {
text = this.generateStaleText(event, true);
} else if (event.type === FEATURE_STALE_OFF) {
text = this.generateStaleText(event, false);
} else {
text = this.generateText(event);
}
const requests = slackChannels.map(channel => { const requests = slackChannels.map(channel => {
const body = { const body = {
@ -74,6 +84,16 @@ class SlackAddon extends Addon {
return tags.filter(tag => tag.type === 'slack').map(t => t.value); return tags.filter(tag => tag.type === 'slack').map(t => t.value);
} }
generateStaleText({ createdBy, data }, isStale) {
const feature = `<${this.unleashUrl}/#/features/strategies/${data.name}|${data.name}>`;
if (isStale) {
return `The feature toggle *${feature}* is now *ready to be removed* from the code. :technologist:
This was changed by ${createdBy}.`;
}
return `The feature toggle *${feature}* was is *unmarked as stale*. This was changed by ${createdBy}.`;
}
generateText({ createdBy, data, type }) { generateText({ createdBy, data, type }) {
const eventName = this.eventName(type); const eventName = this.eventName(type);
const feature = `<${this.unleashUrl}/#/features/strategies/${data.name}|${data.name}>`; const feature = `<${this.unleashUrl}/#/features/strategies/${data.name}|${data.name}>`;

View File

@ -3,6 +3,8 @@ const {
FEATURE_UPDATED, FEATURE_UPDATED,
FEATURE_ARCHIVED, FEATURE_ARCHIVED,
FEATURE_REVIVED, FEATURE_REVIVED,
FEATURE_STALE_ON,
FEATURE_STALE_OFF,
} = require('../event-type'); } = require('../event-type');
module.exports = { module.exports = {
@ -50,5 +52,7 @@ module.exports = {
FEATURE_UPDATED, FEATURE_UPDATED,
FEATURE_ARCHIVED, FEATURE_ARCHIVED,
FEATURE_REVIVED, FEATURE_REVIVED,
FEATURE_STALE_ON,
FEATURE_STALE_OFF,
], ],
}; };

View File

@ -30,6 +30,8 @@ const {
TAG_TYPE_CREATED, TAG_TYPE_CREATED,
TAG_TYPE_DELETED, TAG_TYPE_DELETED,
APPLICATION_CREATED, APPLICATION_CREATED,
FEATURE_STALE_ON,
FEATURE_STALE_OFF,
} = require('./event-type'); } = require('./event-type');
const strategyTypes = [ const strategyTypes = [
@ -51,6 +53,8 @@ const featureTypes = [
FEATURE_TAGGED, FEATURE_TAGGED,
FEATURE_UNTAGGED, FEATURE_UNTAGGED,
DROP_FEATURES, DROP_FEATURES,
FEATURE_STALE_ON,
FEATURE_STALE_OFF,
]; ];
const contextTypes = [ const contextTypes = [

View File

@ -9,6 +9,8 @@ module.exports = {
FEATURE_IMPORT: 'feature-import', FEATURE_IMPORT: 'feature-import',
FEATURE_TAGGED: 'feature-tagged', FEATURE_TAGGED: 'feature-tagged',
FEATURE_UNTAGGED: 'feature-untagged', FEATURE_UNTAGGED: 'feature-untagged',
FEATURE_STALE_ON: 'feature-stale-on',
FEATURE_STALE_OFF: 'feature-stale-off',
DROP_FEATURES: 'drop-features', DROP_FEATURES: 'drop-features',
STRATEGY_CREATED: 'strategy-created', STRATEGY_CREATED: 'strategy-created',
STRATEGY_DELETED: 'strategy-deleted', STRATEGY_DELETED: 'strategy-deleted',

View File

@ -169,11 +169,33 @@ class FeatureController extends Controller {
} }
async staleOn(req, res) { async staleOn(req, res) {
await this._updateField('stale', true, req, res); try {
const { featureName } = req.params;
const userName = extractUser(req);
const feature = await this.featureService.updateStale(
featureName,
true,
userName,
);
res.json(feature).end();
} catch (error) {
handleErrors(res, this.logger, error);
}
} }
async staleOff(req, res) { async staleOff(req, res) {
await this._updateField('stale', false, req, res); try {
const { featureName } = req.params;
const userName = extractUser(req);
const feature = await this.featureService.updateStale(
featureName,
false,
userName,
);
res.json(feature).end();
} catch (error) {
handleErrors(res, this.logger, error);
}
} }
async _updateField(field, value, req, res) { async _updateField(field, value, req, res) {

View File

@ -620,3 +620,42 @@ test('Trying to get features while database is down should yield 500', t => {
const { request, base } = getSetup(false); const { request, base } = getSetup(false);
return request.get(`${base}/api/admin/features`).expect(500); return request.get(`${base}/api/admin/features`).expect(500);
}); });
test('should mark toggle as stale', t => {
t.plan(1);
const toggleName = 'toggle-stale';
const { request, featureToggleStore, base, perms } = getSetup();
perms.withPermissions(UPDATE_FEATURE, DELETE_FEATURE);
featureToggleStore.createFeature({
name: toggleName,
strategies: [{ name: 'default' }],
});
return request
.post(`${base}/api/admin/features/${toggleName}/stale/on`)
.set('Content-Type', 'application/json')
.expect(200)
.expect(res => {
t.true(res.body.stale);
});
});
test('should mark toggle as NOT stale', t => {
t.plan(1);
const toggleName = 'toggle-stale';
const { request, featureToggleStore, base, perms } = getSetup();
perms.withPermissions(UPDATE_FEATURE, DELETE_FEATURE);
featureToggleStore.createFeature({
name: toggleName,
strategies: [{ name: 'default' }],
stale: true,
});
return request
.post(`${base}/api/admin/features/${toggleName}/stale/off`)
.set('Content-Type', 'application/json')
.expect(200)
.expect(res => {
t.false(res.body.stale);
});
});

View File

@ -8,6 +8,8 @@ const {
FEATURE_CREATED, FEATURE_CREATED,
FEATURE_REVIVED, FEATURE_REVIVED,
FEATURE_UPDATED, FEATURE_UPDATED,
FEATURE_STALE_ON,
FEATURE_STALE_OFF,
TAG_CREATED, TAG_CREATED,
} = require('../event-type'); } = require('../event-type');
@ -119,7 +121,7 @@ class FeatureToggleService {
return this.updateField(feature.name, 'enabled', toggle, userName); return this.updateField(feature.name, 'enabled', toggle, userName);
} }
/** Tag releated */ /** Tag related */
async listTags(featureName) { async listTags(featureName) {
return this.featureToggleStore.getAllTagsForFeature(featureName); return this.featureToggleStore.getAllTagsForFeature(featureName);
} }
@ -205,6 +207,23 @@ class FeatureToggleService {
}); });
return feature; return feature;
} }
async updateStale(featureName, isStale, userName) {
const feature = await this.featureToggleStore.getFeature(featureName);
feature.stale = isStale;
await this.featureToggleStore.updateFeature(feature);
const tags =
(await this.featureToggleStore.getAllTagsForFeature(featureName)) ||
[];
await this.eventStore.store({
type: isStale ? FEATURE_STALE_ON : FEATURE_STALE_OFF,
createdBy: userName,
data: feature,
tags,
});
return feature;
}
} }
module.exports = FeatureToggleService; module.exports = FeatureToggleService;

View File

@ -518,3 +518,15 @@ test.serial(
}); });
}, },
); );
test.serial('marks feature toggle as stale', async t => {
t.plan(1);
const request = await setupApp(stores);
await request
.post('/api/admin/features/featureZ/stale/on')
.set('Content-Type', 'application/json');
return request.get('/api/admin/features/featureZ').expect(res => {
t.true(res.body.stale);
});
});