Skip to content
Draft
Show file tree
Hide file tree
Changes from all 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
13 changes: 13 additions & 0 deletions sideboard/src/index.css
Original file line number Diff line number Diff line change
Expand Up @@ -378,6 +378,19 @@ button {
flex-direction: column;
}

.document-list__error {
display: flex;
flex-direction: column;
gap: 0.25rem;
padding: 0.75rem;
color: var(--document-list-danger);
}

.document-list__error span {
color: var(--document-list-muted);
overflow-wrap: anywhere;
}

.document-list-item--loading {
pointer-events: none;
padding-left: calc(1.8rem * var(--depth) + var(--doclist-padding-x));
Expand Down
40 changes: 40 additions & 0 deletions sideboard/src/sideboard/document-list-panel.test.tsx
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
import { render } from "solid-js/web";
import { afterEach, describe, expect, it } from "vitest";

import { DocumentListError, isFolderDoc } from "./document-list-panel.tsx";

let dispose: (() => void) | undefined;

afterEach(() => {
dispose?.();
dispose = undefined;
document.body.replaceChildren();
});

describe("document-list panel errors", () => {
it("recognizes folder-shaped documents", () => {
expect(isFolderDoc({ title: "Root", docs: [] })).toBe(true);
expect(isFolderDoc({ title: "Not a folder" } as any)).toBe(false);
expect(isFolderDoc(undefined)).toBe(false);
});

it("renders visible error details", () => {
const root = document.createElement("div");
document.body.append(root);

dispose = render(
() => (
<DocumentListError
message="Could not load root folder."
detail="automerge:missing"
/>
),
root
);

expect(root.querySelector('[role="alert"]')?.textContent).toContain(
"Could not load root folder."
);
expect(root.textContent).toContain("automerge:missing");
});
});
126 changes: 89 additions & 37 deletions sideboard/src/sideboard/document-list-panel.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,24 @@ import { executeDrop } from "./dnd/operations.ts";
import { getDndPayload, hasDocumentDrag } from "./dnd/payload.ts";
import { createMarquee } from "./document-list/marquee.ts";

export function isFolderDoc(doc: FolderDoc | undefined): doc is FolderDoc {
return !!doc && Array.isArray(doc.docs);
}

export function DocumentListError(props: {
message: string;
detail?: string;
}) {
return (
<div class="document-list__error" role="alert">
<strong>{props.message}</strong>
<Show when={props.detail}>
<span>{props.detail}</span>
</Show>
</div>
);
}

/**
* The document-list panel: a sticky toolbar (new-doc button + filter) over a
* scrolling, recursive list of the folder's documents and subfolders. Renders a
Expand All @@ -46,6 +64,26 @@ export function DocumentListPanel(props: {
// handle happens to resolve synchronously.
const folderReady = () =>
folderHandle.state === "ready" || folderHandle.state === "refreshing";
const folderLoadError = () => {
if (folderHandle.state === "errored") {
const error = folderHandle.error;
return {
message: "Could not load root folder.",
detail:
error instanceof Error
? error.message
: error
? String(error)
: props.folderUrl,
};
}
if (folderReady() && !isFolderDoc(folder())) {
return {
message: "Root folder is not a folder.",
detail: props.folderUrl,
};
}
};

const selectedDocUrls = subscribe<AutomergeUrl[]>(
props.element,
Expand Down Expand Up @@ -189,43 +227,57 @@ export function DocumentListPanel(props: {
);
}}
>
<div class="document-list__toolbar">
<CreateNew
square
draggable
clearFilter={() => setFilter("")}
changeFolder={(fn) => folderHandle()?.change(fn)}
repo={props.repo}
hive={props.element.hive}
open={open}
/>
<div class="document-list__filter-container">
<SearchIcon />
<input
name="filter"
class="document-list__filter"
placeholder="Filter by title"
value={filter()}
onInput={(event) => setFilter(event.target.value.toLowerCase())}
/>
</div>
</div>
<Show when={folderReady()} fallback={<LoadingRows depth={0} />}>
<Suspense fallback={<LoadingRows depth={0} />}>
<DocumentList
depth={0}
repo={props.repo}
docs={folder()?.docs}
handle={folderHandle.latest!}
open={open}
hive={props.element.hive}
selectedDocUrls={selectedDocUrls()}
element={props.element}
rootFolderHandle={folderHandle.latest!}
filter={filter()}
clearFilter={() => setFilter("")}
/>
</Suspense>
<Show
when={folderLoadError()}
keyed
fallback={
<>
<div class="document-list__toolbar">
<CreateNew
square
draggable
clearFilter={() => setFilter("")}
changeFolder={(fn) => folderHandle()?.change(fn)}
repo={props.repo}
hive={props.element.hive}
open={open}
/>
<div class="document-list__filter-container">
<SearchIcon />
<input
name="filter"
class="document-list__filter"
placeholder="Filter by title"
value={filter()}
onInput={(event) =>
setFilter(event.target.value.toLowerCase())
}
/>
</div>
</div>
<Show when={folderReady()} fallback={<LoadingRows depth={0} />}>
<Suspense fallback={<LoadingRows depth={0} />}>
<DocumentList
depth={0}
repo={props.repo}
docs={folder()?.docs}
handle={folderHandle.latest!}
open={open}
hive={props.element.hive}
selectedDocUrls={selectedDocUrls()}
element={props.element}
rootFolderHandle={folderHandle.latest!}
filter={filter()}
clearFilter={() => setFilter("")}
/>
</Suspense>
</Show>
</>
}
>
{(error) => (
<DocumentListError message={error.message} detail={error.detail} />
)}
</Show>
</nav>
</aside>
Expand Down
5 changes: 2 additions & 3 deletions sideboard/src/sideboard/sideboard.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,7 @@ import type { DocHandle, Repo } from "@automerge/automerge-repo/slim";
import type { PatchworkViewElement } from "@inkandswitch/patchwork-elements";

import type { PatchworkToolProps, SideboardAccountDoc } from "../types.ts";
import { DocumentListPanel } from "./document-list-panel.tsx";
import { LoadingRows } from "./document-list/loading-row.tsx";
import { DocumentListError, DocumentListPanel } from "./document-list-panel.tsx";
import { AccountBar } from "./account-bar.tsx";

/**
Expand All @@ -23,7 +22,7 @@ export function Sideboard(props: PatchworkToolProps<SideboardAccountDoc>) {
fallback={
<aside class="document-list">
<nav class="document-list__doclist document-list-widget">
<LoadingRows depth={0} />
<DocumentListError message="Account has no root folder." />
</nav>
</aside>
}
Expand Down
Loading