cloudmunda 0.1.1 → 0.1.4

data/diagrams/demo.bpmn

@@ -0,0 +1,47 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<bpmn:definitions xmlns:bpmn="http://www.omg.org/spec/BPMN/20100524/MODEL" xmlns:bpmndi="http://www.omg.org/spec/BPMN/20100524/DI" xmlns:dc="http://www.omg.org/spec/DD/20100524/DC" xmlns:zeebe="http://camunda.org/schema/zeebe/1.0" xmlns:modeler="http://camunda.org/schema/modeler/1.0" xmlns:di="http://www.omg.org/spec/DD/20100524/DI" id="Definitions_0rbumvm" targetNamespace="http://bpmn.io/schema/bpmn" modeler:executionPlatform="Camunda Cloud" modeler:executionPlatformVersion="1.2.0">
+  <bpmn:process id="cloudmunda-demo" name="cloudmunda-demo" isExecutable="true">
+    <bpmn:startEvent id="StartEvent_1" name="Webhook received">
+      <bpmn:outgoing>Flow_0easrsr</bpmn:outgoing>
+    </bpmn:startEvent>
+    <bpmn:sequenceFlow id="Flow_0easrsr" sourceRef="StartEvent_1" targetRef="Activity_0le34m7" />
+    <bpmn:endEvent id="Event_0a948ov" name="Webhook processed">
+      <bpmn:incoming>Flow_1g4bjdg</bpmn:incoming>
+    </bpmn:endEvent>
+    <bpmn:sequenceFlow id="Flow_1g4bjdg" sourceRef="Activity_0le34m7" targetRef="Event_0a948ov" />
+    <bpmn:serviceTask id="Activity_0le34m7" name="Send slack message to announce">
+      <bpmn:extensionElements>
+        <zeebe:taskDefinition type="webhook-slack-announce" />
+      </bpmn:extensionElements>
+      <bpmn:incoming>Flow_0easrsr</bpmn:incoming>
+      <bpmn:outgoing>Flow_1g4bjdg</bpmn:outgoing>
+    </bpmn:serviceTask>
+  </bpmn:process>
+  <bpmndi:BPMNDiagram id="BPMNDiagram_1">
+    <bpmndi:BPMNPlane id="BPMNPlane_1" bpmnElement="cloudmunda-demo">
+      <bpmndi:BPMNEdge id="Flow_0easrsr_di" bpmnElement="Flow_0easrsr">
+        <di:waypoint x="215" y="97" />
+        <di:waypoint x="270" y="97" />
+      </bpmndi:BPMNEdge>
+      <bpmndi:BPMNEdge id="Flow_1g4bjdg_di" bpmnElement="Flow_1g4bjdg">
+        <di:waypoint x="370" y="97" />
+        <di:waypoint x="432" y="97" />
+      </bpmndi:BPMNEdge>
+      <bpmndi:BPMNShape id="_BPMNShape_StartEvent_2" bpmnElement="StartEvent_1">
+        <dc:Bounds x="179" y="79" width="36" height="36" />
+        <bpmndi:BPMNLabel>
+          <dc:Bounds x="174" y="122" width="47" height="27" />
+        </bpmndi:BPMNLabel>
+      </bpmndi:BPMNShape>
+      <bpmndi:BPMNShape id="Event_0a948ov_di" bpmnElement="Event_0a948ov">
+        <dc:Bounds x="432" y="79" width="36" height="36" />
+        <bpmndi:BPMNLabel>
+          <dc:Bounds x="425" y="122" width="51" height="27" />
+        </bpmndi:BPMNLabel>
+      </bpmndi:BPMNShape>
+      <bpmndi:BPMNShape id="Activity_1qerp1u_di" bpmnElement="Activity_0le34m7">
+        <dc:Bounds x="270" y="57" width="100" height="80" />
+      </bpmndi:BPMNShape>
+    </bpmndi:BPMNPlane>
+  </bpmndi:BPMNDiagram>
+</bpmn:definitions>

data/exe/cloudmunda

@@ -1,14 +1,17 @@
 #!/usr/bin/env ruby
-require "bundler/setup"
-require "cloudmunda/cli"
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'cloudmunda/cli'
 
 begin
   cli = ::Cloudmunda::CLI.instance
   cli.parse
   cli.run
-rescue => e
+rescue StandardError => e
   raise e if $DEBUG
-  STDERR.puts e.message
-  STDERR.puts e.backtrace.join("\n")
+
+  warn e.message
+  warn e.backtrace.join("\n")
   exit 1
 end

data/lib/cloudmunda/api/access_token.rb

@@ -6,10 +6,10 @@ module Cloudmunda
       def self.create(audience_url: Cloudmunda.audience)
         uri = Cloudmunda.auth_url
         payload = {
-          "grant_type":"client_credentials",
-          "audience": audience_url,
-          "client_id": Cloudmunda.client_id,
-          "client_secret": Cloudmunda.client_secret
+          grant_type: 'client_credentials',
+          audience: audience_url,
+          client_id: Cloudmunda.client_id,
+          client_secret: Cloudmunda.client_secret
         }
 
         create_by_uri(uri: uri, payload: payload)

data/lib/cloudmunda/api/client.rb

@@ -15,7 +15,7 @@ module Cloudmunda
 
       def self.headers
         {
-          authorization: "Basic " + Base64.strict_encode64("#{Cloudmunda.client_id}:#{Cloudmunda.client_secret}"),
+          authorization: "Basic #{Base64.strict_encode64("#{Cloudmunda.client_id}:#{Cloudmunda.client_secret}")}"
         }
       end
 
@@ -26,4 +26,4 @@ module Cloudmunda
       end
     end
   end
-end
+end

data/lib/cloudmunda/api/o_auth_resource.rb

@@ -7,13 +7,9 @@ module Cloudmunda
     class OAuthResource < OpenStruct
       def self.create_by_uri(uri:, payload:)
         raw_item = Cloudmunda::API::Client.post(uri, payload)
-        raw_item = {} if raw_item == ""
+        raw_item = {} if raw_item == ''
         new(raw_item)
       end
-
-      def initialize(raw)
-        super(raw)
-      end
     end
   end
 end

data/lib/cloudmunda/api.rb

@@ -1,4 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'api/o_auth_resource'
 require_relative 'api/access_token'
 require_relative 'api/client'
-

data/lib/cloudmunda/cli/launcher.rb

@@ -1,8 +1,9 @@
+# frozen_string_literal: true
+
 require_relative 'supervisor'
 
 module Cloudmunda
   class Launcher
-
     attr_reader :supervisor
 
     def initialize

data/lib/cloudmunda/cli/processor.rb

@@ -1,9 +1,10 @@
+# frozen_string_literal: true
+
 module Cloudmunda
   class Processor
-
     attr_reader :client, :worker_class, :busy_count, :timer
 
-    def initialize(client: ::Cloudmunda.client, worker_class:)
+    def initialize(worker_class:, client: ::Cloudmunda.client)
       @client = client
       @worker_class = worker_class
       @busy_count = ::Concurrent::AtomicFixnum.new(0)
@@ -54,11 +55,11 @@ module Cloudmunda
         worker.complete_job(job)
 
         logger.info "class=#{worker_class} jid=#{job.key} Done processing #{job.type}"
-      rescue => exception
-        logger.info "class=#{worker_class} jid=#{job.key} Failed processing #{job.type}: #{exception.message}"
+      rescue StandardError => e
+        logger.info "class=#{worker_class} jid=#{job.key} Failed processing #{job.type}: #{e.message}"
 
-        worker.fail_job(job, reason: exception.message)
-        raise exception
+        worker.fail_job(job, reason: e.message)
+        raise e
       ensure
         busy_count.decrement
       end
@@ -70,7 +71,7 @@ module Cloudmunda
         worker: worker_name,
         timeout: worker_timeout * 1000,
         maxJobsToActivate: max_jobs_to_activate,
-        fetchVariable: worker_variables_to_fetch,
+        fetchVariable: worker_variables_to_fetch
       )
     end
 

data/lib/cloudmunda/cli/supervisor.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'processor'
 
 module Cloudmunda
@@ -7,14 +9,20 @@ module Cloudmunda
     end
 
     def start
-      @processors = workers.map do |worker_class|
+      workers.each do |worker_class|
+        if ::Cloudmunda.env == 'development' && !worker_class.get_runs_in_development
+          logger.info "Not starting a processor for worker #{worker_class.get_type} as it doesn't run in development."
+          next
+        end
+
+        logger.info "Starting a processor for worker #{worker_class.get_type}"
         processor = ::Cloudmunda::Processor.new(worker_class: worker_class)
-        processor.start
+        @processors << processor.start
       end
     end
 
     def quiet
-      logger.info "Terminating workers"
+      logger.info 'Terminating workers'
       @processors.each(&:stop)
     end
 

data/lib/cloudmunda/cli/worker.rb

@@ -1,8 +1,10 @@
+# frozen_string_literal: true
+
 require 'json'
 
 module Cloudmunda
   module Worker
-    attr_accessor :client, :type, :max_jobs_to_activate, :poll_interval, :timeout, :variables
+    attr_accessor :client, :type, :max_jobs_to_activate, :poll_interval, :timeout, :variables, :runs_in_development
 
     def self.included(base)
       base.extend(ClassMethods)
@@ -17,18 +19,18 @@ module Cloudmunda
       logger.info "Completed processing job #{job.type} #{job.key}"
       client.complete_job(
         jobKey: job.key,
-        variables: Hash(variables).to_json,
+        variables: Hash(variables).to_json
       )
     end
 
-    def fail_job(job, reason: "")
+    def fail_job(job, reason: '')
       logger.error "Failed processing job #{job.type} #{job.key}: #{reason}"
       client.fail_job(
         jobKey: job.key,
         retries: job.retries - 1,
-        errorMessage: reason,
+        errorMessage: reason
       )
-    rescue => e
+    rescue StandardError => e
       logger.error e.message
     end
 
@@ -55,7 +57,7 @@ module Cloudmunda
       #
       # @return [String]
       def get_type
-        @type
+        get_runs_in_development ? "#{@type}-dev" : @type
       end
 
       # Sets the maximum number of jobs to send to the worker for processing at once.
@@ -150,12 +152,33 @@ module Cloudmunda
         @variables.to_a
       end
 
+      # Sets if this service task runs in development mode or not.
+      #
+      # @example
+      #   class MyWorker
+      #     include ::Cloudmunda::Worker
+      #     runs_in_development true
+      #   end
+      #
+      # @param [Boolean] runs_in_development
+      # @return [Boolean]
+      def runs_in_development(runs_in_development)
+        @runs_in_development = runs_in_development
+      end
+
+      # Returns if this service task should run in development mode.
+      #
+      # @return [Boolean]
+      def get_runs_in_development
+        @runs_in_development || false
+      end
+
       # Returns the worker's name.
       #
       # @return [String]
       def get_name
         name = self.name.gsub(/::/, ':')
-        name.gsub!(/([^A-Z:])([A-Z])/) { "#{$1}_#{$2}" }
+        name.gsub!(/([^A-Z:])([A-Z])/) { "#{Regexp.last_match(1)}_#{Regexp.last_match(2)}" }
         name.downcase
       end
     end

data/lib/cloudmunda/cli.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'singleton'
 require 'optparse'
 require 'fileutils'
@@ -40,46 +42,47 @@ module Cloudmunda
 
     def option_parser
       OptionParser.new.tap do |p|
-        p.on "-e", "--env ENV", "Application environment" do |arg|
+        p.on '-e', '--env ENV', 'Application environment' do |arg|
           config.env = arg
         end
 
-        p.on "-i", "--client-id CLIENT_ID", "Client ID" do |arg|
+        p.on '-i', '--client-id CLIENT_ID', 'Client ID' do |arg|
           config.client_id = arg
         end
 
-        p.on "-r", "--require [PATH|DIR]", "Location of Rails application with workers or file to require" do |arg|
+        p.on '-r', '--require [PATH|DIR]', 'Location of Rails application with workers or file to require' do |arg|
           if !File.exist?(arg) ||
-              (File.directory?(arg) && !File.exist?("#{arg}/config/application.rb"))
+             (File.directory?(arg) && !File.exist?("#{arg}/config/application.rb"))
             raise ArgumentError, "#{arg} is not a ruby file nor a rails application"
           else
             config.require = arg
           end
         end
 
-        p.on "-s", "--client-secret CLIENT_SECRET", "Client Secret" do |arg|
+        p.on '-s', '--client-secret CLIENT_SECRET', 'Client Secret' do |arg|
           config.client_secret = arg
         end
 
-        p.on "-u", "--zeebe-url ZEEBE_URL", "Zeebe URL" do |arg|
+        p.on '-u', '--zeebe-url ZEEBE_URL', 'Zeebe URL' do |arg|
           config.zeebe_url = arg
         end
 
-        p.on "-U", "--zeebe-auth-url ZEEBE_AUTH_URL", "Zeebe Authorization Server URL" do |arg|
+        p.on '-U', '--zeebe-auth-url ZEEBE_AUTH_URL', 'Zeebe Authorization Server URL' do |arg|
           config.auth_url = arg
         end
 
-        p.on "-a", "--audience URL", "Zeebe Audience" do |arg|
+        p.on '-a', '--audience URL', 'Zeebe Audience' do |arg|
           config.audience = arg
         end
 
-        p.on "-T", "--use-access-token STRING", "Zeebe Audience" do |arg|
+        p.on '-T', '--use-access-token STRING', 'Zeebe Audience' do |arg|
           config.use_access_token = arg.to_s.downcase == 'true'
         end
 
-        p.on "-t", "--timeout NUM", "Shutdown timeout" do |arg|
+        p.on '-t', '--timeout NUM', 'Shutdown timeout' do |arg|
           timeout = Integer(arg)
-          raise ArgumentError, "timeout must be a positive integer" if timeout <= 0
+          raise ArgumentError, 'timeout must be a positive integer' if timeout <= 0
+
           config.timeout = timeout
         end
 
@@ -87,13 +90,13 @@ module Cloudmunda
         #   ::Cloudmuna.logger.level = ::Logger::DEBUG
         # end
 
-        p.on "-V", "--version", "Print version and exit" do |arg|
+        p.on '-V', '--version', 'Print version and exit' do |_arg|
           puts "Cloudmunda #{::Cloudmunda::VERSION}"
           exit(0)
         end
 
-        p.banner = "Usage: cloudmunda [options]"
-        p.on_tail "-h", "--help", "Show help" do
+        p.banner = 'Usage: cloudmunda [options]'
+        p.on_tail '-h', '--help', 'Show help' do
           puts p
 
           exit(1)
@@ -102,18 +105,16 @@ module Cloudmunda
     end
 
     def boot
-      ENV["RACK_ENV"] = ENV["RAILS_ENV"] = config.env
+      ENV['RACK_ENV'] = ENV['RAILS_ENV'] = config.env
 
       if File.directory?(config.require)
         require 'rails'
-        if ::Rails::VERSION::MAJOR < 6
-          raise "Cloudmunda does not supports this version of Rails"
-        else
-          require File.expand_path("#{config.require}/config/environment.rb")
-          Dir[Rails.root.join('app/jobs/**/*.rb')].each { |f| require f }
+        raise 'Cloudmunda does not supports this version of Rails' if ::Rails::VERSION::MAJOR < 6
 
-          logger.info "Booted Rails #{::Rails.version} application in #{config.env} environment"
-        end
+        require File.expand_path("#{config.require}/config/environment.rb")
+        Dir[Rails.root.join('app/jobs/**/*.rb')].sort.each { |f| require f }
+
+        logger.info "Booted Rails #{::Rails.version} application in #{config.env} environment"
       else
         require config.require
       end
@@ -122,21 +123,19 @@ module Cloudmunda
     def launch(self_read)
       @launcher = ::Cloudmunda::Launcher.new
 
-      if config.env == "development" && $stdout.tty?
-        logger.info "Starting processing, hit Ctrl-C to stop"
-      end
+      logger.info 'Starting processing, hit Ctrl-C to stop' if config.env == 'development' && $stdout.tty?
 
       begin
         launcher.start
 
-        while readable_io = IO.select([self_read])
+        while (readable_io = IO.select([self_read]))
           signal = readable_io.first[0].gets.strip
           handle_signal(signal)
         end
       rescue Interrupt
-        logger.info "Shutting down"
+        logger.info 'Shutting down'
         launcher.stop
-        logger.info "Bye!"
+        logger.info 'Bye!'
 
         exit(0)
       end
@@ -153,8 +152,8 @@ module Cloudmunda
 
     def signal_handlers
       {
-        "INT" => ->(cli) { raise Interrupt },
-        "TERM" => ->(cli) { raise Interrupt },
+        'INT' => ->(_cli) { raise Interrupt },
+        'TERM' => ->(_cli) { raise Interrupt }
       }
     end
 

data/lib/cloudmunda/configuration.rb

@@ -1,6 +1,9 @@
+# frozen_string_literal: true
+
 module Cloudmunda
   module Configuration
-    VALID_OPTIONS_KEYS = %i[env require logger timeout zeebe_url auth_url client_id client_secret audience graphql_url].freeze
+    VALID_OPTIONS_KEYS = %i[env require logger timeout zeebe_url auth_url client_id client_secret audience
+                            graphql_url].freeze
     attr_accessor(*VALID_OPTIONS_KEYS)
 
     # Sets all configuration options to their default values when this module is extended.
@@ -20,10 +23,10 @@ module Cloudmunda
 
     # Resets all configuration options to the defaults.
     def reset
-      @env = ENV["APP_ENV"] || ENV["RAILS_ENV"] || ENV["RACK_ENV"] || "development"
+      @env = ENV['APP_ENV'] || ENV['RAILS_ENV'] || ENV['RACK_ENV'] || 'development'
       @logger = Logger.new($stdout)
-      @require = "."
-      @timeout = 30
+      @require = '.'
+      @timeout = @env == 'development' ? 5 : 30
       @zeebe_url = ENV['ZEEBE_URL']
       @auth_url = ENV['ZEEBE_AUTHORIZATION_SERVER_URL']
       @client_id = ENV['ZEEBE_CLIENT_ID']
@@ -32,4 +35,4 @@ module Cloudmunda
       @graphql_url = ENV['GRAPHQL_URL']
     end
   end
-end
+end

data/lib/cloudmunda/graphql/client.rb

@@ -14,8 +14,9 @@ module Cloudmunda
       end
 
       def self.headers
+        access_token = Cloudmunda::API::AccessToken.create(audience_url: 'tasklist.camunda.io').access_token
         {
-          authorization: "Bearer " + Cloudmunda::API::AccessToken.create(audience_url: 'tasklist.camunda.io').access_token
+          authorization: "Bearer #{access_token}"
         }
       end
 

data/lib/cloudmunda/graphql.rb

@@ -1,2 +1,4 @@
+# frozen_string_literal: true
+
 require_relative 'graphql/client'
-require_relative 'graphql/user_tasks'
+require_relative 'graphql/user_tasks'

data/lib/cloudmunda/loggable.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Cloudmunda
   module Loggable
     def logger

data/lib/cloudmunda/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Cloudmunda
-  VERSION = "0.1.1"
+  VERSION = '0.1.4'
 end

data/lib/cloudmunda/zeebe/client.rb

@@ -1,9 +1,10 @@
+# frozen_string_literal: true
+
 require 'zeebe/client'
 
 module Cloudmunda
   module Zeebe
     class Client
-
       attr_reader :client
 
       def initialize(url: ::Cloudmunda.zeebe_url)
@@ -12,83 +13,71 @@ module Cloudmunda
 
       def activate_jobs(params = {})
         run(:activate_jobs,
-          ::Zeebe::Client::GatewayProtocol::ActivateJobsRequest.new(params)
-        )
+            ::Zeebe::Client::GatewayProtocol::ActivateJobsRequest.new(params))
       end
 
       def cancel_workflow_instance(params = {})
         run(:cancel_workflow_instance,
-          ::Zeebe::Client::GatewayProtocol::CancelWorkflowInstanceRequest.new(params)
-        )
+            ::Zeebe::Client::GatewayProtocol::CancelWorkflowInstanceRequest.new(params))
       end
 
       def complete_job(params = {})
         run(:complete_job,
-          ::Zeebe::Client::GatewayProtocol::CompleteJobRequest.new(params)
-        )
+            ::Zeebe::Client::GatewayProtocol::CompleteJobRequest.new(params))
       end
 
       def create_process_instance(params = {})
         run(:create_process_instance,
-          ::Zeebe::Client::GatewayProtocol::CreateProcessInstanceRequest.new(params)
-        )
+            ::Zeebe::Client::GatewayProtocol::CreateProcessInstanceRequest.new(params))
       end
 
       def deploy_process(params = {})
         run(:deploy_process,
-          ::Zeebe::Client::GatewayProtocol::DeployProcessRequest.new(params)
-        )
+            ::Zeebe::Client::GatewayProtocol::DeployProcessRequest.new(params))
       end
 
       def fail_job(params = {})
         run(:fail_job,
-          ::Zeebe::Client::GatewayProtocol::FailJobRequest.new(params)
-        )
+            ::Zeebe::Client::GatewayProtocol::FailJobRequest.new(params))
       end
 
       def throw_error(params = {})
         run(:throw_error,
-          ::Zeebe::Client::GatewayProtocol::ThrowErrorRequest.new(params)
-        )
+            ::Zeebe::Client::GatewayProtocol::ThrowErrorRequest.new(params))
       end
 
       def publish_message(params = {})
         run(:publish_message,
-          ::Zeebe::Client::GatewayProtocol::PublishMessageRequest.new(params)
-        )
+            ::Zeebe::Client::GatewayProtocol::PublishMessageRequest.new(params))
       end
 
       def resolve_incident(params = {})
         run(:resolve_incident,
-          ::Zeebe::Client::GatewayProtocol::ResolveIncidentRequest.new(params)
-        )
+            ::Zeebe::Client::GatewayProtocol::ResolveIncidentRequest.new(params))
       end
 
       def set_variables(params = {})
         run(:set_variables,
-          ::Zeebe::Client::GatewayProtocol::SetVariablesRequest.new(params)
-        )
+            ::Zeebe::Client::GatewayProtocol::SetVariablesRequest.new(params))
       end
 
       def topology(params = {})
         run(:topology,
-          ::Zeebe::Client::GatewayProtocol::TopologyRequest.new(params)
-        )
+            ::Zeebe::Client::GatewayProtocol::TopologyRequest.new(params))
       end
 
       def update_job_retries(params = {})
         run(:update_job_retries,
-          ::Zeebe::Client::GatewayProtocol::UpdateJobRetriesRequest.new(params)
-        )
+            ::Zeebe::Client::GatewayProtocol::UpdateJobRetriesRequest.new(params))
       end
 
       private
 
       def run(method, params = {})
         client.public_send(method, params)
-      rescue ::GRPC::Unavailable => exception
-        logger.error exception.message
-        raise exception
+      rescue ::GRPC::Unavailable => e
+        logger.error e.message
+        raise e
       end
 
       def logger
@@ -97,7 +86,7 @@ module Cloudmunda
 
       def authentication_headers
         token = Cloudmunda::API::AccessToken.create
-        channel_creds = GRPC::Core::ChannelCredentials.new()
+        channel_creds = GRPC::Core::ChannelCredentials.new
         auth_proc = proc { { 'authorization' => "Bearer #{token.access_token}" } }
         call_creds = GRPC::Core::CallCredentials.new(auth_proc)
         channel_creds.compose(call_creds)

data/lib/cloudmunda/zeebe.rb

@@ -1 +1,3 @@
-require_relative 'zeebe/client'
+# frozen_string_literal: true
+
+require_relative 'zeebe/client'

data/lib/cloudmunda.rb

@@ -2,7 +2,7 @@
 
 require 'concurrent'
 
-require_relative "cloudmunda/version"
+require_relative 'cloudmunda/version'
 require_relative 'cloudmunda/loggable'
 require_relative 'cloudmunda/cli/worker'
 require_relative 'cloudmunda/configuration'
@@ -19,7 +19,7 @@ module Cloudmunda
   end
 
   def self.register_worker(worker)
-    self.workers << worker
+    workers << worker
   end
 
   def self.workers