Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Handle failed API requests on schema page #3323

Merged
Show file tree
Hide file tree
Changes from 10 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
57 changes: 53 additions & 4 deletions mathesar_ui/src/pages/schema/SchemaOverview.svelte
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,10 @@
import type { QueryInstance } from '@mathesar/api/types/queries';
import type { TableEntry } from '@mathesar/api/types/tables';
import type { Database, SchemaEntry } from '@mathesar/AppTypes';
import { AnchorButton } from '@mathesar-component-library';
import { AnchorButton, Button, Icon } from '@mathesar-component-library';
import { getDataExplorerPageUrl } from '@mathesar/routes/urls';
import type { RequestStatus } from '@mathesar/api/utils/requestUtils';
import ErrorBox from '@mathesar/components/message-boxes/ErrorBox.svelte';
import OverviewHeader from './OverviewHeader.svelte';
import TablesList from './TablesList.svelte';
import ExplorationsList from './ExplorationsList.svelte';
Expand All @@ -12,11 +14,15 @@
import CreateNewTableButton from './CreateNewTableButton.svelte';
import TableSkeleton from './TableSkeleton.svelte';
import ExplorationSkeleton from './ExplorationSkeleton.svelte';
import { currentSchemaId } from '@mathesar/stores/schemas';

Check failure on line 17 in mathesar_ui/src/pages/schema/SchemaOverview.svelte

View workflow job for this annotation

GitHub Actions / Run front end linter

`@mathesar/stores/schemas` import should occur before import of `./OverviewHeader.svelte`
import { iconRefresh } from '@mathesar/icons';

Check failure on line 18 in mathesar_ui/src/pages/schema/SchemaOverview.svelte

View workflow job for this annotation

GitHub Actions / Run front end linter

`@mathesar/icons` import should occur before import of `./OverviewHeader.svelte`
import { refetchQueriesForSchema } from '@mathesar/stores/queries';

Check failure on line 19 in mathesar_ui/src/pages/schema/SchemaOverview.svelte

View workflow job for this annotation

GitHub Actions / Run front end linter

`@mathesar/stores/queries` import should occur before import of `./OverviewHeader.svelte`
import { refetchTablesForSchema } from '@mathesar/stores/tables';

Check failure on line 20 in mathesar_ui/src/pages/schema/SchemaOverview.svelte

View workflow job for this annotation

GitHub Actions / Run front end linter

`@mathesar/stores/tables` import should occur before import of `./OverviewHeader.svelte`

export let tablesMap: Map<number, TableEntry>;
export let explorationsMap: Map<number, QueryInstance>;
export let isTablesLoading = false;
export let isExplorationsLoading = false;
export let tablesRequestStatus: RequestStatus;
export let explorationsRequestStatus: RequestStatus;

export let canExecuteDDL: boolean;
export let canEditMetadata: boolean;
Expand All @@ -28,6 +34,7 @@
$: hasExplorations = explorationsMap.size > 0;
$: showTableCreationTutorial = !hasTables && canExecuteDDL;
$: showExplorationTutorial = hasTables && !hasExplorations && canEditMetadata;
$: isExplorationsLoading = explorationsRequestStatus.state == 'processing';

Check failure on line 37 in mathesar_ui/src/pages/schema/SchemaOverview.svelte

View workflow job for this annotation

GitHub Actions / Run front end linter

Expected '===' and instead saw '=='

// Viewers can explore, they cannot save explorations
$: canExplore = hasTables && hasExplorations && !isExplorationsLoading;
Expand All @@ -42,8 +49,29 @@
{/if}
</svelte:fragment>
</OverviewHeader>
{#if isTablesLoading}
{#if tablesRequestStatus.state === 'processing'}
<TableSkeleton numTables={schema.num_tables} />
{:else if tablesRequestStatus.state == 'failure'}

Check failure on line 54 in mathesar_ui/src/pages/schema/SchemaOverview.svelte

View workflow job for this annotation

GitHub Actions / Run front end linter

Expected '===' and instead saw '=='
<ErrorBox>
<p>{tablesRequestStatus.errors[0]}</p>
<div>
<Button
on:click={() => {
if ($currentSchemaId) {
void refetchTablesForSchema($currentSchemaId);
nikhilhenry marked this conversation as resolved.
Show resolved Hide resolved
nikhilhenry marked this conversation as resolved.
Show resolved Hide resolved
}
}}
>
<Icon {...iconRefresh} />
<span>Retry</span>
</Button>
<a href="../">
<Button>
<span>Go to Database</span>
</Button>
</a>
</div>
</ErrorBox>
{:else if showTableCreationTutorial}
<CreateNewTableTutorial {database} {schema} />
{:else}
Expand All @@ -60,6 +88,27 @@
<OverviewHeader title="Saved Explorations" />
{#if isExplorationsLoading}
<ExplorationSkeleton />
{:else if explorationsRequestStatus.state == 'failure'}

Check failure on line 91 in mathesar_ui/src/pages/schema/SchemaOverview.svelte

View workflow job for this annotation

GitHub Actions / Run front end linter

Expected '===' and instead saw '=='
<ErrorBox>
<p>{explorationsRequestStatus.errors[0]}</p>
<div>
<Button
on:click={() => {
if ($currentSchemaId) {
void refetchQueriesForSchema($currentSchemaId);
}
nikhilhenry marked this conversation as resolved.
Show resolved Hide resolved
}}
>
<Icon {...iconRefresh} />
<span>Retry</span>
</Button>
<a href="../">
<Button>
<span>Go to Database</span>
</Button>
</a>
</div>
</ErrorBox>
{:else if showExplorationTutorial}
<CreateNewExplorationTutorial {database} {schema} />
{:else}
Expand Down
13 changes: 6 additions & 7 deletions mathesar_ui/src/pages/schema/SchemaPage.svelte
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,6 @@
getSchemaPageTablesSectionUrl,
getSchemaPageUrl,
} from '@mathesar/routes/urls';
import { States } from '@mathesar/api/utils/requestUtils';
import { getUserProfileStoreFromContext } from '@mathesar/stores/userProfile';
import { logEvent } from '@mathesar/utils/telemetry';
import AddEditSchemaModal from '../database/AddEditSchemaModal.svelte';
Expand Down Expand Up @@ -58,8 +57,8 @@

$: tablesMap = canExecuteDDL ? $tablesStore.data : $importVerifiedTablesStore;
$: explorationsMap = $queries.data;
$: isTablesLoading = $tablesStore.state === States.Loading;
$: isExplorationsLoading = $queries.requestStatus.state === 'processing';
$: tablesRequestStatus = $tablesStore.requestStatus;
$: explorationsRequestStatus = $queries.requestStatus;

$: tabs = [
{
Expand Down Expand Up @@ -153,25 +152,25 @@
<SchemaOverview
{canExecuteDDL}
{canEditMetadata}
{isTablesLoading}
{isExplorationsLoading}
{tablesRequestStatus}
{tablesMap}
{explorationsMap}
{database}
{schema}
{explorationsRequestStatus}
/>
</div>
{:else if activeTab?.id === 'tables'}
<div class="tab-container">
{#if isTablesLoading}
{#if tablesRequestStatus.state === 'processing'}
<TableSkeleton numTables={schema.num_tables} />
{:else}
<SchemaTables {canExecuteDDL} {tablesMap} {database} {schema} />
{/if}
</div>
{:else if activeTab?.id === 'explorations'}
<div class="tab-container">
{#if isExplorationsLoading}
{#if explorationsRequestStatus.state === 'processing'}
<ExplorationSkeleton />
{:else}
<SchemaExplorations
Expand Down
28 changes: 16 additions & 12 deletions mathesar_ui/src/stores/tables.ts
Original file line number Diff line number Diff line change
Expand Up @@ -30,13 +30,15 @@ import type {
} from '@mathesar/api/types/tables/split_table';
import type { DBObjectEntry, Database, SchemaEntry } from '@mathesar/AppTypes';
import { invalidIf } from '@mathesar/components/form';
import type { PaginatedResponse } from '@mathesar/api/utils/requestUtils';
import type {
PaginatedResponse,
RequestStatus,
} from '@mathesar/api/utils/requestUtils';
import {
deleteAPI,
getAPI,
patchAPI,
postAPI,
States,
} from '@mathesar/api/utils/requestUtils';
import { preloadCommonData } from '@mathesar/utils/preloadData';
import { isTableImportConfirmationRequired } from '@mathesar/utils/tables';
Expand All @@ -47,9 +49,8 @@ import { currentSchemaId, addCountToSchemaNumTables } from './schemas';
const commonData = preloadCommonData();

export interface DBTablesStoreData {
state: States;
data: Map<TableEntry['id'], TableEntry>;
error?: string;
requestStatus: RequestStatus;
}

const schemaTablesStoreMap: Map<
Expand Down Expand Up @@ -77,9 +78,8 @@ function setSchemaTablesStore(
}

const storeValue: DBTablesStoreData = {
state: States.Done,
data: tables,
error: undefined,
requestStatus: { state: 'success' },
};

let store = schemaTablesStoreMap.get(schemaId);
Expand Down Expand Up @@ -110,7 +110,7 @@ export async function refetchTablesForSchema(
try {
store.update((currentData) => ({
...currentData,
state: States.Loading,
requestStatus: { state: 'processing' },
}));

schemaTablesRequestMap.get(schemaId)?.cancel();
Expand All @@ -128,8 +128,12 @@ export async function refetchTablesForSchema(
} catch (err) {
store.update((currentData) => ({
...currentData,
state: States.Error,
error: err instanceof Error ? err.message : 'Error in fetching schemas',
requestStatus: {
state: 'failure',
errors: [
err instanceof Error ? err.message : 'Error in fetching schemas',
],
},
}));
return undefined;
}
Expand All @@ -143,7 +147,7 @@ export function getTablesStoreForSchema(
let store = schemaTablesStoreMap.get(schemaId);
if (!store) {
store = writable({
state: States.Loading,
requestStatus: { state: 'processing' },
data: new Map(),
});
schemaTablesStoreMap.set(schemaId, store);
Expand All @@ -153,7 +157,7 @@ export function getTablesStoreForSchema(
void refetchTablesForSchema(schemaId);
}
preload = false;
} else if (get(store).error) {
} else if (get(store).requestStatus.state === 'failure') {
void refetchTablesForSchema(schemaId);
}
return store;
Expand Down Expand Up @@ -416,8 +420,8 @@ export const tables: Readable<DBTablesStoreData> = derived(

if (!$currentSchemaId) {
set({
state: States.Done,
data: new Map(),
requestStatus: { state: 'success' },
});
} else {
const store = getTablesStoreForSchema($currentSchemaId);
Expand Down
Loading