64 Character Feature Flag Key Length Limit
Nobody has claimed this yet.
Assessment
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Newbie friendliness
- 45/100
- Issue type
- Documentation
- Clarity
- Mostly clear
- Activity status
- Quiet
- Domain
- documentation, frontend
Research direction
Start with the feature-flags documentation page and reproduce the behavior at /feature-flags/create using the "Flag key*" field. Verify whether 64 characters is the actual limit, then document the limit and recommended workflow; the UI expectations also require clear validation for pasted and typed values beyond the limit.
Written by the indexing model from the issue text.
Description
Documentation Page
https://docs.datadoghq.com/getting_started/feature_flags/
Issue Description
There is no documentation around the character length limit on a Datadog feature flag key. However, in practice, when I tried to create a new feature flag at:
/feature-flags/create
I copy-pasted a flag key value from my code that was greater than 64 characters into the "Flag key*" mandatory field, and the value I pasted was truncated to exactly 64 characters. I then tried appending the missing part to the key, and no further characters were added.
Based on the above behaviour, I conclude that Datadog has a 64 character limit on key length. I figure this because otherwise, it's a pretty big coincidence that Datadog accidentally prevents me creating a key with more than exactly 64 characters; 64 being a popular number in computers. However, I'll admit that my conclusion may be wrong, and in that case, the rest of this issue isn't really applicable. Instead, the issue would be a proper bug in the feature flagging system.
Expectations
- The 64 character key length should be documented.
- Users should be encourages to create a key first in Datadog, and then use that key in code => This would avoid people shipping code with an oversized key and then having to submit a subsequent PR to fix it.
- When the user tries to paste a value of 65 or more characters into "Flag key*", the UI should clearly reject it with a validation error indicating that the maximum key length of 64 cannot be exceeded.
- When the user tries to type more characters into "Flag key*", after 64 characters are already in there, the UI should clearly reject the additional keystrokes with a validation error indicating that the maximum key length of 64 cannot be exceeded.
The final two points are not strictly documentation issues; they are POLA violations in the UI. But it's all related.
- Dominant language
- JavaScript
- Stars
- 618
- Forks
- 1.3k
- Avg merge
- 2d 9h
- Merged PRs (30d)
- 482
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from DataDog/documentation
-
Difficulty 2/5 1-3 hours Newbie friendliness 76/100
DataDog/documentation#39746 · 1 reaction ·
-
Difficulty 1/5 1-3 hours Newbie friendliness 86/100
DataDog/documentation#38651 · 1 comment ·
-
Difficulty 1/5 Under an hour Newbie friendliness 85/100
DataDog/documentation#37078 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
DataDog/documentation#36762 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 76/100
DataDog/documentation#36300 · 1 comment ·
All issues in DataDog/documentation
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
-
area-deployment area-integrations triage:bot-seen
Difficulty 2/5 Half a day Newbie friendliness 86/100
-
Issue-Bug
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
sugarlabs/musicblocks#8924 ·
-
Difficulty 1/5 Under an hour Newbie friendliness 90/100
ArduPilot/ardupilot_wiki#8088 ·
-
[BUG] createTool tools cannot be registered with Mastra when exactOptionalPropertyTypes is enabled Opencustomer-eng status: needs triage
Difficulty 2/5 1-3 hours Newbie friendliness 84/100