@dfinity/internet-identity-playwright 0.0.1

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2021 DFINITY LLC.
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,161 @@
+# 🔐 Internet Identity Playwright
+
+A [Playwright](https://playwright.dev/) library to simplify the integration of [Internet Identity](https://identity.internetcomputer.org) authentication in E2E tests.
+
+<div align="center" style="display:flex;flex-direction:column;">
+<br/>
+
+[![Internet Computer portal](https://img.shields.io/badge/Internet-Computer-grey?logo=internet%20computer)](https://internetcomputer.org)
+[![GitHub CI Checks Workflow Status](https://img.shields.io/github/actions/workflow/status/dfinity/internet-identity-playwright/checks.yml?logo=github&label=CI%20checks)](https://github.com/dfinity/internet-identity-playwright/actions/workflows/checks.yml)
+[![GitHub CI Tests Workflow Status](https://img.shields.io/github/actions/workflow/status/dfinity/internet-identity-playwright/tests.yml?logo=github&label=CI%20tests)](https://github.com/dfinity/internet-identity-playwright/actions/workflows/tests.yml)
+
+</div>
+
+## 🚀 Introduction
+
+This repository offers Playwright fixtures designed to assist developers in creating end-to-end (E2E) tests for dApps utilizing Internet Identity. These pre-built scenarios allow developers to seamlessly integrate authentication flows, including the creation and reuse of identities, without needing to implement the flows themselves.
+
+## 🖥️ Installation
+
+```bash
+# with npm
+npm install --save-dev @dfinity/internet-identity-playwright
+# with pnpm
+pnpm add --save-dev @dfinity/internet-identity-playwright
+# with yarn
+yarn add -D @dfinity/internet-identity-playwright
+```
+
+## ✍️ Usage
+
+To use the Internet Identity Playwright fixtures, follow these steps:
+
+### 1. Import the Fixtures
+
+In your Playwright test file, import the fixtures provided by this library.
+
+```javascript
+import {testWithII} from '@dfinity/internet-identity-playwright';
+```
+
+### 2. Write Your Tests
+
+Use the extended fixtures in your tests to perform authentication flows.
+
+```javascript
+testWithII('should sign-in with a new user', async ({page, iiPage}) => {
+  await page.goto('/');
+
+  await iiPage.signInWithNewIdentity();
+});
+
+testWithII('should sign-in with an existing new user', async ({page, iiPage}) => {
+  await page.goto('/');
+
+  await iiPage.signInWithIdentity({identity: 10003});
+});
+```
+
+The `iiPage` object represents the page of your application that contains the call to action to start the authentication flow with Internet Identity. By default, the fixture will search for a button identified by the attribute `[data-tid=login-button]`. You can customize this behavior by providing your own selector.
+
+```javascript
+const loginSelector = '#login';
+
+testWithII('should sign-in with a new user', async ({page, iiPage}) => {
+  await page.goto('/');
+
+  await iiPage.signInWithNewIdentity({selector: loginSelector});
+});
+
+testWithII('should sign-in with an existing new user', async ({page, iiPage}) => {
+  await page.goto('/');
+
+  await iiPage.signInWithIdentity({identity: 10003, selector: loginSelector});
+});
+```
+
+### 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.
+
+For example, you can provide the local replica URL and the canister ID on which Internet Identity has been deployed:
+
+```javascript
+testWithII.beforeEach(async ({iiPage, browser}) => {
+  const url = 'http://127.0.0.1:4943';
+  const canisterId = 'rdmx6-jaaaa-aaaaa-aaadq-cai';
+
+  await iiPage.waitReady({url, canisterId});
+});
+```
+
+The function also accepts an optional timeout parameter to specify how long the function should wait for Internet Identity to be mounted, with a default value of 60000 milliseconds.
+
+```javascript
+testWithII.beforeEach(async ({iiPage, browser}) => {
+  const url = 'http://127.0.0.1:4943';
+  const canisterId = 'rdmx6-jaaaa-aaaaa-aaadq-cai';
+  const timeout = 30000;
+
+  await iiPage.waitReady({url, canisterId, timeout});
+});
+```
+
+### 4. Run Your Tests
+
+Run your Playwright tests as usual.
+
+```bash
+npx playwright test
+```
+
+## 💁‍♂️️ Tips & tricks
+
+### Example Test
+
+You can find an example test in the following file: [login.spec.ts](./e2e/login.spec.ts).
+
+### Running Tests Locally
+
+To run these tests locally, you'll need to install the Juno CLI. Follow the steps below:
+
+1. Install Docker:
+
+Make sure you have Docker installed on your machine ([Windows](https://docs.docker.com/desktop/install/windows-install/), [MacOS](https://docs.docker.com/desktop/install/mac-install/), or [Linux](https://docs.docker.com/desktop/install/linux-install/)).
+
+> [!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:
+
+```bash
+npm i -g @junobuild/cli
+```
+
+3. Start the Demo Application:
+
+Navigate to the [demo](./demo) directory and start the application using the Juno CLI:
+
+```bash
+cd demo
+juno dev start
+```
+
+4. Run the Tests:
+
+Return to the root directory and execute the tests:
+
+```
+npm run e2e
+```
+
+## 🚧 Limitations
+
+Currently, the library's fixtures cannot be implemented with Playwright's ability to [load existing authenticated state](https://playwright.dev/docs/auth). Playwright currently does not support IndexedDB for such features. This limitation is tracked in their [GitHub issue #11164](https://github.com/microsoft/playwright/issues/11164).
+
+While it is technically possible to use local storage instead of IndexedDB, this approach is generally discouraged as it does not reflect how identities are stored in the browser. We prefer to adhere to best practices for testing to ensure the most accurate simulation of real-world scenarios.
+
+## 🧑‍🤝‍🧑 Community
+
+- [Forum](https://forum.dfinity.org/)
+- [Discord](https://discord.gg/E9FxceAg2j)

package/dist/index.js

@@ -0,0 +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),u=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(u,{waitUntil:"domcontentloaded"}))?.ok()??!1}catch{return!1}},l=500,w=async({count:r})=>{if(await y())return"ready";let d=r-1;return d===0?"timeout":(await new Promise(m=>setTimeout(m,l)),await w({count:d}))},p=await w({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.locator("[data-action=cancel]").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};

package/dist/types/fixtures.d.ts

@@ -0,0 +1,6 @@
+import { InternetIdentityPage } from './page-objects/InternetIdentityPage';
+interface InternetIdentityFixtures {
+    iiPage: InternetIdentityPage;
+}
+export declare const testWithII: import("@playwright/test").TestType<import("@playwright/test").PlaywrightTestArgs & import("@playwright/test").PlaywrightTestOptions & InternetIdentityFixtures, import("@playwright/test").PlaywrightWorkerArgs & import("@playwright/test").PlaywrightWorkerOptions>;
+export { expect } from '@playwright/test';

package/dist/types/index.d.ts

@@ -0,0 +1,2 @@
+export * from './fixtures';
+export * from './page-objects/InternetIdentityPage';

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

@@ -0,0 +1,57 @@
+import { type Browser, type BrowserContext, type Page } from '@playwright/test';
+/**
+ * A page object to test Internet Identity.
+ */
+export declare class InternetIdentityPage {
+    private readonly page;
+    private readonly browser;
+    private readonly context;
+    /**
+     * Creates an instance of InternetIdentityPage.
+     *
+     * @param {Object} params - The parameters for the constructor.
+     * @param {Page} params.page - The Page instance to interact with Internet Identity a single tab in a Browser.
+     * @param {BrowserContext} params.context - The isolated BrowserContext instance provided by Playwright, created for each test.
+     * @param {Browser} params.browser - The browser launched by Playwright.
+     */
+    constructor({ page, context, browser }: {
+        page: Page;
+        context: BrowserContext;
+        browser: Browser;
+    });
+    /**
+     * Waits until the Internet Identity page is ready.
+     *
+     * @param {Object} params - The parameters for the waitReady method.
+     * @param {string} params.url - The root URL of the Internet Identity page. e.g. https://identity.internetcomputer.org, http://localhot:4973 or http://127.0.0.1:5987
+     * @param {string} [params.canisterId] - An optional canister ID. If provided, will be added to the url parameter.
+     * @param {number} [params.timeout] - } [params.timeout] - An optional timeout period in milliseconds for the function to wait until Internet Identity is mounted. Defaults to 60000 milliseconds.
+     * @returns {Promise<void>} A promise that resolves when the page is ready.
+     */
+    waitReady: ({ url: rootUrl, canisterId, timeout }: {
+        url: string;
+        canisterId?: string | undefined;
+        timeout?: number | undefined;
+    }) => Promise<void>;
+    /**
+     * Signs in and create a new user.
+     *
+     * @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].
+     * @returns {Promise<number>} A promise that resolves to the new identity number.
+     */
+    signInWithNewIdentity: (params?: {
+        selector?: string;
+    }) => Promise<number>;
+    /**
+     * Signs in with an existing identity.
+     * @param {Object} params - The parameters for the sign-in method.
+     * @param {string} [params.selector] - The selector for the login button. Defaults to [data-tid=login-button].
+     * @param {number} params.identity - The identity number.
+     * @returns {Promise<void>} A promise that resolves when the sign-in process is complete.
+     */
+    signInWithIdentity: ({ selector, identity }: {
+        selector?: string | undefined;
+        identity: number;
+    }) => Promise<void>;
+}

package/package.json

@@ -0,0 +1,73 @@
+{
+  "name": "@dfinity/internet-identity-playwright",
+  "version": "0.0.1",
+  "description": "A Playwright library to simplify the integration of Internet Identity authentication in E2E tests.",
+  "license": "Apache-2.0",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/dfinity/internet-identity-playwright.git"
+  },
+  "bugs": {
+    "url": "https://github.com/dfinity/internet-identity-playwright"
+  },
+  "files": [
+    "dist",
+    "README.md",
+    "LICENSE"
+  ],
+  "keywords": [
+    "internet computer",
+    "internet-computer",
+    "ic",
+    "icp",
+    "dfinity",
+    "internet-identity",
+    "ii",
+    "playwright",
+    "e2e",
+    "test"
+  ],
+  "homepage": "https://github.com/dfinity/ic-js#readme",
+  "type": "module",
+  "main": "dist/index.js",
+  "module": "./dist/index.js",
+  "types": "./dist/types/index.d.ts",
+  "exports": {
+    ".": {
+      "import": "./dist/index.js",
+      "require": "./dist/index.js",
+      "types": "./dist/types/index.d.ts"
+    }
+  },
+  "scripts": {
+    "format": "prettier . --write",
+    "format:check": "prettier --check .",
+    "ts-declaration": "tsc --emitDeclarationOnly --outDir dist/types",
+    "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"
+  },
+  "devDependencies": {
+    "@types/node": "^20.14.2",
+    "@typescript-eslint/eslint-plugin": "^6.20.0",
+    "esbuild": "^0.20.2",
+    "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.2.5",
+    "prettier-plugin-organize-imports": "^3.2.4",
+    "typescript": "^5.3.3"
+  },
+  "engines": {
+    "node": ">=20"
+  },
+  "peerDependencies": {
+    "@playwright/test": "^1.44.1"
+  }
+}