Merged
Conversation
Currently Cuttlefish does not support string values that include the # character. This character is, however, used every so often in generated passwords, identifiers and other machine-produced values. This PR introduces an alternative value representation: ``` a.setting = 'sdkjf#hsdf$82836867#9237498' ``` ...which allows such values to be escaped using single quotes. Single quotes are NOT supported by these values by design, I do not thing that the \' escaping would be worth our time. This also drops an invalid UTF-8 input test that I could not get to work. Somewhere inside Neotoma a returned error has turned into an exception. Either way, the limited validation for valid UTF-8 characters is still in place. Closes #37. References #31. * Add an integration test for 'escaped values' * One more test case for escaped values * Fix `invalid_utf8_test` test
07e60b7 to
2f3d731
Compare
lukebakken
approved these changes
Aug 5, 2024
Collaborator
lukebakken
left a comment
There was a problem hiding this comment.
I can merge once CI passes. Thanks!
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Problem Definition
Currently Cuttlefish does not support string
values that include the # character.
This character is, however, used every so often
in generated passwords, identifiers, messaging protocol
(AMQP 0-9-1, MQTTv3.1, MQTTv5) routing patterns,
and other (often machine-produced) values.
The Proposed Solution
This PR introduces an alternative value
representation:
which allows such values to be escaped using
single quotes.
Given the following schema file:
{mapping, "escaped.value", "escaped.value", [ {datatype, [string]} ]}. {mapping, "non_escaped.value", "non_escaped.value", [ {datatype, [string]} ]}.and the following
.conffile:Cuttlefish will now produce the following app config file:
Limitations and Caveats
Single quotes are NOT
supported in these escaped values by design,
I do not thing that the
\'escaping wouldbe worth our time. They are not particularly
common in Cuttlefish schemas according to Team RabbitMQ's
extensive experience with various configuration
files in the wild.
Closes #37.
References #31.