Repository navigation
v0.8.0
Highlights
- Dotted variable names: a name such as
$settings.themeis one variable, so a project with many variables can give them structure. - External Variable Service:
- the Web Service now authenticates to it with a Keycloak token instead of a shared key;
- a slow or unreachable service no longer stalls or breaks a dialogue;
- Studio's status bar shows whether the service is running, and admins see the details in Technical Information;
- a service can mark the variables it supports with a type, allowed values and read-only, which Studio's Variable Browser shows.
- Testing never touches real data: testing a dialogue runs against a copy of the user's variables. Admins can simulate a user to look into a problem without changing anything, and acting for real as a user is clearly marked.
- User data: admins can erase everything stored about a user, from a new Users page. Deleting a project keeps its users' data unless you choose otherwise, and deleted projects can be cleaned up later.
- Studio:
- a reworked main screen: a mode bar showing Live or Authoring mode, aligned panels, and collapsible side panels;
- a project search;
- dialogs that no longer close, and lose what you typed, when you click outside them.
- Translations: a translated node now shows a variable correctly when the node sets it just before the text.
- Clearer errors: a request the caller got wrong is answered with its own 4xx status and the reason, instead of
500. - Compatibility policy: a new docs page lists which parts of Dialogue Branch are stable and which are internal to Studio.
Breaking changes
- Language: a dot followed by a letter or underscore is now part of a variable name.
$settings.themeis one variable, and in an expression$m.keyno longer reads a field of a map held in$m. - External Variable Service authentication:
dlb.external-variable-service.api-keyis gone. Setdlb.external-variable-service.oauth2.token-uri,client-idandclient-secret(and optionallyscope) instead; the Web Service won't start with the integration enabled and these missing.- Your service must check the Keycloak token, as described on the External Variable Service docs page.
- External Variable Service updates: the
retrieve-updatesresponse now only needs each variable'snameandvalue. AnupdatedTimeit sends is ignored, and the Web Service records when it received the update. - Deleting a project:
POST /project/delete-projectkeeps the project's users' variables and dialogue logs unless you passdeleteVariablesanddeleteLogs. client-js'sdeleteProjecttakes them as options.
Upgrading
- Database: a new migration (
V11, marking deleted projects) runs automatically on startup. - External Variable Service (only if you use one):
- In Keycloak, register a confidential client with a service account for the Web Service, and a client for your service with a role the Web Service's account is given. The External Variable Service docs page has the details.
- Configure the new
oauth2settings, and keep the client secret as a secret. - The new timeouts
connect-timeout(default2s) andread-timeout(default5s) are optional.
- Test sessions: the new setting
dlb.test-session.idle-timeout-minutes(default30) is optional.
Full details: CHANGELOG.md