b1776731-62d7-41a7-882d-6a5b4760db75

Committed 14 May 2024 12:28PM UTC coverage: 79.223% (-16.7%) from 95.9%

Build # b1776731-62d7-41a7-882d-6a5b4760db75

Build Type

push

circleci

Committed by

carolyncole

Commit Message

Adding a submission completion page

fixes #1791

Run Details

9 of 9 new or added lines in 2 files covered. (100.0%)

567 existing lines in 42 files now uncovered.

2692 of 3398 relevant lines covered (79.22%)

60.03 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

68.32

/app/controllers/works_wizard_controller.rb

# frozen_string_literal: true

require "nokogiri"
require "open-uri"

# Controller to handle wizard Mode when editing an work
#
# The wizard flow is shown in the [mermaid diagram here](https://github.com/pulibrary/pdc_describe/blob/main/docs/wizard_flow.md).

class WorksWizardController < ApplicationController
  include ERB::Util
  around_action :rescue_aasm_error, only: [:validate, :new_submission_save]

  before_action :load_work, only: [:edit_wizard, :update_wizard, :attachment_select, :attachment_selected,
                                   :file_upload, :file_uploaded, :file_other, :review, :validate,
                                   :readme_select, :readme_uploaded, :readme_uploaded_payload]

  # GET /works/1/edit-wizard
  def edit_wizard
    @wizard_mode = true
    if validate_modification_permissions(work: @work,
                                         uneditable_message: "Can not edit work: #{@work.id} is not editable by #{current_user.uid}",
                                         current_state_message: "Can not edit work: #{@work.id} is not editable in current state by #{current_user.uid}")

      prepare_decorators_for_work_form(@work)
    end
  end

  # PATCH /works/1/update-wizard
  def update_wizard
    edit_helper(:edit_wizard, work_update_additional_path(@work))
  end

  # Prompt to select how to submit their files
  # GET /works/1/attachment_select
  def attachment_select; end

  # User selected a specific way to submit their files
  # POST /works/1/attachment_selected
  def attachment_selected
    @work.files_location = params["attachment_type"]
    @work.save!

    # create a directory for the work if the curator will need to move files by hand
    @work.s3_query_service.create_directory if @work.files_location != "file_upload"

    if params[:save_only] == "true"
      render :attachment_select
    else
      redirect_to file_location_url
    end
  end

  # Allow user to upload files directly
  # GET /works/1/file_upload
  def file_upload
    @work_decorator = WorkDecorator.new(@work, current_user)
  end

  # POST /works/1/upload-files-wizard (called via Uppy)
  def upload_files
    @work = Work.find(params[:id])
    upload_service = WorkUploadsEditService.new(@work, current_user)
    upload_service.update_precurated_file_list(params["files"], [])
  end

  # POST /works/1/file_upload
  def file_uploaded
    upload_service = WorkUploadsEditService.new(@work, current_user)
    # By the time we hit this endpoint files have been uploaded by Uppy submmitting POST requests
    # to /works/1/upload-files-wizard therefore we only need to delete files here and update the upload snapshot.
    @work = upload_service.snapshot_uppy_and_delete_files(deleted_files_param)

    prepare_decorators_for_work_form(@work)
    if params[:save_only] == "true"
      render :file_upload
    else
      redirect_to(work_review_path)
    end
  rescue => ex
    # Notice that we log the URL (rather than @work.doi) because sometimes we are getting a nil @work.
    # The URL will include the ID and might help us troubleshoot the issue further if it happens again.
    # See https://github.com/pulibrary/pdc_describe/issues/1801
    error_message = "Failed to update work snapshot, URL: #{request.url}: #{ex}"
    Rails.logger.error(error_message)
    Honeybadger.notify(error_message)
    flash[:notice] = "Failed to update work snapshot, work: #{@work&.doi}: #{ex}. Please contact rdss@princeton.edu for assistance."

    redirect_to work_file_upload_path(@work)
  end

  # Allow user to indicate where their files are located in the WWW
  # GET /works/1/file_other
  def file_other; end

  # GET /works/1/review
  # POST /works/1/review
  def review
    if request.method == "POST" || request.method == "PATCH"
      @work.location_notes = params["location_notes"]
      @work.save!
      if params[:save_only] == "true"
        render :file_other
      end
    end
  end

  # Validates that the work is ready to be approved
  # POST /works/1/validate-wizard
  # PATCH /works/1/validate-wizard
  def validate
    @work.submission_notes = params["submission_notes"]
    if params[:save_only] == "true"
      @work.save
      render :review
    else
      @work.complete_submission!(current_user)
      redirect_to work_complete_path(@work.id)
    end
  end

  # Show the user the form to select a readme
  # GET /works/1/readme_select
  def readme_select
    readme = Readme.new(@work, current_user)
    @readme = readme.file_name
  end

  # Hit when the user clicks "Save" or "Next" on the README upload process.
  # Notice that this does not really uploads the file, that happens in readme_uploaded_payload.
  # PATCH /works/1/readme_uploaded
  def readme_uploaded
    readme = Readme.new(@work, current_user)
    if params[:save_only] == "true"
      @readme = readme.file_name
      render :readme_select
    else
      redirect_to work_attachment_select_url(@work)
    end
  end

  # Uploads the README file, called by Uppy.
  # POST /works/1/readme-uploaded-payload
  def readme_uploaded_payload
    readme = Readme.new(@work, current_user)
    readme_file = params["files"].first
    readme_error = readme.attach(readme_file)
    if readme_error.nil?
      render plain: readme.file_name
    else
      # Tell Uppy there was an error uploading the README
      render plain: readme.file_name, status: :internal_server_error
    end
  end

  def file_location_url
    WorkMetadataService.file_location_url(@work)
  end
  helper_method :file_location_url

  private

    def edit_helper(view_name, redirect_url)
      if validate_modification_permissions(work: @work,
                                           uneditable_message: "Can not update work: #{@work.id} is not editable by #{current_user.uid}",
                                           current_state_message: "Can not update work: #{@work.id} is not editable in current state by #{current_user.uid}")
        prepare_decorators_for_work_form(@work)
        if WorkCompareService.update_work(work: @work, update_params:, current_user:)
          if params[:save_only] == "true"
            render view_name
          else
            redirect_to redirect_url
          end
        else
          render view_name, status: :unprocessable_entity
        end
      end
    end

    def load_work
      @work = Work.find(params[:id])
    end

    def patch_params
      return {} unless params.key?(:patch)

      params[:patch]
    end

    def pre_curation_uploads_param
      return if patch_params.nil?

      patch_params[:pre_curation_uploads]
    end

    def deleted_files_param
      deleted_count = (params.dig("work", "deleted_files_count") || "0").to_i
      (1..deleted_count).map { |i| params.dig("work", "deleted_file_#{i}") }.select(&:present?)
    end

    def readme_file_param
      return if patch_params.nil?

      patch_params[:readme_file]
    end

    def rescue_aasm_error
      super
    rescue StandardError => generic_error
      redirect_to root_url, notice: "We apologize, an error was encountered: #{generic_error.message}. Please contact the PDC Describe administrators."
    end

    def redirect_aasm_error(transition_error_message)
      if @work.persisted?
        redirect_to edit_work_wizard_path(id: @work.id), notice: transition_error_message, params:
      else
        redirect_to work_create_new_submission_path(@work), notice: transition_error_message, params:
      end
    end
end

1	# frozen_string_literal: true
2
3	require "nokogiri"	1✔
4	require "open-uri"	1✔
5
6	# Controller to handle wizard Mode when editing an work
7	#
8	# The wizard flow is shown in the [mermaid diagram here](https://github.com/pulibrary/pdc_describe/blob/main/docs/wizard_flow.md).
9
10	class WorksWizardController < ApplicationController	1✔
11	include ERB::Util	1✔
12	around_action :rescue_aasm_error, only: [:validate, :new_submission_save]	1✔
13
14	before_action :load_work, only: [:edit_wizard, :update_wizard, :attachment_select, :attachment_selected,	1✔
15	:file_upload, :file_uploaded, :file_other, :review, :validate,
16	:readme_select, :readme_uploaded, :readme_uploaded_payload]
17
18	# GET /works/1/edit-wizard
19	def edit_wizard	1✔
20	@wizard_mode = true	4✔
21	if validate_modification_permissions(work: @work,	4✔
22	uneditable_message: "Can not edit work: #{@work.id} is not editable by #{current_user.uid}",
23	current_state_message: "Can not edit work: #{@work.id} is not editable in current state by #{current_user.uid}")
24
25	prepare_decorators_for_work_form(@work)	4✔
26	end
27	end
28
29	# PATCH /works/1/update-wizard
30	def update_wizard	1✔
31	edit_helper(:edit_wizard, work_update_additional_path(@work))	3✔
32	end
33
34	# Prompt to select how to submit their files
35	# GET /works/1/attachment_select
36	def attachment_select; end	1✔
37
38	# User selected a specific way to submit their files
39	# POST /works/1/attachment_selected
40	def attachment_selected	1✔
41	@work.files_location = params["attachment_type"]	3✔
42	@work.save!	3✔
43
44	# create a directory for the work if the curator will need to move files by hand
45	@work.s3_query_service.create_directory if @work.files_location != "file_upload"	3✔
46
47	if params[:save_only] == "true"	3✔
UNCOV 48	render :attachment_select	×
49	else
50	redirect_to file_location_url	3✔
51	end
52	end
53
54	# Allow user to upload files directly
55	# GET /works/1/file_upload
56	def file_upload	1✔
57	@work_decorator = WorkDecorator.new(@work, current_user)	1✔
58	end
59
60	# POST /works/1/upload-files-wizard (called via Uppy)
61	def upload_files	1✔
62	@work = Work.find(params[:id])	×
63	upload_service = WorkUploadsEditService.new(@work, current_user)	×
64	upload_service.update_precurated_file_list(params["files"], [])	×
65	end
66
67	# POST /works/1/file_upload
68	def file_uploaded	1✔
69	upload_service = WorkUploadsEditService.new(@work, current_user)	1✔
70	# By the time we hit this endpoint files have been uploaded by Uppy submmitting POST requests
71	# to /works/1/upload-files-wizard therefore we only need to delete files here and update the upload snapshot.
72	@work = upload_service.snapshot_uppy_and_delete_files(deleted_files_param)	1✔
73
74	prepare_decorators_for_work_form(@work)	1✔
75	if params[:save_only] == "true"	1✔
UNCOV 76	render :file_upload	×
77	else
78	redirect_to(work_review_path)	1✔
79	end
80	rescue => ex
81	# Notice that we log the URL (rather than @work.doi) because sometimes we are getting a nil @work.
82	# The URL will include the ID and might help us troubleshoot the issue further if it happens again.
83	# See https://github.com/pulibrary/pdc_describe/issues/1801
UNCOV 84	error_message = "Failed to update work snapshot, URL: #{request.url}: #{ex}"	×
UNCOV 85	Rails.logger.error(error_message)	×
UNCOV 86	Honeybadger.notify(error_message)	×
UNCOV 87	flash[:notice] = "Failed to update work snapshot, work: #{@work&.doi}: #{ex}. Please contact rdss@princeton.edu for assistance."	×
88
UNCOV 89	redirect_to work_file_upload_path(@work)	×
90	end
91
92	# Allow user to indicate where their files are located in the WWW
93	# GET /works/1/file_other
94	def file_other; end	1✔
95
96	# GET /works/1/review
97	# POST /works/1/review
98	def review	1✔
99	if request.method == "POST" \|\| request.method == "PATCH"	3✔
100	@work.location_notes = params["location_notes"]	2✔
101	@work.save!	2✔
102	if params[:save_only] == "true"	2✔
UNCOV 103	render :file_other	×
104	end
105	end
106	end
107
108	# Validates that the work is ready to be approved
109	# POST /works/1/validate-wizard
110	# PATCH /works/1/validate-wizard
111	def validate	1✔
112	@work.submission_notes = params["submission_notes"]	3✔
113	if params[:save_only] == "true"	3✔
UNCOV 114	@work.save	×
UNCOV 115	render :review	×
116	else
117	@work.complete_submission!(current_user)	3✔
118	redirect_to work_complete_path(@work.id)	3✔
119	end
120	end
121
122	# Show the user the form to select a readme
123	# GET /works/1/readme_select
124	def readme_select	1✔
125	readme = Readme.new(@work, current_user)	4✔
126	@readme = readme.file_name	4✔
127	end
128
129	# Hit when the user clicks "Save" or "Next" on the README upload process.
130	# Notice that this does not really uploads the file, that happens in readme_uploaded_payload.
131	# PATCH /works/1/readme_uploaded
132	def readme_uploaded	1✔
133	readme = Readme.new(@work, current_user)	4✔
134	if params[:save_only] == "true"	4✔
UNCOV 135	@readme = readme.file_name	×
UNCOV 136	render :readme_select	×
137	else
138	redirect_to work_attachment_select_url(@work)	4✔
139	end
140	end
141
142	# Uploads the README file, called by Uppy.
143	# POST /works/1/readme-uploaded-payload
144	def readme_uploaded_payload	1✔
UNCOV 145	readme = Readme.new(@work, current_user)	×
UNCOV 146	readme_file = params["files"].first	×
UNCOV 147	readme_error = readme.attach(readme_file)	×
UNCOV 148	if readme_error.nil?	×
UNCOV 149	render plain: readme.file_name	×
150	else
151	# Tell Uppy there was an error uploading the README
UNCOV 152	render plain: readme.file_name, status: :internal_server_error	×
153	end
154	end
155
156	def file_location_url	1✔
157	WorkMetadataService.file_location_url(@work)	6✔
158	end
159	helper_method :file_location_url	1✔
160
161	private	1✔
162
163	def edit_helper(view_name, redirect_url)	1✔
164	if validate_modification_permissions(work: @work,	8✔
165	uneditable_message: "Can not update work: #{@work.id} is not editable by #{current_user.uid}",
166	current_state_message: "Can not update work: #{@work.id} is not editable in current state by #{current_user.uid}")
167	prepare_decorators_for_work_form(@work)	8✔
168	if WorkCompareService.update_work(work: @work, update_params:, current_user:)	8✔
169	if params[:save_only] == "true"	8✔
170	render view_name	1✔
171	else
172	redirect_to redirect_url	7✔
173	end
174	else
UNCOV 175	render view_name, status: :unprocessable_entity	×
176	end
177	end
178	end
179
180	def load_work	1✔
181	@work = Work.find(params[:id])	40✔
182	end
183
184	def patch_params	1✔
185	return {} unless params.key?(:patch)	×
186
187	params[:patch]	×
188	end
189
190	def pre_curation_uploads_param	1✔
191	return if patch_params.nil?	×
192
193	patch_params[:pre_curation_uploads]	×
194	end
195
196	def deleted_files_param	1✔
197	deleted_count = (params.dig("work", "deleted_files_count") \|\| "0").to_i	1✔
198	(1..deleted_count).map { \|i\| params.dig("work", "deleted_file_#{i}") }.select(&:present?)	1✔
199	end
200
201	def readme_file_param	1✔
202	return if patch_params.nil?	×
203
204	patch_params[:readme_file]	×
205	end
206
207	def rescue_aasm_error	1✔
208	super	3✔
209	rescue StandardError => generic_error
210	redirect_to root_url, notice: "We apologize, an error was encountered: #{generic_error.message}. Please contact the PDC Describe administrators."	×
211	end
212
213	def redirect_aasm_error(transition_error_message)	1✔
UNCOV 214	if @work.persisted?	×
UNCOV 215	redirect_to edit_work_wizard_path(id: @work.id), notice: transition_error_message, params:	×
216	else
217	redirect_to work_create_new_submission_path(@work), notice: transition_error_message, params:	×
218	end
219	end
220	end

pulibrary / pdc_describe / b1776731-62d7-41a7-882d-6a5b4760db75

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous