This is an archive of the discontinued Mercurial Phabricator instance.

Differential D9325

histedit: don't crash if commit message is empty
ClosedPublic

Authored by martinvonz on Nov 16 2020, 2:10 PM.

Details

Reviewers
durin42
pulkit
Group Reviewers
hg-reviewers
Commits
rHGf4065c3f09b8: histedit: don't crash if commit message is empty
Summary

If the commit message is empty, histedit will crash before this patch
because it assumes that summary.splitlines() is non-empty. One of
our users at work ran into this crash for a commit that was created by
an internal system.

I don't think we have a good way of testing this because it's hard to
create a commit with an empty commit message. I've added a comment to
help prevent regressions.

Diff Detail

Repository
rHG Mercurial
Branch
default
Lint
No Linters Available
Unit
No Unit Test Coverage

Event Timeline

martinvonz created this revision.Nov 16 2020, 2:10 PM
durin42 requested changes to this revision.Nov 18 2020, 5:49 PM

Needs rebased.

This revision now requires changes to proceed.Nov 18 2020, 5:49 PM
martinvonz updated this revision to Diff 23557.Nov 19 2020, 1:54 AM
martinvonz added a comment.Nov 19 2020, 1:54 AM
In D9325#140404, @durin42 wrote:

Needs rebased.

Done

pulkit accepted this revision.Nov 21 2020, 2:26 AM
martinvonz added a commit: rHGf4065c3f09b8: histedit: don't crash if commit message is empty.Nov 21 2020, 3:26 AM
This revision was not accepted when it landed; it landed in state Needs Review.
Closed by commit rHGf4065c3f09b8: histedit: don't crash if commit message is empty (authored by martinvonz). · Explain Why
This revision was automatically updated to reflect the committed changes.

Revision Contents
Changeset List

PathPackages
Mhgext/histedit.py (3 lines)

Diff 23557

hgext/histedit.py

# We don't want color codes in the commit message template, so # We don't want color codes in the commit message template, so
# disable the label() template function while we render it. # disable the label() template function while we render it.
with ui.configoverride( with ui.configoverride(
{(b'templatealias', b'label(l,x)'): b"x"}, b'histedit' {(b'templatealias', b'label(l,x)'): b"x"}, b'histedit'
): ):
summary = cmdutil.rendertemplate( summary = cmdutil.rendertemplate(
ctx, ui.config(b'histedit', b'summary-template') ctx, ui.config(b'histedit', b'summary-template')
) )
summary = summary.splitlines()[0] # Handle the fact that `''.splitlines() => []`
summary = summary.splitlines()[0] if summary else b''
line = b'%s %s %s' % (self.verb, ctx, summary) line = b'%s %s %s' % (self.verb, ctx, summary)
# trim to 75 columns by default so it's not stupidly wide in my editor # trim to 75 columns by default so it's not stupidly wide in my editor
# (the 5 more are left for verb) # (the 5 more are left for verb)
maxlen = self.repo.ui.configint(b'histedit', b'linelen') maxlen = self.repo.ui.configint(b'histedit', b'linelen')
maxlen = max(maxlen, 22) # avoid truncating hash maxlen = max(maxlen, 22) # avoid truncating hash
return stringutil.ellipsis(line, maxlen) return stringutil.ellipsis(line, maxlen)
def tostate(self): def tostate(self):