Add convenience info to `danger.git.diffForFile` #223

namuol · 2017-04-13T21:14:38Z

Fixes #221

Changes the signature for danger.git.diffForFile to the following:

/** All Text diff values will be this shape */
export interface TextDiff {
  /** The value before the PR's applied changes */
  before: string
  /** The value after the PR's applied changes */
  after: string,
  /** A string containing the full set of changes */
  diff: string,
  /** A string containing just the added lines */
  added: string,
  /** A string containing just the removed lines */
  removed: string
}

diffForFile(filename: string): Promise<TextDiff | null>

TODO

orta · 2017-04-13T21:15:57Z

source/dsl/GitDSL.ts

@@ -64,8 +76,7 @@ export interface GitDSL {
   * @param {string} filename the path to the json file
   * @param {string[]} diffTypes An array containing: "add", "del" or "normal" - then you can only get these changes
   */
-
-  diffForFile(filename: string, diffTypes?: string[]): string | null,
+  diffForFile(filename: string, diffTypes?: string[]): Promise<TextDiff | null>,


think you can kill diffTypes in favour of this /cc @alex3165

Should we still keep the added/removed/normal changes? They're not really the same as JSONDiff.

Can't they be the raw string content of all the hunks combined?

Ah, yes that does make sense. @alex3165 does this satisfy your use-case?

i.e. instead of calling diffForFile('foo.js', ['add']), you'd call diffForFile('foo.js').added which would return the same sort of string.

I honestly am confused about the meaning of normal in this context -- I think it refers to "contextual" lines (i.e. non-changed lines that sandwich an addition/deletion).

If I'm correct about this, I struggle to see how it'd be useful to have these lines without being combined with added or removed.

Maybe we could just provide the raw structuredDiff from parseDiff's output as an escape hatch for folks who need finer control.

maybe then added and removed should be add + normal and del?

After some thinking, here's what I think would be more useful for most folks:

/** All Text diff values will be this shape */ export interface TextDiff { /** The value before the PR's applied changes */ before: string /** The value after the PR's applied changes */ after: string, /** A string containing the full set of changes */ diff: string, /** A string containing just the added lines */ added: string, /** A string containing just the removed lines */ removed: string, }

This covers all cases except for the odd one where you only want normal/contextual lines, which seems quite fringe to me.

Yeah, that feels 👍 to me

orta · 2017-04-13T21:17:01Z

source/platforms/github/GitHubGit.ts

+      removed: changes.filter(({type}: {type: string}) => type === "del"),
+      normal: changes.filter(({type}: {type: string}) => type === "normal"),
+      diff: lines.join(os.EOL)
+    }
  }


codecov-io · 2017-04-13T21:17:13Z

Codecov Report

Merging #223 into master will not change coverage.
The diff coverage is 92.3%.

@@           Coverage Diff           @@
##           master     #223   +/-   ##
=======================================
  Coverage   68.62%   68.62%           
=======================================
  Files          34       34           
  Lines         765      765           
  Branches      105      104    -1     
=======================================
  Hits          525      525           
  Misses        240      240

Impacted Files	Coverage Δ
source/platforms/FakePlatform.ts	`68.42% <0%> (ø)`	⬆️
source/platforms/github/GitHubGit.ts	`98.27% <100%> (ø)`	⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update d3f1933...82b089c. Read the comment docs.

namuol · 2017-04-13T21:26:47Z

source/platforms/github/GitHubGit.ts


    // Filter the diffs by type
    if (diffTypes && diffTypes.length > 0) {
      changes = changes.filter((c: any) => diffTypes.indexOf(c.type) !== -1)
    }

+    const baseFile = await api.fileContents(filename, pr.base.repo.full_name, pr.base.sha)


Note: I'm using sha here instead of ref, mainly because the example PR used for the fixture seemed to have deleted the original branch.

We may also want to use sha above in the implementation of JSONPatchForFile.

@orta Thoughts? Any reason to prefer ref over sha?

no difference IMO 👍

sha may be better incase a potential branch has had new commits since the CI was started, and then when danger runs

namuol · 2017-04-13T23:58:29Z

Hmm... I must be missing something. The tests are passing on my machine but AppVeyor doesn't seem to like it. 🤷‍♂️

orta · 2017-04-14T00:00:50Z

source/platforms/github/_tests/_github_git.test.ts

@@ -20,15 +20,19 @@ export const requestWithFixturedContent = async (path: string): Promise<() => Pr
  Promise.resolve(readFileSync(`${fixtures}/${path}`, {}).toString())
 )

+const pullRequestInfoFilename = "github_pr.json"
+const masterSHA = JSON.parse(readFileSync(`${fixtures}/${pullRequestInfoFilename}`, {}).toString()).base.sha


try using the path API for this string - that might be what's breaking on windows, can't remember its name yet

This could possibly be a bug with Jest's snapshot testing. :-/ Their Windows support is still pretty unstable AFAIK.

I thought maybe it had something to do with line endings, but that shouldn't be an issue: jestjs/jest#1879

orta · 2017-04-14T00:30:01Z

These failing snapshots feel backwards, like it's inverting the before and after

namuol · 2017-04-14T00:31:52Z

These failing snapshots feel backwards, like it's inverting the before and after

Yeah, the Jest output doesn't really make sense. It treats every line but the last as different, even though if you copy/paste the terminal output and do a diff after cleaning out the additional +/-s, they're identical.

orta · 2017-04-14T00:34:53Z

yeah, must be some invisible characters - can we strip them for the test?

namuol · 2017-04-14T00:42:29Z

Yup. Stripping the whitespace seemed to fix the issue. I'll make this more explicit and add a TODO to the test file.

orta · 2017-04-14T00:44:23Z

👍 Perfect

namuol · 2017-04-14T00:52:00Z

I'd wait for @alex3165's response, but otherwise does this look good?

orta · 2017-04-14T00:58:00Z

Yep, everything looks 👍

orta · 2017-04-14T00:58:15Z

will merge and release EOD tomorrow if we don't hear anything back

orta · 2017-04-14T01:29:25Z

also, I've invited you to the org, as a part of Moya Community Continuity - you're welcome to participate (or not, we're chill) in PRs and help out at a level that works for you.

namuol added 4 commits April 13, 2017 12:17

Add some fixtures

19e18dc

Add GitHubGit implementation + update tests

4a2c12e

Add before/after snapshot tests

2e38387

Fix FakePlatform.ts type errors

79d2665

orta reviewed Apr 13, 2017

View reviewed changes

namuol commented Apr 13, 2017

View reviewed changes

namuol added 5 commits April 13, 2017 16:03

Simplify TextDiff format

fcea9d7

Merge branch 'master' into structured-file-diffs

91b994e

Update changelog

166d1bd

Test: Use example file with additions and removals

7333df0

Update fixtures + snapshots

5607163

orta reviewed Apr 14, 2017

View reviewed changes

Add test for missing files + use path.join

7b89351

Try a simpler example file

bdaa451

Try stripping whitespace

8946f6c

Add note about whitespace stripping

82b089c

orta merged commit bcdb0ce into danger:master Apr 15, 2017

dependencies bot mentioned this pull request Apr 30, 2018

Update 30 dependencies from npm storybookjs/storybook#3513

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add convenience info to `danger.git.diffForFile` #223

Add convenience info to `danger.git.diffForFile` #223

namuol commented Apr 13, 2017 •

edited

Loading

orta Apr 13, 2017

namuol Apr 13, 2017

orta Apr 13, 2017

namuol Apr 13, 2017

namuol Apr 13, 2017 •

edited

Loading

orta Apr 13, 2017 •

edited

Loading

namuol Apr 13, 2017 •

edited

Loading

orta Apr 13, 2017

orta Apr 13, 2017

codecov-io commented Apr 13, 2017 •

edited

Loading

namuol Apr 13, 2017 •

edited

Loading

orta Apr 13, 2017

orta Apr 13, 2017 •

edited

Loading

namuol commented Apr 13, 2017

orta Apr 14, 2017

namuol Apr 14, 2017

namuol Apr 14, 2017

orta commented Apr 14, 2017

namuol commented Apr 14, 2017

orta commented Apr 14, 2017

namuol commented Apr 14, 2017

orta commented Apr 14, 2017

namuol commented Apr 14, 2017

orta commented Apr 14, 2017

orta commented Apr 14, 2017

orta commented Apr 14, 2017

Add convenience info to danger.git.diffForFile #223

Add convenience info to danger.git.diffForFile #223

Conversation

namuol commented Apr 13, 2017 • edited Loading

TODO

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

namuol Apr 13, 2017 • edited Loading

Choose a reason for hiding this comment

orta Apr 13, 2017 • edited Loading

Choose a reason for hiding this comment

namuol Apr 13, 2017 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

codecov-io commented Apr 13, 2017 • edited Loading

Codecov Report

namuol Apr 13, 2017 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

orta Apr 13, 2017 • edited Loading

Choose a reason for hiding this comment

namuol commented Apr 13, 2017

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

orta commented Apr 14, 2017

namuol commented Apr 14, 2017

orta commented Apr 14, 2017

namuol commented Apr 14, 2017

orta commented Apr 14, 2017

namuol commented Apr 14, 2017

orta commented Apr 14, 2017

orta commented Apr 14, 2017

orta commented Apr 14, 2017

Add convenience info to `danger.git.diffForFile` #223

Add convenience info to `danger.git.diffForFile` #223

namuol commented Apr 13, 2017 •

edited

Loading

namuol Apr 13, 2017 •

edited

Loading

orta Apr 13, 2017 •

edited

Loading

namuol Apr 13, 2017 •

edited

Loading

codecov-io commented Apr 13, 2017 •

edited

Loading

namuol Apr 13, 2017 •

edited

Loading

orta Apr 13, 2017 •

edited

Loading