This is an archive of the discontinued Mercurial Phabricator instance.

Differential D9841

share-share: have the hint issue more consistently and point to the right doc
ClosedPublic

Authored by marmoute on Jan 20 2021, 6:53 AM.

Details

Reviewers
pulkit
mharbison72
Group Reviewers
hg-reviewers
Commits
rHG4a58561ace0f: share-share: have the hint issue more consistently and point to the right doc
Summary

This should help user in trouble to find solution in the documentation.

Diff Detail

Repository
rHG Mercurial
Lint
Automatic diff as part of commit; lint not applicable.
Unit
Automatic diff as part of commit; unit tests not applicable.

Event Timeline

marmoute created this revision.Jan 20 2021, 6:53 AM
baymax updated this revision to Diff 25175.Jan 20 2021, 7:33 AM

✅ refresh by Heptapod after a successful CI run (🐙 💚)

pulkit accepted this revision.Jan 21 2021, 6:15 AM
pulkit added a subscriber: pulkit.
pulkit added inline comments.
mercurial/localrepo.py
622

Since we are using the same hint now, we can assign it before the if-else.

This revision is now accepted and ready to land.Jan 21 2021, 6:15 AM
baymax updated this revision to Diff 25197.Jan 21 2021, 8:26 AM

✅ refresh by Heptapod after a successful CI run (🐙 💚)

marmoute added inline comments.Jan 21 2021, 9:23 AM
mercurial/localrepo.py
622

good catch. This is now so.

mharbison72 accepted this revision.Jan 21 2021, 11:15 PM

Revision Contents
Changeset List

PathPackages
Mmercurial/localrepo.py (11 lines)
Mmercurial/upgrade.py (18 lines)
Mtests/test-share-safe.t (7 lines)

Diff 25213

mercurial/localrepo.py

# NOTE: presence of SHARESAFE_REQUIREMENT imply that store requirement # NOTE: presence of SHARESAFE_REQUIREMENT imply that store requirement
# is present. We never write SHARESAFE_REQUIREMENT for a repo if store # is present. We never write SHARESAFE_REQUIREMENT for a repo if store
# is not present, refer checkrequirementscompat() for that # is not present, refer checkrequirementscompat() for that
# #
# However, if SHARESAFE_REQUIREMENT is not present, it means that the # However, if SHARESAFE_REQUIREMENT is not present, it means that the
# repository was shared the old way. We check the share source .hg/requires # repository was shared the old way. We check the share source .hg/requires
# for SHARESAFE_REQUIREMENT to detect whether the current repository needs # for SHARESAFE_REQUIREMENT to detect whether the current repository needs
# to be reshared # to be reshared
hint = _("see `hg help config.format.use-share-safe` for more information")
if requirementsmod.SHARESAFE_REQUIREMENT in requirements: if requirementsmod.SHARESAFE_REQUIREMENT in requirements:
if ( if (
shared shared
and requirementsmod.SHARESAFE_REQUIREMENT and requirementsmod.SHARESAFE_REQUIREMENT
not in _readrequires(sharedvfs, True) not in _readrequires(sharedvfs, True)
): ):
mismatch_warn = ui.configbool( mismatch_warn = ui.configbool(
requirements, requirements,
mismatch_config, mismatch_config,
mismatch_warn, mismatch_warn,
) )
elif mismatch_config == b'abort': elif mismatch_config == b'abort':
raise error.Abort( raise error.Abort(
_( _(
b"share source does not support exp-sharesafe requirement" b"share source does not support exp-sharesafe requirement"
) ),
hint=hint,
) )
else: else:
hint = _(
"run `hg help config.share.safe-mismatch.source-not-safe`"
)
raise error.Abort( raise error.Abort(
_( _(
b"share-safe mismatch with source.\nUnrecognized" b"share-safe mismatch with source.\nUnrecognized"
b" value '%s' of `share.safe-mismatch.source-not-safe`" b" value '%s' of `share.safe-mismatch.source-not-safe`"
b" set." b" set."
) )
% mismatch_config, % mismatch_config,
hint=hint, hint=hint,
) )
else: else:
requirements |= _readrequires(storevfs, False) requirements |= _readrequires(storevfs, False)
elif shared: elif shared:
sourcerequires = _readrequires(sharedvfs, False) sourcerequires = _readrequires(sharedvfs, False)
if requirementsmod.SHARESAFE_REQUIREMENT in sourcerequires: if requirementsmod.SHARESAFE_REQUIREMENT in sourcerequires:
pulkitUnsubmitted
Not Done

Since we are using the same hint now, we can assign it before the if-else.

pulkit: Since we are using the same hint now, we can assign it before the if-else.
marmouteAuthorUnsubmitted
Done

good catch. This is now so.

marmoute: good catch. This is now so.
mismatch_config = ui.config(b'share', b'safe-mismatch.source-safe') mismatch_config = ui.config(b'share', b'safe-mismatch.source-safe')
mismatch_warn = ui.configbool( mismatch_warn = ui.configbool(
b'share', b'safe-mismatch.source-safe.warn' b'share', b'safe-mismatch.source-safe.warn'
) )
if mismatch_config in ( if mismatch_config in (
b'upgrade-allow', b'upgrade-allow',
b'allow', b'allow',
b'upgrade-abort', b'upgrade-abort',
mismatch_config, mismatch_config,
mismatch_warn, mismatch_warn,
) )
elif mismatch_config == b'abort': elif mismatch_config == b'abort':
raise error.Abort( raise error.Abort(
_( _(
b'version mismatch: source uses share-safe' b'version mismatch: source uses share-safe'
b' functionality while the current share does not' b' functionality while the current share does not'
) ),
hint=hint,
) )
else: else:
hint = _("run `hg help config.share.safe-mismatch.source-safe`")
raise error.Abort( raise error.Abort(
_( _(
b"share-safe mismatch with source.\nUnrecognized" b"share-safe mismatch with source.\nUnrecognized"
b" value '%s' of `share.safe-mismatch.source-safe` set." b" value '%s' of `share.safe-mismatch.source-safe` set."
) )
% mismatch_config, % mismatch_config,
hint=hint, hint=hint,
) )

mercurial/upgrade.py

current_requirements |= locked_requirements current_requirements |= locked_requirements
diffrequires = current_requirements - store_requirements diffrequires = current_requirements - store_requirements
# add share-safe requirement as it will mark the share as share-safe # add share-safe requirement as it will mark the share as share-safe
diffrequires.add(requirementsmod.SHARESAFE_REQUIREMENT) diffrequires.add(requirementsmod.SHARESAFE_REQUIREMENT)
current_requirements.add(requirementsmod.SHARESAFE_REQUIREMENT) current_requirements.add(requirementsmod.SHARESAFE_REQUIREMENT)
scmutil.writerequires(hgvfs, diffrequires) scmutil.writerequires(hgvfs, diffrequires)
ui.warn(_(b'repository upgraded to use share-safe mode\n')) ui.warn(_(b'repository upgraded to use share-safe mode\n'))
except error.LockError as e: except error.LockError as e:
hint = _(
"see `hg help config.format.use-share-safe` for more information"
)
if mismatch_config == b'upgrade-abort': if mismatch_config == b'upgrade-abort':
raise error.Abort( raise error.Abort(
_(b'failed to upgrade share, got error: %s') _(b'failed to upgrade share, got error: %s')
% stringutil.forcebytestr(e.strerror) % stringutil.forcebytestr(e.strerror),
hint=hint,
) )
elif mismatch_warn: elif mismatch_warn:
ui.warn( ui.warn(
_(b'failed to upgrade share, got error: %s\n') _(b'failed to upgrade share, got error: %s\n')
% stringutil.forcebytestr(e.strerror) % stringutil.forcebytestr(e.strerror),
hint=hint,
) )
finally: finally:
if wlock: if wlock:
wlock.release() wlock.release()
def downgrade_share_to_non_safe( def downgrade_share_to_non_safe(
ui, ui,
# as reference # as reference
current_requirements -= removed current_requirements -= removed
current_requirements |= locked_requirements current_requirements |= locked_requirements
current_requirements |= source_requirements current_requirements |= source_requirements
current_requirements -= set(requirementsmod.SHARESAFE_REQUIREMENT) current_requirements -= set(requirementsmod.SHARESAFE_REQUIREMENT)
scmutil.writerequires(hgvfs, current_requirements) scmutil.writerequires(hgvfs, current_requirements)
ui.warn(_(b'repository downgraded to not use share-safe mode\n')) ui.warn(_(b'repository downgraded to not use share-safe mode\n'))
except error.LockError as e: except error.LockError as e:
hint = _(
"see `hg help config.format.use-share-safe` for more information"
)
# If upgrade-abort is set, abort when upgrade fails, else let the # If upgrade-abort is set, abort when upgrade fails, else let the
# process continue as `upgrade-allow` is set # process continue as `upgrade-allow` is set
if mismatch_config == b'downgrade-abort': if mismatch_config == b'downgrade-abort':
raise error.Abort( raise error.Abort(
_(b'failed to downgrade share, got error: %s') _(b'failed to downgrade share, got error: %s')
% stringutil.forcebytestr(e.strerror) % stringutil.forcebytestr(e.strerror),
hint=hint,
) )
elif mismatch_warn: elif mismatch_warn:
ui.warn( ui.warn(
_(b'failed to downgrade share, got error: %s\n') _(b'failed to downgrade share, got error: %s\n')
% stringutil.forcebytestr(e.strerror) % stringutil.forcebytestr(e.strerror),
hint=hint,
) )
finally: finally:
if wlock: if wlock:
wlock.release() wlock.release()

tests/test-share-safe.t

| |
o f3ba8b99bb6f897c87bbc1c07b75c6ddf43a4f77: added foo o f3ba8b99bb6f897c87bbc1c07b75c6ddf43a4f77: added foo
Make sure existing shares dont work with default config Make sure existing shares dont work with default config
$ hg log -GT "{node}: {desc}\n" -R ../nss-share $ hg log -GT "{node}: {desc}\n" -R ../nss-share
abort: version mismatch: source uses share-safe functionality while the current share does not abort: version mismatch: source uses share-safe functionality while the current share does not
(see `hg help config.format.use-share-safe` for more information)
[255] [255]
Create a safe share from upgrade one Create a safe share from upgrade one
$ cd .. $ cd ..
$ hg share non-share-safe ss-share $ hg share non-share-safe ss-share
updating working directory updating working directory
$ hg log -GT "{node}: {desc}\n" -R ../nss-share $ hg log -GT "{node}: {desc}\n" -R ../nss-share
@ f63db81e6dde1d9c78814167f77fb1fb49283f4f: added bar @ f63db81e6dde1d9c78814167f77fb1fb49283f4f: added bar
| |
o f3ba8b99bb6f897c87bbc1c07b75c6ddf43a4f77: added foo o f3ba8b99bb6f897c87bbc1c07b75c6ddf43a4f77: added foo
$ hg log -GT "{node}: {desc}\n" -R ../ss-share $ hg log -GT "{node}: {desc}\n" -R ../ss-share
abort: share source does not support exp-sharesafe requirement abort: share source does not support exp-sharesafe requirement
(see `hg help config.format.use-share-safe` for more information)
[255] [255]
Testing automatic downgrade of shares when config is set Testing automatic downgrade of shares when config is set
$ touch ../ss-share/.hg/wlock $ touch ../ss-share/.hg/wlock
$ hg log -GT "{node}: {desc}\n" -R ../ss-share --config share.safe-mismatch.source-not-safe=downgrade-abort $ hg log -GT "{node}: {desc}\n" -R ../ss-share --config share.safe-mismatch.source-not-safe=downgrade-abort
abort: failed to downgrade share, got error: Lock held abort: failed to downgrade share, got error: Lock held
(see `hg help config.format.use-share-safe` for more information)
[255] [255]
$ rm ../ss-share/.hg/wlock $ rm ../ss-share/.hg/wlock
$ hg log -GT "{node}: {desc}\n" -R ../ss-share --config share.safe-mismatch.source-not-safe=downgrade-abort $ hg log -GT "{node}: {desc}\n" -R ../ss-share --config share.safe-mismatch.source-not-safe=downgrade-abort
repository downgraded to not use share-safe mode repository downgraded to not use share-safe mode
@ f63db81e6dde1d9c78814167f77fb1fb49283f4f: added bar @ f63db81e6dde1d9c78814167f77fb1fb49283f4f: added bar
| |
o f3ba8b99bb6f897c87bbc1c07b75c6ddf43a4f77: added foo o f3ba8b99bb6f897c87bbc1c07b75c6ddf43a4f77: added foo
fncache fncache
generaldelta generaldelta
revlogv1 revlogv1
share-safe share-safe
sparserevlog sparserevlog
store store
$ hg log -GT "{node}: {desc}\n" -R ../nss-share $ hg log -GT "{node}: {desc}\n" -R ../nss-share
abort: version mismatch: source uses share-safe functionality while the current share does not abort: version mismatch: source uses share-safe functionality while the current share does not
(see `hg help config.format.use-share-safe` for more information)
[255] [255]
Check that if lock is taken, upgrade fails but read operation are successful Check that if lock is taken, upgrade fails but read operation are successful
$ hg log -GT "{node}: {desc}\n" -R ../nss-share --config share.safe-mismatch.source-safe=upgra $ hg log -GT "{node}: {desc}\n" -R ../nss-share --config share.safe-mismatch.source-safe=upgra
abort: share-safe mismatch with source. abort: share-safe mismatch with source.
Unrecognized value 'upgra' of `share.safe-mismatch.source-safe` set. Unrecognized value 'upgra' of `share.safe-mismatch.source-safe` set.
(run `hg help config.share.safe-mismatch.source-safe`) (see `hg help config.format.use-share-safe` for more information)
[255] [255]
$ touch ../nss-share/.hg/wlock $ touch ../nss-share/.hg/wlock
$ hg log -GT "{node}: {desc}\n" -R ../nss-share --config share.safe-mismatch.source-safe=upgrade-allow $ hg log -GT "{node}: {desc}\n" -R ../nss-share --config share.safe-mismatch.source-safe=upgrade-allow
failed to upgrade share, got error: Lock held failed to upgrade share, got error: Lock held
@ f63db81e6dde1d9c78814167f77fb1fb49283f4f: added bar @ f63db81e6dde1d9c78814167f77fb1fb49283f4f: added bar
| |
o f3ba8b99bb6f897c87bbc1c07b75c6ddf43a4f77: added foo o f3ba8b99bb6f897c87bbc1c07b75c6ddf43a4f77: added foo
$ hg log -GT "{node}: {desc}\n" -R ../nss-share --config share.safe-mismatch.source-safe=upgrade-allow --config share.safe-mismatch.source-safe.warn=False $ hg log -GT "{node}: {desc}\n" -R ../nss-share --config share.safe-mismatch.source-safe=upgrade-allow --config share.safe-mismatch.source-safe.warn=False
@ f63db81e6dde1d9c78814167f77fb1fb49283f4f: added bar @ f63db81e6dde1d9c78814167f77fb1fb49283f4f: added bar
| |
o f3ba8b99bb6f897c87bbc1c07b75c6ddf43a4f77: added foo o f3ba8b99bb6f897c87bbc1c07b75c6ddf43a4f77: added foo
$ hg log -GT "{node}: {desc}\n" -R ../nss-share --config share.safe-mismatch.source-safe=upgrade-abort $ hg log -GT "{node}: {desc}\n" -R ../nss-share --config share.safe-mismatch.source-safe=upgrade-abort
abort: failed to upgrade share, got error: Lock held abort: failed to upgrade share, got error: Lock held
(see `hg help config.format.use-share-safe` for more information)
[255] [255]
$ rm ../nss-share/.hg/wlock $ rm ../nss-share/.hg/wlock
$ hg log -GT "{node}: {desc}\n" -R ../nss-share --config share.safe-mismatch.source-safe=upgrade-abort $ hg log -GT "{node}: {desc}\n" -R ../nss-share --config share.safe-mismatch.source-safe=upgrade-abort
repository upgraded to use share-safe mode repository upgraded to use share-safe mode
@ f63db81e6dde1d9c78814167f77fb1fb49283f4f: added bar @ f63db81e6dde1d9c78814167f77fb1fb49283f4f: added bar
| |
o f3ba8b99bb6f897c87bbc1c07b75c6ddf43a4f77: added foo o f3ba8b99bb6f897c87bbc1c07b75c6ddf43a4f77: added foo