RunIt.tsx

/*

 MIT License

 Copyright (c) 2021 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 type { BaseSyntheticEvent, FC, FormEventHandler } from 'react';
import React, { useContext, useEffect, useState } from 'react';
import {
  Box,
  Tab,
  TabList,
  TabPanel,
  TabPanels,
  useTabs,
} from '@looker/components';
import type { ApiModel, IMethod } from '@looker/sdk-codegen';
import type {
  IEnvironmentAdaptor,
  OAuthConfigProvider,
} from '@looker/extension-utils';
import { registerEnvAdaptor } from '@looker/extension-utils';

import type { ResponseContent } from './components';
import {
  ConfigForm,
  DocSdkCalls,
  Loading,
  PerfTimings,
  PerfTracker,
  RequestForm,
  ResponseExplorer,
  validateBody,
} from './components';
import {
  createInputs,
  createRequestParams,
  initRequestContent,
  pathify,
  prepareInputs,
  runRequest,
} from './utils';
import { RunItContext } from '.';

export type RunItHttpMethod = 'GET' | 'PUT' | 'POST' | 'PATCH' | 'DELETE';

/**
 * Generic collection
 */
export type RunItValues = Record<string, any>;

type RunItInputType =
  | 'boolean'
  | 'int64'
  | 'integer'
  | 'float'
  | 'double'
  | 'string'
  | 'hostname'
  | 'uuid'
  | 'uri'
  | 'ipv4'
  | 'ipv6'
  | 'email'
  | 'password'
  | 'datetime';

type RunItInputLocation = 'body' | 'path' | 'query' | 'header' | 'cookie';

/**
 * A RunIt input type describing a single REST request's parameter or a structure
 */
export interface RunItInput {
  name: string;
  location: RunItInputLocation;
  /** A RunItInputType or a structure */
  type: RunItInputType | any;
  required: boolean;
  description: string;
}

interface RunItProps {
  adaptor: IEnvironmentAdaptor;
  /** spec model to use for sdk call generation */
  api: ApiModel;
  /** Method to test */
  method: IMethod;
  /** Sdk language to use for generating call syntax */
  sdkLanguage?: string;
}

/**
 * Given an array of inputs, a method, and an api model it renders a REST request form
 * which on submit performs a REST request and renders the response with the appropriate MIME type handler
 */
export const RunIt: FC<RunItProps> = ({
  adaptor,
  api,
  method,
  sdkLanguage = 'All',
}) => {
  const httpMethod = method.httpMethod as RunItHttpMethod;
  const endpoint = method.endpoint;
  const sdk = adaptor.sdk;
  const [initialized, setInitialized] = useState(false);
  const { basePath } = useContext(RunItContext);
  const [inputs] = useState(() => createInputs(api, method));

  /** Request related state */
  const [requestContent, setRequestContent] = useState(
    initRequestContent(inputs)
  );
  const [activePathParams, setActivePathParams] = useState({});
  const [loading, setLoading] = useState<boolean>(false);
  const [keepBody, setKeepBody] = useState<boolean>(false);
  const [responseContent, setResponseContent] =
    useState<ResponseContent>(undefined);

  /** Auth config related state */
  const isExtension = adaptor.isExtension();
  const [hasConfig, setHasConfig] = useState<boolean>(
    isExtension ||
      (sdk.authSession.settings as OAuthConfigProvider).authIsConfigured()
  );
  const [needsAuth] = useState<boolean>(
    () => !isExtension && !sdk.authSession.isAuthenticated()
  );

  const [validationMessage, setValidationMessage] = useState<string>('');
  const tabs = useTabs();

  const perf = new PerfTimings();

  useEffect(() => {
    registerEnvAdaptor(adaptor);
    setInitialized(true);
  }, [adaptor]);

  const toggleKeepBody: (_event: FormEventHandler<HTMLInputElement>) => void = (
    _event: FormEventHandler<HTMLInputElement>
  ) => {
    setKeepBody((prev) => !prev);
  };

  const handleConfig = (_e: BaseSyntheticEvent) => {
    tabs.onSelectTab(4);
  };

  const handleSubmit = async (e: BaseSyntheticEvent) => {
    e.preventDefault();

    const [pathParams, queryParams, body] = createRequestParams(
      inputs,
      requestContent,
      keepBody
    );
    if (body) {
      const [bodyParam] = method.bodyParams;
      const requiredKeys = Object.keys(bodyParam.type.requiredProperties);
      const message = validateBody(body, requiredKeys);
      setValidationMessage(message);
      if (message) {
        // body has an error, don't run
        return;
      }
    }
    setActivePathParams(pathParams);
    tabs.onSelectTab(1);
    if (sdk) {
      setLoading(true);
      let response: ResponseContent;
      try {
        response = await runRequest(
          sdk,
          basePath,
          httpMethod,
          endpoint,
          pathParams,
          queryParams,
          body
        );
      } catch (err: any) {
        // This should not happen but it could. runRequest uses
        // sdk.ok to login once. sdk.ok throws an error so fake
        // out the response so something can be rendered.
        response = {
          ok: false,
          statusMessage: err.message ? err.message : 'Unknown error!',
          statusCode: -1,
          contentType: 'application/json',
          body: JSON.stringify(err),
          headers: {},
        } as ResponseContent;
      }
      setResponseContent(response);
      setLoading(false);
    }
  };

  return (
    <Box bg="background" py="large" height="100%">
      {!initialized ? (
        <Loading loading={true} />
      ) : (
        <>
          <TabList distribute {...tabs}>
            <Tab key="request">Request</Tab>
            <Tab key="response">Response</Tab>
            <Tab key="makeTheCall">SDK Call</Tab>
            {isExtension ? <></> : <Tab key="performance">Performance</Tab>}
            {isExtension ? <></> : <Tab key="configuration">Configure</Tab>}
          </TabList>
          <TabPanels px="xxlarge" {...tabs} overflow="auto" height="87vh">
            <TabPanel key="request">
              <RequestForm
                httpMethod={httpMethod}
                inputs={inputs}
                requestContent={requestContent}
                setRequestContent={setRequestContent}
                handleSubmit={handleSubmit}
                needsAuth={needsAuth}
                hasConfig={hasConfig}
                handleConfig={handleConfig}
                setHasConfig={setHasConfig}
                isExtension={isExtension}
                validationMessage={validationMessage}
                setValidationMessage={setValidationMessage}
                keepBody={keepBody}
                toggleKeepBody={toggleKeepBody}
              />
            </TabPanel>
            <TabPanel key="response">
              <Loading
                loading={loading}
                message={`${httpMethod} ${pathify(endpoint, activePathParams)}`}
              />
              <ResponseExplorer
                response={responseContent}
                verb={httpMethod}
                path={pathify(endpoint, activePathParams)}
              />
            </TabPanel>
            <TabPanel key="makeTheCall">
              <DocSdkCalls
                sdkLanguage={sdkLanguage}
                api={api}
                method={method}
                inputs={prepareInputs(inputs, requestContent)}
                keepBody={keepBody}
              />
            </TabPanel>
            {isExtension ? (
              <></>
            ) : (
              <TabPanel key="performance">
                <PerfTracker perf={perf} />
              </TabPanel>
            )}
            {isExtension ? (
              <></>
            ) : (
              <TabPanel key="config">
                <ConfigForm
                  setHasConfig={setHasConfig}
                  requestContent={requestContent}
                />
              </TabPanel>
            )}
          </TabPanels>
        </>
      )}
    </Box>
  );
};