DashboardTile.tsx

/*

 MIT License

 Copyright (c) 2022 Looker Data Sciences, Inc.

 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
 in the Software without restriction, including without limitation the rights
 to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 copies of the Software, and to permit persons to whom the Software is
 furnished to do so, subject to the following conditions:

 The above copyright notice and this permission notice shall be included in all
 copies or substantial portions of the Software.

 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 SOFTWARE.

 */
import React, { useCallback, useContext, useEffect, useState } from 'react';
import { MessageBar, SpaceVertical, Text } from '@looker/components';
import { More } from '@looker/icons';
import { ExtensionContext40 } from '@looker/extension-sdk-react';
import { DashboardRunState } from '@looker/extension-sdk';
import { useWindowSize } from '../../hooks/use_window_size';
import { LiquidFillGaugeViz } from '../LiquidFillGaugeViz';
import { Layout } from '../Layout';
import { NavigateButton } from '../NavigateButton';

/**
 * This component demonstrates a dashboard tile that is reponsible for
 * getting its own data. Note the technique for determining whether
 * the user has clicked the dashboard reload button. It is not
 * guaranteed that dashboardRunState from tileHostData will ever
 * indicate that the dashboard is running. This is due to performance
 * techniques used by the dashboard and happens when the dashboard does
 * not contain any tiles that run queries. A guaranteed technique to
 * determine if the dashboard reload button has been clicked is to save
 * the lastRunStartTime value from the tileHostData. If this value changes
 * then the user has clicked the dashboard run button (or the dashboard
 * has been setup to auto refresh).
 */
export const DashboardTile: React.FC = () => {
  const { height, width } = useWindowSize();
  const vizSize = Math.min(height, width) - 250;
  const { extensionSDK, coreSDK, tileHostData } =
    useContext(ExtensionContext40);
  const { lastRunStartTime, dashboardRunState } = tileHostData || -1;
  const [saveLastRunStartTime, setSaveLastRunStartTime] = useState<
    number | undefined
  >();
  const [value, setValue] = useState<number | undefined>();
  const [message, setMessage] = useState<string | undefined>();

  useEffect(() => {
    const readData = async () => {
      setSaveLastRunStartTime(lastRunStartTime);
      try {
        const response = await coreSDK.ok(
          coreSDK.run_inline_query({
            result_format: 'json',
            body: {
              model: 'thelook',
              view: 'users',
              fields: ['users.average_age'],
              total: false,
            },
          })
        );
        setValue((response[0] as any)['users.average_age']);
        setMessage(undefined);
      } catch (error) {
        console.error(error);
        setValue(undefined);
        setMessage('Failed to read data');
      }
    };
    if (
      !saveLastRunStartTime ||
      lastRunStartTime !== saveLastRunStartTime ||
      // Not required but shown here as an alternative
      dashboardRunState === DashboardRunState.RUNNING
    ) {
      readData();
    }
  }, [
    lastRunStartTime,
    saveLastRunStartTime,
    setSaveLastRunStartTime,
    dashboardRunState,
  ]);

  const renderComplete = useCallback(() => {
    extensionSDK.rendered();
  }, [extensionSDK]);

  return (
    <Layout right={<NavigateButton path="/inspect" icon={<More />} />}>
      <SpaceVertical p="xxxxxlarge" width="100%" align="center">
        <Text p="xxxxxlarge" fontSize="xxxxxlarge">
          Dashboard Tile
        </Text>
        {message && <MessageBar intent="critical">{message}</MessageBar>}
        {value && (
          <LiquidFillGaugeViz
            width={vizSize}
            height={vizSize}
            value={value}
            renderComplete={renderComplete}
            valueFormat={null}
          />
        )}
      </SpaceVertical>
    </Layout>
  );
};