refactoring snapshot info

williamstein · williamstein · commit 666b67a81927 · 2025-08-17T22:28:20.000Z
diff --git a/src/packages/backend/conat/test/files/file-server.test.ts b/src/packages/backend/conat/test/files/file-server.test.ts
@@ -4,6 +4,7 @@ import {
   client as createFileClient,
 } from "@cocalc/conat/files/file-server";
 import { uuid } from "@cocalc/util/misc";
+import { type SnapshotCounts } from "@cocalc/util/db-schema/projects";
 
 beforeAll(before);
 
@@ -118,12 +119,7 @@ describe("create basic mocked file server and test it out", () => {
 
       updateSnapshots: async (_opts: {
         project_id: string;
-        counts?: {
-          frequent?: number;
-          daily?: number;
-          weekly?: number;
-          monthly?: number;
-        };
+        counts?: Partial<SnapshotCounts>;
         limit?: number;
       }): Promise<void> => {},
     });
diff --git a/src/packages/conat/files/file-server.ts b/src/packages/conat/files/file-server.ts
@@ -23,6 +23,7 @@ Additional functionality:
 
 import { type Client } from "@cocalc/conat/core/client";
 import { conat } from "@cocalc/conat/client";
+import { type SnapshotCounts } from "@cocalc/util/db-schema/projects";
 import { type CopyOptions } from "./fs";
 export { type CopyOptions };
 
@@ -102,12 +103,7 @@ export interface Fileserver {
   deleteSnapshot: (opts: { project_id: string; name: string }) => Promise<void>;
   updateSnapshots: (opts: {
     project_id: string;
-    counts?: {
-      frequent?: number;
-      daily?: number;
-      weekly?: number;
-      monthly?: number;
-    };
+    counts?: Partial<SnapshotCounts>;
     // global limit, same as with createSnapshot above; can prevent new snapshots from being
     // made if counts are too large!
     limit?: number;
diff --git a/src/packages/conat/hub/api/projects.ts b/src/packages/conat/hub/api/projects.ts
@@ -1,5 +1,8 @@
 import { authFirstRequireAccount } from "./util";
-import { type CreateProjectOptions } from "@cocalc/util/db-schema/projects";
+import {
+  type CreateProjectOptions,
+  type SnapshotCounts,
+} from "@cocalc/util/db-schema/projects";
 import { type CopyOptions } from "@cocalc/conat/files/fs";
 
 export const projects = {
@@ -132,12 +135,7 @@ export interface Projects {
   updateSnapshots: (opts: {
     account_id?: string;
     project_id: string;
-    counts?: {
-      frequent?: number;
-      daily?: number;
-      weekly?: number;
-      monthly?: number;
-    };
+    counts?: Partial<SnapshotCounts>;
   }) => Promise<void>;
 
   getSnapshotQuota: (opts: {
diff --git a/src/packages/file-server/btrfs/snapshots.ts b/src/packages/file-server/btrfs/snapshots.ts
@@ -1,37 +1,17 @@
 import { type SubvolumeSnapshots } from "./subvolume-snapshots";
+import {
+  SNAPSHOT_INTERVALS_MS,
+  DEFAULT_SNAPSHOT_COUNTS,
+  type SnapshotCounts,
+} from "@cocalc/util/db-schema/projects";
 import getLogger from "@cocalc/backend/logger";
 
+export { type SnapshotCounts };
+
 const logger = getLogger("file-server:btrfs:snapshots");
 
 const DATE_REGEXP = /^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}\.\d{3}Z$/;
 
-// Lengths of time in minutes to keep snapshots
-// (code below assumes these are listed in ORDER from shortest to longest)
-export const SNAPSHOT_INTERVALS_MS = {
-  frequent: 15 * 1000 * 60,
-  daily: 60 * 24 * 1000 * 60,
-  weekly: 60 * 24 * 7 * 1000 * 60,
-  monthly: 60 * 24 * 7 * 4 * 1000 * 60,
-};
-
-// How many of each type of snapshot to retain
-export const DEFAULT_SNAPSHOT_COUNTS = {
-  frequent: 24,
-  daily: 14,
-  weekly: 7,
-  monthly: 4,
-} as SnapshotCounts;
-
-// We have at least one snapshot for each interval, assuming
-// there are actual changes since the last snapshot, and at
-// most the listed number.
-export interface SnapshotCounts {
-  frequent: number;
-  daily: number;
-  weekly: number;
-  monthly: number;
-}
-
 export async function updateRollingSnapshots({
   snapshots,
   counts,
diff --git a/src/packages/frontend/project/snapshots/create.tsx b/src/packages/frontend/project/snapshots/create.tsx
@@ -14,18 +14,8 @@ import { Icon } from "@cocalc/frontend/components/icon";
 import ShowError from "@cocalc/frontend/components/error";
 import { useProjectContext } from "@cocalc/frontend/project/context";
 import { webapp_client } from "@cocalc/frontend/webapp-client";
-import { delay } from "awaiting";
 
-export default function Snapshots() {
-  return (
-    <Space.Compact>
-      <CreateSnapshot />
-      <EditSchedule />
-    </Space.Compact>
-  );
-}
-
-function CreateSnapshot() {
+export default function CreateSnapshot() {
   const { actions, project_id } = useProjectContext();
   const [loading, setLoading] = useState<boolean>(false);
   const [open, setOpen] = useState<boolean>(false);
@@ -77,7 +67,6 @@ function CreateSnapshot() {
         afterOpenChange={async (open) => {
           if (!open) return;
           setName(new Date().toISOString());
-          await delay(1);
           inputRef.current?.focus({
             cursor: "all",
           });
@@ -156,115 +145,3 @@ function CreateSnapshot() {
     </>
   );
 }
-
-function EditSchedule() {
-  const { actions, project_id } = useProjectContext();
-  const [loading, setLoading] = useState<boolean>(false);
-  const [open, setOpen] = useState<boolean>(false);
-  const [name, setName] = useState<string>("");
-  const [error, setError] = useState<string>("");
-  const inputRef = useRef<InputRef>(null);
-
-  useEffect(() => {
-    if (!open) {
-      return;
-    }
-    actions?.setState({ disableExplorerKeyhandler: true });
-    return () => {
-      actions?.setState({ disableExplorerKeyhandler: false });
-    };
-  }, [open]);
-
-  if (!project_id) {
-    return null;
-  }
-
-  async function createSnapshot() {
-    try {
-      setLoading(true);
-      setError("");
-      await webapp_client.conat_client.hub.projects.createSnapshot({
-        project_id,
-        name,
-      });
-      setName("");
-      setOpen(false);
-    } catch (err) {
-      setError(err);
-    } finally {
-      setLoading(false);
-    }
-  }
-
-  return (
-    <>
-      <Button
-        disabled={open}
-        onClick={() => {
-          setOpen(!open);
-        }}
-      >
-        <Icon name="clock" /> Schedule
-      </Button>
-      <Modal
-        afterOpenChange={(open) => {
-          if (!open) return;
-          setName(new Date().toISOString());
-          inputRef.current?.focus({
-            cursor: "all",
-          });
-        }}
-        title={
-          <>
-            <Icon name="clock" /> Edit Schedule{" "}
-            {loading && <Spin style={{ float: "right" }} />}
-          </>
-        }
-        open={open}
-        onOk={() => {
-          setName("");
-          setOpen(false);
-        }}
-        onCancel={() => {
-          setName("");
-          setOpen(false);
-        }}
-        footer={[
-          <Button
-            key="cancel"
-            onClick={() => {
-              setOpen(false);
-              setName("");
-            }}
-          >
-            Cancel
-          </Button>,
-          <Button
-            key="create"
-            type="primary"
-            onClick={createSnapshot}
-            disabled={!name.trim()}
-          >
-            Create Snapshot
-          </Button>,
-        ]}
-      >
-        <Flex style={{ width: "100%" }}>
-          <Input
-            ref={inputRef}
-            style={{ flex: 1 }}
-            value={name}
-            onChange={(e) => setName(e.target.value)}
-            placeholder="Name of snapshot..."
-            onPressEnter={createSnapshot}
-          />
-        </Flex>
-        <ShowError
-          style={{ marginTop: "10px" }}
-          error={error}
-          setError={setError}
-        />
-      </Modal>
-    </>
-  );
-}
diff --git a/src/packages/frontend/project/snapshots/edit-schedule.tsx b/src/packages/frontend/project/snapshots/edit-schedule.tsx
@@ -0,0 +1,116 @@
+import { useEffect, useRef, useState } from "react";
+import { Button, Flex, Input, Modal, Space, Spin } from "antd";
+import { Icon } from "@cocalc/frontend/components/icon";
+import ShowError from "@cocalc/frontend/components/error";
+import { useProjectContext } from "@cocalc/frontend/project/context";
+import { webapp_client } from "@cocalc/frontend/webapp-client";
+
+export default  function EditSchedule() {
+  const { actions, project_id } = useProjectContext();
+  const [loading, setLoading] = useState<boolean>(false);
+  const [open, setOpen] = useState<boolean>(false);
+  const [error, setError] = useState<string>("");
+
+  useEffect(() => {
+    if (!open) {
+      return;
+    }
+    actions?.setState({ disableExplorerKeyhandler: true });
+    return () => {
+      actions?.setState({ disableExplorerKeyhandler: false });
+    };
+  }, [open]);
+
+  if (!project_id) {
+    return null;
+  }
+
+  async function setSchedule() {
+    try {
+      setLoading(true);
+      setError("");
+      await webapp_client.conat_client.hub.projects.createSnapshot({
+        project_id,
+        name,
+      });
+      setName("");
+      setOpen(false);
+    } catch (err) {
+      setError(err);
+    } finally {
+      setLoading(false);
+    }
+  }
+
+  return (
+    <>
+      <Button
+        disabled={open}
+        onClick={() => {
+          setOpen(!open);
+        }}
+      >
+        <Icon name="clock" /> Schedule
+      </Button>
+      <Modal
+        afterOpenChange={(open) => {
+          if (!open) return;
+          setName(new Date().toISOString());
+          inputRef.current?.focus({
+            cursor: "all",
+          });
+        }}
+        title={
+          <>
+            <Icon name="clock" /> Edit Schedule{" "}
+            {loading && <Spin style={{ float: "right" }} />}
+          </>
+        }
+        open={open}
+        onOk={() => {
+          setName("");
+          setOpen(false);
+        }}
+        onCancel={() => {
+          setName("");
+          setOpen(false);
+        }}
+        footer={[
+          <Button
+            key="cancel"
+            onClick={() => {
+              setOpen(false);
+              setName("");
+            }}
+          >
+            Cancel
+          </Button>,
+          <Button
+            key="create"
+            type="primary"
+            onClick={createSnapshot}
+            disabled={!name.trim()}
+          >
+            Create Snapshot
+          </Button>,
+        ]}
+      >
+        <Flex style={{ width: "100%" }}>
+          <Input
+            ref={inputRef}
+            style={{ flex: 1 }}
+            value={name}
+            onChange={(e) => setName(e.target.value)}
+            placeholder="Name of snapshot..."
+            onPressEnter={createSnapshot}
+          />
+        </Flex>
+        <ShowError
+          style={{ marginTop: "10px" }}
+          error={error}
+          setError={setError}
+        />
+      </Modal>
+    </>
+  );
+}
diff --git a/src/packages/frontend/project/snapshots/index.tsx b/src/packages/frontend/project/snapshots/index.tsx
@@ -0,0 +1,19 @@
+/*
+The Snapshots button pops up a model that let you:
+
+ - create a new snapshot
+ - edit the automatic snapshot schedule
+*/
+
+import { Space } from "antd";
+import CreateSnapshot from "./create";
+import EditSchedule from "./edit-schedule";
+
+export default function Snapshots() {
+  return (
+    <Space.Compact>
+      <CreateSnapshot />
+      <EditSchedule />
+    </Space.Compact>
+  );
+}
diff --git a/src/packages/server/conat/api/projects.ts b/src/packages/server/conat/api/projects.ts
diff --git a/src/packages/server/conat/file-server/index.ts b/src/packages/server/conat/file-server/index.ts
diff --git a/src/packages/util/db-schema/projects.ts b/src/packages/util/db-schema/projects.ts
