lunny/git-lfs
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Rename "id" property to "event" in custom transfer messages

Browse Source
This commit is contained in:
Steve Streeting 2016-07-15 11:49:07 +01:00
parent bb5549e716
commit c018b62a7b
3 changed files with 25 additions and 25 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

32
docs/custom-transfers.md
View File

@ -102,10 +102,10 @@ the configuration.
The message will look like this:
```json
{ "id":"init", "operation":"download", "concurrent": true, "concurrenttransfers": 3 }
{ "event":"init", "operation":"download", "concurrent": true, "concurrenttransfers": 3 }
```
* `id`: Always "init" to identify this message
* `event`: Always "init" to identify this message
* `operation`: will be "upload" or "download" depending on transfer direction
* `concurrent`: reflects the value of `lfs.customtransfer.<name>.concurrent`, in
case the process needs to know
@ -138,10 +138,10 @@ For uploads the request sent from git-lfs to the transfer process will look
like this:
```json
{ "id":"upload", "oid": "bf3e3e2af9366a3b704ae0c31de5afa64193ebabffde2091936ad2e7510bc03a", "size": 346232, "path": "/path/to/file.png", "action": { "href": "nfs://server/path", "header": { "key": "value" } } }
{ "event":"upload", "oid": "bf3e3e2af9366a3b704ae0c31de5afa64193ebabffde2091936ad2e7510bc03a", "size": 346232, "path": "/path/to/file.png", "action": { "href": "nfs://server/path", "header": { "key": "value" } } }
```
* `id`: Always "upload" to identify this message
* `event`: Always "upload" to identify this message
* `oid`: the identifier of the LFS object
* `size`: the size of the LFS object
* `path`: the file which the transfer process should read the upload data from
@ -156,19 +156,19 @@ The transfer process should post one or more [progress messages](#progress) and
then a final completion message as follows:
```json
{ "id":"complete", "oid": "bf3e3e2af9366a3b704ae0c31de5afa64193ebabffde2091936ad2e7510bc03a"}
{ "event":"complete", "oid": "bf3e3e2af9366a3b704ae0c31de5afa64193ebabffde2091936ad2e7510bc03a"}
```
* `id`: Always "complete" to identify this message
* `event`: Always "complete" to identify this message
* `oid`: the identifier of the LFS object
Or if there was an error in the transfer:
```json
{ "id":"complete", "oid": "bf3e3e2af9366a3b704ae0c31de5afa64193ebabffde2091936ad2e7510bc03a", "error": { "code": 2, "message": "Explain what happened to this transfer" }}
{ "event":"complete", "oid": "bf3e3e2af9366a3b704ae0c31de5afa64193ebabffde2091936ad2e7510bc03a", "error": { "code": 2, "message": "Explain what happened to this transfer" }}
```
* `id`: Always "complete" to identify this message
* `event`: Always "complete" to identify this message
* `oid`: the identifier of the LFS object
* `error`: Should contain a `code` and `message` explaining the error
@ -178,10 +178,10 @@ For downloads the request sent from git-lfs to the transfer process will look
like this:
```json
{ "id":"download", "oid": "22ab5f63670800cc7be06dbed816012b0dc411e774754c7579467d2536a9cf3e", "size": 21245, "action": { "href": "nfs://server/path", "header": { "key": "value" } } }
{ "event":"download", "oid": "22ab5f63670800cc7be06dbed816012b0dc411e774754c7579467d2536a9cf3e", "size": 21245, "action": { "href": "nfs://server/path", "header": { "key": "value" } } }
```
* `id`: Always "download" to identify this message
* `event`: Always "download" to identify this message
* `oid`: the identifier of the LFS object
* `size`: the size of the LFS object
* `action`: the "download" action copied from the response from the batch API.
@ -199,10 +199,10 @@ The transfer process should post one or more [progress messages](#progress) and
then a final completion message as follows:
```json
{ "id":"complete", "oid": "22ab5f63670800cc7be06dbed816012b0dc411e774754c7579467d2536a9cf3e", "path": "/path/to/file.png", "error": null}
{ "event":"complete", "oid": "22ab5f63670800cc7be06dbed816012b0dc411e774754c7579467d2536a9cf3e", "path": "/path/to/file.png", "error": null}
```
* `id`: Always "complete" to identify this message
* `event`: Always "complete" to identify this message
* `oid`: the identifier of the LFS object
* `path`: the path to a file containing the downloaded data, which the transfer
process reliquishes control of to git-lfs. git-lfs will move the file into LFS
@ -212,7 +212,7 @@ then a final completion message as follows:
Or, if there was a failure transferring this item:
```json
{ "id":"complete", "oid": "22ab5f63670800cc7be06dbed816012b0dc411e774754c7579467d2536a9cf3e", "error": { "code": 2, "message": "Explain what happened to this transfer" }}
{ "event":"complete", "oid": "22ab5f63670800cc7be06dbed816012b0dc411e774754c7579467d2536a9cf3e", "error": { "code": 2, "message": "Explain what happened to this transfer" }}
```
Errors for a single transfer request should not terminate the process. The error
@ -229,10 +229,10 @@ the transfer process should post messages to stdout as follows before sending
the final completion message:
```json
{ "id":"progress", "oid": "22ab5f63670800cc7be06dbed816012b0dc411e774754c7579467d2536a9cf3e", "bytesSoFar": 1234, "bytesSinceLast": 64 }
{ "event":"progress", "oid": "22ab5f63670800cc7be06dbed816012b0dc411e774754c7579467d2536a9cf3e", "bytesSoFar": 1234, "bytesSinceLast": 64 }
```
* `id`: Always "progress" to identify this message
* `event`: Always "progress" to identify this message
* `oid`: the identifier of the LFS object
* `bytesSoFar`: the total number of bytes transferred so far
* `bytesSinceLast`: the number of bytes transferred since the last progress
@ -247,7 +247,7 @@ When all transfers have been processed, git-lfs will send the following message
to the stdin of the transfer process:
```json
{ "id":"terminate" }
{ "event":"terminate" }
```
On receiving this message the transfer process should clean up and terminate.

8
test/cmd/lfstest-customadapter.go
View File

@ -36,7 +36,7 @@ func main() {
continue
}
switch req.Id {
switch req.Event {
case "init":
writeToStderr(fmt.Sprintf("Initialised test custom adapter for %s\n", req.Operation), errWriter)
resp := &initResponse{}
@ -224,7 +224,7 @@ type transferError struct {
// Combined request struct which can accept anything
type request struct {
Id string `json:"id"`
Event string `json:"event"`
Operation string `json:"operation"`
Concurrent bool `json:"concurrent"`
ConcurrentTransfers int `json:"concurrenttransfers"`
@ -238,13 +238,13 @@ type initResponse struct {
Error *transferError `json:"error,omitempty"`
}
type transferResponse struct {
Id string `json:"id"`
Event string `json:"event"`
Oid string `json:"oid"`
Path string `json:"path,omitempty"` // always blank for upload
Error *transferError `json:"error,omitempty"`
}
type progressResponse struct {
Id string `json:"id"`
Event string `json:"event"`
Oid string `json:"oid"`
BytesSoFar int64 `json:"bytesSoFar"`
BytesSinceLast int `json:"bytesSinceLast"`

10
transfer/custom.go
View File

@ -63,7 +63,7 @@ type customAdapterWorkerContext struct {
}
type customAdapterInitRequest struct {
Id string `json:"id"`
Event string `json:"Event"`
Operation string `json:"operation"`
Concurrent bool `json:"concurrent"`
ConcurrentTransfers int `json:"concurrenttransfers"`
@ -74,7 +74,7 @@ func NewCustomAdapterInitRequest(op string, concurrent bool, concurrentTransfers
}
type customAdapterTransferRequest struct { // common between upload/download
Id string `json:"id"`
Event string `json:"event"`
Oid string `json:"oid"`
Size int64 `json:"size"`
Path string `json:"path,omitempty"`
@ -98,7 +98,7 @@ func NewCustomAdapterTerminateRequest() *customAdapterTerminateRequest {
// A common struct that allows all types of response to be identified
type customAdapterResponseMessage struct {
Id string `json:"id"`
Event string `json:"event"`
Error *api.ObjectError `json:"error"`
Oid string `json:"oid"`
Path string `json:"path,omitempty"` // always blank for upload
@ -291,7 +291,7 @@ func (a *customAdapter) DoTransfer(ctx interface{}, t *Transfer, cb TransferProg
return err
}
var wasAuthOk bool
switch resp.Id {
switch resp.Event {
case "progress":
// Progress
if resp.Oid != t.Object.Oid {
@ -326,7 +326,7 @@ func (a *customAdapter) DoTransfer(ctx interface{}, t *Transfer, cb TransferProg
wasAuthOk = true
complete = true
default:
return fmt.Errorf("Invalid message Id %q from custom adapter %q", resp.Id, a.name)
return fmt.Errorf("Invalid message %q from custom adapter %q", resp.Event, a.name)
}
// Fall through from both progress and completion messages
// Call auth on first progress or success to free up other workers