diff --git a/server/collaboration/ViewsExtension.test.ts b/server/collaboration/ViewsExtension.test.ts new file mode 100644 index 0000000000..cb1fe11004 --- /dev/null +++ b/server/collaboration/ViewsExtension.test.ts @@ -0,0 +1,38 @@ +import type { onChangePayload } from "@hocuspocus/server"; +import { subMinutes } from "date-fns"; +import { User } from "@server/models"; +import { buildDocument, buildUser } from "@server/test/factories"; +import { ViewsExtension } from "./ViewsExtension"; + +describe("ViewsExtension", () => { + const change = async (user: User, documentId: string, socketId: string) => { + const extension = new ViewsExtension(); + await extension.onChange({ + documentName: `document.${documentId}`, + context: { user }, + socketId, + } as onChangePayload); + }; + + it("should write lastActiveAt when it is older than five minutes", async () => { + const old = subMinutes(new Date(), 10); + const user = await buildUser({ lastActiveAt: old }); + const document = await buildDocument({ teamId: user.teamId }); + + await change(user, document.id, "socket-1"); + + const reloaded = await User.findByPk(user.id, { rejectOnEmpty: true }); + expect(reloaded.lastActiveAt!.getTime()).toBeGreaterThan(old.getTime()); + }); + + it("should not write lastActiveAt within five minutes", async () => { + const recent = subMinutes(new Date(), 2); + const user = await buildUser({ lastActiveAt: recent }); + const document = await buildDocument({ teamId: user.teamId }); + + await change(user, document.id, "socket-1"); + + const reloaded = await User.findByPk(user.id, { rejectOnEmpty: true }); + expect(reloaded.lastActiveAt).toEqual(recent); + }); +}); diff --git a/server/collaboration/ViewsExtension.ts b/server/collaboration/ViewsExtension.ts index 1d11f17087..ddfa9f1d22 100644 --- a/server/collaboration/ViewsExtension.ts +++ b/server/collaboration/ViewsExtension.ts @@ -43,7 +43,7 @@ export class ViewsExtension implements Extension { ); await Promise.all([ View.touch(documentId, context.user.id, true), - context.user.update({ lastActiveAt: new Date() }), + context.user.updateActiveAt(), ]); } } diff --git a/server/models/User.ts b/server/models/User.ts index 44b68ab987..0711fb6b86 100644 --- a/server/models/User.ts +++ b/server/models/User.ts @@ -574,23 +574,31 @@ class User extends ParanoidModel< ); }; - updateActiveAt = async (ctx: Context, force = false) => { - const { ip } = ctx.request; + /** + * Updates the lastActiveAt timestamp, at most once every five minutes. + * + * @param ctx the request context, if any, used to record the IP and client. + * @param force whether to update even if the last update was recent. + * @returns a promise that resolves with the updated user. + */ + updateActiveAt = async (ctx?: Context, force = false) => { const fiveMinutesAgo = subMinutes(new Date(), 5); // ensure this is updated only every few minutes otherwise // we'll be constantly writing to the DB as API requests happen if (!this.lastActiveAt || this.lastActiveAt < fiveMinutesAgo || force) { this.lastActiveAt = new Date(); - this.lastActiveIp = ip; + if (ctx) { + this.lastActiveIp = ctx.request.ip; + } } // Track the clients each user is using - if (ctx.userAgent?.source.includes("Outline/")) { + if (ctx?.userAgent?.source.includes("Outline/")) { this.setFlag(UserFlag.Desktop); - } else if (ctx.userAgent?.isDesktop) { + } else if (ctx?.userAgent?.isDesktop) { this.setFlag(UserFlag.DesktopWeb); - } else if (ctx.userAgent?.isMobile) { + } else if (ctx?.userAgent?.isMobile) { this.setFlag(UserFlag.MobileWeb); }