Implement exploration saving RPC APIs on front end

mathesar-foundation · Sep 26, 2024 · 9b49404 · 9b49404
1 parent f3a64c1
commit 9b49404
Show file tree

Hide file tree

Showing 12 changed files with 212 additions and 172 deletions.
diff --git a/mathesar_ui/src/api/rpc/explorations.ts b/mathesar_ui/src/api/rpc/explorations.ts
@@ -78,23 +78,53 @@ export type QueryInstanceTransformation =
   | QueryInstanceHideTransformation
   | QueryInstanceSortTransformation;
 
-export interface SavedExploration {
-  id: number;
+/** The data an exploration contains when the data explorer opens */
+export interface InitialExploration {
   database_id: number;
-  name: string;
-  description?: string;
+  schema_oid: number;
+}
+
+/** The data needed to run an exploration without it being saved */
+export interface AnonymousExploration extends InitialExploration {
   base_table_oid: number;
   initial_columns: InitialColumn[];
   transformations?: QueryInstanceTransformation[];
   display_names?: Record<string, string> | null;
   display_options?: unknown[];
 }
 
-export type UnsavedExploration = Partial<SavedExploration> & {
-  database_id: number;
-};
+export interface AddableExploration extends AnonymousExploration {
+  name: string;
+  description?: string;
+}
 
-export type AnonymousExploration = Omit<SavedExploration, 'id' | 'name'>;
+export interface SavedExploration extends AddableExploration {
+  id: number;
+}
+
+export type MaybeSavedExploration = Partial<SavedExploration> &
+  InitialExploration;
+
+export function explorationIsAddable(
+  e: MaybeSavedExploration,
+): e is MaybeSavedExploration & AddableExploration {
+  return (
+    'name' in e &&
+    e.name !== '' &&
+    e.name !== undefined &&
+    'base_table_oid' in e &&
+    e.base_table_oid !== undefined &&
+    'initial_columns' in e &&
+    e.initial_columns !== undefined &&
+    e.initial_columns.length > 0
+  );
+}
+
+export function explorationIsSaved(
+  e: MaybeSavedExploration,
+): e is SavedExploration {
+  return explorationIsAddable(e) && 'id' in e && e.id !== undefined;
+}
 
 export interface ExplorationRunParams {
   exploration_def: AnonymousExploration;
@@ -164,17 +194,23 @@ export interface ExplorationResult {
 }
 
 export const explorations = {
-  list: rpcMethodTypeContainer<{ database_id: number }, SavedExploration[]>(),
+  list: rpcMethodTypeContainer<
+    { database_id: number; schema_oid: number },
+    SavedExploration[]
+  >(),
 
   get: rpcMethodTypeContainer<{ exploration_id: number }, SavedExploration>(),
 
-  add: rpcMethodTypeContainer<AnonymousExploration & { name: string }, void>(),
+  add: rpcMethodTypeContainer<
+    { exploration_def: AddableExploration },
+    SavedExploration
+  >(),
 
   delete: rpcMethodTypeContainer<{ exploration_id: number }, void>(),
 
   replace: rpcMethodTypeContainer<
     { new_exploration: SavedExploration },
-    void
+    SavedExploration
   >(),
 
   run: rpcMethodTypeContainer<ExplorationRunParams, ExplorationResult>(),

diff --git a/mathesar_ui/src/pages/schema/SchemaOverview.svelte b/mathesar_ui/src/pages/schema/SchemaOverview.svelte
@@ -10,7 +10,7 @@
   import type { Schema } from '@mathesar/models/Schema';
   import type { Table } from '@mathesar/models/Table';
   import { getDataExplorerPageUrl } from '@mathesar/routes/urls';
-  import { refetchQueriesForSchema } from '@mathesar/stores/queries';
+  import { refetchExplorationsForSchema } from '@mathesar/stores/queries';
   import { refetchTablesForSchema } from '@mathesar/stores/tables';
   import { AnchorButton, Button } from '@mathesar-component-library';
 
@@ -88,7 +88,7 @@
           <div>
             <SpinnerButton
               onClick={async () => {
-                await refetchQueriesForSchema(schema.oid);
+                await refetchExplorationsForSchema(schema);
               }}
               label={$_('retry')}
               icon={iconRefresh}

diff --git a/mathesar_ui/src/routes/DataExplorerRoute.svelte b/mathesar_ui/src/routes/DataExplorerRoute.svelte
@@ -4,8 +4,8 @@
   import { router } from 'tinro';
 
   import type {
+    MaybeSavedExploration,
     SavedExploration,
-    UnsavedExploration,
   } from '@mathesar/api/rpc/explorations';
   import type { CancellablePromise } from '@mathesar/component-library';
   import AppendBreadcrumb from '@mathesar/components/breadcrumb/AppendBreadcrumb.svelte';
@@ -19,7 +19,7 @@
     getExplorationEditorPageUrl,
   } from '@mathesar/routes/urls';
   import { abstractTypesMap } from '@mathesar/stores/abstract-types';
-  import { getQuery } from '@mathesar/stores/queries';
+  import { getExploration } from '@mathesar/stores/queries';
   import {
     QueryManager,
     QueryModel,
@@ -36,7 +36,7 @@
   let queryLoadPromise: CancellablePromise<SavedExploration>;
   let query: Readable<QueryModel | undefined> = readable(undefined);
 
-  function createQueryManager(queryInstance: UnsavedExploration) {
+  function createQueryManager(queryInstance: MaybeSavedExploration) {
     queryManager?.destroy();
     queryManager = new QueryManager({
       query: new QueryModel(queryInstance),
@@ -80,6 +80,7 @@
         router.location.hash.clear();
         createQueryManager({
           database_id: database.id,
+          schema_oid: schema.oid,
           ...(newQueryModel ?? {}),
         });
         return;
@@ -88,7 +89,7 @@
         console.error('Unable to create query model from hash', hash);
       }
     }
-    createQueryManager({ database_id: database.id });
+    createQueryManager({ database_id: database.id, schema_oid: schema.oid });
   }
 
   async function loadSavedQuery(_queryId: number) {
@@ -103,7 +104,7 @@
     }
 
     queryLoadPromise?.cancel();
-    queryLoadPromise = getQuery(_queryId);
+    queryLoadPromise = getExploration(_queryId);
     try {
       const queryInstance = await queryLoadPromise;
       createQueryManager(queryInstance);