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
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
|
# frozen_string_literal: true
module Gitlab
module ImportExport
module Json
class StreamingSerializer
include Gitlab::ImportExport::CommandLineUtil
BATCH_SIZE = 100
class Raw < String
def to_json(*_args)
to_s
end
end
def initialize(exportable, relations_schema, json_writer, current_user:, exportable_path:, logger: Gitlab::Export::Logger)
@exportable = exportable
@current_user = current_user
@exportable_path = exportable_path
@relations_schema = relations_schema
@json_writer = json_writer
@logger = logger
end
def execute
read_from_replica_if_available do
serialize_root
includes.each do |relation_definition|
serialize_relation(relation_definition)
end
end
end
def serialize_root(exportable_path = @exportable_path)
log_relation_export('root')
attributes = exportable.as_json(
relations_schema.merge(include: nil, preloads: nil, unsafe: true))
json_writer.write_attributes(exportable_path, attributes)
end
def serialize_relation(definition)
raise ArgumentError, 'definition needs to be Hash' unless definition.is_a?(Hash)
raise ArgumentError, 'definition needs to have exactly one Hash element' unless definition.one?
key, options = definition.first
record = exportable.public_send(key) # rubocop: disable GitlabSecurity/PublicSend
if record.is_a?(ActiveRecord::Relation)
serialize_many_relations(key, record, options)
elsif record.respond_to?(:each) # this is to support `project_members` that return an Array
serialize_many_each(key, record, options)
else
serialize_single_relation(key, record, options)
end
end
private
attr_reader :json_writer, :relations_schema, :exportable, :logger, :current_user
def serialize_many_relations(key, records, options)
log_relation_export(key, records.size)
enumerator = Enumerator.new do |items|
key_preloads = preloads&.dig(key)
batch(records, key) do |batch|
batch = batch.preload(key_preloads) if key_preloads
batch.each do |record|
before_read_callback(record)
items << exportable_json_record(record, options, key)
after_read_callback(record)
end
end
end
json_writer.write_relation_array(@exportable_path, key, enumerator)
end
def exportable_json_record(record, options, key)
associations = relations_schema[:include_if_exportable]&.dig(key)
return Raw.new(record.to_json(options)) unless associations && options[:include]
filtered_options = options.deep_dup
associations.each do |association|
filtered_options[:include].delete_if do |option|
!exportable_json_association?(option, record, association.to_sym)
end
end
Raw.new(record.to_json(filtered_options))
end
def exportable_json_association?(option, record, association)
return true unless option.has_key?(association)
return false unless record.respond_to?(:exportable_association?)
record.exportable_association?(association, current_user: current_user)
end
def batch(relation, key)
opts = { of: BATCH_SIZE }
order_by = reorders(relation, key)
# we need to sort issues by non primary key column(relative_position)
# and `in_batches` does not support that
if order_by
scope = relation.reorder(order_by)
Gitlab::Pagination::Keyset::Iterator.new(scope: scope, use_union_optimization: true).each_batch(**opts) do |batch|
yield batch
end
else
relation.in_batches(**opts) do |batch| # rubocop:disable Cop/InBatches
# order each batch by its primary key to ensure
# consistent and predictable ordering of each exported relation
# as additional `WHERE` clauses can impact the order in which data is being
# returned by database when no `ORDER` is specified
yield batch.reorder(batch.klass.primary_key)
end
end
end
def serialize_many_each(key, records, options)
log_relation_export(key, records.size)
enumerator = Enumerator.new do |items|
records.each do |record|
items << exportable_json_record(record, options, key)
end
end
json_writer.write_relation_array(@exportable_path, key, enumerator)
end
def serialize_single_relation(key, record, options)
log_relation_export(key)
json = exportable_json_record(record, options, key)
json_writer.write_relation(@exportable_path, key, json)
end
def includes
relations_schema[:include]
end
def preloads
relations_schema[:preload]
end
def reorders(relation, key)
export_reorder = relations_schema[:export_reorder]&.dig(key)
return unless export_reorder
custom_reorder(relation.klass, export_reorder)
end
def custom_reorder(klass, order_by)
arel_table = klass.arel_table
column = order_by[:column] || klass.primary_key
direction = order_by[:direction] || :asc
nulls_position = order_by[:nulls_position] || :nulls_last
arel_order_classes = ::Gitlab::Pagination::Keyset::ColumnOrderDefinition::AREL_ORDER_CLASSES.invert
reverse_direction = ::Gitlab::Pagination::Keyset::ColumnOrderDefinition::REVERSED_ORDER_DIRECTIONS[direction]
reverse_nulls_position = ::Gitlab::Pagination::Keyset::ColumnOrderDefinition::REVERSED_NULL_POSITIONS[nulls_position]
order_expression = arel_table[column].public_send(direction).public_send(nulls_position) # rubocop:disable GitlabSecurity/PublicSend
reverse_order_expression = arel_table[column].public_send(reverse_direction).public_send(reverse_nulls_position) # rubocop:disable GitlabSecurity/PublicSend
::Gitlab::Pagination::Keyset::Order.build(
[
::Gitlab::Pagination::Keyset::ColumnOrderDefinition.new(
attribute_name: column,
column_expression: arel_table[column],
order_expression: order_expression,
reversed_order_expression: reverse_order_expression,
order_direction: direction,
nullable: nulls_position,
distinct: false
),
::Gitlab::Pagination::Keyset::ColumnOrderDefinition.new(
attribute_name: klass.primary_key,
order_expression: arel_order_classes[direction].new(arel_table[klass.primary_key.to_sym])
)
])
end
def read_from_replica_if_available(&block)
::Gitlab::Database::LoadBalancing::Session.current.use_replicas_for_read_queries(&block)
end
def before_read_callback(record)
remove_cached_external_diff(record)
end
def after_read_callback(record)
remove_cached_external_diff(record)
end
def remove_cached_external_diff(record)
return unless record.is_a?(MergeRequest)
record.merge_request_diff&.remove_cached_external_diff
end
def log_base_data
log = { importer: 'Import/Export' }
log.merge!(Gitlab::ImportExport::LogUtil.exportable_to_log_payload(exportable))
log
end
def log_relation_export(relation, size = nil)
message = "Exporting #{relation} relation"
message += ". Number of records to export: #{size}" if size
logger.info(message: message, **log_base_data)
end
end
end
end
end
|