Widget configuration

Widget can be configured in order to support different environments local/dev/staging/prod/... and to support needs of different clients. Common use cases:

Feature flagging
Customisation
Storing static values(instead of hardcoding)

Overview

Configuration is applied in layers. There are 3 places where config values can be adjusted

Configuration class in common_barkibu_dart package
WidgetConfiguration class in web_widget package
build.{env}.yaml files in the root of this repository

`common_barkibu_dart` configuration

Configuration class in common_barkibu_dart is responsible for configuring the library. If there is a need for a new config value that will change the logic of the common_barkibu_dart code - it has to be added directly into the Configuration class.

`web_widget` configuration

WidgetConfiguration extends Configuration class from the common_barkibu_dart library. It means that it has access to all values from the common library, but also adds new configuration options that can control the UI side of the widget.

Dart build pipeline configuration - build.{env}.yaml

Build files are used to control dart's build system. Each build file represents a deployment target:

build.dev.yaml - https://web-widget-dev.herokuapp.com/
build.staging.yaml - https://web-widget-staging.herokuapp.com/
build.yaml - https://web-widget.herokuapp.com/

These files are also used to inject specific configuration values based on the build file used. Each file contains a set of configuration values that will be compiled into a dart file with constants definitions. This file used as a source for WidgetConfiguration class values.

targets:
  $default:
    builders:
      web_widget|config_builder:
        options:
          configValue1: dummy
          configValue2: value
          configValue3: true
          clientIdConfigOverride:
            some_client_id1:
              configValue3: false
            some_client_id2:
              configValue3: false

This part of yaml is then provided to the config_builder to generate config.g.dart class during the build phase. This file can be imported in other places to get the values.

// Generated file: .dart_tool/build/generated/web_widget/lib/config.g.dart
const configValue1 = "dummy";
const configValue2 = "value";
const configValue3 = true;
const clientIdConfigOverride = {
  "some_client_id1": {
    "configValue3": false
  },
  "some_client_id2": {
    "configValue3": false
  }
};

// Example usage
import 'package:web_widget/config.g.dart' as config;

config.clientIdConfigOverride['some_client_id1']['configValue3']; // false
config.configValue1; // "dummy"

Generated code in config.g.dart file is used by widget_configuration.dart code. If any of the values that are referenced by widget_configuration.dart are missing in the config.g.dart - build will fail. You have to provide ALL config values in the yaml file. To see the list of all possible configs refer to any existing build yaml file.

clientIdConfigOverride property of the yaml file is used in case of multi-tenant widget deployment. If widget app is opened with ?client_id=some_client_id1 query string, settings from clientIdConfigOverride['some_client_id1'] will override settings from the top level. This way different client_id can have different configs.

List of all configuration values

`Configuration` class

backendUrl - Defines the API URL
appName - Defines the application name. Value is inserted in copies instead of placeholders where an application name is mentioned
brandName - Same as appName but for a brand/company name. Used to replace placeholders in copies.
brandLogo - File name of the apps logo. The file needs to be placed in assets/images/
emailAccount - Defines an email address where pet parents should send their emails in order to contact with a vet
emailNewLineFormat - Defines a new line separator, used to build a body for an email consultation
chatOnPhoneCallUrl - Url for external service where pet parent can schedule a phone call with a vet. Used when pet parent selects Phone option to connect with a vet
conciergeUrl - Defines the url where the concierge can be contacted (for instance: wss://concierge.barkibu.com)
botPreMessageDelay - Defines a delay in ms before bot message in the chat. Used to simulate a real conversation
botPostMessageDelay - Defines a delay in ms after bot message in the chat. Used to simulate a real conversation
telehealthEnabled - Flag that defines wether "Connect with a vet" functionality is enabled
telehealthMediaSharingEnabled - Flag that defines wether pet parent can connect with a vet using video call
telehealthVideoCapabilityEnabled - Flag that defines wether pet parent can upload media files when chatting with a vet
telehealthPhoneCallEnabled - Flag that defines wether pet parent can connect with a vet using a scheduled phone appointment. The value depends on the content of chatOnPhoneCallUrl.
telehealthEmailEnabled - Flag that defines wether pet parent can connect with a vet using an email. The value depends on the content of chatOnPhoneCallUrl.
skipPrimarySymptomEnabled - Controls whether the user will be presented with an option to skip symptom definition after 2 unsuccessful searches. This includes cases when nothing matched or when the user didn't select any of the presented search results.
addPetOptionEnabled - Flag that defines wether "Add pet" option will be available when selecting a pet in a conversation
backButtonEnabled - Flag that defines if back button is going to be displaying into different sections of the app
authServiceUserPoolId - Cognito user pool id. Only used if useLegacyAuthDatasource is set to false
authServiceAppClientId - Cognito app client id. Only used if useLegacyAuthDatasource is set to false
externalToSEnabled - Flag that defines wether the terms of service are external (you have to provide a url link in the Messages Model) or internal (you have to add a component that includes the ToS)
virtualVetInfoEnabled - Flag that allows you to activate and deactivate the link(s) to the Virtual Vet Info page.