Re-introduce commit message template #1756

kuychaco · Oct 25, 2018

Description of the Change

This PR re-introduces the commit message template feature, originally introduced in #1713. It re-works some of the implementation, cleans up tests, and additionally fixes the merge message regression.

With these change, the repository model now manages and updates the commit message based on file system events indicating that the config has changed or a merge has been initiated/completed.

/cc @annthurium

Alternate Designs

N/A

Benefits

Folks will be able to make commits with the aid of commit message templates

Possible Drawbacks

The usual drawbacks associated with code changes. This feature in particular touches a part of the system that is complex and fairly edge-casey...

Applicable Issues

Original PR - #1713
Reverted PR - #1754

Metrics

N/A

Tests

Added unit tests for:

restores template after committing
config commit.template change
when merge is initiated
- merge message replaces
  - empty commit message
  - untouched commit template
- dirty message is left untouched
when merge is aborted
- clean commit message is restored
- commit template is restored

Manually tested:

When tabbing to commit box, cursor is at beginning of template (rather than at the very end)
Commit button is disabled when commit message contains a template. It is enabled only when commit message contains non-commented lines
Commit message updates correctly when expanding/closing expanded commit message editors
Commit message updates correctly to show merge message when merge is initiated and aborted
Commit message template is restored after committing

@smashwilson to test manually on Linux and Windows

Documentation

User Experience Research (Optional)

N/A

TODO:

clean up git strategies tests
de-dupe file system watching tests
verify template path logic works on windows and linux

annthurium · Oct 25, 2018

annthurium reviewed Oct 25, 2018

View changes

lib/git-shell-out-strategy.js

lib/models/repository-states/present.js

lib/views/commit-view.js

annthurium · Oct 25, 2018

annthurium reviewed Oct 25, 2018

View changes

annthurium · Oct 25, 2018

lib/git-shell-out-strategy.js

+    const regex = new RegExp('^~([^/]*)/');
+    templatePath = templatePath.trim().replace(regex, (_, user) => {
+      // if no user is specified, fall back to using the home directory.
+      return `${user ? path.join(path.dirname(homeDir), user) : homeDir}/`;


@smashwilson: can you test this on non-Mac operating systems? We want to make sure if a username is specified, it does the right thing for our Linux and or Windows users.

Can do, and will report back 🙇

One thing that I can see right away is that this won't handle ~root/ correctly; on most *nix systems, that should expand to /root, not /users/root. In general the right thing to do on Unix-y systems is to use getpwnam(3) to read the definitive information, taking into account any weird local network drive setups and so on. Windows I'm less familiar with.

There are a few tilde-expansion libraries on npm, but unfortunately looking at their source it doesn't look like many of them handle all of this correctly either! I found one that uses etc-passwd to read its info, but I don't believe it has any accommodations for Windows. This may be a sign that this isn't important enough to hold up the 🚢 for 😉

coveralls · Oct 26, 2018

Coverage decreased (-0.003%) to 84.869% when pulling 4e400bd on ku-tt-commit-msg-template into 0e906e2 on master.

smashwilson · Oct 29, 2018

smashwilson reviewed Oct 29, 2018

View changes

I have a bunch of assorted feedback, but no bugs or blockers 😄

I'll test the ~ expansion logic on Windows and Linux when I get the chance and leave a 👍 or ❌ accordingly.

lib/controllers/commit-controller.js

lib/get-repo-pipeline-manager.js

smashwilson · Oct 29, 2018

lib/git-shell-out-strategy.js

+    // Regex translation:
+    // ^~ line starts with tilde
+    // ([^/]*)/ captures non-forwardslash characters before first slash
+    const regex = new RegExp('^~([^/]*)/');


Is there a reason this is constructed with new RegExp() rather than as a regexp literal? Is it just for readability so you don't have to escape all of the / and get into leaning-toothpick-syndrome?

A more descriptive name than regex may be nice too 😄 How about something like tildeExpansionPattern?

We didn't really have a strong reason for preferring the regexp constructor over literals here. We went with what the original author had.

Out of curiosity, we looked to see if there was a performance difference. Answer: not really.
https://www.measurethat.net/Benchmarks/Show/1734/1/regexp-constructor-vs-literal

We did give it a more descriptive name, and moved it out of this function so as to avoid creating a new regex every time.

smashwilson · Oct 29, 2018

lib/git-shell-out-strategy.js

+    const regex = new RegExp('^~([^/]*)/');
+    templatePath = templatePath.trim().replace(regex, (_, user) => {
+      // if no user is specified, fall back to using the home directory.
+      return `${user ? path.join(path.dirname(homeDir), user) : homeDir}/`;


Can do, and will report back 🙇

One thing that I can see right away is that this won't handle ~root/ correctly; on most *nix systems, that should expand to /root, not /users/root. In general the right thing to do on Unix-y systems is to use getpwnam(3) to read the definitive information, taking into account any weird local network drive setups and so on. Windows I'm less familiar with.

There are a few tilde-expansion libraries on npm, but unfortunately looking at their source it doesn't look like many of them handle all of this correctly either! I found one that uses etc-passwd to read its info, but I don't believe it has any accommodations for Windows. This may be a sign that this isn't important enough to hold up the 🚢 for 😉

smashwilson · Oct 29, 2018

lib/models/repository-states/present.js

+  async updateCommitMessageAfterFileSystemChange(events) {
+    for (let i = 0; i < events.length; i++) {
+      const event = events[i];
+      const endsWith = (...segments) => event.path.endsWith(path.join(...segments));


Might be worth extracting this to helpers.js?

It is a one-liner, but eh.

sure! Good suggestion. Extracted.

lib/views/commit-view.js

test/integration/file-patch.test.js

smashwilson · Oct 29, 2018

test/models/repository.test.js

+      return {repository, observer};
+    }
+
+    function expectEvents(repository, ...suffixes) {


Yeah, these would be great to extract to a helper and clean up a bit... We have a few places that test Real Filesystem Events ™️ where these would be nice.

How does this look b3c9ec7?

smashwilson · Oct 30, 2018

I just found a bug on Windows. If I run git config --unset commit.template at the command line, the git tab errors out and leaves this stack in the console:

C:\Users\smash\src\atom\node_modules\text-buffer\lib\text-buffer.js:1319 Uncaught TypeError: Cannot read property 'split' of null
    at Diff.lineDiff.tokenize (C:\Users\smash\src\atom\node_modules\text-buffer\node_modules\diff\lib\diff\line.js:22:32)
    at Diff.diff (C:\Users\smash\src\atom\node_modules\text-buffer\node_modules\diff\lib\diff\base.js:36:39)
    at Object.diffLines (C:\Users\smash\src\atom\node_modules\text-buffer\node_modules\diff\lib\diff\line.js:47:19)
    at transact (C:\Users\smash\src\atom\node_modules\text-buffer\lib\text-buffer.js:801:29)
    at TextBuffer.transact (C:\Users\smash\src\atom\node_modules\text-buffer\lib\text-buffer.js:1316:16)
    at TextBuffer.setTextViaDiff (C:\Users\smash\src\atom\node_modules\text-buffer\lib\text-buffer.js:796:10)
    at CommitController.componentDidUpdate (C:/Users/smash/src/github/lib/controllers/commit-controller.js:113:30)
    at commitLifeCycles (C:\Users\smash\src\github\node_modules\react-dom\cjs\react-dom.development.js:14256:22)
    at commitAllLifeCycles (C:\Users\smash\src\github\node_modules\react-dom\cjs\react-dom.development.js:15342:7)
    at HTMLUnknownElement.callCallback (C:\Users\smash\src\github\node_modules\react-dom\cjs\react-dom.development.js:100:14)
    at Object.invokeGuardedCallbackDev (C:\Users\smash\src\github\node_modules\react-dom\cjs\react-dom.development.js:138:16)
    at invokeGuardedCallback (C:\Users\smash\src\github\node_modules\react-dom\cjs\react-dom.development.js:187:29)
    at commitRoot (C:\Users\smash\src\github\node_modules\react-dom\cjs\react-dom.development.js:15481:7)
    at completeRoot (C:\Users\smash\src\github\node_modules\react-dom\cjs\react-dom.development.js:16496:34)
    at performWorkOnRoot (C:\Users\smash\src\github\node_modules\react-dom\cjs\react-dom.development.js:16440:9)
    at performWork (C:\Users\smash\src\github\node_modules\react-dom\cjs\react-dom.development.js:16358:7)
    at performSyncWork (C:\Users\smash\src\github\node_modules\react-dom\cjs\react-dom.development.js:16330:3)
    at requestWork (C:\Users\smash\src\github\node_modules\react-dom\cjs\react-dom.development.js:16230:5)
    at scheduleWork$1 (C:\Users\smash\src\github\node_modules\react-dom\cjs\react-dom.development.js:16096:11)
    at Object.enqueueSetState (C:\Users\smash\src\github\node_modules\react-dom\cjs\react-dom.development.js:11185:5)
    at ObserveModel.Component.setState (C:\Users\smash\src\github\node_modules\react\cjs\react.development.js:273:16)
    at ObserveModel.didUpdate (C:/Users/smash/src/github/lib/views/observe-model.js:39:12)
    at ModelObserver._refreshModelData (C:/Users/smash/src/github/lib/models/model-observer.js:52:14)
    at <anonymous>
    at process._tickCallback (internal/process/next_tick.js:188:7)

From the message, I'm guessing that the fetched commit template is null instead of an empty string unexpectedly?

Oddly it's fine if I ctrl-F5 with no commit.template set.

smashwilson · Oct 30, 2018

Path logic is 👍 on Windows: I verified both ~/... and ~username/... paths. Checking Linux next...

smashwilson · Oct 31, 2018

👍 to path logic on Linux as well. (And I was able to reproduce the --unset bug I mentioned above, so it must not be platform-specific.)

smashwilson · Oct 31, 2018

smashwilson reviewed Oct 31, 2018

View changes

We should probably fix that stack trace I found when running git config --unset commit.template with an Atom window open. Other than that, looks good - all of the path wrangling worked correctly on Windows and Linux 👍

kuychaco · Nov 6, 2018

kuychaco reviewed Nov 6, 2018

View changes

lib/models/repository-states/present.js

annthurium · Nov 6, 2018

annthurium dismissed smashwilson’s stale review Nov 6, 2018

this bug has been addressed

kuychaco added this to In Progress 🔧 in Feature Sprint : 1 October - 19 November 2018 : v0.21.0 via automation Oct 25, 2018

Fix and clean up GitStrategies tests

Loading status checks…

8a40a74

add comment explaining regex
Co-Authored-By: Katrina Uychaco <katrina@github.com>

Loading status checks…

63ffa69

kuychaco requested a review from smashwilson Oct 26, 2018

Feature Sprint : 1 October - 19 November 2018 : v0.21.0 automation moved this from In Progress 🔧 to QA Review 🔬 Oct 31, 2018

annthurium added some commits Nov 6, 2018

handle case where template is unset

a87b3a4

add unit test for unsetting commit template

Loading status checks…

6f88f76

address code review feedback.

Loading status checks…

4e400bd

annthurium dismissed smashwilson’s stale review Nov 6, 2018

Feature Sprint : 1 October - 19 November 2018 : v0.21.0 automation moved this from QA Review 🔬 to Merged ☑️ Nov 7, 2018

annthurium deleted the ku-tt-commit-msg-template branch Nov 7, 2018

vanessayuenn referenced this pull request Nov 21, 2018
Closed
v0.23.0-0 QA Review #1806
5 of 5 tasks complete

atom/github

Re-introduce commit message template #1756

kuychaco commented Oct 25, 2018 •

edited by smashwilson

kuychaco and others added some commits Oct 23, 2018

kuychaco added this to In Progress 🔧 in Feature Sprint : 1 October - 19 November 2018 : v0.21.0 via automation Oct 25, 2018

annthurium reviewed Oct 25, 2018

View changes

annthurium reviewed Oct 25, 2018

View changes

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

coveralls commented Oct 26, 2018 •

edited

annthurium and others added some commits Oct 26, 2018

kuychaco requested a review from smashwilson Oct 26, 2018

smashwilson reviewed Oct 29, 2018

View changes

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

annthurium and others added some commits Oct 29, 2018

This comment has been minimized.

smashwilson commented Oct 30, 2018 •

edited

This comment has been minimized.

smashwilson commented Oct 30, 2018

This comment has been minimized.

smashwilson commented Oct 31, 2018

Feature Sprint : 1 October - 19 November 2018 : v0.21.0 automation moved this from In Progress 🔧 to QA Review 🔬 Oct 31, 2018

smashwilson reviewed Oct 31, 2018

View changes

annthurium added some commits Nov 6, 2018

kuychaco reviewed Nov 6, 2018

View changes

annthurium dismissed smashwilson’s stale review Nov 6, 2018

annthurium merged commit `26c39ee` into master Nov 7, 2018
7 checks passed

7 checks passed

Feature Sprint : 1 October - 19 November 2018 : v0.21.0 automation moved this from QA Review 🔬 to Merged ☑️ Nov 7, 2018

annthurium deleted the ku-tt-commit-msg-template branch Nov 7, 2018

vanessayuenn referenced this pull request Nov 21, 2018

v0.23.0-0 QA Review #1806

atom/github

Join GitHub today

Re-introduce commit message template #1756

Conversation

kuychaco commented Oct 25, 2018 • edited by smashwilson

Description of the Change

Alternate Designs

Benefits

Possible Drawbacks

Applicable Issues

Metrics

Tests

Documentation

User Experience Research (Optional)

kuychaco and others added some commits Oct 23, 2018

kuychaco added this to In Progress 🔧 in Feature Sprint : 1 October - 19 November 2018 : v0.21.0 via automation Oct 25, 2018

annthurium reviewed Oct 25, 2018 View changes

annthurium reviewed Oct 25, 2018 View changes

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

coveralls commented Oct 26, 2018 • edited

annthurium and others added some commits Oct 26, 2018

kuychaco requested a review from smashwilson Oct 26, 2018

smashwilson reviewed Oct 29, 2018 View changes

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

annthurium and others added some commits Oct 29, 2018

This comment has been minimized.

smashwilson commented Oct 30, 2018 • edited

This comment has been minimized.

smashwilson commented Oct 30, 2018

This comment has been minimized.

smashwilson commented Oct 31, 2018

Feature Sprint : 1 October - 19 November 2018 : v0.21.0 automation moved this from In Progress 🔧 to QA Review 🔬 Oct 31, 2018

smashwilson reviewed Oct 31, 2018 View changes

annthurium added some commits Nov 6, 2018

kuychaco reviewed Nov 6, 2018 View changes

annthurium dismissed smashwilson’s stale review Nov 6, 2018

Hide details View details annthurium merged commit 26c39ee into master Nov 7, 2018 7 checks passed

7 checks passed

Feature Sprint : 1 October - 19 November 2018 : v0.21.0 automation moved this from QA Review 🔬 to Merged ☑️ Nov 7, 2018

annthurium deleted the ku-tt-commit-msg-template branch Nov 7, 2018

vanessayuenn referenced this pull request Nov 21, 2018

kuychaco commented Oct 25, 2018 •

edited by smashwilson

annthurium reviewed Oct 25, 2018

View changes

annthurium reviewed Oct 25, 2018

View changes

coveralls commented Oct 26, 2018 •

edited

smashwilson reviewed Oct 29, 2018

View changes

smashwilson commented Oct 30, 2018 •

edited

smashwilson reviewed Oct 31, 2018

View changes

kuychaco reviewed Nov 6, 2018

View changes

annthurium merged commit `26c39ee` into master Nov 7, 2018
7 checks passed