Release Notes

@axinom/mosaic-ui: It is now possible to unselect items after the "select all" option was used. The checkboxes on the data rows will get enabled, once the data is exhausted (meaning there are no more pages to load). If the list is not exhausted yet, the checkboxes will stay disabled as in this case actions are expected to be performed on the whole list (including potentially unloaded items). Once the list is exhausted, the selection event will switch to a mode where it will enumerate the individual selected items to perform the action on.

Video Service: Videos can now be deleted. To delete a video, the user role or service account that is used must have Videos: Edit AND Videos: Delete permission, or just Admin permission for the Video Service.

Media Messages: We’ve extended the doc types on the message payloads defined in the media-messages library to include information about the used aggregate-id and type. This will make it easier for consumers and producers of the messages to understand the values expected for each message. #315

Media Service: Fixed an issue with genre localizations not always being synchronized correctly #310

Media Service: Fixed an issue where the TV show genres station was not rendering successfully when the genre list was empty. #311

@axinom/mosaic-cli: Fixing some commands that were not crrectly returing a non-zero exit code in case there was an error. This will make it easier to use the CLI in automated scripts.

@axinom/mosaic-message-bus: We have made adjustments to the @axinom/mosaic-message-bus library to create the delay queues of Quorum type instead of Classic type. This will ensure the messages in those queues will have higher reliability and fault tolerance.

Image Service: Images can now be deleted. To delete an image, the user or token that is used must have Images: Edit AND Images: Delete permission, or just Admin permission for the Image Service.

Image Service: Fixed an issue that prevented the Altair client to work correctly.

Localization Service: Fixed an issue with the validation of language tags in Localization settings.

Localization Service: Fixed a racing condition where localization values created immediately after the source entity registration were sometimes not saved correctly.

Media Service: We improved the ingest process to be more resilient on large ingests, able to handle more entities at once, improved the progress reporting, and have improved error handling. (#291, #293, and #295)

Media Service: Messages the service uses to send to itself (e.g. during ingest) are now directly stored in the inbox table and won’t do a detour over the RMQ anymore (#292)

Media Service: We updated the version of the Altair package (#303)

Media Service: We updated the version of the pg-transactional-outbox package (#307)

UserDeleted

UserRoleDeleted

ServiceAccountDeleted

@axinom/mosaic-cli: A new CLI command mosaic service purge-permissions is introduced, which can be used to purge permissions from ID Service for a given Mosaic Service. More info can be found in the @axinom/mosaic-cli documentation.

@axinom/mosaic-ui: We introduced a new Tabs component. This component can be used to structure the fields on detail pages. To find more about the control and some general things to keep in mind when designing workflows using this component, check out the Storybook.

Video Service: The video-select-field microfrontend extension now has a new optional property predefinedFilterValues that can be used to specify additional filters that should be applied to the list of videos that users can pick from.

Video Service: The preview station now contains an optional video player allowing to preview videos directly in the management system. This feature can be configured in the video service settings on the admin portal.

Hosting Service: Hosting Service now supports assigning custom DNS labels to services hosted by it that makes it possible to have more predictable URLs for the deployed services. You can find the new field in the details station of your customizable service. Please note that the custom DNS labels are globally unique, and therefore will be assigned on a first-used basis.

Management System Service: Added an option to replace the welcome message on the home screen as well as the logo on the top right of the management system shell with a custom component. To find out how, check out the documentation

Media Service: We updated the piral package to version 1.5.2, which matches the version the Mosaic Portal is using. This update should not have any impact on the existing services, but it is recommended to update the piral package in your services to the latest version to avoid any potential issues. (#287 & #288)

Media Service: We added a new environment variable IS_LOCALIZATION_ENABLED to the media workflow package. This variable will affect whether the localization sub stations on the entity details will be shown or not. (#284)

Media Service: We removed the unnecessary permission check for the events the service receives as answer for the LocalizeEntity command which complicated the process when trying to setup the service from the scratch. (#277)

Media Service: Message handlers in the media service are using a database clients with the owner permissions to be able to change also those values that cannot be changed via the login database role. The field names in the handler suggested incorrectly, that the database login pool is used in message handler. We changed the argument names to "ownerClient" to avoid confusion. (#278)

@axinom/mosaic-ui: Fixed an issue with the Dynamic Data List, where changes to the position of an item using the text input were not applied correctly.

@axinom/mosaic-ui: Explorers in selection mode now reset their selection when the filters are changed.

Hosting Service: When storage credentials are regenerated through the Admin Portal, the Hosting Service now emits an event ObjectStorageCredentialsRegenerated. Interested services can listen to this event and update any stored management tokens etc. using Hosting Service GraphQL API to keep the storage credentials up-to date.

Hosting Service: Now the services deployed via the Hosting Service will receive a performance boost during executing DB Queries that uses ILIKE statement (such as when using filter queries for text fields) since they are able to use existing GIN INDEXes for improving query performance when Row Level Security is enabled. This is achieved by automatically marking the pg_catalog.texticlike function as LEAKPROOF.

Hosting Service: The Mosaic Hosting Service no longer grants the policymaker role to RMQ Users it generates and instead will grant the management role. If you require specific policies to be configured for your RMQ vhosts, please get in touch with our support team, so we can help you out.

Media & Catalog Service: We added localization support for all publishable entities (Movie, TV Show, Season, Episode, Collection, Movie Genre, TV Show Genre).

Media Service: We added a refetch configuration to the mutations on the detail stations to make sure the form data also updates correctly when the save is performed by an action that does not navigate the user away from the page. (#269)

Media Service: We adjusted the titles of some Explorer stations to be more consistent (#267)

Media, Catalog, Entitlement, Vod-to-Live Service: The services were updated to use the latest service-common library, specifically now we use the updated setupMonitoring method of this library that will ensure if there will be any errors of a single metric during its collection, the other successfully collected metrics will be available in the registry. Instead an error log will be generated to be investigated separately. (#263)

@axinom/mosaic-ui: The UI library will now be smarter about the <style/> elements it injects into the DOM. A UI library instance will only add the styles if they were not already added by another instance. Different versions of the library will still define styles that differ individually. This change makes the DOM more lightweiht and improves the developer experience when trying to tweak styles on the fly using the browser’s developer tools.

@axinom/mosaic-portal: When pressing the save button in the management system, the application will not create another entry in the browser history. This will make it easier to navigate back to the previous page after saving a form.

@axinom/mosaic-service-common: The service-common library now includes an express handler to add the Axinom Mosaic favicon.ico to express applications. This can be done via app.use(mosaicFavicon);

@axinom/mosaic-service-common: The assertError helper function is deprecated in favor of a new ensureError helper function.

import { assertError} from '@axinom/mosaic-service-common';

try {
   // code that has a potential to throw errors
} catch(error) {
   assertError(error);
   // your error handling
}

import { ensureError } from '@axinom/mosaic-service-common';

try {
   // code that has a potential to throw errors
} catch(e) {
   const error = ensureError(error);
   // your error handling
}

Video Service: The Video Service message handlers for bulk archiving and bulk unarchiving videos send out an ArchiveVideosFailedEvent and UnarchiveVideosFailedEvent message in case the (un)archiving fails. The import custom videos message handler will now send an ImportCustomVideoFinishedEvent message when the import is successfully done and an ImportCustomVideoFailedEvent in case the import fails.

Image Service: When the ArchiveImagesCommand or the UnarchiveImagesCommand Image Service fails to handle the archive/unarchive message they send out the corresponding ArchiveImagesFailedEvent and UnarchiveImagesFailedEvent messages.

Entitlement Service: Maxmind has introduced a daily download limit for their GEO IP databases. If your entitlement service is deployed in a scalable way or deployed/restarted often that limit can be exceeded. To avoid this limit Maxmind suggests downloading their database with your license key to some shared repository or setting up a proxy cache from where your services download the database.

Entitlement Service: We bumped the geoip-country package version to fixed a bug that caused entitlement-service to crash shortly after start-up. This was caused due to a change in the MaxMind API and the library which accesses the API to fetch the geoip-country list not being updated to handle the changed API. #256

This release implements a few improvements around the way how data is saved in the management system workflows. You can find a more detailed description of concept for saving in the Saving article.

The management system browser tab title now dynamically adapts to the page that is currently open. This makes it easier to distinguish between different tabs when you have multiple tabs open in the same browser window.
Out of the box it will use the title that is being set on the PageHeader component of the station. Stations can also set a custom page title by using the setTitle method on the PiralAPI object. To make it not conflict with a potential PageHeader, the automatic setting of the page title by the PageHeader can be disabled by setting setTabTitle to false.
To enable that feature for your custom workflows you need to update the UI library to the latest version.

We improved the user experience when configuring profiles on video and image service that are using storages coming from the hosting service. If you have hosting service storages already enabled, you can directly pick the container from the containers available on your storage. If you have not enabled the hosting service storages yet, the UI will guide you through the process of enabling them. To find out more, check out the hosting service documentation.

@axinom/mosaic-ui: The FormStation components will now add an asterisk to the page title, if the form has unsaved changes, making it easier to understand whether a from is dirty or not. This will also be reflected in the browser tab title.

@axinom/mosaic-ui: Added a toast notification when a form was saved successfully. This will help users to better understand when a saving operation was happening, e.g. when navigating away from a dirty form.

@axinom/mosaic-ui: Added a new FormGrid component. This can be used to replicate the styles applied to the children of the FormStation.

@axinom/mosaic-graphql-common: We’ve added a new Express middleware forwardToGraphiQl, which will redirect browsers requesting the / as well as /graphql route of a service to the /graphiql endpoint. This will make it easier to access the GraphiQL interface of a service. We added this middleware to all our managed services as well as the services in the media template (see #250).

Management System Service: We tweaked the look and feel of the save indicator to make it more clear what the state of the from and saving process is.

Management System Service: We changed the favicon of the Management system to the Mosaic logo.

Image Service: Previously, if you would request an image of a specific width and height from the /transform` API, and these values exceeded the size of an original image the returned image would have been up-scaled. This is no longer happening. If at least one of the requested dimensions is greater than the same dimension of the original image, the returned image will be transformed to match the aspect ratio of the requested dimensions, but will not exceed the original image. If upscaling was previously expected to happen by the image service, it should not be handled by other means. E.g. browsers built-in upscaling mechanisms.

Image Service: Adding the image transformation base url to the image details station making it easier obtainable for users of the management system.

Image Service: If an image with a name that is longer then 100 characters is uploaded or imported using the EnsureImageExits message, the image service will now truncate the image title to 100 characters instead of failing the import.

Image Service: Fixed an issue with the preview of the image transformation in the focal point stations for images that have the default focal point set.

Hosting Service: The Mosaic Hosting Service now grants the policymaker role to all RMQ Users it generates. This shall offer greater control over defining message policies such as setting Message TTL, Max length, etc. via the RMQ Management Portal for the user.

Media Template: We discovered that some services are missing their required deps in the package.json. Since we are in a monorepo, these deps were supplied by other services, and therefore everything appears to work well. But when we try to build a service in isolation, the missing deps would produce build errors. We added the missing dependencies to all services in PR #246.

@axinom/mosaic-id-guard: When a custom-service is configured to use a specific tenant/environment but receives a JWT that was issued to a different tenant/environment, the displayed error message will contain better instructions to troubleshoot the issue.

@axinom/mosaic-ui: Live suggestion styles are adjusted to have better padding.

@axinom/mosaic-ui: Added new icon for In Progress.

Identity Service: A bug was fixed when the UserRoleAssignmentChanged event was fired for a User Role that was removed from a User, the correct User Role information was not included in the event payload. Now the payload includes the correct User Role name and ID.

Hosting Service: A bug was fixed when a Custom Service was redeployed with a changed DNS label (via the DNS-port-mappings in the deployment-manifest YAML), the new label was not pointing to the service port.

Video Service: The Cue Points station was updated by removing the "Row Number" column from the Cue Points to avoid any confusion regarding the ordering. The Cue Points are always ordered by the Timestamp.

Media Messages: The media-messages library was updated and the corresponding services (Media, Catalog & Entitlement) were aligned to now use the updated GraphQL Subscription payload format where the eventKey strongly typed property is favoured over the now deprecated event property. See more details in this PR (#235).

Media Service: Improved the look & feel of the workflows which contained the "Archive" & "Delete" actions to be more consistent with the remaining actions by removing the icon and only having the label.

With this release we removed backwards compatibility on our Video Service for the deprecated APIs that still used the Encoding Service name.

We also dropped support for the following properties on Video service: drmKeyIds, qualityLevels, durationInSeconds on Videos. bandwidthInBps and initialFile on VideoStreams.

We removed the NodeId based fields from the graphql schemas of all managed services.

@axinom/mosaic-cli: A new CLI command mosaic service sync-permissions is introduced, which can be used to synchronize permissions with ID Service for a given Mosaic Service by giving a permissions.json file. More info can be found in the Documentation of the CLI package.

@axinom/mosaic-id-guard: Now the AxGuard plugin generates a permission-definition.json file that serializes the permission-definition of the service. This can be helpful when you need to perform out-of-band permission synchronization to the Mosaic ID Service before the service is started.

@axinom/mosaic-portal: Changed the link to the /about page on the side panel footer to now show the portal version anymore to avoid confusions. The footer still links to the /about page. The full list of versions of all components running on the management system can be found there.

@axinom/mosaic-ui: Changed the ImageLoader component, to not do requests to ./undefined if the imgSrc is not defined.

@axinom/mosaic-service-common: Removed deprecated error handling classes in favour of MosaicError.

Identity Service: Now when a customizable-service synchronizes the permissions to the Identity Service, the system-defined Administrator role of the corresponding environment will be immediately updated with the changed permissions. Previously this happened only when a Management Super Admin would sign-in to the management system. This new change will keep the Administrator role up to date in a more timely manner.

Hosting Service: The Pilet Artifacts Explorer now shows most recently updated pilets first.

Image Service: New property image_type added to the Image Upload Webhook request payload.

Channel Service: Fixed an issue where the publish validations for channels and playlists would include the publish hash even if there were errors. The publish hash is now correctly null when any validation reported an error.

Monetization Grants Service: Fixed an issue where the publish validations for claim sets would include the publish hash even if there were errors. The publish hash is now correctly null when any validation reported an error.

Subscription Monetization Service: Fixed an issue where the publish validations for subscription plans would include the publish hash even if there were errors. The publish hash is now correctly null when any validation reported an error.

Media, Catalog and Entitlement Service: Added pg lock timeout config on Postgres PoolConfig level. This setting helps to resolve deadlock situations when two competing transactions wait for each other to release their locks. This can happen when a client runs multiple mutations within a single GraphQL request or with other database related work. (#207)