From 581f0fe16597bdf3ebac6eb121e506aac81f1aab Mon Sep 17 00:00:00 2001 From: "Sean R. Abraham" Date: Sat, 21 Dec 2024 13:27:30 -0500 Subject: [PATCH] do some final little bits of "field report" renaming now I really think we're just down to the database level https://github.com/burningmantech/ranger-ims-server/issues/1469 --- CHANGELOG.md | 48 +++++++++++++++++------------------ src/ims/auth/_provider.py | 2 +- src/ims/model/_report.py | 2 +- src/ims/model/json/_report.py | 2 +- src/ims/run/_command.py | 2 +- src/ims/store/_abc.py | 4 +-- 6 files changed, 30 insertions(+), 30 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index abe495b46..dcd9fc6d0 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -39,55 +39,55 @@ Each month below should look like the following, using the same ordering for the ### Changed -- Switched to text-fields with datalists for "Add Ranger" and "Add Incident Types" on the incident page. Previously we used select dropdowns, which were long and cumbersome ([#1292](https://github.com/burningmantech/ranger-ims-server/pull/1292), [#1365](https://github.com/burningmantech/ranger-ims-server/pull/1365)) -- Stopped showing empty locations in the UI as "(?:?)@?", but rather as just an empty string ([#1362](https://github.com/burningmantech/ranger-ims-server/pull/1362)) -- Tightened security on the personnel endpoint, by restricting it to those with at least readIncident permission, and by removing Ranger email addresses from the response ([#1355](https://github.com/burningmantech/ranger-ims-server/pull/1355), [#1317](https://github.com/burningmantech/ranger-ims-server/pull/1317)) -- Made the incidents table load another 2x faster, by not retrieving system-generated report entries as part of that call. This should make the table more responsive too ([#1396](https://github.com/burningmantech/ranger-ims-server/pull/1396)) -- Tweaked the navbar's formatting to align better with Clubhouse ([#1394](https://github.com/burningmantech/ranger-ims-server/pull/1394)) -- On incident page, for a brand-new incident, stopped scrolling down to focus on the "add entry" box. Instead the page will focus on the summary field in that case. ([#1419](https://github.com/burningmantech/ranger-ims-server/pull/1419)) -- Started hiding system-generated incident history by default on the incident page. This can still be toggled by the "show history" checkbox, but the default is now that this is unchecked ([#1421](https://github.com/burningmantech/ranger-ims-server/pull/1421)) +- Switched to text-fields with datalists for "Add Ranger" and "Add Incident Types" on the incident page. Previously we used select dropdowns, which were long and cumbersome https://github.com/burningmantech/ranger-ims-server/pull/1292, https://github.com/burningmantech/ranger-ims-server/pull/1365 +- Stopped showing empty locations in the UI as "(?:?)@?", but rather as just an empty string https://github.com/burningmantech/ranger-ims-server/pull/1362 +- Tightened security on the personnel endpoint, by restricting it to those with at least readIncident permission, and by removing Ranger email addresses from the response https://github.com/burningmantech/ranger-ims-server/pull/1355, https://github.com/burningmantech/ranger-ims-server/pull/1317 +- Made the incidents table load another 2x faster, by not retrieving system-generated report entries as part of that call. This should make the table more responsive too https://github.com/burningmantech/ranger-ims-server/pull/1396 +- Tweaked the navbar's formatting to align better with Clubhouse https://github.com/burningmantech/ranger-ims-server/pull/1394 +- On incident page, for a brand-new incident, stopped scrolling down to focus on the "add entry" box. Instead the page will focus on the summary field in that case. https://github.com/burningmantech/ranger-ims-server/pull/1419 +- Started hiding system-generated incident history by default on the incident page. This can still be toggled by the "show history" checkbox, but the default is now that this is unchecked https://github.com/burningmantech/ranger-ims-server/pull/1421 ### Added -- Added an Incident Type filter to the Incidents page ([#1401](https://github.com/burningmantech/ranger-ims-server/pull/1401)) -- Added full Unicode support to IMS. All text fields now accept previously unsupported characters, like those from Cyrillic, Chinese, emoji, and much more ([#1353](https://github.com/burningmantech/ranger-ims-server/issues/1353)) -- Started doing client-side retries on any EventSource connection failures. This should mean that an IMS web session will be better kept in sync with incident updates, in particular in the off-season, when IMS is running on AWS ([#1389](https://github.com/burningmantech/ranger-ims-server/pull/1389)) -- Added a warning banner to non-production instances of the web UI, to make sure people don't accidentally put prod data into non-production IMS instances. [(#1366](https://github.com/burningmantech/ranger-ims-server/issues/1366)) -- Started showing full datetimes, including time zone, when a user hovers over a time on the incidents page. All times have always been in the user's locale, but this wasn't indicated anywhere ([#1412](https://github.com/burningmantech/ranger-ims-server/pull/1412)) +- Added an Incident Type filter to the Incidents page https://github.com/burningmantech/ranger-ims-server/pull/1401 +- Added full Unicode support to IMS. All text fields now accept previously unsupported characters, like those from Cyrillic, Chinese, emoji, and much more https://github.com/burningmantech/ranger-ims-server/issues/1353 +- Started doing client-side retries on any EventSource connection failures. This should mean that an IMS web session will be better kept in sync with incident updates, in particular in the off-season, when IMS is running on AWS https://github.com/burningmantech/ranger-ims-server/pull/1389 +- Added a warning banner to non-production instances of the web UI, to make sure people don't accidentally put prod data into non-production IMS instances. https://github.com/burningmantech/ranger-ims-server/issues/1366 +- Started showing full datetimes, including time zone, when a user hovers over a time on the incidents page. All times have always been in the user's locale, but this wasn't indicated anywhere https://github.com/burningmantech/ranger-ims-server/pull/1412 ### Removed -- Got rid of Moment.js dependency, as it's deprecated and we're able to use the newer Intl JavaScript browser construct instead ([#1412](https://github.com/burningmantech/ranger-ims-server/pull/1412)) +- Got rid of Moment.js dependency, as it's deprecated and we're able to use the newer Intl JavaScript browser construct instead https://github.com/burningmantech/ranger-ims-server/pull/1412 ### Fixed -- Made incident printouts look much better ([#1382](https://github.com/burningmantech/ranger-ims-server/pull/1382), [#1405](https://github.com/burningmantech/ranger-ims-server/pull/1405)) -- Fixed bug that caused the incident page to reload data multiple times for each incident update ([#1369](https://github.com/burningmantech/ranger-ims-server/issues/1369)) -- Uncovered and resolved some subtle XSS vulnerabilities ([#1402](https://github.com/burningmantech/ranger-ims-server/pull/1402)) +- Made incident printouts look much better https://github.com/burningmantech/ranger-ims-server/pull/1382, https://github.com/burningmantech/ranger-ims-server/pull/1405 +- Fixed bug that caused the incident page to reload data multiple times for each incident update https://github.com/burningmantech/ranger-ims-server/issues/1369 +- Uncovered and resolved some subtle XSS vulnerabilities https://github.com/burningmantech/ranger-ims-server/pull/1402 ## 2024-10 ### Changed -- Resolved IMS's longstanding 6-open-tab limitation, by using a BroadcastChannel to share one EventSource connection between tabs ([#1320](https://github.com/burningmantech/ranger-ims-server/issues/1320), [#1322](https://github.com/burningmantech/ranger-ims-server/pull/1322)) -- Changed login screen to encourage users to log in by email address, rather than by Ranger handle ([#1293](https://github.com/burningmantech/ranger-ims-server/pull/1293)) -- Optimized the API calls that back the incidents endpoint. This speeds up the web UI incidents table load by around 3x ([#1349](https://github.com/burningmantech/ranger-ims-server/pull/1349), [#1324](https://github.com/burningmantech/ranger-ims-server/issues/1324)) +- Resolved IMS's longstanding 6-open-tab limitation, by using a BroadcastChannel to share one EventSource connection between tabs https://github.com/burningmantech/ranger-ims-server/issues/1320, https://github.com/burningmantech/ranger-ims-server/pull/1322 +- Changed login screen to encourage users to log in by email address, rather than by Ranger handle https://github.com/burningmantech/ranger-ims-server/pull/1293 +- Optimized the API calls that back the incidents endpoint. This speeds up the web UI incidents table load by around 3x https://github.com/burningmantech/ranger-ims-server/pull/1349, https://github.com/burningmantech/ranger-ims-server/issues/1324 ### Added -- Added groupings to the "add incident report" dropdown, which emphasize which incident reports are or are not attached to any other incident. This also simplified the sort order for that list ([#1321](https://github.com/burningmantech/ranger-ims-server/pull/1321)) +- Added groupings to the "add Field Report" dropdown, which emphasize which Field Reports are or are not attached to any other incident. This also simplified the sort order for that list https://github.com/burningmantech/ranger-ims-server/pull/1321 ### Fixed -- Stopped using hardcoded 1-hour duration limit on IMS sessions, allowing us to make sessions that will last for a whole shift on playa. ([#1301](https://github.com/burningmantech/ranger-ims-server/pull/1301)) -- Got rid of the browser popup alerts that occurred frequently on JavaScript errors. Instead, error messages will now be written to a text field near the top of each page ([#1335](https://github.com/burningmantech/ranger-ims-server/pull/1335)) +- Stopped using hardcoded 1-hour duration limit on IMS sessions, allowing us to make sessions that will last for a whole shift on playa. https://github.com/burningmantech/ranger-ims-server/pull/1301 +- Got rid of the browser popup alerts that occurred frequently on JavaScript errors. Instead, error messages will now be written to a text field near the top of each page https://github.com/burningmantech/ranger-ims-server/pull/1335 ## 2024-01 ### Added -- Added "Changes you made may not be saved" browser popup when a user might otherwise lose data on incident entries and incident report entries ([#1088](https://github.com/burningmantech/ranger-ims-server/pull/1088)) +- Added "Changes you made may not be saved" browser popup when a user might otherwise lose data on incident entries and Field Report entries https://github.com/burningmantech/ranger-ims-server/pull/1088 ### Fixed -- Do case-insensitive sorting of Ranger handles on incident page ([#1089](https://github.com/burningmantech/ranger-ims-server/pull/1089)) +- Do case-insensitive sorting of Ranger handles on incident page https://github.com/burningmantech/ranger-ims-server/pull/1089 diff --git a/src/ims/auth/_provider.py b/src/ims/auth/_provider.py index 98fdf8de7..5a8ba042b 100644 --- a/src/ims/auth/_provider.py +++ b/src/ims/auth/_provider.py @@ -448,7 +448,7 @@ async def authorizeRequestForFieldReport( Determine whether the user attached to a request has the required authorizations to access the field report with the given number. """ - # An author of the incident report should be allowed to read and write + # An author of the field report should be allowed to read and write # to it, provided they have writeFieldReports on the event. userIsAuthor = False user: IMSUser = request.user # type: ignore[attr-defined] diff --git a/src/ims/model/_report.py b/src/ims/model/_report.py index 8cdd611cb..59cfc2c89 100644 --- a/src/ims/model/_report.py +++ b/src/ims/model/_report.py @@ -17,7 +17,7 @@ ## """ -Incident Report +Field Report """ from collections.abc import Sequence diff --git a/src/ims/model/json/_report.py b/src/ims/model/json/_report.py index ffb6f354e..5eecfa767 100644 --- a/src/ims/model/json/_report.py +++ b/src/ims/model/json/_report.py @@ -15,7 +15,7 @@ ## """ -JSON serialization/deserialization for incident reports +JSON serialization/deserialization for field reports """ from datetime import datetime as DateTime diff --git a/src/ims/run/_command.py b/src/ims/run/_command.py index 6161604d6..17aafc3ae 100644 --- a/src/ims/run/_command.py +++ b/src/ims/run/_command.py @@ -220,7 +220,7 @@ def runCompare(cls, config: Configuration, options: CompareOptions) -> None: if eventDataA.fieldReports != eventDataB.fieldReports: cls.log.error( - "Events incident reports do not match: {event}", + "Events field reports do not match: {event}", event=eventDataA.event, ) diff --git a/src/ims/store/_abc.py b/src/ims/store/_abc.py index 62a2dd3ed..fcf116e37 100644 --- a/src/ims/store/_abc.py +++ b/src/ims/store/_abc.py @@ -317,7 +317,7 @@ async def addReportEntriesToIncident( """ ### - # Incident Reports + # Field Reports ### @abstractmethod @@ -385,7 +385,7 @@ async def addReportEntriesToFieldReport( """ ### - # Incident to Incident Report Relationships + # Incident to Field Report Relationships ### @abstractmethod