Skip to content

Commit 3e54be3

Browse files
andreiborzaandreiborza
authored
fix(android,flutter): Preserve CRLF line endings when present (#1253)
* fix(android,flutter): Preserve CRLF line endings when present This PR fixes mixed line endinges when the wizard modifies files that have CRLF (\r\n) line endings. Previously we would always append LF (\n), thus mixing line endings, causing issues on platforms that use CRLF. It adds a `fixLineEndings()` post-processing step for Android and Flutter wizards that detects modified files with CRLF and normalizes any LF to CRLF. Other wizards use proper formatters or don't suffer from this issue. Closes: #1249 * Run line fixing after mcp step for flutter * Only apply this fix to known file types * Ensure we continue after converting the test app to crlf makes the repo dirty
1 parent 109b8e2 commit 3e54be3

5 files changed

Lines changed: 254 additions & 0 deletions

File tree

‎e2e-tests/tests/flutter.test.ts‎

Lines changed: 87 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
import * as fs from 'node:fs';
2+
import * as path from 'node:path';
23
import { Integration } from '../../lib/Constants';
34
import { createIsolatedTestEnv, getWizardCommand } from '../utils';
45
import {
@@ -159,4 +160,90 @@ describe('Flutter', () => {
159160
);
160161
});
161162
});
163+
164+
describe('with CRLF line endings', () => {
165+
let wizardExitCode: number;
166+
const { projectDir, cleanup } = createIsolatedTestEnv('flutter-test-app');
167+
168+
function convertToCrlf(dir: string) {
169+
const entries = fs.readdirSync(dir, { withFileTypes: true });
170+
for (const entry of entries) {
171+
const fullPath = path.join(dir, entry.name);
172+
if (entry.isDirectory()) {
173+
convertToCrlf(fullPath);
174+
} else if (
175+
/\.(yaml|dart|properties)$/.test(entry.name) ||
176+
entry.name === '.gitignore'
177+
) {
178+
const content = fs.readFileSync(fullPath, 'utf-8');
179+
fs.writeFileSync(
180+
fullPath,
181+
content.replace(/\r?\n/g, '\r\n'),
182+
'utf-8',
183+
);
184+
}
185+
}
186+
}
187+
188+
beforeAll(async () => {
189+
convertToCrlf(projectDir);
190+
191+
wizardExitCode = await withEnv({
192+
cwd: projectDir,
193+
debug: true,
194+
})
195+
.defineInteraction()
196+
.whenAsked('Do you want to continue anyway?')
197+
.respondWith(KEYS.ENTER)
198+
.expectOutput(
199+
'The Sentry Flutter Wizard will help you set up Sentry for your application',
200+
)
201+
.whenAsked('Do you want to enable Tracing')
202+
.respondWith(KEYS.ENTER)
203+
.whenAsked(
204+
'to analyze CPU usage and optimize performance-critical code on iOS & macOS?',
205+
)
206+
.respondWith(KEYS.ENTER)
207+
.whenAsked('to record user interactions and debug issues?')
208+
.respondWith(KEYS.ENTER)
209+
.whenAsked('to send your application logs to Sentry?')
210+
.respondWith(KEYS.ENTER)
211+
.whenAsked(
212+
'Optionally add a project-scoped MCP server configuration for the Sentry MCP?',
213+
)
214+
.respondWith(KEYS.DOWN, KEYS.ENTER)
215+
.expectOutput('Successfully installed the Sentry Flutter SDK!')
216+
.run(getWizardCommand(Integration.flutter));
217+
});
218+
219+
afterAll(() => {
220+
cleanup();
221+
});
222+
223+
test('exits with exit code 0', () => {
224+
expect(wizardExitCode).toBe(0);
225+
});
226+
227+
test('modified files preserve CRLF line endings', () => {
228+
const textFiles = fs
229+
.readdirSync(projectDir, { recursive: true, encoding: 'utf-8' })
230+
.filter(
231+
(f) =>
232+
/\.(yaml|dart|properties)$/.test(f) || f.endsWith('.gitignore'),
233+
);
234+
235+
expect(textFiles.length).toBeGreaterThan(0);
236+
237+
const filesWithMixedEndings = textFiles.filter((file) => {
238+
const content = fs.readFileSync(
239+
path.join(projectDir, file),
240+
'utf-8',
241+
);
242+
const stripped = content.replace(/\r\n/g, '');
243+
return stripped.includes('\n');
244+
});
245+
246+
expect(filesWithMixedEndings).toEqual([]);
247+
});
248+
});
162249
});

‎src/android/android-wizard.ts‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,7 @@ import * as codetools from './code-tools';
2222
import * as gradle from './gradle';
2323
import * as manifest from './manifest';
2424
import { abortIfSpotlightNotSupported } from '../utils/abort-if-sportlight-not-supported';
25+
import { fixLineEndings } from '../utils/line-endings';
2526

2627
const proguardMappingCliSetupConfig: CliSetupConfig = {
2728
...propertiesCliSetupConfig,
@@ -187,6 +188,9 @@ async function runAndroidWizardWithTelemetry(
187188
selectedProject.slug,
188189
);
189190

191+
// Fix mixed line endings caused by inserting LF content into CRLF files (Windows)
192+
fixLineEndings();
193+
190194
// ======== OUTRO ========
191195
const issuesPageLink = selfHosted
192196
? `${sentryUrl}organizations/${selectedProject.organization.slug}/issues/?project=${selectedProject.id}`

‎src/flutter/flutter-wizard.ts‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,7 @@ import { traceStep, withTelemetry } from '../telemetry';
2020
import { findFile } from './code-tools';
2121
import { offerProjectScopedMcpConfig } from '../utils/clack/mcp-config';
2222
import { abortIfSpotlightNotSupported } from '../utils/abort-if-sportlight-not-supported';
23+
import { fixLineEndings } from '../utils/line-endings';
2324

2425
export async function runFlutterWizard(options: WizardOptions): Promise<void> {
2526
return withTelemetry(
@@ -168,6 +169,9 @@ Set the ${chalk.cyan(
168169
selectedProject.slug,
169170
);
170171

172+
// Fix mixed line endings caused by inserting LF content into CRLF files (Windows)
173+
fixLineEndings();
174+
171175
const issuesPageLink = selfHosted
172176
? `${sentryUrl}organizations/${selectedProject.organization.slug}/issues/?project=${selectedProject.id}`
173177
: `https://${selectedProject.organization.slug}.sentry.io/issues/?project=${selectedProject.id}`;

‎src/utils/line-endings.ts‎

Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
import * as fs from 'fs';
2+
import * as path from 'path';
3+
import { getUncommittedOrUntrackedFiles } from './git';
4+
5+
/**
6+
* Fixes mixed line endings in files modified by the wizard.
7+
*
8+
* When the wizard reads a CRLF file and inserts content with hardcoded \n,
9+
* the result is mixed line endings. This function detects files with CRLF
10+
* and normalizes all line endings to CRLF.
11+
*
12+
* Call this at the end of a wizard run, similar to runPrettierIfInstalled().
13+
*/
14+
const TEXT_EXTENSIONS = new Set([
15+
'.dart',
16+
'.yaml',
17+
'.yml',
18+
'.properties',
19+
'.java',
20+
'.kt',
21+
'.xml',
22+
'.gradle',
23+
'.kts',
24+
'.gitignore',
25+
'.json',
26+
]);
27+
28+
export function fixLineEndings(): void {
29+
const files = getUncommittedOrUntrackedFiles()
30+
.map((f) => (f.startsWith('- ') ? f.slice(2) : f))
31+
.filter(Boolean);
32+
33+
for (const file of files) {
34+
const filePath = path.resolve(file);
35+
36+
if (!fs.existsSync(filePath) || !fs.statSync(filePath).isFile()) {
37+
continue;
38+
}
39+
40+
const ext = path.extname(filePath).toLowerCase();
41+
const basename = path.basename(filePath);
42+
if (!TEXT_EXTENSIONS.has(ext) && !TEXT_EXTENSIONS.has(basename)) {
43+
continue;
44+
}
45+
46+
const content = fs.readFileSync(filePath, 'utf8');
47+
48+
if (!content.includes('\r\n')) {
49+
continue;
50+
}
51+
52+
// File has CRLF — normalize all line endings to CRLF
53+
const normalized = content.replace(/\r\n/g, '\n').replace(/\n/g, '\r\n');
54+
fs.writeFileSync(filePath, normalized, 'utf8');
55+
}
56+
}

‎test/utils/line-endings.test.ts‎

Lines changed: 103 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,103 @@
1+
import { describe, expect, it, vi, beforeEach, afterEach } from 'vitest';
2+
import * as fs from 'fs';
3+
import * as path from 'path';
4+
import * as os from 'os';
5+
import { fixLineEndings } from '../../src/utils/line-endings';
6+
import * as git from '../../src/utils/git';
7+
8+
describe('fixLineEndings', () => {
9+
let tmpDir: string;
10+
11+
beforeEach(() => {
12+
tmpDir = fs.mkdtempSync(path.join(os.tmpdir(), 'line-endings-test-'));
13+
});
14+
15+
afterEach(() => {
16+
fs.rmSync(tmpDir, { recursive: true });
17+
vi.restoreAllMocks();
18+
});
19+
20+
it('normalizes mixed line endings to CRLF when file has CRLF', () => {
21+
const filePath = path.join(tmpDir, 'mixed.dart');
22+
fs.writeFileSync(filePath, 'line1\r\nline2\nline3\r\n', 'utf8');
23+
24+
vi.spyOn(git, 'getUncommittedOrUntrackedFiles').mockReturnValue([
25+
`- ${filePath}`,
26+
]);
27+
28+
fixLineEndings();
29+
30+
const result = fs.readFileSync(filePath, 'utf8');
31+
expect(result).toBe('line1\r\nline2\r\nline3\r\n');
32+
});
33+
34+
it('skips files that are pure LF', () => {
35+
const filePath = path.join(tmpDir, 'lf.dart');
36+
const original = 'line1\nline2\n';
37+
fs.writeFileSync(filePath, original, 'utf8');
38+
39+
vi.spyOn(git, 'getUncommittedOrUntrackedFiles').mockReturnValue([
40+
`- ${filePath}`,
41+
]);
42+
43+
fixLineEndings();
44+
45+
const result = fs.readFileSync(filePath, 'utf8');
46+
expect(result).toBe(original);
47+
});
48+
49+
it('leaves consistent CRLF files unchanged', () => {
50+
const filePath = path.join(tmpDir, 'crlf.dart');
51+
const original = 'line1\r\nline2\r\n';
52+
fs.writeFileSync(filePath, original, 'utf8');
53+
54+
vi.spyOn(git, 'getUncommittedOrUntrackedFiles').mockReturnValue([
55+
`- ${filePath}`,
56+
]);
57+
58+
fixLineEndings();
59+
60+
const result = fs.readFileSync(filePath, 'utf8');
61+
expect(result).toBe(original);
62+
});
63+
64+
it('skips non-text files', () => {
65+
const filePath = path.join(tmpDir, 'image.png');
66+
const original = 'line1\r\nline2\nline3\r\n';
67+
fs.writeFileSync(filePath, original, 'utf8');
68+
69+
vi.spyOn(git, 'getUncommittedOrUntrackedFiles').mockReturnValue([
70+
`- ${filePath}`,
71+
]);
72+
73+
fixLineEndings();
74+
75+
const result = fs.readFileSync(filePath, 'utf8');
76+
expect(result).toBe(original);
77+
});
78+
79+
it('skips directories', () => {
80+
const dirPath = path.join(tmpDir, 'subdir');
81+
fs.mkdirSync(dirPath);
82+
83+
vi.spyOn(git, 'getUncommittedOrUntrackedFiles').mockReturnValue([
84+
`- ${dirPath}`,
85+
]);
86+
87+
expect(() => fixLineEndings()).not.toThrow();
88+
});
89+
90+
it('skips nonexistent files', () => {
91+
vi.spyOn(git, 'getUncommittedOrUntrackedFiles').mockReturnValue([
92+
'- nonexistent.txt',
93+
]);
94+
95+
expect(() => fixLineEndings()).not.toThrow();
96+
});
97+
98+
it('does nothing when there are no modified files', () => {
99+
vi.spyOn(git, 'getUncommittedOrUntrackedFiles').mockReturnValue([]);
100+
101+
expect(() => fixLineEndings()).not.toThrow();
102+
});
103+
});

0 commit comments

Comments
 (0)