Skip to content

Commit

Permalink
chore(hoist-core): update ChangeLog to reflect db changes, and the in…
Browse files Browse the repository at this point in the history
…troduction of new services for admin console grids
  • Loading branch information
jacob-xhio committed Apr 2, 2024
1 parent 2e024e3 commit b304222
Showing 1 changed file with 28 additions and 8 deletions.
36 changes: 28 additions & 8 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,23 +2,43 @@

## 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.
### 💥 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
Expand Down

0 comments on commit b304222

Please sign in to comment.