Reputation: 8459
Given following scenario.
My expectations are, that the already uploaded files won't be uploaded again using git push
. But what actual happens is that when a new branch is made all files (even when thousands of smaller source files, instead of one 10MB file) will be uploaded again and again.
My question: How can I make it that Git detects that the 10mb file is already uploaded? Do you know a workaround/fix to make Git detecting already existing objects on the server when pushing commits? Git detects files by its sha, so it should be able to detect that some files in the tree of the commit are already present on the server.
Possible use-case: I have two completely different branches, but some common files are shared within those two. When I push one branch, I don't want to upload the common files again when I push the second branch.
Actual use-case: I do a lot of machine learning experiments using Python scripts and some smaller datasets (1MB - 10MB). Every time I start an experiment, I add all necessary experiment files to a new Git tree, and use that tree in a new commit without branching. That commits hangs completely free in the air and gets then referenced with a new Git reference (e.g. refs/jobs/my-experiment-name). When I now have two experiments with almost the same files (and thus two references), Git pushes all objects again when I push those references. I have low bandwidth and this really slows down my work.
$ mkdir git-test && cd git-test
$ git init
$ git remote add origin [email protected]:username/projectname.git
# create dummy 10MB file
$ head -c 10000000 /dev/urandom > dummy
$ git add dummy
$ git commit -m 'init'
# first push, uploads everything - makes sense
$ git push origin master
Counting objects: 3, done.
Delta compression using up to 6 threads.
Compressing objects: 100% (2/2), done.
Writing objects: 100% (3/3), 9.54 MiB | 1.13 MiB/s, done.
Total 3 (delta 0), reused 0 (delta 0)
# create new empty branch, not based from master
$ git checkout --orphan branch2
# add same files again
$ git add dummy
$ git commit -m 'init on branch2'
# this uploads now again the dummy file (10MB), although the server
# has that object alread
$ git push origin branch3
Counting objects: 3, done.
Delta compression using up to 6 threads.
Compressing objects: 100% (2/2), done.
Writing objects: 100% (3/3), 9.54 MiB | 838.00 KiB/s, done.
On the technical side we have:
The solution is unfortunately not that simple.
Every time Git wants to sync two repositories it builds a pack file, that contains all objects necessary (like files, commits, trees). When you execute a git push
, the remote sends all existing references (branches) and its head commit SHA to the client. This is the problem: The pack protocol is not meant to be used per-object, but per-commit.
So, according to the protocol itself, the explained behaviour above is correct. To work around that, I built a simple script every one can use to do a git push
based on objects, instead of commits.
You find it here: https://github.com/marcj/git-objects-sync
What it does:
Of course this has some drawbacks, but I described them in the linked Github repository.
With my script above you get now following:
marc@osx ~/git-test (branch11*) $ # added new branch11 as explained at the very top
marc@osx ~/git-test (branch11*) $ python git-sync.py refs/heads/branch11
Counting objects: 1, done.
Writing objects: 100% (1/1), 158 bytes | 158.00 KiB/s, done.
Total 1 (delta 0), reused 0 (delta 0)
marc@osx ~/git-test (branch11*) $ git push origin branch11
Everything up-to-date
So as you see, it only syncs one object (the commit object), and not the dummy
file and its tree object again.
Upvotes: 13
Views: 5553
Reputation: 9488
As others have mentioned; Git will only check for blobs on the branch you are pushing, but you can trick Git to check for blobs in the master branch by including it in your ancestry.
It seems you really want to work on an orphan branch, so you can merge the master branch only when you want to push. You can ignore the whole contents of the master branch by using the ours
strategy.
% git checkout --orphan branch2
% git rm -rf .
% git checkout master dummy
% git commit -m 'Init on branch2'
% git merge --strategy=ours --allow-unrelated-histories master -m 'Fake merge'
% git push origin branch2
Counting objects: 3, done.
Delta compression using up to 4 threads.
Compressing objects: 100% (2/2), done.
Writing objects: 100% (3/3), 336 bytes | 336.00 KiB/s, done.
Total 3 (delta 1), reused 0 (delta 0)
remote: Resolving deltas: 100% (1/1), done.
To github.com:felipec/bounty-test.git
* [new branch] branch2 -> branch2
The contents are exactly the same:
% git rev-parse branch2:
d0f549d94dbba116d782293722cf9b43e8a67819
% git rev-parse branch2^:
d0f549d94dbba116d782293722cf9b43e8a67819
If you don't want to mess with your original branch, you can create a new branch just for pushing.
Also, you can just start off based of master, and just throw away all the files:
% git checkout -b branch3 master
% git rm -rf .
% git checkout master dummy
% git commit -m 'Init on branch3'
% git push origin branch3
Counting objects: 2, done.
Delta compression using up to 4 threads.
Compressing objects: 100% (1/1), done.
Writing objects: 100% (2/2), 236 bytes | 236.00 KiB/s, done.
Total 2 (delta 0), reused 0 (delta 0)
To github.com:felipec/bounty-test.git
* [new branch] branch3 -> branch3
If you really want this rather specific use-case to be handled properly in Git you might want to contact the developers on the mailing list. They might offer you other alternatives, but it's possible that they won't agree there's something that can be improved in the code without significant trade offs for other cases.
Note: I don't know why you had to add the dummy file in your steps, on my side the whole contents of the master branch are staged when I do git checkout --orphan
.
Upvotes: 1
Reputation: 7488
I think you just need to stop using --orphan
to create new experiment branches.
Workflow
That's it.
What's going on?
You have insisted that you aren't using branches and that you are only using references. However, branches are a kind of reference. Moreover, git checkout --orphan <newthing>
does actually create a branch. The trouble is that its a branch that doesn't know about anything that was previously added to the repository because it has no parents. It's essentially the same thing as having created a whole new repository.
If you create new branches with git checkout -b <newthing> master
, then git will not bother uploaded files that were already in master.
How do you manage new common files now?
Let's say someday you have a new file which you want all future experiments to make use - of a new shared/common file. All you would need to do is add that file to master
and create your next experiment branch based on the updated master branch. If want that file to be available to your existing/previously created experiments, you would just need to checkout those branches and run git pull --rebase origin master
. This would pull in the commits you added to master, which would contain the newly added file(s).
Mounting Complexity
When you start doing pulls, things might start getting complicated. There are a couple different strategies for how to update branches, and using --rebase
is one of those strategies. It's not required, but it's probably the better way to go. There additional things to consider such as how to manage conflicting changes, but those are seemingly outside the scope of this question. There are plenty of resources available to explain rebasing/merging etc.
TR;DR
Don't try to manage commit-trees and parent/child relationships manually. Just let git
do its thing.
Upvotes: 1
Reputation: 10084
It might be better to use Git LFS in your scenario. Git LFS is made for managing large files on git repositories.
As per this github issue (which has been resolved ~2 years ago), duplicate files are managed as a single entity with the same OID. Thus they are pushes only once and fetched just once.
At least Github and Gitlab already include support for git-lfs in all the repositories.
Upvotes: 0
Reputation: 4263
Git develops its manifests and packs up objects using only an exchange of references. If the branch you are pushing has no common ancestors with the remote, it's going to pack and re-upload all the objects reachable from that branch.
The sequence goes something like this
The remote will recognize objects already in its database and use the existing objects.
The logic is that sending a few unnecessary files from time to time is far more efficient than walking the entire history (potentially tens or hundreds of thousands of objects being accessed and compared) on every push.
Upvotes: 1