rails-cloud-tasks 0.0.2 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 924a936920255b90f05426a1a02d8fcb7c0b688f05ecf23f47d5574cfd830100
-  data.tar.gz: dac09c6a8c32a41ce9b8849b57892cac630f54b9592faf88400d248ac32d4661
+  metadata.gz: 563b23e52524d8a824730b37b9dfe35daa1fcba85bed52050c8581c677dc0ff7
+  data.tar.gz: e0eb08e7c1d7bfb0271c3154b5e9673e2955e3e30bdbece1e4758faa22544785
 SHA512:
-  metadata.gz: b4bb22ec37af949357f944d2e5dc5f80c955fd65426aadc35f1ac4d7bc53cfdc8d5703813553f824e2024c137087a3d891f16d2a7859eb6a26fef771da7a894f
-  data.tar.gz: 4ca848172ca6473f08348f0b5ff6d9f9ddad8ff2a9b95ab9b2f8e77d933c5d6a1ebd4c29b1eac6afa43ecd3e665913fb9864d22bc8b451a1ee946b1279be6cb4
+  metadata.gz: 2aa519587a1662e8dae394e8a100b043a64aee09fdb4c2d679a8d5731fed4da010600780a65a6aff0cc29ff36f6e7373fda85073cb9a82fdedbca9f0bcf6ca89
+  data.tar.gz: 4b188e8d270ba58d06030924e7119c544feddf7ccb8813b1ccafdb79dd48975f536a5be18ce995782cca5244cfcf75cc873336d093980120792e14f24378489d

data/.github/workflows/main.yaml

@@ -23,7 +23,7 @@ jobs:
         run: gem install bundler
 
       - name: Cache dependencies
-        uses: actions/cache@v1
+        uses: actions/cache@v2
         with:
           path: vendor/bundle
           key: ${{ runner.os }}-gem-${{ hashFiles('**/rails-cloud-tasks.gemspec') }}
@@ -48,7 +48,7 @@ jobs:
         run: gem install bundler
 
       - name: Cache dependencies
-        uses: actions/cache@v1
+        uses: actions/cache@v2
         with:
           path: vendor/bundle
           key: ${{ runner.os }}-gem-${{ hashFiles('**/rails-cloud-tasks.gemspec') }}
@@ -73,7 +73,7 @@ jobs:
         run: gem install bundler
 
       - name: Cache dependencies
-        uses: actions/cache@v1
+        uses: actions/cache@v2
         with:
           path: vendor/bundle
           key: ${{ runner.os }}-gem-${{ hashFiles('**/rails-cloud-tasks.gemspec') }}

data/.github/workflows/release.yml

@@ -12,6 +12,7 @@ jobs:
       pre_release: ${{ steps.versioning.outputs.pre_release }}
       upgraded: ${{ steps.versioning.outputs.upgraded }}
       package_version: ${{ steps.versioning.outputs.package_version }}
+      release_message: ${{ steps.versioning.outputs.release_message }}
     steps:
       - uses: actions/checkout@v2
 
@@ -24,13 +25,15 @@ jobs:
         run: gem install bundler
 
       - name: Cache dependencies
-        uses: actions/cache@v1
+        uses: actions/cache@v2
         with:
           path: vendor/bundle
           key: ${{ runner.os }}-gem-${{ hashFiles('**/rails-cloud-tasks.gemspec') }}-2.7
 
       - name: Install dependencies
-        run: bundle install
+        run: |
+          bundle config set without 'development test'
+          bundle install
 
       - name: Fetching Tags
         run: git fetch -t
@@ -45,6 +48,8 @@ jobs:
           echo "::set-output name=upgraded::"$upgraded
           pre_release=$([[ $package_version =~ ^[0-9]+\.[0-9]+\.[0-9]+$ ]] && echo "false" || echo "true")
           echo "::set-output name=pre_release::"$pre_release
+          release_message=$(git log HEAD ^$(git describe --tags `git rev-list --tags --max-count=1`) --pretty=format:'* %C(green)%h%C(reset) %s')
+          echo "::set-output name=release_message::"$release_message
 
   release:
     runs-on: ubuntu-latest
@@ -62,13 +67,15 @@ jobs:
         run: gem install bundler
 
       - name: Cache dependencies
-        uses: actions/cache@v1
+        uses: actions/cache@v2
         with:
           path: vendor/bundle
           key: ${{ runner.os }}-gem-${{ hashFiles('**/rails-cloud-tasks.gemspec') }}-2.7
 
       - name: Install dependencies
-        run: bundle install
+        run: |
+          bundle config set without 'development test'
+          bundle install
 
       - name: Create Release
         uses: actions/create-release@v1
@@ -78,8 +85,7 @@ jobs:
           tag_name: ${{ needs.checks.outputs.package_version }}
           release_name: Release ${{ needs.checks.outputs.package_version }}
           body: |
-            Auto-released by bot.
-            See commit changes.
+            ${{ needs.checks.outputs.release_message }}
           draft: false
           prerelease: ${{ needs.checks.outputs.pre_release }}
 

data/README.md

@@ -64,6 +64,14 @@ Check out the available configs and its usage description:
 | tasks_path            	| The path to run tasks                                                                                       	| 𐄂                   	|                    	| '/tasks'                 	|
 
 
+- Configure ActiveJob queue_adapter
+
+```ruby
+# ./config/application.rb
+
+config.active_job.queue_adapter = RailsCloudTasks.queue_adapter
+```
+
 - Add a Job class:
 ```ruby
 # ./app/jobs/application_job.rb
@@ -97,23 +105,29 @@ We have support to Google Cloud Schedule. It's based on Cloud tasks, the jobs ar
 Check out the follow sample of config file:
 ```yaml
 # config/scheduler.yml
-- name: Users::SyncJob
+- name: UsersSyncJob
   schedule: 0 8 * * *
   description: Sync user data
   time_zone: "America/Los_Angeles"
+  class_name: Users::SyncJob
   args:
-    arg1: 100
-    arg2: 200
+    - this_first: argument
+      is_a: hash
+    - - this second argument
+      - is an array
+    - this third argument is a string
 ```
 
-| attribute   	| description                                                    	| required 	|
-|-------------	|----------------------------------------------------------------	|----------	|
-| name        	| The Job class namespace                                        	| ✓        	|
-| schedule    	| The frequency to run your job. It should be a unix-cron format 	| ✓        	|
-| description 	| What this job does                                             	| ✓        	|
-| time_zone   	| Choose which one timezone your job must run                    	| ✓        	|
-| args        	| What are the job's arguments                                   	| ✓        	|
+| attribute   	| description                                                    	                                                   | required 	|
+|-------------	|----------------------------------------------------------------------------------                                  |----------	|
+| name        	| Any descriptive name, following [Tasks naming restrictions][1]                                                     | ✓        	|
+| schedule    	| The frequency to run your job. It should be a unix-cron format 	                                                   | ✓        	|
+| description 	| What this job does                                             	                                                   | ✓        	|
+| time_zone   	| Choose which one timezone your job must run                    	                                                   | ✓        	|
+| args        	| Arguments to the job execution. Important: if present, this must be an array of items. Check out the example above | 𐄂          |
+| class_name    | The Job class name (including namespace)                                                                           | ✓        	|
 
+[1]: https://cloud.google.com/tasks/docs/reference/rpc/google.cloud.tasks.v2
 
 
 

data/lib/rails-cloud-tasks.rb

@@ -12,6 +12,7 @@ module RailsCloudTasks
   autoload :AppEngine
   autoload :Configuration
   autoload :Version
+  autoload :Instrumentation
 
   module Rack
     extend ActiveSupport::Autoload
@@ -39,4 +40,21 @@ module RailsCloudTasks
       end
     end
   end
+
+  @queue_adapter = nil
+
+  def queue_adapter
+    @@queue_adapter
+  end
+
+  def self.queue_adapter
+    @queue_adapter ||= Adapter.new
+  rescue StandardError => e
+    raise e unless Rails.env.development?
+
+    logger.warn('unable to setup adapter, falling back to :inline')
+    logger.warn(e)
+
+    :inline
+  end
 end

data/lib/rails_cloud_tasks/instrumentation.rb

@@ -0,0 +1,19 @@
+module RailsCloudTasks
+  module Instrumentation
+    extend ActiveSupport::Autoload
+
+    autoload :Default
+    autoload :Factory
+    autoload :NewRelic
+
+    module_function
+
+    def agent
+      @agent ||= RailsCloudTasks::Instrumentation::Factory.agent_class.new
+    end
+
+    def transaction_name!(*opts)
+      agent.transaction_name!(opts)
+    end
+  end
+end

data/lib/rails_cloud_tasks/instrumentation/default.rb

@@ -0,0 +1,7 @@
+module RailsCloudTasks
+  module Instrumentation
+    class Default
+      def transaction_name!(*opts); end
+    end
+  end
+end

data/lib/rails_cloud_tasks/instrumentation/factory.rb

@@ -0,0 +1,11 @@
+module RailsCloudTasks
+  module Instrumentation
+    class Factory
+      def self.agent_class
+        return NewRelic if defined?(::NewRelic)
+
+        Default
+      end
+    end
+  end
+end

data/lib/rails_cloud_tasks/instrumentation/new_relic.rb

@@ -0,0 +1,13 @@
+module RailsCloudTasks
+  module Instrumentation
+    class NewRelic
+      def transaction_name!(opts)
+        agent.set_transaction_name(*opts)
+      end
+
+      def agent
+        @agent ||= ::NewRelic::Agent
+      end
+    end
+  end
+end

data/lib/rails_cloud_tasks/rack/jobs.rb

@@ -8,9 +8,14 @@ module RailsCloudTasks
         def call(env)
           job_class = extract_job_class(env)
 
+          RailsCloudTasks::Instrumentation.transaction_name!(
+            "RailsCloudTasks/#{job_class}/perform_now"
+          )
+
           request = ::Rack::Request.new(env)
           job_args = extract_args(request)
-          job_class.perform_now(job_args)
+
+          job_class.perform_now(*job_args)
 
           response(200, {})
         rescue Rack::InvalidPayloadError => e
@@ -28,7 +33,7 @@ module RailsCloudTasks
 
         def extract_args(request)
           body = request.body.read
-          JSON.parse(body)
+          JSON.parse(body) || []
         rescue JSON::ParserError, KeyError
           raise Rack::InvalidPayloadError
         end

data/lib/rails_cloud_tasks/rack/tasks.rb

@@ -9,8 +9,11 @@ module RailsCloudTasks
           request = ::Rack::Request.new(env)
           job = extract_job(request)
 
-          ActiveJob::Base.execute(job)
+          RailsCloudTasks::Instrumentation.transaction_name!(
+            "RailsCloudTasks/#{job['job_class']}/perform_now"
+          )
 
+          ActiveJob::Base.execute(job)
           response(200, {})
         rescue Rack::InvalidPayloadError => e
           response(400, { error: e.cause.message })

data/lib/rails_cloud_tasks/scheduler.rb

@@ -4,28 +4,28 @@ module RailsCloudTasks
              :scheduler_file_path, :scheduler_prefix_name,
              :service_account_email, to: 'RailsCloudTasks.config'
 
-    attr_reader :client, :credentials
+    attr_reader :client, :credentials, :logger
 
     def initialize(
       client: Google::Cloud::Scheduler.cloud_scheduler,
-      credentials: RailsCloudTasks::Credentials.new
+      credentials: RailsCloudTasks::Credentials.new,
+      logger: RailsCloudTasks.logger
     )
       client.configure do |config|
         config.credentials = credentials.generate(service_account_email)
       end
       @client = client
+      @logger = logger
     end
 
     # Create & Update scheduler job on Google Cloud
     # TODO: Support to delete scheduled jobs
     def upsert
+      result = { success: [], failure: [] }
       scheduler_jobs.each do |job|
-        begin
-          client.create_job parent: location_path, job: job
-        rescue Google::Cloud::AlreadyExistsError
-          client.update_job job: job
-        end
+        upsert_job(job) ? (result[:success] << job[:name]) : (result[:failure] << job[:name])
       end
+      log_output(result)
     end
 
     protected
@@ -45,7 +45,7 @@ module RailsCloudTasks
         description: job[:description],
         time_zone:   job[:time_zone],
         http_target: {
-          uri:         "#{host}#{tasks_path}/#{job[:name]}",
+          uri:         "#{host}#{tasks_path}/#{job[:class_name]}",
           http_method: 'POST',
           body:        job[:args].to_json
         }.merge(auth)
@@ -58,5 +58,38 @@ module RailsCloudTasks
     rescue Errno::ENOENT
       []
     end
+
+    def log_output(result)
+      parse_task_name = ->(task) { task.split("#{scheduler_prefix_name}--")[1] }
+      success = result[:success].map(&parse_task_name)
+      failure = result[:failure].map(&parse_task_name)
+
+      if success.count.positive?
+        log("Successfuly scheduled #{success.count} tasks", '- [✓] ',
+            success)
+      end
+
+      log("Failed to schedule #{failure.count} tasks", '- [𐄂] ', failure) if failure.count.positive?
+    end
+
+    def log(desc, prefix, tasks)
+      logger.info(desc)
+      logger.info(prefix + tasks.join("\n #{prefix}"))
+    end
+
+    private
+
+    def upsert_job(job)
+      success = true
+      begin
+        client.create_job parent: location_path, job: job
+      rescue Google::Cloud::AlreadyExistsError
+        client.update_job job: job
+      rescue StandardError => e
+        logger.error(e)
+        success = false
+      end
+      success
+    end
   end
 end

data/lib/rails_cloud_tasks/version.rb

@@ -1,3 +1,3 @@
 module RailsCloudTasks
-  VERSION = '0.0.2'.freeze
+  VERSION = '0.0.5'.freeze
 end

data/rails-cloud-tasks.gemspec

@@ -27,7 +27,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'google-apis-iamcredentials_v1'
   spec.add_dependency 'google-cloud-scheduler', '>= 2'
   spec.add_dependency 'google-cloud-tasks', '>= 2'
-  spec.add_development_dependency 'rails', '>= 4'
+  spec.add_dependency 'rails', '>= 4'
 
   spec.add_development_dependency 'bundler'
   spec.add_development_dependency 'pry'

data/renovate.json

@@ -0,0 +1,5 @@
+{
+  "extends": [
+    "config:base"
+  ]
+}

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rails-cloud-tasks
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.5
 platform: ruby
 authors:
 - Guilherme Araújo
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-02-11 00:00:00.000000000 Z
+date: 2021-03-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -87,7 +87,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '4'
-  type: :development
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
@@ -284,6 +284,10 @@ files:
 - lib/rails_cloud_tasks/app_engine.rb
 - lib/rails_cloud_tasks/configuration.rb
 - lib/rails_cloud_tasks/credentials.rb
+- lib/rails_cloud_tasks/instrumentation.rb
+- lib/rails_cloud_tasks/instrumentation/default.rb
+- lib/rails_cloud_tasks/instrumentation/factory.rb
+- lib/rails_cloud_tasks/instrumentation/new_relic.rb
 - lib/rails_cloud_tasks/rack/errors.rb
 - lib/rails_cloud_tasks/rack/jobs.rb
 - lib/rails_cloud_tasks/rack/tasks.rb
@@ -292,6 +296,7 @@ files:
 - lib/railtie.rb
 - lib/tasks/scheduler.rake
 - rails-cloud-tasks.gemspec
+- renovate.json
 homepage: http://github.com/flamingo-run/rails-cloud-tasks
 licenses:
 - Apache License 2.0