Changelog

26.0-SNAPSHOT - unreleased

💥 Breaking Changes (upgrade difficulty: 🟢 TRIVIAL - change to runOnInstance signature.)

🎁 New Features

BaseController.runOnInstance now performs the json serialization on the target instance. This allows lighter-weight remote endpoint executions, that do not require object serialization. Applications must now provide a ClusterJsonRequest to this method rather than a ClusterRequest

⚙️ Technical

Align all-built in log names to have form "App-Cluster-xxx.log"

25.0.0 - 2024-11-15

💥 Breaking Changes (upgrade difficulty: 🟢 LOW)

Dynamic configuration for distributed hazelcast objects is no longer supported -- all configuration must be in place before an instance is started, per Hazelcast documentation. Therefore the ClusterService.configureXXX methods have been removed, and have been replaced by support for specifying a static closure ClusterService.configureCluster. This is not expected to have a practical impact on any existing applications.

🐞 Bug Fixes

Fix to issue with a Timer interval specified as a config names failing to update dynamically.

⚙️ Technical

Increased max length of Role.category string to 100 chars.
Requires column modification to xh_role table with the following SQL or equivalent:

-- MySQL
ALTER TABLE `xh_role` CHANGE COLUMN `category` `category` VARCHAR(100) null

-- SQL Server
ALTER TABLE xh_role ALTER COLUMN category VARCHAR(100) null

24.0.0 - 2024-10-17

💥 Breaking Changes (upgrade difficulty: 🟢 LOW - Hoist React update)

Requires hoist-react >= 69 to support revised API for Activity Tracking and User Preference POSTs from client.

🎁 New Features

Updated Activity Tracking endpoint to support client POSTing multiple track logs in a single request, helping to reduce network overhead for chatty apps.
Improved the handling of track log timestamps - these can now be supplied by the client and are no longer bound to insert time of DB record. Latest Hoist React uses start of the tracked activity.
Support for persisting of memory monitoring results
New built-in monitor xhClientErrorsMonitor
New methods MonitorResult.getParam and MonitorResult.getRequiredParam

⚙️ Technical

Updated behavior of withInfo and withDebug log utils to print a "started" message if logging enabled at DEBUG or TRACE, respectively. Allows admins to see start messages for more important withInfo logs, without necessarily printing both lines for all withDebug calls.

23.0.0 - 2024-09-27

💥 Breaking Changes (upgrade difficulty: 🟢 LOW)

Improvements to the efficiency of CachedValue for sharing of large objects. This included moving to its own package io.xh.hoist.cachedvalue for clarity.
New dynamic configuration for all distributed hazelcast objects. See methods ClusterService.configureXXX. These methods replace the static map BaseService.clusterConfigs.

🎁 New Features

Misc. improvements to logging and performance of Cache and Timer.
New configuration property hoist.sensitiveParamTerms allows customization of environment variables to be obscured in the admin client.

22.0.0 - 2024-09-18

💥 Breaking Changes (upgrade difficulty: 🟢 LOW)

Updated Timer, Cache, and CachedValue objects to require a name property. Names are now mandatory to better support new cluster features, logging, and Admin Console tooling.
Migrated BaseService methods getIMap(), getReplicatedMap() and getISet() to createIMap(), createReplicatedMap() and createISet(), respectively. Not expected to impact most apps, as these APIs are new and only used for distributed, multi-instance data.

🎁 New Features

Added new BaseService factories to create Cache and CachedValue objects. This streamlined interface reduces boilerplate and is consistent with Timer creation.
Improved Timer to maintain consistent execution timing across primary instance changes.
Improved RestController to support domain objects linked to a non-primary DataSource.

⚙️ Technical

Enhanced the xh/environmentPoll payload to include any active Alert Banner spec. Clients running hoist-react >= 68 will leverage this to avoid an extra polling request.
Exposed /xh/ping as whitelisted route for basic uptime/reachability checks. Retained legacy /ping alias, but prefer this new path going forward.
Improved handling + rendering of exceptions during authentication and authorization requests.
Updated ClusterService to use Hoist's InstanceNotFoundException, ensuring that common errors thrown due to instance changes are marked as routine and don't spam error reporting.
Added new BaseService.resources property to track and provide access to Cache objects and Timers by name, replacing BaseService.timers.

21.0.1 - 2024-09-05

🐞 Bug Fixes

Resolved issue where connected clients would not display the upgrade prompt banner when an app was first released with an update to hoist-core >= 21.0.0.

⚙️ Technical

Improved serialization efficiency of replicated Cache and CachedValue.

21.0.0 - 2024-09-03

💥 Breaking Changes (upgrade difficulty: 🟢 LOW - latest Hoist React + DB col additions)

Requires hoist-react >= 67.0.0.
Requires minor DB schema additions (see below).
ReplicatedValue has been replaced with the enhanced CachedValue. This new object provides all the functionality of the old, plus additional features from the Cache API such as expiry, getOrCreate(), event support, and blocking support for non-primary nodes.
Migrated previous xhAppVersionCheck to new xhEnvPollConfig, which now governs a single polling interval on the client to check for app version and connected instance changes. The previous config's mode value will be automatically migrated to the new onVersionChange key. A shorter default interval of 10s will be set in all cases, to ensure timely detection of instance changes.
The /xh/environment endpoint is no longer whitelisted and requires / will trigger authentication flow.

🎁 New Features

Client error reports include new correlationId field.
- ⚠ NOTE - this requires a new column in the xh_client_error table. Review and run the following SQL, or an equivalent suitable for the particular database you are using:
```
ALTER TABLE `xh_client_error` ADD COLUMN `correlation_id` VARCHAR(100) NULL;
```
Activity tracking logs include new correlationId field.
- ⚠ NOTE - this requires a new column in the xh_track_log table. Review and run the following SQL, or an equivalent suitable for the particular database you are using:
```
ALTER TABLE `xh_track_log` ADD COLUMN `correlation_id` VARCHAR(100) NULL;
```
Cache and the (new) CachedValue provide a new common API for (potentially replicated) state in services. In particular the following new features are included with common API:
- Dynamic expiry of values via fluid api
- New event handling via addChangeHandler
- Improved trace logging of value serialization
- Offers both replicated and non-replicated modes
New instance aware methods on BaseController: runOnInstance, runOnPrimary and runOnAllInstances. These were formerly on BaseClusterController, which has been removed.
New LdapService.authenticate() API supports a new way to validate a domain user's credentials by confirming they can be used to bind to a configured LDAP server.

🐞 Bug Fixes

Fixed bug where a role with a dot in its name could not be deleted.

⚙️ Technical

LdapService now binds to configured servers with TLS and supports new skipTlsCertVerification flag in its config to allow for self-signed or otherwise untrusted certificates.

20.4.0 - 2024-07-31

🐞 Bug Fixes

Fixed sporadic serialization errors on status monitor results with an attached exception.
Added configurable table name to xhDbConnectionMonitor status check to support edge case where XH tables are in a custom schema.

⚙️ Technical

Support for bulk updating of Role categories.

20.3.1 - 2024-07-23

🐞 Bug Fixes

Simplified the xhDbConnectionMonitor query to work with more SQL dialects.

20.3.0 - 2024-07-16

⚙️ Technical

Improvements to the ability to configure Hibernate 2nd-level caches. See ClusterConfig for more information.

20.2.1 - 2024-07-09

⚙️ Technical

Remove obsolete, non-functioning GSP support from EmailService.

🐞 Bug Fixes

Fix to regression with LdapObject subclasses not fully populating all keys/properties.

20.2.0 - 2024-06-26

⚙️ Technical

Common LDAP attributes cn, displayname, mail, and name moved to LdapObject class.
Websockets are now enabled by default. To disable, add hoist.enableWebSockets = false to your project's application.groovy file (note the lowercase "a" to ensure you have the correct one).

20.1.0 - 2024-06-21

🎁 New Features

LdapService.searchOne and searchMany methods have been made public.
LdapPerson class now includes displayName, givenname, and sn fields.

🐞 Bug Fixes

LdapPerson class email field changed to mail to match LDAP attribute.

20.0.2 - 2024-06-05

🐞 Bug Fixes

BaseProxyService now correctly handles responses without content.
BaseProxyService now properly supports caching the underlying HttpClient between requests. This defaults to false to reflect current behavior, but may be overridden to enable.

⚙️ Technical

Removed obsolete BaseAuthenticationService.whitelistFileExtensions

20.0.1 - 2024-05-21

🐞 Bug Fixes

Restored routing of status monitor logging to dedicated file.

20.0.0 - 2024-05-17

🎁 New Features

Hoist now fully supports multi-instance, clustered deployments!

Hoist Core v20 provides support for running multi-instance clusters of Hoist application servers. Cluster management is powered by Hazelcast, an open-source library providing embedded Java support for inter-server communication, co-ordination, and data sharing.

See the new ClusterService.groovy service, which provides the clustering implementation and main API entry point for accessing the cluster.

Many apps will not need to implement significant changes to run with multiple instances. Hoist will setup the cluster, elect a primary instance, provide cluster-aware Hibernate caching and logging, and ensure cross-server consistency for its own APIs.

However, complex applications -- notably those that maintain significant server-side state or use their server to interact within external systems -- should take care to ensure the app is safe to run in multi-instance mode. Distributed data structures (e.g. Hazelcast Maps) should be used as needed, as well as limiting certain actions to the "primary" server.

Please contact XH to review your app's readiness for multi-instance operation!

Other new features

New support for reporting service statistics for troubleshooting/monitoring. Implement BaseService.getAdminStats() to provide diagnostic metadata about the state of your service. Output (in JSON format) can be easily viewed in the Hoist Admin Console.
New DefaultMonitorDefinitionService provides default implementations of several new status monitors to track core app health metrics. Extend this new superclass in your app's MonitorDefinitionService to enable support for these new monitors.
Includes new support for dynamic configuration of client-side authentication libraries. See new method Authentication.getClientConfig().

💥 Breaking Changes (upgrade difficulty: 🟠 MEDIUM / 🟢 LOW for apps with minimal custom server-side functionality)

Requires hoist-react >= 64.0 for essential Admin Console upgrades.
Requires updated gradle.properties to specify hazelcast.version=5.3.x. Check hoist-core or Toolbox at time of upgrade to confirm exact recommended version.

Requires column additions to three xh_ tables with the following SQL or equivalent:

    ALTER TABLE `xh_client_error` ADD COLUMN `instance` VARCHAR(50) NULL;
    ALTER TABLE `xh_track_log` ADD COLUMN `instance` VARCHAR(50) NULL;
    ALTER TABLE `xh_monitor` ADD COLUMN `primary_only` BIT NOT NULL DEFAULT 0;

On MSSQL, the last column can be added with:

    ALTER TABLE xh_monitor ADD COLUMN primary_only BIT DEFAULT 0 NOT NULL;

Apps can configure their HZ cluster by defining a ClusterConfig class:
- This should extend io.xh.hoist.ClusterConfig and be within your primary application package (xhAppPackage in gradle.properties - e.g. io.xh.toolbox.ClusterConfig).
- We recommend placing it under /grails-app/init/ - see Toolbox for an example.
- Note XH clients with enterprise ("mycompany-hoist") plugins may have their own superclass which should be extended instead to provide appropriate defaults for their environment. Note that an app-level class is required in this case to pick up those defaults, although it will commonly not require any additional app-level overrides.
Apps that intend to run with more than one server must enable sticky sessions when routing clients to servers. This is critical for the correct operation of authentication and websocket communications. Check with XH or your networking team to ensure this is correctly configured.
Server-side events raised by Hoist are now implemented as cluster-wide Hazelcast messages rather than single-server Grails events. Any app code that listens to these events via BaseService.subscribe must update to BaseService.subscribeToTopic. Check for:
- xhClientErrorReceived
- xhConfigChanged
- xhFeedbackReceived
- xhMonitorStatusReport
The exceptionRenderer singleton has been simplified and renamed as xhExceptionHandler. This change was needed to better support cross-cluster exception handling. This object is used by Hoist internally for catching uncaught exceptions and this change is not expected to impact most applications.
Utils.dataSource now returns a reference to the actual javax.sql.DataSource.DataSource. Use Utils.dataSourceConfig to access the previous return of this method (DS config, as a map).

Apps must replace the buildProperties.doLast block at the bottom of their build.gradle with:

tasks.war.doFirst {
   File infoFile = layout.buildDirectory.file('resources/main/META-INF/grails.build.info').get().asFile
   Properties properties = new Properties()
   infoFile.withInputStream {properties.load(it)}
   properties.putAll(hoistMetaData)
   infoFile.withOutputStream {properties.store(it, null)}
}

🐞 Bug Fixes

Calls to URLs with the correct controller but a non-existent action were incorrectly returning raw 500 errors. They now return a properly JSON-formatted 404 error, as expected.

⚙️ Technical

All Throwables are now serialized to JSON using Hoist's standard customization of Jackson.

📚 Libraries

Please ensure you review and update your gradle.properties and gradle-wrapper.properties files.

In gradle.properties (partial contents of this file, with updated libraries only):

groovyVersion=3.0.21
grailsVersion=6.2.0
grailsGradlePluginVersion=6.2.0
gormVersion=8.1.0
grailsHibernatePluginVersion=8.1.0
hazelcast.version=5.3.7

In /gradle/wrapper/gradle-wrapper.properties (note your app might have an internal artifact repo in place of services.gradle.org - leave that as-is, updating the version only to 7.6.4):

distributionUrl=https\://services.gradle.org/distributions/gradle-7.6.4-bin.zip

19.0.0 - 2024-04-04

💥 Breaking Changes (upgrade difficulty: 🟢 LOW - latest Hoist React + DB col additions)

Requires hoist-react >= 63.0 for client-side changes to accommodate updated track and submitError APIs. See below for database column additions to support the same.
Implementations of DefaultRoleService.doLoadUsersForDirectoryGroups will need to handle a new strictMode flag provided as a second argument.

🎁 New Features

Client error reports include a new impersonating field for additional troubleshooting context.
- ⚠ NOTE - this requires a new column in the xh_client_error table. Review and run the following SQL, or an equivalent suitable for the particular database you are using:
```
ALTER TABLE `xh_client_error` ADD COLUMN `impersonating` VARCHAR(50) NULL;
```
Activity tracking logs include new appVersion, appEnvironment and url fields.
- ⚠ NOTE - this requires new columns in the xh_track_log table. Review and run the following SQL, or an equivalent suitable for the particular database you are using:
```
ALTER TABLE `xh_track_log` ADD COLUMN `app_version` VARCHAR(100) NULL;
ALTER TABLE `xh_track_log` ADD COLUMN `app_environment` VARCHAR(100) NULL;
ALTER TABLE `xh_track_log` ADD COLUMN `url` VARCHAR(500) NULL;
```

⚙️ Technical

DefaultRoleService has improved error handling for failed directory group lookups.
LdapService bulk lookup methods now provide a strict option to throw if a query fails rather than quietly returning an empty result.
New TrackLogAdminService and ClientErrorAdminService services provide improved APIs for querying TrackLog and ClientError records. Leveraged by updated Hoist Admin Console to post selected filters to the server and return more relevant data within configured row limits.

18.5.2 - 2024-04-03

🐞 Bug Fixes

Fixed bug in DefaultRoleService.doLoadUsersForDirectoryGroups where LDAP members with null samAccountNames were not being filtered out, causing NullPointerExceptions.

18.5.1 - 2024-03-08

⚙️ Technical

Quiet log warnings from LdapNetworkConnection in LdapService by setting the LdapNetworkConnection log level to ERROR.

18.5.0 - 2024-03-08

💥 Breaking Changes (upgrade difficulty: 🟢 TRIVIAL)

Method DefaultRoleService.ensureUserHasRoles has been renamed to assignRole. The new name more clearly describes that the code will actually grant an additional role to the user.

🐞 Bug Fixes

Fixed LdapService bug where querying multiple servers with same host yielded incomplete results.

18.4.0 - 2024-02-13

🎁 New Features

InstanceConfigUtils - used to read low-level configuration values such as database credentials - will now search for an environment variable with a matching name and return that value if it exists.
- This can either override or entirely replace the use of a yaml file or Kubernetes secrets to specify this kind of configuration.
- To help namespace app-specific environment variables while also maintaining the conventions of instance configs having camelCase identifiers and environment variables having UPPER_SNAKE_CASE identifiers, InstanceConfigUtils will convert and prepend APP_[APP_CODE]_ to the requested key when looking for an environment variable. For example, in our Toolbox demo app InstanceConfigUtils.getInstanceConfig('dbUrl') will check if an environment variable named APP_TOOLBOX_DB_URL exists, and return its value if so.
ConfigService methods now return override values from an instance config, if one exists with the same name as an app config.
- Allows an instance-specific value specified via a yaml file or environment variable to override the config value saved to the app's database, including configs used by Hoist itself.
- Update to hoist-react >= 60.2 for an Admin Console upgrade that checks for and clearly indicates any overridden values in the Config editor tab.
EnvAdminController now obfuscates environment variables ending with password and similarly sensitive strings.

18.3.2 - 2024-02-01

🐞 Bug Fixes

Fixed bug in LdapService.lookupUser where queries were not being formed correctly.

18.3.1 - 2024-01-30

🐞 Bug Fixes

Fixed bug in DefaultRoleService where not all effective roles were being returned for a user.

18.3.0 - 2024-01-29

🎁 New Features

DefaultRoleService now includes support for out-of-the-box LDAP groups.

⚙️ Technical

Refactor DefaultRoleService for more efficient and straightforward role/user resolution
Normalize role member usernames to lowercase and generally tighten up case-insensitive handling.

18.2.1 - 2024-01-25

🐞 Bug Fixes

Fixed DefaultRoleService unintended case-sensitive handling of usernames.

18.2.0 - 2024-01-24

🎁 New Features

Added new LdapService to provide out-of-the-box support for querying LDAP groups and users via the Apache Directory library.
Ådded ConfigService.hasConfig() method to check if a config exists.

18.1.0 - 2024-01-18

🎁 New Features

Improved handling of requests during application initialization. HTTP requests received during App startup will now yield clean "App Initializing" Exceptions. This is an improvement over the current behavior where attempting to service requests prematurely can cause arbitrary and misleading exceptions.
Misc. Improvements to DefaultRoleService API and documentation.

18.0.1 - 2024-01-16

🐞 Bug Fixes

Fixed an issue preventing the creation of new roles.

18.0.0 - 2024-01-12

🎁 New Features

New support for Role Management.
- Hoist now supports an out-of-the-box, database-driven system for maintaining a hierarchical set of roles and associating them with individual users.
- New system supports app and plug-in specific integrations to AD and other enterprise systems.
- Hoist-react v60 is now required and will provide an administrative UI to visualize and manage the new role system.
- See DefaultRoleService for more information.

⚙️ Technical

Add xh/echoHeaders utility endpoint. Useful for verifying headers (e.g. jespa_connection_id) that are installed by or must pass through multiple ingresses/load balancers.
Remove HTML tag escaping when parsing alert banner create/update request JSON.

💥 Breaking Changes

Applications will typically need to adjust their implementation of BaseRoleService. Most applications are expected to adopt the new provided DefaultRoleService, and may be required to migrate existing code/data to the new API. Applications that wish to continue to use a completely custom BaseRoleService will need to implement one additional method: getUsersForRole.

17.4.0 - 2023-11-09

⚙️ Technical

Improvement to BaseProxyService to better handle exceptions during streaming.
Optimization to WebSocketService to remove an extra layer of async task wrapping when pushing to a single channel.

🐞 Bug Fixes

Workaround for GORM issue with unconstrained findAll() and list() breaking eager fetching. See grails/gorm-hibernate5#750.

17.3.0 - 2023-09-18

⚙️ Technical

New ConfigService.setValue() API supports programmatic updates to existing app configs.

17.2.0 - 2023-08-17

🎁 New Features

Lightweight monitoring collection of JDBC connection pool statistics, including counters for active vs idle connections. Viewable in Hoist Admin Console for apps on hoist-react >= 59.0.

17.1.0 - 2023-08-08

⚙️ Technical

Additional improvements to support hot-reloading.

17.0.0 - 2023-07-27

This release upgrades Hoist to the latest 6.0.0 version of Grails and upgrades related libraries. It should be fully compatible with Java 11 and Java 17.

🎁 New Features

This version of Hoist restores the ability to do development-time reloading via the java hotswap agent. See the readme for more information.

⚙️ Technical

The implementation of the LogSupport trait has been simplified, such that it no longer requires an @SLF4J annotation, or log property to be provided. Undocumented and problematic methods logXXXInBase were removed.

📚 Libraries

grails 5.3.2 → 6.0.0
gorm 7.3.2 → 8.0.0
groovy 3.0.9 → 3.0.11

16.4.4 - 2023-08-03

🐞 Bug Fixes

Replace bullet points with hyphens in default xhAppVersionCheck config.

16.4.3 - 2023-08-02

🐞 Bug Fixes

Remove one remaining smart quote to make default notes in default config safer for all DBs.

16.4.2 - 2023-07-31

🐞 Bug Fixes

Make default notes in default config safer for all DBs by removing smart quotes.

16.4.1 - 2023-07-13

🐞 Bug Fixes

Make impersonation service more robust for applications with dynamic/lazy user generation.
Additional validation of parameters to '/userAdmin/users' endpoint.

16.4.0 - 2023-07-07

🎁 New Features

Added new logData option to TrackService.track() - allows applications to request that key/value pairs provided within the data block of a track statement be logged along with the standard output. Client-side support for this feature on a per-call basis added in hoist-react >= 57.1, can also be defaulted within the xhActivityTrackingConfig app config.
Deprecated config xhAppVersionCheckEnabled in favor of object based xhAppVersionCheck. Apps will migrate the existing value to this new config's mode flag. This supports the new forceRefresh mode introduced in hoist-react v58.

16.3.0 - 2023-06-20

🎁 New Features

Added support for saving alert banner presets (requires hoist-react >= 57.0.0 to use this new functionality, but backwards compatible with earlier hoist-react releases).
Defined new HOIST_IMPERSONATOR role to control access to Hoist's user-impersonation feature.
- This new role is inherited by HOIST_ADMIN (the role previously required) by default, although applications can override BaseUserService.getRolesForUser() to customize.
- Applications that have already overridden this method will need to re-implement this role inheritance, or assign the new role to appropriate users directly.
Exposed new BaseUserService.impersonationTargetsForUser() template method to allow apps to customize the list of users that an admin can impersonate.
Added support for OWASP-encoding user submitted strings to BaseController via a new safeEncode() method and a new safeEncode option to parseRequestJSON() and parseRequestJSONArray().
- Apps are encouraged to run any user-provided inputs through this method to prevent XSS attacks.

16.2.0 - 2023-05-26

🎁 New Features

Added new BaseController methods parseRequestJSON() and parseRequestJSONArray().
- These methods are the recommended way to parse JSON from a request body - they will use Hoist's optimized, Jackson-based JSONParser.
Created new xhExpectedServerTimeZone app config, now read at startup to validate that the server is running in a particular, application-configured time zone.
- Default value of * will skip validation but log a warning that no zone is configured.
- If a zone is configured, Hoist will throw a fatal exception if it does not match the zone reported by Java.
- Most applications should ensure that this config and the runtime JVM are set to the same time zone as their primary database.
Added h2Config method to RuntimeConfig class to give apps the option of starting up with an H2 in-memory DB. This is intended for projects in their earliest, "just checked out, first run" stage, when a developer wants to get started before having set up an external database.
Updated AlertBannerService to append the environment name when creating/updating the JsonBlob used to persist banner state in a non-production environment. This better supports apps where e.g. Beta and Production environments share a database, but should display distinct banners.
Added support for the caseSensitive flag in log filtering endpoint.

🐞 Bug Fixes

Fixed a regression preventing the culling of snapshots in the memory monitoring service.

16.1.0 - 2023-04-14

Enhance MemoryMonitoringService.
- Produce and use more appropriate usage metric (used/max)
- Produce GC statistics
- Support for taking a heap dump

16.0.1 - 2023-03-29

🐞 Bug Fixes

Fixed a regression with 404 errors being incorrectly handled and not serialized as JSON.

16.0.0 - 2023-03-24

🎁 New Features

EmailService.sendEmail() now supports the attachments argument, for attaching one or more files to the email.
A new xhActivityTrackingConfig soft-configuration entry will be automatically created to control the behavior of built-in Activity Tracking (via TrackService).
- Most notably, the size of any data objects included with track log entries will be constrained by this config, primarily to constrain memory usage when querying and serializing large numbers of log entries for the Admin Console.
- Any track requests with data objects exceeding this length will be persisted, but without the requested data.

💥 Breaking Changes

Removed support for "local" preferences - any existing prefs previously marked as local will now work like all others, with their values persisted on the server.
- Apps upgrading to this Core release should simultaneously upgrade to Hoist React v56, which will automatically post any existing local preference values to the server.
- Alternatively, update client-side code to use browser local storage for persisting user state that should remain tightly bound to a particular computer.
- Update the schema to set xh_preference table's local column to allow nulls. If this is not done, a Hibernate error (local column cannot be null) will be thrown when an admin tries to add a new preference to the app.
```
alter table xh_preference alter column local bit null
```
- Once they are sure no rollback is needed, apps can safely delete the xh_preference table's local column.
```
alter table xh_preference drop column local
```
Grails has been updated to 5.3.2. While this change did not itself introduce any breaking changes, applications should update their Grails version within gradle.properties to match.

🐞 Bug Fixes

Client Error timestamps will now correctly reflect the exact time the error was received on the server rather than the time the error was bulk processed by the server.

📚 Libraries

grails 5.2.1 → 5.3.2

15.0.0 - 2022-12-5

🎁 New Features

Version 15 includes changes to support more flexible logging of structured data:

The bulk of Hoist conventions around log formatting have been moved from LogSupport to a new log converter -- LogSupportConverter. This allows applications to more easily and fully customize their log formats by specifying custom converters.
LogSupport should still be the main entry point for most application logging. This class provides the support for enhanced meta data-handling as well as some important APIs - e.g. withDebug() and withInfo().
Applications are now encouraged to provide LogSupport methods with data in Map form. Provided converters will serialize these maps as appropriate for target logs.
Hoist's LogSupportConverter is intended for easy reading by humans, allows specifying keys that should disappear in the final output with an _ prefix. This is useful for keys that are obvious, e.g. [_status: 'completed', rows: 100] logs as 'completed' | rows=100.
Alternatively, applications may now specify custom converters that preserve all keys and are more appropriate for automatic processing (e.g. splunk). An example of such a converter is CustomLogSupportConverter which can be found in the Toolbox project.
By default, Hoist now also logs the time in millis when a log message occurred.

14.4.2 - 2022-11-14

⚙️ Technical

Improved the signatures of LogSupport methods withInfo (and similar) to pass through the return type of their closure argument.

14.4.1 - 2022-10-24

🐞 Bug Fixes

Allow database connection info to viewed by users with role: HOIST_ADMIN_READER and higher.

14.4.0 - 2022-10-19

🎁 New Features

The Hoist Admin Console is now accessible in a read-only capacity to users assigned the new HOIST_ADMIN_READER role.
The pre-existing HOIST_ADMIN role inherits this new role, and is still required to take any actions that modify data.
Requires hoist-react >= 53.0 for client-side support of this new readonly role.

14.3.1 - 2022-10-10

⚙️ Technical

Status monitor now prepends its generated message to any more specific message provided by app-level status check code when the result is ERROR, FAIL, or WARN. Previously any app-specific messages were overridden entirely.

🐞 Bug Fixes

Correct type specified for notFoundValue arg in ConfigService.getLong() and getDouble() method signatures.

14.3.0 - 2022-09-23

Excel exports now support per-cell data types and long values for int types.

14.2.1 - 2022-09-06

🐞 Bug Fixes

Fix to minor regression in client error emails.

14.2.0 - 2022-08-19

Activity tracking enhancements. Tracking can now be done without the context of a web request and an explicit specification of a username is allowed.

14.1.2 - 2022-08-05

⚙️ Technical

Relaxed character limit on subject length for emails sent via emailService from 70 to 255

14.1.1 - 2022-08-03

⚙️ Technical

Revert groovy version to 3.0.9 to support java/groovy compilation.

📚 Libraries

groovy 3.0.11 → 3.0.9

14.1.0 - 2022-07-29

⚠ Note - applications should add logback.version=1.2.7 as a new line to their gradle.properties file to fix logback on a version that remains compatible with Hoist's Groovy-based configuration.

⚙️ Technical

PrefService.getClientConfig() has been optimized to reduce the number of database calls. Previously one select was issued per non-local preference when the second-level query cache was cold for a given user. Now only a single select is required.
DateTimeUtils app/server timezone conversion utils default to current day/date if called without arguments.
Standard JSON serialization/deserialization of newer Java date classes added with registration of the JSR310 module.
LogSupport methods withInfo, withDebug, and withTrace will now output a pre-work " Starting" message whenever logging is at level 'debug' or above. Previously level 'trace' was required.
Additional logging added to MemoryMonitoringService.

📚 Libraries

grails 5.1.1 → 5.2.1
groovy 3.0.9 → 3.0.11
gorm 7.1.2 → 7.3.2
hibernate 5.6.3 → 5.6.10
org.grails.plugins:hibernate 7.2.0 → 7.3.0
httpclient 5.1.2 → 5.1.3

Files

CHANGELOG.md

Latest commit

History

CHANGELOG.md

File metadata and controls

Changelog

26.0-SNAPSHOT - unreleased

💥 Breaking Changes (upgrade difficulty: 🟢 TRIVIAL - change to runOnInstance signature.)

🎁 New Features

⚙️ Technical

25.0.0 - 2024-11-15

💥 Breaking Changes (upgrade difficulty: 🟢 LOW)

🐞 Bug Fixes

⚙️ Technical

24.0.0 - 2024-10-17

💥 Breaking Changes (upgrade difficulty: 🟢 LOW - Hoist React update)

🎁 New Features

⚙️ Technical

23.0.0 - 2024-09-27

💥 Breaking Changes (upgrade difficulty: 🟢 LOW)

🎁 New Features

22.0.0 - 2024-09-18

💥 Breaking Changes (upgrade difficulty: 🟢 LOW)

🎁 New Features

⚙️ Technical

21.0.1 - 2024-09-05

🐞 Bug Fixes

⚙️ Technical

21.0.0 - 2024-09-03

💥 Breaking Changes (upgrade difficulty: 🟢 LOW - latest Hoist React + DB col additions)

🎁 New Features

🐞 Bug Fixes

⚙️ Technical

20.4.0 - 2024-07-31

🐞 Bug Fixes

⚙️ Technical

20.3.1 - 2024-07-23

🐞 Bug Fixes

20.3.0 - 2024-07-16

⚙️ Technical

20.2.1 - 2024-07-09

⚙️ Technical

🐞 Bug Fixes

20.2.0 - 2024-06-26

⚙️ Technical

20.1.0 - 2024-06-21

🎁 New Features

🐞 Bug Fixes

20.0.2 - 2024-06-05

🐞 Bug Fixes

⚙️ Technical

20.0.1 - 2024-05-21

🐞 Bug Fixes

20.0.0 - 2024-05-17

🎁 New Features

Hoist now fully supports multi-instance, clustered deployments!

Other new features

💥 Breaking Changes (upgrade difficulty: 🟠 MEDIUM / 🟢 LOW for apps with minimal custom server-side functionality)

🐞 Bug Fixes

⚙️ Technical

📚 Libraries

19.0.0 - 2024-04-04

💥 Breaking Changes (upgrade difficulty: 🟢 LOW - latest Hoist React + DB col additions)

🎁 New Features

⚙️ Technical

18.5.2 - 2024-04-03

🐞 Bug Fixes

18.5.1 - 2024-03-08

⚙️ Technical

18.5.0 - 2024-03-08

💥 Breaking Changes (upgrade difficulty: 🟢 TRIVIAL)

🐞 Bug Fixes

18.4.0 - 2024-02-13

🎁 New Features

18.3.2 - 2024-02-01

🐞 Bug Fixes

18.3.1 - 2024-01-30

🐞 Bug Fixes

18.3.0 - 2024-01-29