[1.x] Custom Branding (#826)

[kavilla]

Custom branding

• Make top left logo on the main screen configurable
  • Add a new config opensearchDashboards.branding.logoUrl in yaml file
    for making top left corner logo on the main screen configurable. If
    URL is invalid, the default OpenSearch logo will be shown.
• Welcome page title and logo configurable (Make welcome page logo and title configurable #738)
  • Add two new configs branding.smallLogoUrl and branding.title
    in the yaml file for making the welcome page logo and title
    configurable. If URL is invalid, the default branding will be shown.
• Make loading page logo and title configurable (Make loading page logo and title configurable  #746)
  • Add one new config branding.loadingLogoUrl for making loading page logo
    configurable. URL can be in svg and gif format. If no loading logo is found,
    the static logo with a horizontal bar loading bar will be shown. If logo is also
    not found, the default OpenSearch loading logo and spinner will be shown.
• Branding configs rename and improvement (Branding config rename and improvement #771)
  • Change config smallLogoUrl to logoUrl, config logoUrl to fullLogoUrl to emphasize that thumbnail version
    of the logo will be used mostly in the application. Full version of the logo will only be used on the main
    page nav bar. If full logo is not provided, thumbnail logo will be used on the nav bar. Some config improvement
    includes fixing the validation error when inputting empty string, and add title validation function.
• Branding config structure change and renaming (Branding config structure change and renaming #793)
  • Change the branding related config to a map structure in the yml file.
    Also rename the configs according to the official branding guidelines.
    The full logo on the main page header will be called logo; the small
    logo icon will be called mark.
• Darkmode configurations for header logo, welcome logo and loading logo (Dark mode configurations for header logo, welcome logo and loading logo #797)
  • Add dark mode configs in the yml file that allows user to configure a
    dark mode version of the logo. When user toggles dark mode under the
    Advanced Setting, the logo will be rendered accordingly.
• Add favicon configuration (Add favicon configuration #801)
  • Added a configuration on favicon inside opensearchDashboards.branding
    in the yml file. If user inputs a valid URL, we gurantee basic browser
    favicon customization, while remaining places show the default browser/device
    favicon icon. If user does not provide a valid URL for favicon, the
    opensearch favicon icon will be used.
• Make home page primary dashboard card logo and title configurable (Make home page primary dashboard card logo and title configurable #809)
  • Home page dashboard card logo and title can be customized by config
    mark.defaultUrl and mark.darkModeUrl. Unit test and functional test
    are also written.
• Side menu logo configuration
  • Make logo for opensearch dashboard side menu be configurable.
    Use config mark.defaultUrl and mark.darkModeUrl.
• Overview Header Logo Configuration
  • Make logo for opensearch dashboard overview header logo be configurable.
    Use config mark.defaultUrl and mark.darkModeUrl.
• Redirect URL not allowed
  • Add an addtional parameter to the checkUrlValid function
    so that max redirect count is 0. We do not allow URLs that
    can be redirected because of potential security issues.
• Store default opensearch branding asset folder
  • Store the original opensearch branding logos in an asset folder,
    instead of making API calls.
• [Branding] handle comments from PR
  • Handling the helper function rename and grammar issues. To avoid risk, we will not remove the duplicate code for 1.2 and everything related to those comments (ie function renames). That will be handled in 1.3. Here is the issue tracking it: [Cleanup] Reduce duplication in code for Initial Custom Branding #895

Backport PR:
#897

Signed-off-by: Abby Hu abigailhu2000@gmail.com
Co-authored-by: Kawika Avilla kavilla414@gmail.com

[tmarkley]

LGTM!