collapse large diffs && collapse/expand any diff within multi file patch view #1913

annthurium · 2019-01-16T19:40:45Z

Description of the Change

This pull request adds code to detect large diffs, and automatically collapse them. It also adds the ability for users to collapse and expand any diff within a multi file patch view. There's a lot of shared logic between both so it made sense to tackle them at the same time.

TODO

https://github.com/atom/github/projects/18

Screenshot/Gif

TBD

Alternate Designs

Benefits

The pull request view, commit preview, and commit pane are more useful now.
No more endless scrolling to get past your package-lock.json changes that you probably don't need to review in such detail!

Possible Drawbacks

TBD

Applicable Issues

#1860

QA Checklist

Metrics

Count of how many files are manually collapsed / expanded
Performance of rendering large diffs

Tests

TBD

Documentation

TBD

Release Notes

The GitHub package now supports collapsing and expanding any files within multi file diff views (such as commit preview and the pull request files view), and also automatically collapses large files.

User Experience Research (Optional)

The UI is simple enough for this that I would argue it does not warrant UXR.

todo · 2019-01-16T19:40:50Z

Set this based on performance measurements

github/lib/models/patch/builder.js

Lines 12 to 17 in 7eab119

    
             // TODO: Set this based on performance measurements 
        
             largeDiffThreshold: 10, 
        
             // Map of file path (relative to repository root) to Patch render status (EXPANDED, COLLAPSED, TOO_LARGE) 
        
             renderStatusOverrides: {}, 
        
           };

This comment was generated by todo based on a `TODO` comment in `7eab119` in #1913. cc @atom.

todo · 2019-01-16T19:40:51Z

do something with large diff too

github/lib/models/patch/builder.js

Lines 178 to 183 in 7eab119

    
             // TODO: do something with large diff too 
        
           } 
        
           const [hunks, patchMarker] = buildHunks(contentChangeDiff, layeredBuffer, layeredBuffer.buffer.getLastRow()); 
        
           const patch = new Patch({status, hunks, marker: patchMarker, buffer: layeredBuffer.buffer});

This comment was generated by todo based on a `TODO` comment in `7eab119` in #1913. cc @atom.

todo · 2019-01-16T19:40:52Z

it prob shouldn't extend NullPatch

github/lib/models/patch/patch.js

Lines 395 to 400 in 7eab119

    
           // TODO: it prob shouldn't extend NullPatch 
        
           class DelayedPatch extends NullPatch { 
        
             constructor(position, renderStatus, parseFn) { 
        
               super(); 
        
               this.position = position; 
        
               this.renderStatus = renderStatus;

This comment was generated by todo based on a `TODO` comment in `7eab119` in #1913. cc @atom.

codecov · 2019-01-16T19:42:49Z

Codecov Report

Merging #1913 into master will increase coverage by 0.45%.
The diff coverage is 100%.

@@            Coverage Diff             @@
##           master    #1913      +/-   ##
==========================================
+ Coverage   92.12%   92.57%   +0.45%     
==========================================
  Files         188      189       +1     
  Lines       10809    11237     +428     
  Branches     1582     1633      +51     
==========================================
+ Hits         9958    10403     +445     
+ Misses        851      834      -17

Impacted Files	Coverage Δ
lib/controllers/pr-reviews-controller.js	`100% <ø> (ø)`	⬆️
lib/models/patch/patch.js	`100% <100%> (ø)`	⬆️
lib/models/patch/region.js	`100% <100%> (ø)`	⬆️
lib/views/pr-review-comments-view.js	`100% <100%> (ø)`	⬆️
lib/models/patch/hunk.js	`100% <100%> (ø)`	⬆️
lib/containers/changed-file-container.js	`100% <100%> (ø)`	⬆️
lib/views/file-patch-header-view.js	`100% <100%> (ø)`	⬆️
lib/models/patch/multi-file-patch.js	`100% <100%> (ø)`	⬆️
lib/models/patch/file-patch.js	`100% <100%> (ø)`	⬆️
lib/views/multi-file-patch-view.js	`100% <100%> (ø)`	⬆️
... and 12 more

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 d42b8e8...3b65cfe. Read the comment docs.

...not sure how we would get into this situation, but it seems like an important case to cover.

unnecessary console output during tests is a bummer.

smashwilson

I found a few minor tweaks and renames. Almost there 🎉

smashwilson · 2019-02-28T19:13:35Z

docs/react-component-atlas.md

-> > > Render a sequence of git-generated file patches within a TextEditor, using decorations to include contextually
-> > > relevant controls.
+> > > Render a sequence of git-generated file patches within a TextEditor, using decorations to include contextually relevant controls.
+> > > See [`MultiFilePatchView` atlas](#multifilepatchview-atlas) below for a more detailed breakdown.


What I really want is a tool that parses our source and outputs this atlas as an .svg diagram or something 🤔

lib/atom/atom-text-editor.js

lib/containers/pr-changed-files-container.js

lib/models/patch/builder.js

lib/models/patch/multi-file-patch.js

test/models/patch/file-patch.test.js

smashwilson · 2019-02-28T19:42:44Z

test/models/patch/multi-file-patch.test.js

+        });
+      });
+
+      it('is deterministic regardless of the order in which collapse and expand operations are performed', function() {


I'm still proud of this test case 😆

test/models/patch/patch-buffer.test.js

test/models/patch/patch.test.js

docs/react-component-atlas.md

kuychaco · 2019-03-13T00:20:15Z

docs/react-component-atlas.md

+
+
+
+## `MultiFilePatchView` Atlas


another test comment

smashwilson and others added 2 commits January 16, 2019 14:27

Remember changed renderStatus

cd5cc28

add collapse button to file patch header

7eab119

annthurium changed the title ~~Vy/diff gate~~ collapse large diffs && collapse/expand any diff within multi file patch view Jan 16, 2019

annthurium mentioned this pull request Jan 16, 2019

Collapse and expand files within a multi file patch view. #1863

Closed

smashwilson and others added 22 commits January 16, 2019 15:03

Use a Marker instead of a Point to track delayed patch location

b251264

Track changed renderStatus in CommitPreviewContainer

0bfacb6

Ditto for CommitDetailContainer

40cde30

fix bad parens in mfp builder

be2ab8f

don't render pull request comments if patch exceeds large diff threshold

e28522e

use a Map to avoid iterating through patches

b66c88c

deal with null patches

98fbfc9

...not sure how we would get into this situation, but it seems like an important case to cover.

👕

ccf2a99

danananana PROP TYPES

26ee209

also check for COLLAPSED patch state

010cd56

honk if you like test helpers

cd2b7f9

clean up pr comments builder

8324cb3

unnecessary console output during tests is a bummer.

[wip] add tests for isPatchTooLargeOrCollapsed

ee6c9c2

Test case for Patch Marker movement

0733676

Extract LayeredBuffer class and use it consistently in Patch logic

1237458

Rename LayeredBuffer to PatchBuffer

f963e75

Begin an "atomic" (with respect to markers) Modification API

6df1380

import LARGE_DIFF_THRESHOLD

3b34099

Preserve Markers that begin or end at a Modification's insertion point

49b406d

PatchBuffer::extract() to slice a Range out and preserve its markers

a2d453c

Unit test for inserting one PatchBuffer into another

34e104a

actually trigger expanding and collapsing from FilePatchHeaderView

dfc2fee

smashwilson and others added 16 commits February 26, 2019 14:27

Use IIFEs to bind variables in arrow functions

9a3c4da

Only measure the contentChangeDiff when determining if it's "too large"

817143e

Patch 💯

0b7811d

Region 💯

6e4ae95

FilePatch 💯

2681e23

Starting on MultiFilePatchView test coverage

7dc1b78

add test for unsub

e758dc6

Cover the last uncovered line in MultiFilePatchView

2c261c8

Manually test cache invalidation from FOCUS on Linux

776a440

That .catch on win32 is probably important?

97720b0

PatchBuffer 💯

893489b

AtomTextEditor 💯

d58ca26

State 💯

3f5d3a3

Maybe it's the path separators?

0d18601

Actually 💯 State

33c88af

Merge branch 'master' into vy/diff-gate

13f1c86

smashwilson suggested changes Feb 28, 2019

View reviewed changes

smashwilson added 7 commits February 28, 2019 14:51

Our daily Nietzsche

a316c1b

🔥 obsolete TODO

ceda6ef

Rename getLayeredBuffer() to getPatchBuffer()

355ade8

Use defaultProps for on(Will|Did)UpdatePatch handlers

fd990ed

🔥 unused propTypes

2ea5184

Touch up builder method spelling

6b4c770

Rename ...LayeredBuffer variables to ...PatchBuffer

3b65cfe

smashwilson approved these changes Feb 28, 2019

View reviewed changes

smashwilson merged commit 96d77c5 into master Feb 28, 2019

smashwilson deleted the vy/diff-gate branch February 28, 2019 20:28

vanessayuenn mentioned this pull request Mar 6, 2019

v0.27.0-0 QA Review #2005

Closed

9 tasks

kuychaco reviewed Mar 12, 2019

View reviewed changes

docs/react-component-atlas.md Show resolved Hide resolved

kuychaco reviewed Mar 13, 2019

View reviewed changes

docs/react-component-atlas.md

## `MultiFilePatchView` Atlas

Copy link

Contributor

kuychaco Mar 13, 2019

Choose a reason for hiding this comment

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

another test comment

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

collapse large diffs && collapse/expand any diff within multi file patch view #1913

collapse large diffs && collapse/expand any diff within multi file patch view #1913

Uh oh!

annthurium commented Jan 16, 2019 •

edited by smashwilson

Loading

Uh oh!

todo bot commented Jan 16, 2019

Uh oh!

todo bot commented Jan 16, 2019

Uh oh!

todo bot commented Jan 16, 2019

Uh oh!

codecov bot commented Jan 16, 2019 •

edited

Loading

Uh oh!

smashwilson left a comment

Uh oh!

smashwilson Feb 28, 2019

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

smashwilson Feb 28, 2019

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

kuychaco Mar 13, 2019

Uh oh!

Uh oh!

collapse large diffs && collapse/expand any diff within multi file patch view #1913

collapse large diffs && collapse/expand any diff within multi file patch view #1913

Uh oh!

Conversation

annthurium commented Jan 16, 2019 • edited by smashwilson Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description of the Change

TODO

Screenshot/Gif

Alternate Designs

Benefits

Possible Drawbacks

Applicable Issues

QA Checklist

Metrics

Tests

Documentation

Release Notes

User Experience Research (Optional)

Uh oh!

todo bot commented Jan 16, 2019

Set this based on performance measurements

This comment was generated by todo based on a TODO comment in 7eab119 in #1913. cc @atom.

Uh oh!

todo bot commented Jan 16, 2019

do something with large diff too

This comment was generated by todo based on a TODO comment in 7eab119 in #1913. cc @atom.

Uh oh!

todo bot commented Jan 16, 2019

it prob shouldn't extend NullPatch

This comment was generated by todo based on a TODO comment in 7eab119 in #1913. cc @atom.

Uh oh!

codecov bot commented Jan 16, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

smashwilson left a comment

Choose a reason for hiding this comment

Uh oh!

smashwilson Feb 28, 2019

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

smashwilson Feb 28, 2019

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

kuychaco Mar 13, 2019

Choose a reason for hiding this comment

Uh oh!

Uh oh!

annthurium commented Jan 16, 2019 •

edited by smashwilson

Loading

This comment was generated by todo based on a `TODO` comment in `7eab119` in #1913. cc @atom.

This comment was generated by todo based on a `TODO` comment in `7eab119` in #1913. cc @atom.

This comment was generated by todo based on a `TODO` comment in `7eab119` in #1913. cc @atom.

codecov bot commented Jan 16, 2019 •

edited

Loading