Use logical equivalent for undefined, jsdoc params

Signed-off-by: Abby Hu <abigailhu2000@gmail.com>
opensearch-project · Aug 29, 2021 · 913e6d8 · 913e6d8
1 parent c56d3ff
commit 913e6d8
Show file tree

Hide file tree

Showing 13 changed files with 55 additions and 48 deletions.
diff --git a/config/opensearch_dashboards.yml b/config/opensearch_dashboards.yml
@@ -152,10 +152,10 @@
 #vis_type_timeline.graphiteBlockedIPs: []
 
 # full version customized logo URL
-# opensearchDashboards.branding.logoUrl: ""
+ opensearchDashboards.branding.logoUrl: "https://i.ibb.co/WHHLG2W/bear"
 
 # smaller version customized logo URL
-# opensearchDashboards.branding.smallLogoUrl: ""
+ opensearchDashboards.branding.smallLogoUrl: "https://i.ibb.co/WHHLG2W/bear.png"
 
 # custom application title
 # opensearchDashboards.branding.title: ""

diff --git a/src/core/public/chrome/ui/header/branding/opensearch_dashboards_custom_logo.test.tsx b/src/core/public/chrome/ui/header/branding/opensearch_dashboards_custom_logo.test.tsx
@@ -17,7 +17,7 @@ describe('Custom Logo', () => {
     expect(component).toMatchSnapshot();
   });
   it('Take in a invalid URL string', () => {
-    const branding = { logoUrl: undefined };
+    const branding = {};
     const component = mountWithIntl(<CustomLogo {...branding} />);
     expect(component).toMatchSnapshot();
   });

diff --git a/src/core/public/chrome/ui/header/branding/opensearch_dashboards_custom_logo.tsx b/src/core/public/chrome/ui/header/branding/opensearch_dashboards_custom_logo.tsx
@@ -34,12 +34,15 @@ import React from 'react';
 import '../header_logo.scss';
 import { OpenSearchDashboardsLogoDarkMode } from './opensearch_dashboards_logo_darkmode';
 
+/**
+ * @param {string} logoUrl - custom URL for the top left logo of the main screen
+ */
 export interface CustomLogoType {
-  logoUrl: string | undefined;
+  logoUrl?: string;
 }
 
 export const CustomLogo = ({ ...branding }: CustomLogoType) => {
-  return branding.logoUrl === undefined ? (
+  return !branding.logoUrl ? (
     OpenSearchDashboardsLogoDarkMode()
   ) : (
     <img

diff --git a/src/core/public/chrome/ui/header/header.tsx b/src/core/public/chrome/ui/header/header.tsx
@@ -87,7 +87,7 @@ export interface HeaderProps {
   isLocked$: Observable<boolean>;
   loadingCount$: ReturnType<HttpStart['getLoadingCount$']>;
   onIsLockedUpdate: OnIsLockedUpdate;
-  branding: { logoUrl: string | undefined };
+  branding: { logoUrl?: string };
 }
 
 export function Header({

diff --git a/src/core/public/chrome/ui/header/header_logo.tsx b/src/core/public/chrome/ui/header/header_logo.tsx
@@ -104,7 +104,7 @@ interface Props {
   navLinks$: Observable<ChromeNavLink[]>;
   forceNavigation$: Observable<boolean>;
   navigateToApp: (appId: string) => void;
-  logoUrl: string | undefined;
+  logoUrl?: string;
 }
 
 export function HeaderLogo({ href, navigateToApp, logoUrl, ...observables }: Props) {

diff --git a/src/core/public/index.ts b/src/core/public/index.ts
@@ -237,8 +237,8 @@ export interface CoreSetup<TPluginsStart extends object = object, TStart = unkno
   injectedMetadata: {
     getInjectedVar: (name: string, defaultValue?: any) => unknown;
     getBranding: () => {
-      logoUrl: string | undefined;
-      smallLogoUrl: string | undefined;
+      logoUrl?: string;
+      smallLogoUrl?: string;
       title: string;
     };
   };
@@ -297,8 +297,8 @@ export interface CoreStart {
   injectedMetadata: {
     getInjectedVar: (name: string, defaultValue?: any) => unknown;
     getBranding: () => {
-      logoUrl: string | undefined;
-      smallLogoUrl: string | undefined;
+      logoUrl?: string;
+      smallLogoUrl?: string;
       title: string;
     };
   };

diff --git a/src/core/public/injected_metadata/injected_metadata_service.ts b/src/core/public/injected_metadata/injected_metadata_service.ts
@@ -77,8 +77,8 @@ export interface InjectedMetadataParams {
       };
     };
     branding: {
-      logoUrl: string | undefined;
-      smallLogoUrl: string | undefined;
+      logoUrl?: string;
+      smallLogoUrl?: string;
       title: string;
     };
   };
@@ -186,8 +186,8 @@ export interface InjectedMetadataSetup {
     [key: string]: unknown;
   };
   getBranding: () => {
-    logoUrl: string | undefined;
-    smallLogoUrl: string | undefined;
+    logoUrl?: string;
+    smallLogoUrl?: string;
     title: string;
   };
 }

diff --git a/src/core/server/rendering/rendering_service.tsx b/src/core/server/rendering/rendering_service.tsx
@@ -121,12 +121,10 @@ export class RenderingService {
               uiSettings: settings,
             },
             branding: {
-              logoUrl:
-                isLogoUrlValid === true ? opensearchDashboardsConfig.branding.logoUrl : undefined,
-              smallLogoUrl:
-                isSmallLogoUrlValid === true
-                  ? opensearchDashboardsConfig.branding.smallLogoUrl
-                  : undefined,
+              logoUrl: isLogoUrlValid ? opensearchDashboardsConfig.branding.logoUrl : undefined,
+              smallLogoUrl: isSmallLogoUrlValid
+                ? opensearchDashboardsConfig.branding.smallLogoUrl
+                : undefined,
               title: opensearchDashboardsConfig.branding.title,
             },
           },

diff --git a/src/core/server/rendering/types.ts b/src/core/server/rendering/types.ts
@@ -75,8 +75,8 @@ export interface RenderingMetadata {
       };
     };
     branding: {
-      logoUrl: string | undefined;
-      smallLogoUrl: string | undefined;
+      logoUrl?: string;
+      smallLogoUrl?: string;
       title: string;
     };
   };

diff --git a/src/plugins/home/public/application/components/__snapshots__/welcome.test.tsx.snap b/src/plugins/home/public/application/components/__snapshots__/welcome.test.tsx.snap
diff --git a/src/plugins/home/public/application/components/home.js b/src/plugins/home/public/application/components/home.js
@@ -208,7 +208,7 @@ export class Home extends Component {
 
   render() {
     const { isLoading, isWelcomeEnabled, isNewOpenSearchDashboardsInstance } = this.state;
-    
+
     if (isWelcomeEnabled) {
       if (isLoading) {
         return this.renderLoading();

diff --git a/src/plugins/home/public/application/components/welcome.test.tsx b/src/plugins/home/public/application/components/welcome.test.tsx
@@ -92,7 +92,6 @@ test('fires opt-in seen when mounted', () => {
 
 test('should render a Welcome screen with the default OpenSearch Dashboards branding', () => {
   const defaultBranding = {
-    smallLogoUrl: undefined,
     title: 'OpenSearch Dashboards',
   };
   const component = shallow(

diff --git a/src/plugins/home/public/application/components/welcome.tsx b/src/plugins/home/public/application/components/welcome.tsx
@@ -59,7 +59,7 @@ interface Props {
   onSkip: () => void;
   telemetry?: TelemetryPluginStart;
   branding: {
-    smallLogoUrl: string | undefined;
+    smallLogoUrl?: string;
     title: string;
   };
 }
@@ -144,6 +144,28 @@ export class Welcome extends React.Component<Props> {
     }
   };
 
+  private renderBrandingEnabledOrDisabledLogo = () => {
+    if (!this.props.branding.smallLogoUrl) {
+      return (
+        <span className="homWelcome__logo">
+          <EuiIcon type={OpenSearchMarkCentered} size="original" />
+        </span>
+      );
+    } else {
+      return (
+        <div className="homWelcome__customLogoContainer">
+          <img
+            className="homWelcome__customLogo"
+            data-test-subj="welcomeCustomLogo"
+            data-test-image-url={this.props.branding.smallLogoUrl}
+            alt="logo"
+            src={this.props.branding.smallLogoUrl}
+          />
+        </div>
+      );
+    }
+  };
+
   render() {
     const { urlBasePath, telemetry, branding } = this.props;
     return (
@@ -152,21 +174,7 @@ export class Welcome extends React.Component<Props> {
           <header className="homWelcome__header">
             <div className="homWelcome__content eui-textCenter">
               <EuiSpacer size="xl" />
-              {branding.smallLogoUrl === undefined ? (
-                <span className="homWelcome__logo">
-                  <EuiIcon type={OpenSearchMarkCentered} size="original" />
-                </span>
-              ) : (
-                <div className="homWelcome__customLogoContainer">
-                  <img
-                    className="homWelcome__customLogo"
-                    data-test-subj="welcomeCustomLogo"
-                    data-test-image-url={branding.smallLogoUrl}
-                    alt="logo"
-                    src={branding.smallLogoUrl}
-                  />
-                </div>
-              )}
+              {this.renderBrandingEnabledOrDisabledLogo()}
               <EuiTitle
                 size="l"
                 className="homWelcome__title"