Mercurial > hg
view tests/test-bugzilla.t @ 49000:dd6b67d5c256 stable
rust: fix unsound `OwningDirstateMap`
As per the previous patch, `OwningDirstateMap` is unsound. Self-referential
structs are difficult to implement correctly in Rust since the compiler is
free to move structs around as much as it wants to. They are also very rarely
needed in practice, so the state-of-the-art on how they should be done within
the Rust rules is still a bit new.
The crate `ouroboros` is an attempt at providing a safe way (in the Rust sense)
of declaring self-referential structs. It is getting a lot attention and was
improved very quickly when soundness issues were found in the past: rather than
relying on our own (limited) review circle, we might as well use the de-facto
common crate to fix this problem. This will give us a much better chance of
finding issues should any new ones be discovered as well as the benefit of
fewer `unsafe` APIs of our own.
I was starting to think about how I would present a safe API to the old struct
but soon realized that the callback-based approach was already done in
`ouroboros`, along with a lot more care towards refusing incorrect structs.
In short: we don't return a mutable reference to the `DirstateMap` anymore, we
expect users of its API to pass a `FnOnce` that takes the map as an argument.
This allows our `OwningDirstateMap` to control the input and output lifetimes
of the code that modifies it to prevent such issues.
Changing to `ouroboros` meant changing every API with it, but it is relatively
low churn in the end. It correctly identified the example buggy modification of
`copy_map_insert` outlined in the previous patch as violating the borrow rules.
Differential Revision: https://phab.mercurial-scm.org/D12429
author | Raphaël Gomès <rgomes@octobus.net> |
---|---|
date | Tue, 05 Apr 2022 10:55:28 +0200 |
parents | 7370f302be71 |
children | 42d2b31cee0b |
line wrap: on
line source
mock bugzilla driver for testing template output: $ cat <<EOF > bzmock.py > from __future__ import absolute_import > from mercurial import extensions > from mercurial import pycompat > from mercurial import registrar > from mercurial.utils import stringutil > > configtable = {} > configitem = registrar.configitem(configtable) > > configitem(b'bugzilla', b'mocklog', > default=None, > ) > def extsetup(ui): > bugzilla = extensions.find(b'bugzilla') > class bzmock(bugzilla.bzaccess): > def __init__(self, ui): > super(bzmock, self).__init__(ui) > self._logfile = ui.config(b'bugzilla', b'mocklog') > def updatebug(self, bugid, newstate, text, committer): > with open(pycompat.fsdecode(self._logfile), 'ab') as f: > f.write(b'update bugid=%s, newstate=%s, committer=%s\n' > % (stringutil.pprint(bugid), > stringutil.pprint(newstate), > stringutil.pprint(committer))) > f.write(b'----\n' + text + b'\n----\n') > def notify(self, bugs, committer): > with open(pycompat.fsdecode(self._logfile), 'ab') as f: > f.write(b'notify bugs=%s, committer=%s\n' > % (stringutil.pprint(bugs), > stringutil.pprint(committer))) > bugzilla.bugzilla._versions[b'mock'] = bzmock > EOF set up mock repository: $ hg init mockremote $ cat <<EOF > mockremote/.hg/hgrc > [extensions] > bugzilla = > bzmock = $TESTTMP/bzmock.py > > [bugzilla] > version = mock > mocklog = $TESTTMP/bzmock.log > > [hooks] > incoming.bugzilla = python:hgext.bugzilla.hook > > [web] > baseurl=http://example.org/hg > > %include $TESTTMP/bzstyle.hgrc > EOF $ hg clone -q mockremote mocklocal push with default template: $ echo '[bugzilla]' > bzstyle.hgrc $ echo foo > mocklocal/foo $ hg ci -R mocklocal -Aqm 'Fixes bug 123' $ hg -R mocklocal push -q $ cat bzmock.log && rm bzmock.log update bugid=123, newstate={}, committer='test' ---- changeset 7875a8342c6f in repo $TESTTMP/mockremote refers to bug 123. details: Fixes bug 123 ---- notify bugs={123: {}}, committer='test' push with style: $ cat <<EOF > bzstyle.map > changeset = "{node|short} refers to bug {bug}." > EOF $ echo "style = $TESTTMP/bzstyle.map" >> bzstyle.hgrc $ echo foo >> mocklocal/foo $ hg ci -R mocklocal -qm 'Fixes bug 456' $ hg -R mocklocal push -q $ cat bzmock.log && rm bzmock.log update bugid=456, newstate={}, committer='test' ---- 2808b172464b refers to bug 456. ---- notify bugs={456: {}}, committer='test' push with template (overrides style): $ cat <<EOF >> bzstyle.hgrc > template = Changeset {node|short} in {root|basename}. > {hgweb}/rev/{node|short}\n > {desc} > EOF $ echo foo >> mocklocal/foo $ hg ci -R mocklocal -qm 'Fixes bug 789' $ hg -R mocklocal push -q $ cat bzmock.log && rm bzmock.log update bugid=789, newstate={}, committer='test' ---- Changeset a770f3e409f2 in mockremote. http://example.org/hg/rev/a770f3e409f2 Fixes bug 789 ---- notify bugs={789: {}}, committer='test'