Handle path separator normalization on Windows

smashwilson · smashwilson · commit adf996ec3bae · 2019-01-11T09:37:21.000-05:00
diff --git a/lib/containers/pr-changed-files-container.js b/lib/containers/pr-changed-files-container.js
@@ -3,6 +3,7 @@ import PropTypes from 'prop-types';
 import {parse as parseDiff} from 'what-the-diff';
 
 import {ItemTypePropType, EndpointPropType} from '../prop-types';
+import {toNativePathSep} from '../helpers';
 import MultiFilePatchController from '../controllers/multi-file-patch-controller';
 import LoadingView from '../views/loading-view';
 import ErrorView from '../views/error-view';
@@ -60,13 +61,13 @@ export default class PullRequestChangedFilesContainer extends React.Component {
 
   buildPatch(rawDiff) {
     const diffs = parseDiff(rawDiff).map(diff => {
-      // diff coming from API will have the defaul git diff prefixes a/ and b/
-      // e.g. a/file1.js and b/file2.js
+      // diff coming from API will have the defaul git diff prefixes a/ and b/ and use *nix-style / path separators.
+      // e.g. a/dir/file1.js and b/dir/file2.js
       // see https://git-scm.com/docs/git-diff#_generating_patches_with_p
       return {
         ...diff,
-        newPath: diff.newPath ? diff.newPath.replace(/^[a|b]\//, '') : diff.newPath,
-        oldPath: diff.oldPath ? diff.oldPath.replace(/^[a|b]\//, '') : diff.oldPath,
+        newPath: diff.newPath ? toNativePathSep(diff.newPath.replace(/^[a|b]\//, '')) : diff.newPath,
+        oldPath: diff.oldPath ? toNativePathSep(diff.oldPath.replace(/^[a|b]\//, '')) : diff.oldPath,
       };
     });
     return buildMultiFilePatch(diffs);
diff --git a/lib/models/patch/multi-file-patch.js b/lib/models/patch/multi-file-patch.js
@@ -340,7 +340,6 @@ export default class MultiFilePatch {
   }
 
   getBufferRowForDiffPosition = (fileName, diffRow) => {
-    // TODO verify that this works on Windows
     const {startBufferRow, index} = this.diffRowOffsetIndices.get(fileName);
     const {offset} = index.lowerBound({diffRow}).data();
     return startBufferRow + diffRow - offset;
diff --git a/test/containers/pr-changed-files-container.test.js b/test/containers/pr-changed-files-container.test.js
@@ -1,6 +1,7 @@
 import React from 'react';
 import {shallow} from 'enzyme';
 import {parse as parseDiff} from 'what-the-diff';
+import path from 'path';
 
 import {rawDiff, rawDiffWithPathPrefix} from '../fixtures/diffs/raw-diff';
 import {buildMultiFilePatch} from '../../lib/models/patch';
@@ -79,6 +80,13 @@ describe('PullRequestChangedFilesContainer', function() {
       assert.notMatch(filePatches[0].oldFile.path, /^[a|b]\//);
     });
 
+    it('converts file paths to use native path separators', function() {
+      const wrapper = shallow(buildApp());
+      const {filePatches} = wrapper.instance().buildPatch(rawDiffWithPathPrefix);
+      assert.strictEqual(filePatches[0].newFile.path, path.join('bad/path.txt'));
+      assert.strictEqual(filePatches[0].oldFile.path, path.join('bad/path.txt'));
+    });
+
     it('passes loaded diff data through to the controller', async function() {
       const wrapper = shallow(buildApp({
         token: '4321',
diff --git a/test/fixtures/diffs/raw-diff.js b/test/fixtures/diffs/raw-diff.js
@@ -12,10 +12,10 @@ const rawDiff = dedent`
    line3
 `;
 const rawDiffWithPathPrefix = dedent`
-  diff --git a/badpath.txt b/badpath.txt
+  diff --git a/bad/path.txt b/bad/path.txt
   index af607bb..cfac420 100644
-  --- a/badpath.txt
-  +++ b/badpath.txt
+  --- a/bad/path.txt
+  +++ b/bad/path.txt
   @@ -1,2 +1,3 @@
     line0
   -line1

Original file line number	Diff line number	Diff line change
`@@ -340,7 +340,6 @@ export default class MultiFilePatch {`
`340`	`340`	`}`
`341`	`341`
`342`	`342`	`getBufferRowForDiffPosition = (fileName, diffRow) => {`
`343`		`- // TODO verify that this works on Windows`
`344`	`343`	`const {startBufferRow, index} = this.diffRowOffsetIndices.get(fileName);`
`345`	`344`	`const {offset} = index.lowerBound({diffRow}).data();`
`346`	`345`	`return startBufferRow + diffRow - offset;`