Merge pull request #13477 from demarche-numerique/push-ukyolpppunvm

Tech: déplace les constantes et helpers de stream dans des concerns dédiés

Author: tchak

app/components/dossiers/champ_updated_component.rb

@@ -30,7 +30,7 @@ def updated_by_instructeur?
   end
 
   def instructeur?
-    source_stream == Champ::INSTRUCTEUR_BUFFER_STREAM
+    source_stream == Dossier::INSTRUCTEUR_BUFFER_STREAM
   end
 
   def tooltip_id

app/components/dossiers/champs_rows_show_component.rb

@@ -26,7 +26,7 @@ def row_show_component(champ)
   end
 
   def updated_by(champ)
-    if usager? && champ.source_stream == Champ::INSTRUCTEUR_BUFFER_STREAM && champ.procedure.hide_instructeurs_email?
+    if usager? && champ.instructeur_buffer_source_stream? && champ.procedure.hide_instructeurs_email?
       nil
     else
       champ.updated_by

app/components/editable_champ/editable_champ_component.rb

@@ -100,7 +100,7 @@ def stimulus_values
   def turbo_poll_url_value
     if @champ.private?
       annotation_instructeur_dossier_path(@champ.dossier.procedure, @champ.dossier, @champ.stable_id, row_id: @champ.row_id)
-    elsif @champ.dossier.stream == Champ::INSTRUCTEUR_BUFFER_STREAM
+    elsif @champ.dossier.instructeur_buffer_stream?
       champ_instructeur_dossier_path(@champ.dossier.procedure, @champ.dossier, @champ.stable_id, row_id: @champ.row_id)
     else
       champ_dossier_path(@champ.dossier, @champ.stable_id, row_id: @champ.row_id)

app/controllers/attachments_controller.rb

@@ -73,7 +73,7 @@ def user_or_invite_changing_an_attachment?
   end
 
   def instructeur_changing_an_attachment?
-    (champ&.private? || champ&.stream == Champ::INSTRUCTEUR_BUFFER_STREAM) && current_user.instructeur? && current_instructeur.in?(champ.dossier.groupe_instructeur.instructeurs)
+    (champ&.private? || champ&.instructeur_buffer_stream?) && current_user.instructeur? && current_instructeur.in?(champ.dossier.groupe_instructeur.instructeurs)
   end
 
   def admin_changing_its_procedure?

app/jobs/migrations/backfill_stable_id_job.rb

@@ -6,7 +6,7 @@ class Migrations::BackfillStableIdJob < ApplicationJob
   DEFAULT_LIMIT = 50_000
 
   def perform(iteration, limit = DEFAULT_LIMIT)
-    sql = "UPDATE champs SET stable_id = t.stable_id, stream = 'main'
+    sql = "UPDATE champs SET stable_id = t.stable_id, stream = '#{Dossier::MAIN_STREAM}'
       FROM types_de_champ t
         WHERE champs.type_de_champ_id = t.id
         AND champs.id IN (SELECT id FROM champs WHERE champs.stable_id IS NULL LIMIT ?);"

app/models/champ.rb

@@ -5,6 +5,7 @@ class Champ < ApplicationRecord
   include ChampValidateConcern
   include ChampRevisionConcern
   include ChampExternalDataConcern
+  include ChampStreamConcern
 
   self.ignored_columns += [:type_de_champ_id, :parent_id]
 
@@ -265,7 +266,7 @@ def clone
     deep_clone(only: champ_attributes + value_attributes, include: relationships, validate: true) do |original, kopy|
       if original.is_a?(Champ)
         kopy.write_attribute(:stable_id, original.stable_id)
-        kopy.write_attribute(:stream, 'main')
+        kopy.write_attribute(:stream, Dossier::MAIN_STREAM)
         # TODO: overwrite row_id "N" with nil
         kopy.write_attribute(:row_id, kopy.row_id)
       end
@@ -285,32 +286,6 @@ def html_id
     type_de_champ.html_id(row_id)
   end
 
-  MAIN_STREAM = 'main'
-  USER_BUFFER_STREAM = 'user:buffer'
-  INSTRUCTEUR_BUFFER_STREAM = 'instructeur:buffer'
-  USER_HISTORY_STREAM = 'user:history'
-  HISTORY_STREAM = 'history:'
-
-  def main_stream?
-    stream == MAIN_STREAM
-  end
-
-  def user_buffer_stream?
-    stream == USER_BUFFER_STREAM
-  end
-
-  def instructeur_buffer_stream?
-    stream == INSTRUCTEUR_BUFFER_STREAM
-  end
-
-  def history_stream?
-    stream.start_with?(HISTORY_STREAM)
-  end
-
-  def buffer_stream?
-    persisted? && (user_buffer_stream? || instructeur_buffer_stream?)
-  end
-
   def clear
     update_columns(value: nil, value_json: nil, external_id: nil, data: nil)
     Champ.no_touching do

app/models/champs/referentiel_champ.rb

@@ -100,7 +100,7 @@ def propagate_prefill(types_de_champ)
   private
 
   def prefillable_types_de_champ
-    if stream == Champ::MAIN_STREAM
+    if main_stream?
       dossier.revision.types_de_champ
     else
       dossier.types_de_champ_public_all

app/models/concerns/champ_stream_concern.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module ChampStreamConcern
+  extend ActiveSupport::Concern
+
+  def main_stream?
+    stream == Dossier::MAIN_STREAM
+  end
+
+  def user_buffer_stream?
+    stream == Dossier::USER_BUFFER_STREAM
+  end
+
+  def instructeur_buffer_stream?
+    stream == Dossier::INSTRUCTEUR_BUFFER_STREAM
+  end
+
+  def history_stream?
+    stream.start_with?(Dossier::HISTORY_STREAM)
+  end
+
+  def buffer_stream?
+    persisted? && (user_buffer_stream? || instructeur_buffer_stream?)
+  end
+
+  def instructeur_buffer_source_stream?
+    source_stream == Dossier::INSTRUCTEUR_BUFFER_STREAM
+  end
+end

app/models/concerns/dossier_champs_concern.rb

@@ -183,35 +183,35 @@ def reload
   end
 
   def merge_user_buffer_stream!
-    buffer_ids, changed_ids = changed_champ_ids_for_merge(Champ::USER_BUFFER_STREAM)
+    buffer_ids, changed_ids = changed_champ_ids_for_merge(Dossier::USER_BUFFER_STREAM)
 
     return if buffer_ids.blank?
 
-    merge_buffer_champs(buffer_ids, changed_ids, Champ::USER_BUFFER_STREAM)
+    merge_buffer_champs(buffer_ids, changed_ids, Dossier::USER_BUFFER_STREAM)
   end
 
   def merge_instructeur_buffer_stream!
-    buffer_ids, changed_ids = changed_champ_ids_for_merge(Champ::INSTRUCTEUR_BUFFER_STREAM)
+    buffer_ids, changed_ids = changed_champ_ids_for_merge(Dossier::INSTRUCTEUR_BUFFER_STREAM)
 
     return if buffer_ids.blank?
 
-    merge_buffer_champs(buffer_ids, changed_ids, Champ::INSTRUCTEUR_BUFFER_STREAM)
+    merge_buffer_champs(buffer_ids, changed_ids, Dossier::INSTRUCTEUR_BUFFER_STREAM)
   end
 
   def reset_user_buffer_stream!
-    champ_data.where(stream: Champ::USER_BUFFER_STREAM).destroy_all
+    champ_data.where(stream: Dossier::USER_BUFFER_STREAM).destroy_all
 
     # update loaded champ instances
-    association(:champ_data).target = champ_data.filter { _1.stream != Champ::USER_BUFFER_STREAM }
+    association(:champ_data).target = champ_data.reject(&:user_buffer_stream?)
 
     reset_champs_cache
   end
 
   def reset_instructeur_buffer_stream!
-    champ_data.where(stream: Champ::INSTRUCTEUR_BUFFER_STREAM).destroy_all
+    champ_data.where(stream: Dossier::INSTRUCTEUR_BUFFER_STREAM).destroy_all
 
     # update loaded champ instances
-    association(:champ_data).target = champ_data.filter { _1.stream != Champ::INSTRUCTEUR_BUFFER_STREAM }
+    association(:champ_data).target = champ_data.reject(&:instructeur_buffer_stream?)
 
     reset_champs_cache
   end
@@ -224,49 +224,6 @@ def instructeur_buffer_changes?
     champs_on_instructeur_buffer_stream.present?
   end
 
-  def can_update_as_user?(user)
-    return false unless en_construction?
-    user.owns_or_invite?(self)
-  end
-
-  def can_update_as_instructeur?(user)
-    return false unless en_construction?
-    return false unless procedure.instructeurs_can_edit_dossiers?
-    return false unless user.instructeur?
-    return false if can_update_as_user?(user)
-    groupe_instructeur.instructeurs.include?(user.instructeur)
-  end
-
-  def with_update_stream(user, &block)
-    if can_update_as_user?(user)
-      with_stream(Champ::USER_BUFFER_STREAM, &block)
-    elsif can_update_as_instructeur?(user)
-      with_stream(Champ::INSTRUCTEUR_BUFFER_STREAM, &block)
-    else
-      with_stream(Champ::MAIN_STREAM, &block)
-    end
-  end
-
-  def with_main_stream(&block)
-    with_stream(Champ::MAIN_STREAM, &block)
-  end
-
-  def with_instructeur_buffer_stream(&block)
-    with_stream(Champ::INSTRUCTEUR_BUFFER_STREAM, &block)
-  end
-
-  def with_user_history_stream(&block)
-    with_stream(Champ::USER_HISTORY_STREAM, &block)
-  end
-
-  def with_champ_stream(champ, &block)
-    with_stream(champ.stream, &block)
-  end
-
-  def stream
-    @stream || Champ::MAIN_STREAM
-  end
-
   def history
     champ_data.filter(&:history_stream?)
   end
@@ -308,7 +265,7 @@ def changed_champ_ids_for_merge(stream)
 
     return [[], []] if stream_h.empty?
 
-    main_h = champ_data.where(stream: Champ::MAIN_STREAM, stable_id: revision_stable_ids)
+    main_h = champ_data.where(stream: Dossier::MAIN_STREAM, stable_id: revision_stable_ids)
       .pluck(:stable_id, :row_id, :id)
       .to_h { |(stable_id, row_id, id)| [TypeDeChamp.public_id(stable_id, row_id), id] }
 
@@ -325,29 +282,29 @@ def changed_champ_ids_for_merge(stream)
       .pluck(:row_id)
 
     if discarded_row_ids.present?
-      changed_ids += champ_data.where(stream: Champ::MAIN_STREAM, row_id: discarded_row_ids).pluck(:id)
+      changed_ids += champ_data.where(stream: Dossier::MAIN_STREAM, row_id: discarded_row_ids).pluck(:id)
     end
 
     [stream_ids, changed_ids]
   end
 
   def merge_buffer_champs(buffer_ids, changed_ids, stream)
     now = Time.zone.now
-    history_stream = "#{Champ::HISTORY_STREAM}#{now}"
+    history_stream = "#{Dossier::HISTORY_STREAM}#{now}"
     buffer_champs = champ_data.filter { buffer_ids.member?(it.id) }
 
     transaction do
       # if merging user buffer, discard any instructeur made changes
-      if stream == Champ::USER_BUFFER_STREAM
+      if stream == Dossier::USER_BUFFER_STREAM
         champ_data.where(id: buffer_ids, stream:).pluck(:stable_id, :row_id).each do |(stable_id, row_id)|
-          champ_data.where(stream: Champ::INSTRUCTEUR_BUFFER_STREAM, stable_id:, row_id:).destroy_all
+          champ_data.where(stream: Dossier::INSTRUCTEUR_BUFFER_STREAM, stable_id:, row_id:).destroy_all
         end
       end
 
       # move champ_data with changes from "main" to "history" stream
-      champ_data.where(id: changed_ids, stream: Champ::MAIN_STREAM).update_all(stream: history_stream)
+      champ_data.where(id: changed_ids, stream: Dossier::MAIN_STREAM).update_all(stream: history_stream)
       # move champ_data from "buffer" to "main"
-      champ_data.where(id: buffer_ids, stream:).update_all(stream: Champ::MAIN_STREAM, updated_at: now, checkpoint: history_stream)
+      champ_data.where(id: buffer_ids, stream:).update_all(stream: Dossier::MAIN_STREAM, updated_at: now, checkpoint: history_stream)
       update_champs_timestamps(buffer_champs, stream)
     end
 
@@ -356,7 +313,7 @@ def merge_buffer_champs(buffer_ids, changed_ids, stream)
       if champ.id.in?(changed_ids)
         champ.stream = history_stream
       elsif champ.id.in?(buffer_ids)
-        champ.stream = Champ::MAIN_STREAM
+        champ.stream = Dossier::MAIN_STREAM
         champ.checkpoint = history_stream
       end
     end
@@ -370,22 +327,6 @@ def merge_buffer_champs(buffer_ids, changed_ids, stream)
     history_stream
   end
 
-  def with_stream(stream)
-    if block_given?
-      previous_stream = @stream
-      @stream = stream
-      reset_champs_cache
-      result = yield
-      @stream = previous_stream
-      reset_champs_cache
-      result
-    else
-      @stream = stream
-      reset_champs_cache
-      self
-    end
-  end
-
   def champs_by_public_id
     @champs_by_public_id ||= champs_on_stream.index_by(&:public_id)
   end
@@ -395,12 +336,11 @@ def discarded_champs_by_public_id
   end
 
   def champs_on_stream
-    @champs_on_stream ||= case stream
-    when Champ::USER_BUFFER_STREAM
+    @champs_on_stream ||= if user_buffer_stream?
       (champs_on_user_buffer_stream + champs_on_main_stream).uniq(&:public_id)
-    when Champ::INSTRUCTEUR_BUFFER_STREAM
+    elsif instructeur_buffer_stream?
       (champs_on_instructeur_buffer_stream + champs_on_main_stream).uniq(&:public_id)
-    when Champ::USER_HISTORY_STREAM
+    elsif user_history_stream?
       champ_data
         # only "main" and "history"
         .reject(&:buffer_stream?)
@@ -480,8 +420,8 @@ def champ_upsert_by!(type_de_champ, row_id)
     if champ.class != type_de_champ.champ_class
       champ = champ.becomes!(type_de_champ.champ_class)
       champ.assign_attributes(value: nil, value_json: nil, external_id: nil, data: nil)
-    elsif stream != Champ::MAIN_STREAM && champ.previously_new_record?
-      main_stream_champ = champ_data.find_by(stable_id: type_de_champ.stable_id, row_id:, stream: Champ::MAIN_STREAM)
+    elsif !main_stream? && champ.previously_new_record?
+      main_stream_champ = champ_data.find_by(stable_id: type_de_champ.stable_id, row_id:, stream: Dossier::MAIN_STREAM)
       champ.clone_value_from(main_stream_champ) if main_stream_champ.present?
     end
 
@@ -505,10 +445,10 @@ def champ_upsert_by!(type_de_champ, row_id)
 
   def check_valid_stream_on_write?(type_de_champ)
     if type_de_champ.private?
-      if stream != Champ::MAIN_STREAM
+      if !main_stream?
         raise "Can not write a private champ to \"#{stream}\" stream"
       end
-    elsif stream == Champ::MAIN_STREAM && en_construction?
+    elsif main_stream? && en_construction?
       raise 'Can not write to "main" stream on a dossier "en construction"'
     end
   end

app/models/concerns/dossier_state_concern.rb

@@ -391,14 +391,14 @@ def clean_champs_after_instruction!
   private
 
   def remove_not_in_revision_champs!
-    champ_data.where.not(stable_id: revision_stable_ids).where(stream: Champ::MAIN_STREAM).destroy_all
+    champ_data.where.not(stable_id: revision_stable_ids).where(stream: Dossier::MAIN_STREAM).destroy_all
   end
 
   def remove_discarded_rows!
     row_to_remove_ids = champ_data.filter { _1.row? && _1.discarded? }.map(&:row_id)
 
     return if row_to_remove_ids.empty?
-    champ_data.where(row_id: row_to_remove_ids, stream: Champ::MAIN_STREAM).destroy_all
+    champ_data.where(row_id: row_to_remove_ids, stream: Dossier::MAIN_STREAM).destroy_all
   end
 
   def remove_not_visible_or_empty_repetitions!
@@ -407,15 +407,15 @@ def remove_not_visible_or_empty_repetitions!
       .flat_map(&:row_ids)
 
     return if row_to_remove_ids.empty?
-    champ_data.where(row_id: row_to_remove_ids, stream: Champ::MAIN_STREAM).destroy_all
+    champ_data.where(row_id: row_to_remove_ids, stream: Dossier::MAIN_STREAM).destroy_all
   end
 
   def clear_not_visible_or_empty_champs!
     champs_to_clear = project_champs_public_all
       .reject(&:repetition?)
       .filter { _1.blank? || !_1.visible? }
 
-    champ_data.where(id: champs_to_clear, stream: Champ::MAIN_STREAM).find_each(&:clear)
+    champ_data.where(id: champs_to_clear, stream: Dossier::MAIN_STREAM).find_each(&:clear)
   end
 
   def clear_france_connect_champs_piece_justificatives!
@@ -462,7 +462,7 @@ def remove_auto_purged_piece_justificatives!
 
     return if champ_to_remove_ids.empty?
 
-    champ_data.where(id: champ_to_remove_ids, stream: Champ::MAIN_STREAM).destroy_all
+    champ_data.where(id: champ_to_remove_ids, stream: Dossier::MAIN_STREAM).destroy_all
   end
 
   def enqueue_ami_notification(trigger: :dossier_state_change, state: nil)