Skip to content

Commit

Permalink
Fix bug where /retrieve endpoint returns wrong logIndex across shards (
Browse files Browse the repository at this point in the history
…#908)

Signed-off-by: Priya Wadhwa <[email protected]>
  • Loading branch information
priyawadhwa authored Jul 7, 2022
1 parent 751b19d commit f986c45
Show file tree
Hide file tree
Showing 2 changed files with 37 additions and 45 deletions.
78 changes: 33 additions & 45 deletions pkg/api/entries.go
Original file line number Diff line number Diff line change
Expand Up @@ -149,30 +149,13 @@ func logEntryFromLeaf(ctx context.Context, signer signature.Signer, tc TrillianC
// GetLogEntryAndProofByIndexHandler returns the entry and inclusion proof for a specified log index
func GetLogEntryByIndexHandler(params entries.GetLogEntryByIndexParams) middleware.Responder {
ctx := params.HTTPRequest.Context()
tid, resolvedIndex := api.logRanges.ResolveVirtualIndex(int(params.LogIndex))
tc := NewTrillianClientFromTreeID(ctx, tid)
log.ContextLogger(ctx).Debugf("Retrieving resolved index %v from TreeID %v", resolvedIndex, tid)

resp := tc.getLeafAndProofByIndex(resolvedIndex)
switch resp.status {
case codes.OK:
case codes.NotFound, codes.OutOfRange, codes.InvalidArgument:
return handleRekorAPIError(params, http.StatusNotFound, fmt.Errorf("grpc error: %w", resp.err), "")
default:
return handleRekorAPIError(params, http.StatusInternalServerError, fmt.Errorf("grpc err: %w", resp.err), trillianCommunicationError)
}

result := resp.getLeafAndProofResult
leaf := result.Leaf
if leaf == nil {
return handleRekorAPIError(params, http.StatusNotFound, errors.New("grpc returned 0 leaves with success code"), "")
}

logEntry, err := logEntryFromLeaf(ctx, api.signer, tc, leaf, result.SignedLogRoot, result.Proof, tid, api.logRanges)
logEntry, err := retrieveLogEntryByIndex(ctx, int(params.LogIndex))
if err != nil {
if errors.Is(err, ErrNotFound) {
return handleRekorAPIError(params, http.StatusNotFound, fmt.Errorf("grpc error: %w", err), "")
}
return handleRekorAPIError(params, http.StatusInternalServerError, err, err.Error())
}

return entries.NewGetLogEntryByIndexOK().WithPayload(logEntry)
}

Expand Down Expand Up @@ -414,46 +397,51 @@ func SearchLogQueryHandler(params entries.SearchLogQueryParams) middleware.Respo
if len(params.Entry.LogIndexes) > 0 {
g, _ := errgroup.WithContext(httpReqCtx)

leafResults := make([]*trillian.GetEntryAndProofResponse, len(params.Entry.LogIndexes))
for i, logIndex := range params.Entry.LogIndexes {
i, logIndex := i, logIndex // https://golang.org/doc/faq#closures_and_goroutines
for _, logIndex := range params.Entry.LogIndexes {
logIndex := logIndex // https://golang.org/doc/faq#closures_and_goroutines
g.Go(func() error {
tid, resolvedIndex := api.logRanges.ResolveVirtualIndex(int(swag.Int64Value(logIndex)))
trillianClient := NewTrillianClientFromTreeID(httpReqCtx, tid)
resp := trillianClient.getLeafAndProofByIndex(resolvedIndex)
switch resp.status {
case codes.OK, codes.NotFound:
default:
return resp.err
}
leafResult := resp.getLeafAndProofResult
if leafResult != nil && leafResult.Leaf != nil {
leafResults[i] = leafResult
logEntry, err := retrieveLogEntryByIndex(httpReqCtx, int(swag.Int64Value(logIndex)))
if err != nil {
return err
}
resultPayload = append(resultPayload, logEntry)
return nil
})
}

if err := g.Wait(); err != nil {
return handleRekorAPIError(params, http.StatusInternalServerError, fmt.Errorf("grpc error: %w", err), trillianUnexpectedResult)
}

for _, result := range leafResults {
if result != nil {
logEntry, err := logEntryFromLeaf(httpReqCtx, api.signer, tc, result.Leaf, result.SignedLogRoot, result.Proof, api.logRanges.ActiveTreeID(), api.logRanges)
if err != nil {
return handleRekorAPIError(params, http.StatusInternalServerError, err, trillianUnexpectedResult)
}
resultPayload = append(resultPayload, logEntry)
}
}
}

return entries.NewSearchLogQueryOK().WithPayload(resultPayload)
}

var ErrNotFound = errors.New("grpc returned 0 leaves with success code")

func retrieveLogEntryByIndex(ctx context.Context, logIndex int) (models.LogEntry, error) {
tid, resolvedIndex := api.logRanges.ResolveVirtualIndex(logIndex)
tc := NewTrillianClientFromTreeID(ctx, tid)
log.ContextLogger(ctx).Debugf("Retrieving resolved index %v from TreeID %v", resolvedIndex, tid)

resp := tc.getLeafAndProofByIndex(resolvedIndex)
switch resp.status {
case codes.OK:
case codes.NotFound, codes.OutOfRange, codes.InvalidArgument:
return models.LogEntry{}, ErrNotFound
default:
return models.LogEntry{}, fmt.Errorf("grpc err: %w: %s", resp.err, trillianCommunicationError)
}

result := resp.getLeafAndProofResult
leaf := result.Leaf
if leaf == nil {
return models.LogEntry{}, ErrNotFound
}

return logEntryFromLeaf(ctx, api.signer, tc, leaf, result.SignedLogRoot, result.Proof, tid, api.logRanges)
}

// Retrieve a Log Entry
// If a tree ID is specified, look in that tree
// Otherwise, look through all inactive and active shards
Expand Down
4 changes: 4 additions & 0 deletions tests/sharding-e2e-test.sh
Original file line number Diff line number Diff line change
Expand Up @@ -265,4 +265,8 @@ stringsMatch $NUM_ELEMENTS "2"
NUM_ELEMENTS=$(curl -f -H "Content-Type: application/json" --data '{"logIndexes": [0,3]}' "http://localhost:3000/api/v1/log/entries/retrieve" | jq '. | length')
stringsMatch $NUM_ELEMENTS "2"

# Make sure we get the expected LogIndex in the response when calling /retrieve endpoint
RETRIEVE_LOGINDEX1=$(curl -f http://localhost:3000/api/v1/log/entries/retrieve -H "Content-Type: application/json" -H "Accept: application/json" -d "{ \"logIndexes\": [1]}" | jq '.[0]' | jq -r .$UUID1.logIndex)
stringsMatch $RETRIEVE_LOGINDEX1 "1"

echo "Test passed successfully :)"

0 comments on commit f986c45

Please sign in to comment.