feat: add mutation to allow adding of gsi - admin only

Author: pregnantboy

packages/backend/src/graphql/admin/mutations/add-gsi.ts

@@ -0,0 +1,56 @@
+import { flattenJsonb } from '@/helpers/knex-jsonb-flatten'
+import { GSIS } from '@/models/dynamodb/table-row'
+import TableColumnMetadata from '@/models/table-column-metadata'
+
+import type { AdminMutationResolvers } from '../../__generated__/types.generated'
+
+const createTable: AdminMutationResolvers['addGsi'] = async (
+  _parent,
+  params,
+  context,
+) => {
+  const { tableId, columnId, indexName } = params.input
+
+  if (!tableId || !columnId) {
+    throw new Error('Table id and column id required')
+  }
+
+  const correspondingGsi = GSIS.find((g) => g.gsi === indexName)
+  if (!correspondingGsi) {
+    throw new Error('Invalid index name')
+  }
+
+  const table = await context.currentUser
+    .$relatedQuery('tables')
+    .findById(tableId)
+    .withGraphFetched('columns')
+    .throwIfNotFound()
+
+  const correspondingColumn = table.columns.find((c) => c.id === columnId)
+  if (!correspondingColumn) {
+    throw new Error('Column not found')
+  }
+
+  const alreadyHasGsi = table.columns.some((c) => !!c.config.gsi)
+  if (alreadyHasGsi) {
+    throw new Error('Table already has a GSI')
+  }
+
+  await TableColumnMetadata.query()
+    .patch(
+      flattenJsonb({
+        config: {
+          gsi: {
+            indexName: correspondingGsi.gsi,
+            type: correspondingGsi.type,
+            status: 'pending',
+          },
+        },
+      }),
+    )
+    .where({ id: columnId })
+
+  return true
+}
+
+export default createTable

packages/backend/src/graphql/admin/mutations/index.ts

@@ -0,0 +1,7 @@
+import type { AdminMutationResolvers } from '../../__generated__/types.generated'
+
+import addGsi from './add-gsi'
+
+export default {
+  addGsi,
+} satisfies AdminMutationResolvers

packages/backend/src/graphql/mutation-resolvers.ts

@@ -82,4 +82,9 @@ export default {
   deleteUploadedFile,
   generatePresignedUrl,
   ...tilesMutationResolvers,
+
+  // This is a special stub that enables us to group all our admin-related
+  // mutations into a special AdminMutation object; each "mutations" is handled by field
+  // resolvers defined in @/graphql/admin/mutations.
+  admin: () => ({}),
 } satisfies MutationResolvers

packages/backend/src/graphql/resolvers.ts

@@ -1,4 +1,5 @@
 import type { Resolvers } from './__generated__/types.generated'
+import adminMutationResolvers from './admin/mutations'
 import adminQueryResolvers from './admin/queries'
 import customResolvers from './custom-resolvers'
 import mutationResolvers from './mutation-resolvers'
@@ -8,5 +9,6 @@ export default {
   Query: queryResolvers,
   Mutation: mutationResolvers,
   AdminQuery: adminQueryResolvers,
+  AdminMutation: adminMutationResolvers,
   ...customResolvers,
 } satisfies Resolvers

packages/backend/src/graphql/schema.graphql

@@ -115,6 +115,12 @@ type Mutation {
   # Flow transfers
   createFlowTransfer(input: CreateFlowTransferInput!): FlowTransfer!
   updateFlowTransferStatus(input: UpdateFlowTransferStatusInput): FlowTransfer!
+  # Admin mutations
+  admin: AdminMutation!
+}
+
+type AdminMutation {
+  addGsi(input: AddGsiInput!): Boolean
 }
 
 """
@@ -762,6 +768,13 @@ input DeleteTableInput {
 
 type TableColumnConfig {
   width: Int
+  gsi: TableColumnGsiConfig
+}
+
+type TableColumnGsiConfig {
+  indexName: String!
+  type: String!
+  status: String!
 }
 
 type TableColumnMetadata {
@@ -834,6 +847,13 @@ input DeleteTableRowsInput {
   tableId: ID!
   rowIds: [ID!]!
 }
+
+input AddGsiInput {
+  tableId: ID!
+  columnId: ID!
+  indexName: String!
+}
+
 # End Tiles row types
 
 type AppHealth {

packages/backend/src/helpers/authentication.ts

@@ -103,7 +103,9 @@ const authentication = shield(
       // Not OTP, but no real reason to be looser than OTP.
       loginWithSgid: rateLimitRule({ window: '1s', max: 5 }),
       loginWithSelectedSgid: rateLimitRule({ window: '1s', max: 5 }),
+      admin: isAdminOperation,
     },
+    AdminMutation: isAdminOperation,
   },
   {
     allowExternalErrors: true,