sentry-delayed_job 4.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: db868f6352945d274c05edc038c741fad9d416735bd68df6550af2f56f58ffb4
+  data.tar.gz: 7e64583c842ddb8e54d37866af6098377182f10c30120f51981c0f7944a5f2d3
+SHA512:
+  metadata.gz: 215f4e41121897b18f5b0b15eea29c50c583ce10e2d07536cca40d878b9de912df700256f1d54949cb4687e859a6b6121b116c27538314706fbf369cdffd5f67
+  data.tar.gz: 6a5aeaed988bcd76e6da51cc16affdec0677f456a020bcf9b8630acb0d22dff8a63627c60e0e6e66a7a4d36f7dcb73f504927385500fe07e00eb6780d8c8929a

data/.craft.yml

@@ -0,0 +1,19 @@
+minVersion: '0.13.2'
+github:
+    owner: getsentry
+    repo: sentry-ruby
+changelogPolicy: simple
+preReleaseCommand: ruby ../.scripts/bump-version.rb
+releaseBranchPrefix: release-sentry-delayed_job
+statusProvider:
+  name: github
+artifactProvider:
+  name: github
+targets:
+    - name: gem
+    - name: github
+      tagPrefix: sentry-delayed_job-v
+    - name: registry
+      type: sdk
+      config:
+          canonical: 'gem:sentry-delayed_job'

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+# Changelog
+
+## 4.2.0
+
+- First release!

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at stan001212@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [https://contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,23 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in sentry-ruby.gemspec
+gemspec
+
+# TODO: Remove this if https://github.com/jruby/jruby/issues/6547 is addressed
+gem "i18n", "<= 1.8.7"
+
+gem "rake", "~> 12.0"
+gem "rspec", "~> 3.0"
+gem "codecov", "0.2.12"
+
+gem "delayed_job"
+gem "delayed_job_active_record"
+gem "rails"
+gem "activerecord-jdbcmysql-adapter", platform: :jruby
+gem "jdbc-sqlite3", platform: :jruby
+gem "sqlite3", platform: :ruby
+
+gem "sentry-ruby", path: "../sentry-ruby"
+gem "sentry-rails", path: "../sentry-rails"
+
+gem "pry"

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 st0012
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/Makefile

@@ -0,0 +1,3 @@
+build:
+	bundle install
+	gem build sentry-delayed_job.gemspec

data/README.md

@@ -0,0 +1,34 @@
+<p align="center">
+  <a href="https://sentry.io" target="_blank" align="center">
+    <img src="https://sentry-brand.storage.googleapis.com/sentry-logo-black.png" width="280">
+  </a>
+  <br>
+</p>
+
+# sentry-delayed_job, the DelayedJob integration for Sentry's Ruby client
+
+---
+
+
+[![Gem Version](https://img.shields.io/gem/v/sentry-delayed_job.svg)](https://rubygems.org/gems/sentry-delayed_job)
+![Build Status](https://github.com/getsentry/sentry-ruby/workflows/sentry-delayed_job%20Test/badge.svg)
+[![Coverage Status](https://img.shields.io/codecov/c/github/getsentry/sentry-ruby/master?logo=codecov)](https://codecov.io/gh/getsentry/sentry-ruby/branch/master)
+[![Gem](https://img.shields.io/gem/dt/sentry-delayed_job.svg)](https://rubygems.org/gems/sentry-delayed_job/)
+[![SemVer](https://api.dependabot.com/badges/compatibility_score?dependency-name=sentry-delayed_job&package-manager=bundler&version-scheme=semver)](https://dependabot.com/compatibility-score.html?dependency-name=sentry-delayed_job&package-manager=bundler&version-scheme=semver)
+
+
+[Documentation](https://docs.sentry.io/platforms/ruby/guides/delayed_job/) | [Bug Tracker](https://github.com/getsentry/sentry-ruby/issues) | [Forum](https://forum.sentry.io/) | IRC: irc.freenode.net, #sentry
+
+The official Ruby-language client and integration layer for the [Sentry](https://github.com/getsentry/sentry) error reporting API.
+
+
+## Getting Started
+
+### Install
+
+```ruby
+gem "sentry-ruby"
+gem "sentry-delayed_job"
+```
+
+Then you're all set! `sentry-delayed_job` will automatically insert a custom middleware and error handler to capture exceptions from your workers!

data/Rakefile

@@ -0,0 +1,8 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec).tap do |task|
+  task.rspec_opts = "--order rand"
+end
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "sentry/ruby"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/example/Gemfile

@@ -0,0 +1,10 @@
+source "https://rubygems.org"
+
+gem "rails"
+gem "sqlite3"
+gem "delayed_job"
+gem 'delayed_job_active_record'
+gem "sentry-delayed_job", path: "../"
+gem "sentry-ruby", path: "../../sentry-ruby"
+
+gem "pry"

data/example/app.rb

@@ -0,0 +1,68 @@
+require "pry"
+require "active_job"
+require "active_record"
+require "delayed_job"
+require "delayed_job_active_record"
+require "sentry-delayed_job"
+# require "logger"
+
+# This connection will do for database-independent bug reports.
+ActiveRecord::Base.establish_connection(adapter: "sqlite3", database: ":memory:")
+# ActiveRecord::Base.logger = Logger.new(STDOUT)
+
+ActiveRecord::Schema.define do
+  create_table :delayed_jobs do |table|
+    table.integer :priority, default: 0, null: false # Allows some jobs to jump to the front of the queue
+    table.integer :attempts, default: 0, null: false # Provides for retries, but still fail eventually.
+    table.text :handler,                 null: false # YAML-encoded string of the object that will do work
+    table.text :last_error                           # reason for last failure (See Note below)
+    table.datetime :run_at                           # When to run. Could be Time.zone.now for immediately, or sometime in the future.
+    table.datetime :locked_at                        # Set when a client is working on this object
+    table.datetime :failed_at                        # Set when all retries have failed (actually, by default, the record is deleted instead)
+    table.string :locked_by                          # Who is working on this object (if locked)
+    table.string :queue                              # The name of the queue this job is in
+    table.timestamps null: true
+  end
+end
+
+Sentry.init do |config|
+  config.breadcrumbs_logger = [:sentry_logger]
+  # replace it with your sentry dsn
+  config.dsn = 'https://2fb45f003d054a7ea47feb45898f7649@o447951.ingest.sentry.io/5434472'
+end
+
+class MyJob < ActiveJob::Base
+  self.queue_adapter = :delayed_job
+
+  def perform
+    raise "foo"
+  end
+end
+
+MyJob.perform_later
+
+enqueued_job = Delayed::Backend::ActiveRecord::Job.last
+
+begin
+  enqueued_job.invoke_job
+rescue => e
+  puts("active job failed because of \"#{e.message}\"")
+end
+
+class Foo
+  def bar
+    1 / 0
+  end
+end
+
+Foo.new.delay.bar
+
+enqueued_job = Delayed::Backend::ActiveRecord::Job.last
+
+begin
+  enqueued_job.invoke_job
+rescue => e
+  puts("inline job failed because of \"#{e.message}\"")
+end
+
+

data/lib/sentry-delayed_job.rb

@@ -0,0 +1,23 @@
+require "delayed_job"
+require "sentry-ruby"
+require "sentry/integrable"
+require "sentry/delayed_job/version"
+require "sentry/delayed_job/plugin"
+
+module Sentry
+  module DelayedJob
+    extend Sentry::Integrable
+
+    register_integration name: "delayed_job", version: Sentry::DelayedJob::VERSION
+
+    if defined?(::Rails)
+      class Railtie < ::Rails::Railtie
+        config.after_initialize do
+          next unless Sentry.initialized?
+
+          Sentry.configuration.rails.skippable_job_adapters << "ActiveJob::QueueAdapters::DelayedJobAdapter"
+        end
+      end
+    end
+  end
+end

data/lib/sentry/delayed_job/plugin.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+require "delayed_job"
+
+module Sentry
+  module DelayedJob
+    class Plugin < ::Delayed::Plugin
+      callbacks do |lifecycle|
+        lifecycle.around(:invoke_job) do |job, *args, &block|
+          Sentry.with_scope do |scope|
+            scope.set_extras(**generate_extra(job))
+            scope.set_tags("delayed_job.queue" => job.queue, "delayed_job.id" => job.id)
+
+            begin
+              block.call(job, *args)
+            rescue Exception => e
+              Sentry::DelayedJob.capture_exception(e, hint: { background: false })
+
+              raise
+            end
+          end
+        end
+      end
+
+      def self.generate_extra(job)
+        extra = {
+          "delayed_job.id": job.id,
+          "delayed_job.priority": job.priority,
+          "delayed_job.attempts": job.attempts,
+          "delayed_job.run_at": job.run_at,
+          "delayed_job.locked_at": job.locked_at,
+          "delayed_job.locked_by": job.locked_by,
+          "delayed_job.queue": job.queue,
+          "delayed_job.created_at": job.created_at,
+          "delayed_job.last_error": job.last_error&.byteslice(0..1000),
+          "delayed_job.handler": job.handler&.byteslice(0..1000)
+        }
+
+        if job.payload_object.respond_to?(:job_data)
+          job.payload_object.job_data.each do |key, value|
+            extra[:"active_job.#{key}"] = value
+          end
+        end
+
+        extra
+      end
+    end
+  end
+end
+
+Delayed::Worker.plugins << Sentry::DelayedJob::Plugin

data/lib/sentry/delayed_job/version.rb

@@ -0,0 +1,5 @@
+module Sentry
+  module DelayedJob
+    VERSION = "4.2.0"
+  end
+end

data/sentry-delayed_job.gemspec

@@ -0,0 +1,26 @@
+require_relative "lib/sentry/delayed_job/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "sentry-delayed_job"
+  spec.version       = Sentry::DelayedJob::VERSION
+  spec.authors = ["Sentry Team"]
+  spec.description = spec.summary = "A gem that provides DelayedJob integration for the Sentry error logger"
+  spec.email = "accounts@sentry.io"
+  spec.license = 'Apache-2.0'
+  spec.homepage = "https://github.com/getsentry/sentry-ruby"
+
+  spec.platform = Gem::Platform::RUBY
+  spec.required_ruby_version = '>= 2.4'
+  spec.extra_rdoc_files = ["README.md", "LICENSE.txt"]
+  spec.files = `git ls-files | grep -Ev '^(spec|benchmarks|examples)'`.split("\n")
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+  spec.metadata["changelog_uri"] = "#{spec.homepage}/blob/master/sentry-delayed_job/CHANGELOG.md"
+
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "sentry-ruby-core", "~> 4.2.0"
+end

metadata

@@ -0,0 +1,79 @@
+--- !ruby/object:Gem::Specification
+name: sentry-delayed_job
+version: !ruby/object:Gem::Version
+  version: 4.2.0
+platform: ruby
+authors:
+- Sentry Team
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2021-02-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: sentry-ruby-core
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.2.0
+description: A gem that provides DelayedJob integration for the Sentry error logger
+email: accounts@sentry.io
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.md
+- LICENSE.txt
+files:
+- ".craft.yml"
+- ".gitignore"
+- ".rspec"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- Makefile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- example/Gemfile
+- example/app.rb
+- lib/sentry-delayed_job.rb
+- lib/sentry/delayed_job/plugin.rb
+- lib/sentry/delayed_job/version.rb
+- sentry-delayed_job.gemspec
+homepage: https://github.com/getsentry/sentry-ruby
+licenses:
+- Apache-2.0
+metadata:
+  homepage_uri: https://github.com/getsentry/sentry-ruby
+  source_code_uri: https://github.com/getsentry/sentry-ruby
+  changelog_uri: https://github.com/getsentry/sentry-ruby/blob/master/sentry-delayed_job/CHANGELOG.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.4'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: A gem that provides DelayedJob integration for the Sentry error logger
+test_files: []