@internetarchive/recaptcha-manager 0.0.1-alpha.3 → 0.1.1

package/test/mock-lazy-loader.ts

@@ -0,0 +1,38 @@
+/* eslint-disable @typescript-eslint/no-unused-vars */
+import {
+  BundleType,
+  LazyLoaderServiceEvents,
+  LazyLoaderServiceInterface,
+} from '@internetarchive/lazy-loader-service';
+import { Unsubscribe } from 'nanoevents';
+import { MockGrecaptcha } from './mock-grecaptcha';
+
+export class MockLazyLoaderService implements LazyLoaderServiceInterface {
+  loadScriptSrc?: string;
+
+  on<E extends keyof LazyLoaderServiceEvents>(
+    event: E,
+    callback: LazyLoaderServiceEvents[E]
+  ): Unsubscribe {
+    throw new Error('Method not implemented.');
+  }
+
+  async loadBundle(bundle: {
+    module?: string;
+    nomodule?: string;
+  }): Promise<void> {
+    console.debug('loadBundle', bundle);
+  }
+
+  async loadScript(options: {
+    src: string;
+    bundleType?: BundleType;
+    attributes?: Record<string, string>;
+  }): Promise<void> {
+    this.loadScriptSrc = options.src;
+    window.grecaptcha = new MockGrecaptcha({
+      mode: 'success',
+    });
+    (window as any).grecaptchaLoadedCallback();
+  }
+}

package/test/recaptcha-manager.test.ts

@@ -1,71 +1,151 @@
-// import { html, fixture, expect } from '@open-wc/testing';
-// import { MockGrecaptcha, MockGrecaptchaMode } from './mock-grecaptcha';
-// import { RecaptchaManager } from '../src/recaptcha-manager';
+import { expect } from '@open-wc/testing';
+import { MockGrecaptcha } from './mock-grecaptcha';
+import { RecaptchaManager } from '../src/recaptcha-manager';
+import { MockLazyLoaderService } from './mock-lazy-loader';
 
-describe('ReCaptcha Manager', () => {
-  // it('can execute the recaptcha like a Promise', async () => {
-  //   const recaptchaElement = (await fixture(html`
-  //     <div></div>
-  //   `)) as HTMLElement;
-  //   const mockGrecaptcha = new MockGrecaptcha(MockGrecaptchaMode.Success);
-  //   const recaptchaManager = new RecaptchaManager({
-  //     grecaptchaLibrary: mockGrecaptcha,
-  //     siteKey: '123',
-  //   });
-  //   recaptchaManager.setup(recaptchaElement, 1, 'dark', 'image');
-  //   const result = await recaptchaManager.execute();
-  //   expect(result).to.equal('foo');
-  // });
+const mockLazyLoader = new MockLazyLoaderService();
 
-  // it('can error properly like a Promise', async () => {
-  //   const recaptchaElement = (await fixture(html`
-  //     <div></div>
-  //   `)) as HTMLElement;
-  //   const mockGrecaptcha = new MockGrecaptcha(MockGrecaptchaMode.Error);
-  //   const recaptchaManager = new RecaptchaManager({
-  //     grecaptchaLibrary: mockGrecaptcha,
-  //     siteKey: '123',
-  //   });
-  //   recaptchaManager.setup(recaptchaElement, 1, 'dark', 'image');
-  //   try {
-  //     await recaptchaManager.execute();
-  //     expect.fail('should not get here');
-  //   } catch (error) {
-  //     expect(error).to.equal('error');
-  //   }
-  // });
+describe('ReCaptcha Management', () => {
+  describe('ReCaptcha Manager', () => {
+    it('can return recaptchas', async () => {
+      const mockGrecaptcha = new MockGrecaptcha({
+        mode: 'success',
+      });
+      mockGrecaptcha.response = 'foo';
+      const recaptchaManager = new RecaptchaManager({
+        lazyLoader: mockLazyLoader,
+        grecaptchaLibrary: mockGrecaptcha,
+        defaultSiteKey: '123',
+      });
+      const recaptcha = await recaptchaManager.getRecaptchaWidget();
+      const result = await recaptcha.execute();
+      expect(result).to.equal('foo');
+    });
 
-  // it('can expire properly like a Promise', async () => {
-  //   const recaptchaElement = (await fixture(html`
-  //     <div></div>
-  //   `)) as HTMLElement;
-  //   const mockGrecaptcha = new MockGrecaptcha(MockGrecaptchaMode.Expired);
-  //   const recaptchaManager = new RecaptchaManager({
-  //     grecaptchaLibrary: mockGrecaptcha,
-  //     siteKey: '123',
-  //   });
-  //   recaptchaManager.setup(recaptchaElement, 1, 'dark', 'image');
-  //   try {
-  //     await recaptchaManager.execute();
-  //     expect.fail('should not get here');
-  //   } catch (error) {
-  //     expect(error).to.equal('expired');
-  //   }
-  // });
+    it('throws an error if no site key found', async () => {
+      const mockGrecaptcha = new MockGrecaptcha({
+        mode: 'success',
+      });
+      mockGrecaptcha.response = 'foo';
+      const recaptchaManager = new RecaptchaManager({
+        lazyLoader: mockLazyLoader,
+        grecaptchaLibrary: mockGrecaptcha,
+      });
+      try {
+        await recaptchaManager.getRecaptchaWidget();
+        expect.fail('should not get here');
+      } catch (e) {
+        expect((e as Error).message).to.equal(
+          'The reCaptcha widget requires a site key'
+        );
+      }
+    });
 
-  // it('resets the captcha if execute() gets called more than once', async () => {
-  //   const recaptchaElement = (await fixture(html`
-  //     <div></div>
-  //   `)) as HTMLElement;
-  //   const mockGrecaptcha = new MockGrecaptcha(MockGrecaptchaMode.Success, true);
-  //   const recaptchaManager = new RecaptchaManager({
-  //     grecaptchaLibrary: mockGrecaptcha,
-  //     siteKey: '123',
-  //   });
-  //   recaptchaManager.setup(recaptchaElement, 1, 'dark', 'image');
-  //   recaptchaManager.execute();
-  //   expect(mockGrecaptcha.resetCalled).to.be.false;
-  //   recaptchaManager.execute();
-  //   expect(mockGrecaptcha.resetCalled).to.be.true;
-  // });
+    it('returns a cached version if one already exists for a given site key', async () => {
+      const mockGrecaptcha = new MockGrecaptcha({
+        mode: 'success',
+      });
+      mockGrecaptcha.response = 'foo';
+      const recaptchaManager = new RecaptchaManager({
+        lazyLoader: mockLazyLoader,
+        grecaptchaLibrary: mockGrecaptcha,
+        defaultSiteKey: '123',
+      });
+      const recaptcha1 = await recaptchaManager.getRecaptchaWidget();
+      const recaptcha2 = await recaptchaManager.getRecaptchaWidget();
+      expect(recaptcha1).to.equal(recaptcha2);
+    });
+
+    it('loads the recaptcha library if needed', async () => {
+      const recaptchaManager = new RecaptchaManager({
+        lazyLoader: mockLazyLoader,
+        defaultSiteKey: '123',
+      });
+      await recaptchaManager.getRecaptchaWidget();
+      const loadUrl = mockLazyLoader.loadScriptSrc;
+      expect(
+        loadUrl?.includes('recaptcha/api.js?onload=grecaptchaLoadedCallback')
+      ).to.be.true;
+    });
+  });
+
+  describe('ReCaptcha Widget', () => {
+    it('can error properly like a Promise', async () => {
+      const mockGrecaptcha = new MockGrecaptcha({
+        mode: 'error',
+      });
+      const recaptchaManager = new RecaptchaManager({
+        lazyLoader: mockLazyLoader,
+        grecaptchaLibrary: mockGrecaptcha,
+        defaultSiteKey: '123',
+      });
+      const recaptcha = await recaptchaManager.getRecaptchaWidget();
+
+      try {
+        await recaptcha.execute();
+        expect.fail('should not get here');
+      } catch (error) {
+        expect((error as Error).message).to.equal('error');
+      }
+    });
+
+    it('can expire properly like a Promise', async () => {
+      const mockGrecaptcha = new MockGrecaptcha({
+        mode: 'expired',
+      });
+      const recaptchaManager = new RecaptchaManager({
+        lazyLoader: mockLazyLoader,
+        grecaptchaLibrary: mockGrecaptcha,
+        defaultSiteKey: '123',
+      });
+      const recaptcha = await recaptchaManager.getRecaptchaWidget();
+
+      try {
+        await recaptcha.execute();
+        expect.fail('should not get here');
+      } catch (error) {
+        expect((error as Error).message).to.equal('expired');
+      }
+    });
+
+    it('resets the captcha after execution', async () => {
+      const mockGrecaptcha = new MockGrecaptcha({
+        mode: 'success',
+        addDelay: true,
+      });
+      const recaptchaManager = new RecaptchaManager({
+        lazyLoader: mockLazyLoader,
+        grecaptchaLibrary: mockGrecaptcha,
+        defaultSiteKey: '123',
+      });
+      const recaptcha = await recaptchaManager.getRecaptchaWidget();
+
+      expect(mockGrecaptcha.resetCallCount).to.equal(0);
+      await recaptcha.execute();
+      expect(mockGrecaptcha.resetCallCount).to.equal(1);
+      await recaptcha.execute();
+      expect(mockGrecaptcha.resetCallCount).to.equal(2);
+    });
+
+    // there's no way to know if the user has dismissed the captcha so if another execution
+    // comes through while the captcha is still active, it will be reset
+    it('resets the captcha if another execution gets called', async () => {
+      const mockGrecaptcha = new MockGrecaptcha({
+        mode: 'success',
+        addDelay: true,
+      });
+      const recaptchaManager = new RecaptchaManager({
+        lazyLoader: mockLazyLoader,
+        grecaptchaLibrary: mockGrecaptcha,
+        defaultSiteKey: '123',
+      });
+      const recaptcha = await recaptchaManager.getRecaptchaWidget();
+
+      expect(mockGrecaptcha.resetCallCount).to.equal(0);
+      recaptcha.execute();
+      expect(mockGrecaptcha.resetCallCount).to.equal(0);
+      await recaptcha.execute();
+      expect(mockGrecaptcha.resetCallCount).to.equal(2);
+    });
+  });
 });