Skip to content

Commit 5ce7209

Browse files
oleg-jukovecoleg-jukovec
committed
api: remove IPROTO constants
IPROTO constants have been moved to a separate package go-iproto [1]. 1. https://github.com/tarantool/go-iproto Part of #158
1 parent cf992eb commit 5ce7209

22 files changed

+271
-411
lines changed

‎CHANGELOG.md

+4
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,8 @@ Versioning](http://semver.org/spec/v2.0.0.html) except to the first release.
1010

1111
### Added
1212

13+
- Type() method to the Request interface (#158)
14+
1315
### Changed
1416

1517
- connection_pool renamed to pool (#239)
@@ -23,6 +25,8 @@ Versioning](http://semver.org/spec/v2.0.0.html) except to the first release.
2325
- pool/RoundRobinStrategy (#158)
2426
- DeadlineIO (#158)
2527
- UUID_extId (#158)
28+
- IPROTO constants (#158)
29+
- Code() method from the Request interface (#158)
2630

2731
### Fixed
2832

‎README.md

+10
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,8 @@ faster than other packages according to public benchmarks.
3131
* [pool package](#pool-package)
3232
* [msgpack.v5](#msgpackv5)
3333
* [Call = Call17](#call--call17)
34+
* [IPROTO constants](#iproto-constants)
35+
* [Request interface](#request-interface)
3436
* [Contributing](#contributing)
3537
* [Alternative connectors](#alternative-connectors)
3638

@@ -190,6 +192,14 @@ Call requests uses `IPROTO_CALL` instead of `IPROTO_CALL_16`.
190192
So now `Call` = `Call17` and `NewCallRequest` = `NewCall17Request`. A result
191193
of the requests is an array instead of array of arrays.
192194

195+
#### IPROTO constants
196+
197+
IPROTO constants have been moved to a separate package [go-iproto](https://github.com/tarantool/go-iproto).
198+
199+
#### Request interface
200+
201+
* The method `Code() uint32` replaced by the `Type() iproto.Type`.
202+
193203
## Contributing
194204

195205
See [the contributing guide](CONTRIBUTING.md) for detailed instructions on how

‎connection.go

+11-10
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@ import (
1515
"sync/atomic"
1616
"time"
1717

18+
"github.com/tarantool/go-iproto"
1819
"github.com/vmihailenco/msgpack/v5"
1920
)
2021

@@ -167,7 +168,7 @@ type Connection struct {
167168
opts Opts
168169
state uint32
169170
dec *msgpack.Decoder
170-
lenbuf [PacketLengthBytes]byte
171+
lenbuf [packetLengthBytes]byte
171172

172173
lastStreamId uint64
173174

@@ -410,8 +411,8 @@ func Connect(addr string, opts Opts) (conn *Connection, err error) {
410411
ter, ok := err.(Error)
411412
if conn.opts.Reconnect <= 0 {
412413
return nil, err
413-
} else if ok && (ter.Code == ErrNoSuchUser ||
414-
ter.Code == ErrPasswordMismatch) {
414+
} else if ok && (ter.Code == iproto.ER_NO_SUCH_USER ||
415+
ter.Code == iproto.ER_CREDS_MISMATCH) {
415416
// Reported auth errors immediately.
416417
return nil, err
417418
} else {
@@ -595,7 +596,7 @@ func pack(h *smallWBuf, enc *msgpack.Encoder, reqid uint32,
595596
hMapLen := byte(0x82) // 2 element map.
596597
if streamId != ignoreStreamId {
597598
hMapLen = byte(0x83) // 3 element map.
598-
streamBytes[0] = KeyStreamId
599+
streamBytes[0] = byte(iproto.IPROTO_STREAM_ID)
599600
if streamId > math.MaxUint32 {
600601
streamBytesLen = streamBytesLenUint64
601602
streamBytes[1] = uint64Code
@@ -610,8 +611,8 @@ func pack(h *smallWBuf, enc *msgpack.Encoder, reqid uint32,
610611
hBytes := append([]byte{
611612
uint32Code, 0, 0, 0, 0, // Length.
612613
hMapLen,
613-
KeyCode, byte(req.Code()), // Request code.
614-
KeySync, uint32Code,
614+
byte(iproto.IPROTO_REQUEST_TYPE), byte(req.Type()), // Request type.
615+
byte(iproto.IPROTO_SYNC), uint32Code,
615616
byte(reqid >> 24), byte(reqid >> 16),
616617
byte(reqid >> 8), byte(reqid),
617618
}, streamBytes[:streamBytesLen]...)
@@ -813,13 +814,13 @@ func readWatchEvent(reader io.Reader) (connWatchEvent, error) {
813814
return event, err
814815
}
815816

816-
switch cd {
817-
case KeyEvent:
817+
switch iproto.Key(cd) {
818+
case iproto.IPROTO_EVENT_KEY:
818819
if event.key, err = d.DecodeString(); err != nil {
819820
return event, err
820821
}
821822
keyExist = true
822-
case KeyEventData:
823+
case iproto.IPROTO_EVENT_DATA:
823824
if event.value, err = d.DecodeInterface(); err != nil {
824825
return event, err
825826
}
@@ -857,7 +858,7 @@ func (conn *Connection) reader(r io.Reader, c Conn) {
857858
}
858859

859860
var fut *Future = nil
860-
if resp.Code == EventCode {
861+
if iproto.Type(resp.Code) == iproto.IPROTO_EVENT {
861862
if event, err := readWatchEvent(&resp.buf); err == nil {
862863
events <- event
863864
} else {

‎const.go

+19-84
Original file line numberDiff line numberDiff line change
@@ -1,95 +1,30 @@
11
package tarantool
22

3-
const (
4-
SelectRequestCode = 1
5-
InsertRequestCode = 2
6-
ReplaceRequestCode = 3
7-
UpdateRequestCode = 4
8-
DeleteRequestCode = 5
9-
Call16RequestCode = 6 /* call in 1.6 format */
10-
AuthRequestCode = 7
11-
EvalRequestCode = 8
12-
UpsertRequestCode = 9
13-
Call17RequestCode = 10 /* call in >= 1.7 format */
14-
ExecuteRequestCode = 11
15-
PrepareRequestCode = 13
16-
BeginRequestCode = 14
17-
CommitRequestCode = 15
18-
RollbackRequestCode = 16
19-
PingRequestCode = 64
20-
SubscribeRequestCode = 66
21-
IdRequestCode = 73
22-
WatchRequestCode = 74
23-
UnwatchRequestCode = 75
24-
CallRequestCode = Call17RequestCode
25-
26-
KeyCode = 0x00
27-
KeySync = 0x01
28-
KeyStreamId = 0x0a
29-
KeySpaceNo = 0x10
30-
KeyIndexNo = 0x11
31-
KeyLimit = 0x12
32-
KeyOffset = 0x13
33-
KeyIterator = 0x14
34-
KeyFetchPos = 0x1f
35-
KeyKey = 0x20
36-
KeyTuple = 0x21
37-
KeyFunctionName = 0x22
38-
KeyUserName = 0x23
39-
KeyExpression = 0x27
40-
KeyAfterPos = 0x2e
41-
KeyAfterTuple = 0x2f
42-
KeyDefTuple = 0x28
43-
KeyData = 0x30
44-
KeyError24 = 0x31 /* Error in pre-2.4 format. */
45-
KeyMetaData = 0x32
46-
KeyBindCount = 0x34
47-
KeyPos = 0x35
48-
KeySQLText = 0x40
49-
KeySQLBind = 0x41
50-
KeySQLInfo = 0x42
51-
KeyStmtID = 0x43
52-
KeyError = 0x52 /* Extended error in >= 2.4 format. */
53-
KeyVersion = 0x54
54-
KeyFeatures = 0x55
55-
KeyTimeout = 0x56
56-
KeyEvent = 0x57
57-
KeyEventData = 0x58
58-
KeyTxnIsolation = 0x59
59-
KeyAuthType = 0x5b
60-
61-
KeyFieldName = 0x00
62-
KeyFieldType = 0x01
63-
KeyFieldColl = 0x02
64-
KeyFieldIsNullable = 0x03
65-
KeyIsAutoincrement = 0x04
66-
KeyFieldSpan = 0x05
67-
KeySQLInfoRowCount = 0x00
68-
KeySQLInfoAutoincrementIds = 0x01
3+
import (
4+
"github.com/tarantool/go-iproto"
5+
)
696

70-
// https://github.com/fl00r/go-tarantool-1.6/issues/2
7+
const (
8+
packetLengthBytes = 5
9+
)
7110

72-
IterEq = uint32(0) // key == x ASC order
73-
IterReq = uint32(1) // key == x DESC order
74-
IterAll = uint32(2) // all tuples
75-
IterLt = uint32(3) // key < x
76-
IterLe = uint32(4) // key <= x
77-
IterGe = uint32(5) // key >= x
78-
IterGt = uint32(6) // key > x
79-
IterBitsAllSet = uint32(7) // all bits from x are set in key
80-
IterBitsAnySet = uint32(8) // at least one x's bit is set
81-
IterBitsAllNotSet = uint32(9) // all bits are not set
11+
const (
12+
IterEq = uint32(0) // key == x ASC order
13+
IterReq = uint32(1) // key == x DESC order
14+
IterAll = uint32(2) // all tuples
15+
IterLt = uint32(3) // key < x
16+
IterLe = uint32(4) // key <= x
17+
IterGe = uint32(5) // key >= x
18+
IterGt = uint32(6) // key > x
19+
IterBitsAllSet = uint32(7) // all bits from x are set in key
20+
IterBitsAnySet = uint32(8) // at least one x's bit is set
21+
IterBitsAllNotSet = uint32(9) // all bits are not set
8222
IterOverlaps = uint32(10) // key overlaps x
8323
IterNeighbor = uint32(11) // tuples in distance ascending order from specified point
8424

8525
RLimitDrop = 1
8626
RLimitWait = 2
8727

88-
OkCode = uint32(0)
89-
EventCode = uint32(0x4c)
90-
PushCode = uint32(0x80)
91-
ErrorCodeBit = 0x8000
92-
PacketLengthBytes = 5
93-
ErSpaceExistsCode = 0xa
94-
IteratorCode = 0x14
28+
OkCode = uint32(iproto.IPROTO_OK)
29+
PushCode = uint32(iproto.IPROTO_CHUNK)
9530
)

‎crud/common.go

+5-3
Original file line numberDiff line numberDiff line change
@@ -56,6 +56,8 @@ package crud
5656
import (
5757
"context"
5858

59+
"github.com/tarantool/go-iproto"
60+
5961
"github.com/tarantool/go-tarantool/v2"
6062
)
6163

@@ -67,9 +69,9 @@ func newCall(method string) *tarantool.CallRequest {
6769
return tarantool.NewCall17Request(method)
6870
}
6971

70-
// Code returns IPROTO code for CRUD request.
71-
func (req baseRequest) Code() int32 {
72-
return req.impl.Code()
72+
// Type returns IPROTO type for CRUD request.
73+
func (req baseRequest) Type() iproto.Type {
74+
return req.impl.Type()
7375
}
7476

7577
// Ctx returns a context of CRUD request.

‎crud/request_test.go

+29-28
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@ import (
77
"fmt"
88
"testing"
99

10+
"github.com/tarantool/go-iproto"
1011
"github.com/vmihailenco/msgpack/v5"
1112

1213
"github.com/tarantool/go-tarantool/v2"
@@ -22,7 +23,7 @@ const validSpace = "test" // Any valid value != default.
2223
const defaultSpace = 0 // And valid too.
2324
const defaultIndex = 0 // And valid too.
2425

25-
const CrudRequestCode = tarantool.Call17RequestCode
26+
const CrudRequestType = iproto.IPROTO_CALL
2627

2728
var reqObject = crud.MapObject{
2829
"id": uint(24),
@@ -166,37 +167,37 @@ func BenchmarkSelectRequest(b *testing.B) {
166167

167168
func TestRequestsCodes(t *testing.T) {
168169
tests := []struct {
169-
req tarantool.Request
170-
code int32
170+
req tarantool.Request
171+
rtype iproto.Type
171172
}{
172-
{req: crud.MakeInsertRequest(validSpace), code: CrudRequestCode},
173-
{req: crud.MakeInsertObjectRequest(validSpace), code: CrudRequestCode},
174-
{req: crud.MakeInsertManyRequest(validSpace), code: CrudRequestCode},
175-
{req: crud.MakeInsertObjectManyRequest(validSpace), code: CrudRequestCode},
176-
{req: crud.MakeGetRequest(validSpace), code: CrudRequestCode},
177-
{req: crud.MakeUpdateRequest(validSpace), code: CrudRequestCode},
178-
{req: crud.MakeDeleteRequest(validSpace), code: CrudRequestCode},
179-
{req: crud.MakeReplaceRequest(validSpace), code: CrudRequestCode},
180-
{req: crud.MakeReplaceObjectRequest(validSpace), code: CrudRequestCode},
181-
{req: crud.MakeReplaceManyRequest(validSpace), code: CrudRequestCode},
182-
{req: crud.MakeReplaceObjectManyRequest(validSpace), code: CrudRequestCode},
183-
{req: crud.MakeUpsertRequest(validSpace), code: CrudRequestCode},
184-
{req: crud.MakeUpsertObjectRequest(validSpace), code: CrudRequestCode},
185-
{req: crud.MakeUpsertManyRequest(validSpace), code: CrudRequestCode},
186-
{req: crud.MakeUpsertObjectManyRequest(validSpace), code: CrudRequestCode},
187-
{req: crud.MakeMinRequest(validSpace), code: CrudRequestCode},
188-
{req: crud.MakeMaxRequest(validSpace), code: CrudRequestCode},
189-
{req: crud.MakeSelectRequest(validSpace), code: CrudRequestCode},
190-
{req: crud.MakeTruncateRequest(validSpace), code: CrudRequestCode},
191-
{req: crud.MakeLenRequest(validSpace), code: CrudRequestCode},
192-
{req: crud.MakeCountRequest(validSpace), code: CrudRequestCode},
193-
{req: crud.MakeStorageInfoRequest(), code: CrudRequestCode},
194-
{req: crud.MakeStatsRequest(), code: CrudRequestCode},
173+
{req: crud.MakeInsertRequest(validSpace), rtype: CrudRequestType},
174+
{req: crud.MakeInsertObjectRequest(validSpace), rtype: CrudRequestType},
175+
{req: crud.MakeInsertManyRequest(validSpace), rtype: CrudRequestType},
176+
{req: crud.MakeInsertObjectManyRequest(validSpace), rtype: CrudRequestType},
177+
{req: crud.MakeGetRequest(validSpace), rtype: CrudRequestType},
178+
{req: crud.MakeUpdateRequest(validSpace), rtype: CrudRequestType},
179+
{req: crud.MakeDeleteRequest(validSpace), rtype: CrudRequestType},
180+
{req: crud.MakeReplaceRequest(validSpace), rtype: CrudRequestType},
181+
{req: crud.MakeReplaceObjectRequest(validSpace), rtype: CrudRequestType},
182+
{req: crud.MakeReplaceManyRequest(validSpace), rtype: CrudRequestType},
183+
{req: crud.MakeReplaceObjectManyRequest(validSpace), rtype: CrudRequestType},
184+
{req: crud.MakeUpsertRequest(validSpace), rtype: CrudRequestType},
185+
{req: crud.MakeUpsertObjectRequest(validSpace), rtype: CrudRequestType},
186+
{req: crud.MakeUpsertManyRequest(validSpace), rtype: CrudRequestType},
187+
{req: crud.MakeUpsertObjectManyRequest(validSpace), rtype: CrudRequestType},
188+
{req: crud.MakeMinRequest(validSpace), rtype: CrudRequestType},
189+
{req: crud.MakeMaxRequest(validSpace), rtype: CrudRequestType},
190+
{req: crud.MakeSelectRequest(validSpace), rtype: CrudRequestType},
191+
{req: crud.MakeTruncateRequest(validSpace), rtype: CrudRequestType},
192+
{req: crud.MakeLenRequest(validSpace), rtype: CrudRequestType},
193+
{req: crud.MakeCountRequest(validSpace), rtype: CrudRequestType},
194+
{req: crud.MakeStorageInfoRequest(), rtype: CrudRequestType},
195+
{req: crud.MakeStatsRequest(), rtype: CrudRequestType},
195196
}
196197

197198
for _, test := range tests {
198-
if code := test.req.Code(); code != test.code {
199-
t.Errorf("An invalid request code 0x%x, expected 0x%x", code, test.code)
199+
if rtype := test.req.Type(); rtype != test.rtype {
200+
t.Errorf("An invalid request type 0x%x, expected 0x%x", rtype, test.rtype)
200201
}
201202
}
202203
}

‎crud/tarantool_test.go

+4-2
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,8 @@ import (
88
"time"
99

1010
"github.com/stretchr/testify/require"
11+
"github.com/tarantool/go-iproto"
12+
1113
"github.com/tarantool/go-tarantool/v2"
1214
"github.com/tarantool/go-tarantool/v2/crud"
1315
"github.com/tarantool/go-tarantool/v2/test_helpers"
@@ -399,9 +401,9 @@ func getCrudError(req tarantool.Request, crudError interface{}) (interface{}, er
399401
var err []interface{}
400402
var ok bool
401403

402-
code := req.Code()
404+
rtype := req.Type()
403405
if crudError != nil {
404-
if code == tarantool.Call17RequestCode {
406+
if rtype == iproto.IPROTO_CALL {
405407
return crudError, nil
406408
}
407409

‎dial.go

+3-2
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ import (
1010
"strings"
1111
"time"
1212

13+
"github.com/tarantool/go-iproto"
1314
"github.com/vmihailenco/msgpack/v5"
1415
)
1516

@@ -261,7 +262,7 @@ func identify(w writeFlusher, r io.Reader) (ProtocolInfo, error) {
261262

262263
resp, err := readResponse(r)
263264
if err != nil {
264-
if resp.Code == ErrUnknownRequestType {
265+
if iproto.Error(resp.Code) == iproto.ER_UNKNOWN_REQUEST_TYPE {
265266
// IPROTO_ID requests are not supported by server.
266267
return info, nil
267268
}
@@ -368,7 +369,7 @@ func writeRequest(w writeFlusher, req Request) error {
368369

369370
// readResponse reads a response from the reader.
370371
func readResponse(r io.Reader) (Response, error) {
371-
var lenbuf [PacketLengthBytes]byte
372+
var lenbuf [packetLengthBytes]byte
372373

373374
respBytes, err := read(r, lenbuf[:])
374375
if err != nil {

0 commit comments

Comments
 (0)