Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Blacklight Upgrade #19

Closed
1 task done
crisr15 opened this issue Mar 10, 2023 · 8 comments
Closed
1 task done

Blacklight Upgrade #19

crisr15 opened this issue Mar 10, 2023 · 8 comments
Assignees

Comments

@crisr15
Copy link

crisr15 commented Mar 10, 2023

Testing QA Instructions:

#19 (comment)

Testing on staging:
Staging is: https://oralhistory-test.library.ucla.edu/
UN: & PW for auth are oralhistory
Admin user login (if needed): https://start.1password.com/open/i?a=LTLZ652TT5H5FHMYMASSH7PIXM&v=huuakin4bu4xanlhktv42qheam&i=mcualmilgnczhcga4gkqc4675a&h=scientist.1password.com

Please pay careful attention to the over written partials that are noted in the comment linked above.

Summary

Newest Version of Blacklight is 7.33.1. Blacklight should currently be running 7.10. Running bootstrap 4.6.0.

Related

The app will require a rails upgrade in order to upgrade to the latest blacklight version.
Rails Upgrade Ticket: #18

Acceptance Criteria

  • -Bootstrap is running in the 7.33.1

Notes

Hopefully still at this link: https://github.com/projectblacklight/blacklight/releases?page=6
Version 7.0.0
New features
Bootstrap 4
Rails 5.2 support
Webpacker support
JSON-API support
Solr 7.2 support
Dynamic solr schema by default
Additive configuration projectblacklight/blacklight#1767
Defined properties in the SolrDocument class projectblacklight/blacklight#1659
If you previously had a number of methods in your SolrDocument class like this:
def title
self['title_ssim'].first
end
You can now simplify these by replacing with:

include Blacklight::Solr::Document
attribute :title, Blacklight::Types::String, 'title_tesim'
Bug fixes
if the application name isn't defined in the current language, fallback to the application_name in the default language. projectblacklight/blacklight#1724
Upgrading
Add include Blacklight::DefaultComponentConfiguration to your catalog controller or

configure_blacklight do |config|
config.add_results_document_tool(:bookmark, partial: 'bookmark_control', if: :render_bookmarks_control?)

config.add_results_collection_tool(:sort_widget)
config.add_results_collection_tool(:per_page_widget)
config.add_results_collection_tool(:view_type_group)

config.add_show_tools_partial(:bookmark, partial: 'bookmark_control', if: :render_bookmarks_control?)
config.add_show_tools_partial(:email, callback: :email_action, validator: :validate_email_params)
config.add_show_tools_partial(:sms, if: :render_sms_action?, callback: :sms_action, validator: :validate_sms_params)
config.add_show_tools_partial(:citation)

config.add_nav_action(:bookmark, partial: 'blacklight/nav/bookmark', if: :render_bookmarks_control?)
config.add_nav_action(:search_history, partial: 'blacklight/nav/search_history')

end
Documents are now returned using JSON-API at /catalog/:id.json This only returns fields that are configured using add_show_field. If you want to receive the full Solr document (all fields) in the format they were in in Blacklight 6, you must add the configuration: config.raw_endpoint.enabled = true and the endpoint will be changed to /catalog/:id/raw.json

If you are using Blacklight::Solr::Response directly, note that the options to the initializer have changed. Where previously it took :solr_document_model it now takes a :blacklight_config option.

Partial changes
shared/ajax_modal has moved toshared/modal

Bootstrap 3 to 4 migration guide
For updating your Blacklight application from Bootstrap 3 to 4, please review and contribute to the migration guide.

@summer-cook summer-cook self-assigned this Mar 14, 2023
@summer-cook summer-cook added the blocked Cannot proceed - may be dependent on other work label Mar 14, 2023
@summer-cook
Copy link

summer-cook commented Mar 14, 2023

Currently blocked by rails upgrade ticket:

Image

blacklight 7.33.1 depends on Rails 7

@aprilrieger aprilrieger self-assigned this Mar 17, 2023
@aprilrieger aprilrieger removed the blocked Cannot proceed - may be dependent on other work label Mar 17, 2023
@aprilrieger
Copy link

Making new tickets for updating the overrides

@aprilrieger
Copy link

Checkout my branch:
branch: i18-rails-upgrade-6point1
get .env.development here: https://start.1password.com/open/i?a=LTLZ652TT5H5FHMYMASSH7PIXM&v=huuakin4bu4xanlhktv42qheam&i=ok6rwracafccnhrhur7usyfwoi&h=scientist.1password.com

gem install stack_car -v0.16.0
gem install dory

dory up
sc build
sc up

navigate to http://oralhistory.test/users/sign_in
login: creds in the .env

navigate to http://oralhistory.test/admin

run importer OR run in web container rake db:migrate import[10] [#] <— amount of works you import

Need troubleshooting tips?
If you do a dc down -v, odds are you will want to do a rm -rf tmp/*

@aprilrieger
Copy link

rails upgrade notes:
updated to 5.2 latest
updated to 6.0
updated to 6.1

@aprilrieger aprilrieger changed the title Blacklight Upgrade EPIC - Blacklight Upgrade Mar 20, 2023
@aprilrieger
Copy link

aprilrieger commented Mar 21, 2023

Testing on staging:

Staging is: https://oralhistory-test.library.ucla.edu/
UN: & PW for auth are oralhistory
Admin user login (if needed): https://start.1password.com/open/i?a=LTLZ652TT5H5FHMYMASSH7PIXM&v=huuakin4bu4xanlhktv42qheam&i=mcualmilgnczhcga4gkqc4675a&h=scientist.1password.com

  • app/views/catalog/_constraints.html.erb
  • app/views/catalog/_email_form.html.erb
  • app/views/catalog/_facet_layout.html.erb
  • app/views/catalog/_facets.html.erb
  • app/views/catalog/_home_text.html.erb
  • app/views/catalog/_index.html.erb
  • app/views/catalog/_search_form.html.erb
  • app/views/catalog/_search_results.html.erb
  • app/views/catalog/_show_tools.html.erb
  • app/views/catalog/_start_over.html.erb
  • app/views/catalog/show.html.erb
  • app/views/search_history/index.html.erb
  • app/views/shared/_header_navbar.html.erb
  • app/models/search_builder.rb
  • app/controllers/concerns/blacklight/bookmarks.rb
  • app/services/blacklight/field_retriever.rb
  • All full_text blacklight partials
  • All interviewee blacklight partials

@aprilrieger aprilrieger changed the title EPIC - Blacklight Upgrade Blacklight Upgrade Mar 21, 2023
@aprilrieger aprilrieger mentioned this issue Mar 21, 2023
21 tasks
@DiemBTran
Copy link

blocked for QA until we hear back from John re http basic auth env variables getting set in the deploy

@DiemBTran DiemBTran added blocked Cannot proceed - may be dependent on other work and removed blocked Cannot proceed - may be dependent on other work labels Mar 28, 2023
@DiemBTran
Copy link

This passes SoftServ QA. Mobbed with April and Kirk to check each of the partials that was updated in this comment.

@aprilrieger
Copy link

Image

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Done
Development

No branches or pull requests

4 participants