Skip to content

fix(core-tools): resolve Jupyter Notebook and JSON corruption in write_file #28000

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.

Sign up for GitHub

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

Closed
amelidev wants to merge 12 commits into from
+192 −28
Closed

fix(core-tools): resolve Jupyter Notebook and JSON corruption in write_file #28000

Show file tree
Hide file tree
Changes from 9 commits
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
fe7d77d
fix(core-tools): resolve Jupyter Notebook and JSON corruption in writ…
amelidev Jun 18, 2026
12a68e4
Update packages/core/src/tools/write-file.ts
amelidev Jun 18, 2026
08559eb
Update packages/core/src/tools/write-file.ts
amelidev Jun 18, 2026
ff8ea46
fix(core-tools): expand write_file JSON/YAML/TOML safe formats per co…
amelidev Jun 18, 2026
09462ef
Update packages/core/src/tools/write-file.ts
amelidev Jun 19, 2026
1a7cb75
Merge branch 'main' into b_446760218
amelidev Jun 19, 2026
aef101b
Merge branch 'main' into b_446760218
amelidev Jun 22, 2026
043016a
fix(core-tools): expand protected config files to include env, lock, …
amelidev Jun 22, 2026
eb66932
Update packages/core/src/tools/write-file.ts
amelidev Jun 22, 2026
58ff7f2
fix(core-tools): safeguard XML, SVG, CSV, HCL, and Terraform files
amelidev Jun 22, 2026
d8f2878
fix(core-tools): resolve code review comments on editCorrector saniti…
amelidev Jun 22, 2026
7e9a1b3
Update packages/core/src/utils/editCorrector.ts
amelidev Jun 22, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 2 additions & 26 deletions package-lock.json
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

49 changes: 49 additions & 0 deletions packages/core/src/tools/write-file.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -356,6 +356,7 @@ describe('WriteFileTool', () => {
abortSignal,
true,
true, // aggressiveUnescape
false, // isJsonLike
);
expect(result.correctedContent).toBe(correctedContent);
expect(result.originalContent).toBe('');
Expand Down Expand Up @@ -389,9 +390,50 @@ describe('WriteFileTool', () => {
abortSignal,
true,
false, // aggressiveUnescape
false, // isJsonLike
);
});

it('should set isJsonLike to true and aggressiveUnescape to false for .ipynb, .json, map, yaml, toml, and common JSON-based dotfiles', async () => {
const abortSignal = new AbortController().signal;
const filesToTest = [
'notebook.ipynb',
'data.json',
'bundle.js.map',
'workflow.yaml',
'config.yml',
'Cargo.toml',
'.eslintrc',
'.prettierrc',
'.env',
'.env.local',
'config.ini',
'.gitconfig',
];
Comment thread
amelidev marked this conversation as resolved.
Comment thread
amelidev marked this conversation as resolved.
Comment on lines +397 to +422

@gemini-code-assist gemini-code-assist Bot Jun 22, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

high

We should update the test suite to verify that the newly added structured formats (XML, SVG, CSV, TSV, Terraform/HCL, Terraform state, and Web App Manifests) are also correctly identified as isJsonLike and bypass aggressive unescaping.

    it('should set isJsonLike to true and aggressiveUnescape to false for .ipynb, .json, map, yaml, toml, and common JSON-based dotfiles', async () => {
      const abortSignal = new AbortController().signal;
      const filesToTest = [
        'notebook.ipynb',
        'data.json',
        'bundle.js.map',
        'workflow.yaml',
        'config.yml',
        'Cargo.toml',
        '.eslintrc',
        '.prettierrc',
        '.env',
        '.env.local',
        'config.ini',
        '.gitconfig',
        'data.xml',
        'image.svg',
        'data.csv',
        'data.tsv',
        'main.tf',
        'terraform.tfvars',
        'config.hcl',
        'terraform.tfstate',
        'manifest.webmanifest',
      ];


for (const file of filesToTest) {
mockEnsureCorrectFileContent.mockClear();
mockEnsureCorrectFileContent.mockResolvedValue('content');

const filePath = path.join(rootDir, file);
await getCorrectedFileContent(
mockConfig,
filePath,
'content',
abortSignal,
);

expect(mockEnsureCorrectFileContent).toHaveBeenCalledWith(
'content',
mockBaseLlmClientInstance,
abortSignal,
true,
false, // aggressiveUnescape
true, // isJsonLike
);
}
});

it('should call ensureCorrectFileContent for an existing file', async () => {
const filePath = path.join(rootDir, 'existing_corrected_file.txt');
const originalContent = 'Original existing content.';
Expand All @@ -416,6 +458,7 @@ describe('WriteFileTool', () => {
abortSignal,
true,
true, // aggressiveUnescape
false, // isJsonLike
);
expect(result.correctedContent).toBe(correctedProposedContent);
expect(result.originalContent).toBe(originalContent);
Expand Down Expand Up @@ -493,6 +536,7 @@ describe('WriteFileTool', () => {
abortSignal,
true,
true, // aggressiveUnescape
false, // isJsonLike
);
expect(confirmation).toEqual(
expect.objectContaining({
Expand Down Expand Up @@ -531,6 +575,7 @@ describe('WriteFileTool', () => {
abortSignal,
true,
true, // aggressiveUnescape
false, // isJsonLike
);
expect(confirmation).toEqual(
expect.objectContaining({
Expand Down Expand Up @@ -737,6 +782,7 @@ describe('WriteFileTool', () => {
abortSignal,
true,
true, // aggressiveUnescape
false, // isJsonLike
);
expect(result.llmContent).toMatch(
/Successfully created and wrote to new file/,
Expand Down Expand Up @@ -782,6 +828,7 @@ describe('WriteFileTool', () => {
abortSignal,
true,
true, // aggressiveUnescape
false, // isJsonLike
);
expect(result.llmContent).toMatch(/Successfully overwrote file/);
const writtenContent = await fsService.readTextFile(filePath);
Expand Down Expand Up @@ -1052,6 +1099,7 @@ describe('WriteFileTool', () => {
abortSignal,
true,
true, // aggressiveUnescape
false, // isJsonLike
);
expect(result.correctedContent).toBe(proposedContent);
expect(result.fileExists).toBe(false);
Expand Down Expand Up @@ -1080,6 +1128,7 @@ describe('WriteFileTool', () => {
abortSignal,
true,
true, // aggressiveUnescape
false, // isJsonLike
);
expect(result.correctedContent).toBe(proposedContent);
expect(result.originalContent).toBe(originalContent);
Expand Down
37 changes: 36 additions & 1 deletion packages/core/src/tools/write-file.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -131,14 +131,49 @@ export async function getCorrectedFileContent(
}
}

const aggressiveUnescape = !isGemini3Model(config.getActiveModel());
const fileExtension = path.extname(filePath).toLowerCase();
const fileName = path.basename(filePath).toLowerCase();

const isJsonLike =
fileExtension.includes('json') ||
fileExtension === '.ipynb' ||
fileExtension === '.map' ||
fileExtension === '.yaml' ||
fileExtension === '.yml' ||
fileExtension === '.toml' ||
fileExtension === '.lock' ||
fileExtension === '.ini' ||
Comment thread
amelidev marked this conversation as resolved.
fileExtension === '.properties' ||
fileExtension === '.cfg' ||
fileExtension === '.conf' ||
fileExtension === '.config' ||
fileName.startsWith('.env') ||
Comment thread
amelidev marked this conversation as resolved.
[
'.eslintrc',
'.babelrc',
'.prettierrc',
'.stylelintrc',
'.watchmanconfig',
'.nycrc',
'.releaserc',
'.gitconfig',
'.editorconfig',
'.npmrc',
'.yarnrc',
'.jshintrc',
'.markdownlintrc',
].includes(fileName);
Comment thread
amelidev marked this conversation as resolved.
Comment thread
amelidev marked this conversation as resolved.
Comment on lines +137 to +175

@gemini-code-assist gemini-code-assist Bot Jun 22, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

high

To prevent silent corruption of other highly structured data and configuration formats, we should expand the isJsonLike check to cover additional common formats such as XML, SVG, CSV, TSV, Terraform/HCL (.tf, .tfvars, .hcl), Terraform state (.tfstate), and Web App Manifests (.webmanifest). These formats are equally vulnerable to aggressive unescaping corruption (e.g., breaking escaped quotes in CSV/TSV or XML attributes).

  const isJsonLike =
    fileExtension.includes('json') ||
    fileExtension === '.ipynb' ||
    fileExtension === '.map' ||
    fileExtension === '.yaml' ||
    fileExtension === '.yml' ||
    fileExtension === '.toml' ||
    fileExtension === '.lock' ||
    fileExtension === '.ini' ||
    fileExtension === '.properties' ||
    fileExtension === '.cfg' ||
    fileExtension === '.conf' ||
    fileExtension === '.config' ||
    fileExtension === '.xml' ||
    fileExtension === '.svg' ||
    fileExtension === '.csv' ||
    fileExtension === '.tsv' ||
    fileExtension === '.tf' ||
    fileExtension === '.tfvars' ||
    fileExtension === '.hcl' ||
    fileExtension === '.tfstate' ||
    fileExtension === '.webmanifest' ||
    fileName.startsWith('.env') ||
    [
      '.eslintrc',
      '.babelrc',
      '.prettierrc',
      '.stylelintrc',
      '.watchmanconfig',
      '.nycrc',
      '.releaserc',
      '.gitconfig',
      '.editorconfig',
      '.npmrc',
      '.yarnrc',
      '.jshintrc',
      '.markdownlintrc',
    ].includes(fileName);


const aggressiveUnescape =
!isJsonLike && !isGemini3Model(config.getActiveModel());

correctedContent = await ensureCorrectFileContent(
proposedContent,
config.getBaseLlmClient(),
abortSignal,
config.getDisableLLMCorrection(),
aggressiveUnescape,
isJsonLike,
);

return { originalContent, correctedContent, fileExists };
Expand Down
Loading
Loading