DDINGI-1306: Revised Data Paging/Totals

gateway/field_presence.go

@@ -151,7 +151,7 @@ type presenceInterceptorOptionsDecorator struct {
 
 type presenceInterceptorOption func(*presenceInterceptorOptionsDecorator)
 
-//WithOverrideFieldMask represent an option to override field mask generated by grpc-gateway
+// WithOverrideFieldMask represent an option to override field mask generated by grpc-gateway
 func WithOverrideFieldMask(d *presenceInterceptorOptionsDecorator) {
 	d.overrideFieldMask = true
 }

gateway/fields.go

@@ -7,10 +7,10 @@ import (
 	"github.com/infobloxopen/atlas-app-toolkit/query"
 )
 
-//retainFields function extracts the configuration for fields that
-//need to be ratained either from gRPC response or from original testRequest
-//(in case when gRPC side didn't set any preferences) and retains only
-//this fields on outgoing response (dynmap).
+// retainFields function extracts the configuration for fields that
+// need to be ratained either from gRPC response or from original testRequest
+// (in case when gRPC side didn't set any preferences) and retains only
+// this fields on outgoing response (dynmap).
 func retainFields(ctx context.Context, req *http.Request, dynmap map[string]interface{}) {
 	fieldsStr := ""
 	if req != nil {

gorm/filtering.go

@@ -57,7 +57,7 @@ func FilterStringToGorm(ctx context.Context, filter string, obj interface{}, pb
 	return FilteringToGormEx(ctx, f, obj, c)
 }
 
-//Deprecated: Use FilteringToGormEx instead
+// Deprecated: Use FilteringToGormEx instead
 // FilteringToGorm returns GORM Plain SQL representation of the filtering expression.
 func FilteringToGorm(ctx context.Context, m *query.Filtering, obj interface{}, pb proto.Message) (string, []interface{}, map[string]struct{}, error) {
 	c := &DefaultFilteringConditionConverter{&DefaultFilteringConditionProcessor{pb}}

gorm/utilities.go

@@ -41,7 +41,7 @@ func HandleFieldPath(ctx context.Context, fieldPath []string, obj interface{}) (
 	return dbPath, "", nil
 }
 
-//HandleJSONFiledPath translate field path to JSONB path for postgres jsonb
+// HandleJSONFiledPath translate field path to JSONB path for postgres jsonb
 func HandleJSONFieldPath(ctx context.Context, fieldPath []string, obj interface{}, values ...string) (string, string, error) {
 	operator := "#>>"
 	if isRawJSON(values...) {
@@ -82,7 +82,7 @@ func isRawJSON(values ...string) bool {
 	return true
 }
 
-//TODO: add supprt for embeded objects
+// TODO: add supprt for embeded objects
 func IsJSONCondition(ctx context.Context, fieldPath []string, obj interface{}) bool {
 	fieldName := generator.CamelCase(fieldPath[0])
 	objType := indirectType(reflect.TypeOf(obj))

query/collection_operators.proto

@@ -202,6 +202,9 @@ message Pagination {
     // The service may impose maximum value.
     // If omitted the service may impose a default value.
     int32 limit = 3;
+    // The bool value enables/disables the record count.
+    // The default setting disables the record count.
+    bool is_total_size_needed = 4;
 }
 
 // PageInfo represents both server-driven and client-driven pagination response.
@@ -220,6 +223,8 @@ message PageInfo {
     // The service may optionally include the offset of the next page of resources.
     // A null value indicates no more pages.
     int32 offset = 3;
+    // total_size indicates the total records present.
+    int64 total_size = 4;
 }
 
 // Searching represents search by.

query/fields.go

@@ -9,8 +9,8 @@ const (
 	opCommonInnerDelimiter = "."
 )
 
-//FieldSelectionMap is a convenience type that represents map[string]*Field
-//used in FieldSelection and Field structs
+// FieldSelectionMap is a convenience type that represents map[string]*Field
+// used in FieldSelection and Field structs
 type FieldSelectionMap map[string]*Field
 
 func innerDelimiter(delimiter ...string) string {
@@ -26,9 +26,9 @@ func toParts(input string, delimiter ...string) []string {
 	return strings.Split(input, split)
 }
 
-//ParseFieldSelection transforms a string with comma-separated fields that comes
-//from client to FieldSelection struct. For complex fields dot is used as a delimeter by
-//default, but it is also possible to specify a different delimiter.
+// ParseFieldSelection transforms a string with comma-separated fields that comes
+// from client to FieldSelection struct. For complex fields dot is used as a delimeter by
+// default, but it is also possible to specify a different delimiter.
 func ParseFieldSelection(input string, delimiter ...string) *FieldSelection {
 	if len(input) == 0 {
 		return nil
@@ -44,8 +44,8 @@ func ParseFieldSelection(input string, delimiter ...string) *FieldSelection {
 	return result
 }
 
-//GoString converts FieldSelection to a string representation
-//It implements fmt.GoStringer interface and returns dot-notated fields separated by commas
+// GoString converts FieldSelection to a string representation
+// It implements fmt.GoStringer interface and returns dot-notated fields separated by commas
 func (f *FieldSelection) GoString() string {
 	return strings.Join(f.AllFieldStrings(), opCommonDelimiter)
 }
@@ -70,7 +70,7 @@ func addChildFieldString(result *[]string, parent string, field *Field) {
 	}
 }
 
-//Add allows to add new fields to FieldSelection
+// Add allows to add new fields to FieldSelection
 func (f *FieldSelection) Add(field string, delimiter ...string) {
 	if len(field) == 0 {
 		return
@@ -97,7 +97,7 @@ func (f *FieldSelection) Add(field string, delimiter ...string) {
 	}
 }
 
-//Delete allows to remove fields from FieldSelection
+// Delete allows to remove fields from FieldSelection
 func (f *FieldSelection) Delete(field string, delimiter ...string) bool {
 	if len(field) == 0 || f.Fields == nil {
 		return false
@@ -122,7 +122,7 @@ func (f *FieldSelection) Delete(field string, delimiter ...string) bool {
 	return true
 }
 
-//Get allows to get specified field from FieldSelection
+// Get allows to get specified field from FieldSelection
 func (f *FieldSelection) Get(field string, delimiter ...string) *Field {
 	if len(field) == 0 || f.Fields == nil {
 		return nil

query/filtering_lexer.go

@@ -221,7 +221,7 @@ func (t InToken) String() string {
 	return "in"
 }
 
-//NumberArrayToken represent number array e.g. [1,2,5]
+// NumberArrayToken represent number array e.g. [1,2,5]
 type StringArrayToken struct {
 	TokenBase
 	Values []string
@@ -231,7 +231,7 @@ func (t StringArrayToken) String() string {
 	return fmt.Sprintf("%v", t.Values)
 }
 
-//NumberArrayToken represent number array e.g. [1,2,5]
+// NumberArrayToken represent number array e.g. [1,2,5]
 type NumberArrayToken struct {
 	TokenBase
 	Values []float64

requestid/interceptor.go

@@ -11,7 +11,6 @@ import (
 // that should be used as a middleware to generate/include Request-Id in headers and context
 // for tracing and tracking user's request.
 //
-//
 // Returned middleware populates Request-Id from gRPC metadata if
 // they defined in a testRequest message else creates a new one.
 func UnaryServerInterceptor() grpc.UnaryServerInterceptor {

rpc/resource/jsonpb.go

@@ -9,7 +9,9 @@ import (
 
 // MarshalJSONPB implements jsonpb.JSONPBMarshaler interface by marshal
 // Identifier from a JSON string in accordance with Atlas Reference format
-// 		<application_name>/<resource_type>/<resource_id>
+//
+//	<application_name>/<resource_type>/<resource_id>
+//
 // Support "null" value.
 func (m Identifier) MarshalJSONPB(*jsonpb.Marshaler) ([]byte, error) {
 	v := BuildString(m.GetApplicationName(), m.GetResourceType(), m.GetResourceId())
@@ -28,7 +30,9 @@ var _ json.Marshaler = &Identifier{}
 
 // UnmarshalJSONPB implements jsonpb.JSONPBUnmarshaler interface by unmarshal
 // Identifier to a JSON string in accordance with Atlas Reference format
-// 		<application_name>/<resource_type>/<resource_id>
+//
+//	<application_name>/<resource_type>/<resource_id>
+//
 // Support "null" value.
 func (m *Identifier) UnmarshalJSONPB(_ *jsonpb.Unmarshaler, data []byte) error {
 	v := strings.Trim(string(data), "\"")

rpc/resource/string.go

@@ -8,7 +8,8 @@ const (
 )
 
 // BuildString builds string id according to Atlas Reference format:
-//  <application_name>/<resource_type>/<resource_id>
+//
+//	<application_name>/<resource_type>/<resource_id>
 func BuildString(aname, rtype, rid string) string {
 	var l []string
 
@@ -26,7 +27,9 @@ func BuildString(aname, rtype, rid string) string {
 }
 
 // ParseString parses id according to Atlas Reference format:
+//
 //	<application_name>/<resource_type>/<resource_id>
+//
 // All leading and trailing Delimiter are removed.
 // The resource_id is parsed first, then resource type and last application name.
 // The id "/a/b/c/" will be converted to "a/b/c" and returned as (a, b, c).

server/server.go

@@ -43,7 +43,7 @@ type Server struct {
 	isAutomaticStop bool
 }
 
-//Middleware wrapper
+// Middleware wrapper
 type Middleware func(handler http.Handler) http.Handler
 
 // Option is a functional option for creating a Server

tracing/annotator.go

@@ -16,8 +16,8 @@ const (
 
 var defaultFormat propagation.HTTPFormat = &b3.HTTPFormat{}
 
-//SpanContextAnnotator retrieve information about current span from context or HTTP headers
-//and propagate in binary format to gRPC service
+// SpanContextAnnotator retrieve information about current span from context or HTTP headers
+// and propagate in binary format to gRPC service
 func SpanContextAnnotator(ctx context.Context, req *http.Request) metadata.MD {
 	md := make(metadata.MD)
 

tracing/exporter.go

@@ -7,7 +7,7 @@ import (
 	"go.opencensus.io/trace"
 )
 
-//Exporter creates a new OC Agent exporter and configure for tracing
+// Exporter creates a new OC Agent exporter and configure for tracing
 func Exporter(address string, serviceName string, sampler trace.Sampler) error {
 	// TRACE: Setup OC agent for tracing
 	exporter, err := ocagent.NewExporter(
@@ -25,7 +25,7 @@ func Exporter(address string, serviceName string, sampler trace.Sampler) error {
 	return nil
 }
 
-//SamplerForFraction init sampler for specified fraction
+// SamplerForFraction init sampler for specified fraction
 func SamplerForFraction(fraction float64) trace.Sampler {
 	return trace.ProbabilitySampler(fraction)
 }

tracing/grpc.go

@@ -19,7 +19,7 @@ var sensitiveMetadata = map[string]struct{}{
 	"authorization":             struct{}{},
 }
 
-//GRPCOption allows extending handler with additional functionality
+// GRPCOption allows extending handler with additional functionality
 type GRPCOption func(*gRPCOptions)
 
 type metadataMatcher func(string) (string, bool)
@@ -42,48 +42,48 @@ func defaultGRPCOptions() *gRPCOptions {
 	}
 }
 
-//WithMetadataAnnotation annotate span with request metadata
+// WithMetadataAnnotation annotate span with request metadata
 func WithMetadataAnnotation(f func(context.Context, stats.RPCStats) bool) GRPCOption {
 	return func(ops *gRPCOptions) {
 		ops.spanWithMetadata = f
 	}
 }
 
-//WithMetadataMatcher set metadata matcher to filterout or preprocess metadata
+// WithMetadataMatcher set metadata matcher to filterout or preprocess metadata
 func WithMetadataMatcher(f func(string) (string, bool)) GRPCOption {
 	return func(ops *gRPCOptions) {
 		ops.metadataMatcher = f
 	}
 }
 
-//WithGRPCPayloadAnnotation add Inbound/Outbound payload as an attribute to span if f returns true
+// WithGRPCPayloadAnnotation add Inbound/Outbound payload as an attribute to span if f returns true
 func WithGRPCPayloadAnnotation(f func(context.Context, stats.RPCStats) bool) GRPCOption {
 	return func(ops *gRPCOptions) {
 		ops.spanWithPayload = f
 	}
 }
 
-//WithGRPCPayloadLimit limit payload size propogated to span
-//in case payload exceeds limit, payload truncated and
-//annotation payload.truncated=true added into span
+// WithGRPCPayloadLimit limit payload size propogated to span
+// in case payload exceeds limit, payload truncated and
+// annotation payload.truncated=true added into span
 func WithGRPCPayloadLimit(limit int) GRPCOption {
 	return func(ops *gRPCOptions) {
 		ops.maxPayloadSize = limit
 	}
 }
 
-//Check that &ServerHandler{} comply stats.Handler interface
+// Check that &ServerHandler{} comply stats.Handler interface
 var _ stats.Handler = &ServerHandler{}
 
-//ServerHandler is a wrapper over ocgrpc.ServerHandler
-//wrapper extends metadata added into the  span
+// ServerHandler is a wrapper over ocgrpc.ServerHandler
+// wrapper extends metadata added into the  span
 type ServerHandler struct {
 	ocgrpc.ServerHandler
 
 	options *gRPCOptions
 }
 
-//NewServerHandler returns wrapper over ocgrpc.ServerHandler
+// NewServerHandler returns wrapper over ocgrpc.ServerHandler
 func NewServerHandler(ops ...GRPCOption) *ServerHandler {
 	options := defaultGRPCOptions()
 	for _, op := range ops {
@@ -197,12 +197,12 @@ func payloadToAttributes(key string, value interface{}, limit int) ([]trace.Attr
 	return attrs, truncated, nil
 }
 
-//defaultHeaderMatcher is a header matcher which just accept all headers
+// defaultHeaderMatcher is a header matcher which just accept all headers
 func defaultMetadataMatcher(h string) (string, bool) {
 	return h, true
 }
 
-//AlwaysGRPC for each call returns true
+// AlwaysGRPC for each call returns true
 func AlwaysGRPC(_ context.Context, _ stats.RPCStats) bool {
 	return true
 }