Class: Rolemodel::SentryGenerator

Inherits:
GeneratorBase
  • Object
show all
Defined in:
lib/generators/rolemodel/sentry/sentry_generator.rb

Constant Summary collapse

JS_DEPS = 
%w[
  @sentry/browser
  @sentry/webpack-plugin
]

Instance Method Summary collapse

Instance Method Details

#add_js_dependencies ⇒ Object 



43
44
45
46
47
48
 
# File 'lib/generators/rolemodel/sentry/sentry_generator.rb', line 43

def add_js_dependencies
  say 'Adding Sentry JS dependencies to package.json', :green

  ensure_yarn
  run "yarn add --dev #{JS_DEPS.join(' ')}"
end

#add_js_initializer ⇒ Object 



50
51
52
53
54
55
56
57
 
# File 'lib/generators/rolemodel/sentry/sentry_generator.rb', line 50

def add_js_initializer
  say 'Setting up Sentry for JS error reporting', :green

  copy_file 'app/javascript/initializers/sentry.js'
  append_to_file 'app/javascript/application.js', <<~JS
    import './initializers/sentry'
  JS
end

#add_ruby_initializer ⇒ Object 



28
29
30
31
32
 
# File 'lib/generators/rolemodel/sentry/sentry_generator.rb', line 28

def add_ruby_initializer
  say 'Setting up Sentry for Ruby error reporting', :green

  copy_file 'config/initializers/sentry.rb'
end

#add_user_context ⇒ Object 



34
35
36
37
38
39
40
41
 
# File 'lib/generators/rolemodel/sentry/sentry_generator.rb', line 34

def add_user_context
  say 'Adding Sentry user context to ApplicationController', :green

  directory 'app/controllers/concerns'

  inject_into_class 'app/controllers/application_controller.rb', 'ApplicationController',
                    "  include SentryUser\n"
end

#configure_webpack ⇒ Object

Wire the Sentry webpack plugin into webpack.config.js. Idempotent and a no-op if there's no webpack.config.js or it's already wired, so the webpack generator can safely invoke this generator via its --sentry option.



62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
 
# File 'lib/generators/rolemodel/sentry/sentry_generator.rb', line 62

def configure_webpack
  config = File.expand_path('webpack.config.js', destination_root)
  return unless File.exist?(config)
  return if File.read(config).include?('@sentry/webpack-plugin')

  say 'Wiring Sentry into webpack.config.js', :green

  inject_into_file 'webpack.config.js',
                   "import { sentryWebpackPlugin } from '@sentry/webpack-plugin'\n",
                   after: "import CssMinimizerPlugin from 'css-minimizer-webpack-plugin'\n"

  inject_into_file 'webpack.config.js', after: "'process.env.RAILS_ENV': JSON.stringify(process.env.RAILS_ENV),\n" do
    <<-JS
  'process.env.SENTRY_DSN': JSON.stringify(process.env.SENTRY_DSN),
  'process.env.SENTRY_ENVIRONMENT': JSON.stringify(process.env.SENTRY_ENVIRONMENT),
  'process.env.SENTRY_AUTH_TOKEN': JSON.stringify(process.env.SENTRY_AUTH_TOKEN),
    JS
  end

  gsub_file 'webpack.config.js', "    })\n  ].filter(Boolean)", <<-JS.chomp
}),

// Upload source maps to Sentry in production for easier debugging
mode === 'production' &&
  !process.env.CI &&
  sentryWebpackPlugin({
    authToken: process.env.SENTRY_AUTH_TOKEN,
    org: 'rolemodel-software',
    project: '#{sentry_app_name}',
    telemetry: false,
    applicationKey: 'app-frontend'
  })
  ].filter(Boolean)
  JS
end

#finishing_notes ⇒ Object 



98
99
100
101
102
103
104
105
106
 
# File 'lib/generators/rolemodel/sentry/sentry_generator.rb', line 98

def finishing_notes
  say <<~NOTES

    *** Update the sentryWebpackPlugin `project` and `applicationKey` in webpack.config.js,
        and the matching `filterKeys` in app/javascript/initializers/sentry.js, to your Sentry project.

    *** Set the SENTRY_DSN, SENTRY_ENVIRONMENT, and SENTRY_AUTH_TOKEN environment variables.
  NOTES
end

#install_gem ⇒ Object 



12
13
14
15
16
 
# File 'lib/generators/rolemodel/sentry/sentry_generator.rb', line 12

def install_gem
  say 'Adding sentry-rails gem', :green

  bundle_command 'add sentry-rails'
end

#install_profiler_gem ⇒ Object 



18
19
20
21
22
23
24
25
26
 
# File 'lib/generators/rolemodel/sentry/sentry_generator.rb', line 18

def install_profiler_gem
  say 'Adding stackprof gem for Sentry profiling', :green

  # config/initializers/sentry.rb sets profiles_sample_rate; without stackprof
  # the SDK logs a warning on every boot and profiling is silently disabled.
  # stackprof is a native MRI extension, so restrict it to compatible platforms.
  bundle_command 'add stackprof --platform ruby'
  run_bundle
end