Skip to content

Commit df805d6

Browse files
authored
Support legacy _links LFS batch responses (#31513)
Support legacy _links LFS batch response. Fixes #31512. This is backwards-compatible change to the LFS client so that, upon mirroring from an upstream which has a batch api, it can download objects whether the responses contain the `_links` field or its successor the `actions` field. When Gitea must fallback to the legacy `_links` field a logline is emitted at INFO level which looks like this: ``` ...s/lfs/http_client.go:188:performOperation() [I] <LFSPointer ee95d0a27ccdfc7c12516d4f80dcf144a5eaf10d0461d282a7206390635cdbee:160> is using a deprecated batch schema response! ``` I've only run `test-backend` with this code, but added a new test to cover this case. Additionally I have a fork with this change deployed which I've confirmed syncs LFS from Gitea<-Artifactory (which has legacy `_links`) as well as from Gitea<-Gitea (which has the modern `actions`). Signed-off-by: Royce Remer <[email protected]>
1 parent 62b3738 commit df805d6

File tree

3 files changed

+21
-0
lines changed

3 files changed

+21
-0
lines changed

Diff for: modules/lfs/http_client.go

+4
Original file line numberDiff line numberDiff line change
@@ -180,6 +180,10 @@ func (c *HTTPClient) performOperation(ctx context.Context, objects []Pointer, dc
180180
}
181181
} else {
182182
link, ok := object.Actions["download"]
183+
if !ok {
184+
// no actions block in response, try legacy response schema
185+
link, ok = object.Links["download"]
186+
}
183187
if !ok {
184188
log.Debug("%+v", object)
185189
return errors.New("missing action 'download'")

Diff for: modules/lfs/http_client_test.go

+16
Original file line numberDiff line numberDiff line change
@@ -59,6 +59,17 @@ func lfsTestRoundtripHandler(req *http.Request) *http.Response {
5959
},
6060
},
6161
}
62+
} else if strings.Contains(url, "legacy-batch-request-download") {
63+
batchResponse = &BatchResponse{
64+
Transfer: "dummy",
65+
Objects: []*ObjectResponse{
66+
{
67+
Links: map[string]*Link{
68+
"download": {},
69+
},
70+
},
71+
},
72+
}
6273
} else if strings.Contains(url, "valid-batch-request-upload") {
6374
batchResponse = &BatchResponse{
6475
Transfer: "dummy",
@@ -229,6 +240,11 @@ func TestHTTPClientDownload(t *testing.T) {
229240
endpoint: "https://unknown-actions-map.io",
230241
expectederror: "missing action 'download'",
231242
},
243+
// case 11
244+
{
245+
endpoint: "https://legacy-batch-request-download.io",
246+
expectederror: "",
247+
},
232248
}
233249

234250
for n, c := range cases {

Diff for: modules/lfs/shared.go

+1
Original file line numberDiff line numberDiff line change
@@ -47,6 +47,7 @@ type BatchResponse struct {
4747
type ObjectResponse struct {
4848
Pointer
4949
Actions map[string]*Link `json:"actions,omitempty"`
50+
Links map[string]*Link `json:"_links,omitempty"`
5051
Error *ObjectError `json:"error,omitempty"`
5152
}
5253

0 commit comments

Comments
 (0)