legion-transport 1.1.9 → 1.2.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/.github/workflows/rubocop-analysis.yml +41 -0
- data/.github/workflows/sourcehawk-scan.yml +20 -0
- data/.gitignore +4 -2
- data/.rubocop.yml +0 -6
- data/CHANGELOG.md +2 -29
- data/CODE_OF_CONDUCT.md +75 -0
- data/CONTRIBUTING.md +55 -0
- data/Gemfile +7 -0
- data/INDIVIDUAL_CONTRIBUTOR_LICENSE.md +30 -0
- data/LICENSE +201 -0
- data/NOTICE.txt +9 -0
- data/README.md +90 -2
- data/SECURITY.md +9 -0
- data/attribution.txt +1 -0
- data/legion-transport.gemspec +20 -27
- data/lib/legion/transport.rb +25 -2
- data/lib/legion/transport/common.rb +3 -3
- data/lib/legion/transport/connection.rb +9 -5
- data/lib/legion/transport/connection/ssl.rb +35 -0
- data/lib/legion/transport/connection/vault.rb +9 -0
- data/lib/legion/transport/consumer.rb +0 -0
- data/lib/legion/transport/exchange.rb +10 -2
- data/lib/legion/transport/exchanges/crypt.rb +1 -1
- data/lib/legion/transport/exchanges/extensions.rb +11 -0
- data/lib/legion/transport/exchanges/lex.rb +1 -4
- data/lib/legion/transport/exchanges/node.rb +0 -0
- data/lib/legion/transport/exchanges/task.rb +0 -0
- data/lib/legion/transport/message.rb +37 -4
- data/lib/legion/transport/messages/check_subtask.rb +0 -0
- data/lib/legion/transport/messages/dynamic.rb +0 -0
- data/lib/legion/transport/messages/{node_health.rb → extension.rb} +4 -4
- data/lib/legion/transport/messages/lex_register.rb +3 -3
- data/lib/legion/transport/messages/request_cluster_secret.rb +0 -0
- data/lib/legion/transport/messages/subtask.rb +0 -0
- data/lib/legion/transport/messages/task.rb +0 -0
- data/lib/legion/transport/messages/task_log.rb +0 -0
- data/lib/legion/transport/messages/task_update.rb +0 -0
- data/lib/legion/transport/queue.rb +1 -1
- data/lib/legion/transport/queues/node.rb +0 -0
- data/lib/legion/transport/queues/node_crypt.rb +0 -0
- data/lib/legion/transport/queues/node_status.rb +0 -0
- data/lib/legion/transport/queues/task_log.rb +0 -0
- data/lib/legion/transport/queues/task_update.rb +0 -0
- data/lib/legion/transport/settings.rb +15 -8
- data/lib/legion/transport/version.rb +1 -1
- data/sonar-project.properties +1 -1
- data/sourcehawk.yml +4 -0
- metadata +48 -132
- data/.circleci/config.yml +0 -84
- data/.rspec +0 -1
- data/Rakefile +0 -6
- data/bitbucket-pipelines.yml +0 -14
- data/settings/transport.json +0 -5
data/NOTICE.txt
ADDED
data/README.md
CHANGED
@@ -1,3 +1,91 @@
|
|
1
|
-
|
1
|
+
Legion::Transport
|
2
|
+
=====
|
2
3
|
|
3
|
-
|
4
|
+
Legion::Transport is the gem responsible for connecting LegionIO to the FIFO queue system(RabbitMQ over AMQP 0.9.1)
|
5
|
+
|
6
|
+
Supported Ruby versions and implementations
|
7
|
+
------------------------------------------------
|
8
|
+
|
9
|
+
Legion::Transport should work identically on:
|
10
|
+
|
11
|
+
* JRuby 9.2+
|
12
|
+
* Ruby 2.4+
|
13
|
+
|
14
|
+
|
15
|
+
Installation and Usage
|
16
|
+
------------------------
|
17
|
+
|
18
|
+
You can verify your installation using this piece of code:
|
19
|
+
|
20
|
+
```bash
|
21
|
+
gem install legion-transport
|
22
|
+
```
|
23
|
+
|
24
|
+
```ruby
|
25
|
+
require 'legion/transport'
|
26
|
+
conn = Legion::Transport::Connection
|
27
|
+
conn.setup
|
28
|
+
conn.channel # => ::Bunny::Channel
|
29
|
+
conn.session # => ::Bunny::Session
|
30
|
+
```
|
31
|
+
|
32
|
+
Settings
|
33
|
+
----------
|
34
|
+
|
35
|
+
```json
|
36
|
+
{
|
37
|
+
"type": "rabbitmq",
|
38
|
+
"connected": false,
|
39
|
+
"logger_level": "info",
|
40
|
+
"messages": {
|
41
|
+
"encrypt": false,
|
42
|
+
"ttl": null,
|
43
|
+
"priority": 0,
|
44
|
+
"persistent": true
|
45
|
+
},
|
46
|
+
"prefetch": 2,
|
47
|
+
"exchanges": {
|
48
|
+
"type": "topic",
|
49
|
+
"arguments": {},
|
50
|
+
"auto_delete": false,
|
51
|
+
"durable": true,
|
52
|
+
"internal": false
|
53
|
+
},
|
54
|
+
"queues": {
|
55
|
+
"manual_ack": true,
|
56
|
+
"durable": true,
|
57
|
+
"exclusive": false,
|
58
|
+
"block": false,
|
59
|
+
"auto_delete": false,
|
60
|
+
"arguments": {
|
61
|
+
"x-max-priority": 255,
|
62
|
+
"x-overflow": "reject-publish"
|
63
|
+
}
|
64
|
+
},
|
65
|
+
"connection": {
|
66
|
+
"read_timeout": 1,
|
67
|
+
"heartbeat": 30,
|
68
|
+
"automatically_recover": true,
|
69
|
+
"continuation_timeout": 4000,
|
70
|
+
"network_recovery_interval": 1,
|
71
|
+
"connection_timeout": 1,
|
72
|
+
"frame_max": 65536,
|
73
|
+
"user": "guest",
|
74
|
+
"password": "guest",
|
75
|
+
"host": "127.0.0.1",
|
76
|
+
"port": "5672",
|
77
|
+
"vhost": "/",
|
78
|
+
"recovery_attempts": 100,
|
79
|
+
"logger_level": "info",
|
80
|
+
"connected": false
|
81
|
+
},
|
82
|
+
"channel": {
|
83
|
+
"default_worker_pool_size": 1,
|
84
|
+
"session_worker_pool_size": 8
|
85
|
+
}
|
86
|
+
}
|
87
|
+
```
|
88
|
+
Authors
|
89
|
+
----------
|
90
|
+
|
91
|
+
* [Matthew Iverson](https://github.com/Esity) - current maintainer
|
data/SECURITY.md
ADDED
data/attribution.txt
ADDED
@@ -0,0 +1 @@
|
|
1
|
+
Add attributions here.
|
data/legion-transport.gemspec
CHANGED
@@ -1,40 +1,33 @@
|
|
1
|
-
|
2
|
-
|
3
|
-
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
require_relative 'lib/legion/transport/version'
|
4
4
|
|
5
5
|
Gem::Specification.new do |spec|
|
6
6
|
spec.name = 'legion-transport'
|
7
7
|
spec.version = Legion::Transport::VERSION
|
8
8
|
spec.authors = ['Esity']
|
9
|
-
spec.email = [
|
10
|
-
|
11
|
-
spec.summary = 'Used by Legion to connect with RabbitMQ'
|
12
|
-
spec.description = 'The Legion transport gem'
|
13
|
-
spec.homepage = 'https://bitbucket.org/legion-io/legion-transport'
|
14
|
-
spec.required_ruby_version = '>= 2.5.0'
|
9
|
+
spec.email = %w[matthewdiverson@gmail.com ruby@optum.com]
|
15
10
|
|
11
|
+
spec.summary = 'Manages the connection to the transport tier(RabbitMQ)'
|
12
|
+
spec.description = 'The Gem to connect LegionIO and it\'s extensions to the transport tier'
|
13
|
+
spec.homepage = 'https://github.com/Optum/legion-transport'
|
14
|
+
spec.license = 'Apache-2.0'
|
15
|
+
spec.require_paths = ['lib']
|
16
|
+
spec.required_ruby_version = '>= 2.5'
|
17
|
+
spec.files = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
|
18
|
+
spec.test_files = spec.files.select { |p| p =~ %r{^test/.*_test.rb} }
|
19
|
+
spec.extra_rdoc_files = %w[README.md LICENSE CHANGELOG.md]
|
16
20
|
spec.metadata = {
|
17
|
-
'bug_tracker_uri' => 'https://
|
18
|
-
'changelog_uri' => 'https://
|
19
|
-
'
|
20
|
-
'
|
21
|
+
'bug_tracker_uri' => 'https://github.com/Optum/legion-transport/issues',
|
22
|
+
'changelog_uri' => 'https://github.com/Optum/legion-transport/src/main/CHANGELOG.md',
|
23
|
+
'documentation_uri' => 'https://github.com/Optum/legion-transport',
|
24
|
+
'homepage_uri' => 'https://github.com/Optum/LegionIO',
|
25
|
+
'source_code_uri' => 'https://github.com/Optum/legion-transport',
|
26
|
+
'wiki_uri' => 'https://github.com/Optum/legion-transport/wiki'
|
21
27
|
}
|
22
28
|
|
23
|
-
spec.files = `git ls-files -z`.split("\x0").reject do |f|
|
24
|
-
f.match(%r{^(test|spec|features)/})
|
25
|
-
end
|
26
|
-
spec.require_paths = ['lib']
|
27
|
-
|
28
|
-
spec.add_development_dependency 'legion-logging'
|
29
|
-
spec.add_development_dependency 'legion-settings'
|
30
|
-
spec.add_development_dependency 'rake'
|
31
|
-
spec.add_development_dependency 'rspec'
|
32
|
-
spec.add_development_dependency 'rspec_junit_formatter'
|
33
|
-
spec.add_development_dependency 'rubocop'
|
34
|
-
spec.add_development_dependency 'simplecov'
|
35
|
-
spec.add_development_dependency 'simplecov_json_formatter'
|
36
|
-
|
37
29
|
spec.add_dependency 'bunny', '>= 2.17.0'
|
38
30
|
spec.add_dependency 'concurrent-ruby', '>= 1.1.7'
|
39
31
|
spec.add_dependency 'legion-json'
|
32
|
+
spec.add_dependency 'legion-settings'
|
40
33
|
end
|
data/lib/legion/transport.rb
CHANGED
@@ -1,5 +1,6 @@
|
|
1
|
-
|
2
|
-
|
1
|
+
require 'legion/transport/version'
|
2
|
+
require 'legion/settings'
|
3
|
+
require 'legion/transport/settings'
|
3
4
|
|
4
5
|
module Legion
|
5
6
|
module Transport
|
@@ -12,6 +13,28 @@ module Legion
|
|
12
13
|
TYPE = 'bunny'.freeze
|
13
14
|
CONNECTOR = ::Bunny
|
14
15
|
end
|
16
|
+
|
17
|
+
class << self
|
18
|
+
def logger
|
19
|
+
@logger unless @logger.nil?
|
20
|
+
|
21
|
+
if ::Legion.const_defined?('Logging')
|
22
|
+
@logger = ::Legion::Logging
|
23
|
+
else
|
24
|
+
require 'logger'
|
25
|
+
@logger = ::Logger.new($stdout)
|
26
|
+
@logger.level = Logger::ERROR
|
27
|
+
end
|
28
|
+
|
29
|
+
@logger
|
30
|
+
end
|
31
|
+
|
32
|
+
def settings
|
33
|
+
Legion::Settings[:transport] if Legion.const_defined? 'Settings'
|
34
|
+
|
35
|
+
Legion::Transport::Settings.default
|
36
|
+
end
|
37
|
+
end
|
15
38
|
end
|
16
39
|
|
17
40
|
require_relative 'transport/common'
|
@@ -52,14 +52,14 @@ module Legion
|
|
52
52
|
end
|
53
53
|
|
54
54
|
def close!
|
55
|
-
Legion::
|
55
|
+
Legion::Transport.logger.error 'close! called'
|
56
56
|
false unless Legion::Transport::Connection.channel_open?
|
57
57
|
Legion::Transport::Connection.channel.close
|
58
58
|
end
|
59
59
|
|
60
60
|
def close
|
61
|
-
Legion::
|
62
|
-
Legion::
|
61
|
+
Legion::Transport.logger.error 'close called'
|
62
|
+
Legion::Transport.logger.warn 'close called, but method is called close!'
|
63
63
|
close!
|
64
64
|
end
|
65
65
|
|
@@ -23,7 +23,7 @@ module Legion
|
|
23
23
|
end
|
24
24
|
|
25
25
|
def setup(connection_name: 'Legion', **) # rubocop:disable Metrics/AbcSize,Metrics/MethodLength
|
26
|
-
Legion::
|
26
|
+
Legion::Transport.logger.info("Using transport connector: #{Legion::Transport::CONNECTOR}")
|
27
27
|
|
28
28
|
if @session.respond_to?(:value) && session.respond_to?(:closed?) && session.closed?
|
29
29
|
@channel_thread = Concurrent::ThreadLocalVar.new(nil)
|
@@ -46,7 +46,7 @@ module Legion
|
|
46
46
|
connector.new(
|
47
47
|
Legion::Settings[:transport][:connection],
|
48
48
|
connection_name: connection_name,
|
49
|
-
logger: Legion::
|
49
|
+
logger: Legion::Transport.logger,
|
50
50
|
log_level: :info
|
51
51
|
)
|
52
52
|
)
|
@@ -58,15 +58,19 @@ module Legion
|
|
58
58
|
end
|
59
59
|
|
60
60
|
if session.respond_to? :on_blocked
|
61
|
-
session.on_blocked { Legion::
|
61
|
+
session.on_blocked { Legion::Transport.logger.warn('Legion::Transport is being blocked by RabbitMQ!') }
|
62
62
|
end
|
63
63
|
|
64
64
|
if session.respond_to? :on_unblocked
|
65
|
-
session.on_unblocked
|
65
|
+
session.on_unblocked do
|
66
|
+
Legion::Transport.logger.info('Legion::Transport is no longer being blocked by RabbitMQ')
|
67
|
+
end
|
66
68
|
end
|
67
69
|
|
68
70
|
if session.respond_to? :after_recovery_completed
|
69
|
-
session.after_recovery_completed
|
71
|
+
session.after_recovery_completed do
|
72
|
+
Legion::Transport.logger.info('Legion::Transport has completed recovery')
|
73
|
+
end
|
70
74
|
end
|
71
75
|
|
72
76
|
true
|
@@ -0,0 +1,35 @@
|
|
1
|
+
module Legion
|
2
|
+
module Transport
|
3
|
+
module Connection
|
4
|
+
module SSL
|
5
|
+
def settings
|
6
|
+
Legion::Settings[:transport][:tls] || {}
|
7
|
+
end
|
8
|
+
|
9
|
+
def use_vault_pki?
|
10
|
+
settings[:use_vault_pki] && Legion::Settings[:crypt][:vault][:connected]
|
11
|
+
end
|
12
|
+
|
13
|
+
def use_tls?
|
14
|
+
settings[:use_tls] || Legion::Settings[:transport][:port] == 5671
|
15
|
+
end
|
16
|
+
|
17
|
+
def tls_cert
|
18
|
+
settings[:tls_cert]
|
19
|
+
end
|
20
|
+
|
21
|
+
def tls_key
|
22
|
+
settings[:tls_key]
|
23
|
+
end
|
24
|
+
|
25
|
+
def ca_certs
|
26
|
+
settings[:ca_certs]
|
27
|
+
end
|
28
|
+
|
29
|
+
def verify_peer?
|
30
|
+
settings[:verify_peer] || false
|
31
|
+
end
|
32
|
+
end
|
33
|
+
end
|
34
|
+
end
|
35
|
+
end
|
File without changes
|
@@ -22,7 +22,7 @@ module Legion
|
|
22
22
|
end
|
23
23
|
|
24
24
|
def delete_exchange(exchange)
|
25
|
-
Legion::
|
25
|
+
Legion::Transport.logger.warn "Exchange:#{exchange} exists with wrong parameters, deleting and creating"
|
26
26
|
channel.exchange_delete(exchange)
|
27
27
|
end
|
28
28
|
|
@@ -31,9 +31,14 @@ module Legion
|
|
31
31
|
hash[:durable] = true
|
32
32
|
hash[:auto_delete] = false
|
33
33
|
hash[:arguments] = {}
|
34
|
+
hash[:passive] = passive?
|
34
35
|
hash
|
35
36
|
end
|
36
37
|
|
38
|
+
def passive?
|
39
|
+
false
|
40
|
+
end
|
41
|
+
|
37
42
|
def exchange_name
|
38
43
|
self.class.ancestors.first.to_s.split('::')[2].downcase
|
39
44
|
end
|
@@ -54,7 +59,10 @@ module Legion
|
|
54
59
|
end
|
55
60
|
|
56
61
|
def channel
|
57
|
-
Legion::Transport::Connection.channel
|
62
|
+
@channel ||= Legion::Transport::Connection.channel
|
63
|
+
rescue ChannelLevelException => e
|
64
|
+
@channel = Legion::Transport::Connection.channel
|
65
|
+
raise e unless @channel.open?
|
58
66
|
end
|
59
67
|
end
|
60
68
|
end
|
File without changes
|
File without changes
|
@@ -19,7 +19,38 @@ module Legion
|
|
19
19
|
type: options[:type] || type,
|
20
20
|
priority: options[:priority] || priority,
|
21
21
|
expiration: options[:expiration] || expiration,
|
22
|
-
headers: headers
|
22
|
+
headers: headers,
|
23
|
+
persistent: persistent,
|
24
|
+
message_id: message_id,
|
25
|
+
timestamp: timestamp)
|
26
|
+
end
|
27
|
+
|
28
|
+
def app_id
|
29
|
+
@options[:app_id] if @options.key? :app_id
|
30
|
+
|
31
|
+
'legion'
|
32
|
+
end
|
33
|
+
|
34
|
+
def message_id
|
35
|
+
@options[:message_id] || @options[:task_id]
|
36
|
+
end
|
37
|
+
|
38
|
+
# user_id Sender's identifier. https://www.rabbitmq.com/extensions.html#validated-user-id
|
39
|
+
def user_id
|
40
|
+
@options[:user_id] || Legion::Transport.settings[:connection][:user]
|
41
|
+
end
|
42
|
+
|
43
|
+
def reply_to
|
44
|
+
@options[:reply_to]
|
45
|
+
end
|
46
|
+
|
47
|
+
# ID of the message that this message is a reply to
|
48
|
+
def correlation_id
|
49
|
+
nil
|
50
|
+
end
|
51
|
+
|
52
|
+
def persistent
|
53
|
+
@options[:persistent] || Legion::Transport.settings[:messages][:persistent]
|
23
54
|
end
|
24
55
|
|
25
56
|
def expiration
|
@@ -27,6 +58,8 @@ module Legion
|
|
27
58
|
@options[:expiration]
|
28
59
|
elsif @options.key? :ttl
|
29
60
|
@options[:ttl]
|
61
|
+
elsif Legion::Transport.settings[:messages].key? :expiration
|
62
|
+
Legion::Transport.settings[:messages][:expiration]
|
30
63
|
end
|
31
64
|
end
|
32
65
|
|
@@ -80,8 +113,8 @@ module Legion
|
|
80
113
|
end
|
81
114
|
@options[:headers]
|
82
115
|
rescue StandardError => e
|
83
|
-
Legion::
|
84
|
-
Legion::
|
116
|
+
Legion::Transport.logger.error e.message
|
117
|
+
Legion::Transport.logger.error e.backtrace
|
85
118
|
end
|
86
119
|
|
87
120
|
def priority
|
@@ -101,7 +134,7 @@ module Legion
|
|
101
134
|
end
|
102
135
|
|
103
136
|
def timestamp
|
104
|
-
now.to_i
|
137
|
+
Time.now.to_i
|
105
138
|
end
|
106
139
|
|
107
140
|
def validate
|