Changelog
Features
- Add new endpoints
- PUT
subscriptionsBulk subscribe to telemetry, deviceTwin or connectionState - DELETE
subscriptionsBulk unsubscribe to telemetry, deviceTwin or connectionState
- Enable shared-access-key to be used in lastValue endpoints
Update subrepositories accordingly
Compatible endpoints to [email protected]:
- Send warning, error logs to Application Insights
- Use latest commit as default version
- Remove backwards compatibility for ux4iot v2. (Remove publishing of last values over websocket after grant was added)
- Fix bug where connectionState was not published
- Add option connectionStateOnTelemetry to enable/disable a connection state update whenever a telemetry message is received (enabled by default)
- Fixed bug where the ux4iot instance was in a broken state, because the custom resource's function app for the managed application was not deployed correctly
- Update all dependencies of ux4iot-server and submodules
- Revert cache to work with ux4iot 2.0 timestamps to ensure backwards compatibility of the redis cache
Features
The subscription flow was updated. Previously, whenever a grant was added, ux4iot began to publish messages to a room, specific to the grant data. Now adding a grant does nothing other than telling ux4iot that a specific session has the permission to subscribe to SD (SD = telemetry, connection state, device twin, d2c messages) This breaking change also changes the way the client's websocket receives messages for telemetry. Previously all telemetry in a device's message was split by all keys and for each telemetry key, a single message was published. Now, only one message per device will be published for all subscribed telemetry of that device. A client will therefore just receive one message per device and per connection state, d2c message, devicetwin or telemetry.
- breaking Request to PUT /grant endpoint no longer subscribe to SD
- breaking Change grant request type parameter key from "grantType" to "type"
- breaking Change grant request type parameter values from
- subscribeToTelemetry -> telemetry
- subscribeToConnectionState -> connectionState
- subscribeToDeviceTwin -> deviceTwin
- subscribeToD2CMessages -> d2cMessages
- modifyDesiredProperties -> desiredProperties
- invokeDirectMethod -> directMethod
- Add new endpoint PUT /subscription to subscribe to SD which depends on grants
- Add new endpoint DELETE /subscription to unsubscribe from SD which depends on grants
- Add unit test cases for state management in ux4iot
- Make parameter 'telemetryKey' in GET /lastValue/:deviceId/:telemetryKey optional, omitting it will return all last values for the given device
- Add GET /deviceTwin/:deviceId endpoint to retrieve the last received device twin
- Add GET /connectionState/:deviceId endpoint to retrieve the last received connection state
- ux4iot-admin-node
- breaking Change methodname 'revokeAll' to 'revokeAllSessions'
- Add methods for endpoints
- subscribe -> PUT /subscription
- unsubscribe -> DELETE /subscription
- invokeDirectMethod -> POST /directMethod
- getLastTelemetryValues -> GET /lastValue/:deviceId/:telemetryKey
- getLastDeviceTwin -> GET /deviceTwin
- getLastConnectionState -> GET /connectionState
- patchDesiredProperties -> PATCH /deviceTwinDesiredProperties
- ux4iot-react Complete refactoring of internal ux4iot-react subscription logic. Ux4iot 3.0 delivers telemetry messages in a new way. It will aggregate all subscribed telemetry in one message. Ux4iot-react will distribute these messages over all used hooks. Ux4iot-react 3.0 will use the new subscription mechanism for ux4iot 3.0 in that it uses separate requests for grants and subscriptions. During these changes, a lot of types were changed, which then resulted in breaking changes. These changes however are very minor so there won't be much effort to update from 2.x to 3.0.
Overview of changes:
- Unify all message callbacks in hooksexport type MessageCallbackBase<T> = (deviceId: string,data: T | undefined,timestamp: string) => void;export type TelemetryCallback = MessageCallbackBase<Record<string, unknown>>;export type DeviceTwinCallback = MessageCallbackBase<TwinUpdate>;export type ConnectionStateCallback = MessageCallbackBase<boolean>;export type D2CMessageCallback = MessageCallbackBase<Record<string, unknown>>;
- breaking useConnectionState
onData: (connectionState: boolean) => void- changed toonData: ConnectionStateCallback - breaking useD2CMessages
onData: (data: T, timestamp: string) => void- changed toonData: D2CMessageCallback - breaking useDeviceTwin
onData: (twin: Twin) => void- changed toonData: DeviceTwinCallback - breaking useMultiTelemetry
onData: (deviceId: string, telemetryKey: string, telemetryValue: unknown, timestamp: string | undefined) => void- changed toonData: TelemetryCallback - breaking useTelemetry
onData<T>: (data: T, timestamp: string | undefined) => void- changed toonData<T>: MessageCallbackBase<T> - breaking Rename type RawD2CMessageCallback to D2CMessageCallback
- breaking useConnectionState is now returning
booleaninstead of{connected: boolean}
If you're not using onData callbacks, you shouldn't have any breaking changes.
- Add useMultiConnectionState hook
- Add
onSubscriptionErrorcallback, firing when there are errors on posting requests to subscribe to ux4iot data - Update ux4iot-shared types to updated ux4iot 3.0 types
- Add typeguards for all message types
- Add separate state handling in ux4iot-react
Breaking
- Rename customTimestampProperty to customTimestampKey
Misc
- Changed info log statements that were debug level to debug
- Add new setting customDeviceIdKey to be able to set a custom key in messages to be used as deviceId
- Make it possible to disable TTL for connection cache
- Add parameter
throttlingParameterto specify the number of milliseconds with which to throttle the telemetry updates sent via websockets. Set this to -1 to disable throttling. This is the default. - Add special branch
experimentalfrom which the app definitionux4iot-experimentalis updated.
- The connection state received via Event Hub / IoT Hub is cached. This makes it possible to use the
useConnectionStatehook, even if no IoT Hub is used, as you can simulate the connected/disconnected messages using an Event Hub - Add parameter
customTimestampPropertywith default value_tsso that the timestamp can optionally be passed as part of the body of a message. You can still continue to use the message properties - Add parameter
connectionStateCacheTTL. This indicates the number of seconds that the connection state should be cached. You can set it to0to set the time-to-live to infinity. The default value is60 - Fix inconsistencies regarding contents of device twin.
- Add persistence of complex telemetry values
- Reduce Azure infrastructure costs: Application Insights
- Fix a problem with too low max open file limit in reverse proxy
- Reduce Azure infrastructure costs: Storage Accounts
- Reduce Azure infrastructure costs: Application Insights, Storage Accounts
- ARM Template improvements
- Add support for timestamps
- Add parameters for ARM template:
- Add SKUs (small, standard) to make less cost-intensive instances possible (
sku) - Make it possible to inject the primary and secondary secrets (
primaryAdminSecret,secondaryAdminSecret) - Make the log level configurable (
logLevel)
- The consumer group to use for reading from Event Hub or IoT Hub can be configured
- Slightly improved the wording and detail in the creation screen
- Fix an issue with
patchDesiredProperties - Fix issues with using ux4iot without an IoT Hub, i.e. only using an Event Hub
- Improve memory attribution between containers
- The DNS label can not be overwritten with the parameter
dnsLabelOverride - The custom sub-resource pages for the admin connection strings and websocket url load much faster now
Last modified 2d ago