blacklight-spotlight 5.3.2 → 6.0.0.rc2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 28bd8687f04b835aec548865b73ece402d5cdaa5392117e050e7817d1ce3e650
-  data.tar.gz: 2a37c6d24183a6edfc6f4036e20ceeb077a1715c5e21895300efaa0165459a18
+  metadata.gz: b2ccaa324ed47dd6da8761196f53797ba20acb7f6e4f608bde04232914893355
+  data.tar.gz: dba5c6c8b3321365e3f6e34fcabb02ff602076bc40db8e61d21e2030874af2c3
 SHA512:
-  metadata.gz: e8498080a3e2445c4b14cf50a2df4b6f1df3c657bae2cb15c04142b013aba8bde0811d21d4936a2edfc8b0c76f78898ccfb17d00cc3fc5dced7fada5b99ca56c
-  data.tar.gz: d5827e68e97dd74823ae3319047ae554c2c15cf9f757740112d1f73b9eeae833cb6d9f36846414652c1820809ce1c3e575dd5bfdf50edf7a2de470febcb230e3
+  metadata.gz: 9bc205606b6d53e8550be7eb271ceb3521a26d37c611234eda479a9105d28f59be9b5738ff9543ade508726f80098f76c0d2c5858582e8bd1d590e2982e72969
+  data.tar.gz: 77e04246b8932d4b6a243090f4a56de2375437b988cbc13d96717db70f2979017cf13f004b895da9b2fc850ac1c09d2fc9ed8cd53e3ea51e3517761e96280803

data/README.md

@@ -11,7 +11,7 @@ If you have questions or are interested in contributing, please reach out to the
 
 ## Requirements
 
-- [Ruby](https://www.ruby-lang.org/) 3.2+
+- [Ruby](https://www.ruby-lang.org/) 3.3+
 - [Ruby on Rails](https://rubyonrails.org/) 7.1+
 - Java (11 or greater) *for Solr*
 - [ImageMagick](http://www.imagemagick.org/script/index.php) if using riiif (current default for `config.iiif_service`)
@@ -75,6 +75,27 @@ Go to http://localhost:3000 in your browser.
 
 Spotlight introduces functionality that depends on being able to send emails to exhibit curators and contacts. Be sure to configure your application's environments appropriately (see the Rails Guide for [Action Mailer Configuration](https://guides.rubyonrails.org/v7.2/action_mailer_basics.html#action-mailer-configuration)).
 
+### Cleaning up job trackers
+
+Spotlight records a `Spotlight::JobTracker` row for each background job it runs (reindexing, CSV uploads, bulk updates, and so on) so curators can see the job's progress. These rows are never removed automatically, so the `spotlight_job_trackers` table grows over time.
+
+`Spotlight::CleanupJobTrackersJob` deletes completed job trackers that were last updated longer ago than `Spotlight::Engine.config.reindex_progress_window` (one hour by default). Failed and in-progress job trackers are kept. Spotlight does not enqueue this job itself, so schedule it to run periodically (for example, daily) with whatever scheduler your application uses.
+
+With [Solid Queue](https://github.com/rails/solid_queue), add it to `config/recurring.yml`:
+
+```yaml
+production:
+  cleanup_job_trackers:
+    class: Spotlight::CleanupJobTrackersJob
+    schedule: every day at 3am
+```
+
+Or, with cron:
+
+```sh
+0 3 * * * cd /path/to/app && bin/rails runner -e production 'Spotlight::CleanupJobTrackersJob.perform_later'
+```
+
 See the [Spotlight wiki](https://github.com/projectblacklight/spotlight/wiki) for more detailed information on configuring Spotlight.
 
 ## Translations
@@ -107,7 +128,13 @@ You only need to update `package.json` and prepare/publish the JavaScript packag
 3. Run `npm i --package-lock-only` to update the version in `package-lock.json`
 4. Commit the changes e.g. `git commit -am "Bump version to X.X.X"`
 5. Push the release to rubygems and GitHub: `bundle exec rake release`
-6. Run `npm publish` to push the JavaScript package to https://npmjs.org/package/spotlight-frontend
+6. Log in to npm: `npm login`
+7. You can test the release by running `npm publish --dry-run`. Check the console output to make sure the version number looks correct.
+8. Run `npm publish` to push the JavaScript package to https://npmjs.org/package/spotlight-frontend
+
+For a prerelease (e.g. `6.0.0.rc1` in `version.rb` and `6.0.0-rc.1` in `package.json`), publish with `npm publish --tag next` so the `latest` tag stays on the current stable release.
+
+For a release from a backport branch (e.g. `release-5.x`), publish with `npm publish --tag release-5.x` so it doesn't replace the `latest` tag.
 
 See [Updating the JavaScript bundle](#updating-the-javascript-bundle) above for more details.
 
@@ -115,7 +142,8 @@ See [Updating the JavaScript bundle](#updating-the-javascript-bundle) above for
 
 ### Branches
 
-* The `main` branch is for development of the 5.x series.
+* The `main` branch is for development of the 6.x series.
+* The `5.x` series is on the [release-5.x](https://github.com/projectblacklight/spotlight/tree/release-5.x) branch for backports of features and bug fixes.
 * The `4.x` series is on the [release-4.x](https://github.com/projectblacklight/spotlight/tree/release-4.x) branch for backports of features and bug fixes.
 
 ### Tooling
@@ -193,6 +221,15 @@ The `spec:prepare` task generates css assets for use by the tests. You can delet
 
 Once you are set up, you can also run `rubocop` to enforce consistent coding style.
 
+#### External IIIF resources in JavaScript feature specs
+
+JavaScript feature specs run in a real browser, so WebMock can't intercept the requests it makes. To keep these specs from depending on external IIIF servers:
+
+* The test browser doesn't load images.
+* IIIF manifests are served from fixtures. When a document has a fixture at `spec/fixtures/iiif_manifests/<document_id>.json`, its autocomplete response points at that fixture instead of the live manifest (see `spec/support/iiif_manifest_fixtures.rb`). If a JavaScript spec selects a document that loads its manifest, add a fixture by saving the manifest from the document's `iiif_manifest_url_ssi` URL.
+
+IIIF image `info.json` requests, such as the ones the cropper makes, still go to the image server named in the manifest.
+
 
 ### Individual commands
 
@@ -263,7 +300,7 @@ A brief orientation to this codebase
 #### Frontend Asset Structure
 - **Source JavaScript:** Resides in `app/javascript/spotlight/` (e.g., admin widgets, custom field behaviors).
 - **Core Orchestration:** `app/javascript/spotlight/index.js` listens to page loads and instantiates class components (e.g., `new AddAnother().connect()`).
-- **Standard:** Spotlight prefers standard, modern JavaScript (ES6+) and is migrating away from jQuery dependencies.
+- **Standard:** Spotlight prefers standard, modern JavaScript (ES6+) and does not depend on jQuery.
 
 ## Spotlight Community
 

data/Rakefile

@@ -33,8 +33,6 @@ require 'spotlight/version'
 
 # Build with our opinionated defaults if none are provided.
 rails_options = ENV.fetch('ENGINE_CART_RAILS_OPTIONS', '')
-rails_options = "#{rails_options} -a propshaft" unless rails_options.match?(/-a\s|--asset-pipeline/)
-rails_options = "#{rails_options} -j importmap" unless rails_options.match?(/-j\s|--javascript/)
 rails_options = "#{rails_options} --css bootstrap" unless rails_options.match?(/--css/)
 ENV['ENGINE_CART_RAILS_OPTIONS'] = rails_options
 
@@ -73,6 +71,7 @@ task :ci do
     Rake::Task['spotlight:fixtures'].invoke
     within_test_app do
       system 'bin/rake spec:prepare'
+      abort 'Error running spec:prepare' unless $?.success?
     end
 
     # run the tests