-
Notifications
You must be signed in to change notification settings - Fork 43
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat: add targeting validation/warning (#878)
Signed-off-by: Todd Baert <todd.baert@dynatrace.com>
- Loading branch information
Showing
7 changed files
with
153 additions
and
85 deletions.
There are no files selected for viewing
Submodule flagd-schemas
updated
36 files
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,75 +1,117 @@ | ||
| import { parse } from './parser'; | ||
| import { ParseError } from '@openfeature/core'; | ||
| import { parse } from './parser'; | ||
|
|
||
| describe('Flag configurations', () => { | ||
| it('should parse valid configurations - single', () => { | ||
| const simpleFlag = | ||
| '{\n' + | ||
| ' "flags": {\n' + | ||
| ' "myBoolFlag": {\n' + | ||
| ' "state": "ENABLED",\n' + | ||
| ' "variants": {\n' + | ||
| ' "on": true,\n' + | ||
| ' "off": false\n' + | ||
| ' },\n' + | ||
| ' "defaultVariant": "on"\n' + | ||
| ' }\n' + | ||
| ' }\n' + | ||
| '}'; | ||
|
|
||
| const flags = parse(simpleFlag); | ||
| expect(flags).toBeTruthy(); | ||
| expect(flags.get('myBoolFlag')).toBeTruthy(); | ||
| }); | ||
| describe('throwIfSchemaInvalid=false', () => { | ||
| it('should parse valid configurations - single', () => { | ||
| const simpleFlag = | ||
| '{\n' + | ||
| ' "flags": {\n' + | ||
| ' "myBoolFlag": {\n' + | ||
| ' "state": "ENABLED",\n' + | ||
| ' "variants": {\n' + | ||
| ' "on": true,\n' + | ||
| ' "off": false\n' + | ||
| ' },\n' + | ||
| ' "defaultVariant": "on"\n' + | ||
| ' }\n' + | ||
| ' }\n' + | ||
| '}'; | ||
|
|
||
| it('should parse valid configurations - long', () => { | ||
| const longFlag = | ||
| '{"flags":{"myBoolFlag":{"state":"ENABLED","variants":{"on":true,"off":false},"defaultVariant":"on"},"myStringFlag":{"state":"ENABLED","variants":{"key1":"val1","key2":"val2"},"defaultVariant":"key1"},"myFloatFlag":{"state":"ENABLED","variants":{"one":1.23,"two":2.34},"defaultVariant":"one"},"myIntFlag":{"state":"ENABLED","variants":{"one":1,"two":2},"defaultVariant":"one"},"myObjectFlag":{"state":"ENABLED","variants":{"object1":{"key":"val"},"object2":{"key":true}},"defaultVariant":"object1"},"fibAlgo":{"variants":{"recursive":"recursive","memo":"memo","loop":"loop","binet":"binet"},"defaultVariant":"recursive","state":"ENABLED","targeting":{"if":[{"$ref":"emailWithFaas"},"binet",null]}},"targetedFlag":{"variants":{"first":"AAA","second":"BBB","third":"CCC"},"defaultVariant":"first","state":"ENABLED","targeting":{"if":[{"in":["@openfeature.dev",{"var":"email"}]},"second",{"in":["Chrome",{"var":"userAgent"}]},"third",null]}}},"$evaluators":{"emailWithFaas":{"in":["@faas.com",{"var":["email"]}]}}}'; | ||
| const flags = parse(simpleFlag, false); | ||
| expect(flags).toBeTruthy(); | ||
| expect(flags.get('myBoolFlag')).toBeTruthy(); | ||
| }); | ||
|
|
||
| const flags = parse(longFlag); | ||
| expect(flags).toBeTruthy(); | ||
| expect(flags.get('myBoolFlag')).toBeTruthy(); | ||
| expect(flags.get('myStringFlag')).toBeTruthy(); | ||
| }); | ||
| it('should parse valid configurations - long', () => { | ||
| const longFlag = | ||
| '{"flags":{"myBoolFlag":{"state":"ENABLED","variants":{"on":true,"off":false},"defaultVariant":"on"},"myStringFlag":{"state":"ENABLED","variants":{"key1":"val1","key2":"val2"},"defaultVariant":"key1"},"myFloatFlag":{"state":"ENABLED","variants":{"one":1.23,"two":2.34},"defaultVariant":"one"},"myIntFlag":{"state":"ENABLED","variants":{"one":1,"two":2},"defaultVariant":"one"},"myObjectFlag":{"state":"ENABLED","variants":{"object1":{"key":"val"},"object2":{"key":true}},"defaultVariant":"object1"},"fibAlgo":{"variants":{"recursive":"recursive","memo":"memo","loop":"loop","binet":"binet"},"defaultVariant":"recursive","state":"ENABLED","targeting":{"if":[{"$ref":"emailWithFaas"},"binet",null]}},"targetedFlag":{"variants":{"first":"AAA","second":"BBB","third":"CCC"},"defaultVariant":"first","state":"ENABLED","targeting":{"if":[{"in":["@openfeature.dev",{"var":"email"}]},"second",{"in":["Chrome",{"var":"userAgent"}]},"third",null]}}},"$evaluators":{"emailWithFaas":{"in":["@faas.com",{"var":["email"]}]}}}'; | ||
|
|
||
| it('should fail if invalid - missing default value', () => { | ||
| const invalidFlag = | ||
| '{\n' + | ||
| ' "flags": {\n' + | ||
| ' "myBoolFlag": {\n' + | ||
| ' "state": "ENABLED",\n' + | ||
| ' "variants": {\n' + | ||
| ' "on": true,\n' + | ||
| ' "off": false\n' + | ||
| ' }\n' + | ||
| ' }\n' + | ||
| ' }\n' + | ||
| '}'; | ||
|
|
||
| expect(() => parse(invalidFlag)).toThrowError(); | ||
| }); | ||
| const flags = parse(longFlag, false); | ||
| expect(flags).toBeTruthy(); | ||
| expect(flags.get('myBoolFlag')).toBeTruthy(); | ||
| expect(flags.get('myStringFlag')).toBeTruthy(); | ||
| }); | ||
|
|
||
| it('should parse flag configurations with references', () => { | ||
| const flagWithRef = | ||
| '{"flags":{"fibAlgo":{"variants":{"recursive":"recursive","binet":"binet"},"defaultVariant":"recursive","state":"ENABLED","targeting":{"if":[{"$ref":"emailSuffixFaas"},"binet",null]}}},"$evaluators":{"emailSuffixFaas":{"in":["@faas.com",{"var":["email"]}]}}}'; | ||
| it('should fail if invalid - missing default value', () => { | ||
| const invalidFlag = | ||
| '{\n' + | ||
| ' "flags": {\n' + | ||
| ' "myBoolFlag": {\n' + | ||
| ' "state": "ENABLED",\n' + | ||
| ' "variants": {\n' + | ||
| ' "on": true,\n' + | ||
| ' "off": false\n' + | ||
| ' }\n' + | ||
| ' }\n' + | ||
| ' }\n' + | ||
| '}'; | ||
|
|
||
| const flags = parse(flagWithRef); | ||
| expect(flags).toBeTruthy(); | ||
| expect(() => parse(invalidFlag, false)).toThrowError(); | ||
| }); | ||
|
|
||
| const fibAlgo = flags.get('fibAlgo'); | ||
| expect(fibAlgo).toBeTruthy(); | ||
| expect(fibAlgo?.targeting).toStrictEqual({ if: [{ in: ['@faas.com', { var: ['email'] }] }, 'binet', null] }); | ||
| }); | ||
| it('should parse flag configurations with references', () => { | ||
| const flagWithRef = | ||
| '{"flags":{"fibAlgo":{"variants":{"recursive":"recursive","binet":"binet"},"defaultVariant":"recursive","state":"ENABLED","targeting":{"if":[{"$ref":"emailSuffixFaas"},"binet",null]}}},"$evaluators":{"emailSuffixFaas":{"in":["@faas.com",{"var":["email"]}]}}}'; | ||
|
|
||
| const flags = parse(flagWithRef, false); | ||
| expect(flags).toBeTruthy(); | ||
|
|
||
| const fibAlgo = flags.get('fibAlgo'); | ||
| expect(fibAlgo).toBeTruthy(); | ||
| expect(fibAlgo?.targeting).toStrictEqual({ if: [{ in: ['@faas.com', { var: ['email'] }] }, 'binet', null] }); | ||
| }); | ||
|
|
||
| it('should throw a parsing error due to invalid JSON', () => { | ||
| const invalidJson = '{'; | ||
|
|
||
| expect(() => parse(invalidJson, false)).toThrow(ParseError); | ||
| }); | ||
|
|
||
| it('should throw a parsing error due to invalid flagd configuration', () => { | ||
| const invalidFlagdConfig = '{"flags":{"fibAlgo":{}}}'; | ||
|
|
||
| expect(() => parse(invalidFlagdConfig, false)).toThrow(ParseError); | ||
| }); | ||
|
|
||
| it('should throw a parsing error due to invalid JSON', () => { | ||
| const invalidJson = '{'; | ||
| it('should not throw if targeting invalid', () => { | ||
| const invalidFlag = | ||
| '{\n' + | ||
| ' "flags": {\n' + | ||
| ' "myBoolFlag": {\n' + | ||
| ' "state": "ENABLED",\n' + | ||
| ' "variants": {\n' + | ||
| ' "on": true,\n' + | ||
| ' "off": false\n' + | ||
| ' },\n' + | ||
| ' "defaultVariant": "on",\n' + | ||
| ' "targeting": "invalid"\n' + | ||
| ' }\n' + | ||
| ' }\n' + | ||
| '}'; | ||
|
|
||
| expect(() => parse(invalidJson)).toThrow(ParseError); | ||
| expect(() => parse(invalidFlag, false)).not.toThrow(ParseError); | ||
| }); | ||
| }); | ||
|
|
||
| it('should throw a parsing error due to invalid flagd configuration', () => { | ||
| const invalidFlagdConfig = '{"flags":{"fibAlgo":{}}}'; | ||
| describe('throwIfSchemaInvalid=true', () => { | ||
| it('should not throw if targeting invalid', () => { | ||
| const invalidFlag = | ||
| '{\n' + | ||
| ' "flags": {\n' + | ||
| ' "myBoolFlag": {\n' + | ||
| ' "state": "ENABLED",\n' + | ||
| ' "variants": {\n' + | ||
| ' "on": true,\n' + | ||
| ' "off": false\n' + | ||
| ' },\n' + | ||
| ' "defaultVariant": "on",\n' + | ||
| ' "targeting": "invalid"\n' + | ||
| ' }\n' + | ||
| ' }\n' + | ||
| '}'; | ||
|
|
||
| expect(() => parse(invalidFlagdConfig)).toThrow(ParseError); | ||
| expect(() => parse(invalidFlag, true)).toThrow(ParseError); | ||
| }); | ||
| }); | ||
| }); |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters