@vantran-se/openchamber-web 1.23.1 → 1.24.4

package/server/lib/guests/oauth.test.js

@@ -0,0 +1,481 @@
+import { afterEach, describe, expect, test } from 'bun:test';
+import fs from 'node:fs/promises';
+import os from 'node:os';
+import path from 'node:path';
+
+import { getGuestAuth, guestAuthPersistPath, patchGuestAuth } from './auth-store.js';
+import {
+  clearGuestPendingForTests,
+  consumeGuestAuthorization,
+  credentialTarget,
+  createPkcePair,
+  encodeBasicCredential,
+  guestAuthorizationHeader,
+  guestRedirectUri,
+  saveGuestAccessToken,
+  saveGuestOAuthClient,
+  refreshGuestAccessToken,
+  startGuestAuthorization,
+  storedTokensUsable,
+  toPublicGuestAuth,
+} from './oauth.js';
+
+const clickupGuest = {
+  id: 'clickup',
+  integration: {
+    name: 'ClickUp',
+    description: 'Tasks',
+    oauth: {
+      authorizeUrl: 'https://app.clickup.com/api',
+      tokenUrl: 'https://api.clickup.com/api/v2/oauth/token',
+      apiOrigin: 'https://api.clickup.com',
+      account: { path: '/api/v2/user', name: 'user.username' },
+    },
+  },
+};
+
+afterEach(() => {
+  clearGuestPendingForTests();
+});
+
+describe('guestRedirectUri', () => {
+  test('stays on the server origin', () => {
+    expect(guestRedirectUri('http://127.0.0.1:4096', 'clickup'))
+      .toBe('http://127.0.0.1:4096/api/guests/clickup/oauth/callback');
+  });
+});
+
+describe('toPublicGuestAuth', () => {
+  test('never forwards tokens', () => {
+    expect(toPublicGuestAuth({
+      clientId: 'id',
+      clientSecret: 'secret',
+      accessToken: 'tok',
+      account: 'ada',
+      settings: { 'list-id': '1' },
+    })).toEqual({
+      connected: true,
+      account: 'ada',
+      hasClient: true,
+      settings: { 'list-id': '1' },
+    });
+  });
+});
+
+describe('startGuestAuthorization', () => {
+  test('builds a PKCE authorize URL after a client id is saved', async () => {
+    const dir = await fs.mkdtemp(path.join(os.tmpdir(), 'oc-guest-oauth-'));
+    const persistPath = guestAuthPersistPath(dir);
+    await patchGuestAuth('clickup', { clientId: 'app-id', clientSecret: 'app-secret', clientTarget: credentialTarget(clickupGuest.integration) }, persistPath);
+    const started = await startGuestAuthorization({
+      guest: clickupGuest,
+      persistPath,
+      origin: 'http://127.0.0.1:4096',
+    });
+    const url = new URL(started.authorizationUrl);
+    expect(url.origin + url.pathname).toBe('https://app.clickup.com/api');
+    expect(url.searchParams.get('client_id')).toBe('app-id');
+    expect(url.searchParams.get('redirect_uri')).toBe('http://127.0.0.1:4096/api/guests/clickup/oauth/callback');
+    expect(url.searchParams.get('code_challenge_method')).toBe('S256');
+    expect(url.searchParams.get('state')).toBeTruthy();
+    await fs.rm(dir, { recursive: true, force: true });
+  });
+
+  test('refuses start without a client id', async () => {
+    const dir = await fs.mkdtemp(path.join(os.tmpdir(), 'oc-guest-oauth-'));
+    const persistPath = guestAuthPersistPath(dir);
+    try {
+      await startGuestAuthorization({
+        guest: clickupGuest,
+        persistPath,
+        origin: 'http://127.0.0.1:4096',
+      });
+      throw new Error('should have thrown');
+    } catch (error) {
+      expect(error.code).toBe('CLIENT_MISSING');
+    }
+    await fs.rm(dir, { recursive: true, force: true });
+  });
+});
+
+describe('consumeGuestAuthorization', () => {
+  test('stores tokens from the token endpoint and never returns them', async () => {
+    const dir = await fs.mkdtemp(path.join(os.tmpdir(), 'oc-guest-oauth-'));
+    const persistPath = guestAuthPersistPath(dir);
+    await patchGuestAuth('clickup', { clientId: 'app-id', clientSecret: 'app-secret', clientTarget: credentialTarget(clickupGuest.integration) }, persistPath);
+    const started = await startGuestAuthorization({
+      guest: clickupGuest,
+      persistPath,
+      origin: 'http://127.0.0.1:4096',
+    });
+    const state = new URL(started.authorizationUrl).searchParams.get('state');
+    const originalFetch = globalThis.fetch;
+    globalThis.fetch = async (url) => {
+      const target = String(url);
+      if (target === 'https://api.clickup.com/api/v2/oauth/token') {
+        return new Response(JSON.stringify({
+          access_token: 'access-1',
+          refresh_token: 'refresh-1',
+          token_type: 'Bearer',
+          expires_in: 3600,
+        }), { status: 200, headers: { 'Content-Type': 'application/json' } });
+      }
+      if (target === 'https://api.clickup.com/api/v2/user') {
+        return new Response(JSON.stringify({ user: { username: 'ada' } }), {
+          status: 200,
+          headers: { 'Content-Type': 'application/json' },
+        });
+      }
+      throw new Error(`unexpected fetch ${target}`);
+    };
+    try {
+      const result = await consumeGuestAuthorization({
+        guest: clickupGuest,
+        persistPath,
+        code: 'auth-code',
+        state,
+      });
+      expect(result).toEqual({ connected: true, account: 'ada' });
+      const stored = await getGuestAuth('clickup', persistPath);
+      expect(stored.accessToken).toBe('access-1');
+      expect(toPublicGuestAuth(stored).accessToken).toBeUndefined();
+    } finally {
+      globalThis.fetch = originalFetch;
+      await fs.rm(dir, { recursive: true, force: true });
+    }
+  });
+
+  test('rejects a callback without state even when this guest has one pending exchange', async () => {
+    const dir = await fs.mkdtemp(path.join(os.tmpdir(), 'oc-guest-oauth-'));
+    const persistPath = guestAuthPersistPath(dir);
+    await patchGuestAuth('clickup', { clientId: 'app-id', clientSecret: 'app-secret', clientTarget: credentialTarget(clickupGuest.integration) }, persistPath);
+    await startGuestAuthorization({
+      guest: clickupGuest,
+      persistPath,
+      origin: 'http://127.0.0.1:4096',
+    });
+    const originalFetch = globalThis.fetch;
+    globalThis.fetch = async (url) => {
+      const target = String(url);
+      if (target === 'https://api.clickup.com/api/v2/oauth/token') {
+        return new Response(JSON.stringify({ access_token: 'access-2' }), {
+          status: 200,
+          headers: { 'Content-Type': 'application/json' },
+        });
+      }
+      if (target === 'https://api.clickup.com/api/v2/user') {
+        return new Response(JSON.stringify({ user: { username: 'ada' } }), {
+          status: 200,
+          headers: { 'Content-Type': 'application/json' },
+        });
+      }
+      throw new Error(`unexpected fetch ${target}`);
+    };
+    try {
+      await expect(consumeGuestAuthorization({
+        guest: clickupGuest,
+        persistPath,
+        code: 'auth-code',
+        state: '',
+      })).rejects.toThrow();
+    } finally {
+      globalThis.fetch = originalFetch;
+      await fs.rm(dir, { recursive: true, force: true });
+    }
+  });
+
+  test('falls back to a JSON token body when form exchange fails', async () => {
+    const dir = await fs.mkdtemp(path.join(os.tmpdir(), 'oc-guest-oauth-'));
+    const persistPath = guestAuthPersistPath(dir);
+    await patchGuestAuth('clickup', { clientId: 'app-id', clientSecret: 'app-secret', clientTarget: credentialTarget(clickupGuest.integration) }, persistPath);
+    const started = await startGuestAuthorization({
+      guest: clickupGuest,
+      persistPath,
+      origin: 'http://127.0.0.1:4096',
+    });
+    const state = new URL(started.authorizationUrl).searchParams.get('state');
+    const originalFetch = globalThis.fetch;
+    const seen = [];
+    globalThis.fetch = async (url, init) => {
+      const target = String(url);
+      if (target === 'https://api.clickup.com/api/v2/oauth/token') {
+        seen.push(init.headers['Content-Type']);
+        if (init.headers['Content-Type'] === 'application/x-www-form-urlencoded') {
+          return new Response(JSON.stringify({ error: 'invalid_request' }), { status: 400 });
+        }
+        const body = JSON.parse(init.body);
+        expect(body).toEqual({
+          client_id: 'app-id',
+          client_secret: 'app-secret',
+          code: 'auth-code',
+        });
+        return new Response(JSON.stringify({ access_token: 'access-json' }), { status: 200 });
+      }
+      if (target === 'https://api.clickup.com/api/v2/user') {
+        return new Response(JSON.stringify({ user: { username: 'ada' } }), { status: 200 });
+      }
+      throw new Error(`unexpected fetch ${target}`);
+    };
+    try {
+      const result = await consumeGuestAuthorization({
+        guest: clickupGuest,
+        persistPath,
+        code: 'auth-code',
+        state,
+      });
+      expect(result).toEqual({ connected: true, account: 'ada' });
+      expect(seen).toEqual([
+        'application/x-www-form-urlencoded',
+        'application/json',
+      ]);
+    } finally {
+      globalThis.fetch = originalFetch;
+      await fs.rm(dir, { recursive: true, force: true });
+    }
+  });
+
+  test('rejects an unknown state', async () => {
+    const dir = await fs.mkdtemp(path.join(os.tmpdir(), 'oc-guest-oauth-'));
+    const persistPath = guestAuthPersistPath(dir);
+    try {
+      await consumeGuestAuthorization({
+        guest: clickupGuest,
+        persistPath,
+        code: 'auth-code',
+        state: 'nope',
+      });
+      throw new Error('should have thrown');
+    } catch (error) {
+      expect(error.code).toBe('STATE_MISMATCH');
+    }
+    await fs.rm(dir, { recursive: true, force: true });
+  });
+});
+
+describe('createPkcePair', () => {
+  test('returns a verifier and challenge', () => {
+    const pair = createPkcePair();
+    expect(pair.verifier.length).toBeGreaterThan(20);
+    expect(pair.challenge.length).toBeGreaterThan(20);
+    expect(pair.verifier).not.toBe(pair.challenge);
+  });
+});
+
+describe('saveGuestAccessToken with a basic scheme', () => {
+  const jiraGuest = {
+    id: 'jira',
+    integration: {
+      name: 'Jira',
+      description: 'Issues',
+      token: {
+        apiOrigin: 'https://acme.atlassian.net',
+        scheme: 'basic',
+        account: { path: '/rest/api/3/myself', name: 'displayName' },
+      },
+    },
+  };
+
+  test('encodes username:token, probes with a Basic header, and stores only the pair', async () => {
+    const dir = await fs.mkdtemp(path.join(os.tmpdir(), 'oc-guest-basic-'));
+    const persistPath = guestAuthPersistPath(dir);
+    const originalFetch = globalThis.fetch;
+    let seenAuthorization = '';
+    globalThis.fetch = async (url, init) => {
+      expect(String(url)).toBe('https://acme.atlassian.net/rest/api/3/myself');
+      seenAuthorization = init.headers.Authorization;
+      return new Response(JSON.stringify({ displayName: 'Ada Lovelace' }), {
+        status: 200,
+        headers: { 'Content-Type': 'application/json' },
+      });
+    };
+    try {
+      const result = await saveGuestAccessToken({ guest: jiraGuest, persistPath, token: 'api-token', username: 'ada@acme.example' });
+      expect(result).toEqual({ connected: true, account: 'Ada Lovelace' });
+      const expected = encodeBasicCredential('ada@acme.example', 'api-token');
+      expect(seenAuthorization).toBe(`Basic ${expected}`);
+      const stored = await getGuestAuth('jira', persistPath);
+      expect(stored.accessToken).toBe(expected);
+      expect(stored.tokenType).toBe('basic');
+      expect(guestAuthorizationHeader(stored.accessToken, 'basic')).toBe(`Basic ${expected}`);
+    } finally {
+      globalThis.fetch = originalFetch;
+      await fs.rm(dir, { recursive: true, force: true });
+    }
+  });
+
+  test('refuses a basic integration without a username', async () => {
+    const dir = await fs.mkdtemp(path.join(os.tmpdir(), 'oc-guest-basic-'));
+    const persistPath = guestAuthPersistPath(dir);
+    try {
+      await expect(saveGuestAccessToken({ guest: jiraGuest, persistPath, token: 'api-token' }))
+        .rejects.toMatchObject({ code: 'USERNAME_MISSING' });
+    } finally {
+      await fs.rm(dir, { recursive: true, force: true });
+    }
+  });
+
+  test('uses the username as the account label when the manifest declares no account probe', async () => {
+    const dir = await fs.mkdtemp(path.join(os.tmpdir(), 'oc-guest-basic-'));
+    const persistPath = guestAuthPersistPath(dir);
+    const guest = { ...jiraGuest, integration: { ...jiraGuest.integration, token: { apiOrigin: 'https://acme.atlassian.net', scheme: 'basic' } } };
+    try {
+      const result = await saveGuestAccessToken({ guest, persistPath, token: 'api-token', username: 'ada@acme.example' });
+      expect(result).toEqual({ connected: true, account: 'ada@acme.example' });
+    } finally {
+      await fs.rm(dir, { recursive: true, force: true });
+    }
+  });
+});
+
+describe('a package that changes its endpoints mid sign-in', () => {
+  test('the callback refuses the exchange and nothing reaches the new endpoint', async () => {
+    const dir = await fs.mkdtemp(path.join(os.tmpdir(), 'oc-guest-oauth-'));
+    const persistPath = guestAuthPersistPath(dir);
+    await patchGuestAuth('clickup', { clientId: 'app-id', clientSecret: 'app-secret', clientTarget: credentialTarget(clickupGuest.integration) }, persistPath);
+    const started = await startGuestAuthorization({ guest: clickupGuest, persistPath, origin: 'http://127.0.0.1:4096' });
+    const state = new URL(started.authorizationUrl).searchParams.get('state');
+    const moved = {
+      ...clickupGuest,
+      integration: { ...clickupGuest.integration, oauth: { ...clickupGuest.integration.oauth, tokenUrl: 'https://evil.example/token' } },
+    };
+    const originalFetch = globalThis.fetch;
+    const seen = [];
+    globalThis.fetch = async (url) => {
+      seen.push(String(url));
+      return new Response('{}', { status: 200 });
+    };
+    try {
+      await expect(consumeGuestAuthorization({ guest: moved, persistPath, code: 'auth-code', state }))
+        .rejects.toMatchObject({ code: 'TARGET_CHANGED' });
+      expect(seen).toEqual([]);
+      expect((await getGuestAuth('clickup', persistPath))?.accessToken).toBeUndefined();
+    } finally {
+      globalThis.fetch = originalFetch;
+      await fs.rm(dir, { recursive: true, force: true });
+    }
+  });
+
+  test('stored tokens record the target and stop counting once it moves', async () => {
+    const dir = await fs.mkdtemp(path.join(os.tmpdir(), 'oc-guest-oauth-'));
+    const persistPath = guestAuthPersistPath(dir);
+    await patchGuestAuth('clickup', { clientId: 'app-id', clientSecret: 'app-secret', clientTarget: credentialTarget(clickupGuest.integration) }, persistPath);
+    const started = await startGuestAuthorization({ guest: clickupGuest, persistPath, origin: 'http://127.0.0.1:4096' });
+    const state = new URL(started.authorizationUrl).searchParams.get('state');
+    const originalFetch = globalThis.fetch;
+    globalThis.fetch = async (url) => {
+      if (String(url) === 'https://api.clickup.com/api/v2/oauth/token') {
+        return new Response(JSON.stringify({ access_token: 'access-1', refresh_token: 'refresh-1', token_type: 'Bearer', expires_in: 3600 }), { status: 200, headers: { 'Content-Type': 'application/json' } });
+      }
+      return new Response('{}', { status: 200, headers: { 'Content-Type': 'application/json' } });
+    };
+    try {
+      await consumeGuestAuthorization({ guest: clickupGuest, persistPath, code: 'auth-code', state });
+      const stored = await getGuestAuth('clickup', persistPath);
+      expect(stored.target).toEqual({
+        apiOrigin: 'https://api.clickup.com',
+        authorizeUrl: 'https://app.clickup.com/api',
+        tokenUrl: 'https://api.clickup.com/api/v2/oauth/token',
+      });
+      expect(storedTokensUsable(stored, clickupGuest.integration)).toBe(true);
+      const moved = { ...clickupGuest.integration, oauth: { ...clickupGuest.integration.oauth, apiOrigin: 'https://api.other.example' } };
+      expect(storedTokensUsable(stored, moved)).toBe(false);
+    } finally {
+      globalThis.fetch = originalFetch;
+      await fs.rm(dir, { recursive: true, force: true });
+    }
+  });
+});
+
+describe('client credentials after the package moved its endpoints', () => {
+  const moved = {
+    ...clickupGuest,
+    integration: { ...clickupGuest.integration, oauth: { ...clickupGuest.integration.oauth, tokenUrl: 'https://evil.example/token' } },
+  };
+
+  test('a new Connect refuses to reuse the old client id and secret', async () => {
+    const dir = await fs.mkdtemp(path.join(os.tmpdir(), 'oc-guest-oauth-'));
+    const persistPath = guestAuthPersistPath(dir);
+    await patchGuestAuth('clickup', { clientId: 'app-id', clientSecret: 'app-secret', clientTarget: credentialTarget(clickupGuest.integration) }, persistPath);
+    try {
+      await expect(startGuestAuthorization({ guest: moved, persistPath, origin: 'http://127.0.0.1:4096' }))
+        .rejects.toMatchObject({ code: 'CLIENT_MISSING' });
+      expect(toPublicGuestAuth(await getGuestAuth('clickup', persistPath), moved.integration).hasClient).toBe(false);
+      expect(toPublicGuestAuth(await getGuestAuth('clickup', persistPath), clickupGuest.integration).hasClient).toBe(true);
+    } finally {
+      await fs.rm(dir, { recursive: true, force: true });
+    }
+  });
+
+  test('a refresh that finished after a new Connect for other endpoints is dropped', async () => {
+    const dir = await fs.mkdtemp(path.join(os.tmpdir(), 'oc-guest-oauth-'));
+    const persistPath = guestAuthPersistPath(dir);
+    await patchGuestAuth('clickup', {
+      clientId: 'app-id',
+      clientSecret: 'app-secret',
+      clientTarget: credentialTarget(clickupGuest.integration),
+      accessToken: 'access-a',
+      refreshToken: 'refresh-a',
+      target: credentialTarget(clickupGuest.integration),
+    }, persistPath);
+    const originalFetch = globalThis.fetch;
+    let release;
+    const gate = new Promise((resolve) => { release = resolve; });
+    globalThis.fetch = async () => {
+      await gate;
+      return new Response(JSON.stringify({ access_token: 'access-a2', refresh_token: 'refresh-a2', token_type: 'Bearer', expires_in: 3600 }), { status: 200, headers: { 'Content-Type': 'application/json' } });
+    };
+    try {
+      const refreshing = refreshGuestAccessToken({ guest: clickupGuest, persistPath });
+      // Meanwhile the user connected the moved package: new client, new tokens, new target.
+      await patchGuestAuth('clickup', {
+        clientId: 'app-id-b',
+        clientSecret: 'app-secret-b',
+        clientTarget: credentialTarget(moved.integration),
+        accessToken: 'access-b',
+        refreshToken: 'refresh-b',
+        target: credentialTarget(moved.integration),
+      }, persistPath);
+      release();
+      expect(await refreshing).toBeNull();
+      const stored = await getGuestAuth('clickup', persistPath);
+      expect(stored.accessToken).toBe('access-b');
+      expect(stored.refreshToken).toBe('refresh-b');
+      expect(stored.target).toEqual(credentialTarget(moved.integration));
+    } finally {
+      globalThis.fetch = originalFetch;
+      await fs.rm(dir, { recursive: true, force: true });
+    }
+  });
+});
+
+describe('saveGuestOAuthClient', () => {
+  const moved = {
+    ...clickupGuest,
+    integration: { ...clickupGuest.integration, oauth: { ...clickupGuest.integration.oauth, tokenUrl: 'https://evil.example/token' } },
+  };
+
+  test('an empty secret keeps the stored one only for the same client and endpoints', async () => {
+    const dir = await fs.mkdtemp(path.join(os.tmpdir(), 'oc-guest-oauth-'));
+    const persistPath = guestAuthPersistPath(dir);
+    try {
+      await saveGuestOAuthClient({ guest: clickupGuest, persistPath, clientId: 'app-id', clientSecret: 'app-secret' });
+      await saveGuestOAuthClient({ guest: clickupGuest, persistPath, clientId: 'app-id' });
+      expect((await getGuestAuth('clickup', persistPath)).clientSecret).toBe('app-secret');
+
+      // Same endpoints, new client id: the old secret does not belong to it.
+      await saveGuestOAuthClient({ guest: clickupGuest, persistPath, clientId: 'app-id-2' });
+      expect((await getGuestAuth('clickup', persistPath)).clientSecret).toBeUndefined();
+
+      // Same client id, moved endpoints: the old secret must not follow.
+      await saveGuestOAuthClient({ guest: clickupGuest, persistPath, clientId: 'app-id-2', clientSecret: 'secret-2' });
+      await saveGuestOAuthClient({ guest: moved, persistPath, clientId: 'app-id-2' });
+      const stored = await getGuestAuth('clickup', persistPath);
+      expect(stored.clientSecret).toBeUndefined();
+      expect(stored.clientTarget).toEqual(credentialTarget(moved.integration));
+      await expect(startGuestAuthorization({ guest: moved, persistPath, origin: 'http://127.0.0.1:4096' }))
+        .resolves.toMatchObject({ authorizationUrl: expect.stringContaining('client_id=app-id-2') });
+    } finally {
+      await fs.rm(dir, { recursive: true, force: true });
+    }
+  });
+});