SHS-5980: Dashboard: Notifications/Announcements to Site Editors

[codechefmarc]

Summary

• Adds a new dashboard block to show announcements. Data comes from a Google Sheets document.

Need Review By (Date)

2025-02-12

Urgency

low

Steps to Test

1. Login to the site as a Developer
2. Edit the dashboard layout by going to the Dashboard (/admin/dashboard) and clicking on "+ Edit Layout"
3. Click "Add Block"
4. Add a block of type "HSDP Announcements"

6. Click "Add Block"
7. Verify there is data coming from the Google Sheet (specified in ClickUp) and the table is sorted by date (descending), and contains titles and descriptions.
8. Verify that the titles are bolded and markdown links are converted to HTML

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?

[cienvaras]

@codechefmarc Looks pretty good, there are just a couple of things I want you to check:

• Left a comment in the code about a duplicated function call
• In my tests, the changes in the Google sheet were almost instantly available in the block. Can you please confirm that the cache is working as expected?

[codechefmarc]

@cienvaras - Fixed the duplicate call and reworked caching so the table data itself is cached for 2 minutes.

[cienvaras]

@codechefmarc Thanks for the fixes! I still have a question and a minor change request, please check the inline comments.

[cienvaras]

@codechefmarc LGTM! Thanks for the fixes.

@ahughes3 Ready for you to review.

[ahughes3]

@codechefmarc @dalin- In reviewing with the team we would like to remove the "Title" column and rename "Description" to "Update"

Date and Update should be the only columns that are displayed on the dashboard.

I've updated the sheet with the actual updates that we want to display.

On the Google Sheet In the cells that have links there is a message that says - "This cell's contents violate its validation rule", they display correctly on the dashboard but just wanted to see if this would be an issue

[dalin-]

@ahughes3

On the Google Sheet In the cells that have links there is a message that says - "This cell's contents violate its validation rule", they display correctly on the dashboard but just wanted to see if this would be an issue

That's a data validation rule to show a warning if the content is > 150 characters. AFAICT it should be showing you "Please keep content within 150 characters" rather than that very technical warning. Also, once you throw a link in there that'll easily eat up another 50 chars, so I increased it to 200.

[codechefmarc]

@ahughes3 - I've made those changes to the table and is viewable on Tugboat.

[ahughes3]

approved to be merged into the main dashboard PR but left some additional notes in the PR