Skip to content

Free, simple, and intuitive online database diagram editor and SQL generator.

Add move local diagrams to cloud (#1063)

1ilit9428511e77af
diff --git a/src/api/gists.js b/src/api/gists.js
index 8d0370b7..7f05bcf4 100644
--- a/src/api/gists.js
+++ b/src/api/gists.js
@@ -4,7 +4,11 @@ export const SHARE_FILENAME = "share.json";
export const VERSION_FILENAME = "versionned.json";
const description = "drawDB diagram";
-const baseUrl = import.meta.env.VITE_BACKEND_URL;
+
+const baseUrl =
+ import.meta.env.VITE_GIST_BACKEND_URL ||
+ import.meta.env.VITE_BACKEND_URL ||
+ "http://localhost:5000";
export async function create(filename, content) {
const res = await axios.post(`${baseUrl}/gists`, {
diff --git a/src/components/Workspace.jsx b/src/components/Workspace.jsx
index c8546932..2d86daad 100644
--- a/src/components/Workspace.jsx
+++ b/src/components/Workspace.jsx
@@ -34,13 +34,8 @@ import { IconAlertTriangle } from "@douyinfe/semi-icons";
import { useTranslation } from "react-i18next";
import { databases } from "../data/databases";
import { isRtl } from "../i18n/utils/rtl";
-import {
- useMatch,
- useParams,
- useSearchParams,
-} from "react-router-dom";
+import { useMatch, useParams, useSearchParams } from "react-router-dom";
import { get, SHARE_FILENAME } from "../api/gists";
-import { nanoid } from "nanoid";
import { mergeCustomTypes } from "../utils/customTypes";
export const IdContext = createContext({
@@ -52,6 +47,18 @@ export const IdContext = createContext({
const SIDEPANEL_MIN_WIDTH = 374;
+const MOVE_TO_CLOUD_DISMISSED_KEY = "drawdb:moveToCloudDismissed";
+
+function readDismissedMoveIds() {
+ try {
+ return new Set(
+ JSON.parse(localStorage.getItem(MOVE_TO_CLOUD_DISMISSED_KEY) || "[]"),
+ );
+ } catch {
+ return new Set();
+ }
+}
+
export default function WorkSpace({ forcedDiagramId } = {}) {
const [gistId, setGistId] = useState("");
const [version, setVersion] = useState("");
@@ -64,6 +71,9 @@ export default function WorkSpace({ forcedDiagramId } = {}) {
const [showSelectDbModal, setShowSelectDbModal] = useState(false);
const [showRestoreModal, setShowRestoreModal] = useState(false);
const [selectedDb, setSelectedDb] = useState("");
+
+ const [diagramSource, setDiagramSource] = useState(null);
+ const [dismissedMoveIds, setDismissedMoveIds] = useState(readDismissedMoveIds);
const pendingNewIdRef = useRef(null);
const loadedIdRef = useRef(null);
const { layout, setLayout } = useLayout();
@@ -102,34 +112,49 @@ export default function WorkSpace({ forcedDiagramId } = {}) {
if (w > SIDEPANEL_MIN_WIDTH) setWidth(w);
};
+ const buildCloudPayload = useCallback(
+ (targetId) => ({
+ diagramId: targetId,
+ database,
+ name: title,
+ gistId: gistId ?? "",
+ lastModified: new Date(),
+ tables,
+ references: relationships,
+ notes,
+ areas,
+ pan: transform.pan,
+ zoom: transform.zoom,
+ ...(databases[database].hasEnums && { enums }),
+ ...(databases[database].hasTypes && { types }),
+ }),
+ [
+ database,
+ title,
+ gistId,
+ tables,
+ relationships,
+ notes,
+ areas,
+ transform,
+ enums,
+ types,
+ ],
+ );
+
const save = useCallback(async () => {
if (searchParams.has("shareId")) {
searchParams.delete("shareId");
setSearchParams(searchParams, { replace: true });
}
- if (cloudOnly) {
+ if (cloudOnly && diagramSource !== "local") {
const isNew = !loadedDiagramId || isTemplate;
const targetId = isNew
? (pendingNewIdRef.current ??= uuidv4())
: loadedDiagramId;
- const cloudPayload = {
- diagramId: targetId,
- database,
- name: title,
- gistId: gistId ?? "",
- lastModified: new Date(),
- tables,
- references: relationships,
- notes,
- areas,
- pan: transform.pan,
- zoom: transform.zoom,
- ...(databases[database].hasEnums && { enums }),
- ...(databases[database].hasTypes && { types }),
- };
try {
- await extensions.cloudSave(cloudPayload, { isNew });
+ await extensions.cloudSave(buildCloudPayload(targetId), { isNew });
if (isNew) {
pendingNewIdRef.current = null;
navigate(`/editor/diagrams/${targetId}`, { replace: true });
@@ -198,6 +223,8 @@ export default function WorkSpace({ forcedDiagramId } = {}) {
}
}, [
cloudOnly,
+ diagramSource,
+ buildCloudPayload,
extensions,
searchParams,
setSearchParams,
@@ -220,84 +247,55 @@ export default function WorkSpace({ forcedDiagramId } = {}) {
navigate,
]);
+ const moveToCloud = useCallback(async () => {
+ if (typeof extensions.cloudSave !== "function" || !loadedDiagramId) return;
+ setSaveState(State.SAVING);
+ try {
+ await extensions.cloudSave(buildCloudPayload(loadedDiagramId), {
+ isNew: true,
+ });
+ await db.diagrams.where("diagramId").equals(loadedDiagramId).delete();
+ setDiagramSource("cloud");
+ setSaveState(State.SAVED);
+ setLastSaved(new Date().toLocaleString());
+ } catch (err) {
+ console.warn("move to cloud failed:", err);
+ setSaveState(State.ERROR);
+ }
+ }, [extensions, loadedDiagramId, buildCloudPayload, setSaveState]);
+
+ const dismissMoveToCloud = () => {
+ if (!loadedDiagramId) return;
+ setDismissedMoveIds((prev) => {
+ const next = new Set(prev).add(loadedDiagramId);
+ localStorage.setItem(
+ MOVE_TO_CLOUD_DISMISSED_KEY,
+ JSON.stringify([...next]),
+ );
+ return next;
+ });
+ };
+
const load = useCallback(async () => {
const previousLoadedId = loadedIdRef.current;
loadedIdRef.current = loadedDiagramId ?? null;
- const loadLatestDiagram = async () => {
- await db.diagrams
- .orderBy("lastModified")
- .last()
- .then((diagram) => {
- if (diagram) {
- if (diagram.database) {
- setDatabase(diagram.database);
- } else {
- setDatabase(DB.GENERIC);
- }
- setGistId(diagram.gistId);
- setLoadedFromGistId(diagram.loadedFromGistId);
- setTitle(diagram.name);
- setTables(diagram.tables);
- setRelationships(diagram.references);
- setNotes(diagram.notes);
- setAreas(diagram.areas);
- setTransform({ pan: diagram.pan, zoom: diagram.zoom });
- if (databases[database].hasTypes) {
- if (diagram.types) {
- setTypes(
- diagram.types.map((t) =>
- t.id
- ? t
- : {
- ...t,
- id: nanoid(),
- fields: t.fields.map((f) =>
- f.id ? f : { ...f, id: nanoid() },
- ),
- },
- ),
- );
- } else {
- setTypes([]);
- }
- }
- if (databases[database].hasEnums) {
- setEnums(
- diagram.enums.map((e) =>
- !e.id ? { ...e, id: nanoid() } : e,
- ) ?? [],
- );
- }
- navigate(`/editor/diagrams/${diagram.diagramId}`, {
- replace: true,
- });
- } else {
- if (selectedDb === "") setShowSelectDbModal(true);
- }
- })
- .catch((error) => {
- console.log(error);
- });
- };
-
- const loadDiagram = async (id) => {
- const diagram =
- typeof extensions.cloudLoad === "function"
- ? await extensions.cloudLoad(id)
- : await db.diagrams.where("diagramId").equals(id).first();
-
- if (!diagram) return;
+ const fetchDiagram = async (id) => {
+ const localDiagram = await db.diagrams
+ .where("diagramId")
+ .equals(id)
+ .first();
+ if (localDiagram) return { diagram: localDiagram, source: "local" };
- if (typeof diagram.canWrite === "boolean") {
- setLayout((prev) => ({ ...prev, readOnly: !diagram.canWrite }));
+ if (typeof extensions.cloudLoad === "function") {
+ const cloudDiagram = await extensions.cloudLoad(id);
+ if (cloudDiagram) return { diagram: cloudDiagram, source: "cloud" };
}
+ return { diagram: null, source: null };
+ };
- if (diagram.database) {
- setDatabase(diagram.database);
- } else {
- setDatabase(DB.GENERIC);
- }
+ const applyDiagramState = (diagram) => {
+ setDatabase(diagram.database || DB.GENERIC);
setGistId(diagram.gistId);
setLoadedFromGistId(diagram.loadedFromGistId);
setTitle(diagram.name);
@@ -305,36 +303,56 @@ export default function WorkSpace({ forcedDiagramId } = {}) {
setRelationships(diagram.references);
setAreas(diagram.areas);
setNotes(diagram.notes);
- setTransform({
- pan: diagram.pan,
- zoom: diagram.zoom,
- });
+ setTransform({ pan: diagram.pan, zoom: diagram.zoom });
+ setTypes(diagram.types ?? []);
+ setEnums(diagram.enums ?? []);
+ };
+
+ const resetEditorState = () => {
+ setTables([]);
+ setRelationships([]);
+ setAreas([]);
+ setNotes([]);
+ setTypes([]);
+ setEnums([]);
setUndoStack([]);
setRedoStack([]);
- if (databases[database].hasTypes) {
- if (diagram.types) {
- setTypes(
- diagram.types.map((t) =>
- t.id
- ? t
- : {
- ...t,
- id: nanoid(),
- fields: t.fields.map((f) =>
- f.id ? f : { ...f, id: nanoid() },
- ),
- },
- ),
- );
- } else {
- setTypes([]);
- }
+ setTransform({ zoom: 1, pan: { x: 0, y: 0 } });
+ setTitle("Untitled diagram");
+ setGistId("");
+ setLoadedFromGistId("");
+ setLayout((prev) => ({ ...prev, readOnly: false }));
+ setDiagramSource(null);
+ };
+
+ const loadLatestDiagram = async () => {
+ let diagram;
+ try {
+ diagram = await db.diagrams.orderBy("lastModified").last();
+ } catch (error) {
+ console.log(error);
+ return;
}
- if (databases[database].hasEnums) {
- setEnums(
- diagram.enums.map((e) => (!e.id ? { ...e, id: nanoid() } : e)) ?? [],
- );
+ if (!diagram) {
+ if (selectedDb === "") setShowSelectDbModal(true);
+ return;
}
+ setDiagramSource("local");
+ applyDiagramState(diagram);
+ navigate(`/editor/diagrams/${diagram.diagramId}`, { replace: true });
+ };
+
+ const loadDiagram = async (id) => {
+ const { diagram, source } = await fetchDiagram(id);
+ if (!diagram) return;
+
+ setDiagramSource(source);
+ if (typeof diagram.canWrite === "boolean") {
+ setLayout((prev) => ({ ...prev, readOnly: !diagram.canWrite }));
+ }
+ applyDiagramState(diagram);
+ setUndoStack([]);
+ setRedoStack([]);
};
const loadTemplate = async (id) => {
@@ -342,102 +360,45 @@ export default function WorkSpace({ forcedDiagramId } = {}) {
.where("templateId")
.equals(id)
.first();
-
- if (template) {
- if (template.database) {
- setDatabase(template.database);
- } else {
- setDatabase(DB.GENERIC);
- }
- setTitle(template.title);
- setTables(template.tables);
- setRelationships(template.relationships);
- setAreas(template.subjectAreas);
- setNotes(template.notes);
- setTransform({
- zoom: 1,
- pan: { x: 0, y: 0 },
- });
- setUndoStack([]);
- setRedoStack([]);
- if (databases[database].hasTypes) {
- if (template.types) {
- setTypes(
- template.types.map((t) =>
- t.id
- ? t
- : {
- ...t,
- id: nanoid(),
- fields: t.fields.map((f) =>
- f.id ? f : { ...f, id: nanoid() },
- ),
- },
- ),
- );
- } else {
- setTypes([]);
- }
- }
- if (databases[database].hasEnums) {
- setEnums(
- template.enums.map((e) => (!e.id ? { ...e, id: nanoid() } : e)) ??
- [],
- );
- }
- } else {
+ if (!template) {
if (selectedDb === "") setShowSelectDbModal(true);
+ return;
}
+ setDiagramSource(null);
+ setDatabase(template.database || DB.GENERIC);
+ setTitle(template.title);
+ setTables(template.tables);
+ setRelationships(template.relationships);
+ setAreas(template.subjectAreas);
+ setNotes(template.notes);
+ setTransform({ zoom: 1, pan: { x: 0, y: 0 } });
+ setUndoStack([]);
+ setRedoStack([]);
+ setTypes(template.types ?? []);
+ setEnums(template.enums ?? []);
};
const loadFromGist = async (shareId, diagramId = null) => {
try {
const { data } = await get(shareId);
- const parsedDiagram = JSON.parse(data.files[SHARE_FILENAME].content);
+ const parsed = JSON.parse(data.files[SHARE_FILENAME].content);
+ setDiagramSource(null);
setUndoStack([]);
setRedoStack([]);
setGistId(shareId);
setLoadedFromGistId(shareId);
- setDatabase(parsedDiagram.database);
- setTitle(parsedDiagram.title);
- setTables(parsedDiagram.tables);
- setRelationships(parsedDiagram.relationships);
- setNotes(parsedDiagram.notes);
- setAreas(parsedDiagram.subjectAreas);
- setTransform(parsedDiagram.transform);
- if (databases[parsedDiagram.database].hasTypes) {
- if (parsedDiagram.types) {
- setTypes(
- parsedDiagram.types.map((t) =>
- t.id
- ? t
- : {
- ...t,
- id: nanoid(),
- fields: t.fields.map((f) =>
- f.id ? f : { ...f, id: nanoid() },
- ),
- },
- ),
- );
- } else {
- setTypes([]);
- }
- }
- if (databases[parsedDiagram.database].hasEnums) {
- setEnums(
- parsedDiagram.enums.map((e) =>
- !e.id ? { ...e, id: nanoid() } : e,
- ) ?? [],
- );
- }
- if (parsedDiagram.customTypes) {
- mergeCustomTypes(parsedDiagram.customTypes);
- }
+ setDatabase(parsed.database);
+ setTitle(parsed.title);
+ setTables(parsed.tables);
+ setRelationships(parsed.relationships);
+ setNotes(parsed.notes);
+ setAreas(parsed.subjectAreas);
+ setTransform(parsed.transform);
+ setTypes(parsed.types ?? []);
+ setEnums(parsed.enums ?? []);
+ if (parsed.customTypes) mergeCustomTypes(parsed.customTypes);
if (diagramId) {
- navigate(`/editor/diagrams/${diagramId}`, {
- replace: true,
- });
+ navigate(`/editor/diagrams/${diagramId}`, { replace: true });
}
} catch (e) {
console.log(e);
@@ -450,28 +411,13 @@ export default function WorkSpace({ forcedDiagramId } = {}) {
const existingDiagram = await db.diagrams.get({
loadedFromGistId: shareId,
});
-
await loadFromGist(shareId, existingDiagram?.diagramId || null);
return;
}
if (!loadedDiagramId) {
if (cloudOnly) {
- if (previousLoadedId != null) {
- setTables([]);
- setRelationships([]);
- setAreas([]);
- setNotes([]);
- setTypes([]);
- setEnums([]);
- setUndoStack([]);
- setRedoStack([]);
- setTransform({ zoom: 1, pan: { x: 0, y: 0 } });
- setTitle("Untitled diagram");
- setGistId("");
- setLoadedFromGistId("");
- setLayout((prev) => ({ ...prev, readOnly: false }));
- }
+ if (previousLoadedId != null) resetEditorState();
if (selectedDb === "") setShowSelectDbModal(true);
return;
}
@@ -499,7 +445,6 @@ export default function WorkSpace({ forcedDiagramId } = {}) {
setNotes,
setTypes,
setDatabase,
- database,
setEnums,
selectedDb,
setSaveState,
@@ -613,6 +558,31 @@ export default function WorkSpace({ forcedDiagramId } = {}) {
</Button>
</div>
)}
+ {cloudOnly &&
+ diagramSource === "local" &&
+ !version &&
+ !dismissedMoveIds.has(loadedDiagramId) && (
+ <div className="pointer-events-none absolute inset-x-0 top-3 z-50 flex justify-center">
+ <div className="pointer-events-auto flex items-center gap-3 rounded-full border border-blue-300 bg-blue-50 px-5 py-1.5 shadow-md dark:border-sky-900/50 dark:bg-sky-900/30">
+ <i className="bi bi-hdd" />
+ <span className="text-sm">
+ This diagram is stored locally on your browser. Move it to
+ the cloud?
+ </span>
+ <Button size="small" theme="solid" onClick={moveToCloud}>
+ Move
+ </Button>
+ <Button
+ size="small"
+ theme="borderless"
+ type="tertiary"
+ aria-label="Dismiss"
+ icon={<i className="bi bi-x-lg" />}
+ onClick={dismissMoveToCloud}
+ />
+ </div>
+ </div>
+ )}
{!(layout.sidebar || layout.toolbar || layout.header) && (
<div className="fixed right-5 bottom-4">
<FloatingControls />