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.

Sign up for GitHub

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

Jump to bottom

feat!: make error code an enum and include optional error message #142

Merged
merged 14 commits into from
Sep 27, 2022
Merged

feat!: make error code an enum and include optional error message #142

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
14 commits
Select commit Hold shift + click to select a range
d5f5128
Add INVALID_CONTEXT error code.
kinyoklion Sep 23, 2022
886ec0b
Merge branch 'main' into rlamb/invalid-context
kinyoklion Sep 23, 2022
24dba1a
Enumerate error codes in a table. Link to error codes from flag evalu…
kinyoklion Sep 23, 2022
833af07
Update json specification.
kinyoklion Sep 23, 2022
19d0620
Linting updates.
kinyoklion Sep 23, 2022
2b23695
Change 'error codes' to 'error code'.
kinyoklion Sep 23, 2022
3db6249
Remove inadverant pipe on note.
kinyoklion Sep 23, 2022
f8f17d7
Remove the enumerated values from 2.8 and reference the error code type.
kinyoklion Sep 26, 2022
fcbcb00
Update spec JSON.
kinyoklion Sep 26, 2022
fec8633
Change 1.4.7 to use an error code instead of a string.
kinyoklion Sep 26, 2022
5c93e9b
Add requirement for error message.
kinyoklion Sep 26, 2022
0e4007b
Update specification/sections/01-flag-evaluation.md
kinyoklion Sep 26, 2022
766164f
Update specficiation.json, extend 2.8 with optional error message.
kinyoklion Sep 26, 2022
a0ee5b1
Add example exception.
kinyoklion Sep 26, 2022
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
2 changes: 1 addition & 1 deletion specification.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -237,7 +237,7 @@
{
"id": "Requirement 2.8",
"machine_id": "requirement_2_8",
"content": "In cases of abnormal execution, the `provider` MUST indicate an error using the idioms of the implementation language, with an associated error code having possible values `\"PROVIDER_NOT_READY\"`, `\"FLAG_NOT_FOUND\"`, `\"PARSE_ERROR\"`, `\"TYPE_MISMATCH\"`, or `\"GENERAL\"`.",
"content": "In cases of abnormal execution, the `provider` MUST indicate an error using the idioms of the implementation language, with an associated error code having possible values `\"PROVIDER_NOT_READY\"`, `\"FLAG_NOT_FOUND\"`, `\"PARSE_ERROR\"`, `\"TYPE_MISMATCH\"`, `\"INVALID_CONTEXT\"`, or `\"GENERAL\"`.",
"RFC 2119 keyword": "MUST",
"children": []
},
Expand Down
2 changes: 1 addition & 1 deletion specification/sections/01-flag-evaluation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -187,7 +187,7 @@ FlagEvaluationDetails<MyStruct> myStructDetails = client.getObjectDetails<MyStru

> In cases of abnormal execution, the `evaluation details` structure's `error code` field **MUST** contain a string identifying an error occurred during flag evaluation and the nature of the error.

Some example error codes include: `"TARGETING_KEY_MISSING"`, `"PROVIDER_NOT_READY"`, `"FLAG_NOT_FOUND"`, `"PARSE_ERROR"`, `"TYPE_MISMATCH"`, or `"GENERAL"`.
Some example error codes include: `"TARGETING_KEY_MISSING"`, `"PROVIDER_NOT_READY"`, `"FLAG_NOT_FOUND"`, `"PARSE_ERROR"`, `"TYPE_MISMATCH"`, `"INVALID_CONTEXT"`, or `"GENERAL"`.
kinyoklion marked this conversation as resolved.
Show resolved Hide resolved

##### Requirement 1.4.8

Expand Down
2 changes: 1 addition & 1 deletion specification/sections/02-providers.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,7 @@ Possible values vary by provider, but might include such values as `"TARGETING_M

##### Requirement 2.8

> In cases of abnormal execution, the `provider` **MUST** indicate an error using the idioms of the implementation language, with an associated error code having possible values `"PROVIDER_NOT_READY"`, `"FLAG_NOT_FOUND"`, `"PARSE_ERROR"`, `"TYPE_MISMATCH"`, or `"GENERAL"`.
> In cases of abnormal execution, the `provider` **MUST** indicate an error using the idioms of the implementation language, with an associated error code having possible values `"PROVIDER_NOT_READY"`, `"FLAG_NOT_FOUND"`, `"PARSE_ERROR"`, `"TYPE_MISMATCH"`, `"INVALID_CONTEXT"`, or `"GENERAL"`.

The provider might throw an exception, return an error, or populate the `error code` object on the returned `flag resolution` structure to indicate a problem during flag value resolution.

Expand Down