Skip to content

Two bugs of iCal parsing was fixed#424

Merged
Ellerbach merged 1 commit intonanoframework:mainfrom
Naglfario:fix_icalendar_parsing
Jul 7, 2025
Merged

Two bugs of iCal parsing was fixed#424
Ellerbach merged 1 commit intonanoframework:mainfrom
Naglfario:fix_icalendar_parsing

Conversation

@Naglfario
Copy link
Contributor

@Naglfario Naglfario commented Jul 5, 2025

Description

  • In the iCal parser (DateTimeExtensions.FromiCalendar), before creating a DateTime, the constructor parameters are now validated. Year, month, day, hour, minutes, seconds. If at least one parameter is out of bounds or is not a number, DateTime.MaxValue is returned.
  • In the iCal parser (DateTimeExtensions.FromiCalendar), when converting a date to UTC, DateTime is now initialized with a ticks count = ticks from the existing date. Previously, date was initialized with zero ticks, and then ticks from existing date were added to it. Previously, this led to an exception, since initialization with zero ticks actually resulted in DateTime.MinValue = 1600-01-01 00:00:00 being created. If you then add ticks from 2025 to such a date, for example, you get a date from 3625 and this value is outside DateTime range since nanoFramework has a limitation, the year of DateTime cannot be >= 3001

Motivation and Context

I noticed that when trying to deserialize a string containing many digits (18 or more), I often see exceptions in the debug output console, but this does not interfere with deserialization as such. After investigating, I found that the problem occurs when JsonConvert tries to figure out whether string can be a date in iCal or vCal format.

Inside this code, there is an attempt to convert string, if it is numeric, into a date, passing each individual parameter from the year to the seconds as an integer number, but before passing numbers to DateTime constructor, it was not checked before - and whether these numbers can be a year, month, day, and so on. Thus, for example, it could try to create a date with a month = 99.

In addition, there was another bug. It consists in the fact that if at the end of iCal string date there is Z letter, i.e. pointer to time in UTC format, first it creates MinValue date with DateTimeKind.UTC, and then ticks from date already obtained at the previous stage were added to created MinValue date. This led to an error, because DateTime.MinValue in nanoFramework = 1600-01-01, not a first year, as in the "big .NET"

How Has This Been Tested?

Unit tests were written to test the changes, most of which were not passed before the changes were made. After I fixed bugs, I ran the tests again and they passed.

I did not test the changes on real hardware.

I did not run benchmark tests.

Screenshots

Types of changes

  • Improvement (non-breaking change that improves a feature, code or algorithm)
  • Bug fix (non-breaking change which fixes an issue with code or algorithm)
  • New feature (non-breaking change which adds functionality to code)
  • Breaking change (fix or feature that would cause existing functionality to change)
  • Config and build (change in the configuration and build system, has no impact on code or features)
  • Dependencies (update dependencies and changes associated, has no impact on code or features)
  • Unit Tests (add new Unit Test(s) or improved existing one(s), has no impact on code or features)
  • Documentation (changes or updates in the documentation, has no impact on code or features)

Checklist:

  • My code follows the code style of this project (only if there are changes in source code).
  • My changes require an update to the documentation (there are changes that require the docs website to be updated).
  • I have updated the documentation accordingly (the changes require an update on the docs in this repo).
  • I have read the CONTRIBUTING document.
  • I have tested everything locally and all new and existing tests passed (only if there are changes in source code).
  • I have added new tests to cover my changes.

@nfbot nfbot added Type: Bug Something isn't working Type: Unit Tests labels Jul 5, 2025
@coderabbitai
Copy link

coderabbitai bot commented Jul 5, 2025

Important

Review skipped

Review was skipped due to path filters

⛔ Files ignored due to path filters (3)
  • nanoFramework.Json.Test/DateTimeExtensionsTests.cs is excluded by none and included by none
  • nanoFramework.Json.Test/nanoFramework.Json.Test.nfproj is excluded by none and included by none
  • nanoFramework.Json/TimeExtensions.cs is excluded by none and included by none

CodeRabbit blocks several paths by default. You can override this behavior by explicitly including those paths in the path filters. For example, including **/dist/** will override the default block on the dist directory, by removing the pattern from both the lists.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.


Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Explain this complex logic.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai explain this code block.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and explain its main purpose.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@Naglfario
Copy link
Contributor Author

@dotnet-policy-service agree

@Naglfario
Copy link
Contributor Author

@Naglfario the command you issued was incorrect. Please try again.

Examples are:

@dotnet-policy-service agree

and

@dotnet-policy-service agree company="your company"

@dotnet-policy-service agree

Copy link
Member

@Ellerbach Ellerbach left a comment

Choose a reason for hiding this comment

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

Thanks a lot, looks all good. Great you added tests as well.

Copy link
Member

@josesimoes josesimoes left a comment

Choose a reason for hiding this comment

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

LGTM!

@josesimoes
Copy link
Member

/azp run

@azure-pipelines
Copy link

Azure Pipelines successfully started running 1 pipeline(s).

@josesimoes
Copy link
Member

/azp run

@azure-pipelines
Copy link

Azure Pipelines successfully started running 1 pipeline(s).

@Ellerbach
Copy link
Member

@Naglfario the pipeline failure are not yours. They're on the hardware device side.
@josesimoes , I'll go ahead and merge!

@Ellerbach Ellerbach merged commit bdbad0d into nanoframework:main Jul 7, 2025
10 of 16 checks passed
@nfbot
Copy link
Member

nfbot commented Jul 7, 2025

@Naglfario thank you again for your contribution! 🙏😄

.NET nanoFramework is all about community involvement, and no contribution is too small.
We would like to invite you to join the project's Contributors list.

Please edit it and add an entry with your GitHub username in the appropriate location (names are sorted alphabetically):

  <tr>
    <td><img src="https://github.com/Naglfario.png?size=50" height="50" width="50" ></td>
    <td><a href="https://github.com/Naglfario"></a></td>
  </tr>

(Feel free to adjust your name if it's not correct)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Type: Bug Something isn't working Type: Unit Tests

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants