datajunction-ui 0.0.1-a1

package/src/app/pages/NodePage/index.jsx

@@ -0,0 +1,210 @@
+import * as React from 'react';
+import { useParams } from 'react-router-dom';
+import { useContext, useEffect, useState } from 'react';
+import Tab from '../../components/Tab';
+import NamespaceHeader from '../../components/NamespaceHeader';
+import NodeInfoTab from './NodeInfoTab';
+import NodeColumnTab from './NodeColumnTab';
+import NodeLineage from './NodeGraphTab';
+import NodeHistory from './NodeHistory';
+import DJClientContext from '../../providers/djclient';
+import NodeSQLTab from './NodeSQLTab';
+import NodeMaterializationTab from './NodeMaterializationTab';
+import ClientCodePopover from './ClientCodePopover';
+import NodesWithDimension from './NodesWithDimension';
+import NodeColumnLineage from './NodeLineageTab';
+import EditIcon from '../../icons/EditIcon';
+import AlertIcon from '../../icons/AlertIcon';
+
+export function NodePage() {
+  const djClient = useContext(DJClientContext).DataJunctionAPI;
+  const [state, setState] = useState({
+    selectedTab: 0,
+  });
+
+  const [node, setNode] = useState();
+
+  const onClickTab = id => () => {
+    setState({ selectedTab: id });
+  };
+
+  const buildTabs = tab => {
+    return tab.display ? (
+      <Tab
+        key={tab.id}
+        id={tab.id}
+        name={tab.name}
+        onClick={onClickTab(tab.id)}
+        selectedTab={state.selectedTab}
+      />
+    ) : null;
+  };
+
+  const { name } = useParams();
+
+  useEffect(() => {
+    const fetchData = async () => {
+      const data = await djClient.node(name);
+      data.createNodeClientCode = await djClient.clientCode(name);
+      setNode(data);
+      if (data.type === 'metric') {
+        const metric = await djClient.metric(name);
+        data.dimensions = metric.dimensions;
+        setNode(data);
+      }
+      if (data.type === 'cube') {
+        const cube = await djClient.cube(name);
+        data.cube_elements = cube.cube_elements;
+        setNode(data);
+      }
+    };
+    fetchData().catch(console.error);
+  }, [djClient, name]);
+
+  const tabsList = node => {
+    return [
+      {
+        id: 0,
+        name: 'Info',
+        display: true,
+      },
+      {
+        id: 1,
+        name: 'Columns',
+        display: true,
+      },
+      {
+        id: 2,
+        name: 'Graph',
+        display: true,
+      },
+      {
+        id: 3,
+        name: 'History',
+        display: true,
+      },
+      {
+        id: 4,
+        name: 'SQL',
+        display: node?.type !== 'dimension' && node?.type !== 'source',
+      },
+      {
+        id: 5,
+        name: 'Materializations',
+        display: node?.type !== 'source',
+      },
+      {
+        id: 6,
+        name: 'Linked Nodes',
+        display: node?.type === 'dimension',
+      },
+      {
+        id: 7,
+        name: 'Lineage',
+        display: node?.type === 'metric',
+      },
+    ];
+  };
+
+  //
+  //
+  let tabToDisplay = null;
+  switch (state.selectedTab) {
+    case 0:
+      tabToDisplay =
+        node && node.message === undefined ? <NodeInfoTab node={node} /> : '';
+      break;
+    case 1:
+      tabToDisplay = <NodeColumnTab node={node} djClient={djClient} />;
+      break;
+    case 2:
+      tabToDisplay = <NodeLineage djNode={node} djClient={djClient} />;
+      break;
+    case 3:
+      tabToDisplay = <NodeHistory node={node} djClient={djClient} />;
+      break;
+    case 4:
+      tabToDisplay =
+        node?.type === 'metric' ? <NodeSQLTab djNode={node} /> : <br />;
+      break;
+    case 5:
+      tabToDisplay = <NodeMaterializationTab node={node} djClient={djClient} />;
+      break;
+    case 6:
+      tabToDisplay = <NodesWithDimension node={node} djClient={djClient} />;
+      break;
+    case 7:
+      tabToDisplay = <NodeColumnLineage djNode={node} djClient={djClient} />;
+      break;
+    default: /* istanbul ignore next */
+      tabToDisplay = <NodeInfoTab node={node} />;
+  }
+  // @ts-ignore
+  return (
+    <div className="node__header">
+      <NamespaceHeader namespace={name.split('.').slice(0, -1).join('.')} />
+      <div className="card">
+        {node?.message === undefined ? (
+          <div className="card-header">
+            <h3
+              className="card-title align-items-start flex-column"
+              style={{ display: 'inline-block' }}
+            >
+              <span
+                className="card-label fw-bold text-gray-800"
+                role="dialog"
+                aria-hidden="false"
+                aria-label="DisplayName"
+              >
+                {node?.display_name}{' '}
+                <span
+                  className={'node_type__' + node?.type + ' badge node_type'}
+                  role="dialog"
+                  aria-hidden="false"
+                  aria-label="NodeType"
+                >
+                  {node?.type}
+                </span>
+              </span>
+            </h3>
+            <a
+              href={`/nodes/${node?.name}/edit`}
+              style={{ marginLeft: '0.5rem' }}
+            >
+              <EditIcon />
+            </a>
+            <ClientCodePopover code={node?.createNodeClientCode} />
+            <div>
+              <a
+                href={'/nodes/' + node?.name}
+                className="link-table"
+                role="dialog"
+                aria-hidden="false"
+                aria-label="NodeName"
+              >
+                {node?.name}
+              </a>
+              <span
+                className="rounded-pill badge bg-secondary-soft"
+                style={{ marginLeft: '0.5rem' }}
+              >
+                {node?.version}
+              </span>
+            </div>
+            <div className="align-items-center row">
+              {tabsList(node).map(buildTabs)}
+            </div>
+            {tabToDisplay}
+          </div>
+        ) : node?.message !== undefined ? (
+          <div className="message alert" style={{ margin: '20px' }}>
+            <AlertIcon />
+            Node `{name}` does not exist!
+          </div>
+        ) : (
+          ''
+        )}
+      </div>
+    </div>
+  );
+}

package/src/app/pages/NotFoundPage/Loadable.tsx

@@ -0,0 +1,14 @@
+/**
+ * Asynchronously loads the component for NotFoundPage
+ */
+
+import * as React from 'react';
+import { lazyLoad } from '../../../utils/loadable';
+
+export const NotFoundPage = lazyLoad(
+  () => import('./index'),
+  module => module.NotFoundPage,
+  {
+    fallback: <></>,
+  },
+);

package/src/app/pages/NotFoundPage/__tests__/index.test.jsx

@@ -0,0 +1,16 @@
+import React from 'react';
+import { render } from '@testing-library/react';
+import { NotFoundPage } from '../index';
+import { HelmetProvider } from 'react-helmet-async';
+
+describe('<NotFoundPage />', () => {
+  it('displays the correct 404 message ', () => {
+    const { getByText } = render(
+      <HelmetProvider>
+        <NotFoundPage />
+      </HelmetProvider>,
+    );
+
+    expect(getByText('Page not found.')).toBeInTheDocument();
+  });
+});

package/src/app/pages/NotFoundPage/index.tsx

@@ -0,0 +1,23 @@
+import * as React from 'react';
+import { Helmet } from 'react-helmet-async';
+
+export function NotFoundPage() {
+  return (
+    <>
+      <Helmet>
+        <title>404 Page Not Found</title>
+        <meta name="description" content="Page not found" />
+      </Helmet>
+      <div>
+        <label>
+          4
+          <span role="img" aria-label="Crying Face">
+            😢
+          </span>
+          4
+        </label>
+        <p>Page not found.</p>
+      </div>
+    </>
+  );
+}

package/src/app/pages/RegisterTablePage/Loadable.jsx

@@ -0,0 +1,16 @@
+/**
+ * Asynchronously loads the component for the Node page
+ */
+
+import * as React from 'react';
+import { lazyLoad } from '../../../utils/loadable';
+
+export const RegisterTablePage = () => {
+  return lazyLoad(
+    () => import('./index'),
+    module => module.RegisterTablePage,
+    {
+      fallback: <div></div>,
+    },
+  )();
+};

package/src/app/pages/RegisterTablePage/__tests__/RegisterTablePage.test.jsx

@@ -0,0 +1,110 @@
+import React from 'react';
+import { fireEvent, screen, waitFor } from '@testing-library/react';
+import fetchMock from 'jest-fetch-mock';
+import userEvent from '@testing-library/user-event';
+import { render } from '../../../../setupTests';
+import { MemoryRouter, Route, Routes } from 'react-router-dom';
+import DJClientContext from '../../../providers/djclient';
+import { RegisterTablePage } from '../index';
+
+describe('<RegisterTablePage />', () => {
+  const initializeMockDJClient = () => {
+    return {
+      DataJunctionAPI: {
+        catalogs: jest.fn(),
+        registerTable: jest.fn(),
+      },
+    };
+  };
+
+  const mockDjClient = initializeMockDJClient();
+
+  beforeEach(() => {
+    fetchMock.resetMocks();
+    jest.clearAllMocks();
+    window.scrollTo = jest.fn();
+
+    mockDjClient.DataJunctionAPI.catalogs.mockReturnValue([
+      {
+        name: 'warehouse',
+        engines: [
+          {
+            name: 'duckdb',
+            version: '0.7.1',
+            uri: null,
+            dialect: null,
+          },
+        ],
+      },
+    ]);
+  });
+
+  const renderRegisterTable = element => {
+    return render(
+      <MemoryRouter initialEntries={['/create/source']}>
+        <Routes>
+          <Route path="create/source" element={element} />
+        </Routes>
+      </MemoryRouter>,
+    );
+  };
+
+  const testElement = djClient => {
+    return (
+      <DJClientContext.Provider value={djClient}>
+        <RegisterTablePage />
+      </DJClientContext.Provider>
+    );
+  };
+
+  it('registers a table correctly', async () => {
+    mockDjClient.DataJunctionAPI.registerTable.mockReturnValue({
+      status: 201,
+      json: { name: 'source.warehouse.schema.some_table' },
+    });
+
+    const element = testElement(mockDjClient);
+    const { container, getByTestId } = renderRegisterTable(element);
+
+    const catalog = getByTestId('choose-catalog');
+    await waitFor(async () => {
+      fireEvent.keyDown(catalog.firstChild, { key: 'ArrowDown' });
+      fireEvent.click(screen.getByText('warehouse'));
+    });
+
+    await userEvent.type(screen.getByLabelText('Schema'), 'schema');
+    await userEvent.type(screen.getByLabelText('Table'), 'some_table');
+    await userEvent.click(screen.getByRole('button'));
+
+    await waitFor(() => {
+      expect(mockDjClient.DataJunctionAPI.registerTable).toBeCalled();
+      expect(mockDjClient.DataJunctionAPI.registerTable).toBeCalledWith(
+        'warehouse',
+        'schema',
+        'some_table',
+      );
+    });
+    expect(container.getElementsByClassName('message')).toMatchSnapshot();
+  }, 60000);
+
+  it('fails to register a table', async () => {
+    mockDjClient.DataJunctionAPI.registerTable.mockReturnValue({
+      status: 500,
+      json: { message: 'table not found' },
+    });
+
+    const element = testElement(mockDjClient);
+    const { getByTestId } = renderRegisterTable(element);
+
+    const catalog = getByTestId('choose-catalog');
+    await waitFor(async () => {
+      fireEvent.keyDown(catalog.firstChild, { key: 'ArrowDown' });
+      fireEvent.click(screen.getByText('warehouse'));
+    });
+
+    await userEvent.type(screen.getByLabelText('Schema'), 'schema');
+    await userEvent.type(screen.getByLabelText('Table'), 'some_table');
+    await userEvent.click(screen.getByRole('button'));
+    expect(screen.getByText('table not found')).toBeInTheDocument();
+  }, 60000);
+});

package/src/app/pages/RegisterTablePage/__tests__/__snapshots__/RegisterTablePage.test.jsx.snap

@@ -0,0 +1,37 @@
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`<RegisterTablePage /> registers a table correctly 1`] = `
+HTMLCollection [
+  <div
+    class="message success"
+    data-testid="success"
+  >
+    <svg
+      class="bi bi-check-circle-fill"
+      fill="currentColor"
+      height="25"
+      viewBox="0 0 16 16"
+      width="25"
+      xmlns="http://www.w3.org/2000/svg"
+    >
+      <path
+        d="M16 8A8 8 0 1 1 0 8a8 8 0 0 1 16 0zm-3.97-3.03a.75.75 0 0 0-1.08.022L7.477 9.417 5.384 7.323a.75.75 0 0 0-1.06 1.06L6.97 11.03a.75.75 0 0 0 1.079-.02l3.992-4.99a.75.75 0 0 0-.01-1.05z"
+      />
+    </svg>
+    Successfully registered source node
+     
+    <a
+      href="/nodes/source.warehouse.schema.some_table"
+    >
+      source.warehouse.schema.some_table
+    </a>
+    , which references table 
+    warehouse
+    .
+    schema
+    .
+    some_table
+    .
+  </div>,
+]
+`;

package/src/app/pages/RegisterTablePage/index.jsx

@@ -0,0 +1,142 @@
+/**
+ * Node add + edit page for transforms, metrics, and dimensions. The creation and edit flow for these
+ * node types is largely the same, with minor differences handled server-side. For the `query`
+ * field, this page will render a CodeMirror SQL editor with autocompletion and syntax highlighting.
+ */
+import { ErrorMessage, Field, Form, Formik } from 'formik';
+
+import NamespaceHeader from '../../components/NamespaceHeader';
+import React, { useContext, useEffect, useState } from 'react';
+import DJClientContext from '../../providers/djclient';
+import 'styles/node-creation.scss';
+import { FormikSelect } from '../AddEditNodePage/FormikSelect';
+import { displayMessageAfterSubmit } from '../../../utils/form';
+
+export function RegisterTablePage() {
+  const djClient = useContext(DJClientContext).DataJunctionAPI;
+  const [catalogs, setCatalogs] = useState([]);
+
+  useEffect(() => {
+    const fetchData = async () => {
+      const catalogs = await djClient.catalogs();
+      setCatalogs(
+        catalogs.map(catalog => {
+          return { value: catalog.name, label: catalog.name };
+        }),
+      );
+    };
+    fetchData().catch(console.error);
+  }, [djClient, djClient.namespaces]);
+
+  const initialValues = {
+    catalog: '',
+    schema: '',
+    table: '',
+  };
+
+  const validator = values => {
+    const errors = {};
+    if (!values.table) {
+      errors.table = 'Required';
+    }
+    if (!values.schema) {
+      errors.schema = 'Required';
+    }
+    return errors;
+  };
+
+  const handleSubmit = async (values, { setSubmitting, setStatus }) => {
+    const { status, json } = await djClient.registerTable(
+      values.catalog,
+      values.schema,
+      values.table,
+    );
+    if (status === 200 || status === 201) {
+      setStatus({
+        success: (
+          <>
+            Successfully registered source node{' '}
+            <a href={`/nodes/${json.name}`}>{json.name}</a>, which references
+            table {values.catalog}.{values.schema}.{values.table}.
+          </>
+        ),
+      });
+    } else {
+      setStatus({
+        failure: `${json.message}`,
+      });
+    }
+    setSubmitting(false);
+    window.scrollTo({ top: 0, left: 0, behavior: 'smooth' });
+  };
+
+  return (
+    <div className="mid">
+      <NamespaceHeader namespace="" />
+      <div className="card">
+        <div className="card-header">
+          <h2>
+            Register{' '}
+            <span className={`node_type__source node_type_creation_heading`}>
+              Source
+            </span>
+          </h2>
+          <center>
+            <Formik
+              initialValues={initialValues}
+              validate={validator}
+              onSubmit={handleSubmit}
+            >
+              {function Render({ isSubmitting, status }) {
+                return (
+                  <Form>
+                    {displayMessageAfterSubmit(status)}
+                    {
+                      <>
+                        <div className="SourceCreationInput">
+                          <ErrorMessage name="catalog" component="span" />
+                          <label htmlFor="catalog">Catalog</label>
+                          <span data-testid="choose-catalog">
+                            <FormikSelect
+                              selectOptions={catalogs}
+                              formikFieldName="catalog"
+                              placeholder="Choose Catalog"
+                              defaultValue={catalogs[0]}
+                            />
+                          </span>
+                        </div>
+                        <div className="SourceCreationInput">
+                          <ErrorMessage name="schema" component="span" />
+                          <label htmlFor="schema">Schema</label>
+                          <Field
+                            type="text"
+                            name="schema"
+                            id="schema"
+                            placeholder="Schema"
+                          />
+                        </div>
+                        <div className="SourceCreationInput NodeCreationInput">
+                          <ErrorMessage name="table" component="span" />
+                          <label htmlFor="table">Table</label>
+                          <Field
+                            type="text"
+                            name="table"
+                            id="table"
+                            placeholder="Table"
+                          />
+                        </div>
+                        <button type="submit" disabled={isSubmitting}>
+                          Register
+                        </button>
+                      </>
+                    }
+                  </Form>
+                );
+              }}
+            </Formik>
+          </center>
+        </div>
+      </div>
+    </div>
+  );
+}

package/src/app/pages/Root/Loadable.tsx

@@ -0,0 +1,14 @@
+/**
+ * Asynchronously loads the component for the root page
+ */
+
+import * as React from 'react';
+import { lazyLoad } from '../../../utils/loadable';
+
+export const Root = lazyLoad(
+  () => import('./index'),
+  module => module.Root,
+  {
+    fallback: <></>,
+  },
+);

package/src/app/pages/Root/__tests__/index.test.jsx

@@ -0,0 +1,77 @@
+import React from 'react';
+import { render, screen, waitFor } from '@testing-library/react';
+import { Root } from '../index';
+import DJClientContext from '../../../providers/djclient';
+import { HelmetProvider } from 'react-helmet-async';
+
+describe('<Root />', () => {
+  const mockDjClient = {
+    logout: jest.fn(),
+  };
+
+  it('renders with the correct title and navigation', async () => {
+    render(
+      <HelmetProvider>
+        <DJClientContext.Provider value={{ DataJunctionAPI: mockDjClient }}>
+          <Root />
+        </DJClientContext.Provider>
+      </HelmetProvider>,
+    );
+
+    waitFor(() => {
+      expect(document.title).toEqual('DataJunction');
+      const metaDescription = document.querySelector(
+        "meta[name='description']",
+      );
+      expect(metaDescription).toBeInTheDocument();
+      expect(metaDescription.content).toBe(
+        'DataJunction Metrics Platform Webapp',
+      );
+
+      expect(screen.getByText(/^DataJunction$/)).toBeInTheDocument();
+      expect(screen.getByText('Explore').closest('a')).toHaveAttribute(
+        'href',
+        '/',
+      );
+      expect(screen.getByText('SQL').closest('a')).toHaveAttribute(
+        'href',
+        '/sql',
+      );
+      expect(screen.getByText('Docs').closest('a')).toHaveAttribute(
+        'href',
+        'https://www.datajunction.io',
+      );
+    });
+  });
+
+  it('renders Logout button unless REACT_DISABLE_AUTH is true', () => {
+    process.env.REACT_DISABLE_AUTH = 'false';
+    render(
+      <HelmetProvider>
+        <DJClientContext.Provider value={{ DataJunctionAPI: mockDjClient }}>
+          <Root />
+        </DJClientContext.Provider>
+      </HelmetProvider>,
+    );
+    expect(screen.getByText('Logout')).toBeInTheDocument();
+  });
+
+  it('calls logout and reloads window on logout button click', () => {
+    process.env.REACT_DISABLE_AUTH = 'false';
+    const originalLocation = window.location;
+    delete window.location;
+    window.location = { ...originalLocation, reload: jest.fn() };
+
+    render(
+      <HelmetProvider>
+        <DJClientContext.Provider value={{ DataJunctionAPI: mockDjClient }}>
+          <Root />
+        </DJClientContext.Provider>
+      </HelmetProvider>,
+    );
+
+    screen.getByText('Logout').click();
+    expect(mockDjClient.logout).toHaveBeenCalled();
+    window.location = originalLocation;
+  });
+});