df805d6ed0
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 <royceremer@gmail.com>
79 lines
2.4 KiB
Go
79 lines
2.4 KiB
Go
// Copyright 2020 The Gitea Authors. All rights reserved.
|
|
// SPDX-License-Identifier: MIT
|
|
|
|
package lfs
|
|
|
|
import (
|
|
"time"
|
|
)
|
|
|
|
const (
|
|
// MediaType contains the media type for LFS server requests
|
|
MediaType = "application/vnd.git-lfs+json"
|
|
// Some LFS servers offer content with other types, so fallback to '*/*' if application/vnd.git-lfs+json cannot be served
|
|
AcceptHeader = "application/vnd.git-lfs+json;q=0.9, */*;q=0.8"
|
|
)
|
|
|
|
// BatchRequest contains multiple requests processed in one batch operation.
|
|
// https://github.com/git-lfs/git-lfs/blob/main/docs/api/batch.md#requests
|
|
type BatchRequest struct {
|
|
Operation string `json:"operation"`
|
|
Transfers []string `json:"transfers,omitempty"`
|
|
Ref *Reference `json:"ref,omitempty"`
|
|
Objects []Pointer `json:"objects"`
|
|
}
|
|
|
|
// Reference contains a git reference.
|
|
// https://github.com/git-lfs/git-lfs/blob/main/docs/api/batch.md#ref-property
|
|
type Reference struct {
|
|
Name string `json:"name"`
|
|
}
|
|
|
|
// Pointer contains LFS pointer data
|
|
type Pointer struct {
|
|
Oid string `json:"oid" xorm:"UNIQUE(s) INDEX NOT NULL"`
|
|
Size int64 `json:"size" xorm:"NOT NULL"`
|
|
}
|
|
|
|
// BatchResponse contains multiple object metadata Representation structures
|
|
// for use with the batch API.
|
|
// https://github.com/git-lfs/git-lfs/blob/main/docs/api/batch.md#successful-responses
|
|
type BatchResponse struct {
|
|
Transfer string `json:"transfer,omitempty"`
|
|
Objects []*ObjectResponse `json:"objects"`
|
|
}
|
|
|
|
// ObjectResponse is object metadata as seen by clients of the LFS server.
|
|
type ObjectResponse struct {
|
|
Pointer
|
|
Actions map[string]*Link `json:"actions,omitempty"`
|
|
Links map[string]*Link `json:"_links,omitempty"`
|
|
Error *ObjectError `json:"error,omitempty"`
|
|
}
|
|
|
|
// Link provides a structure with information about how to access a object.
|
|
type Link struct {
|
|
Href string `json:"href"`
|
|
Header map[string]string `json:"header,omitempty"`
|
|
ExpiresAt *time.Time `json:"expires_at,omitempty"`
|
|
}
|
|
|
|
// ObjectError defines the JSON structure returned to the client in case of an error.
|
|
type ObjectError struct {
|
|
Code int `json:"code"`
|
|
Message string `json:"message"`
|
|
}
|
|
|
|
// PointerBlob associates a Git blob with a Pointer.
|
|
type PointerBlob struct {
|
|
Hash string
|
|
Pointer
|
|
}
|
|
|
|
// ErrorResponse describes the error to the client.
|
|
type ErrorResponse struct {
|
|
Message string
|
|
DocumentationURL string `json:"documentation_url,omitempty"`
|
|
RequestID string `json:"request_id,omitempty"`
|
|
}
|