From b304222f9ae1c6869ac9439e3bfca3ef09e9c59e Mon Sep 17 00:00:00 2001
From: Jacob Haddad <jacob@xh.io>
Date: Tue, 2 Apr 2024 09:31:45 -0700
Subject: [PATCH] chore(hoist-core): update ChangeLog to reflect db changes,
 and the introduction of new services for admin console grids

---
 CHANGELOG.md | 36 ++++++++++++++++++++++++++++--------
 1 file changed, 28 insertions(+), 8 deletions(-)

diff --git a/CHANGELOG.md b/CHANGELOG.md
index 678fc0bb..c91a64dd 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -2,14 +2,36 @@
 
 ## 19.0-SNAPSHOT - unreleased
 
-### ⚙️ Technical
+### 🎁 New Features
+
+* New `TrackLogAdminService` and `ClientErrorAdminService` services provide a more bespoke set of methods
+  for querying `TrackLog` and `ClientError` records.
+  * These services utilize HQL criterion to allow for filters posted by the Hoist Admin Console to be applied
+    directly to the server-side query.
+* Client error reports now include `impersonating` field for additional troubleshooting context.
+    * ⚠ NOTE - this requires a new, nullable varchar(50) column be added to the xh_client_error
+      table in your app's configuration database. Review and run the following SQL, or an equivalent
+      suitable for the particular database you are using:
 
-* `ClientError` `JSONFormat` now accepts `impersonating` as a `nullable` field with at most `50` characters.
-* `TrackLog` `JSONFormat` now accepts three new fields:
-  * `appVersion` as a `nullable` field with at most `100` characters
-  * `appEnvironment` as a `nullable` field with at most `100` characters
-  * `url` as a `nullable` field with at most `500` characters
+      ```sql
+      ALTER TABLE `xh_client_error` ADD COLUMN `impersonating` VARCHAR(50) NULL;
+      ```
+* Track log reports now include `appVersion`, `appEnvironment`, and `url`,  fields for additional
+  activity context.
+  * ⚠ NOTE - this requires new, nullable varchar(100), nullable varchar(100), and nullable varchar(500)
+    columns to be added to the xh_track_log table in your app's configuration database for `appVersion`,
+    `appEnvironment`, and `url` respectively. Review and run the following SQL, or an equivalent
+    suitable for the particular database you are using:
+
+    ```sql
+    ALTER TABLE `xh_track_log` ADD COLUMN `appVersion` VARCHAR(100) NULL;
+    ALTER TABLE `xh_track_log` ADD COLUMN `appEnvironment` VARCHAR(100) NULL;
+    ALTER TABLE `xh_track_log` ADD COLUMN `url` VARCHAR(500) NULL;
+    ```
 * `TrackService` now logs `appVersion`, `appEnvironment`, and `url` fields in `TrackLog` records.
+
+### ⚙️ Technical
+
 * `XhController` endpoints `track` and `submitError` now expect to be visited via a `postJSON` request with a
   `JSON` object posted in the `body`. This is pattern is preferred over using a `fetchJSON` request with
   `params` posted in the request header.
@@ -17,8 +39,6 @@
 ### 💥 Breaking Changes
 
 * Requires `hoist-react >= 63.0` for client-side support of the new `track` and `submitError` endpoints.
-* Three new columns added to `xh_track_log` table: `app_version`, `app_environment`, and `url`. These columns
-  are nullable and have a maximum length of `100`, `100`, and `500` characters respectively.
 
 
 ## 18.5.1 - 2024-03-08