-
Notifications
You must be signed in to change notification settings - Fork 1.2k
refactor: replace cjson with internal comment-stripping JSON parser #10662
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
joehan
wants to merge
1
commit into
main
Choose a base branch
from
joehan/remove-cjson
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+40
−49
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
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
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,16 +1,30 @@ | ||
| import * as fs from "fs"; | ||
| import { FirebaseError } from "./error"; | ||
| import * as cjson from "cjson"; | ||
|
|
||
| /** | ||
| * Loads CJSON from given path. | ||
| */ | ||
| export function loadCJSON(path: string): any { | ||
| let content: string; | ||
| try { | ||
| return cjson.load(path); | ||
| content = fs.readFileSync(path, "utf8"); | ||
| } catch (e: any) { | ||
| if (e.code === "ENOENT") { | ||
| throw new FirebaseError(`File ${path} does not exist`); | ||
| } | ||
| throw e; | ||
| } | ||
|
|
||
| try { | ||
| const stripped = content.replace( | ||
| /("([^"\\]|\\.)*")|(\/\*[\s\S]*?\*\/|\/\/.*)/g, | ||
| (match, string) => { | ||
| if (string) return string; | ||
| return ""; | ||
| }, | ||
| ); | ||
| return JSON.parse(stripped); | ||
| } catch (e: any) { | ||
| throw new FirebaseError(`Parse Error in ${path}:\n\n${e.message}`); | ||
| } | ||
| } | ||
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,11 @@ | ||
| { | ||
| // Line comment at start | ||
| "url": "https://example.com/foo", | ||
| "comment_in_string": "this is // not a comment", | ||
| "block_in_string": "this is /* not a block */ comment", | ||
| /* Multi-line | ||
| block comment */ | ||
| "nested": { | ||
| "key": "value" // trailing line comment | ||
| } | ||
| } |
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Issue: Critical Bug with Empty Strings
""The current implementation of the comment-stripping parser has a critical bug when parsing empty strings
""in JSON.In the replacement callback:
The parameter
stringcorresponds to the first capture group("([^"\\]|\\.)*"). When the parser encounters an empty string"", the captured value is"". Since""is a falsy value in JavaScript,if (string)evaluates tofalse, causing the function to return""(which is treated as a comment removal).This results in the empty string being completely stripped from the JSON, leading to invalid JSON and a
SyntaxErrorduringJSON.parse. For example,{"key": ""}becomes{"key": }, which fails to parse.Suggestion: Preserve Line Numbers & Fix Empty Strings
We can fix this bug by explicitly checking if
quotedStringis notundefined.Additionally, we can improve error reporting by replacing comments with spaces/newlines instead of an empty string
"". This preserves the exact line and column numbers of the original file, making any JSON parsing error messages much more accurate and helpful.