[Refactor] Remove global config references (coinbase#317)

* Remove global config from client specs

* Remove global configuration from client and connection

* Remove global configuration from integration specs

* Remove global config from error messages and comments

* Remove global config from specs

* Remove global config from worker spec

* Add README section on global vs local configuration

Author: antstorm

README.md

@@ -179,6 +179,47 @@ Temporal.configure do |config|
 end
 ```
 
+## Configuration
+
+This gem is optimised for the smoothest out-of-the-box experience, which is achieved using a global
+configuration:
+
+```ruby
+Temporal.configure do |config|
+  config.host = '127.0.0.1' # sets global host
+  ...
+end
+
+Temporal::Worker.new # uses global host
+Temporal.start_workflow(...) # uses global host
+```
+
+This will work just fine for simpler use-cases, however at some point you might need to setup
+multiple clients and workers within the same instance of your app (e.g. you have different Temporal
+hosts, need to use different codecs/converters for different parts of your app, etc). Should this be
+the case we recommend using explicit local configurations for each client/worker:
+
+```ruby
+config_1 = Temporal::Configuration.new
+config_1.host = 'temporal-01'
+
+config_2 = Temporal::Configuration.new
+config_2.host = 'temporal-01'
+
+worker_1 = Temporal::Worker.new(config_1)
+worker_2 = Temporal::Worker.new(config_2)
+
+client_1 = Temporal::Client.new(config_1)
+client_1.start_workflow(...)
+
+client_2 = Temporal::Client.new(config_2)
+client_2.start_workflow(...)
+```
+
+*NOTE: Almost all the methods on the `Temporal` module are delegated to the default client that's
+initialized using global configuration. The same methods can be used directly on your own client
+instances.*
+
 ## Workflows
 
 A workflow is defined using pure Ruby code, however it should contain only a high-level

examples/init.rb

@@ -8,10 +8,13 @@
 
 metrics_logger = Logger.new(STDOUT, progname: 'metrics')
 
+DEFAULT_NAMESPACE = 'ruby-samples'.freeze
+DEFAULT_TASK_QUEUE = 'general'.freeze
+
 Temporal.configure do |config|
   config.host = ENV.fetch('TEMPORAL_HOST', 'localhost')
   config.port = ENV.fetch('TEMPORAL_PORT', 7233).to_i
-  config.namespace = ENV.fetch('TEMPORAL_NAMESPACE', 'ruby-samples')
-  config.task_queue = ENV.fetch('TEMPORAL_TASK_QUEUE', 'general')
+  config.namespace = ENV.fetch('TEMPORAL_NAMESPACE', DEFAULT_NAMESPACE)
+  config.task_queue = ENV.fetch('TEMPORAL_TASK_QUEUE', DEFAULT_TASK_QUEUE)
   config.metrics_adapter = Temporal::MetricsAdapters::Log.new(metrics_logger)
 end

examples/spec/helpers.rb

@@ -21,7 +21,7 @@ def wait_for_workflow_completion(workflow_id, run_id)
   def fetch_history(workflow_id, run_id, options = {})
     connection = Temporal.send(:default_client).send(:connection)
     options = {
-      namespace: Temporal.configuration.namespace,
+      namespace: integration_spec_namespace,
       workflow_id: workflow_id,
       run_id: run_id,
     }.merge(options)
@@ -30,6 +30,10 @@ def fetch_history(workflow_id, run_id, options = {})
   end
 
   def integration_spec_namespace
-    ENV.fetch('TEMPORAL_NAMESPACE', 'ruby-samples')
+    ENV.fetch('TEMPORAL_NAMESPACE', DEFAULT_NAMESPACE)
+  end
+
+  def integration_spec_task_queue
+    ENV.fetch('TEMPORAL_TASK_QUEUE', DEFAULT_TASK_QUEUE)
   end
 end

examples/spec/integration/converter_spec.rb

@@ -12,8 +12,6 @@
   end
 
   around(:each) do |example|
-    task_queue = Temporal.configuration.task_queue
-
     Temporal.configure do |config|
       config.task_queue = 'crypt'
       config.payload_codec = codec
@@ -22,7 +20,7 @@
     example.run
   ensure
     Temporal.configure do |config|
-      config.task_queue = task_queue
+      config.task_queue = integration_spec_task_queue
       config.payload_codec = Temporal::Configuration::DEFAULT_PAYLOAD_CODEC
     end
   end

examples/spec/integration/create_schedule_spec.rb

@@ -25,7 +25,7 @@
         "Test",
         options: {
           workflow_id: workflow_id,
-          task_queue: Temporal.configuration.task_queue
+          task_queue: integration_spec_task_queue
         }
       ),
       policies: Temporal::Schedule::SchedulePolicies.new(
@@ -74,7 +74,7 @@
       action: Temporal::Schedule::StartWorkflowAction.new(
         "HelloWorldWorkflow",
         "Test",
-        options: {task_queue: Temporal.configuration.task_queue}
+        options: {task_queue: integration_spec_task_queue}
       )
     )
 

examples/spec/integration/delete_schedule_spec.rb

@@ -15,7 +15,7 @@
         "HelloWorldWorkflow",
         "Test",
         options: {
-          task_queue: Temporal.configuration.task_queue
+          task_queue: integration_spec_task_queue
         }
       )
     )

examples/spec/integration/handling_structured_error_workflow_spec.rb

@@ -5,16 +5,14 @@
   # That worker runs a task queue, error_serialization_v2.  This setup code will
   # route workflow requests to that task queue.
   around(:each) do |example|
-    task_queue = Temporal.configuration.task_queue
-
     Temporal.configure do |config|
       config.task_queue = 'error_serialization_v2'
     end
 
     example.run
   ensure
     Temporal.configure do |config|
-      config.task_queue = task_queue
+      config.task_queue = integration_spec_task_queue
     end
   end
 

examples/spec/integration/list_schedules_spec.rb

@@ -22,7 +22,7 @@
         "HelloWorldWorkflow",
         "Test",
         options: {
-          task_queue: Temporal.configuration.task_queue
+          task_queue: integration_spec_task_queue
         }
       )
     )

examples/spec/integration/metadata_workflow_spec.rb

@@ -16,7 +16,7 @@
       run_id: run_id,
     )
 
-    expect(actual_result.task_queue).to eq(Temporal.configuration.task_queue)
+    expect(actual_result.task_queue).to eq(integration_spec_task_queue)
   end
 
   it 'workflow can retrieve its headers' do

examples/spec/integration/pause_schedule_spec.rb

@@ -17,7 +17,7 @@
         "HelloWorldWorkflow",
         "Test",
         options: {
-          task_queue: Temporal.configuration.task_queue
+          task_queue: integration_spec_task_queue
         }
       )
     )