latchkey 3.7.0 → 3.8.0

package/dist/tests/manualCompletion.test.js

@@ -0,0 +1,221 @@
+/**
+ * Tests for the credential request shown when a browser automation fails: the
+ * user pastes what they created by hand into a form, and the page hands it back
+ * to latchkey.
+ *
+ * Browser-free: the context and page are stand-ins exposing only what the
+ * request uses, which also lets the exposed binding be called directly.
+ */
+import { describe, it, expect } from 'vitest';
+import vm from 'node:vm';
+import { CredentialFormFieldMissingError, CredentialFormValues, parseSubmittedCredentialValues, requestCredentialsFromUser, } from '../src/playwrightUtils.js';
+const FORM_FIELDS = [
+    { name: 'clientId', label: 'Client ID' },
+    { name: 'clientSecret', label: 'Client secret', hint: 'From the app page' },
+];
+function createFakeBrowser() {
+    let renderedScript = '';
+    let submitBinding;
+    const closeListeners = [];
+    let markAsShown = () => {
+        /* replaced below */
+    };
+    const shown = new Promise((resolve) => {
+        markAsShown = resolve;
+    });
+    const page = {
+        isClosed: () => false,
+        bringToFront: () => Promise.resolve(),
+        exposeFunction: (_name, binding) => {
+            submitBinding = binding;
+            return Promise.resolve();
+        },
+        evaluate: (script) => {
+            renderedScript = script;
+            markAsShown();
+            return Promise.resolve(undefined);
+        },
+        on: (event, listener) => {
+            if (event === 'close') {
+                closeListeners.push(listener);
+            }
+        },
+    };
+    const context = {
+        newPage: () => Promise.resolve(page),
+        on: () => undefined,
+        browser: () => ({ on: () => undefined }),
+    };
+    return {
+        shown,
+        getRenderedScript: () => renderedScript,
+        submit: (values) => {
+            if (submitBinding === undefined) {
+                throw new Error('The credential request has not been shown yet.');
+            }
+            return submitBinding(values);
+        },
+        closeBrowser: () => {
+            for (const listener of closeListeners) {
+                listener();
+            }
+        },
+        context,
+        page,
+    };
+}
+const NEVER_MS = 60_000;
+describe('requestCredentialsFromUser', () => {
+    it('returns what the user submitted once it is accepted', async () => {
+        const browser = createFakeBrowser();
+        const request = requestCredentialsFromUser({
+            context: browser.context,
+            spinnerPage: browser.page,
+            message: 'Automation failed',
+            details: 'Do it yourself',
+            fields: FORM_FIELDS,
+            decide: (values) => Promise.resolve({ accepted: `${values.get('clientId')}:${values.get('clientSecret')}` }),
+            timeoutMs: NEVER_MS,
+        });
+        await browser.shown;
+        const decision = await browser.submit({ clientId: 'id-1', clientSecret: 'secret-1' });
+        expect(decision).toEqual({ accepted: true });
+        await expect(request).resolves.toBe('id-1:secret-1');
+    });
+    it('reports a refusal back to the form and keeps waiting', async () => {
+        const browser = createFakeBrowser();
+        const decisions = [
+            { problem: 'GitHub did not accept these credentials.' },
+            { accepted: 'second-try' },
+        ];
+        const request = requestCredentialsFromUser({
+            context: browser.context,
+            spinnerPage: browser.page,
+            message: 'Automation failed',
+            details: 'Do it yourself',
+            fields: FORM_FIELDS,
+            decide: () => Promise.resolve(decisions.shift() ?? { problem: 'no more decisions' }),
+            timeoutMs: NEVER_MS,
+        });
+        await browser.shown;
+        const refusal = await browser.submit({ clientId: 'id-1', clientSecret: 'wrong' });
+        expect(refusal).toEqual({ problem: 'GitHub did not accept these credentials.' });
+        const acceptance = await browser.submit({ clientId: 'id-1', clientSecret: 'right' });
+        expect(acceptance).toEqual({ accepted: true });
+        await expect(request).resolves.toBe('second-try');
+    });
+    it('turns a failure to build the credentials into a problem for the user', async () => {
+        const browser = createFakeBrowser();
+        void requestCredentialsFromUser({
+            context: browser.context,
+            spinnerPage: browser.page,
+            message: 'Automation failed',
+            details: 'Do it yourself',
+            fields: FORM_FIELDS,
+            decide: () => Promise.reject(new SyntaxError('That is not a valid client id.')),
+            timeoutMs: 50,
+        });
+        await browser.shown;
+        expect(await browser.submit({ clientId: 'nonsense', clientSecret: 'secret-1' })).toEqual({
+            problem: 'That is not a valid client id.',
+        });
+    });
+    it('asks for the missing fields instead of bothering the caller', async () => {
+        const browser = createFakeBrowser();
+        let decideCalls = 0;
+        void requestCredentialsFromUser({
+            context: browser.context,
+            spinnerPage: browser.page,
+            message: 'Automation failed',
+            details: 'Do it yourself',
+            fields: FORM_FIELDS,
+            decide: () => {
+                decideCalls++;
+                return Promise.resolve({ accepted: 'never' });
+            },
+            timeoutMs: 50,
+        });
+        await browser.shown;
+        expect(await browser.submit({ clientId: 'id-1' })).toEqual({
+            problem: 'Please fill in every field.',
+        });
+        expect(decideCalls).toBe(0);
+    });
+    it('gives up when the user closes the browser', async () => {
+        const browser = createFakeBrowser();
+        const request = requestCredentialsFromUser({
+            context: browser.context,
+            spinnerPage: browser.page,
+            message: 'Automation failed',
+            details: 'Do it yourself',
+            fields: FORM_FIELDS,
+            decide: () => Promise.resolve({ accepted: 'never' }),
+            timeoutMs: NEVER_MS,
+        });
+        await browser.shown;
+        browser.closeBrowser();
+        await expect(request).resolves.toBeNull();
+    });
+    it('gives up when the request times out', async () => {
+        const browser = createFakeBrowser();
+        const request = requestCredentialsFromUser({
+            context: browser.context,
+            spinnerPage: browser.page,
+            message: 'Automation failed',
+            details: 'Do it yourself',
+            fields: FORM_FIELDS,
+            decide: () => Promise.resolve({ accepted: 'never' }),
+            timeoutMs: 10,
+        });
+        await expect(request).resolves.toBeNull();
+    });
+});
+/**
+ * The overlay is built as a source string, so a mistake in it only shows up in a
+ * real browser. Parsing what we would send catches that here instead — with
+ * texts full of the characters that would break a naive template.
+ */
+describe('credential request page script', () => {
+    const AWKWARD_MESSAGE = "Backtick ` and <b>markup</b> and ${braces} and 'quotes'";
+    const AWKWARD_DETAILS = 'Line one\nLine `two` with "quotes" and ${more}';
+    it('parses as JavaScript and carries the field texts', async () => {
+        const browser = createFakeBrowser();
+        void requestCredentialsFromUser({
+            context: browser.context,
+            spinnerPage: browser.page,
+            message: AWKWARD_MESSAGE,
+            details: AWKWARD_DETAILS,
+            fields: [{ name: 'clientId', label: 'Client `ID`', hint: 'Looks like ${this}' }],
+            decide: () => Promise.resolve({ accepted: 'never' }),
+            timeoutMs: 10,
+        });
+        await browser.shown;
+        const script = browser.getRenderedScript();
+        expect(() => new vm.Script(script)).not.toThrow();
+        expect(script).toContain('Client `ID`');
+        expect(script).toContain('clientId');
+        expect(script).toContain('__latchkeySubmitCredentials');
+    });
+});
+describe('parseSubmittedCredentialValues', () => {
+    it('accepts a complete set of values', () => {
+        const values = parseSubmittedCredentialValues({ clientId: 'id-1', clientSecret: 'secret-1' }, FORM_FIELDS);
+        expect(values?.get('clientId')).toBe('id-1');
+        expect(values?.get('clientSecret')).toBe('secret-1');
+    });
+    it('rejects submissions with a missing or empty field', () => {
+        expect(parseSubmittedCredentialValues({ clientId: 'id-1' }, FORM_FIELDS)).toBeNull();
+        expect(parseSubmittedCredentialValues({ clientId: 'id-1', clientSecret: '' }, FORM_FIELDS)).toBeNull();
+    });
+    it('rejects anything that is not a set of values', () => {
+        expect(parseSubmittedCredentialValues('token', FORM_FIELDS)).toBeNull();
+        expect(parseSubmittedCredentialValues(null, FORM_FIELDS)).toBeNull();
+    });
+});
+describe('CredentialFormValues', () => {
+    it('rejects reading a field the form does not have', () => {
+        const values = new CredentialFormValues(new Map([['token', 'ghp_1']]));
+        expect(() => values.get('somethingElse')).toThrow(CredentialFormFieldMissingError);
+    });
+});
+//# sourceMappingURL=manualCompletion.test.js.map

package/dist/tests/manualCompletion.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"manualCompletion.test.js","sourceRoot":"","sources":["../../tests/manualCompletion.test.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAEH,OAAO,EAAE,QAAQ,EAAE,EAAE,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAC;AAC9C,OAAO,EAAE,MAAM,SAAS,CAAC;AAEzB,OAAO,EACL,+BAA+B,EAC/B,oBAAoB,EACpB,8BAA8B,EAC9B,0BAA0B,GAG3B,MAAM,2BAA2B,CAAC;AAEnC,MAAM,WAAW,GAAmC;IAClD,EAAE,IAAI,EAAE,UAAU,EAAE,KAAK,EAAE,WAAW,EAAE;IACxC,EAAE,IAAI,EAAE,cAAc,EAAE,KAAK,EAAE,eAAe,EAAE,IAAI,EAAE,mBAAmB,EAAE;CAC5E,CAAC;AAgBF,SAAS,iBAAiB;IACxB,IAAI,cAAc,GAAG,EAAE,CAAC;IACxB,IAAI,aAA4C,CAAC;IACjD,MAAM,cAAc,GAAmB,EAAE,CAAC;IAC1C,IAAI,WAAW,GAAe,GAAG,EAAE;QACjC,oBAAoB;IACtB,CAAC,CAAC;IACF,MAAM,KAAK,GAAG,IAAI,OAAO,CAAO,CAAC,OAAO,EAAE,EAAE;QAC1C,WAAW,GAAG,OAAO,CAAC;IACxB,CAAC,CAAC,CAAC;IAEH,MAAM,IAAI,GAAG;QACX,QAAQ,EAAE,GAAG,EAAE,CAAC,KAAK;QACrB,YAAY,EAAE,GAAG,EAAE,CAAC,OAAO,CAAC,OAAO,EAAE;QACrC,cAAc,EAAE,CAAC,KAAa,EAAE,OAA0B,EAAE,EAAE;YAC5D,aAAa,GAAG,OAAO,CAAC;YACxB,OAAO,OAAO,CAAC,OAAO,EAAE,CAAC;QAC3B,CAAC;QACD,QAAQ,EAAE,CAAC,MAAc,EAAE,EAAE;YAC3B,cAAc,GAAG,MAAM,CAAC;YACxB,WAAW,EAAE,CAAC;YACd,OAAO,OAAO,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;QACpC,CAAC;QACD,EAAE,EAAE,CAAC,KAAa,EAAE,QAAoB,EAAE,EAAE;YAC1C,IAAI,KAAK,KAAK,OAAO,EAAE,CAAC;gBACtB,cAAc,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;YAChC,CAAC;QACH,CAAC;KACiB,CAAC;IAErB,MAAM,OAAO,GAAG;QACd,OAAO,EAAE,GAAG,EAAE,CAAC,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC;QACpC,EAAE,EAAE,GAAG,EAAE,CAAC,SAAS;QACnB,OAAO,EAAE,GAAG,EAAE,CAAC,CAAC,EAAE,EAAE,EAAE,GAAG,EAAE,CAAC,SAAS,EAAE,CAAC;KACZ,CAAC;IAE/B,OAAO;QACL,KAAK;QACL,iBAAiB,EAAE,GAAG,EAAE,CAAC,cAAc;QACvC,MAAM,EAAE,CAAC,MAAM,EAAE,EAAE;YACjB,IAAI,aAAa,KAAK,SAAS,EAAE,CAAC;gBAChC,MAAM,IAAI,KAAK,CAAC,gDAAgD,CAAC,CAAC;YACpE,CAAC;YACD,OAAO,aAAa,CAAC,MAAM,CAAC,CAAC;QAC/B,CAAC;QACD,YAAY,EAAE,GAAG,EAAE;YACjB,KAAK,MAAM,QAAQ,IAAI,cAAc,EAAE,CAAC;gBACtC,QAAQ,EAAE,CAAC;YACb,CAAC;QACH,CAAC;QACD,OAAO;QACP,IAAI;KACL,CAAC;AACJ,CAAC;AAED,MAAM,QAAQ,GAAG,MAAM,CAAC;AAExB,QAAQ,CAAC,4BAA4B,EAAE,GAAG,EAAE;IAC1C,EAAE,CAAC,qDAAqD,EAAE,KAAK,IAAI,EAAE;QACnE,MAAM,OAAO,GAAG,iBAAiB,EAAE,CAAC;QACpC,MAAM,OAAO,GAAG,0BAA0B,CAAS;YACjD,OAAO,EAAE,OAAO,CAAC,OAAO;YACxB,WAAW,EAAE,OAAO,CAAC,IAAI;YACzB,OAAO,EAAE,mBAAmB;YAC5B,OAAO,EAAE,gBAAgB;YACzB,MAAM,EAAE,WAAW;YACnB,MAAM,EAAE,CAAC,MAAM,EAAE,EAAE,CACjB,OAAO,CAAC,OAAO,CAAC,EAAE,QAAQ,EAAE,GAAG,MAAM,CAAC,GAAG,CAAC,UAAU,CAAC,IAAI,MAAM,CAAC,GAAG,CAAC,cAAc,CAAC,EAAE,EAAE,CAAC;YAC1F,SAAS,EAAE,QAAQ;SACpB,CAAC,CAAC;QAEH,MAAM,OAAO,CAAC,KAAK,CAAC;QACpB,MAAM,QAAQ,GAAG,MAAM,OAAO,CAAC,MAAM,CAAC,EAAE,QAAQ,EAAE,MAAM,EAAE,YAAY,EAAE,UAAU,EAAE,CAAC,CAAC;QAEtF,MAAM,CAAC,QAAQ,CAAC,CAAC,OAAO,CAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC,CAAC;QAC7C,MAAM,MAAM,CAAC,OAAO,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC;IACvD,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,sDAAsD,EAAE,KAAK,IAAI,EAAE;QACpE,MAAM,OAAO,GAAG,iBAAiB,EAAE,CAAC;QACpC,MAAM,SAAS,GAAqC;YAClD,EAAE,OAAO,EAAE,0CAA0C,EAAE;YACvD,EAAE,QAAQ,EAAE,YAAY,EAAE;SAC3B,CAAC;QACF,MAAM,OAAO,GAAG,0BAA0B,CAAS;YACjD,OAAO,EAAE,OAAO,CAAC,OAAO;YACxB,WAAW,EAAE,OAAO,CAAC,IAAI;YACzB,OAAO,EAAE,mBAAmB;YAC5B,OAAO,EAAE,gBAAgB;YACzB,MAAM,EAAE,WAAW;YACnB,MAAM,EAAE,GAAG,EAAE,CAAC,OAAO,CAAC,OAAO,CAAC,SAAS,CAAC,KAAK,EAAE,IAAI,EAAE,OAAO,EAAE,mBAAmB,EAAE,CAAC;YACpF,SAAS,EAAE,QAAQ;SACpB,CAAC,CAAC;QACH,MAAM,OAAO,CAAC,KAAK,CAAC;QAEpB,MAAM,OAAO,GAAG,MAAM,OAAO,CAAC,MAAM,CAAC,EAAE,QAAQ,EAAE,MAAM,EAAE,YAAY,EAAE,OAAO,EAAE,CAAC,CAAC;QAClF,MAAM,CAAC,OAAO,CAAC,CAAC,OAAO,CAAC,EAAE,OAAO,EAAE,0CAA0C,EAAE,CAAC,CAAC;QAEjF,MAAM,UAAU,GAAG,MAAM,OAAO,CAAC,MAAM,CAAC,EAAE,QAAQ,EAAE,MAAM,EAAE,YAAY,EAAE,OAAO,EAAE,CAAC,CAAC;QACrF,MAAM,CAAC,UAAU,CAAC,CAAC,OAAO,CAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC,CAAC;QAC/C,MAAM,MAAM,CAAC,OAAO,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;IACpD,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,sEAAsE,EAAE,KAAK,IAAI,EAAE;QACpF,MAAM,OAAO,GAAG,iBAAiB,EAAE,CAAC;QACpC,KAAK,0BAA0B,CAAS;YACtC,OAAO,EAAE,OAAO,CAAC,OAAO;YACxB,WAAW,EAAE,OAAO,CAAC,IAAI;YACzB,OAAO,EAAE,mBAAmB;YAC5B,OAAO,EAAE,gBAAgB;YACzB,MAAM,EAAE,WAAW;YACnB,MAAM,EAAE,GAAG,EAAE,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,WAAW,CAAC,gCAAgC,CAAC,CAAC;YAC/E,SAAS,EAAE,EAAE;SACd,CAAC,CAAC;QACH,MAAM,OAAO,CAAC,KAAK,CAAC;QAEpB,MAAM,CAAC,MAAM,OAAO,CAAC,MAAM,CAAC,EAAE,QAAQ,EAAE,UAAU,EAAE,YAAY,EAAE,UAAU,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC;YACvF,OAAO,EAAE,gCAAgC;SAC1C,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,6DAA6D,EAAE,KAAK,IAAI,EAAE;QAC3E,MAAM,OAAO,GAAG,iBAAiB,EAAE,CAAC;QACpC,IAAI,WAAW,GAAG,CAAC,CAAC;QACpB,KAAK,0BAA0B,CAAS;YACtC,OAAO,EAAE,OAAO,CAAC,OAAO;YACxB,WAAW,EAAE,OAAO,CAAC,IAAI;YACzB,OAAO,EAAE,mBAAmB;YAC5B,OAAO,EAAE,gBAAgB;YACzB,MAAM,EAAE,WAAW;YACnB,MAAM,EAAE,GAAG,EAAE;gBACX,WAAW,EAAE,CAAC;gBACd,OAAO,OAAO,CAAC,OAAO,CAAC,EAAE,QAAQ,EAAE,OAAO,EAAE,CAAC,CAAC;YAChD,CAAC;YACD,SAAS,EAAE,EAAE;SACd,CAAC,CAAC;QACH,MAAM,OAAO,CAAC,KAAK,CAAC;QAEpB,MAAM,CAAC,MAAM,OAAO,CAAC,MAAM,CAAC,EAAE,QAAQ,EAAE,MAAM,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC;YACzD,OAAO,EAAE,6BAA6B;SACvC,CAAC,CAAC;QACH,MAAM,CAAC,WAAW,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IAC9B,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,2CAA2C,EAAE,KAAK,IAAI,EAAE;QACzD,MAAM,OAAO,GAAG,iBAAiB,EAAE,CAAC;QACpC,MAAM,OAAO,GAAG,0BAA0B,CAAS;YACjD,OAAO,EAAE,OAAO,CAAC,OAAO;YACxB,WAAW,EAAE,OAAO,CAAC,IAAI;YACzB,OAAO,EAAE,mBAAmB;YAC5B,OAAO,EAAE,gBAAgB;YACzB,MAAM,EAAE,WAAW;YACnB,MAAM,EAAE,GAAG,EAAE,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,QAAQ,EAAE,OAAO,EAAE,CAAC;YACpD,SAAS,EAAE,QAAQ;SACpB,CAAC,CAAC;QACH,MAAM,OAAO,CAAC,KAAK,CAAC;QAEpB,OAAO,CAAC,YAAY,EAAE,CAAC;QACvB,MAAM,MAAM,CAAC,OAAO,CAAC,CAAC,QAAQ,CAAC,QAAQ,EAAE,CAAC;IAC5C,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,qCAAqC,EAAE,KAAK,IAAI,EAAE;QACnD,MAAM,OAAO,GAAG,iBAAiB,EAAE,CAAC;QACpC,MAAM,OAAO,GAAG,0BAA0B,CAAS;YACjD,OAAO,EAAE,OAAO,CAAC,OAAO;YACxB,WAAW,EAAE,OAAO,CAAC,IAAI;YACzB,OAAO,EAAE,mBAAmB;YAC5B,OAAO,EAAE,gBAAgB;YACzB,MAAM,EAAE,WAAW;YACnB,MAAM,EAAE,GAAG,EAAE,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,QAAQ,EAAE,OAAO,EAAE,CAAC;YACpD,SAAS,EAAE,EAAE;SACd,CAAC,CAAC;QACH,MAAM,MAAM,CAAC,OAAO,CAAC,CAAC,QAAQ,CAAC,QAAQ,EAAE,CAAC;IAC5C,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC;AAEH;;;;GAIG;AACH,QAAQ,CAAC,gCAAgC,EAAE,GAAG,EAAE;IAC9C,MAAM,eAAe,GAAG,yDAAyD,CAAC;IAClF,MAAM,eAAe,GAAG,gDAAgD,CAAC;IAEzE,EAAE,CAAC,kDAAkD,EAAE,KAAK,IAAI,EAAE;QAChE,MAAM,OAAO,GAAG,iBAAiB,EAAE,CAAC;QACpC,KAAK,0BAA0B,CAAS;YACtC,OAAO,EAAE,OAAO,CAAC,OAAO;YACxB,WAAW,EAAE,OAAO,CAAC,IAAI;YACzB,OAAO,EAAE,eAAe;YACxB,OAAO,EAAE,eAAe;YACxB,MAAM,EAAE,CAAC,EAAE,IAAI,EAAE,UAAU,EAAE,KAAK,EAAE,aAAa,EAAE,IAAI,EAAE,oBAAoB,EAAE,CAAC;YAChF,MAAM,EAAE,GAAG,EAAE,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,QAAQ,EAAE,OAAO,EAAE,CAAC;YACpD,SAAS,EAAE,EAAE;SACd,CAAC,CAAC;QACH,MAAM,OAAO,CAAC,KAAK,CAAC;QAEpB,MAAM,MAAM,GAAG,OAAO,CAAC,iBAAiB,EAAE,CAAC;QAC3C,MAAM,CAAC,GAAG,EAAE,CAAC,IAAI,EAAE,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,GAAG,CAAC,OAAO,EAAE,CAAC;QAClD,MAAM,CAAC,MAAM,CAAC,CAAC,SAAS,CAAC,aAAa,CAAC,CAAC;QACxC,MAAM,CAAC,MAAM,CAAC,CAAC,SAAS,CAAC,UAAU,CAAC,CAAC;QACrC,MAAM,CAAC,MAAM,CAAC,CAAC,SAAS,CAAC,6BAA6B,CAAC,CAAC;IAC1D,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC;AAEH,QAAQ,CAAC,gCAAgC,EAAE,GAAG,EAAE;IAC9C,EAAE,CAAC,kCAAkC,EAAE,GAAG,EAAE;QAC1C,MAAM,MAAM,GAAG,8BAA8B,CAC3C,EAAE,QAAQ,EAAE,MAAM,EAAE,YAAY,EAAE,UAAU,EAAE,EAC9C,WAAW,CACZ,CAAC;QACF,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,UAAU,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QAC7C,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,cAAc,CAAC,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;IACvD,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,mDAAmD,EAAE,GAAG,EAAE;QAC3D,MAAM,CAAC,8BAA8B,CAAC,EAAE,QAAQ,EAAE,MAAM,EAAE,EAAE,WAAW,CAAC,CAAC,CAAC,QAAQ,EAAE,CAAC;QACrF,MAAM,CACJ,8BAA8B,CAAC,EAAE,QAAQ,EAAE,MAAM,EAAE,YAAY,EAAE,EAAE,EAAE,EAAE,WAAW,CAAC,CACpF,CAAC,QAAQ,EAAE,CAAC;IACf,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,8CAA8C,EAAE,GAAG,EAAE;QACtD,MAAM,CAAC,8BAA8B,CAAC,OAAO,EAAE,WAAW,CAAC,CAAC,CAAC,QAAQ,EAAE,CAAC;QACxE,MAAM,CAAC,8BAA8B,CAAC,IAAI,EAAE,WAAW,CAAC,CAAC,CAAC,QAAQ,EAAE,CAAC;IACvE,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC;AAEH,QAAQ,CAAC,sBAAsB,EAAE,GAAG,EAAE;IACpC,EAAE,CAAC,gDAAgD,EAAE,GAAG,EAAE;QACxD,MAAM,MAAM,GAAG,IAAI,oBAAoB,CAAC,IAAI,GAAG,CAAC,CAAC,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC;QACvE,MAAM,CAAC,GAAG,EAAE,CAAC,MAAM,CAAC,GAAG,CAAC,eAAe,CAAC,CAAC,CAAC,OAAO,CAAC,+BAA+B,CAAC,CAAC;IACrF,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}

package/dist/tests/manualCredentialForms.test.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Every browser-automated service should be able to fall back on asking the
+ * user for the credentials, so these tests go over the whole registry rather
+ * than a single service: the forms are declarative, so they can be checked
+ * without a browser.
+ */
+export {};
+//# sourceMappingURL=manualCredentialForms.test.d.ts.map

package/dist/tests/manualCredentialForms.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"manualCredentialForms.test.d.ts","sourceRoot":"","sources":["../../tests/manualCredentialForms.test.ts"],"names":[],"mappings":"AAAA;;;;;GAKG"}

package/dist/tests/manualCredentialForms.test.js

@@ -0,0 +1,64 @@
+/**
+ * Every browser-automated service should be able to fall back on asking the
+ * user for the credentials, so these tests go over the whole registry rather
+ * than a single service: the forms are declarative, so they can be checked
+ * without a browser.
+ */
+import { describe, it, expect } from 'vitest';
+import { SERVICE_REGISTRY } from '../src/serviceRegistry.js';
+import { BrowserFollowupServiceSession, } from '../src/services/core/base.js';
+import { CredentialFormValues } from '../src/playwrightUtils.js';
+/**
+ * Services whose login ends in an OAuth exchange (an authorization code
+ * redeemed for access and refresh tokens against an app latchkey created), so
+ * there is no value the user could produce by hand and paste back. Asking them
+ * for one would be asking for something that does not exist.
+ */
+const SERVICES_WITHOUT_A_PASTEABLE_CREDENTIAL = ['dropbox'];
+function isOAuthOnlyService(service) {
+    return (SERVICES_WITHOUT_A_PASTEABLE_CREDENTIAL.includes(service.name) ||
+        // Google's services all share one flow: latchkey prepares an OAuth client,
+        // then trades a consent for tokens.
+        service.name === 'google' ||
+        service.name.startsWith('google-'));
+}
+const BROWSER_FOLLOWUP_SESSIONS = SERVICE_REGISTRY.services
+    .map((service) => ({ service, session: service.getSession?.('latchkey') }))
+    .filter((candidate) => candidate.session instanceof BrowserFollowupServiceSession);
+function formsWithService() {
+    return BROWSER_FOLLOWUP_SESSIONS.flatMap(({ service, session }) => session.manualCredentialForm === undefined
+        ? []
+        : [{ service, form: session.manualCredentialForm }]);
+}
+describe('manual credential forms', () => {
+    it('finds the browser-automated services to check', () => {
+        expect(BROWSER_FOLLOWUP_SESSIONS.length).toBeGreaterThan(5);
+    });
+    it.each(BROWSER_FOLLOWUP_SESSIONS.filter(({ service }) => !isOAuthOnlyService(service)).map(({ service, session }) => ({ name: service.name, session })))('$name offers a form for finishing the login by hand', ({ session }) => {
+        expect(session.manualCredentialForm).toBeDefined();
+    });
+    it.each(formsWithService().map(({ service, form }) => ({
+        name: service.name,
+        displayName: service.displayName,
+        form,
+    })))('$name asks for its credentials in a usable way', ({ displayName, form }) => {
+        expect(form.instructions.length).toBeGreaterThan(30);
+        expect(form.fields.length).toBeGreaterThan(0);
+        const fieldNames = form.fields.map((field) => field.name);
+        expect(new Set(fieldNames).size).toBe(fieldNames.length);
+        for (const field of form.fields) {
+            expect(field.name).not.toBe('');
+            expect(field.label).not.toBe('');
+        }
+        // The builder has to agree with the field names, which is the mistake this
+        // catches: reading a field the form never asked for throws.
+        const values = new CredentialFormValues(new Map(fieldNames.map((fieldName) => [fieldName, `pasted-${fieldName}`])));
+        const credentials = form.buildCredentials(values);
+        expect(credentials.objectType).not.toBe('');
+        // The instructions name the service the user is being sent to, so the page
+        // does not read as if it came from nowhere.
+        const firstWordOfDisplayName = displayName.split(' ')[0] ?? displayName;
+        expect(form.instructions.toLowerCase()).toContain(firstWordOfDisplayName.toLowerCase());
+    });
+});
+//# sourceMappingURL=manualCredentialForms.test.js.map

package/dist/tests/manualCredentialForms.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"manualCredentialForms.test.js","sourceRoot":"","sources":["../../tests/manualCredentialForms.test.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,EAAE,QAAQ,EAAE,EAAE,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAC;AAC9C,OAAO,EAAE,gBAAgB,EAAE,MAAM,2BAA2B,CAAC;AAC7D,OAAO,EACL,6BAA6B,GAG9B,MAAM,8BAA8B,CAAC;AACtC,OAAO,EAAE,oBAAoB,EAAE,MAAM,2BAA2B,CAAC;AAEjE;;;;;GAKG;AACH,MAAM,uCAAuC,GAAG,CAAC,SAAS,CAAC,CAAC;AAE5D,SAAS,kBAAkB,CAAC,OAAgB;IAC1C,OAAO,CACL,uCAAuC,CAAC,QAAQ,CAAC,OAAO,CAAC,IAAI,CAAC;QAC9D,2EAA2E;QAC3E,oCAAoC;QACpC,OAAO,CAAC,IAAI,KAAK,QAAQ;QACzB,OAAO,CAAC,IAAI,CAAC,UAAU,CAAC,SAAS,CAAC,CACnC,CAAC;AACJ,CAAC;AAOD,MAAM,yBAAyB,GAA4B,gBAAgB,CAAC,QAAQ;KACjF,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC,EAAE,OAAO,EAAE,OAAO,EAAE,OAAO,CAAC,UAAU,EAAE,CAAC,UAAU,CAAC,EAAE,CAAC,CAAC;KAC1E,MAAM,CACL,CAAC,SAAS,EAA6B,EAAE,CACvC,SAAS,CAAC,OAAO,YAAY,6BAA6B,CAC7D,CAAC;AAEJ,SAAS,gBAAgB;IACvB,OAAO,yBAAyB,CAAC,OAAO,CAAC,CAAC,EAAE,OAAO,EAAE,OAAO,EAAE,EAAE,EAAE,CAChE,OAAO,CAAC,oBAAoB,KAAK,SAAS;QACxC,CAAC,CAAC,EAAE;QACJ,CAAC,CAAC,CAAC,EAAE,OAAO,EAAE,IAAI,EAAE,OAAO,CAAC,oBAAoB,EAAE,CAAC,CACtD,CAAC;AACJ,CAAC;AAED,QAAQ,CAAC,yBAAyB,EAAE,GAAG,EAAE;IACvC,EAAE,CAAC,+CAA+C,EAAE,GAAG,EAAE;QACvD,MAAM,CAAC,yBAAyB,CAAC,MAAM,CAAC,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC;IAC9D,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,IAAI,CACL,yBAAyB,CAAC,MAAM,CAAC,CAAC,EAAE,OAAO,EAAE,EAAE,EAAE,CAAC,CAAC,kBAAkB,CAAC,OAAO,CAAC,CAAC,CAAC,GAAG,CACjF,CAAC,EAAE,OAAO,EAAE,OAAO,EAAE,EAAE,EAAE,CAAC,CAAC,EAAE,IAAI,EAAE,OAAO,CAAC,IAAI,EAAE,OAAO,EAAE,CAAC,CAC5D,CACF,CAAC,qDAAqD,EAAE,CAAC,EAAE,OAAO,EAAE,EAAE,EAAE;QACvE,MAAM,CAAC,OAAO,CAAC,oBAAoB,CAAC,CAAC,WAAW,EAAE,CAAC;IACrD,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,IAAI,CACL,gBAAgB,EAAE,CAAC,GAAG,CAAC,CAAC,EAAE,OAAO,EAAE,IAAI,EAAE,EAAE,EAAE,CAAC,CAAC;QAC7C,IAAI,EAAE,OAAO,CAAC,IAAI;QAClB,WAAW,EAAE,OAAO,CAAC,WAAW;QAChC,IAAI;KACL,CAAC,CAAC,CACJ,CAAC,gDAAgD,EAAE,CAAC,EAAE,WAAW,EAAE,IAAI,EAAE,EAAE,EAAE;QAC5E,MAAM,CAAC,IAAI,CAAC,YAAY,CAAC,MAAM,CAAC,CAAC,eAAe,CAAC,EAAE,CAAC,CAAC;QACrD,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC;QAE9C,MAAM,UAAU,GAAG,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;QAC1D,MAAM,CAAC,IAAI,GAAG,CAAC,UAAU,CAAC,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC;QACzD,KAAK,MAAM,KAAK,IAAI,IAAI,CAAC,MAAM,EAAE,CAAC;YAChC,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;YAChC,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QACnC,CAAC;QAED,2EAA2E;QAC3E,4DAA4D;QAC5D,MAAM,MAAM,GAAG,IAAI,oBAAoB,CACrC,IAAI,GAAG,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,SAAS,EAAE,EAAE,CAAC,CAAC,SAAS,EAAE,UAAU,SAAS,EAAE,CAAC,CAAC,CAAC,CAC3E,CAAC;QACF,MAAM,WAAW,GAAG,IAAI,CAAC,gBAAgB,CAAC,MAAM,CAAC,CAAC;QAClD,MAAM,CAAC,WAAW,CAAC,UAAU,CAAC,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QAE5C,2EAA2E;QAC3E,4CAA4C;QAC5C,MAAM,sBAAsB,GAAG,WAAW,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,WAAW,CAAC;QACxE,MAAM,CAAC,IAAI,CAAC,YAAY,CAAC,WAAW,EAAE,CAAC,CAAC,SAAS,CAAC,sBAAsB,CAAC,WAAW,EAAE,CAAC,CAAC;IAC1F,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "latchkey",
-  "version": "3.7.0",
+  "version": "3.8.0",
   "description": "A CLI tool that injects API credentials into curl requests to third-party services",
   "author": "Imbue <hynek@imbue.com>",
   "repository": {