lfs: import the Facebook git-lfs client extension The purpose of this is the same as the built-in largefiles extension- to handle huge files outside of the normal storage system, generally to keep the amount of data cloned to a lower amount. There are several benefits of implementing the git-lfs protocol, instead of using the largefiles extension: - Bitbucket and Github support (and probably wider support in 3rd party hosting sites in general). [1][2] - The number of hg internals monkey patched are several orders of magnitude lower, so it will be easier to reason about and maintain. Future commands will likely just work, without requiring various wrappers. - The "standin" files are only written to the filelog, not the disk. That should avoid weird edge cases where the largefile and standin files get out of sync. [3] It also avoids the occasional printing of the "hidden" standin file in various messages. - Filesets like size() will work, even if the file isn't present. (It always says 41 bytes for largefiles, whether present or not.) The only place that I see where largefiles comes out on top is that it works with `hg serve` for simple sharing, without external infrastructure. Getting lfs-test-server working was a hassle, and took awhile to figure out. Maybe we can do something to make it work in the future. Long term, I expect that this will be highly preferred over largefiles. But if we are to recommend this to largefile users, there are some UI issues to bikeshed. Until they are resolved, I've marked this experimental, and am not putting a pointer to this in the largefiles help. The (non exhaustive) list of issues I've seen so far are: - It isn't sufficient to just enable the largefiles extension- you have to explicitly add a file with --large before it will pay attention to the configured sizes and patterns on future adds. The justification being that once you use it, you're stuck with it. I've seen people confused by this, and haven't liked it myself. But it's also saved me a few times. Should we do something like have a specific enabling config setting that must be set in the local repo config, so that enabling this extension in the user or system hgrc doesn't silently start storing lfs files? - The largefiles extension adds a repo requirement when the first largefile is committed, so that the extension must always be enabled in the future. This extension is not doing that, and since I only enabled it locally to avoid infecting other repos, I got a cryptic error about missing flag processors when I cloned. Is there no repo requirement due to shallow/narrow clone considerations (or other future advanced things)? - In the (small amount of) reading I've done about the git implementation, it seems that the files and sizes are stored in a tracked .gitattributes file. I think a tracked file for this would be extremely useful for consistency across developers, but this kind of touches on the tracked hgrc file proposal a few months back. - The git client can specify file patterns, not just sizes. - The largefiles extension has a cache directory in the local repo, but also a system wide one. We should probably implement a system wide cache too, so that multiple clones don't have to refetch the files from the server. - Jun mentioned other missing features, like SSH authentication, gc, etc. The code corresponds to c0492b73c7ef in hg-experimental. [4] The only tweaks are to load the extension in the tests with 'lfs=' instead of 'lfs=$TESTDIR/../hgext3rd/lfs', change the import in the *.py test to hgext (from hgext3rd), add the 'testedwith' declaration, and mark it experimental for now. The infinite-push, p4fastimport, and remotefilelog tests were left behind. The devel-warnings for unregistered config options are not corrected yet, nor are the import check warnings. [1] https://www.mercurial-scm.org/pipermail/mercurial/2017-November/050699.html [2] https://bitbucket.org/site/master/issues/3843/largefiles-support-bb-3903 [3] https://bz.mercurial-scm.org/show_bug.cgi?id=5738 [4] https://bitbucket.org/facebook/hg-experimental

     1

# pointer.py - Git-LFS pointer serialization

     2

#

     3

# Copyright 2017 Facebook, Inc.

     4

#

     5

# This software may be used and distributed according to the terms of the

     6

# GNU General Public License version 2 or any later version.

     7

     8

from __future__ import absolute_import

     9

    10

import re

    11

    12

from mercurial import (

    13

    error,

    14

)

    15

from mercurial.i18n import _

    16

    17

class InvalidPointer(error.RevlogError):

    18

    pass

    19

    20

class gitlfspointer(dict):

    21

    VERSION = 'https://git-lfs.github.com/spec/v1'

    22

    23

    def __init__(self, *args, **kwargs):

    24

        self['version'] = self.VERSION

    25

        super(gitlfspointer, self).__init__(*args, **kwargs)

    26

    27

    @classmethod

    28

    def deserialize(cls, text):

    29

        try:

    30

            return cls(l.split(' ', 1) for l in text.splitlines()).validate()

    31

        except ValueError: # l.split returns 1 item instead of 2

    32

            raise InvalidPointer(_('cannot parse git-lfs text: %r') % text)

    33

    34

    def serialize(self):

    35

        sortkeyfunc = lambda x: (x[0] != 'version', x)

    36

        items = sorted(self.validate().iteritems(), key=sortkeyfunc)

    37

        return ''.join('%s %s\n' % (k, v) for k, v in items)

    38

    39

    def oid(self):

    40

        return self['oid'].split(':')[-1]

    41

    42

    def size(self):

    43

        return int(self['size'])

    44

    45

    # regular expressions used by _validate

    46

    # see https://github.com/git-lfs/git-lfs/blob/master/docs/spec.md

    47

    _keyre = re.compile(r'\A[a-z0-9.-]+\Z')

    48

    _valuere = re.compile(r'\A[^\n]*\Z')

    49

    _requiredre = {

    50

        'size': re.compile(r'\A[0-9]+\Z'),

    51

        'oid': re.compile(r'\Asha256:[0-9a-f]{64}\Z'),

    52

        'version': re.compile(r'\A%s\Z' % re.escape(VERSION)),

    53

    }

    54

    55

    def validate(self):

    56

        """raise InvalidPointer on error. return self if there is no error"""

    57

        requiredcount = 0

    58

        for k, v in self.iteritems():

    59

            if k in self._requiredre:

    60

                if not self._requiredre[k].match(v):

    61

                    raise InvalidPointer(_('unexpected value: %s=%r') % (k, v))

    62

                requiredcount += 1

    63

            elif not self._keyre.match(k):

    64

                raise InvalidPointer(_('unexpected key: %s') % k)

    65

            if not self._valuere.match(v):

    66

                raise InvalidPointer(_('unexpected value: %s=%r') % (k, v))

    67

        if len(self._requiredre) != requiredcount:

    68

            miss = sorted(set(self._requiredre.keys()).difference(self.keys()))

    69

            raise InvalidPointer(_('missed keys: %s') % ', '.join(miss))

    70

        return self

    71

    72

deserialize = gitlfspointer.deserialize