Skip to content

Improve error handling for malformed JSON syntax #13

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

Open
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

Copilot
Copy link
Contributor

@Copilot Copilot AI commented Aug 4, 2025

Fixes #12 by properly distinguishing between malformed JSON (invalid syntax) and partial JSON (incomplete but valid syntax).

Problem

The parser was silently swallowing invalid JSON syntax instead of throwing errors:

  1. Invalid numbers starting with dots - .0516156161551515 would be silently ignored, causing the rest of valid JSON to be discarded
  2. Invalid tokens in arrays - [abc would return [] instead of throwing an error
  3. Empty arrays with spaces - [ ] would cause parsing to terminate early, discarding subsequent valid JSON

Example

Before this fix:

parse(`{
  "vector": [1, 2, 3, .0516156161551515, 7],
  "info": "valid data"
}`)
// Returns: { "vector": [1, 2, 3] }  // Silent truncation!

After this fix:

parse(`{
  "vector": [1, 2, 3, .0516156161551515, 7],  
  "info": "valid data"
}`)
// Throws: MalformedJSON: Unexpected token '.' at position 83

Solution

  1. Enhanced token validation - Added proper validation before attempting to parse numbers, rejecting invalid tokens like .123 and abc

  2. Improved array parsing - Fixed whitespace handling in arrays by adding skipBlank() calls at appropriate points

  3. Better error propagation - Modified parseArr() and parseObj() to let MalformedJSON errors bubble up while still allowing PartialJSON errors to be handled gracefully for incomplete but valid JSON

Backward Compatibility

✅ All existing functionality is preserved:

  • Valid partial JSON parsing continues to work exactly as before
  • All existing tests pass without modification
  • The Allow flags continue to control partial parsing behavior as expected

This change only affects clearly invalid JSON syntax that should never have been accepted in the first place.


💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.

Summary by CodeRabbit

  • Bug Fixes

    • Improved error handling for malformed JSON, ensuring invalid numbers and tokens are correctly identified and reported.
    • Enhanced whitespace handling within arrays to ensure accurate parsing.
  • Tests

    • Added comprehensive test cases to verify correct error reporting for invalid JSON inputs and to confirm proper handling of edge cases.

Copy link

vercel bot commented Aug 4, 2025

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
partial-json-coverage ✅ Ready (Inspect) Visit Preview 💬 Add feedback Aug 4, 2025 10:28pm

Copy link

Review PR in StackBlitz Codeflow Run & review this pull request in StackBlitz Codeflow.

@Copilot Copilot AI changed the title [WIP] Fix @promplate/partial-json-parser-js/issues/12 Fix issue #12: Improve error handling for malformed JSON syntax Aug 4, 2025
Copilot finished work on behalf of CNSeniorious000 August 4, 2025 03:34
@Copilot Copilot AI requested a review from CNSeniorious000 August 4, 2025 03:34
Copy link

pkg-pr-new bot commented Aug 4, 2025

Open in StackBlitz

npm i https://pkg.pr.new/promplate/partial-json-parser-js/partial-json@13

commit: 9b6e38e

@CNSeniorious000 CNSeniorious000 marked this pull request as ready for review August 4, 2025 20:58
@CNSeniorious000
Copy link
Member

@coderabbitai review

Copy link

coderabbitai bot commented Aug 4, 2025

✅ Actions performed

Review triggered.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

Copy link

coderabbitai bot commented Aug 4, 2025

Walkthrough

The changes improve JSON parsing by enhancing error handling for malformed numbers and invalid tokens, ensuring that syntax errors are no longer silently ignored. The parser now strictly validates number formats, propagates MalformedJSON errors, and adds new tests to verify that invalid input triggers errors rather than partial or incorrect parsing results.

Changes

Cohort / File(s) Change Summary
Parser Logic Improvements
src/index.ts
Refines error handling in JSON parsing: validates number start tokens, ensures MalformedJSON errors propagate, improves whitespace skipping in arrays, and makes number parsing stricter and more robust.
Tests for Issue #12
tests/issue12.test.js
Adds tests for invalid numbers and tokens, confirming that malformed input now throws MalformedJSON errors as expected and valid edge cases still parse correctly.

Sequence Diagram(s)

sequenceDiagram
    participant TestSuite as Test Suite
    participant Parser as JSON Parser
    participant Error as MalformedJSON

    TestSuite->>Parser: parse(JSON string)
    alt Valid JSON
        Parser-->>TestSuite: Return parsed object/array
    else Invalid number or token
        Parser-->>Error: Throw MalformedJSON
        Error-->>TestSuite: Error is caught and asserted
    end
Loading

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~8 minutes

Assessment against linked issues

Objective Addressed Explanation
Ensure parser throws error for invalid numbers instead of silently ignoring them (#12)
Prevent partial parsing when encountering malformed numbers or invalid tokens in arrays/objects (#12)
Add tests to verify error reporting for invalid number formats and tokens (#12)

Poem

A rabbit with code in its fur and its nose,
Digs through the JSON where error now shows.
No more silent skipping, no numbers astray—
Malformed tokens are caught, no data goes away!
With tests in the meadow and parsing made bright,
The bugs hop away, and the code feels just right.
🐇✨

Note

⚡️ Unit Test Generation is now available in beta!

Learn more here, or try it out under "Finishing Touches" below.

✨ Finishing Touches
  • 📝 Generate Docstrings
🧪 Generate unit tests
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch copilot/fix-d63c1154-0fba-4921-80da-192e5f9b9723

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.
  • 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.

Support

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

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 generate unit tests to generate unit tests for 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.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

🧹 Nitpick comments (1)
tests/issue12.test.js (1)

15-19: Consider adding more invalid token test cases

The tests correctly verify that invalid tokens throw errors. Consider adding more edge cases for completeness.

 test("issue #12 - invalid tokens should throw error instead of returning empty", () => {
     // Should throw error instead of returning []
     expect(() => parse("[abc")).toThrow(MalformedJSON);
     expect(() => parse("[invalid")).toThrow(MalformedJSON);
+    expect(() => parse("{abc}")).toThrow(MalformedJSON);
+    expect(() => parse("[#invalid]")).toThrow(MalformedJSON);
+    expect(() => parse("[.abc]")).toThrow(MalformedJSON);
 });
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 5eb1039 and b029d41.

📒 Files selected for processing (2)
  • src/index.ts (4 hunks)
  • tests/issue12.test.js (1 hunks)
🔇 Additional comments (8)
src/index.ts (5)

117-131: Good error propagation pattern

The explicit re-throwing of MalformedJSON errors ensures they bubble up correctly without being masked by the partial parsing logic.


141-149: Improved whitespace handling in arrays

The addition of skipBlank() calls ensures proper handling of whitespace in arrays, fixing the issue where empty arrays with spaces would cause parsing failures.


153-156: Consistent error propagation in array parsing

The error handling matches the pattern used in parseObj, ensuring MalformedJSON errors bubble up correctly.


191-203: Robust partial number parsing

The improved error handling for partial numbers is more explicit and maintains backward compatibility while properly reporting malformed JSON.


68-75: Fix variable shadowing in error message

The implementation correctly validates number tokens before parsing. However, the error message on line 74 uses char which shadows the const declaration.

-        throwMalformedError(`Unexpected token '${char}'`);
+        throwMalformedError(`Unexpected token '${jsonString[index]}'`);

Likely an incorrect or invalid review comment.

tests/issue12.test.js (3)

4-13: Comprehensive test coverage for invalid number formats

The tests effectively cover the main issue from #12, verifying that numbers starting with dots throw MalformedJSON errors in various contexts.


21-34: Well-structured test for whitespace handling

The test effectively verifies that empty arrays with spaces are handled correctly and don't interrupt the parsing of subsequent elements.


36-43: Good regression test coverage

The tests ensure that valid JSON continues to parse correctly after the error handling improvements, preventing regressions.

@CNSeniorious000 CNSeniorious000 changed the title Fix issue #12: Improve error handling for malformed JSON syntax Improve error handling for malformed JSON syntax Aug 4, 2025
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.

Invalid number swallowed without any error
2 participants