Merge pull request #6 from thingsdb/dev

Added Raw Query and Run variants

Author: joente

.github/workflows/ci.yml

@@ -11,11 +11,11 @@ jobs:
   build:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
-      - name: Set up Go 1.12
-        uses: actions/setup-go@v2
+      - uses: actions/checkout@v4
+      - name: Set up Go 1.15
+        uses: actions/setup-go@v5
         with:
-          go-version: 1.12
+          go-version: 1.15
       - name: Run tests
         env:
           TI_TOKEN: ${{ secrets.TI_TOKEN }}

.github/workflows/golangci-lint.yml

@@ -16,12 +16,12 @@ jobs:
     name: lint
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v4
       - name: golangci-lint
-        uses: golangci/golangci-lint-action@v2
+        uses: golangci/golangci-lint-action@v4
         with:
           # Optional: version of golangci-lint to use in form of v1.2 or v1.2.3 or `latest` to use the latest version
-          version: v1.29
+          version: latest
 
           # Optional: working directory, useful for monorepos
           # working-directory: somedir

README.md

@@ -19,7 +19,9 @@
     * [AuthToken(token) -> error](#AuthToken)
     * [IsConnected() -> bool](#IsConnected)
     * [Query(scope, code, vars) -> interface{}, error](#Query)
+    * [QueryRaw(scope, code, vars) -> []byte, error](#QueryRaw)
     * [Run(scope, procedure, args) -> interface{}, error](#Run)
+    * [RunRaw(scope, procedure, args) -> []byte, error](#RunRaw)
     * [Emit(scope, roomId, event, args) -> error](#Emit-Conn)
     * [Close()](#Close)
   * [Room](#Room)
@@ -229,6 +231,10 @@ if res, err := conn.Query("/t", "`Hello {name}!!`;", vars); err == nil {
 }
 ```
 
+### QueryRaw
+
+The same as Query, except a raw `[]byte` array is returned.
+
 ### Run
 
 Run a procedure in ThingsDB. Arguments are optional and may be either positional `[]interface{}` or by map `map[string]interface{}`.
@@ -275,6 +281,10 @@ if res, err := conn.Run("//stuff", "subtract", vars); err == nil {
 }
 ```
 
+### RunRaw
+
+The same as Run, except a raw `[]byte` array is returned.
+
 ### Emit-Conn
 
 Emit an even to a room. If a `Room` is created for the given `roomId`, you probable want to use [Emit](#Emit) on the [Room](#Room) type.

conn.go

@@ -16,7 +16,7 @@ const defaultPingInterval = 30 * time.Second
 const pingTimout = 5 * time.Second
 const authTimeout = 10 * time.Second
 const maxReconnectSleep = time.Minute
-const defaultReconnectionAttempts = 0  // 0 = infinite reconnect attempts
+const defaultReconnectionAttempts = 0 // 0 = infinite reconnect attempts
 
 type LogLevelType int8
 
@@ -61,15 +61,14 @@ type Conn struct {
 //
 // Example:
 //
-//     thingsdb.NewConn("localhost", 9200, nil)
+//	thingsdb.NewConn("localhost", 9200, nil)
 //
 // Or, with TLS (SSL) config enabled
 //
-//     config := &tls.Config{
-//         InsecureSkipVerify: false,
-//     }
-//     thingsdb.NewConn("localhost", 9200, config)
-//
+//	config := &tls.Config{
+//	    InsecureSkipVerify: false,
+//	}
+//	thingsdb.NewConn("localhost", 9200, config)
 func NewConn(host string, port uint16, config *tls.Config) *Conn {
 	return &Conn{
 		// Private
@@ -111,10 +110,9 @@ func NewConn(host string, port uint16, config *tls.Config) *Conn {
 //
 // Example:
 //
-//     conn := thingsdb.NewConn("node1.local", 9200, nil)
-//     conn.AddNode("node2.local", 9200)
-//     conn.AddNode("node3.local", 9200)
-//
+//	conn := thingsdb.NewConn("node1.local", 9200, nil)
+//	conn.AddNode("node2.local", 9200)
+//	conn.AddNode("node3.local", 9200)
 func (conn *Conn) AddNode(host string, port uint16) {
 	conn.nodes = append(conn.nodes, node{host: host, port: port})
 }
@@ -123,8 +121,7 @@ func (conn *Conn) AddNode(host string, port uint16) {
 //
 // Example:
 //
-//     thingsdb.NewConn("localhost", 9200, nil).ToString()  // "localhost:9200"
-//
+//	thingsdb.NewConn("localhost", 9200, nil).ToString()  // "localhost:9200"
 func (conn *Conn) ToString() string {
 	node := conn.node()
 	if strings.Count(node.host, ":") > 0 {
@@ -189,70 +186,96 @@ func (conn *Conn) IsConnected() bool {
 //
 // Example:
 //
-//     if res, err := conn.Query("/t", "'Hello Go Connector for ThingsDB!!';", nil); err == nil {
-//         fmt.Println(res)  // "Hello Go Connector for ThingsDB!!"
-//     }
+//	if res, err := conn.Query("/t", "'Hello Go Connector for ThingsDB!!';", nil); err == nil {
+//	    fmt.Println(res)  // "Hello Go Connector for ThingsDB!!"
+//	}
 //
 // Arguments can be provided using a `map[string]interface{}`, for example:
 //
-//     vars := map[string]interface{}{
-//         "name": "Alice",
-//     }
-//
-//     if res, err := conn.Query("/t", "`Hello {name}!!`;", vars); err == nil {
-//         fmt.Println(res) // "Hello Alice!!"
-//     }
+//	vars := map[string]interface{}{
+//	    "name": "Alice",
+//	}
 //
+//	if res, err := conn.Query("/t", "`Hello {name}!!`;", vars); err == nil {
+//	    fmt.Println(res) // "Hello Alice!!"
+//	}
 func (conn *Conn) Query(scope string, code string, vars map[string]interface{}) (interface{}, error) {
+	var result interface{}
 	data := []interface{}{scope, code}
 	if vars != nil {
 		data = append(data, vars)
 	}
+	res, err := conn.ensureWrite(ProtoReqQuery, data)
+	if err == nil {
+		err = msgpack.Unmarshal(res, &result)
+	}
+	return result, err
+}
 
+// QueryRaw is like Query except a raw []byte array is returned
+func (conn *Conn) QueryRaw(scope string, code string, vars map[string]interface{}) ([]byte, error) {
+	data := []interface{}{scope, code}
+	if vars != nil {
+		data = append(data, vars)
+	}
 	return conn.ensureWrite(ProtoReqQuery, data)
 }
 
 // Run a procedure in ThingsDB. Arguments are optional and may be either positional `[]interface{}` or by map `map[string]interface{}`.
 //
 // Example without arguments:
 //
-//     // Suppose collection `stuff` has the following procedure:
-//     // new_procedure('greet', || 'Hi');
+//	// Suppose collection `stuff` has the following procedure:
+//	// new_procedure('greet', || 'Hi');
 //
-//     if res, err := conn.Run("//stuff", "greet", nil); err == nil {
-//         fmt.Println(res)  // "Hi"
-//     }
+//	if res, err := conn.Run("//stuff", "greet", nil); err == nil {
+//	    fmt.Println(res)  // "Hi"
+//	}
 //
 // Example using positional arguments:
 //
-//     // Suppose collection `stuff` has the following procedure:
-//     // new_procedure('subtract', |a, b| a - b);
+//	// Suppose collection `stuff` has the following procedure:
+//	// new_procedure('subtract', |a, b| a - b);
 //
-//     args := []interface{}{40, 10}
+//	args := []interface{}{40, 10}
 //
-//     if res, err := conn.Run("//stuff", "subtract", args); err == nil {
-//         fmt.Println(res)  // 30
-//     }
+//	if res, err := conn.Run("//stuff", "subtract", args); err == nil {
+//	    fmt.Println(res)  // 30
+//	}
 //
 // Example using mapped arguments:
 //
-//     // Suppose collection `stuff` has the following procedure:
-//     // new_procedure('subtract', |a, b| a - b);
+//	// Suppose collection `stuff` has the following procedure:
+//	// new_procedure('subtract', |a, b| a - b);
+//
+//	args := map[string]interface{}{
+//	    "a": 15,
+//	    "b": 5,
+//	}
+//	if res, err := conn.Run("//stuff", "subtract", args); err == nil {
+//	    fmt.Println(res)  // 10
+//	}
 //
-//     args := map[string]interface{}{
-//         "a": 15,
-//         "b": 5,
-//     }
-//     if res, err := conn.Run("//stuff", "subtract", args); err == nil {
-//         fmt.Println(res)  // 10
-//     }
 // ```
 func (conn *Conn) Run(scope string, procedure string, args interface{}) (interface{}, error) {
+	var result interface{}
 	data := []interface{}{scope, procedure}
 	if args != nil {
 		data = append(data, args)
 	}
+	res, err := conn.ensureWrite(ProtoReqRun, data)
+	if err == nil {
+		err = msgpack.Unmarshal(res, &result)
+	}
+	return result, err
+}
 
+// RunRaw is like Query except a raw []byte array is returned
+func (conn *Conn) RunRaw(scope string, procedure string, args interface{}) ([]byte, error) {
+	data := []interface{}{scope, procedure}
+	if args != nil {
+		data = append(data, args)
+	}
 	return conn.ensureWrite(ProtoReqRun, data)
 }
 
@@ -263,15 +286,14 @@ func (conn *Conn) Run(scope string, procedure string, args interface{}) (interfa
 //
 // Example:
 //
-//     args := []interface{}{"This is a message"}
-//
-//     err := conn.Emit(
-//         "//stuff",      // scope of the Room
-//         123,            // Room Id
-//         "new-message",  // Event to emit
-//         args            // Arguments (may be nil)
-//     );
+//	args := []interface{}{"This is a message"}
 //
+//	err := conn.Emit(
+//	    "//stuff",      // scope of the Room
+//	    123,            // Room Id
+//	    "new-message",  // Event to emit
+//	    args            // Arguments (may be nil)
+//	);
 func (conn *Conn) Emit(scope string, roomId uint64, event string, args []interface{}) error {
 	data := []interface{}{scope, roomId, event}
 	if args != nil {
@@ -345,17 +367,20 @@ func (conn *Conn) connect() error {
 }
 
 func (conn *Conn) joinOrLeave(proto Proto, scope string, ids []*uint64) error {
+	var result interface{}
 	data := make([]interface{}, 1+len(ids))
 	data[0] = scope
 	for i, v := range ids {
 		data[1+i] = v
 	}
 	res, err := conn.ensureWrite(proto, data)
-
 	if err == nil {
-		arr, ok := res.([]interface{})
+		err = msgpack.Unmarshal(res, &result)
+	}
+	if err == nil {
+		arr, ok := result.([]interface{})
 		if !ok {
-			return fmt.Errorf("unexpected Join response: %v", res)
+			return fmt.Errorf("unexpected Join response: %v", result)
 		}
 		for i, val := range arr {
 			switch val.(type) {
@@ -375,8 +400,8 @@ func (conn *Conn) leave(scope string, ids []*uint64) error {
 	return conn.joinOrLeave(ProtoReqLeave, scope, ids)
 }
 
-func getResult(respCh chan *pkg, timeoutCh chan bool) (interface{}, error) {
-	var result interface{}
+func getResult(respCh chan *pkg, timeoutCh chan bool) ([]byte, error) {
+	var result []byte
 	var err error
 
 	select {
@@ -386,7 +411,8 @@ func getResult(respCh chan *pkg, timeoutCh chan bool) (interface{}, error) {
 		} else {
 			switch Proto(pkg.tp) {
 			case ProtoResData:
-				err = msgpack.Unmarshal(pkg.data, &result)
+				result = pkg.data
+				pkg.data = nil
 			case ProtoResPong, ProtoResOk:
 				result = nil
 			case ProtoResError:
@@ -410,7 +436,7 @@ func (conn *Conn) nextPid() uint16 {
 	return pid
 }
 
-func (conn *Conn) getRespCh(pid uint16, b []byte, timeout time.Duration) (interface{}, error) {
+func (conn *Conn) getRespCh(pid uint16, b []byte, timeout time.Duration) ([]byte, error) {
 	var err error
 	respCh := make(chan *pkg, 1)
 
@@ -445,7 +471,7 @@ func (conn *Conn) getRespCh(pid uint16, b []byte, timeout time.Duration) (interf
 	return result, err
 }
 
-func (conn *Conn) ensureWrite(tp Proto, data interface{}) (interface{}, error) {
+func (conn *Conn) ensureWrite(tp Proto, data interface{}) ([]byte, error) {
 
 	pid := conn.nextPid()
 	b, err := pkgPack(pid, tp, data)

go.mod

@@ -5,6 +5,6 @@ go 1.15
 require (
 	github.com/davecgh/go-spew v1.1.1 // indirect
 	github.com/kr/pretty v0.1.0 // indirect
-	github.com/vmihailenco/msgpack/v5 v5.3.4
+	github.com/vmihailenco/msgpack/v5 v5.4.1
 	gopkg.in/check.v1 v1.0.0-20180628173108-788fd7840127 // indirect
 )

go.sum

@@ -11,8 +11,8 @@ github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZN
 github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME=
 github.com/stretchr/testify v1.6.1 h1:hDPOHmpOpP40lSULcqw7IrRb/u7w6RpDC9399XyoNd0=
 github.com/stretchr/testify v1.6.1/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg=
-github.com/vmihailenco/msgpack/v5 v5.3.4 h1:qMKAwOV+meBw2Y8k9cVwAy7qErtYCwBzZ2ellBfvnqc=
-github.com/vmihailenco/msgpack/v5 v5.3.4/go.mod h1:7xyJ9e+0+9SaZT0Wt1RGleJXzli6Q/V5KbhBonMG9jc=
+github.com/vmihailenco/msgpack/v5 v5.4.1 h1:cQriyiUvjTwOHg8QZaPihLWeRAAVoCpE00IUPn0Bjt8=
+github.com/vmihailenco/msgpack/v5 v5.4.1/go.mod h1:GaZTsDaehaPpQVyxrf5mtQlH+pc21PIudVV/E3rRQok=
 github.com/vmihailenco/tagparser/v2 v2.0.0 h1:y09buUbR+b5aycVFQs/g70pqKVZNBmxwAhO7/IwNM9g=
 github.com/vmihailenco/tagparser/v2 v2.0.0/go.mod h1:Wri+At7QHww0WTrCBeu4J6bNtoV6mEfg5OIWRZA9qds=
 gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=

version.go

@@ -1,12 +1,12 @@
 package thingsdb
 
-//Version exposes the go-thingsdb version
-const Version = "1.0.5"
+// Version exposes the go-thingsdb version
+const Version = "1.0.6"
 
 //Publish module:
 //
 //  go mod tidy
-//  go test ./...
+//  TI_TOKEN="Fai6N..." go test ./...
 //  git tag {VERSION}
 //  git push origin {VERSION}
 //  GOPROXY=proxy.golang.org go list -m github.com/thingsdb/go-thingsdb@{VERSION}