Skip to content
This repository was archived by the owner on Jul 23, 2023. It is now read-only.
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
15 changes: 15 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -170,6 +170,21 @@ try {
}
```

To define the **default behavior** globally you can call the function `setUnknownFeatureState`

```js
import { isEnabled, setEnabledFeatures, setUnknownFeatureState } from 'vue-feature-flipping'
setUnknownFeatureState(true);

setEnabledFeatures(['FF1', 'FF3'])

isEnabled('FF1') // returns true cause the flag is here
isEnabled('FF1', false) // returns true the flag is here
isEnabled('FF2') // returns true cause the default behavior is true du to the previous setUnknownFeatureState calls
isEnabled('FF2', false) // returns false cause the default behavior is passed as second argument

```

### `not`: reversed rendering

In some cases, we have to define a behavior when the feature is disabled.
Expand Down
1 change: 1 addition & 0 deletions package-lock.json

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

13 changes: 10 additions & 3 deletions src/service.ts
Original file line number Diff line number Diff line change
@@ -1,18 +1,25 @@
import {ref, watch} from 'vue';

const unknownFeatureState = ref<boolean>(false);

const enabledFeatures = ref<string[] | null>(null);

export function isEnabled(key: string, defaut = false) {
export function isEnabled(key: string, defaut?: boolean) {
const keys = enabledFeatures.value
return keys === null ? defaut : keys.includes(key)
const defaultValue = defaut === undefined ? unknownFeatureState.value : defaut;
return keys === null ? defaultValue : keys.includes(key)
}

export function setUnknownFeatureState(value: boolean) {
unknownFeatureState.value = value
}

export function setEnabledFeatures(features: string[] | null) {
enabledFeatures.value = features
}

export function onFeaturesChanged(handler: () => void) {
return watch(enabledFeatures, (from, to) => {
return watch([enabledFeatures, unknownFeatureState], (from, to) => {
handler()
})
}
35 changes: 34 additions & 1 deletion tests/service.spec.ts
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
import {isEnabled, setEnabledFeatures} from '../src'
import {onFeaturesChanged} from "../src/service";
import {onFeaturesChanged, setUnknownFeatureState} from "../src/service";
import {nextTick} from "vue";

describe('service', () => {
Expand All @@ -23,6 +23,21 @@ describe('service', () => {
})
})

describe('Unknown flag should return unknownFeatureState value', () => {
beforeEach(() => setEnabledFeatures(null))

it('Should return "default" value', () => {
setUnknownFeatureState(true)
expect(isEnabled('KEY', true)).toEqual(true)
expect(isEnabled('KEY', false)).toEqual(false)
})

it('Default "default" value is "true"', () => {
setUnknownFeatureState(true)
expect(isEnabled('KEY')).toEqual(true)
})
})

describe('onFeaturesChanged', () => {
it('Should call handler when features list updated', async () => {
const handler = jest.fn()
Expand All @@ -44,6 +59,24 @@ describe('service', () => {
expect(handler).toHaveBeenCalledTimes(3)
})

it('Should call handler when unknownFeatureState updated', async () => {
setUnknownFeatureState(false)
const handler = jest.fn()
onFeaturesChanged(handler)

setUnknownFeatureState(false)
await nextTick()
expect(handler).toHaveBeenCalledTimes(0)

setUnknownFeatureState(true)
await nextTick()
expect(handler).toHaveBeenCalledTimes(1)

setUnknownFeatureState(false)
await nextTick()
expect(handler).toHaveBeenCalledTimes(2)
})

it('Should return function to unsubscribe', async () => {
const handler = jest.fn()
const unsubscriber = onFeaturesChanged(handler)
Expand Down