gremlin-go/driver/request.go

/*
Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements.  See the NOTICE file
distributed with this work for additional information
regarding copyright ownership.  The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License.  You may obtain a copy of the License at

  http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied.  See the License for the
specific language governing permissions and limitations
under the License.
*/

package gremlingo

import "strconv"

// RequestMessage represents a request to the server.
type RequestMessage struct {
	Gremlin string
	Fields  map[string]interface{}
}

// MakeStringRequest creates a request from a Gremlin string query for submission to a Gremlin server.
//
// This function is exposed publicly to enable alternative transport protocols (gRPC, HTTP/2, etc.)
// to construct properly formatted requests outside the standard HTTP client. The returned
// request can then be serialized using SerializeMessage().
//
// Parameters:
//   - stringGremlin: The Gremlin query string to execute
//   - traversalSource: The name of the traversal source (typically "g")
//   - requestOptions: Options such as bindings, timeout, batch size, etc.
//
// Returns:
//   - request: A request structure ready for serialization
//
// Example for alternative transports:
//
//	req := MakeStringRequest("g.V().count()", "g", RequestOptions{})
//	serializer := newGraphBinarySerializer(nil)
//	bytes, _ := serializer.(graphBinarySerializer).SerializeMessage(&req)
//	// Send bytes over gRPC, HTTP/2, etc.
func MakeStringRequest(stringGremlin string, traversalSource string, requestOptions RequestOptions) (req RequestMessage) {
	newFields := map[string]interface{}{
		"language": "gremlin-lang",
		"g":        traversalSource,
	}

	if requestOptions.bindings != nil {
		newFields["bindings"] = requestOptions.bindings
	}

	if requestOptions.evaluationTimeout != 0 {
		newFields["evaluationTimeout"] = requestOptions.evaluationTimeout
	}

	if requestOptions.batchSize != 0 {
		newFields["batchSize"] = requestOptions.batchSize
	}

	if requestOptions.userAgent != "" {
		newFields["userAgent"] = requestOptions.userAgent
	}

	if requestOptions.materializeProperties != "" {
		newFields["materializeProperties"] = requestOptions.materializeProperties
	}

	if requestOptions.bulkResults != nil {
		newFields["bulkResults"] = strconv.FormatBool(*requestOptions.bulkResults)
	}

	return RequestMessage{
		Gremlin: stringGremlin,
		Fields:  newFields,
	}
}

// allowedReqArgs contains the arguments that will be extracted from the
// bytecode and sent with the request.
var allowedReqArgs = map[string]bool{
	"evaluationTimeout":     true,
	"batchSize":             true,
	"userAgent":             true,
	"materializeProperties": true,
	"bulkResults":           true,
}