Catalog: Admin: Tabulator Settings (open query) + docs

catalog/CHANGELOG.md

@@ -17,6 +17,7 @@ where verb is one of
 
 ## Changes
 
+- [Added] Admin: Tabulator Settings (open query) ([#4255](https://github.com/quiltdata/quilt/pull/4255))
 - [Added] Visual editor for `quilt_summarize.json` ([#4254](https://github.com/quiltdata/quilt/pull/4254))
 - [Added] Support "html" type in `quilt_summarize.json` ([#4252](https://github.com/quiltdata/quilt/pull/4252))
 - [Fixed] Resolve caching issues where changes in `.quilt/{workflows,catalog}` were not applied ([#4245](https://github.com/quiltdata/quilt/pull/4245))

catalog/app/containers/Admin/Settings/Settings.tsx

@@ -12,6 +12,7 @@
 
 import * as Form from '../Form'
 import SearchSettings from './SearchSettings'
+import TabulatorSettings from './TabulatorSettings'
 import ThemeEditor from './ThemeEditor'
 
 function useBeta(): [boolean, (b: boolean) => Promise<void>] {
@@ -273,6 +274,10 @@
   title: {
     margin: t.spacing(0, 0, 2),
     padding: t.spacing(0, 2),
+
+    '* + &': {
+      marginTop: t.spacing(2),
+    },
   },
 }))
 
@@ -324,6 +329,13 @@
           </M.Paper>
         </M.Grid>
       </M.Grid>
+
+      <M.Typography variant="h5" className={classes.title}>
+        Tabulator Settings
+      </M.Typography>
+      <M.Paper className={classes.group}>
+        <TabulatorSettings />
+      </M.Paper>
     </div>
   )
 }

catalog/app/containers/Admin/Settings/TabulatorSettings.tsx

@@ -0,0 +1,90 @@
+import * as React from 'react'
+import * as M from '@material-ui/core'
+import * as Lab from '@material-ui/lab'
+import * as Sentry from '@sentry/react'
+
+import Skeleton from 'components/Skeleton'
+import { docs } from 'constants/urls'
+import * as Notifications from 'containers/Notifications'
+import * as GQL from 'utils/GraphQL'
+import StyledLink from 'utils/StyledLink'
+
+import OPEN_QUERY_QUERY from './gql/TabulatorOpenQuery.generated'
+import SET_OPEN_QUERY_MUTATION from './gql/SetTabulatorOpenQuery.generated'
+
+interface ToggleProps {
+  checked: boolean
+}
+
+function Toggle({ checked }: ToggleProps) {
+  const { push: notify } = Notifications.use()
+  const mutate = GQL.useMutation(SET_OPEN_QUERY_MUTATION)
+  const [mutation, setMutation] = React.useState<{ enabled: boolean } | null>(null)
+
+  const handleChange = React.useCallback(
+    async (_event, enabled: boolean) => {
+      if (mutation) return
+      setMutation({ enabled })
+      try {
+        await mutate({ enabled })
+      } catch (e) {
+        Sentry.captureException(e)
+        notify(`Failed to update tabulator settings: ${e}`)
+      } finally {
+        setMutation(null)
+      }
+    },
+    [mutate, notify, mutation],
+  )
+
+  return (
+    <>
+      <M.FormControlLabel
+        control={
+          <M.Switch
+            checked={mutation?.enabled ?? checked}
+            onChange={handleChange}
+            disabled={!!mutation}
+          />
+        }
+        label="Enable open querying of Tabulator tables"
+      />
+      <M.FormHelperText>
+        <b>CAUTION:</b> When enabled, Tabulator defers all access control to AWS and does
+        not enforce any extra restrictions.{' '}
+        <StyledLink
+          href={`${docs}/advanced-features/tabulator#open-query`}
+          target="_blank"
+        >
+          Learn more
+        </StyledLink>{' '}
+        in the documentation.
+      </M.FormHelperText>
+    </>
+  )
+}
+
+export default function TabulatorSettings() {
+  const query = GQL.useQuery(OPEN_QUERY_QUERY)
+
+  return (
+    <M.FormGroup>
+      {GQL.fold(query, {
+        data: ({ admin }) => <Toggle checked={admin.tabulatorOpenQuery} />,
+        fetching: () => (
+          <>
+            <Skeleton width="40%" height={38} />
+            <Skeleton width="80%" height={20} mt="3px" />
+          </>
+        ),
+        error: (e) => (
+          <Lab.Alert severity="error">
+            Could not fetch tabulator settings:
+            <br />
+            {e.message}
+          </Lab.Alert>
+        ),
+      })}
+    </M.FormGroup>
+  )
+}

catalog/app/containers/Admin/Settings/gql/SetTabulatorOpenQuery.generated.ts

@@ -0,0 +1,84 @@
+/* eslint-disable @typescript-eslint/naming-convention */
+import type { TypedDocumentNode as DocumentNode } from '@graphql-typed-document-node/core'
+import * as Types from '../../../../model/graphql/types.generated'
+
+export type containers_Admin_Settings_gql_SetTabulatorOpenQueryMutationVariables =
+  Types.Exact<{
+    enabled: Types.Scalars['Boolean']
+  }>
+
+export type containers_Admin_Settings_gql_SetTabulatorOpenQueryMutation = {
+  readonly __typename: 'Mutation'
+} & {
+  readonly admin: { readonly __typename: 'AdminMutations' } & {
+    readonly setTabulatorOpenQuery: {
+      readonly __typename: 'TabulatorOpenQueryResult'
+    } & Pick<Types.TabulatorOpenQueryResult, 'tabulatorOpenQuery'>
+  }
+}
+
+export const containers_Admin_Settings_gql_SetTabulatorOpenQueryDocument = {
+  kind: 'Document',
+  definitions: [
+    {
+      kind: 'OperationDefinition',
+      operation: 'mutation',
+      name: {
+        kind: 'Name',
+        value: 'containers_Admin_Settings_gql_SetTabulatorOpenQuery',
+      },
+      variableDefinitions: [
+        {
+          kind: 'VariableDefinition',
+          variable: { kind: 'Variable', name: { kind: 'Name', value: 'enabled' } },
+          type: {
+            kind: 'NonNullType',
+            type: { kind: 'NamedType', name: { kind: 'Name', value: 'Boolean' } },
+          },
+        },
+      ],
+      selectionSet: {
+        kind: 'SelectionSet',
+        selections: [
+          {
+            kind: 'Field',
+            name: { kind: 'Name', value: 'admin' },
+            selectionSet: {
+              kind: 'SelectionSet',
+              selections: [
+                {
+                  kind: 'Field',
+                  name: { kind: 'Name', value: 'setTabulatorOpenQuery' },
+                  arguments: [
+                    {
+                      kind: 'Argument',
+                      name: { kind: 'Name', value: 'enabled' },
+                      value: {
+                        kind: 'Variable',
+                        name: { kind: 'Name', value: 'enabled' },
+                      },
+                    },
+                  ],
+                  selectionSet: {
+                    kind: 'SelectionSet',
+                    selections: [
+                      {
+                        kind: 'Field',
+                        name: { kind: 'Name', value: 'tabulatorOpenQuery' },
+                      },
+                    ],
+                  },
+                },
+              ],
+            },
+          },
+        ],
+      },
+    },
+  ],
+} as unknown as DocumentNode<
+  containers_Admin_Settings_gql_SetTabulatorOpenQueryMutation,
+  containers_Admin_Settings_gql_SetTabulatorOpenQueryMutationVariables
+>
+
+export { containers_Admin_Settings_gql_SetTabulatorOpenQueryDocument as default }

catalog/app/containers/Admin/Settings/gql/SetTabulatorOpenQuery.graphql

@@ -0,0 +1,7 @@
+mutation($enabled: Boolean!) {
+  admin {
+    setTabulatorOpenQuery(enabled: $enabled) {
+      tabulatorOpenQuery
+    }
+  }
+}

catalog/app/containers/Admin/Settings/gql/TabulatorOpenQuery.generated.ts

@@ -0,0 +1,47 @@
+/* eslint-disable @typescript-eslint/naming-convention */
+import type { TypedDocumentNode as DocumentNode } from '@graphql-typed-document-node/core'
+import * as Types from '../../../../model/graphql/types.generated'
+
+export type containers_Admin_Settings_gql_TabulatorOpenQueryQueryVariables = Types.Exact<{
+  [key: string]: never
+}>
+
+export type containers_Admin_Settings_gql_TabulatorOpenQueryQuery = {
+  readonly __typename: 'Query'
+} & {
+  readonly admin: { readonly __typename: 'AdminQueries' } & Pick<
+    Types.AdminQueries,
+    'tabulatorOpenQuery'
+  >
+}
+
+export const containers_Admin_Settings_gql_TabulatorOpenQueryDocument = {
+  kind: 'Document',
+  definitions: [
+    {
+      kind: 'OperationDefinition',
+      operation: 'query',
+      name: { kind: 'Name', value: 'containers_Admin_Settings_gql_TabulatorOpenQuery' },
+      selectionSet: {
+        kind: 'SelectionSet',
+        selections: [
+          {
+            kind: 'Field',
+            name: { kind: 'Name', value: 'admin' },
+            selectionSet: {
+              kind: 'SelectionSet',
+              selections: [
+                { kind: 'Field', name: { kind: 'Name', value: 'tabulatorOpenQuery' } },
+              ],
+            },
+          },
+        ],
+      },
+    },
+  ],
+} as unknown as DocumentNode<
+  containers_Admin_Settings_gql_TabulatorOpenQueryQuery,
+  containers_Admin_Settings_gql_TabulatorOpenQueryQueryVariables
+>
+
+export { containers_Admin_Settings_gql_TabulatorOpenQueryDocument as default }

catalog/app/containers/Admin/Settings/gql/TabulatorOpenQuery.graphql

@@ -0,0 +1,5 @@
+query {
+  admin {
+    tabulatorOpenQuery
+  }
+}

catalog/app/model/graphql/schema.generated.ts

@@ -240,9 +240,37 @@ export default {
               },
             ],
           },
+          {
+            name: 'setTabulatorOpenQuery',
+            type: {
+              kind: 'NON_NULL',
+              ofType: {
+                kind: 'OBJECT',
+                name: 'TabulatorOpenQueryResult',
+                ofType: null,
+              },
+            },
+            args: [
+              {
+                name: 'enabled',
+                type: {
+                  kind: 'NON_NULL',
+                  ofType: {
+                    kind: 'SCALAR',
+                    name: 'Boolean',
+                    ofType: null,
+                  },
+                },
+              },
+            ],
+          },
         ],
         interfaces: [],
       },
+      {
+        kind: 'SCALAR',
+        name: 'Boolean',
+      },
       {
         kind: 'OBJECT',
         name: 'AdminQueries',
@@ -280,13 +308,21 @@ export default {
             },
             args: [],
           },
+          {
+            name: 'tabulatorOpenQuery',
+            type: {
+              kind: 'NON_NULL',
+              ofType: {
+                kind: 'SCALAR',
+                name: 'Boolean',
+                ofType: null,
+              },
+            },
+            args: [],
+          },
         ],
         interfaces: [],
       },
-      {
-        kind: 'SCALAR',
-        name: 'Boolean',
-      },
       {
         kind: 'OBJECT',
         name: 'BooleanPackageUserMetaFacet',
@@ -5437,6 +5473,25 @@ export default {
           },
         ],
       },
+      {
+        kind: 'OBJECT',
+        name: 'TabulatorOpenQueryResult',
+        fields: [
+          {
+            name: 'tabulatorOpenQuery',
+            type: {
+              kind: 'NON_NULL',
+              ofType: {
+                kind: 'SCALAR',
+                name: 'Boolean',
+                ofType: null,
+              },
+            },
+            args: [],
+          },
+        ],
+        interfaces: [],
+      },
       {
         kind: 'OBJECT',
         name: 'TabulatorTable',