7a0688c8-6a53-4d3c-9bea-20dad3bdcbaa

Committed 18 Mar 2025 05:24PM UTC coverage: 96.065% (-0.07%) from 96.13%

Build # 7a0688c8-6a53-4d3c-9bea-20dad3bdcbaa

Build Type

Pull #2052

circleci

Committed by

hectorcorrea

Commit Message

Fixed the work edit page

Pull Request Pull Request #2052: Handle File Upload errors when the Load Balancer blocks the request

Run Details

0 of 2 new or added lines in 2 files covered. (0.0%)

23 existing lines in 1 file now uncovered.

3345 of 3482 relevant lines covered (96.07%)

406.04 hits per line

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

88.68

/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"], [])
    render plain: params["files"].map(&:original_filename).join(",")
  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

  def files_param
    params["files"]
  end

  # Uploads the README file, called by Uppy.
  # POST /works/1/readme-uploaded-payload
  def readme_uploaded_payload
    raise StandardError("Only one README file can be uploaded.") if files_param.empty?
    raise StandardError("Only one README file can be uploaded.") if files_param.length > 1

    readme_file = files_param.first
    readme = Readme.new(@work, current_user)

    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
          # return 200 so the loadbalancer doesn't capture the error
          render view_name
        end
      end
    end

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

    # @note No testing coverage but not a route, not called
    def patch_params
      return {} unless params.key?(:patch)

      params[:patch]
    end

    # @note No testing coverage but not a route, not called
    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

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

pulibrary / pdc_describe / 7a0688c8-6a53-4d3c-9bea-20dad3bdcbaa

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