Class: Service

Inherits:
ApplicationRecord show all
Includes:
DataFields, EachBatch, FromUnion, Importable, ProjectServicesLoggable, Sortable
Defined in:
app/models/service.rb

Overview

To add new service you should build a class inherited from Service and implement a set of methods

Constant Summary collapse

SERVICE_NAMES =
%w[
  alerts asana assembla bamboo bugzilla buildkite campfire confluence custom_issue_tracker datadog discord
  drone_ci emails_on_push ewm external_wiki flowdock hangouts_chat hipchat irker jira
  mattermost mattermost_slash_commands microsoft_teams packagist pipelines_email
  pivotaltracker prometheus pushover redmine slack slack_slash_commands teamcity unify_circuit webex_teams youtrack
].freeze
PROJECT_SPECIFIC_SERVICE_NAMES =
%w[
  jenkins
].freeze
DEV_SERVICE_NAMES =

Fake services to help with local development.

%w[
  mock_ci mock_deployment mock_monitoring
].freeze

Instance Attribute Summary

Attributes included from Importable

#imported, #importing

Class Method Summary collapse

Instance Method Summary collapse

Methods included from ProjectServicesLoggable

#build_message, #log_error, #log_info, #logger

Methods inherited from ApplicationRecord

at_most, id_in, id_not_in, iid_in, pluck_primary_key, primary_key_in, safe_ensure_unique, safe_find_or_create_by, safe_find_or_create_by!, underscore, where_exists, with_fast_statement_timeout, without_order

Class Method Details

.available_services_names(include_project_specific: true, include_dev: true) ⇒ Object


204
205
206
207
208
209
210
# File 'app/models/service.rb', line 204

def self.available_services_names(include_project_specific: true, include_dev: true)
  service_names = services_names
  service_names += project_specific_services_names if include_project_specific
  service_names += dev_services_names if include_dev

  service_names.sort_by(&:downcase)
end

.available_services_types(include_project_specific: true, include_dev: true) ⇒ Object


226
227
228
229
230
# File 'app/models/service.rb', line 226

def self.available_services_types(include_project_specific: true, include_dev: true)
  available_services_names(include_project_specific: include_project_specific, include_dev: include_dev).map do |service_name|
    "#{service_name}_service".camelize
  end
end

.boolean_accessor(*args) ⇒ Object

Provide convenient boolean accessor methods for each serialized property. Also keep track of updated properties in a similar way as ActiveModel::Dirty


125
126
127
128
129
130
131
132
133
134
135
136
# File 'app/models/service.rb', line 125

def self.boolean_accessor(*args)
  self.prop_accessor(*args)

  args.each do |arg|
    class_eval <<~RUBY, __FILE__, __LINE__ + 1
      def #{arg}?
        # '!!' is used because nil or empty string is converted to nil
        !!ActiveRecord::Type::Boolean.new.cast(#{arg})
      end
    RUBY
  end
end

.build_from_integration(integration, project_id: nil, group_id: nil) ⇒ Object


232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
# File 'app/models/service.rb', line 232

def self.build_from_integration(integration, project_id: nil, group_id: nil)
  service = integration.dup

  if integration.supports_data_fields?
    data_fields = integration.data_fields.dup
    data_fields.service = service
  end

  service.template = false
  service.instance = false
  service.project_id = project_id
  service.group_id = group_id
  service.inherit_from_id = integration.id if integration.instance? || integration.group
  service.active = false if service.invalid?
  service
end

.create_from_active_default_integrations(scope, association, with_templates: false) ⇒ Object


272
273
274
275
276
277
278
279
280
281
282
283
# File 'app/models/service.rb', line 272

def self.create_from_active_default_integrations(scope, association, with_templates: false)
  group_ids = scope.ancestors.select(:id)
  array = group_ids.to_sql.present? ? "array(#{group_ids.to_sql})" : 'ARRAY[]'

  from_union([
    with_templates ? active.where(template: true) : none,
    active.where(instance: true),
    active.where(group_id: group_ids, inherit_from_id: nil)
  ]).order(Arel.sql("type ASC, array_position(#{array}::bigint[], services.group_id), instance DESC")).group_by(&:type).each do |type, records|
    build_from_integration(records.first, association => scope.id).save!
  end
end

.default_integration(type, scope) ⇒ Object


253
254
255
# File 'app/models/service.rb', line 253

def self.default_integration(type, scope)
  closest_group_integration(type, scope) || instance_level_integration(type)
end

.default_test_eventObject


154
155
156
# File 'app/models/service.rb', line 154

def self.default_test_event
  'push'
end

.dev_services_namesObject


216
217
218
219
220
# File 'app/models/service.rb', line 216

def self.dev_services_names
  return [] unless Rails.env.development?

  DEV_SERVICE_NAMES
end

.event_description(event) ⇒ Object


158
159
160
# File 'app/models/service.rb', line 158

def self.event_description(event)
  ServicesHelper.service_event_description(event)
end

.event_namesObject


142
143
144
# File 'app/models/service.rb', line 142

def self.event_names
  self.supported_events.map { |event| ServicesHelper.service_event_field_name(event) }
end

.find_or_create_templatesObject


162
163
164
165
# File 'app/models/service.rb', line 162

def self.find_or_create_templates
  create_nonexistent_templates
  for_template
end

.find_or_initialize_all_non_project_specific(scope) ⇒ Object


186
187
188
# File 'app/models/service.rb', line 186

def self.find_or_initialize_all_non_project_specific(scope)
  scope + build_nonexistent_services_for(scope)
end

.find_or_initialize_non_project_specific_integration(name, instance: false, group_id: nil) ⇒ Object


180
181
182
183
184
# File 'app/models/service.rb', line 180

def self.find_or_initialize_non_project_specific_integration(name, instance: false, group_id: nil)
  if name.in?(available_services_names(include_project_specific: false))
    "#{name}_service".camelize.constantize.find_or_initialize_by(instance: instance, group_id: group_id)
  end
end

.inherited_descendants_from_self_or_ancestors_from(integration) ⇒ Object


285
286
287
288
289
290
291
292
293
294
# File 'app/models/service.rb', line 285

def self.inherited_descendants_from_self_or_ancestors_from(integration)
  inherit_from_ids =
    where(type: integration.type, group: integration.group.self_and_ancestors)
      .or(where(type: integration.type, instance: true)).select(:id)

  from_union([
    where(type: integration.type, inherit_from_id: inherit_from_ids, group: integration.group.descendants),
    where(type: integration.type, inherit_from_id: inherit_from_ids, project: Project.in_namespace(integration.group.self_and_descendants))
  ])
end

.instance_exists_for?(type) ⇒ Boolean

Returns:

  • (Boolean)

249
250
251
# File 'app/models/service.rb', line 249

def self.instance_exists_for?(type)
  exists?(instance: true, type: type)
end

.project_specific_services_namesObject


222
223
224
# File 'app/models/service.rb', line 222

def self.project_specific_services_names
  PROJECT_SPECIFIC_SERVICE_NAMES
end

.prop_accessor(*args) ⇒ Object

Provide convenient accessor methods for each serialized property. Also keep track of updated properties in a similar way as ActiveModel::Dirty


93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
# File 'app/models/service.rb', line 93

def self.prop_accessor(*args)
  args.each do |arg|
    class_eval <<~RUBY, __FILE__, __LINE__ + 1
      unless method_defined?(arg)
        def #{arg}
          properties['#{arg}']
        end
      end

      def #{arg}=(value)
        self.properties ||= {}
        updated_properties['#{arg}'] = #{arg} unless #{arg}_changed?
        self.properties['#{arg}'] = value
      end

      def #{arg}_changed?
        #{arg}_touched? && #{arg} != #{arg}_was
      end

      def #{arg}_touched?
        updated_properties.include?('#{arg}')
      end

      def #{arg}_was
        updated_properties['#{arg}']
      end
    RUBY
  end
end

.services_namesObject


212
213
214
# File 'app/models/service.rb', line 212

def self.services_names
  SERVICE_NAMES
end

.supported_event_actionsObject


146
147
148
# File 'app/models/service.rb', line 146

def self.supported_event_actions
  %w[]
end

.supported_eventsObject


150
151
152
# File 'app/models/service.rb', line 150

def self.supported_events
  %w[commit push tag_push issue confidential_issue merge_request wiki_page]
end

.to_paramObject

Raises:

  • (NotImplementedError)

138
139
140
# File 'app/models/service.rb', line 138

def self.to_param
  raise NotImplementedError
end

Instance Method Details

#activated?Boolean

Returns:

  • (Boolean)

296
297
298
# File 'app/models/service.rb', line 296

def activated?
  active
end

#api_field_namesObject


369
370
371
372
# File 'app/models/service.rb', line 369

def api_field_names
  fields.map { |field| field[:name] }
    .reject { |field_name| field_name =~ /(password|token|key|title|description)/ }
end

#async_execute(data) ⇒ Object


431
432
433
434
435
# File 'app/models/service.rb', line 431

def async_execute(data)
  return unless supported_events.include?(data[:object_kind])

  ProjectServiceWorker.perform_async(id, data)
end

#can_test?Boolean

Disable test for instance-level and group-level services. gitlab.com/gitlab-org/gitlab/-/issues/213138

Returns:

  • (Boolean)

413
414
415
# File 'app/models/service.rb', line 413

def can_test?
  !instance? && !group_id
end

#categoryObject


312
313
314
# File 'app/models/service.rb', line 312

def category
  read_attribute(:category).to_sym
end

#configurable_event_actionsObject


389
390
391
# File 'app/models/service.rb', line 389

def configurable_event_actions
  self.class.supported_event_actions
end

#configurable_eventsObject


378
379
380
381
382
383
384
385
386
387
# File 'app/models/service.rb', line 378

def configurable_events
  events = supported_events

  # No need to disable individual triggers when there is only one
  if events.count == 1
    []
  else
    events
  end
end

#default_test_eventObject


397
398
399
# File 'app/models/service.rb', line 397

def default_test_event
  self.class.default_test_event
end

#descriptionObject


324
325
326
# File 'app/models/service.rb', line 324

def description
  # implement inside child
end

#editable?Boolean

Returns:

  • (Boolean)

308
309
310
# File 'app/models/service.rb', line 308

def editable?
  true
end

#event_channel_namesObject


357
358
359
# File 'app/models/service.rb', line 357

def event_channel_names
  []
end

#event_field(event) ⇒ Object


365
366
367
# File 'app/models/service.rb', line 365

def event_field(event)
  nil
end

#event_namesObject


361
362
363
# File 'app/models/service.rb', line 361

def event_names
  self.class.event_names
end

#execute(data) ⇒ Object


401
402
403
# File 'app/models/service.rb', line 401

def execute(data)
  # implement inside child
end

#external_issue_tracker?Boolean

Returns:

  • (Boolean)

437
438
439
# File 'app/models/service.rb', line 437

def external_issue_tracker?
  category == :issue_tracker && active?
end

#external_wiki?Boolean

Returns:

  • (Boolean)

441
442
443
# File 'app/models/service.rb', line 441

def external_wiki?
  type == 'ExternalWikiService' && active?
end

#fieldsObject


337
338
339
340
# File 'app/models/service.rb', line 337

def fields
  # implement inside child
  []
end

#global_fieldsObject


374
375
376
# File 'app/models/service.rb', line 374

def global_fields
  fields
end

#helpObject


328
329
330
# File 'app/models/service.rb', line 328

def help
  # implement inside child
end

#initialize_propertiesObject


316
317
318
# File 'app/models/service.rb', line 316

def initialize_properties
  self.properties = {} if has_attribute?(:properties) && properties.nil?
end

#json_fieldsObject

Expose a list of fields in the JSON endpoint.

This list is used in `Service#as_json(only: json_fields)`.


345
346
347
# File 'app/models/service.rb', line 345

def json_fields
  %w[active]
end

#operating?Boolean

Returns:

  • (Boolean)

300
301
302
# File 'app/models/service.rb', line 300

def operating?
  active && persisted?
end

#reset_updated_propertiesObject


427
428
429
# File 'app/models/service.rb', line 427

def reset_updated_properties
  @updated_properties = nil
end

#show_active_box?Boolean

Returns:

  • (Boolean)

304
305
306
# File 'app/models/service.rb', line 304

def show_active_box?
  true
end

#supported_eventsObject


393
394
395
# File 'app/models/service.rb', line 393

def supported_events
  self.class.supported_events
end

#supports_data_fields?Boolean

override if needed

Returns:

  • (Boolean)

446
447
448
# File 'app/models/service.rb', line 446

def supports_data_fields?
  false
end

#test(data) ⇒ Object


405
406
407
408
409
# File 'app/models/service.rb', line 405

def test(data)
  # default implementation
  result = execute(data)
  { success: result.present?, result: result }
end

#titleObject


320
321
322
# File 'app/models/service.rb', line 320

def title
  # implement inside child
end

#to_data_fields_hashObject


353
354
355
# File 'app/models/service.rb', line 353

def to_data_fields_hash
  data_fields.as_json(only: data_fields.class.column_names).except('id', 'service_id')
end

#to_paramObject


332
333
334
335
# File 'app/models/service.rb', line 332

def to_param
  # implement inside child
  self.class.to_param
end

#to_service_hashObject


349
350
351
# File 'app/models/service.rb', line 349

def to_service_hash
  as_json(methods: :type, except: %w[id template instance project_id group_id])
end

#updated_propertiesObject

Returns a hash of the properties that have been assigned a new value since last save, indicating their original values (attr => original value). ActiveRecord does not provide a mechanism to track changes in serialized keys, so we need a specific implementation for service properties. This allows to track changes to properties set with the accessor methods, but not direct manipulation of properties hash.


423
424
425
# File 'app/models/service.rb', line 423

def updated_properties
  @updated_properties ||= ActiveSupport::HashWithIndifferentAccess.new
end