Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Revert broken ref_prefix handling, consistently apply ref_prefix #1422

Merged
merged 2 commits into from
Nov 7, 2024
Merged

Revert broken ref_prefix handling, consistently apply ref_prefix #1422

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6ca9b62
Revert broken refspec handling in porcelain.pull
jelmer Nov 6, 2024
5e46375
When using protocol v1, apply ref_prefix client-side for consistency
jelmer Nov 6, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
96 changes: 47 additions & 49 deletions dulwich/client.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -113,6 +113,7 @@
capability_agent,
extract_capabilities,
extract_capability_names,
filter_ref_prefix,
parse_capability,
pkt_line,
pkt_seq,
Expand Down Expand Up @@ -944,12 +945,9 @@ def fetch(
list of shas to fetch. Defaults to all shas.
progress: Optional progress function
depth: Depth to fetch at
ref_prefix: Prefix of desired references, as a list of bytestrings.
The server will limit the list of references sent to this prefix,
provided this feature is supported and sufficient server-side
resources are available to match all references against the prefix.
Clients must be prepared to filter out any non-requested references
themselves. This feature is an entirely optional optimization.
ref_prefix: List of prefixes of desired references, as a list of
bytestrings. Filtering is done by the server if supported, and
client side otherwise.
filter_spec: A git-rev-list-style object filter spec, as bytestring.
Only used if the server supports the Git protocol-v2 'filter'
feature, and ignored otherwise.
Expand Down Expand Up @@ -1026,12 +1024,9 @@ def fetch_pack(
pack_data: Callback called for each bit of data in the pack
progress: Callback for progress reports (strings)
depth: Shallow fetch depth
ref_prefix: Prefix of desired references, as a list of bytestrings.
The server will limit the list of references sent to this prefix,
provided this feature is supported and sufficient server-side
resources are available to match all references against the prefix.
Clients must be prepared to filter out any non-requested references
themselves. This feature is an entirely optional optimization.
ref_prefix: List of prefixes of desired references, as a list of
bytestrings. Filtering is done by the server if supported, and
client side otherwise.
filter_spec: A git-rev-list-style object filter spec, as bytestring.
Only used if the server supports the Git protocol-v2 'filter'
feature, and ignored otherwise.
Expand Down Expand Up @@ -1338,12 +1333,9 @@ def fetch_pack(
pack_data: Callback called for each bit of data in the pack
progress: Callback for progress reports (strings)
depth: Shallow fetch depth
ref_prefix: Prefix of desired references, as a list of bytestrings.
The server will limit the list of references sent to this prefix,
provided this feature is supported and sufficient server-side
resources are available to match all references against the prefix.
Clients must be prepared to filter out any non-requested references
themselves. This feature is an entirely optional optimization.
ref_prefix: List of prefixes of desired references, as a list of
bytestrings. Filtering is done by the server if supported, and
client side otherwise.
filter_spec: A git-rev-list-style object filter spec, as bytestring.
Only used if the server supports the Git protocol-v2 'filter'
feature, and ignored otherwise.
Expand Down Expand Up @@ -1372,21 +1364,17 @@ def fetch_pack(
)
self.protocol_version = server_protocol_version
with proto:
try:
if self.protocol_version == 2:
if self.protocol_version == 2:
try:
server_capabilities = read_server_capabilities(proto.read_pkt_seq())
refs = None
else:
refs, server_capabilities = read_pkt_refs_v1(proto.read_pkt_seq())
except HangupException as exc:
raise _remote_error_from_stderr(stderr) from exc
(
negotiated_capabilities,
symrefs,
agent,
) = self._negotiate_upload_pack_capabilities(server_capabilities)
except HangupException as exc:
raise _remote_error_from_stderr(stderr) from exc
(
negotiated_capabilities,
symrefs,
agent,
) = self._negotiate_upload_pack_capabilities(server_capabilities)

if self.protocol_version == 2:
proto.write_pkt_line(b"command=ls-refs\n")
proto.write(b"0001") # delim-pkt
proto.write_pkt_line(b"symrefs")
Expand All @@ -1397,6 +1385,19 @@ def fetch_pack(
proto.write_pkt_line(b"ref-prefix " + prefix)
proto.write_pkt_line(None)
refs, symrefs, _peeled = read_pkt_refs_v2(proto.read_pkt_seq())
else:
try:
refs, server_capabilities = read_pkt_refs_v1(proto.read_pkt_seq())
except HangupException as exc:
raise _remote_error_from_stderr(stderr) from exc
(
negotiated_capabilities,
symrefs,
agent,
) = self._negotiate_upload_pack_capabilities(server_capabilities)

if ref_prefix is not None:
refs = filter_ref_prefix(refs, ref_prefix)

if refs is None:
proto.write_pkt_line(None)
Expand Down Expand Up @@ -1501,6 +1502,8 @@ def get_refs(
raise _remote_error_from_stderr(stderr) from exc
proto.write_pkt_line(None)
(_symrefs, _agent) = _extract_symrefs_and_agent(server_capabilities)
if ref_prefix is not None:
refs = filter_ref_prefix(refs, ref_prefix)
return refs

def archive(
Expand Down Expand Up @@ -1845,12 +1848,9 @@ def fetch(
list of shas to fetch. Defaults to all shas.
progress: Optional progress function
depth: Shallow fetch depth
ref_prefix: Prefix of desired references, as a list of bytestrings.
The server will limit the list of references sent to this prefix,
provided this feature is supported and sufficient server-side
resources are available to match all references against the prefix.
Clients must be prepared to filter out any non-requested references
themselves. This feature is an entirely optional optimization.
ref_prefix: List of prefixes of desired references, as a list of
bytestrings. Filtering is done by the server if supported, and
client side otherwise.
filter_spec: A git-rev-list-style object filter spec, as bytestring.
Only used if the server supports the Git protocol-v2 'filter'
feature, and ignored otherwise.
Expand Down Expand Up @@ -1891,12 +1891,9 @@ def fetch_pack(
pack_data: Callback called for each bit of data in the pack
progress: Callback for progress reports (strings)
depth: Shallow fetch depth
ref_prefix: Prefix of desired references, as a list of bytestrings.
The server will limit the list of references sent to this prefix,
provided this feature is supported and sufficient server-side
resources are available to match all references against the prefix.
Clients must be prepared to filter out any non-requested references
themselves. This feature is an entirely optional optimization.
ref_prefix: List of prefixes of desired references, as a list of
bytestrings. Filtering is done by the server if supported, and
client side otherwise.
filter_spec: A git-rev-list-style object filter spec, as bytestring.
Only used if the server supports the Git protocol-v2 'filter'
feature, and ignored otherwise.
Expand Down Expand Up @@ -2533,10 +2530,14 @@ def begin_protocol_v2(proto):
(symrefs, agent) = _extract_symrefs_and_agent(
server_capabilities
)
if ref_prefix is not None:
refs = filter_ref_prefix(refs, ref_prefix)
return refs, server_capabilities, base_url, symrefs, peeled
else:
self.protocol_version = 0 # dumb servers only support protocol v0
(refs, peeled) = split_peeled_refs(read_info_refs(resp))
if ref_prefix is not None:
refs = filter_ref_prefix(refs, ref_prefix)
return refs, set(), base_url, {}, peeled
finally:
resp.close()
Expand Down Expand Up @@ -2651,12 +2652,9 @@ def fetch_pack(
pack_data: Callback called for each bit of data in the pack
progress: Callback for progress reports (strings)
depth: Depth for request
ref_prefix: Prefix of desired references, as a list of bytestrings.
The server will limit the list of references sent to this prefix,
provided this feature is supported and sufficient server-side
resources are available to match all references against the prefix.
Clients must be prepared to filter out any non-requested references
themselves. This feature is an entirely optional optimization.
ref_prefix: List of prefixes of desired references, as a list of
bytestrings. Filtering is done by the server if supported, and
client side otherwise.
filter_spec: A git-rev-list-style object filter spec, as bytestring.
Only used if the server supports the Git protocol-v2 'filter'
feature, and ignored otherwise.
Expand Down
28 changes: 4 additions & 24 deletions dulwich/porcelain.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -486,26 +486,6 @@ def init(path=".", *, bare=False, symlinks: Optional[bool] = None):
return Repo.init(path, symlinks=symlinks)


def encode_refspecs(refspecs):
if refspecs is None:
return [b"HEAD"]

def encode_refspec(ref):
if isinstance(ref, bytes):
return ref
else:
return ref.encode(DEFAULT_ENCODING)

encoded_refs = []
if isinstance(refspecs, bytes) or isinstance(refspecs, str):
encoded_refs.append(encode_refspec(refspecs))
else:
for ref in refspecs:
encoded_refs.append(encode_refspec(ref))

return encoded_refs


def clone(
source,
target=None,
Expand Down Expand Up @@ -587,7 +567,6 @@ def clone(
depth=depth,
filter_spec=filter_spec,
protocol_version=protocol_version,
**kwargs,
)


Expand Down Expand Up @@ -1296,12 +1275,14 @@ def pull(
with open_repo_closing(repo) as r:
(remote_name, remote_location) = get_remote_repo(r, remote_location)

encoded_refs = encode_refspecs(refspecs)
selected_refs = []

if refspecs is None:
refspecs = [b"HEAD"]

def determine_wants(remote_refs, **kwargs):
selected_refs.extend(
parse_reftuples(remote_refs, r.refs, encoded_refs, force=force)
parse_reftuples(remote_refs, r.refs, refspecs, force=force)
)
return [
remote_refs[lh]
Expand All @@ -1319,7 +1300,6 @@ def determine_wants(remote_refs, **kwargs):
r,
progress=errstream.write,
determine_wants=determine_wants,
ref_prefix=refspecs,
filter_spec=filter_spec,
protocol_version=protocol_version,
)
Expand Down
10 changes: 10 additions & 0 deletions dulwich/protocol.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -194,6 +194,16 @@ def pkt_seq(*seq):
return b"".join([pkt_line(s) for s in seq]) + pkt_line(None)


def filter_ref_prefix(refs, prefixes):
"""Filter refs to only include those with a given prefix.

Args:
refs: A list of refs.
prefix: The prefix to filter by.
"""
return {k: v for k, v in refs.items() if any(k.startswith(p) for p in prefixes)}


class Protocol:
"""Class for interacting with a remote git process over the wire.

Expand Down
13 changes: 13 additions & 0 deletions tests/compat/test_client.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -270,6 +270,19 @@ def test_get_refs_with_peeled_tag(self):
sorted(refs.keys()),
)

def test_get_refs_with_ref_prefix(self):
c = self._client()
refs = c.get_refs(
self._build_path("/server_new.export"), ref_prefix=[b"refs/heads"]
)
self.assertEqual(
[
b"refs/heads/branch",
b"refs/heads/master",
],
sorted(refs.keys()),
)

def test_fetch_pack_depth(self):
c = self._client()
with repo.Repo(os.path.join(self.gitroot, "dest")) as dest:
Expand Down
22 changes: 19 additions & 3 deletions tests/test_protocol.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,21 +35,37 @@
ack_type,
extract_capabilities,
extract_want_line_capabilities,
filter_ref_prefix,
pkt_line,
pkt_seq,
)

from . import TestCase


class PktLinetests:
class PktLineTests(TestCase):
def test_pkt_line(self):
self.assertEqual(b"0007bla", pkt_line(b"bla"))
self.assertEqual(b"0000", pkt_line(None))

def test_pkt_seq(self):
self.assertEqual(b"0007bla0003foo0000", pkt_seq([b"bla", b"foo"]))
self.assertEqual(b"0000", pkt_seq([]))
self.assertEqual(b"0007bla0007foo0000", pkt_seq(b"bla", b"foo"))
self.assertEqual(b"0000", pkt_seq())


class FilterRefPrefixTests(TestCase):
def test_filter_ref_prefix(self):
self.assertEqual(
{b"refs/heads/foo": b"0123456789", b"refs/heads/bar": b"0123456789"},
filter_ref_prefix(
{
b"refs/heads/foo": b"0123456789",
b"refs/heads/bar": b"0123456789",
b"refs/tags/bar": b"0123456789",
},
[b"refs/heads/"],
),
)


class BaseProtocolTests:
Expand Down
Loading