Add RemoteCallbacks.push_negotiation

Author: jorio

pygit2/callbacks.py

@@ -81,7 +81,7 @@
     from pygit2._libgit2.ffi import GitProxyOptionsC
 
     from ._pygit2 import CloneOptions, PushOptions
-    from .remotes import TransferProgress
+    from .remotes import PushUpdate, TransferProgress
 #
 # The payload is the way to pass information from the pygit2 API, through
 # libgit2, to the Python callbacks. And back.
@@ -198,6 +198,15 @@ def certificate_check(self, certificate: None, valid: bool, host: bytes) -> bool
 
         raise Passthrough
 
+    def push_negotiation(self, updates: list['PushUpdate']) -> None:
+        """
+        During a push, called once between the negotiation step and the upload.
+        Provides information about what updates will be performed.
+
+        Override with your own function to check the pending updates
+        and possibly reject them (by raising an exception).
+        """
+
     def transfer_progress(self, stats: 'TransferProgress') -> None:
         """
         During the download of new data, this will be regularly called with
@@ -427,6 +436,7 @@ def git_push_options(payload, opts=None):
     opts.callbacks.credentials = C._credentials_cb
     opts.callbacks.certificate_check = C._certificate_check_cb
     opts.callbacks.push_update_reference = C._push_update_reference_cb
+    opts.callbacks.push_negotiation = C._push_negotiation_cb
     # Per libgit2 sources, push_transfer_progress may incur a performance hit.
     # So, set it only if the user has overridden the no-op stub.
     if (
@@ -559,6 +569,19 @@ def _credentials_cb(cred_out, url, username, allowed, data):
     return 0
 
 
+@libgit2_callback
+def _push_negotiation_cb(updates, num_updates, data):
+    from .remotes import PushUpdate
+
+    push_negotiation = getattr(data, 'push_negotiation', None)
+    if not push_negotiation:
+        return 0
+
+    py_updates = [PushUpdate(updates[i]) for i in range(num_updates)]
+    push_negotiation(py_updates)
+    return 0
+
+
 @libgit2_callback
 def _push_update_reference_cb(ref, msg, data):
     push_update_reference = getattr(data, 'push_update_reference', None)

pygit2/decl/callbacks.h

@@ -16,6 +16,11 @@ extern "Python" int _push_update_reference_cb(
     const char *status,
     void *data);
 
+extern "Python" int _push_negotiation_cb(
+    const git_push_update **updates,
+    size_t len,
+    void *data);
+
 extern "Python" int _remote_create_cb(
 	git_remote **out,
 	git_repository *repo,

pygit2/remotes.py

@@ -58,6 +58,34 @@ class LsRemotesDict(TypedDict):
     oid: Oid
 
 
+class PushUpdate:
+    """
+    Represents an update which will be performed on the remote during push.
+    """
+
+    src_refname: str
+    """The source name of the reference"""
+
+    dst_refname: str
+    """The name of the reference to update on the server"""
+
+    src: Oid
+    """The current target of the reference"""
+
+    dst: Oid
+    """The new target for the reference"""
+
+    def __init__(self, c_struct: Any) -> None:
+        src_refname = maybe_string(c_struct.src_refname)
+        dst_refname = maybe_string(c_struct.dst_refname)
+        assert src_refname is not None, 'libgit2 returned null src_refname'
+        assert dst_refname is not None, 'libgit2 returned null dst_refname'
+        self.src_refname = src_refname
+        self.dst_refname = dst_refname
+        self.src = Oid(raw=bytes(ffi.buffer(c_struct.src.id)[:]))
+        self.dst = Oid(raw=bytes(ffi.buffer(c_struct.dst.id)[:]))
+
+
 class TransferProgress:
     """Progress downloading and indexing data during a fetch."""
 

test/test_remote.py

@@ -31,7 +31,7 @@
 
 import pygit2
 from pygit2 import Remote, Repository
-from pygit2.remotes import TransferProgress
+from pygit2.remotes import PushUpdate, TransferProgress
 
 from . import utils
 
@@ -406,9 +406,12 @@ def push_transfer_progress(
     assert origin.branches['master'].target == new_tip_id
 
 
+@pytest.mark.parametrize('reject_from', ['push_transfer_progress', 'push_negotiation'])
 def test_push_interrupted_from_callbacks(
-    origin: Repository, clone: Repository, remote: Remote
+    origin: Repository, clone: Repository, remote: Remote, reject_from: str
 ) -> None:
+    reject_message = 'retreat! retreat!'
+
     tip = clone[clone.head.target]
     clone.create_commit(
         'refs/heads/master',
@@ -420,10 +423,15 @@ def test_push_interrupted_from_callbacks(
     )
 
     class MyCallbacks(pygit2.RemoteCallbacks):
+        def push_negotiation(self, updates: list[PushUpdate]) -> None:
+            if reject_from == 'push_negotiation':
+                raise InterruptedError(reject_message)
+
         def push_transfer_progress(
             self, objects_pushed: int, total_objects: int, bytes_pushed: int
         ) -> None:
-            raise InterruptedError('retreat! retreat!')
+            if reject_from == 'push_transfer_progress':
+                raise InterruptedError(reject_message)
 
     assert origin.branches['master'].target == tip.id
 
@@ -504,3 +512,37 @@ def test_push_threads(origin: Repository, clone: Repository, remote: Remote) ->
     callbacks = RemoteCallbacks()
     remote.push(['refs/heads/master'], callbacks, threads=1)
     assert callbacks.push_options.pb_parallelism == 1
+
+
+def test_push_negotiation(
+    origin: Repository, clone: Repository, remote: Remote
+) -> None:
+    old_tip = clone[clone.head.target]
+    new_tip_id = clone.create_commit(
+        'refs/heads/master',
+        old_tip.author,
+        old_tip.author,
+        'empty commit',
+        old_tip.tree.id,
+        [old_tip.id],
+    )
+
+    the_updates: list[PushUpdate] = []
+
+    class MyCallbacks(pygit2.RemoteCallbacks):
+        def push_negotiation(self, updates: list[PushUpdate]) -> None:
+            the_updates.extend(updates)
+
+    assert origin.branches['master'].target == old_tip.id
+    assert 'new_branch' not in origin.branches
+
+    callbacks = MyCallbacks()
+    remote.push(['refs/heads/master'], callbacks=callbacks)
+
+    assert len(the_updates) == 1
+    assert the_updates[0].src_refname == 'refs/heads/master'
+    assert the_updates[0].dst_refname == 'refs/heads/master'
+    assert the_updates[0].src == old_tip.id
+    assert the_updates[0].dst == new_tip_id
+
+    assert origin.branches['master'].target == new_tip_id