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

Allow unknown value data types for VALUE #674

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

heiglandreas
Copy link
Contributor

Currently value-types that are not known will cause the parser to throw an InvalidDataException. In RFC5545, Section 3.2.20 is described though that the allowed values for the "VALUE" data-type can include x-names and iana-tokens. These can be any string that might - or might not - be understood by the parser. The description clearly states that "Applications MUST preserve the value data for x-name and iana-token value that they don't recognize without attempting to interpret or parse the value data"

This means that the content of the "VALUE" part should not be interpreted at all the moment the parser doesn't find a match in the corresponding mapping table.

But it should also not hard-fail when someone sets a VALUE that might not be understood. In such a case the default should be used instead.

Currently value-types that are not known will cause the parser to throw
an InvalidDataException. In RFC5545, Section 3.2.20 is described though
that the allowed values for the "VALUE" data-type can include x-names and
iana-tokens. These can be any string that might - or might not - be
understood by the parser. The description clearly states that
"Applications MUST preserve the value data for x-name and iana-token
value that they don't recognize without attempting to interpret or parse
the value data"

This means that the content of the "VALUE" part should not be
interpreted at all the moment the parser doesn't find a match in the
corresponding mapping table.

But it should also not hard-fail when someone sets a VALUE that might
not be understood. In such a case the default should be used instead.
Copy link

codecov bot commented Sep 10, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 98.78%. Comparing base (57492ab) to head (9e72aca).
Report is 1 commits behind head on master.

Additional details and impacted files
@@             Coverage Diff              @@
##             master     #674      +/-   ##
============================================
+ Coverage     98.76%   98.78%   +0.02%     
+ Complexity     1874     1873       -1     
============================================
  Files            71       71              
  Lines          5343     5268      -75     
============================================
- Hits           5277     5204      -73     
+ Misses           66       64       -2     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@heiglandreas
Copy link
Contributor Author

Background is a feed we got from a server that uses a DTSTAMP;VALUE=DATETIME:20240101T000000Z (note the DATETIME instead of DATE-TIME).

The whole feed looks like this:

BEGIN:VCALENDAR
PRODID;X-RICAL-TZSOURCE=TZINFO:-//Application//Calendar//EN
CALSCALE:GREGORIAN
VERSION:2.0
BEGIN:VEVENT
DTSTAMP;VALUE=DATETIME:20240101T000000Z
DTSTART;VALUE=DATE:20240910
DTEND;VALUE=DATE:20240912
UID:[email protected]
SUMMARY:Summary
END:VEVENT
END:VCALENDAR

Verifying this with the ICS-Validator at https://icalendar.org/validator.html results in "Success! No errors found"

grafik

Yet with the current implementation of the library importing this feed will fail due to the unknown DATETIME value.

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.

1 participant