@internetarchive/recaptcha-manager 2.0.0 → 2.0.1

package/.claude/worktrees/recaptcha-google-url-hardcode-79a528/test/recaptcha-manager.test.ts

@@ -0,0 +1,201 @@
+import { expect } from '@open-wc/testing';
+import { MockGrecaptcha } from './mock-grecaptcha';
+import { RecaptchaManager } from '../src/recaptcha-manager';
+import { MockLazyLoaderService } from './mock-lazy-loader';
+
+const mockLazyLoader = new MockLazyLoaderService();
+
+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('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('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 () => {
+      // Mock lazy loader that mimics the grecaptcha script calling the callback on load
+      const mockLazyLoaderWithCallback = new MockLazyLoaderService(() => {
+        window.grecaptcha = new MockGrecaptcha({
+          mode: 'success',
+        });
+        // eslint-disable-next-line @typescript-eslint/no-explicit-any
+        (window as any).grecaptchaLoadedCallback();
+      });
+
+      const recaptchaManager = new RecaptchaManager({
+        lazyLoader: mockLazyLoaderWithCallback,
+        defaultSiteKey: '123',
+        timeout: 100,
+      });
+
+      await recaptchaManager.getRecaptchaWidget();
+      const loadUrl = mockLazyLoaderWithCallback.loadScriptSrc;
+      expect(
+        loadUrl?.includes(
+          'https://www.recaptcha.net/recaptcha/api.js?onload=grecaptchaLoadedCallback',
+        ),
+      ).to.be.true;
+    });
+
+    it('rejects after specified timeout if grecaptcha fails to execute callback', async () => {
+      const recaptchaManager = new RecaptchaManager({
+        lazyLoader: mockLazyLoader,
+        defaultSiteKey: '123',
+        timeout: 100,
+      });
+
+      try {
+        await recaptchaManager.getRecaptchaWidget();
+        expect.fail('recaptcha load did not time out as expected');
+      } catch (err) {
+        expect(err).to.be.instanceOf(Error);
+        expect((err as Error).message).to.equal(
+          'grecaptcha failed to execute callback',
+        );
+      }
+    });
+
+    it('can set the timeout delay', async () => {
+      const recaptchaManager = new RecaptchaManager({
+        lazyLoader: mockLazyLoader,
+        defaultSiteKey: '123',
+      });
+
+      recaptchaManager.setTimeoutDelay(1);
+
+      try {
+        await recaptchaManager.getRecaptchaWidget();
+        expect.fail('recaptcha load did not time out as expected');
+      } catch (err) {
+        expect(err).to.be.instanceOf(Error);
+        expect((err as Error).message).to.equal(
+          'grecaptcha failed to execute callback',
+        );
+      }
+    });
+  });
+
+  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);
+    });
+  });
+});

package/.claude/worktrees/recaptcha-google-url-hardcode-79a528/tsconfig.json

@@ -0,0 +1,31 @@
+{
+  "compilerOptions": {
+    "target": "es2018",
+    "module": "esnext",
+    "moduleResolution": "node",
+    "noEmitOnError": true,
+    "lib": ["es2017", "dom"],
+    "strict": true,
+    "esModuleInterop": false,
+    "allowSyntheticDefaultImports": true,
+    "experimentalDecorators": true,
+    "importHelpers": true,
+    "outDir": "dist",
+    "sourceMap": true,
+    "inlineSources": true,
+    "rootDir": "./",
+    "declaration": true,
+    "plugins": [
+      {
+        "name": "ts-lit-plugin"
+      }
+    ],
+    "paths": {
+      // workaround for: https://github.com/vitest-dev/vitest/issues/4567
+      "rollup/parseAst": [
+        "./node_modules/rollup/dist/parseAst"
+    ]
+}
+  },
+  "include": ["**/*.ts"]
+}

package/.claude/worktrees/recaptcha-google-url-hardcode-79a528/vite.config.ts

@@ -0,0 +1,25 @@
+import { defineConfig } from 'vite';
+import { resolve } from 'path';
+
+// https://vitejs.dev/config/
+export default defineConfig({
+  base: './',
+  root: resolve(__dirname, './demo'),
+  build: {
+    /**
+     * This is the directory where the built files will be placed
+     * that we upload to GitHub Pages.
+     */
+    outDir: '../ghpages/demo',
+    emptyOutDir: true,
+    manifest: true,
+    rollupOptions: {
+      input: {
+        main: resolve(__dirname, 'demo/index.html'),
+      },
+      output: {
+        entryFileNames: 'app-root.js',
+      },
+    },
+  },
+});

package/.claude/worktrees/recaptcha-google-url-hardcode-79a528/web-dev-server.config.mjs

@@ -0,0 +1,32 @@
+// import { hmrPlugin, presets } from '@open-wc/dev-server-hmr';
+
+/** Use Hot Module replacement by adding --hmr to the start command */
+const hmr = process.argv.includes('--hmr');
+
+export default /** @type {import('@web/dev-server').DevServerConfig} */ ({
+  nodeResolve: true,
+  open: '/demo',
+  watch: !hmr,
+  sslCert: './ssl/server.crt',
+  sslKey: './ssl/server.key',
+  hostname: 'local.archive.org',
+  http2: true,
+
+  /** Compile JS for older browsers. Requires @web/dev-server-esbuild plugin */
+  // esbuildTarget: 'auto'
+
+  /** Set appIndex to enable SPA routing */
+  // appIndex: 'demo/index.html',
+
+  /** Configure bare import resolve plugin */
+  // nodeResolve: {
+  //   exportConditions: ['browser', 'development']
+  // },
+
+  plugins: [
+    /** Use Hot Module Replacement by uncommenting. Requires @open-wc/dev-server-hmr plugin */
+    // hmr && hmrPlugin({ exclude: ['**/*/node_modules/**/*'], presets: [presets.litElement] }),
+  ],
+
+  // See documentation for all available options
+});

package/.claude/worktrees/recaptcha-google-url-hardcode-79a528/web-test-runner.config.mjs

@@ -0,0 +1,41 @@
+// import { playwrightLauncher } from '@web/test-runner-playwright';
+
+const filteredLogs = ['Running in dev mode', 'lit-html is in dev mode'];
+
+export default /** @type {import("@web/test-runner").TestRunnerConfig} */ ({
+  /** Test files to run */
+  files: 'dist/test/**/*.test.js',
+
+  /** Resolve bare module imports */
+  nodeResolve: {
+    exportConditions: ['browser', 'development'],
+  },
+
+  /** Filter out lit dev mode logs */
+  filterBrowserLogs(log) {
+    for (const arg of log.args) {
+      if (typeof arg === 'string' && filteredLogs.some(l => arg.includes(l))) {
+        return false;
+      }
+    }
+    return true;
+  },
+
+  /** Compile JS for older browsers. Requires @web/dev-server-esbuild plugin */
+  // esbuildTarget: 'auto',
+
+  /** Amount of browsers to run concurrently */
+  // concurrentBrowsers: 2,
+
+  /** Amount of test files per browser to test concurrently */
+  // concurrency: 1,
+
+  /** Browsers to run tests on */
+  // browsers: [
+  //   playwrightLauncher({ product: 'chromium' }),
+  //   playwrightLauncher({ product: 'firefox' }),
+  //   playwrightLauncher({ product: 'webkit' }),
+  // ],
+
+  // See documentation for all available options
+});

package/.editorconfig

@@ -1,29 +1,29 @@
-# EditorConfig helps developers define and maintain consistent
-# coding styles between different editors and IDEs
-# editorconfig.org
-
-root = true
-
-
-[*]
-
-# Change these settings to your own preference
-indent_style = space
-indent_size = 2
-
-# We recommend you to keep these unchanged
-end_of_line = lf
-charset = utf-8
-trim_trailing_whitespace = true
-insert_final_newline = true
-
-[*.md]
-trim_trailing_whitespace = false
-
-[*.json]
-indent_size = 2
-
-[*.{html,js,md}]
-block_comment_start = /**
-block_comment = *
-block_comment_end = */
+# EditorConfig helps developers define and maintain consistent
+# coding styles between different editors and IDEs
+# editorconfig.org
+
+root = true
+
+
+[*]
+
+# Change these settings to your own preference
+indent_style = space
+indent_size = 2
+
+# We recommend you to keep these unchanged
+end_of_line = lf
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true
+
+[*.md]
+trim_trailing_whitespace = false
+
+[*.json]
+indent_size = 2
+
+[*.{html,js,md}]
+block_comment_start = /**
+block_comment = *
+block_comment_end = */

package/.github/workflows/ci.yml

@@ -1,27 +1,27 @@
-name: App CI
-
-on:
-  push:
-    branches: [ main ]
-  pull_request:
-    branches: [ main ]
-
-jobs:
-  build:
-    runs-on: ubuntu-latest
-
-    steps:
-    - uses: actions/checkout@v4
-    - uses: actions/setup-node@v4
-      with:
-        node-version: latest
-
-    - name: Install dependencies
-      run: npm install
-
-    - name: Run tests
-      run: npm run test
-
-    - uses: codecov/codecov-action@v5
-      with:
-        token: ${{ secrets.CODECOV_TOKEN }}
+name: App CI
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v4
+    - uses: actions/setup-node@v4
+      with:
+        node-version: latest
+
+    - name: Install dependencies
+      run: npm install
+
+    - name: Run tests
+      run: npm run test
+
+    - uses: codecov/codecov-action@v5
+      with:
+        token: ${{ secrets.CODECOV_TOKEN }}

package/.github/workflows/gh-pages-main.yml

@@ -1,39 +1,39 @@
-# This workflow will generate the static page under `main` subdirectory inside the `gh-pages` branch
-
-# This workflow will run every time new changes were pushed to the `main` branch
-
-name: App build CI/CD to main branch
-
-on:
-  push:
-    branches: [ main ]
-
-jobs:
-  build:
-    runs-on: ubuntu-latest
-
-    steps:
-      - uses: actions/checkout@v4
-        with:
-          persist-credentials: false
-      - uses: actions/setup-node@v4
-        with:
-          node-version: latest
-
-
-      - name: Install dependencies
-        run: npm install
-
-      - name: Create build files for gh-pages deploy
-        run: npm run ghpages:build
-
-      # Reference: https://github.com/JamesIves/github-pages-deploy-action
-      - name: Deploy 🚀
-        uses: JamesIves/github-pages-deploy-action@v4.5.0
-        with:
-          branch: gh-pages
-          folder: ghpages
-          clean-exclude: pr/
-          force: false
-          target-folder: main
-          token: ${{ secrets.GH_TOKEN }}
+# This workflow will generate the static page under `main` subdirectory inside the `gh-pages` branch
+
+# This workflow will run every time new changes were pushed to the `main` branch
+
+name: App build CI/CD to main branch
+
+on:
+  push:
+    branches: [ main ]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          persist-credentials: false
+      - uses: actions/setup-node@v4
+        with:
+          node-version: latest
+
+
+      - name: Install dependencies
+        run: npm install
+
+      - name: Create build files for gh-pages deploy
+        run: npm run ghpages:build
+
+      # Reference: https://github.com/JamesIves/github-pages-deploy-action
+      - name: Deploy 🚀
+        uses: JamesIves/github-pages-deploy-action@v4.5.0
+        with:
+          branch: gh-pages
+          folder: ghpages
+          clean-exclude: pr/
+          force: false
+          target-folder: main
+          token: ${{ secrets.GH_TOKEN }}

package/.github/workflows/pr-preview.yml

@@ -1,63 +1,63 @@
-# This workflow will generate the static page under `pr` subdirectory inside the `gh-pages` branch
-
-# This workflow will run every time there's a PR opened, reopened, synchronize, or closed
-
-name: Deploy PR previews
-
-on:
-  pull_request:
-    types:
-      - opened
-      - reopened
-      - synchronize
-      - closed
-
-concurrency: preview-${{ github.ref }}
-
-env:
-  PREVIEW_BRANCH: gh-pages
-jobs:
-  deploy-preview:
-    runs-on: ubuntu-latest
-    steps:
-      - name: Checkout
-        uses: actions/checkout@v4
-      - uses: actions/setup-node@v4
-        with:
-          node-version: latest
-
-
-      - name: Install and Build
-        run: |
-          npm install
-          npm run ghpages:build
-
-      # Reference: https://github.com/rossjrw/pr-preview-action
-      - name: Deploy preview
-        uses: rossjrw/pr-preview-action@v1
-        id: preview-step
-        with:
-          source-dir: ./ghpages/
-          umbrella-dir: pr
-          preview-branch: ${{ env.PREVIEW_BRANCH }}
-          comment: false
-
-      - uses: marocchino/sticky-pull-request-comment@v2
-        if: steps.preview-step.outputs.deployment-action == 'deploy'
-        with:
-          header: pr-preview
-          message: |
-            [PR Preview Action](https://github.com/rossjrw/pr-preview-action) ${{ steps.preview-step.outputs.action-version }}
-            :---:
-            | <p></p> :rocket: View preview at <br> ${{ steps.preview-step.outputs.preview-url }}demo/ <br><br>
-            | <h6>Built to branch [`${{ env.PREVIEW_BRANCH }}`](${{ github.server_url }}/${{ github.repository }}/tree/${{ env.PREVIEW_BRANCH }}) at ${{ steps.preview-step.outputs.action-start-time }}. <br> Preview will be ready when the [GitHub Pages deployment](${{ github.server_url }}/${{ github.repository }}/deployments) is complete. <br><br> </h6>
-
-      - uses: marocchino/sticky-pull-request-comment@v2
-        if: steps.preview-step.outputs.deployment-action == 'remove'
-        with:
-          header: pr-preview
-          message: |
-            [PR Preview Action](https://github.com/rossjrw/pr-preview-action) ${{ steps.preview-step.outputs.action-version }}
-            :---:
-            Preview removed because the pull request was closed.
-            ${{ steps.preview-step.outputs.action-start-time }}
+# This workflow will generate the static page under `pr` subdirectory inside the `gh-pages` branch
+
+# This workflow will run every time there's a PR opened, reopened, synchronize, or closed
+
+name: Deploy PR previews
+
+on:
+  pull_request:
+    types:
+      - opened
+      - reopened
+      - synchronize
+      - closed
+
+concurrency: preview-${{ github.ref }}
+
+env:
+  PREVIEW_BRANCH: gh-pages
+jobs:
+  deploy-preview:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
+        with:
+          node-version: latest
+
+
+      - name: Install and Build
+        run: |
+          npm install
+          npm run ghpages:build
+
+      # Reference: https://github.com/rossjrw/pr-preview-action
+      - name: Deploy preview
+        uses: rossjrw/pr-preview-action@v1
+        id: preview-step
+        with:
+          source-dir: ./ghpages/
+          umbrella-dir: pr
+          preview-branch: ${{ env.PREVIEW_BRANCH }}
+          comment: false
+
+      - uses: marocchino/sticky-pull-request-comment@v2
+        if: steps.preview-step.outputs.deployment-action == 'deploy'
+        with:
+          header: pr-preview
+          message: |
+            [PR Preview Action](https://github.com/rossjrw/pr-preview-action) ${{ steps.preview-step.outputs.action-version }}
+            :---:
+            | <p></p> :rocket: View preview at <br> ${{ steps.preview-step.outputs.preview-url }}demo/ <br><br>
+            | <h6>Built to branch [`${{ env.PREVIEW_BRANCH }}`](${{ github.server_url }}/${{ github.repository }}/tree/${{ env.PREVIEW_BRANCH }}) at ${{ steps.preview-step.outputs.action-start-time }}. <br> Preview will be ready when the [GitHub Pages deployment](${{ github.server_url }}/${{ github.repository }}/deployments) is complete. <br><br> </h6>
+
+      - uses: marocchino/sticky-pull-request-comment@v2
+        if: steps.preview-step.outputs.deployment-action == 'remove'
+        with:
+          header: pr-preview
+          message: |
+            [PR Preview Action](https://github.com/rossjrw/pr-preview-action) ${{ steps.preview-step.outputs.action-version }}
+            :---:
+            Preview removed because the pull request was closed.
+            ${{ steps.preview-step.outputs.action-start-time }}

package/.husky/pre-commit

@@ -1 +1 @@
-npx lint-staged
+npx lint-staged

package/.prettierignore

@@ -1 +1 @@
-coverage
+coverage