@proteinjs/user-server 1.4.5 → 1.5.0

package/test/SignupInvite.test.ts

@@ -0,0 +1,175 @@
+import moment from 'moment';
+
+/**
+ * Covers invite token lifetime and the expired-token user experience.
+ *
+ * Two things are asserted here:
+ * 1. `sendInvite` stamps `tokenExpiresAt` from the `INVITE_TOKEN_TTL_DAYS` knob (not a literal),
+ *    on both the create and the refresh path.
+ * 2. An expired token produces an honest, actionable message at `initializeSignup` — the surface
+ *    the signup page reads — and is distinguishable from a token that never existed / was revoked.
+ *    Previously both collapsed into "not found or has expired", and outside invite-only mode an
+ *    expired token wasn't reported at all: signup rendered with the email field hidden and the user
+ *    could only reach a generic "Sign up failed." on submit.
+ *
+ * The service's collaborators are stubbed at the module boundary; no db or mail server needed.
+ */
+
+const dbGet = jest.fn();
+const dbInsert = jest.fn();
+const dbUpdate = jest.fn();
+const dbDelete = jest.fn();
+const sendEmail = jest.fn();
+
+const db = { get: dbGet, insert: dbInsert, update: dbUpdate, delete: dbDelete };
+
+// Only the db accessors are stubbed; the table/column classes stay real because the table
+// definitions in @proteinjs/user extend them at import time.
+jest.mock('@proteinjs/db', () => ({
+  ...jest.requireActual('@proteinjs/db'),
+  getDb: () => db,
+  getDbAsSystem: () => db,
+}));
+
+jest.mock('@proteinjs/email-server', () => ({
+  EmailSender: jest.fn().mockImplementation(() => ({ sendEmail })),
+  getDefaultInviteEmailConfigFactory: () => ({
+    getConfig: () => ({ getEmailContent: () => ({ text: 'invite', html: '<p>invite</p>' }) }),
+  }),
+  getDefaultSignupConfirmationEmailConfigFactory: () => ({
+    getConfig: () => ({ getNewUserEmailContent: () => ({ text: 'welcome', html: '<p>welcome</p>' }) }),
+  }),
+}));
+
+// `merge` is kept real so the generated source graphs still load; only lookup is stubbed, so
+// `getDefaultInviteConfigFactory` falls back to its invite-optional default.
+jest.mock('@proteinjs/reflection', () => ({
+  ...jest.requireActual('@proteinjs/reflection'),
+  SourceRepository: {
+    ...jest.requireActual('@proteinjs/reflection').SourceRepository,
+    get: () => ({ object: () => undefined }),
+  },
+}));
+
+import { UserRepo } from '@proteinjs/user';
+import { INVITE_TOKEN_TTL_DAYS, Signup } from '../src/services/Signup';
+
+const EXPECTED_TTL_DAYS = 90;
+
+/** Tolerance for the clock advancing between the service stamping the token and the assertion. */
+const CLOCK_SKEW_TOLERANCE_SECONDS = 60;
+
+/**
+ * Compares against the same `moment().add(days, 'days')` arithmetic the service uses, so a DST
+ * boundary inside the window (90 days crosses one) cancels out instead of showing up as an hour of
+ * drift. A wrong TTL is still off by days, so this stays a biting assertion.
+ */
+const secondsFromExpectedTtl = (tokenExpiresAt: any, ttlDays: number) =>
+  Math.abs(moment(tokenExpiresAt).diff(moment().add(ttlDays, 'days'), 'seconds'));
+
+describe('invite token lifetime', () => {
+  beforeEach(() => {
+    jest.restoreAllMocks();
+    jest.clearAllMocks();
+    dbInsert.mockImplementation(async (table: any, record: any) => record);
+    // `sendInvite` stamps the inviter from the session; there is no session in a unit test.
+    jest.spyOn(UserRepo.prototype, 'getUser').mockReturnValue({ id: 'inviter-1' } as any);
+  });
+
+  it('is configured by the INVITE_TOKEN_TTL_DAYS knob', () => {
+    expect(INVITE_TOKEN_TTL_DAYS).toBe(EXPECTED_TTL_DAYS);
+  });
+
+  it('stamps tokenExpiresAt from the knob when creating an invite', async () => {
+    dbGet.mockResolvedValue(undefined); // no existing user, no existing invite
+
+    const response = await new Signup().sendInvite('Invitee@Test.local');
+
+    expect(response.sent).toBe(true);
+    expect(dbInsert).toHaveBeenCalledTimes(1);
+    const [, inserted] = dbInsert.mock.calls[0];
+    expect(inserted.email).toBe('invitee@test.local');
+    expect(inserted.invitedBy).toBe('inviter-1');
+    expect(secondsFromExpectedTtl(inserted.tokenExpiresAt, INVITE_TOKEN_TTL_DAYS)).toBeLessThan(
+      CLOCK_SKEW_TOLERANCE_SECONDS
+    );
+    // Pin the value too, so changing the constant is a deliberate act rather than a drive-by.
+    expect(secondsFromExpectedTtl(inserted.tokenExpiresAt, EXPECTED_TTL_DAYS)).toBeLessThan(
+      CLOCK_SKEW_TOLERANCE_SECONDS
+    );
+  });
+
+  it('stamps tokenExpiresAt from the knob when refreshing an existing invite', async () => {
+    dbGet
+      .mockResolvedValueOnce(undefined) // user lookup
+      .mockResolvedValueOnce({ id: 'invite-1', email: 'invitee@test.local', token: 'old-token' });
+
+    await new Signup().sendInvite('invitee@test.local');
+
+    expect(dbUpdate).toHaveBeenCalledTimes(1);
+    const [, updated] = dbUpdate.mock.calls[0];
+    expect(updated.token).not.toBe('old-token');
+    expect(secondsFromExpectedTtl(updated.tokenExpiresAt, INVITE_TOKEN_TTL_DAYS)).toBeLessThan(
+      CLOCK_SKEW_TOLERANCE_SECONDS
+    );
+  });
+});
+
+describe('expired invite user experience', () => {
+  beforeEach(() => {
+    jest.clearAllMocks();
+  });
+
+  it('tells the user the invite expired, and what to do about it', async () => {
+    dbGet.mockResolvedValue({
+      id: 'invite-1',
+      email: 'invitee@test.local',
+      token: 'expired-token',
+      tokenExpiresAt: moment().subtract(1, 'day'),
+    });
+
+    const response = await new Signup().initializeSignup('expired-token');
+
+    expect(response.isReady).toBe(false);
+    expect(response.error).toMatch(/expired/i);
+    // The actionable half — an honest error still has to tell the user their way out.
+    expect(response.error).toMatch(/new one/i);
+    // It must not read as a generic failure or leave signup half-rendered.
+    expect(response.error).not.toMatch(/not found/i);
+    expect(response.invite).toBeUndefined();
+  });
+
+  it('reports an unknown or revoked token distinctly from an expired one', async () => {
+    dbGet.mockResolvedValue(undefined);
+
+    const response = await new Signup().initializeSignup('unknown-token');
+
+    expect(response.isReady).toBe(false);
+    expect(response.error).toMatch(/no longer valid/i);
+    expect(response.error).not.toMatch(/expired/i);
+  });
+
+  it('accepts a token that has not expired yet', async () => {
+    const invite = {
+      id: 'invite-1',
+      email: 'invitee@test.local',
+      token: 'good-token',
+      tokenExpiresAt: moment().add(1, 'day'),
+    };
+    dbGet.mockResolvedValue(invite);
+
+    const response = await new Signup().initializeSignup('good-token');
+
+    expect(response.isReady).toBe(true);
+    expect(response.error).toBeUndefined();
+    expect(response.invite?.email).toBe('invitee@test.local');
+  });
+
+  it('still blocks tokenless signup when invite-only, without an expiry message', async () => {
+    const response = await new Signup().initializeSignup(undefined);
+
+    // Default config is invite-optional, so this is the open case.
+    expect(response.isReady).toBe(true);
+    expect(dbGet).not.toHaveBeenCalled();
+  });
+});

package/LICENSE

@@ -1,21 +0,0 @@
-MIT License
-
-Copyright (c) 2023 Brent Bahry
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.