SHS-6056: Dashboard: Importer block: Events

[codechefmarc]

Summary

• Adds event importer information into the dashboard importers block
• Refactors how importer information is retrieved by reworking each importer into a plugin with an interface and base class
• Requires work done over in SHS-6056: Allow external access to Localist API methods SU-SWS/stanford_fields#58 that make some of the Widget methods public. Once merged, in this PR, you can remove the changes in composer.json.

Need Review By (Date)

3/5/2025

Urgency

high

Steps to Test

1. Visit the dashboard for several of the test sites: /admin/dashboard
2. Scroll to the Importers section
3. Verify that there are 2 importers now, People and Events

5. Not all sites will have event imports, but West and History have them
6. Change the importer temporarily: Visit /admin/structure/migrate/localist-events and for one of the importers, add a few different filters
7. Save the config page
8. Go back to the dashboard and refresh
9. Verify that filters are showing up in the list of event importers via a comma separated list

10. Verify that on the base Tugboat instance, there are no importers configured and the messaging exists to tell you so

Review Tasks

Backend / Functional Validation

Code

• Are the naming conventions following our standards?
• Are PHP functions and variables in snake_case and not camelCase?
• Does Drupal code follow Drupal Coding Standards?
• Does the code have sufficient inline comments?
• Is there anything in this code that would be hidden or hard to discover through the UI?
• Are there any code smells?
• Are tests provided?

Code security

• Is all user input properly sanitized when rendered?
• Any obvious security flaws or new areas for attack?

General

• Is there anything included in this PR that is not related to the problem it is trying to solve?
• Is the approach to the problem appropriate?

---

• To see the specific tasks where the Asana app for GitHub is being used, see below:
  • https://app.asana.com/0/0/1209599198048823
  • https://app.asana.com/0/0/1209634321427636

[cienvaras]

@codechefmarc Great work, thanks!

@ahughes3 Ready for you.

[ahughes3]

@cienvaras a few minor updates for this one before merging into the main dashboard branch

• Change the column title Filters to Departments/Groups
• Remove column for Recurring event treatment: This info isn't relevant to the Site Editors as H&S Web team sets the importers up

Would it be possible to also include

• Last imported date
• Number of Imported items
• Number of failed imported items?

[cienvaras]

@ahughes3 "Filters" renamed to "Departments/Groups" and "Recurring event treatment" column removed. Ready for review again.

[ahughes3]

@cienvaras lgtm, approved to move merge into the main dashboard branch