new sync client: implement "touch"

Author: williamstein

src/packages/conat/sync-doc/sync-client.ts

@@ -11,6 +11,7 @@ import { type Client as ConatClient } from "@cocalc/conat/core/client";
 import { type ConatSyncTable } from "@cocalc/conat/sync/synctable";
 import { projectApiClient } from "@cocalc/conat/project/api";
 import { base64ToBuffer } from "@cocalc/util/base64";
+import callHub from "@cocalc/conat/hub/call-hub";
 
 export class SyncClient extends EventEmitter implements Client0 {
   private client: ConatClient;
@@ -45,7 +46,18 @@ export class SyncClient extends EventEmitter implements Client0 {
     return this.client.isSignedIn();
   };
 
-  touch_project = (_): void => {};
+  touch_project = async (project_id): Promise<void> => {
+    try {
+      await callHub({
+        client: this.client,
+        account_id: this.client_id(),
+        name: "db.touch",
+        args: [{ project_id, account_id: this.client_id() }],
+      });
+    } catch (err) {
+      console.log("WARNING: issue touching project", { project_id });
+    }
+  };
 
   is_deleted = (_filename: string, _project_id?: string): boolean => {
     return false;

src/packages/frontend/client/project.ts

@@ -12,7 +12,6 @@ import { redux } from "@cocalc/frontend/app-framework";
 import { appBasePath } from "@cocalc/frontend/customize/app-base-path";
 import { dialogs } from "@cocalc/frontend/i18n";
 import { getIntl } from "@cocalc/frontend/i18n/get-intl";
-import { allow_project_to_run } from "@cocalc/frontend/project/client-side-throttle";
 import { ensure_project_running } from "@cocalc/frontend/project/project-start-warning";
 import { API } from "@cocalc/frontend/project/websocket/api";
 import { connection_to_project } from "@cocalc/frontend/project/websocket/connect";
@@ -44,9 +43,10 @@ import { readFile, type ReadFileOptions } from "@cocalc/conat/files/read";
 import { type ProjectApi } from "@cocalc/conat/project/api";
 import { type CopyOptions } from "@cocalc/conat/files/fs";
 
+const TOUCH_THROTTLE = 30_000;
+
 export class ProjectClient {
   private client: WebappClient;
-  private touch_throttle: { [project_id: string]: number } = {};
 
   constructor(client: WebappClient) {
     this.client = client;
@@ -393,63 +393,40 @@ export class ProjectClient {
     },
   );
 
-  touch_project = async (
-    // project_id where activity occured
-    project_id: string,
-    // optional global id of a compute server (in the given project), in which case we also mark
-    // that compute server as active, which keeps it running in case it has idle timeout configured.
-    compute_server_id?: number,
-  ): Promise<void> => {
-    if (!is_valid_uuid_string(project_id)) {
-      console.warn("WARNING -- touch_project takes a project_id, but got ", {
-        project_id,
-      });
-    }
-    if (compute_server_id) {
-      // this is throttled, etc. and is independent of everything below.
-      touchComputeServer({
-        project_id,
-        compute_server_id,
-        client: this.client,
-      });
-      // that said, we do still touch the project, since if a user is actively
-      // using a compute server, the project should also be considered active.
-    }
-
-    const state = redux.getStore("projects")?.get_state(project_id);
-    if (!(state == null && redux.getStore("account")?.get("is_admin"))) {
-      // not trying to view project as admin so do some checks
-      if (!(await allow_project_to_run(project_id))) return;
-      if (!this.client.is_signed_in()) {
-        // silently ignore if not signed in
+  touch_project = throttle(
+    async (
+      // project_id where activity occured
+      project_id: string,
+      // optional global id of a compute server (in the given project), in which case we also mark
+      // that compute server as active, which keeps it running in case it has idle timeout configured.
+      compute_server_id?: number | null,
+    ): Promise<void> => {
+      console.log("touch_project", { project_id, compute_server_id });
+      if (!is_valid_uuid_string(project_id)) {
+        console.warn("WARNING -- touch_project takes a project_id, but got ", {
+          project_id,
+        });
         return;
       }
-      if (state != "running") {
-        // not running so don't touch (user must explicitly start first)
-        return;
+      if (compute_server_id) {
+        // this is independent of everything below.
+        touchComputeServer({
+          project_id,
+          compute_server_id,
+          client: this.client,
+        });
+        // that said, we do still touch the project, since if a user is actively
+        // using a compute server, the project should also be considered active.
       }
-    }
 
-    // Throttle -- so if this function is called with the same project_id
-    // twice in 3s, it's ignored (to avoid unnecessary network traffic).
-    // Do not make the timeout long, since that can mess up
-    // getting the hub-websocket to connect to the project.
-    const last = this.touch_throttle[project_id];
-    if (last != null && Date.now() - last <= 3000) {
-      return;
-    }
-    this.touch_throttle[project_id] = Date.now();
-    try {
-      await this.client.conat_client.hub.db.touch({ project_id });
-    } catch (err) {
-      // silently ignore; this happens, e.g., if you touch too frequently,
-      // and shouldn't be fatal and break other things.
-      // NOTE: this is a bit ugly for now -- basically the
-      // hub returns an error regarding actually touching
-      // the project (updating the db), but it still *does*
-      // ensure there is a TCP connection to the project.
-    }
-  };
+      try {
+        await this.client.conat_client.hub.db.touch({ project_id });
+      } catch (err) {
+        console.log("WARNING: issue touching project", err);
+      }
+    },
+    TOUCH_THROTTLE,
+  );
 
   // Print sagews to pdf
   // The printed version of the file will be created in the same directory

src/packages/frontend/frame-editors/generic/client.ts

@@ -15,12 +15,9 @@ import { FakeSyncstring } from "./syncstring-fake";
 import { type UserSearchResult as User } from "@cocalc/util/db-schema/accounts";
 export { type User };
 import { excludeFromComputeServer } from "@cocalc/frontend/file-associations";
-
 import type { ExecOpts, ExecOutput } from "@cocalc/util/db-schema/projects";
 export type { ExecOpts, ExecOutput };
-
 import * as schema from "@cocalc/util/schema";
-
 import { DEFAULT_FONT_SIZE } from "@cocalc/util/db-schema";
 
 export function server_time(): Date {
@@ -73,7 +70,7 @@ export async function touch(project_id: string, path: string): Promise<void> {
 // Resets the idle timeout timer and makes it known we are using the project.
 export async function touch_project(
   project_id: string,
-  compute_server_id?: number,
+  compute_server_id?: number | null,
 ): Promise<void> {
   try {
     await webapp_client.project_client.touch_project(

src/packages/frontend/frame-editors/terminal-editor/connected-terminal.ts

@@ -6,7 +6,7 @@
 /*
 Wrapper object around xterm.js's Terminal, which adds
 extra support for being connected to:
-  - a backend server pty via a sonat socket, which can be on a 
+  - a backend server pty via a sonat socket, which can be on a
     project or compute server
   - react/redux
   - frame-editor (via actions)
@@ -91,8 +91,6 @@ export class Terminal<T extends CodeEditorState = CodeEditorState> {
 
   private render_buffer: string = "";
   private history: string = "";
-  private last_active: number = 0;
-  private touch_interval;
 
   public is_visible: boolean = false;
   public element: HTMLElement;
@@ -181,10 +179,10 @@ export class Terminal<T extends CodeEditorState = CodeEditorState> {
     this.update_settings();
     this.init_title();
     this.init_settings();
-    this.init_touch();
     this.set_connection_status("disconnected");
 
     const handleData = (data: string) => {
+      touch_project(this.project_id, this.compute_server_id);
       if (this.ptyExited) {
         this.ptyExited = false;
         this.connect();
@@ -289,7 +287,6 @@ export class Terminal<T extends CodeEditorState = CodeEditorState> {
     this.compute_server_id = null;
     this.set_connection_status("disconnected");
     this.state = "closed";
-    clearInterval(this.touch_interval);
     this.account_store.removeListener("change", this.update_settings);
     this.terminal.dispose();
     close(this);
@@ -564,23 +561,6 @@ export class Terminal<T extends CodeEditorState = CodeEditorState> {
     }
   };
 
-  touch = async () => {
-    if (this.isClosed()) return;
-    if (Date.now() - this.last_active < 70000) {
-      if (
-        this.project_actions.isTabClosed() ||
-        this.compute_server_id == null
-      ) {
-        return;
-      }
-      touch_project(this.project_id, this.compute_server_id);
-    }
-  };
-
-  init_touch = (): void => {
-    this.touch_interval = setInterval(this.touch, 60000);
-  };
-
   initKeyHandler = (): void => {
     if (this.isClosed()) {
       return;
@@ -602,9 +582,6 @@ export class Terminal<T extends CodeEditorState = CodeEditorState> {
       //         key: event.key,
       //       });
 
-      // record that terminal is being actively used.
-      this.last_active = Date.now();
-
       if (this.is_paused) {
         this.pauseKeyCount += 1;
         if (this.pauseKeyCount >= 4) {

src/packages/frontend/projects/actions.ts

@@ -954,6 +954,7 @@ export class ProjectsActions extends Actions<ProjectsState> {
         event: "project_start_requested",
       });
       const runner = webapp_client.conat_client.projectRunner(project_id);
+      webapp_client.project_client.touch_project(project_id);
       await runner.start({ project_id });
 
       this.project_log(project_id, {