1
0
mirror of https://github.com/Unleash/unleash.git synced 2024-12-22 19:07:54 +01:00
unleash.unleash/docs/advanced/custom-activation-strategy.md
egilconr 1d9065aff1
chore: Improve our user documentation (#733)
Co-authored-by: Christopher Kolstad <chriswk@fastmail.com>
Co-authored-by: Fredrik Strand Oseberg <fredrik.no@gmail.com>
Co-authored-by: Ivar Conradi Østhus <ivarconr@gmail.com>
Co-authored-by: Eco C <egilconr@gmail.com>
2021-02-25 16:01:36 +01:00

80 lines
2.8 KiB
Markdown

---
id: custom_activation_strategy
title: Custom Activation Strategy
---
Even though Unleash comes with a few powerful [activation strategies](activation-strategies.md) there might be scenarios where you would like to extend Unleash with your own custom strategies.
### Example: TimeStamp Strategy
In this example we want to define an activation strategy offers a scheduled release of a feature toggle. This means that we want the feature toggle to be activated after a given date and time.
#### Define custom strategy
First we need to "define" our new strategy. To add a new "Strategy", open the Strategies tab from the sidebar.
![timestamp_create_strategy](../assets/timestamp_create_strategy.png)
We name our strategy `TimeStamp` and add one required parameter of type string, which we call `enableAfter`.
#### Use custom strategy
After we have created the strategy definition, we can now decide to use that activation strategy for our feature toggle.
![timestamp_use_strategy](../assets/timestamp_use_strategy.png)
In the example we want to use our custom strategy for the feature toggle named `demo.TimeStampRollout`.
#### Client implementation
All official client SDK's for Unleash provides abstractions for you to implement support for custom strategies.
> Before you have provided support for the custom strategy; the client will return false, because it does not understand the activation strategy.
In Node.js the implementation for the `TimeStampStrategy` would be:
```javascript
class TimeStampStrategy extends Strategy {
constructor() {
super('TimeStamp');
}
isEnabled(parameters, context) {
Date.parse(parameters.enableAfter) < Date.now();
}
}
```
In the example implementation we make use of the library called moment to parse the timestamp and verify that current time is after the specified `enabledAfter` parameter.
All parameter injected to the strategy are handled as `string` objects. This means that the strategies needs to parse it to a more suitable format. In this example we just parse it directly to a `Date` type and do the comparison directly. You might want to also consider timezone in a real implementation.
We also have to remember to register the custom strategy when initializing the Unleash client. Full working code example:
```javascript
const { Strategy, initialize, isEnabled } = require('unleash-client');
class TimeStampStrategy extends Strategy {
constructor() {
super('TimeStamp');
}
isEnabled(parameters, context) {
return Date.parse(parameters.enableAfter) < Date.now();
}
}
const instance = initialize({
url: 'http://unleash.herokuapp.com/api/',
appName: 'unleash-demo',
instanceId: '1',
strategies: [new TimeStampStrategy()],
});
instance.on('ready', () => {
setInterval(() => {
console.log(isEnabled('demo.TimeStampRollout'));
}, 1000);
});
```