Updated URSYS ClientLog Module (+HMR warning fix) - [merged]

[benloh]

In GitLab by @daveseah on Sep 13, 2022, 16:11

Merges dev-sri/client-logger -> dev-next

This is a Developer Support Merge Request

• UR client now has LogEnabled() method that returns the state of client side log messages or sets to TRUE or FALSE
• The mysterious "HMR warning" in the browser client that didn't seem to break anything has nevertheless been suppressed with a webpack config change.

BEHIND THE SCENES

• LogEvent and LogJSON have been moved to client-logger (formerly named client-status)
• A new flag LOGGING_ENABLED has been added to the module. It default to OFF.
• The module will log the event when it is client-side logging is turned on or off
• The server-side logging system is not affected; only clients that are using LogEvent and LogJSON are affected in their ability to report logs to the server.

DEVELOPMENT NOTE

type function LogEnabled( optSet ?: boolean ) => boolean;

• if optSet is boolean true or false, LOGGING_ENABLED is set to it
• if optSet is undefined (no arg) then this just returns the current state
• if optSet is not a boolean or undefined this causes a hard throw Error
• if there is a CHANGE from the existing state (e.g. true to false, false to true) this is logged as CLIENT_LOG ENABLED or CLIENT_LOG DISABLED on the server log
• returns the current state that was set

[benloh]

In GitLab by @daveseah on Sep 13, 2022, 16:17

added 1 commit

• 05eb5c27 - dev-sri/client-logger: forward LOG.LogEnabled as part of UR.client API to match LogEvent, LogJSON

Compare with previous version

[benloh]

marked this merge request as ready

[benloh]

mentioned in commit ad478cd35c45d036e46895fc7c47b2ae49ed6386

[benloh]

BUG: client-logger.js uses the SendMessage method, but it is not defined in client-logger (This used to work because the SendMessage call for LogEvent and LogJSON were being made in index-client.js).

[benloh]

@daveseah How should SendMessage be passed to client-logger? We can't require './index-client without causing a circular dependency. Add an init? Somehow pass UR?

[benloh]

In GitLab by @daveseah on Sep 19, 2022, 13:37

I should move LocalNode into its own module instead of having it floating in index-client, so then it can be safely cross-imported.