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.

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

stringify: do not use unescapedIndexOf in property parameters #658

Merged

Conversation

dilyanpalauzov
Copy link
Contributor

… as \ is no escape character there. When the propery parameter contains :, then it must be quoted, the colon cannot be escaped.

As the function stringify.propertyValue in fact stringifies property parameter values, it is renamed accordingly.

This supersedes #535 and updates #555.

Without these changes, the herein added test fails:

1) ICAL.stringify
     stringify property
       stringify property value containing "escaped" ; , ::

    AssertionError: expected 'ATTENDEE;CN=X\::mailto:id' to equal 'ATTENDEE;CN="X\:":mailto:id'
    + expected - actual

    -ATTENDEE;CN=X\::mailto:id
    +ATTENDEE;CN="X\:":mailto:id

@coveralls
Copy link

coveralls commented Apr 9, 2024

Pull Request Test Coverage Report for Build 8676344112

Details

  • 4 of 4 (100.0%) changed or added relevant lines in 1 file are covered.
  • No unchanged relevant lines lost coverage.
  • Overall coverage decreased (-0.001%) to 98.024%

Totals Coverage Status
Change from base Build 8676316098: -0.001%
Covered Lines: 9288
Relevant Lines: 9459

💛 - Coveralls

test/stringify_test.js Outdated Show resolved Hide resolved
dilyanpalauzov added a commit to dilyanpalauzov/ical.js that referenced this pull request Apr 13, 2024
… as \ is no escape character there.  When the propery parameter
contains :, then it must be quoted, the colon cannot be escaped.

As the function stringify.propertyValue in fact stringifies
property parameter values, it is renamed accordingly.

kewisch#658

This supersedes kewisch#535
and updates kewisch#555 .

Without these changes, the herein added test fails:

1) ICAL.stringify
     stringify property
            stringify property value containing "escaped" ; , ::

    AssertionError: expected 'ATTENDEE;CN=X\::mailto:id' to equal 'ATTENDEE;CN="X\:":mailto:id'
        + expected - actual

    -ATTENDEE;CN=X\::mailto:id
        +ATTENDEE;CN="X\:":mailto:id
* @param {String} value Raw property value
* @param {boolean} force If value should be escaped even when unnecessary
* @return {String} Given or escaped value when needed
*/
stringify.paramPropertyValue = function(value, force) {
stringify.propertyParameterValue = function(value, force) {
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This would break the API and we'd have to bump the major version to be true to semver. I'd suggest we avoid that for now.

Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Noted this for later in #663

… as \ is no escape character there.  When the propery parameter
contains :, then it must be quoted, the colon cannot be escaped.
@kewisch kewisch force-pushed the stringify_propertyParameterValue_escape2 branch from 5696750 to c38ddae Compare April 13, 2024 21:21
@kewisch kewisch merged commit 722e144 into kewisch:main Apr 13, 2024
7 checks passed
dilyanpalauzov added a commit to dilyanpalauzov/ical.js that referenced this pull request Apr 14, 2024
@dilyanpalauzov dilyanpalauzov deleted the stringify_propertyParameterValue_escape2 branch April 14, 2024 13:08
dilyanpalauzov added a commit to dilyanpalauzov/ical.js that referenced this pull request Apr 20, 2024
… as \ is no escape character there.  When the propery parameter
contains :, then it must be quoted, the colon cannot be escaped.

As the function stringify.propertyValue in fact stringifies
property parameter values, it is renamed accordingly.

kewisch#658

This supersedes kewisch#535
and updates kewisch#555 .

Without these changes, the herein added test fails:

1) ICAL.stringify
     stringify property
            stringify property value containing "escaped" ; , ::

    AssertionError: expected 'ATTENDEE;CN=X\::mailto:id' to equal 'ATTENDEE;CN="X\:":mailto:id'
        + expected - actual

    -ATTENDEE;CN=X\::mailto:id
        +ATTENDEE;CN="X\:":mailto:id
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants