Rename QueryContext.RawQuals UnsafeQuals. Remove panic after context cancellation - leave it to the plugin to handle context cancellation. #17 (#126)

Author: kaidaguerre

plugin/errors.go

@@ -36,13 +36,8 @@ func WrapHydrate(hydrateFunc HydrateFunc, shouldIgnoreError ErrorPredicate) Hydr
 	return func(ctx context.Context, d *QueryData, h *HydrateData) (item interface{}, err error) {
 		defer func() {
 			if r := recover(); r != nil {
-				if helpers.ToError(r).Error() == contextCancelledError {
-					// if the error was a context cancellation, just trace it - this is not an error
-					log.Printf("[TRACE] hydrate function %s terminated with a context cancellation", helpers.GetFunctionName(hydrateFunc))
-				} else {
-					log.Printf("[WARN] recovered a panic from a wrapped hydrate function: %v\n", r)
-					err = status.Error(codes.Internal, fmt.Sprintf("hydrate function %s failed with panic %v", helpers.GetFunctionName(hydrateFunc), r))
-				}
+				log.Printf("[WARN] recovered a panic from a wrapped hydrate function: %v\n", r)
+				err = status.Error(codes.Internal, fmt.Sprintf("hydrate function %s failed with panic %v", helpers.GetFunctionName(hydrateFunc), r))
 			}
 		}()
 		// call the underlying get function

plugin/hydrate.go

@@ -5,17 +5,17 @@ import (
 )
 
 type QueryContext struct {
-	Columns  []string
-	RawQuals map[string]*proto.Quals
-	Limit    *int64
+	Columns     []string
+	UnsafeQuals map[string]*proto.Quals
+	Limit       *int64
 }
 
 // NewQueryContext maps from a proto.QueryContext to a plugin.QueryContext.
 // the only difference is the representation of the limit (as protobuf does not support pointers)
 func NewQueryContext(p *proto.QueryContext) *QueryContext {
 	q := &QueryContext{
-		Columns:  p.Columns,
-		RawQuals: p.Quals,
+		Columns:     p.Columns,
+		UnsafeQuals: p.Quals,
 	}
 	if p.Limit != nil {
 		q.Limit = &p.Limit.Value

plugin/query_context.go

@@ -131,7 +131,7 @@ func (d *QueryData) SetFetchType(table *Table) {
 		d.FetchType = fetchTypeGet
 
 		// build a qual map from Get key columns
-		qualMap := NewKeyColumnQualValueMap(d.QueryContext.RawQuals, table.Get.KeyColumns)
+		qualMap := NewKeyColumnQualValueMap(d.QueryContext.UnsafeQuals, table.Get.KeyColumns)
 		// now see whether the qual map has everything required for the get call
 		if satisfied, _ := qualMap.SatisfiesKeyColumns(table.Get.KeyColumns); satisfied {
 			d.KeyColumnQuals = qualMap.ToEqualsQualValueMap()
@@ -144,7 +144,7 @@ func (d *QueryData) SetFetchType(table *Table) {
 		// if there is a list config default to list, even is we are missing required quals
 		d.FetchType = fetchTypeList
 		if len(table.List.KeyColumns) > 0 {
-			d.Quals = NewKeyColumnQualValueMap(d.QueryContext.RawQuals, table.List.KeyColumns)
+			d.Quals = NewKeyColumnQualValueMap(d.QueryContext.UnsafeQuals, table.List.KeyColumns)
 		}
 	}
 }
@@ -228,12 +228,6 @@ func (d *QueryData) verifyCallerIsListCall(callingFunction string) bool {
 }
 
 func (d *QueryData) streamLeafListItem(ctx context.Context, item interface{}) {
-	// if the context is cancelled, panic to break out
-	select {
-	case <-d.stream.Context().Done():
-		panic(contextCancelledError)
-	default:
-	}
 
 	// create rowData, passing matrixItem from context
 	rd := newRowData(d, item)

plugin/query_data.go

@@ -55,7 +55,7 @@ func (t *Table) fetchItems(ctx context.Context, queryData *QueryData) error {
 		return t.executeGetCall(ctx, queryData)
 	}
 	if t.List == nil {
-		log.Printf("[WARN] query is not a get call, but no list call is defined, quals: %v", grpc.QualMapToString(queryData.QueryContext.RawQuals))
+		log.Printf("[WARN] query is not a get call, but no list call is defined, quals: %v", grpc.QualMapToString(queryData.QueryContext.UnsafeQuals))
 		panic("query is not a get call, but no list call is defined")
 	}