From 1af2b63ed150d997c52902faf595ca1b017395dc Mon Sep 17 00:00:00 2001 From: clemkeirua Date: Mon, 30 Sep 2019 11:57:21 +0200 Subject: [PATCH 1/6] initial implementation of async export --- .../instructeurs/procedures_controller.rb | 8 +++++ app/jobs/download_dossiers_job.rb | 32 +++++++++++++++++++ app/mailers/instructeur_mailer.rb | 8 +++++ .../download_procedure.html.haml | 8 +++++ .../procedures/_download_dossiers.html.haml | 6 ++++ config/routes.rb | 1 + 6 files changed, 63 insertions(+) create mode 100644 app/jobs/download_dossiers_job.rb create mode 100644 app/views/instructeur_mailer/download_procedure.html.haml diff --git a/app/controllers/instructeurs/procedures_controller.rb b/app/controllers/instructeurs/procedures_controller.rb index 139d311ed..4284eaf9e 100644 --- a/app/controllers/instructeurs/procedures_controller.rb +++ b/app/controllers/instructeurs/procedures_controller.rb @@ -205,6 +205,14 @@ module Instructeurs end end + def download_dossiers_mail + options = params.permit(:format, tables: []) + DownloadDossiersJob.perform_later(procedure, options, current_instructeur) + + flash.notice = "Le dossier va vous être envoyé par mail" + redirect_to procedure + end + def email_notifications @procedure = procedure @assign_to = assign_to diff --git a/app/jobs/download_dossiers_job.rb b/app/jobs/download_dossiers_job.rb new file mode 100644 index 000000000..8d3401eaf --- /dev/null +++ b/app/jobs/download_dossiers_job.rb @@ -0,0 +1,32 @@ +class DownloadDossiersJob < ApplicationJob + def perform(procedure, options, instructeur) + dossiers = instructeur.dossiers.for_procedure(procedure) + format = options[:format] + options.delete(:format) + + case format + when 'csv' + filename = procedure.export_filename(:csv) + data = procedure.to_csv(dossiers, options) + when 'xlsx' + filename = procedure.export_filename(:xlsx) + data = procedure.to_xlsx(dossiers, options) + when 'ods' + filename = procedure.export_filename(:ods) + data = procedure.to_ods(dossiers, options) + end + + file_path = File.join('/tmp/', filename) + IO.write(file_path, data) + + File.open(file_path) do |io| + blob = ActiveStorage::Blob.create_after_upload!( + io: io, + filename: filename + ) + + InstructeurMailer.download_procedure(instructeur, procedure, blob).deliver_now + File.delete(file_path) + end + end +end diff --git a/app/mailers/instructeur_mailer.rb b/app/mailers/instructeur_mailer.rb index aa28622d2..8aa2d9a83 100644 --- a/app/mailers/instructeur_mailer.rb +++ b/app/mailers/instructeur_mailer.rb @@ -42,4 +42,12 @@ class InstructeurMailer < ApplicationMailer mail(to: instructeur.email, subject: subject) end + + def download_procedure(instructeur, procedure, blob) + @procedure = procedure + @lien_telechargement = url_for(blob) + subject = "Votre export de la procédure #{procedure.id} est disponible" + + mail(to: instructeur.email, subject: subject) + end end diff --git a/app/views/instructeur_mailer/download_procedure.html.haml b/app/views/instructeur_mailer/download_procedure.html.haml new file mode 100644 index 000000000..9c8108f6c --- /dev/null +++ b/app/views/instructeur_mailer/download_procedure.html.haml @@ -0,0 +1,8 @@ +%p + Bonjour, + +%p + Vous avez demandé un export des dossiers de la procédure nº #{@procedure.id} « #{@procedure.libelle} ». Cliquez sur le lien ci-dessous pour le télécharger : + = link_to('Télécharger les dossiers', @lien_telechargement) + += render partial: "layouts/mailers/signature" diff --git a/app/views/instructeurs/procedures/_download_dossiers.html.haml b/app/views/instructeurs/procedures/_download_dossiers.html.haml index 074752555..387759623 100644 --- a/app/views/instructeurs/procedures/_download_dossiers.html.haml +++ b/app/views/instructeurs/procedures/_download_dossiers.html.haml @@ -20,3 +20,9 @@ = link_to "Au format .ods #{old_format_message}", procedure_dossiers_download_path(procedure, format: :ods, version: 'v1'), target: "_blank", rel: "noopener" %li = link_to "Au format .csv #{old_format_message}", procedure_dossiers_download_path(procedure, format: :csv, version: 'v1'), target: "_blank", rel: "noopener" + %li + = link_to "Par mail, au format .xlsx", download_dossiers_mail_instructeur_procedure_path(procedure, format: :xlsx, version: 'v2') + %li + = link_to "Par mail, au format .ods", download_dossiers_mail_instructeur_procedure_path(procedure, format: :ods, version: 'v2') + %li + = link_to "Par mail, au format .csv", download_dossiers_mail_instructeur_procedure_path(procedure, format: :csv, version: 'v2') diff --git a/config/routes.rb b/config/routes.rb index 595299fcd..7ddf6c7c7 100644 --- a/config/routes.rb +++ b/config/routes.rb @@ -293,6 +293,7 @@ Rails.application.routes.draw do post 'add_filter' get 'remove_filter' => 'procedures#remove_filter', as: 'remove_filter' get 'download_dossiers' + get 'download_dossiers_mail' get 'stats' get 'email_notifications' patch 'update_email_notifications' From 70ea5e167efcf60823137f3ad9b149ee0ffdebcc Mon Sep 17 00:00:00 2001 From: clemkeirua Date: Wed, 2 Oct 2019 15:51:37 +0200 Subject: [PATCH 2/6] procedure download is performed through a controller in order not to leak the URL --- .../instructeurs/procedures_controller.rb | 12 ++++++++++-- ...oad_dossiers_job.rb => export_procedure_job.rb} | 14 +++++++------- app/mailers/instructeur_mailer.rb | 3 +-- app/models/procedure.rb | 1 + ...ml.haml => download_procedure_export.html.haml} | 2 +- config/routes.rb | 1 + 6 files changed, 21 insertions(+), 12 deletions(-) rename app/jobs/{download_dossiers_job.rb => export_procedure_job.rb} (58%) rename app/views/instructeur_mailer/{download_procedure.html.haml => download_procedure_export.html.haml} (70%) diff --git a/app/controllers/instructeurs/procedures_controller.rb b/app/controllers/instructeurs/procedures_controller.rb index 4284eaf9e..271ea602b 100644 --- a/app/controllers/instructeurs/procedures_controller.rb +++ b/app/controllers/instructeurs/procedures_controller.rb @@ -206,13 +206,21 @@ module Instructeurs end def download_dossiers_mail - options = params.permit(:format, tables: []) - DownloadDossiersJob.perform_later(procedure, options, current_instructeur) + ExportProcedureJob.perform_later(procedure, current_instructeur, params[:format]) flash.notice = "Le dossier va vous être envoyé par mail" redirect_to procedure end + def download_export + if procedure.export_file.attachment.created_at < 1.day.ago + flash.alert = "Cet export n'est plus disponible. Vous devez en générer un nouveau qui vous sera transmis par mail" + redirect_to instructeur_procedure_url(procedure) + else + redirect_to url_for(procedure.export_file) + end + end + def email_notifications @procedure = procedure @assign_to = assign_to diff --git a/app/jobs/download_dossiers_job.rb b/app/jobs/export_procedure_job.rb similarity index 58% rename from app/jobs/download_dossiers_job.rb rename to app/jobs/export_procedure_job.rb index 8d3401eaf..194c13ebe 100644 --- a/app/jobs/download_dossiers_job.rb +++ b/app/jobs/export_procedure_job.rb @@ -1,10 +1,9 @@ -class DownloadDossiersJob < ApplicationJob - def perform(procedure, options, instructeur) +class ExportProcedureJob < ApplicationJob + def perform(procedure, instructeur, export_format) dossiers = instructeur.dossiers.for_procedure(procedure) - format = options[:format] - options.delete(:format) + options = { :version => 'v2', :tables => [:dossiers, :etablissements] } - case format + case export_format when 'csv' filename = procedure.export_filename(:csv) data = procedure.to_csv(dossiers, options) @@ -20,12 +19,13 @@ class DownloadDossiersJob < ApplicationJob IO.write(file_path, data) File.open(file_path) do |io| - blob = ActiveStorage::Blob.create_after_upload!( + # todo: add a TTL to the uploaded file, even though it's checked for in the controller too + procedure.export_file = ActiveStorage::Blob.create_after_upload!( io: io, filename: filename ) - InstructeurMailer.download_procedure(instructeur, procedure, blob).deliver_now + InstructeurMailer.download_procedure_export(instructeur, procedure).deliver_now File.delete(file_path) end end diff --git a/app/mailers/instructeur_mailer.rb b/app/mailers/instructeur_mailer.rb index 8aa2d9a83..52c4fe429 100644 --- a/app/mailers/instructeur_mailer.rb +++ b/app/mailers/instructeur_mailer.rb @@ -43,9 +43,8 @@ class InstructeurMailer < ApplicationMailer mail(to: instructeur.email, subject: subject) end - def download_procedure(instructeur, procedure, blob) + def download_procedure_export(instructeur, procedure) @procedure = procedure - @lien_telechargement = url_for(blob) subject = "Votre export de la procédure #{procedure.id} est disponible" mail(to: instructeur.email, subject: subject) diff --git a/app/models/procedure.rb b/app/models/procedure.rb index 1d24b7ae4..843e2ce47 100644 --- a/app/models/procedure.rb +++ b/app/models/procedure.rb @@ -34,6 +34,7 @@ class Procedure < ApplicationRecord has_one_attached :logo has_one_attached :notice has_one_attached :deliberation + has_one_attached :export_file accepts_nested_attributes_for :types_de_champ, reject_if: proc { |attributes| attributes['libelle'].blank? }, allow_destroy: true accepts_nested_attributes_for :types_de_champ_private, reject_if: proc { |attributes| attributes['libelle'].blank? }, allow_destroy: true diff --git a/app/views/instructeur_mailer/download_procedure.html.haml b/app/views/instructeur_mailer/download_procedure_export.html.haml similarity index 70% rename from app/views/instructeur_mailer/download_procedure.html.haml rename to app/views/instructeur_mailer/download_procedure_export.html.haml index 9c8108f6c..251f6668f 100644 --- a/app/views/instructeur_mailer/download_procedure.html.haml +++ b/app/views/instructeur_mailer/download_procedure_export.html.haml @@ -3,6 +3,6 @@ %p Vous avez demandé un export des dossiers de la procédure nº #{@procedure.id} « #{@procedure.libelle} ». Cliquez sur le lien ci-dessous pour le télécharger : - = link_to('Télécharger les dossiers', @lien_telechargement) + = link_to('Télécharger les dossiers', download_export_instructeur_procedure_url(@procedure)) = render partial: "layouts/mailers/signature" diff --git a/config/routes.rb b/config/routes.rb index 7ddf6c7c7..51cb1b35e 100644 --- a/config/routes.rb +++ b/config/routes.rb @@ -294,6 +294,7 @@ Rails.application.routes.draw do get 'remove_filter' => 'procedures#remove_filter', as: 'remove_filter' get 'download_dossiers' get 'download_dossiers_mail' + get 'download_export' get 'stats' get 'email_notifications' patch 'update_email_notifications' From 43424e4f4e84d8db90a4f03e5012cf2ed7730815 Mon Sep 17 00:00:00 2001 From: clemkeirua Date: Thu, 3 Oct 2019 15:35:31 +0200 Subject: [PATCH 3/6] merge with the work of paul, using 3 links --- .../instructeurs/procedures_controller.rb | 19 +-- app/jobs/export_procedure_job.rb | 30 +--- app/mailers/instructeur_mailer.rb | 5 +- app/models/procedure.rb | 90 +++++++++- .../download_procedure_export.html.haml | 8 - ...otify_procedure_export_available.html.haml | 11 ++ .../procedures/_download_dossiers.html.haml | 41 +++-- config/initializers/flipper.rb | 1 + config/routes.rb | 1 - ...9140415_add_export_queued_to_procedures.rb | 7 + db/schema.rb | 3 + spec/factories/procedure.rb | 42 +++++ spec/models/procedure_spec.rb | 161 ++++++++++++++++++ 13 files changed, 356 insertions(+), 63 deletions(-) delete mode 100644 app/views/instructeur_mailer/download_procedure_export.html.haml create mode 100644 app/views/instructeur_mailer/notify_procedure_export_available.html.haml create mode 100644 db/migrate/20190709140415_add_export_queued_to_procedures.rb diff --git a/app/controllers/instructeurs/procedures_controller.rb b/app/controllers/instructeurs/procedures_controller.rb index 271ea602b..37a0f2c2c 100644 --- a/app/controllers/instructeurs/procedures_controller.rb +++ b/app/controllers/instructeurs/procedures_controller.rb @@ -205,19 +205,16 @@ module Instructeurs end end - def download_dossiers_mail - ExportProcedureJob.perform_later(procedure, current_instructeur, params[:format]) - - flash.notice = "Le dossier va vous être envoyé par mail" - redirect_to procedure - end - def download_export - if procedure.export_file.attachment.created_at < 1.day.ago - flash.alert = "Cet export n'est plus disponible. Vous devez en générer un nouveau qui vous sera transmis par mail" - redirect_to instructeur_procedure_url(procedure) + export_format = params[:export_format] + + if procedure.should_generate_export?(export_format) + procedure.queue_export(current_instructeur, export_format) + + flash.now.notice = "Nous générons cet export. Lorsque celui-ci sera disponible, vous recevrez une notification par email accompagnée d'un lien de téléchargement." + redirect_to procedure else - redirect_to url_for(procedure.export_file) + redirect_to url_for(procedure.export_file(export_format)) end end diff --git a/app/jobs/export_procedure_job.rb b/app/jobs/export_procedure_job.rb index 194c13ebe..7e935d8ac 100644 --- a/app/jobs/export_procedure_job.rb +++ b/app/jobs/export_procedure_job.rb @@ -1,32 +1,6 @@ class ExportProcedureJob < ApplicationJob def perform(procedure, instructeur, export_format) - dossiers = instructeur.dossiers.for_procedure(procedure) - options = { :version => 'v2', :tables => [:dossiers, :etablissements] } - - case export_format - when 'csv' - filename = procedure.export_filename(:csv) - data = procedure.to_csv(dossiers, options) - when 'xlsx' - filename = procedure.export_filename(:xlsx) - data = procedure.to_xlsx(dossiers, options) - when 'ods' - filename = procedure.export_filename(:ods) - data = procedure.to_ods(dossiers, options) - end - - file_path = File.join('/tmp/', filename) - IO.write(file_path, data) - - File.open(file_path) do |io| - # todo: add a TTL to the uploaded file, even though it's checked for in the controller too - procedure.export_file = ActiveStorage::Blob.create_after_upload!( - io: io, - filename: filename - ) - - InstructeurMailer.download_procedure_export(instructeur, procedure).deliver_now - File.delete(file_path) - end + procedure.prepare_export_download(export_format) + InstructeurMailer.notify_procedure_export_available(instructeur, procedure, export_format).deliver_later end end diff --git a/app/mailers/instructeur_mailer.rb b/app/mailers/instructeur_mailer.rb index 52c4fe429..d0aae6b81 100644 --- a/app/mailers/instructeur_mailer.rb +++ b/app/mailers/instructeur_mailer.rb @@ -43,9 +43,10 @@ class InstructeurMailer < ApplicationMailer mail(to: instructeur.email, subject: subject) end - def download_procedure_export(instructeur, procedure) + def notify_procedure_export_available(instructeur, procedure, export_format) @procedure = procedure - subject = "Votre export de la procédure #{procedure.id} est disponible" + @export_format = export_format + subject = "Votre export de la procédure nº #{procedure.id} est disponible" mail(to: instructeur.email, subject: subject) end diff --git a/app/models/procedure.rb b/app/models/procedure.rb index 843e2ce47..240fc3998 100644 --- a/app/models/procedure.rb +++ b/app/models/procedure.rb @@ -34,7 +34,10 @@ class Procedure < ApplicationRecord has_one_attached :logo has_one_attached :notice has_one_attached :deliberation - has_one_attached :export_file + + has_one_attached :csv_export_file + has_one_attached :xlsx_export_file + has_one_attached :ods_export_file accepts_nested_attributes_for :types_de_champ, reject_if: proc { |attributes| attributes['libelle'].blank? }, allow_destroy: true accepts_nested_attributes_for :types_de_champ_private, reject_if: proc { |attributes| attributes['libelle'].blank? }, allow_destroy: true @@ -129,11 +132,88 @@ class Procedure < ApplicationRecord end end + def csv_export_stale? + !csv_export_file.attached? || csv_export_file.created_at < 3.hours.ago + end + + def xlsx_export_stale? + !xlsx_export_file.attached? || xlsx_export_file.created_at < 3.hours.ago + end + + def ods_export_stale? + !ods_export_file.attached? || ods_export_file.created_at < 3.hours.ago + end + + def should_generate_export?(format) + case format.to_sym + when :csv + return csv_export_stale? && !csv_export_queued? + when :xlsx + return xlsx_export_stale? && !xlsx_export_queued? + when :ods + return ods_export_stale? && !ods_export_queued? + end + false + end + + def export_file(export_format) + case export_format.to_sym + when :csv + csv_export_file + when :xlsx + xlsx_export_file + when :ods + ods_export_file + end + end + + def queue_export(instructeur, export_format) + ExportProcedureJob.perform_later(procedure, instructeur, export_format) + case export_format.to_sym + when :csv + update(csv_export_queued: true) + when :xlsx + update(xlsx_export_queued: true) + when :ods + update(ods_export_queued: true) + end + end + + def prepare_export_download(format) + service = ProcedureExportV2Service.new(self, self.dossiers) + filename = export_filename(format) + + case format.to_sym + when :csv + csv_export_file.attach( + io: StringIO.new(service.to_csv), + filename: filename, + content_type: 'text/csv' + ) + update(csv_export_queued: false) + when :xlsx + xlsx_export_file.attach( + io: StringIO.new(service.to_xlsx), + filename: filename, + content_type: 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet' + ) + update(xlsx_export_queued: false) + when :ods + ods_export_file.attach( + io: StringIO.new(service.to_ods), + filename: filename, + content_type: 'application/vnd.oasis.opendocument.spreadsheet' + ) + update(ods_export_queued: false) + end + end + def reset! if locked? raise "Can not reset a locked procedure." else groupe_instructeurs.each { |gi| gi.dossiers.destroy_all } + purge_export_files end end @@ -175,6 +255,12 @@ class Procedure < ApplicationRecord procedure.blank? || administrateur.owns?(procedure) end + def purge_export_files + xlsx_export_file.purge_later + ods_export_file.purge_later + csv_export_file.purge_later + end + def locked? publiee_ou_archivee? end @@ -514,12 +600,14 @@ class Procedure < ApplicationRecord def after_archive update!(archived_at: Time.zone.now) + purge_export_files end def after_hide now = Time.zone.now update!(hidden_at: now) dossiers.update_all(hidden_at: now) + purge_export_files end def after_draft diff --git a/app/views/instructeur_mailer/download_procedure_export.html.haml b/app/views/instructeur_mailer/download_procedure_export.html.haml deleted file mode 100644 index 251f6668f..000000000 --- a/app/views/instructeur_mailer/download_procedure_export.html.haml +++ /dev/null @@ -1,8 +0,0 @@ -%p - Bonjour, - -%p - Vous avez demandé un export des dossiers de la procédure nº #{@procedure.id} « #{@procedure.libelle} ». Cliquez sur le lien ci-dessous pour le télécharger : - = link_to('Télécharger les dossiers', download_export_instructeur_procedure_url(@procedure)) - -= render partial: "layouts/mailers/signature" diff --git a/app/views/instructeur_mailer/notify_procedure_export_available.html.haml b/app/views/instructeur_mailer/notify_procedure_export_available.html.haml new file mode 100644 index 000000000..cc9425645 --- /dev/null +++ b/app/views/instructeur_mailer/notify_procedure_export_available.html.haml @@ -0,0 +1,11 @@ +%p + Bonjour, + +%p + Vous avez demandé un export des dossiers de la procédure nº #{@procedure.id} « #{@procedure.libelle} » au format #{@export_format}. + +%p + Cliquez sur le lien ci-dessous pour le télécharger : + = link_to('Télécharger l\'export des dossiers', download_export_instructeur_procedure_url(@procedure, :export_format => @export_format)) + += render partial: "layouts/mailers/signature" diff --git a/app/views/instructeurs/procedures/_download_dossiers.html.haml b/app/views/instructeurs/procedures/_download_dossiers.html.haml index 387759623..2eab6536e 100644 --- a/app/views/instructeurs/procedures/_download_dossiers.html.haml +++ b/app/views/instructeurs/procedures/_download_dossiers.html.haml @@ -4,14 +4,37 @@ Télécharger tous les dossiers - old_format_limit_date = Date.parse("Oct 31 2019") - export_v1_enabled = old_format_limit_date > Time.zone.today + - export_v2_enabled = Flipper[:procedure_export_v2_enabled] || !export_v1_enabled .dropdown-content.fade-in-down{ style: !export_v1_enabled ? 'width: 330px' : '' } %ul.dropdown-items - %li - = link_to "Au format .xlsx", procedure_dossiers_download_path(procedure, format: :xlsx, version: 'v2'), target: "_blank", rel: "noopener" - %li - = link_to "Au format .ods", procedure_dossiers_download_path(procedure, format: :ods, version: 'v2'), target: "_blank", rel: "noopener" - %li - = link_to "Au format .csv", procedure_dossiers_download_path(procedure, format: :csv, version: 'v2'), target: "_blank", rel: "noopener" + - if export_v2_enabled + %li + - if procedure.xlsx_export_stale? + - if procedure.xlsx_export_queued? + L'export au format .xlsx est en cours de préparation + = link_to "rafraichir", download_export_instructeur_procedure_path(procedure, export_format: :xlsx), remote: true + - else + = link_to "Préparer le téléchargement de l'export au format .xlsx", download_export_instructeur_procedure_path(procedure, export_format: :xlsx), remote: true + - else + = link_to "Au format .xlsx", url_for(procedure.xlsx_export_file), target: "_blank", rel: "noopener" + %li + - if procedure.ods_export_stale? + - if procedure.ods_export_queued? + L'export au format .ods est en cours de préparation + = link_to "rafraichir", download_export_instructeur_procedure_path(procedure, export_format: :ods), remote: true + - else + = link_to "Préparer le téléchargement de l'export au format .ods", download_export_instructeur_procedure_path(procedure, export_format: :ods)#, remote: true + - else + = link_to "Au format .ods", url_for(procedure.ods_export_file), target: "_blank", rel: "noopener" + %li + - if procedure.csv_export_stale? + - if procedure.csv_export_queued? + L'export au format .csv est en cours de préparation + = link_to "rafraichir", download_export_instructeur_procedure_path(procedure, export_format: :csv), remote: true + - else + = link_to "Préparer le téléchargement de l'export au format .csv", download_export_instructeur_procedure_path(procedure, export_format: :csv), remote: true + - else + = link_to "Au format .csv", url_for(procedure.csv_export_file), target: "_blank", rel: "noopener" - if export_v1_enabled - old_format_message = "(ancien format, jusqu’au #{old_format_limit_date.strftime('%d/%m/%Y')})" %li @@ -20,9 +43,3 @@ = link_to "Au format .ods #{old_format_message}", procedure_dossiers_download_path(procedure, format: :ods, version: 'v1'), target: "_blank", rel: "noopener" %li = link_to "Au format .csv #{old_format_message}", procedure_dossiers_download_path(procedure, format: :csv, version: 'v1'), target: "_blank", rel: "noopener" - %li - = link_to "Par mail, au format .xlsx", download_dossiers_mail_instructeur_procedure_path(procedure, format: :xlsx, version: 'v2') - %li - = link_to "Par mail, au format .ods", download_dossiers_mail_instructeur_procedure_path(procedure, format: :ods, version: 'v2') - %li - = link_to "Par mail, au format .csv", download_dossiers_mail_instructeur_procedure_path(procedure, format: :csv, version: 'v2') diff --git a/config/initializers/flipper.rb b/config/initializers/flipper.rb index e8172d0da..0718c0e6a 100644 --- a/config/initializers/flipper.rb +++ b/config/initializers/flipper.rb @@ -34,6 +34,7 @@ features = [ :mini_profiler, :operation_log_serialize_subject, :pre_maintenance_mode, + :procedure_export_v2_enabled, :xray ] diff --git a/config/routes.rb b/config/routes.rb index 51cb1b35e..d60cd0c65 100644 --- a/config/routes.rb +++ b/config/routes.rb @@ -293,7 +293,6 @@ Rails.application.routes.draw do post 'add_filter' get 'remove_filter' => 'procedures#remove_filter', as: 'remove_filter' get 'download_dossiers' - get 'download_dossiers_mail' get 'download_export' get 'stats' get 'email_notifications' diff --git a/db/migrate/20190709140415_add_export_queued_to_procedures.rb b/db/migrate/20190709140415_add_export_queued_to_procedures.rb new file mode 100644 index 000000000..471d61fd0 --- /dev/null +++ b/db/migrate/20190709140415_add_export_queued_to_procedures.rb @@ -0,0 +1,7 @@ +class AddExportQueuedToProcedures < ActiveRecord::Migration[5.2] + def change + add_column :procedures, :csv_export_queued, :boolean + add_column :procedures, :xlsx_export_queued, :boolean + add_column :procedures, :ods_export_queued, :boolean + end +end diff --git a/db/schema.rb b/db/schema.rb index a9b5f57a9..3736ce621 100644 --- a/db/schema.rb +++ b/db/schema.rb @@ -487,6 +487,9 @@ ActiveRecord::Schema.define(version: 2019_10_14_160538) do t.string "declarative_with_state" t.text "monavis_embed" t.text "routing_criteria_name" + t.boolean "csv_export_queued" + t.boolean "xlsx_export_queued" + t.boolean "ods_export_queued" t.index ["declarative_with_state"], name: "index_procedures_on_declarative_with_state" t.index ["hidden_at"], name: "index_procedures_on_hidden_at" t.index ["parent_procedure_id"], name: "index_procedures_on_parent_procedure_id" diff --git a/spec/factories/procedure.rb b/spec/factories/procedure.rb index 43dc38211..b392caba3 100644 --- a/spec/factories/procedure.rb +++ b/spec/factories/procedure.rb @@ -242,5 +242,47 @@ FactoryBot.define do end end end + + trait :with_csv_export_file do + after(:create) do |procedure, _evaluator| + procedure.csv_export_file.attach(io: StringIO.new("some csv data"), filename: "export.csv", content_type: "text/plain") + procedure.csv_export_file.update(created_at: 5.minutes.ago) + end + end + + trait :with_stale_csv_export_file do + after(:create) do |procedure, _evaluator| + procedure.csv_export_file.attach(io: StringIO.new("some csv data"), filename: "export.csv", content_type: "text/plain") + procedure.csv_export_file.update(created_at: 4.hours.ago) + end + end + + trait :with_ods_export_file do + after(:create) do |procedure, _evaluator| + procedure.ods_export_file.attach(io: StringIO.new("some ods data"), filename: "export.ods", content_type: "text/plain") + procedure.ods_export_file.update(created_at: 5.minutes.ago) + end + end + + trait :with_stale_ods_export_file do + after(:create) do |procedure, _evaluator| + procedure.ods_export_file.attach(io: StringIO.new("some ods data"), filename: "export.ods", content_type: "text/plain") + procedure.ods_export_file.update(created_at: 4.hours.ago) + end + end + + trait :with_xlsx_export_file do + after(:create) do |procedure, _evaluator| + procedure.xlsx_export_file.attach(io: StringIO.new("some xlsx data"), filename: "export.xlsx", content_type: "text/plain") + procedure.xlsx_export_file.update(created_at: 5.minutes.ago) + end + end + + trait :with_stale_xlsx_export_file do + after(:create) do |procedure, _evaluator| + procedure.xlsx_export_file.attach(io: StringIO.new("some xlsx data"), filename: "export.xlsx", content_type: "text/plain") + procedure.xlsx_export_file.update(created_at: 4.hours.ago) + end + end end end diff --git a/spec/models/procedure_spec.rb b/spec/models/procedure_spec.rb index c95879de4..d63ff1670 100644 --- a/spec/models/procedure_spec.rb +++ b/spec/models/procedure_spec.rb @@ -954,4 +954,165 @@ describe Procedure do it { is_expected.to be false } end end + + describe '.ods_export_stale?' do + subject { procedure.ods_export_stale? } + + context 'with no ods export' do + let(:procedure) { create(:procedure) } + it { is_expected.to be true } + end + + context 'with a recent ods export' do + let(:procedure) { create(:procedure, :with_ods_export_file) } + it { is_expected.to be false } + end + + context 'with an old ods export' do + let(:procedure) { create(:procedure, :with_stale_ods_export_file) } + it { is_expected.to be true } + end + end + + describe '.csv_export_stale?' do + subject { procedure.csv_export_stale? } + + context 'with no csv export' do + let(:procedure) { create(:procedure) } + it { is_expected.to be true } + end + + context 'with a recent csv export' do + let(:procedure) { create(:procedure, :with_csv_export_file) } + it { is_expected.to be false } + end + + context 'with an old csv export' do + let(:procedure) { create(:procedure, :with_stale_csv_export_file) } + it { is_expected.to be true } + end + end + + describe '.xlsx_export_stale?' do + subject { procedure.xlsx_export_stale? } + + context 'with no xlsx export' do + let(:procedure) { create(:procedure) } + it { is_expected.to be true } + end + + context 'with a recent xlsx export' do + let(:procedure) { create(:procedure, :with_xlsx_export_file) } + it { is_expected.to be false } + end + + context 'with an old xlsx export' do + let(:procedure) { create(:procedure, :with_stale_xlsx_export_file) } + it { is_expected.to be true } + end + end + + describe '.should_generate_export?' do + context 'xlsx' do + subject { procedure.should_generate_export?('xlsx') } + context 'with no export' do + let(:procedure) { create(:procedure) } + it { is_expected.to be true } + end + + context 'with a recent export' do + context 'when its not queued' do + let(:procedure) { create(:procedure, :with_xlsx_export_file, xlsx_export_queued: false) } + it { is_expected.to be false } + end + + context 'when its already queued' do + let(:procedure) { create(:procedure, :with_xlsx_export_file, xlsx_export_queued: true) } + it { expect(procedure.xlsx_export_queued).to be true } + it { is_expected.to be false } + end + end + + context 'with an old export' do + context 'when its not queued' do + let(:procedure) { create(:procedure, :with_stale_xlsx_export_file, xlsx_export_queued: false) } + it { is_expected.to be true } + end + + context 'when its already queued' do + let(:procedure) { create(:procedure, :with_stale_xlsx_export_file, xlsx_export_queued: true) } + it { expect(procedure.xlsx_export_queued).to be true } + it { is_expected.to be false } + end + end + end + + context 'csv' do + subject { procedure.should_generate_export?('csv') } + context 'with no export' do + let(:procedure) { create(:procedure) } + it { is_expected.to be true } + end + + context 'with a recent export' do + context 'when its not queued' do + let(:procedure) { create(:procedure, :with_csv_export_file, csv_export_queued: false) } + it { is_expected.to be false } + end + + context 'when its already queued' do + let(:procedure) { create(:procedure, :with_csv_export_file, csv_export_queued: true) } + it { expect(procedure.csv_export_queued).to be true } + it { is_expected.to be false } + end + end + + context 'with an old export' do + context 'when its not queued' do + let(:procedure) { create(:procedure, :with_stale_csv_export_file, csv_export_queued: false) } + it { is_expected.to be true } + end + + context 'when its already queued' do + let(:procedure) { create(:procedure, :with_stale_csv_export_file, csv_export_queued: true) } + it { expect(procedure.csv_export_queued).to be true } + it { is_expected.to be false } + end + end + end + + context 'ods' do + subject { procedure.should_generate_export?('ods') } + context 'with no export' do + let(:procedure) { create(:procedure) } + it { is_expected.to be true } + end + + context 'with a recent export' do + context 'when its not queued' do + let(:procedure) { create(:procedure, :with_ods_export_file, ods_export_queued: false) } + it { is_expected.to be false } + end + + context 'when its already queued' do + let(:procedure) { create(:procedure, :with_ods_export_file, ods_export_queued: true) } + it { expect(procedure.ods_export_queued).to be true } + it { is_expected.to be false } + end + end + + context 'with an old export' do + context 'when its not queued' do + let(:procedure) { create(:procedure, :with_stale_ods_export_file, ods_export_queued: false) } + it { is_expected.to be true } + end + + context 'when its already queued' do + let(:procedure) { create(:procedure, :with_stale_ods_export_file, ods_export_queued: true) } + it { expect(procedure.ods_export_queued).to be true } + it { is_expected.to be false } + end + end + end + end end From cdab08b19832c699ced0b1416934c35943ff2531 Mon Sep 17 00:00:00 2001 From: clemkeirua Date: Wed, 16 Oct 2019 11:40:19 +0200 Subject: [PATCH 4/6] UI work --- .../instructeurs/procedures_controller.rb | 8 ++++++-- app/mailers/instructeur_mailer.rb | 2 +- app/models/procedure.rb | 4 +++- .../notify_procedure_export_available.html.haml | 2 +- .../procedures/_download_dossiers.html.haml | 13 +++++-------- .../instructeurs/procedures/download_export.js.erb | 2 ++ 6 files changed, 18 insertions(+), 13 deletions(-) create mode 100644 app/views/instructeurs/procedures/download_export.js.erb diff --git a/app/controllers/instructeurs/procedures_controller.rb b/app/controllers/instructeurs/procedures_controller.rb index 37a0f2c2c..9b76145ff 100644 --- a/app/controllers/instructeurs/procedures_controller.rb +++ b/app/controllers/instructeurs/procedures_controller.rb @@ -211,8 +211,12 @@ module Instructeurs if procedure.should_generate_export?(export_format) procedure.queue_export(current_instructeur, export_format) - flash.now.notice = "Nous générons cet export. Lorsque celui-ci sera disponible, vous recevrez une notification par email accompagnée d'un lien de téléchargement." - redirect_to procedure + respond_to do |format| + format.js do + flash.notice = "Nous générons cet export. Lorsque celui-ci sera disponible, vous recevrez une notification par email accompagnée d'un lien de téléchargement." + @procedure = procedure + end + end else redirect_to url_for(procedure.export_file(export_format)) end diff --git a/app/mailers/instructeur_mailer.rb b/app/mailers/instructeur_mailer.rb index d0aae6b81..d132c0005 100644 --- a/app/mailers/instructeur_mailer.rb +++ b/app/mailers/instructeur_mailer.rb @@ -46,7 +46,7 @@ class InstructeurMailer < ApplicationMailer def notify_procedure_export_available(instructeur, procedure, export_format) @procedure = procedure @export_format = export_format - subject = "Votre export de la procédure nº #{procedure.id} est disponible" + subject = "Votre export de la démarche nº #{procedure.id} est disponible" mail(to: instructeur.email, subject: subject) end diff --git a/app/models/procedure.rb b/app/models/procedure.rb index 240fc3998..4e14e7f94 100644 --- a/app/models/procedure.rb +++ b/app/models/procedure.rb @@ -168,7 +168,7 @@ class Procedure < ApplicationRecord end def queue_export(instructeur, export_format) - ExportProcedureJob.perform_later(procedure, instructeur, export_format) + ExportProcedureJob.perform_now(self, instructeur, export_format) case export_format.to_sym when :csv update(csv_export_queued: true) @@ -259,6 +259,8 @@ class Procedure < ApplicationRecord xlsx_export_file.purge_later ods_export_file.purge_later csv_export_file.purge_later + + update(csv_export_queued: false, xlsx_export_queued: false, ods_export_queued: false) end def locked? diff --git a/app/views/instructeur_mailer/notify_procedure_export_available.html.haml b/app/views/instructeur_mailer/notify_procedure_export_available.html.haml index cc9425645..678dfd08b 100644 --- a/app/views/instructeur_mailer/notify_procedure_export_available.html.haml +++ b/app/views/instructeur_mailer/notify_procedure_export_available.html.haml @@ -2,7 +2,7 @@ Bonjour, %p - Vous avez demandé un export des dossiers de la procédure nº #{@procedure.id} « #{@procedure.libelle} » au format #{@export_format}. + Votre export des dossiers de la démarche nº #{@procedure.id} « #{@procedure.libelle} » au format #{@export_format} est prêt. %p Cliquez sur le lien ci-dessous pour le télécharger : diff --git a/app/views/instructeurs/procedures/_download_dossiers.html.haml b/app/views/instructeurs/procedures/_download_dossiers.html.haml index 2eab6536e..10902baae 100644 --- a/app/views/instructeurs/procedures/_download_dossiers.html.haml +++ b/app/views/instructeurs/procedures/_download_dossiers.html.haml @@ -11,26 +11,23 @@ %li - if procedure.xlsx_export_stale? - if procedure.xlsx_export_queued? - L'export au format .xlsx est en cours de préparation - = link_to "rafraichir", download_export_instructeur_procedure_path(procedure, export_format: :xlsx), remote: true + L'export au format .xlsx est en cours de préparation, vous recevrez un email lorsqu'il sera disponible. - else - = link_to "Préparer le téléchargement de l'export au format .xlsx", download_export_instructeur_procedure_path(procedure, export_format: :xlsx), remote: true + = link_to "Exporter au format .xlsx", download_export_instructeur_procedure_path(procedure, export_format: :xlsx), remote: true - else = link_to "Au format .xlsx", url_for(procedure.xlsx_export_file), target: "_blank", rel: "noopener" %li - if procedure.ods_export_stale? - if procedure.ods_export_queued? - L'export au format .ods est en cours de préparation - = link_to "rafraichir", download_export_instructeur_procedure_path(procedure, export_format: :ods), remote: true + L'export au format .ods est en cours de préparation, vous recevrez un email lorsqu'il sera disponible. - else - = link_to "Préparer le téléchargement de l'export au format .ods", download_export_instructeur_procedure_path(procedure, export_format: :ods)#, remote: true + = link_to "Préparer le téléchargement de l'export au format .ods", download_export_instructeur_procedure_path(procedure, export_format: :ods), remote: true - else = link_to "Au format .ods", url_for(procedure.ods_export_file), target: "_blank", rel: "noopener" %li - if procedure.csv_export_stale? - if procedure.csv_export_queued? - L'export au format .csv est en cours de préparation - = link_to "rafraichir", download_export_instructeur_procedure_path(procedure, export_format: :csv), remote: true + L'export au format .csv est en cours de préparation, vous recevrez un email lorsqu'il sera disponible. - else = link_to "Préparer le téléchargement de l'export au format .csv", download_export_instructeur_procedure_path(procedure, export_format: :csv), remote: true - else diff --git a/app/views/instructeurs/procedures/download_export.js.erb b/app/views/instructeurs/procedures/download_export.js.erb new file mode 100644 index 000000000..cb6442733 --- /dev/null +++ b/app/views/instructeurs/procedures/download_export.js.erb @@ -0,0 +1,2 @@ +<%= render_to_element('.procedure-actions', partial: "download_dossiers", locals: { procedure: @procedure }) %> +<%= render_flash %> From 87741f4b4903bf18dba78b5c2d53d57f2e55fb8d Mon Sep 17 00:00:00 2001 From: clemkeirua Date: Mon, 21 Oct 2019 17:14:56 +0200 Subject: [PATCH 5/6] introduce constant for exports --- app/models/procedure.rb | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/app/models/procedure.rb b/app/models/procedure.rb index 4e14e7f94..d4703b465 100644 --- a/app/models/procedure.rb +++ b/app/models/procedure.rb @@ -6,6 +6,7 @@ class Procedure < ApplicationRecord include ProcedureStatsConcern MAX_DUREE_CONSERVATION = 36 + MAX_DUREE_CONSERVATION_EXPORT = 3.hours has_many :types_de_champ, -> { root.public_only.ordered }, inverse_of: :procedure, dependent: :destroy has_many :types_de_champ_private, -> { root.private_only.ordered }, class_name: 'TypeDeChamp', inverse_of: :procedure, dependent: :destroy @@ -133,15 +134,15 @@ class Procedure < ApplicationRecord end def csv_export_stale? - !csv_export_file.attached? || csv_export_file.created_at < 3.hours.ago + !csv_export_file.attached? || csv_export_file.created_at < MAX_DUREE_CONSERVATION_EXPORT.ago end def xlsx_export_stale? - !xlsx_export_file.attached? || xlsx_export_file.created_at < 3.hours.ago + !xlsx_export_file.attached? || xlsx_export_file.created_at < MAX_DUREE_CONSERVATION_EXPORT.ago end def ods_export_stale? - !ods_export_file.attached? || ods_export_file.created_at < 3.hours.ago + !ods_export_file.attached? || ods_export_file.created_at < MAX_DUREE_CONSERVATION_EXPORT.ago end def should_generate_export?(format) From ad785278af52904bafe6aaba621c921d3082a224 Mon Sep 17 00:00:00 2001 From: clemkeirua Date: Mon, 21 Oct 2019 17:38:45 +0200 Subject: [PATCH 6/6] add mailer test --- spec/mailers/instructeur_mailer_spec.rb | 14 ++++++++++++++ .../mailers/previews/instructeur_mailer_preview.rb | 4 ++++ 2 files changed, 18 insertions(+) diff --git a/spec/mailers/instructeur_mailer_spec.rb b/spec/mailers/instructeur_mailer_spec.rb index aafaf85d2..ffcda1f25 100644 --- a/spec/mailers/instructeur_mailer_spec.rb +++ b/spec/mailers/instructeur_mailer_spec.rb @@ -46,4 +46,18 @@ RSpec.describe InstructeurMailer, type: :mailer do end end end + + describe '#notify_procedure_export_available' do + let(:instructeur) { create(:instructeur) } + let(:procedure) { create(:procedure, :published, instructeurs: [instructeur]) } + let(:dossier) { create(:dossier, procedure: procedure) } + let(:format) { 'xlsx' } + + context 'when the mail is sent' do + subject { described_class.notify_procedure_export_available(instructeur, procedure, format) } + it 'contains a download link' do + expect(subject.body).to include download_export_instructeur_procedure_url(procedure, :export_format => format) + end + end + end end diff --git a/spec/mailers/previews/instructeur_mailer_preview.rb b/spec/mailers/previews/instructeur_mailer_preview.rb index b7b1c879f..0932eab6a 100644 --- a/spec/mailers/previews/instructeur_mailer_preview.rb +++ b/spec/mailers/previews/instructeur_mailer_preview.rb @@ -37,6 +37,10 @@ class InstructeurMailerPreview < ActionMailer::Preview InstructeurMailer.send_notifications(instructeur, data) end + def notify_procedure_export_available + InstructeurMailer.notify_procedure_export_available(instructeur, procedure, 'xlsx') + end + private def instructeur