Skip to content

Commit d0314fe

Browse files
committed
queue: add an example with connection_pool
The example demonstrates how to use the queue package with the connection_pool package. Closes #176
1 parent 3a0809c commit d0314fe

File tree

4 files changed

+191
-9
lines changed

4 files changed

+191
-9
lines changed

CHANGELOG.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@ Versioning](http://semver.org/spec/v2.0.0.html) except to the first release.
1515
ConnectionPool (#178)
1616
- Execute, ExecuteTyped and ExecuteAsync methods to ConnectionPool (#176)
1717
- ConnectorAdapter type to use ConnectionPool as Connector interface (#176)
18+
- An example how to use queue and connection_pool subpackages together (#176)
1819

1920
### Changed
2021

queue/config.lua

Lines changed: 4 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -23,21 +23,15 @@ box.cfg{
2323
box.schema.func.create('queue.identify')
2424
box.schema.func.create('queue.state')
2525
box.schema.func.create('queue.statistics')
26-
box.schema.user.grant('test', 'create', 'space')
27-
box.schema.user.grant('test', 'write', 'space', '_schema')
28-
box.schema.user.grant('test', 'write', 'space', '_space')
29-
box.schema.user.grant('test', 'read,write', 'space', '_space_sequence')
30-
box.schema.user.grant('test', 'write', 'space', '_index')
26+
box.schema.user.grant('test', 'create,read,write,drop', 'space')
3127
box.schema.user.grant('test', 'read, write', 'space', '_queue_session_ids')
3228
box.schema.user.grant('test', 'execute', 'universe')
3329
box.schema.user.grant('test', 'read,write', 'space', '_queue')
3430
box.schema.user.grant('test', 'read,write', 'space', '_schema')
31+
box.schema.user.grant('test', 'read,write', 'space', '_space_sequence')
3532
box.schema.user.grant('test', 'read,write', 'space', '_space')
3633
box.schema.user.grant('test', 'read,write', 'space', '_index')
37-
box.schema.user.grant('test', 'read,write', 'space', '_queue_consumers')
3834
box.schema.user.grant('test', 'read,write', 'space', '_priv')
39-
box.schema.user.grant('test', 'read,write', 'space', '_queue_taken_2')
40-
box.schema.user.grant('test', 'read,write', 'space', '_queue_shared_sessions')
4135
if box.space._trigger ~= nil then
4236
box.schema.user.grant('test', 'read', 'space', '_trigger')
4337
end
@@ -56,3 +50,5 @@ end)
5650
box.cfg{
5751
listen = os.getenv("TEST_TNT_LISTEN"),
5852
}
53+
54+
require('console').start()

queue/example_connection_pool_test.go

Lines changed: 148 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,148 @@
1+
package queue_test
2+
3+
import (
4+
"fmt"
5+
"log"
6+
"sync"
7+
"time"
8+
9+
"github.com/google/uuid"
10+
"github.com/tarantool/go-tarantool"
11+
"github.com/tarantool/go-tarantool/connection_pool"
12+
"github.com/tarantool/go-tarantool/queue"
13+
)
14+
15+
type QueueConnectionHandler struct {
16+
name string
17+
cfg queue.Cfg
18+
19+
uuid uuid.UUID
20+
registered bool
21+
err error
22+
registerMutex sync.Mutex
23+
done chan struct{}
24+
}
25+
26+
var _ connection_pool.ConnectionHandler = &QueueConnectionHandler{}
27+
28+
func NewQueueConnectionHandler(name string, cfg queue.Cfg) *QueueConnectionHandler {
29+
return &QueueConnectionHandler{
30+
name: name,
31+
cfg: cfg,
32+
done: make(chan struct{}),
33+
}
34+
}
35+
36+
func (h *QueueConnectionHandler) Discovered(conn *tarantool.Connection,
37+
role connection_pool.Role) error {
38+
// The queue only works with a master instance.
39+
if role != connection_pool.MasterRole {
40+
return nil
41+
}
42+
43+
// We need to register a shared session only once.
44+
h.registerMutex.Lock()
45+
46+
if h.err != nil {
47+
h.registerMutex.Unlock()
48+
return h.err
49+
}
50+
51+
q := queue.New(conn, h.name)
52+
if !h.registered {
53+
opts := queue.CfgOpts{InReplicaset: true, Ttr: 60 * time.Second}
54+
if h.err = q.Cfg(opts); h.err == nil {
55+
if h.uuid, h.err = q.Identify(nil); h.err == nil {
56+
h.err = q.Create(h.cfg)
57+
}
58+
}
59+
h.registered = h.err == nil
60+
close(h.done)
61+
h.registerMutex.Unlock()
62+
return h.err
63+
} else {
64+
// We already registered. We don't need the lock any more.
65+
h.registerMutex.Unlock()
66+
if _, err := q.Identify(&h.uuid); err != nil {
67+
return err
68+
}
69+
if err := q.Create(h.cfg); err != nil {
70+
return err
71+
}
72+
}
73+
return nil
74+
}
75+
76+
func (h *QueueConnectionHandler) Deactivated(conn *tarantool.Connection,
77+
role connection_pool.Role) error {
78+
return nil
79+
}
80+
81+
// Example demonstrates how to use the queue package with the connection_pool
82+
// package. First of all, you need to create a connection handler for the
83+
// a ConnectionPool object to process new connections from RW-instances.
84+
//
85+
// You need to register a shared session UUID at a first master connection.
86+
// It needs to be used to re-identify as the shared session on new
87+
// RW-instances. See QueueConnectionHandler.Discovered() implementation.
88+
//
89+
// After that, you need to create a ConnectorAdapter object with RW mode for
90+
// the ConnectionPool to send requests into RW-instances. This adapter can
91+
// be used to create a ready-to-work queue object.
92+
func Example_connectionPool() {
93+
servers := []string{
94+
"127.0.0.1:3014",
95+
"127.0.0.1:3015",
96+
"127.0.0.1:3016",
97+
}
98+
connOpts := tarantool.Opts{
99+
Timeout: 500 * time.Millisecond,
100+
User: "test",
101+
Pass: "test",
102+
}
103+
104+
cfg := queue.Cfg{
105+
Temporary: false,
106+
IfNotExists: true,
107+
Kind: queue.FIFO,
108+
Opts: queue.Opts{
109+
Ttl: 10 * time.Second,
110+
},
111+
}
112+
h := NewQueueConnectionHandler("test_queue", cfg)
113+
poolOpts := connection_pool.OptsPool{
114+
CheckTimeout: 1 * time.Second,
115+
ConnectionHandler: h,
116+
}
117+
connPool, err := connection_pool.ConnectWithOpts(servers, connOpts, poolOpts)
118+
if err != nil {
119+
log.Fatalf("unable to connect to the pool: %s", err)
120+
}
121+
122+
defer connPool.Close()
123+
124+
<-h.done
125+
126+
if h.err != nil {
127+
log.Fatalf("unable to identify in the pool: %s", h.err)
128+
}
129+
130+
rw := connection_pool.NewConnectorAdapter(connPool, connection_pool.RW)
131+
q := queue.New(rw, "test_queue")
132+
133+
fmt.Println("A Queue object is ready to work.")
134+
135+
if _, err = q.Put("test_data"); err != nil {
136+
log.Fatalf("unable to put data into the queue: %s", err)
137+
}
138+
139+
if task, err := q.Take(); err != nil {
140+
log.Fatalf("unable to take data from the queue: %s", err)
141+
} else {
142+
task.Ack()
143+
fmt.Println("data:", task.Data())
144+
}
145+
// Output:
146+
// A Queue object is ready to work.
147+
// data: test_data
148+
}

queue/queue_test.go

Lines changed: 38 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,14 @@ import (
1414
)
1515

1616
var server = "127.0.0.1:3013"
17+
var serversPool = []string{
18+
"127.0.0.1:3014",
19+
"127.0.0.1:3015",
20+
"127.0.0.1:3016",
21+
}
22+
23+
var instances []test_helpers.TarantoolInstance
24+
1725
var opts = Opts{
1826
Timeout: 2500 * time.Millisecond,
1927
User: "test",
@@ -899,12 +907,41 @@ func runTestMain(m *testing.M) int {
899907
ConnectRetry: 3,
900908
RetryTimeout: 500 * time.Millisecond,
901909
})
902-
defer test_helpers.StopTarantoolWithCleanup(inst)
903910

904911
if err != nil {
905912
log.Fatalf("Failed to prepare test tarantool: %s", err)
906913
}
907914

915+
defer test_helpers.StopTarantoolWithCleanup(inst)
916+
917+
workDirs := []string{"work_dir1", "work_dir2", "work_dir3"}
918+
poolOpts := test_helpers.StartOpts{
919+
InitScript: "config.lua",
920+
User: opts.User,
921+
Pass: opts.Pass,
922+
WaitStart: 100 * time.Millisecond,
923+
ConnectRetry: 3,
924+
RetryTimeout: 500 * time.Millisecond,
925+
}
926+
instances, err = test_helpers.StartTarantoolInstances(serversPool, workDirs, poolOpts)
927+
928+
if err != nil {
929+
log.Fatalf("Failed to prepare test tarantool pool: %s", err)
930+
}
931+
932+
defer test_helpers.StopTarantoolInstances(instances)
933+
934+
roles := []bool{false, true, true}
935+
connOpts := Opts{
936+
Timeout: 500 * time.Millisecond,
937+
User: "test",
938+
Pass: "test",
939+
}
940+
err = test_helpers.SetClusterRO(serversPool, connOpts, roles)
941+
942+
if err != nil {
943+
log.Fatalf("Failed to set roles in tarantool pool: %s", err)
944+
}
908945
return m.Run()
909946
}
910947

0 commit comments

Comments
 (0)