Merge branch 'main' into refactor/checkout-post-message-handler

.github/actions/setup-playwright/action.yaml

@@ -0,0 +1,39 @@
+name: "Playwright setup"
+description: "Install the browsers and dependencies for Playwright to run"
+
+runs:
+  using: "composite"
+  steps:
+    - name: Playwright versions in sync check
+      shell: bash
+      run: |
+        versions=$(yarn why --json @playwright/test | grep -h 'workspace:.' | jq --raw-output '.children[].locator' | sed -e 's/@playwright\/test@.*://')
+        unique_versions=$(echo "$versions" | sort | uniq)
+        if [ $(echo "$unique_versions" | wc -l) -ne 1 ]; then
+          echo "Playwright versions are not in sync:"
+          echo "$unique_versions"
+          exit 1
+        else
+          echo "All Playwright versions are in sync."
+        fi
+
+    - name: Get Playwright version
+      shell: bash
+      run: echo "PLAYWRIGHT_VERSION=$(node -e "console.log(require('playwright/package.json').version)")" >> $GITHUB_ENV
+
+    - name: Cache Playwright Browsers
+      id: cache-playwright-browsers
+      uses: actions/cache@v4
+      with:
+        path: ~/.cache/ms-playwright
+        key: playwright-browsers-${{ runner.os }}-${{ env.PLAYWRIGHT_VERSION }}
+
+    - name: Install Playwright with dependencies
+      shell: bash
+      if: steps.cache-playwright-browsers.outputs.cache-hit != 'true'
+      run: yarn dlx playwright@${{ env.PLAYWRIGHT_VERSION }} install --with-deps
+
+    - name: Install Playwright dependencies
+      shell: bash
+      if: steps.cache-playwright-browsers.outputs.cache-hit == 'true'
+      run: yarn dlx playwright@${{ env.PLAYWRIGHT_VERSION }} install-deps

.github/scripts/check-docs-version.sh

@@ -20,3 +20,9 @@ if [ -d "$CLONE_DIR/api-docs/sdk-references/ts-immutable-sdk/$VERSION" ]; then
   echo "There is already a docs folder for v$VERSION. Please create a separate PR to update the SDK reference docs for v$VERSION."
   exit 1
 fi
+
+# check the version contains `alpha` string
+if echo "$VERSION" | grep -q "alpha"; then
+  echo "Skipping docs generation for alpha version"
+  exit 1
+fi

.github/workflows/pr.yaml

@@ -127,7 +127,7 @@ jobs:
   build-examples:
     name: Build Examples
     needs: build-sdk
-    runs-on: ubuntu-latest-4-cores
+    runs-on: ubuntu-latest-8-cores
     env:
       NODE_OPTIONS: --max-old-space-size=14366
     steps:
@@ -165,7 +165,7 @@ jobs:
   test-examples:
     name: Test Examples
     needs: build-sdk
-    runs-on: ubuntu-latest-4-cores
+    runs-on: ubuntu-latest-8-cores
     env:
       NODE_OPTIONS: --max-old-space-size=14366
     steps:
@@ -178,6 +178,9 @@ jobs:
       - name: Setup examples
         uses: ./.github/actions/setup-examples
 
+      - name: Setup playwright
+        uses: ./.github/actions/setup-playwright
+
       - name: Test examples
         run: yarn test:examples
 
@@ -217,7 +220,7 @@ jobs:
 
   func-test-zkevm:
     name: zkevm func tests
-    runs-on: ubuntu-latest-4-cores
+    runs-on: ubuntu-latest-8-cores
     needs: build-sdk
     env:
       ZKEVM_ORDERBOOK_BANKER: ${{ secrets.ZKEVM_ORDERBOOK_BANKER }}

.github/workflows/publish-docs.yaml

@@ -26,19 +26,19 @@ jobs:
           VERSION=$(git describe --tags --abbrev=0)
           if echo "$VERSION" | grep -q "alpha"; then
             echo "Skipping docs generation for alpha version"
-            echo "is_alpha=true" >> $GITHUB_ENV
+            echo "is_alpha=true" >> $GITHUB_OUTPUT
             exit 0
           else
             echo "Generating docs for non-alpha version"
-            echo "is_alpha=false" >> $GITHUB_ENV
+            echo "is_alpha=false" >> $GITHUB_OUTPUT
           fi
         shell: bash
 
   PublishDocs:
     name: Publish SDK Reference Docs
     runs-on: ubuntu-latest
     needs: AlphaCheck
-    # if: ${{ needs.AlphaCheck.outputs.is_alpha == 'false' }}
+    if: ${{ needs.AlphaCheck.outputs.is_alpha == 'false' }}
     env:
       SDK_PUBLISH_SLACK_WEBHOOK: ${{ secrets.SDK_PUBLISH_SLACK_WEBHOOK }}
       NETLIFY_BUILD_HOOK: ${{ secrets.NETLIFY_BUILD_HOOK }}
@@ -87,12 +87,6 @@ jobs:
           node-version-file: .nvmrc
           cache: "yarn"
 
-      - name: Update SDK package.json version
-        run: |
-          tmp=$(mktemp)
-          jq '.version = "${{ env.VERSION }}"' ./package.json > "$tmp" && mv "$tmp" ./package.json
-        shell: bash
-
       - name: Restore cached node_modules
         id: restore-cache-node_modules
         uses: actions/cache@v4
@@ -107,6 +101,12 @@ jobs:
       - name: Build
         run: export NODE_OPTIONS=--max-old-space-size=6144 && yarn build
 
+      - name: Update SDK package.json version
+        run: |
+          tmp=$(mktemp)
+          jq '.version = "${{ env.VERSION }}"' ./sdk/package.json > "$tmp" && mv "$tmp" ./sdk/package.json
+        shell: bash
+
       - name: Build SDK Docs
         run: yarn docs:build
 
@@ -135,7 +135,7 @@ jobs:
         if: ${{ success() && steps.docs_push.conclusion == 'success' && steps.netlify_build.conclusion == 'success' && steps.netlify_deploy.conclusion == 'success' }}
         uses: ./.github/actions/notify-slack-publish-status
         with:
-          message: "✅ SDK reference documents published successfully - https://docs.immutable.com/sdk-references/ts-immutable-sdk/${{ env.VERSION }}/modules/_imtbl_sdk.html\n\n>*`${{ env.GITHUB_USER }}` Please ensure you and the team updated all Sample Code + Guides on the <https://docs.immutable.com|imx-docs site> to reflect the change.*"
+          message: "✅ SDK reference documents published successfully - https://docs.immutable.com/sdk-references/ts-immutable-sdk/${{ env.VERSION }}/\n\n>*`${{ env.GITHUB_USER }}` Please ensure you and the team updated all Sample Code + Guides on the <https://docs.immutable.com|imx-docs site> to reflect the change.*"
 
       - name: Notify SDK Slack Docs Publish Failure
         if: ${{ failure() && steps.docs_version_check.conclusion == 'success' }}

examples/README.md

@@ -263,7 +263,7 @@ Example of the base level of testing required can be found in `/examples/passpor
 Add the test runner to the scripts in your package.json
 
 ```
-"test": "playwright install --with-deps && playwright test"
+"test": "playwright test"
 ```
 
 Run your tests with `yarn test`

examples/passport/identity-with-nextjs/package.json

@@ -25,6 +25,6 @@
     "dev": "next dev",
     "lint": "next lint",
     "start": "next start",
-    "test": "playwright install --with-deps && playwright test"
+    "test": "playwright test"
   }
 }

examples/passport/wallets-connect-with-nextjs/package.json

@@ -28,6 +28,6 @@
     "dev": "next dev",
     "lint": "eslint app --ext .js,.jsx,.ts,.tsx",
     "start": "next start",
-    "test": "playwright install --with-deps && playwright test"
+    "test": "playwright test"
   }
 }

examples/passport/wallets-signing-with-nextjs/package.json

@@ -28,6 +28,6 @@
     "dev": "next dev",
     "lint": "next lint",
     "start": "next start",
-    "test": "playwright install --with-deps && playwright test"
+    "test": "playwright test"
   }
 }

examples/passport/wallets-transactions-with-nextjs/package.json

@@ -25,6 +25,6 @@
     "dev": "next dev",
     "lint": "next lint",
     "start": "next start",
-    "test": "playwright install --with-deps && playwright test"
+    "test": "playwright test"
   }
 }

packages/checkout/sdk/src/widgets/definitions/events/checkout.ts

@@ -1,6 +1,6 @@
 import { Web3Provider } from '@ethersproject/providers';
 import { CheckoutFlowType } from '../parameters/checkout';
-import { ConnectionFailed } from './connect';
+import { ConnectionFailed, ConnectionSuccess } from './connect';
 import {
   SaleFailed,
   SalePaymentMethod,
@@ -16,7 +16,7 @@ import {
   BridgeFailed,
   BridgeTransactionSent,
 } from './bridge';
-import { SwapFailed, SwapSuccess } from './swap';
+import { SwapFailed, SwapRejected, SwapSuccess } from './swap';
 import { WalletNetworkSwitch } from './wallet';
 
 export enum CheckoutEventType {
@@ -39,6 +39,8 @@ export enum CheckoutSuccessEventType {
 export enum CheckoutFailureEventType {
   BRIDGE_FAILED = 'BRIDGE_FAILED',
   BRIDGE_CLAIM_WITHDRAWAL_FAILED = 'BRIDGE_CLAIM_WITHDRAWAL_FAILED',
+  SWAP_FAILED = 'SWAP_FAILED',
+  SWAP_REJECTED = 'SWAP_REJECTED',
 }
 
 export enum CheckoutUserActionEventType {
@@ -89,7 +91,13 @@ export type CheckoutSwapSuccessEvent = {
   data: SwapSuccess;
 }; // FIMXE: TransactionSent
 
+export type CheckoutConnectSuccessEvent = {
+  flow: CheckoutFlowType.CONNECT;
+  data: ConnectionSuccess;
+};
+
 export type CheckoutSuccessEvent =
+  | CheckoutConnectSuccessEvent
   | CheckoutBridgeSuccessEvent
   | CheckoutBridgeClaimWithdrawalSuccessEvent
   | CheckoutOnRampSuccessEvent
@@ -121,9 +129,16 @@ export type CheckoutOnRampFailureEvent = {
 
 export type CheckoutSwapFailureEvent = {
   flow: CheckoutFlowType.SWAP;
+  type: CheckoutFailureEventType.SWAP_FAILED;
   data: SwapFailed;
 }; // FIMXE: Error
 
+export type CheckoutSwapRejectedEvent = {
+  flow: CheckoutFlowType.SWAP;
+  type: CheckoutFailureEventType.SWAP_REJECTED;
+  data: SwapRejected;
+}; // FIMXE: Error
+
 export type CheckoutSaleFailureEvent = {
   flow: CheckoutFlowType.SALE;
   data: SaleFailed;
@@ -135,6 +150,7 @@ export type CheckoutFailureEvent =
   | CheckoutConnectFailureEvent
   | CheckoutOnRampFailureEvent
   | CheckoutSwapFailureEvent
+  | CheckoutSwapRejectedEvent
   | CheckoutSaleFailureEvent;
 
 export type CheckoutPaymentMethodSelectedEvent = {

packages/checkout/widgets-lib/src/widgets/checkout/context/CheckoutContextProvider.tsx

@@ -40,7 +40,7 @@ export function CheckoutContextProvider({
 
     // TODO: remove logger after done with development
     postMessageHandlerInstance.setLogger((...args: any[]) => {
-      console.log('🔔 PARENT – ', ...args); // eslint-disable-line
+      console.log("🔔 PARENT – ", ...args); // eslint-disable-line
     });
 
     checkoutDispatch({

packages/game-bridge/src/index.ts

@@ -214,6 +214,7 @@ window.callFunction = async (jsonData: string) => {
 
     track(moduleName, 'startedCallFunction', {
       function: fxName,
+      requestId,
     });
     switch (fxName) {
       case PASSPORT_FUNCTIONS.init: {