summaryrefslogtreecommitdiff
path: root/lib/gitlab/background_migration/migrate_events_to_push_event_payloads.rb
blob: 7088aa0860ac7c3b0bc7d7dfac34a15afe391b2b (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
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
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
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
# frozen_string_literal: true
# rubocop:disable Metrics/LineLength
# rubocop:disable Style/Documentation

module Gitlab
  module BackgroundMigration
    # Class that migrates events for the new push event payloads setup. All
    # events are copied to a shadow table, and push events will also have a row
    # created in the push_event_payloads table.
    class MigrateEventsToPushEventPayloads
      class Event < ActiveRecord::Base
        self.table_name = 'events'

        serialize :data

        BLANK_REF = ('0' * 40).freeze
        TAG_REF_PREFIX = 'refs/tags/'.freeze
        MAX_INDEX = 69
        PUSHED = 5

        def push_event?
          action == PUSHED && data.present?
        end

        def commit_title
          commit = commits.last

          return nil unless commit && commit[:message]

          index = commit[:message].index("\n")
          message = index ? commit[:message][0..index] : commit[:message]

          message.strip.truncate(70)
        end

        def commit_from_sha
          if create?
            nil
          else
            data[:before]
          end
        end

        def commit_to_sha
          if remove?
            nil
          else
            data[:after]
          end
        end

        def data
          super || {}
        end

        def commits
          data[:commits] || []
        end

        def commit_count
          data[:total_commits_count] || 0
        end

        def ref
          data[:ref]
        end

        def trimmed_ref_name
          if ref_type == :tag
            ref[10..-1]
          else
            ref[11..-1]
          end
        end

        def create?
          data[:before] == BLANK_REF
        end

        def remove?
          data[:after] == BLANK_REF
        end

        def push_action
          if create?
            :created
          elsif remove?
            :removed
          else
            :pushed
          end
        end

        def ref_type
          if ref.start_with?(TAG_REF_PREFIX)
            :tag
          else
            :branch
          end
        end
      end

      class EventForMigration < ActiveRecord::Base
        self.table_name = 'events_for_migration'
      end

      class PushEventPayload < ActiveRecord::Base
        self.table_name = 'push_event_payloads'

        enum action: {
          created: 0,
          removed: 1,
          pushed: 2
        }

        enum ref_type: {
          branch: 0,
          tag: 1
        }
      end

      # start_id - The start ID of the range of events to process
      # end_id - The end ID of the range to process.
      def perform(start_id, end_id)
        return unless migrate?

        find_events(start_id, end_id).each { |event| process_event(event) }
      end

      def process_event(event)
        ActiveRecord::Base.transaction do
          replicate_event(event)
          create_push_event_payload(event) if event.push_event?
        end
      rescue ActiveRecord::InvalidForeignKey => e
        # A foreign key error means the associated event was removed. In this
        # case we'll just skip migrating the event.
        Rails.logger.error("Unable to migrate event #{event.id}: #{e}")
      end

      def replicate_event(event)
        new_attributes = event.attributes
          .with_indifferent_access.except(:title, :data)

        EventForMigration.create!(new_attributes)
      end

      def create_push_event_payload(event)
        commit_from = pack(event.commit_from_sha)
        commit_to = pack(event.commit_to_sha)

        PushEventPayload.create!(
          event_id: event.id,
          commit_count: event.commit_count,
          ref_type: event.ref_type,
          action: event.push_action,
          commit_from: commit_from,
          commit_to: commit_to,
          ref: event.trimmed_ref_name,
          commit_title: event.commit_title
        )
      end

      def find_events(start_id, end_id)
        Event
          .where('NOT EXISTS (SELECT true FROM events_for_migration WHERE events_for_migration.id = events.id)')
          .where(id: start_id..end_id)
      end

      def migrate?
        Event.table_exists? && PushEventPayload.table_exists? &&
          EventForMigration.table_exists?
      end

      def pack(value)
        value ? [value].pack('H*') : nil
      end
    end
  end
end