This is an archive of the discontinued Mercurial Phabricator instance.

Differential D3578

state: set canonical=True to write deterministically
ClosedPublic

Authored by pulkit on May 18 2018, 7:18 AM.

Details

Reviewers
martinvonz
Group Reviewers
hg-reviewers
Commits
rHG18c6d8b565bf: state: set canonical=True to write deterministically
Summary

Passing canonical=True to cbor.dump() will help in writing the data
deterministically. This will sort all the sets and dicts before writing to the
file. Thanks indygreg for recommending to use it.

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

pulkit created this revision.May 18 2018, 7:18 AM
martinvonz accepted this revision.May 21 2018, 11:59 AM
This revision is now accepted and ready to land.May 21 2018, 11:59 AM
Closed by commit rHG18c6d8b565bf: state: set canonical=True to write deterministically (authored by pulkit). · Explain WhyMay 21 2018, 1:40 PM
This revision was automatically updated to reflect the committed changes.

Revision Contents
Changeset List

Diff 8852

mercurial/state.py

return self._read() return self._read()
def save(self, data): def save(self, data):
"""write all the state data stored to .hg/<filename> file """write all the state data stored to .hg/<filename> file
we use third-party library cbor to serialize data to write in the file. we use third-party library cbor to serialize data to write in the file.
""" """
with self._repo.vfs(self.fname, 'wb', atomictemp=True) as fp: with self._repo.vfs(self.fname, 'wb', atomictemp=True) as fp:
cbor.dump(self.opts, fp) cbor.dump(self.opts, fp, canonical=True)
def _read(self): def _read(self):
"""reads the state file and returns a dictionary which contain """reads the state file and returns a dictionary which contain
data in the same format as it was before storing""" data in the same format as it was before storing"""
with self._repo.vfs(self.fname, 'rb') as fp: with self._repo.vfs(self.fname, 'rb') as fp:
return cbor.load(fp) return cbor.load(fp)
def delete(self): def delete(self):
"""drop the state file if exists""" """drop the state file if exists"""
util.unlinkpath(self._repo.vfs.join(self.fname), ignoremissing=True) util.unlinkpath(self._repo.vfs.join(self.fname), ignoremissing=True)
def exists(self): def exists(self):
"""check whether the state file exists or not""" """check whether the state file exists or not"""
return self._repo.vfs.exists(self.fname) return self._repo.vfs.exists(self.fname)