Re-introduce commit message template #1756

kuychaco · 2018-10-25T02:52:19Z

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

…-template" This reverts commit c96687a, reversing changes made to 4bc7fde.

Co-Authored-By: Tilde Ann Thurium <[email protected]>

Repro steps: open repo with merge conflict click undo see error (cannot do a soft reset in the middle of a merge) expected: no change to commit message box actual: commit message from last commit appears in box

See #1464 (for performance)

It's best to assume that template users craft their template exactly as they want it. For example, I have two empty lines at the beginning of mine so that I can quickly type my message.

We don't want it to be at the end

@smashwilson

According to @smashwilson > it may be worth triggering some of that behavior manually if a user aborts (or, eventually, initiates) a merge through our UI. in terms of reliability - on all three platforms there is some risk of dropped events that increases with the number of events that arrive in quick succession (like if a ton of files are created at once). merges in huge repositories _might_ trigger this but it shouldn't be common. Co-Authored-By: Ash Wilson <[email protected]>

…vents

Co-Authored-By: Matt <[email protected]>

We don't want to be setting up a commit template for every single test that runs. We do it locally for the tests that need it

Co-Authored-By: Matt <[email protected]>

lib/git-shell-out-strategy.js

lib/models/repository-states/present.js

lib/views/commit-view.js

Co-Authored-By: Katrina Uychaco <[email protected]>

annthurium · 2018-10-25T22:17:19Z

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 😉

Co-Authored-By: Katrina Uychaco <[email protected]>

coveralls · 2018-10-26T00:22:20Z

Coverage increased (+0.05%) to 84.925% when pulling acf502c on ku-tt-commit-msg-template into 32c39c2 on master.

coveralls · 2018-10-26T00:22:21Z

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

Co-Authored-By: Katrina Uychaco <[email protected]>

This only works for commit message templates where every line starts with a #. We explored using isCommitMessageClean to try and handle commit message templates that have uncommented lines. We're not calling didUpdate every time the commit message is updated, so it's out of sync, and we decided it was getting too edge casey out there. Co-Authored-By: Katrina Uychaco <[email protected]>

smashwilson

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 · 2018-10-29T17:35:49Z

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 · 2018-10-29T17:54:10Z

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 · 2018-10-29T18:07:41Z

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 · 2018-10-29T18:11:53Z

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?

Co-Authored-By: Katrina Uychaco <[email protected]>

Co-Authored-By: Tilde Ann Thurium <[email protected]>

Tests were failing because my global config was being used to look up the commit template

Co-Authored-By: Ash Wilson <[email protected]>

…mplate

smashwilson · 2018-10-30T23:42:29Z

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 · 2018-10-30T23:46:42Z

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

smashwilson · 2018-10-31T00:37:24Z

👍 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

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 👍

lib/models/repository-states/present.js

this bug has been addressed

kuychaco and others added 26 commits October 23, 2018 14:57

Revert "Merge pull request #1754 from atom/revert-1713-feature/commit…

f5ccd16

…-template" This reverts commit c96687a, reversing changes made to 4bc7fde.

🎨 getCommitMessageFromTemplate tests. Return null if config not set

0a24012

Co-Authored-By: Tilde Ann Thurium <[email protected]>

Restore state from last commit only if undo is successful

49a1d31

Repro steps: open repo with merge conflict click undo see error (cannot do a soft reset in the middle of a merge) expected: no change to commit message box actual: commit message from last commit appears in box

Pass events to observeFilesystemChange in order to use action property

3ebda2f

Update commit message after file system change for MERGE_HEAD or config

b6ef6d2

👕

d895691

Load initial commit message based on template or merge state

bcbbff8

🎨 variable message -> template

b8e55ab

Don't set merge message in controller, now handled in repository

ca10d13

Fix repo test now that we are passing events and not paths

99fe542

WIP tests for CommitController

40b015e

Suppress repo update when typing commit message

ade7de8

See #1464 (for performance)

Don't trim commit message template

7c18ddb

It's best to assume that template users craft their template exactly as they want it. For example, I have two empty lines at the beginning of mine so that I can quickly type my message.

🎨 rename getCommitMessageFromTemplate to getCommitMessageTemplate

7a73138

Enable commit button only if message contains non-comment lines

b16525c

Set cursor to beginning of commit message template

b3cc2c3

We don't want it to be at the end

Add repository tests for commit message updating due to file system e…

b3588ef

…vents

Trim message before checking if clean

4a1525b

🔥 merge message tests in CommitController (now handled in repo)

2c2857e

Fix WorkdirContext test

f780ad1

Fix CommitController tests

5ee83db

Co-Authored-By: Matt <[email protected]>

🔥 commit-template test fixture

6e45f0c

Clean up cloneRepository

56d9f5e

We don't want to be setting up a commit template for every single test that runs. We do it locally for the tests that need it

🔥 comment

d145084

Co-Authored-By: Matt <[email protected]>

Fix and clean up GitStrategies tests

8a40a74

annthurium reviewed Oct 25, 2018

View reviewed changes

add comment explaining regex

63ffa69

Co-Authored-By: Katrina Uychaco <[email protected]>

annthurium reviewed Oct 25, 2018

View reviewed changes

cleanup some dead code

c15f1d0

Co-Authored-By: Katrina Uychaco <[email protected]>

Merge branch 'master' into pr-1756/atom/ku-tt-commit-msg-template

acf502c

Co-Authored-By: Katrina Uychaco <[email protected]>

annthurium force-pushed the ku-tt-commit-msg-template branch from a24bad7 to acf502c Compare October 26, 2018 00:08

Tilde Ann Thurium and others added 3 commits October 25, 2018 17:24

test merged changes + cleanup

9b606ba

Co-Authored-By: Katrina Uychaco <[email protected]>

Retry flakey file patch test

d331372

kuychaco requested a review from smashwilson October 26, 2018 18:20

smashwilson reviewed Oct 29, 2018

View reviewed changes

Tilde Ann Thurium and others added 9 commits October 29, 2018 15:34

extract regex and give it a better name

13e7342

Co-Authored-By: Katrina Uychaco <[email protected]>

rename getCommitMessageTemplate to fetchCommitMessageTemplate

218f193

Co-Authored-By: Katrina Uychaco <[email protected]>

extract filePathEndsWith into helper function

e2cc423

Extract wireUpObserver and expectEvents to test helpers file

b3c9ec7

Co-Authored-By: Tilde Ann Thurium <[email protected]>

Access local config in spec mode

37fbb44

Tests were failing because my global config was being used to look up the commit template

Don't break snapshotting by accessing atom in global scope

6299ae2

Co-Authored-By: Ash Wilson <[email protected]>

Test flakes

8aaf2ac

Merge remote-tracking branch 'origin/master' into ku-tt-commit-msg-te…

e8e39db

…mplate

Retry file-patch test flakes

3e1cb40

smashwilson previously requested changes Oct 31, 2018

View reviewed changes

Tilde Ann Thurium added 2 commits November 6, 2018 13:22

handle case where template is unset

a87b3a4

add unit test for unsetting commit template

6f88f76

kuychaco commented Nov 6, 2018

View reviewed changes

lib/models/repository-states/present.js Outdated Show resolved Hide resolved

address code review feedback.

4e400bd

annthurium merged commit 26c39ee into master Nov 7, 2018

annthurium deleted the ku-tt-commit-msg-template branch November 7, 2018 19:32

vanessayuenn mentioned this pull request Nov 21, 2018

v0.23.0-0 QA Review #1806

Closed

5 tasks

Re-introduce commit message template #1756

Re-introduce commit message template #1756

Uh oh!

Conversation

kuychaco commented Oct 25, 2018 • edited by smashwilson Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description of the Change

Alternate Designs

Benefits

Possible Drawbacks

Applicable Issues

Metrics

Tests

Documentation

User Experience Research (Optional)

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

coveralls commented Oct 26, 2018

Uh oh!

coveralls commented Oct 26, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

smashwilson left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

smashwilson commented Oct 30, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

smashwilson commented Oct 30, 2018

Uh oh!

smashwilson commented Oct 31, 2018

Uh oh!

smashwilson left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

kuychaco commented Oct 25, 2018 •

edited by smashwilson

Loading

coveralls commented Oct 26, 2018 •

edited

Loading

smashwilson commented Oct 30, 2018 •

edited

Loading