@dfinity/internet-identity-playwright 0.0.3 → 0.0.5

package/LICENSE

@@ -186,7 +186,7 @@
       same "printed page" as the copyright notice for easier
       identification within third-party archives.
 
-   Copyright 2021 DFINITY LLC.
+   Copyright 2024 DFINITY Foundation.
 
    Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.

package/README.md

@@ -74,6 +74,16 @@ testWithII('should sign-in with an existing new user', async ({page, iiPage}) =>
 });
 ```
 
+The plugin defaults to an Internet Identity sign-in flow that does not require captcha. If you wish to set up a test that requires this validation, you can pass the option `captcha` set to `true` when initializing a new user:
+
+```javascript
+testWithII('should sign-in with a new user when II requires a captcha', async ({page, iiPage}) => {
+  await page.goto('/');
+
+  await iiPage.signInWithNewIdentity({captcha: true});
+});
+```
+
 ### 3. Wait for Internet Identity (optional)
 
 You might encounter scenarios where you perform tests against a local replica started in parallel with your tests, commonly when automating the tests in a CI environment. The library also exposes a fixture that lets you wait for Internet Identity to be ready.
@@ -126,27 +136,35 @@ Make sure you have Docker installed on your machine ([Windows](https://docs.dock
 > [!NOTE]
 > For MacBooks with M processors, it is important to use Docker Desktop version 4.25.0 or later, ideally the latest available version.
 
-2. Install Juno CLI:
+2. Start the Demo Application:
+
+Navigate to the [demo](./demo) directory and start the application using Docker:
 
 ```bash
-npm i -g @junobuild/cli
+cd demo
+docker compose up
 ```
 
-3. Start the Demo Application:
+4. Run the Tests:
 
-Navigate to the [demo](./demo) directory and start the application using the Juno CLI:
+Return to the root directory and execute the tests:
 
 ```bash
-cd demo
-juno dev start
+npm run e2e
 ```
 
-4. Run the Tests:
+### Running Captcha Tests Locally
 
-Return to the root directory and execute the tests:
+The default test suite validates the use of Internet Identity without captcha requirements. To test a flow with captcha, run the following command in the `demo` directory:
 
+```bash
+docker compose -f docker-compose.captcha.yml up
 ```
-npm run e2e
+
+Then, navigate to the root directory and run the dedicated test:
+
+```bash
+npm run e2e:captcha
 ```
 
 ## 🚧 Limitations
@@ -158,4 +176,4 @@ While it is technically possible to use local storage instead of IndexedDB, this
 ## 🧑‍🤝‍🧑 Community
 
 - [Forum](https://forum.dfinity.org/)
-- [Discord](https://discord.gg/E9FxceAg2j)
+- [Discord](https://discord.internetcomputer.org)

package/dist/index.js

@@ -1 +1 @@
-import{test as I}from"@playwright/test";import{expect as a}from"@playwright/test";var n=class{page;browser;context;constructor({page:i,context:o,browser:t}){this.page=i,this.browser=t,this.context=o}waitReady=async({url:i,canisterId:o,timeout:t=6e4})=>{let{host:e,protocol:c}=new URL(i),d=o!==void 0?this.browser.browserType().name()==="webkit"?`${c}//${e}?canisterId=${o}`:`${c}//${o}.${e.replace("127.0.0.1","localhost")}`:i,y=async()=>{try{return(await this.page.goto(d,{waitUntil:"domcontentloaded"}))?.ok()??!1}catch{return!1}},l=500,u=async({count:r})=>{if(await y())return"ready";let w=r-1;return w===0?"timeout":(await new Promise(m=>setTimeout(m,l)),await u({count:w}))},p=await u({count:t/l});a(p).toEqual("ready"),await a(this.page).toHaveTitle("Internet Identity");let g=this.page.locator("#registerButton");a(g).not.toBeNull()};signInWithNewIdentity=async i=>{let o=this.context.waitForEvent("page");await this.page.locator(i?.selector??"[data-tid=login-button]").click();let t=await o;await a(t).toHaveTitle("Internet Identity"),await t.locator("#registerButton").click(),await t.locator("[data-action=construct-identity]").click(),await t.locator("input#captchaInput").fill("a"),await t.locator("#confirmRegisterButton").click();let e=await t.locator("#userNumber").textContent();return a(e).not.toBeNull(),await t.locator("#displayUserContinue").click(),await t.waitForEvent("close"),a(t.isClosed()).toBe(!0),parseInt(e)};signInWithIdentity=async({selector:i,identity:o})=>{let t=this.context.waitForEvent("page");await this.page.locator(i??"[data-tid=login-button]").click();let e=await t;await a(e).toHaveTitle("Internet Identity"),await e.locator(`[data-anchor-id='${o}']`).click(),await e.waitForEvent("close"),a(e.isClosed()).toBe(!0)}};import{expect as $}from"@playwright/test";var v=I.extend({iiPage:async({page:s,browser:i,context:o},t)=>{let e=new n({page:s,context:o,browser:i});await t(e)}});export{n as InternetIdentityPage,$ as expect,v as testWithII};
+import{test as I}from"@playwright/test";import{expect as a}from"@playwright/test";var n=class{page;browser;context;constructor({page:o,context:i,browser:t}){this.page=o,this.browser=t,this.context=i}waitReady=async({url:o,canisterId:i,timeout:t=6e4})=>{let{host:e,protocol:c}=new URL(o),d=i!==void 0?this.browser.browserType().name()==="webkit"?`${c}//${e}?canisterId=${i}`:`${c}//${i}.${e.replace("127.0.0.1","localhost")}`:o,p=async()=>{try{return(await this.page.goto(d,{waitUntil:"domcontentloaded"}))?.ok()??!1}catch{return!1}},l=500,u=async({count:r})=>{if(await p())return"ready";let w=r-1;return w===0?"timeout":(await new Promise(m=>setTimeout(m,l)),await u({count:w}))},y=await u({count:t/l});a(y).toEqual("ready"),await a(this.page).toHaveTitle("Internet Identity");let g=this.page.locator("#registerButton");a(g).not.toBeNull()};signInWithNewIdentity=async o=>{let i=this.context.waitForEvent("page");await this.page.locator(o?.selector??"[data-tid=login-button]").click();let t=await i;await a(t).toHaveTitle("Internet Identity"),await t.locator("#registerButton").click(),await t.locator("[data-action=construct-identity]").click(),o?.captcha===!0&&(await t.locator("input#captchaInput").fill("a",{timeout:1e4}),await t.locator("#confirmRegisterButton").click());let e=await t.locator("#userNumber").textContent();return a(e).not.toBeNull(),await t.locator("#displayUserContinue").click(),await t.waitForEvent("close"),a(t.isClosed()).toBe(!0),parseInt(e)};signInWithIdentity=async({selector:o,identity:i})=>{let t=this.context.waitForEvent("page");await this.page.locator(o??"[data-tid=login-button]").click();let e=await t;await a(e).toHaveTitle("Internet Identity"),await e.locator(`[data-anchor-id='${i}']`).click(),await e.waitForEvent("close"),a(e.isClosed()).toBe(!0)}};import{expect as $}from"@playwright/test";var v=I.extend({iiPage:async({page:s,browser:o,context:i},t)=>{let e=new n({page:s,context:i,browser:o});await t(e)}});export{n as InternetIdentityPage,$ as expect,v as testWithII};

package/dist/types/page-objects/InternetIdentityPage.d.ts

@@ -38,10 +38,12 @@ export declare class InternetIdentityPage {
      *
      * @param {Object} [params] - The optional arguments for the sign-in method.
      * @param {string} [params.selector] - The selector for the login button. Defaults to [data-tid=login-button].
+     * @param {boolean} [params.captcha] - Set to true if the II login flow requires a captcha.
      * @returns {Promise<number>} A promise that resolves to the new identity number.
      */
     signInWithNewIdentity: (params?: {
         selector?: string;
+        captcha?: boolean;
     }) => Promise<number>;
     /**
      * Signs in with an existing identity.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dfinity/internet-identity-playwright",
-  "version": "0.0.3",
+  "version": "0.0.5",
   "description": "A Playwright library to simplify the integration of Internet Identity authentication in E2E tests.",
   "license": "Apache-2.0",
   "repository": {
@@ -46,26 +46,21 @@
     "build": "tsc --noEmit && node rmdir.mjs && node esbuild.mjs && npm run ts-declaration",
     "lint": "eslint --max-warnings 0 \"src/**/*\"",
     "dev": "npm --prefix demo run dev",
-    "e2e": "NODE_ENV=development playwright test",
-    "e2e:ci": "playwright test --reporter=html"
+    "e2e": "NODE_ENV=development playwright test --grep-invert 'captcha'",
+    "e2e:ci": "playwright test --reporter=html --grep-invert 'captcha'",
+    "e2e:captcha": "NODE_ENV=development playwright test e2e/captcha.spec",
+    "e2e:captcha:ci": "playwright test --reporter=html e2e/captcha.spec"
   },
   "devDependencies": {
-    "@types/node": "^20.14.2",
-    "@typescript-eslint/eslint-plugin": "^6.20.0",
-    "esbuild": "^0.23.1",
-    "eslint": "^8.57.0",
-    "eslint-config-prettier": "^9.1.0",
-    "eslint-config-standard-with-typescript": "^43.0.1",
-    "eslint-plugin-import": "^2.29.1",
-    "eslint-plugin-n": "^16.6.2",
-    "eslint-plugin-prettier": "^5.1.3",
-    "eslint-plugin-promise": "^6.1.1",
-    "prettier": "^3.3.3",
-    "prettier-plugin-organize-imports": "^4.0.0",
+    "@dfinity/eslint-config-oisy-wallet": "^0.0.6",
+    "@types/node": "^22.13.4",
+    "esbuild": "^0.25.0",
+    "prettier": "^3.5.1",
+    "prettier-plugin-organize-imports": "^4.1.0",
     "typescript": "^5.3.3"
   },
   "engines": {
-    "node": ">=20"
+    "node": ">=22"
   },
   "peerDependencies": {
     "@playwright/test": "^1.44.1"