Merge branch 'main' into feat/update-satellte-template

Author: peterpeterparker

.github/actions/download-wasms/action.yml

@@ -2,53 +2,59 @@ name: Download WASM Artifacts
 
 description: Downloads the WASM build artifacts
 
+inputs:
+  path:
+    description: Target directory for downloaded artifacts
+    required: false
+    default: "."
+
 runs:
   using: "composite"
   steps:
     - name: Download satellite.wasm.gz
       uses: actions/download-artifact@v4
       with:
         name: satellite.wasm.gz
-        path: .
+        path: ${{ inputs.path }}
 
     - name: Download orbiter.wasm.gz
       uses: actions/download-artifact@v4
       with:
         name: orbiter.wasm.gz
-        path: .
+        path: ${{ inputs.path }}
 
     - name: Download sputnik.wasm.gz
       uses: actions/download-artifact@v4
       with:
         name: sputnik.wasm.gz
-        path: .
+        path: ${{ inputs.path }}
 
     - name: Download console.wasm.gz
       uses: actions/download-artifact@v4
       with:
         name: console.wasm.gz
-        path: .
+        path: ${{ inputs.path }}
 
     - name: Download observatory.wasm.gz
       uses: actions/download-artifact@v4
       with:
         name: observatory.wasm.gz
-        path: .
+        path: ${{ inputs.path }}
 
     - name: Download mission_control.wasm.gz
       uses: actions/download-artifact@v4
       with:
         name: mission_control.wasm.gz
-        path: .
+        path: ${{ inputs.path }}
 
     - name: Download test_satellite.wasm.gz
       uses: actions/download-artifact@v4
       with:
         name: test_satellite.wasm.gz
-        path: .
+        path: ${{ inputs.path }}
 
     - name: Download test_sputnik.wasm.gz
       uses: actions/download-artifact@v4
       with:
         name: test_sputnik.wasm.gz
-        path: .
+        path: ${{ inputs.path }}

.github/actions/emulator/action.yml

@@ -0,0 +1,28 @@
+name: Run emulator
+
+description: Start and config the emulator
+
+runs:
+  using: composite
+  steps:
+    - name: Run emulator
+      shell: bash
+      run: |
+        set -e
+        ./scripts/emulator.sh --headless &
+        npm run emulator:wait
+
+    - name: Identity Console controller locally
+      shell: bash
+      run: |
+        set -e
+        node ./scripts/console.controller.mjs --headless
+
+    # We have copied the WASMs into target/deploy
+    # Therefore, the latest Satellite, Mission Control and Orbiter
+    # were already uploaded to the Console at boot time
+    - name: Upgrade the Console
+      shell: bash
+      run: |
+        set -e
+        node ./scripts/console.upgrade.mjs --headless

.github/workflows/tests-screenshots.yml

@@ -84,6 +84,11 @@ jobs:
 
       - name: Download WASM Artifacts
         uses: ./.github/actions/download-wasms
+        with:
+          path: ./target/deploy
+
+      - name: Run emulator
+        uses: ./.github/actions/emulator
 
       - name: Run Playwright tests
         run: npm run e2e:snapshots

.github/workflows/tests.yml

@@ -116,6 +116,11 @@ jobs:
 
       - name: Download WASM Artifacts
         uses: ./.github/actions/download-wasms
+        with:
+          path: ./target/deploy
+
+      - name: Run emulator
+        uses: ./.github/actions/emulator
 
       - name: E2E tests
         run: npm run e2e:ci

package-lock.json

@@ -50,7 +50,7 @@
 		"e2e:ci": "playwright test --reporter=html",
 		"e2e:snapshots": "playwright test --update-snapshots --reporter=list",
 		"e2e:report": "playwright show-report",
-		"e2e:playwright:install": "playwright install --with-deps",
+		"e2e:playwright:install": "playwright install chromium --with-deps",
 		"build:console": "scripts/cargo.sh --console",
 		"build:observatory": "scripts/cargo.sh --observatory",
 		"build:satellite": "scripts/cargo.sh --satellite",
@@ -61,10 +61,12 @@
 		"build:test-satellite": "scripts/cargo.sh --test_satellite",
 		"build:test-sputnik": "scripts/cargo.sh --test_sputnik",
 		"build:modules": "npm run build:console && npm run build:observatory && npm run build:satellite && npm run build:mission-control && npm run build:orbiter",
-		"emulator": "./scripts/emulator.sh"
+		"emulator": "./scripts/emulator.sh",
+		"emulator:wait": "node scripts/emulator.wait.mjs"
 	},
 	"devDependencies": {
 		"@dfinity/eslint-config-oisy-wallet": "^0.2.2",
+		"@dfinity/internet-identity-playwright": "^2.0.0",
 		"@dfinity/pic": "^0.13.1",
 		"@dfinity/response-verification": "^3.0.3",
 		"@junobuild/cli-tools": "^0.4.1",

package.json

@@ -18,6 +18,12 @@ export default defineConfig({
 			caret: 'hide'
 		}
 	},
+	webServer: {
+		command: 'npm run prepare && npm run dev',
+		url: 'http://localhost:5173',
+		reuseExistingServer: !!process.env.CI,
+		timeout: 120 * 1000
+	},
 	use: {
 		testIdAttribute: 'data-tid',
 		baseURL: 'http://localhost:5173',

playwright.config.ts

@@ -3,6 +3,7 @@ import { nonNullish } from '@dfinity/utils';
 import { assertAnswerCtrlC } from '@junobuild/cli-tools';
 import Conf from 'conf';
 import prompts from 'prompts';
+import { isHeadless } from './utils.mjs';
 
 const askForPassword = async () => {
 	const { encryptionKey } = await prompts([
@@ -25,7 +26,7 @@ const initConfig = async (mainnet) => {
 		return;
 	}
 
-	const encryptionKey = await askForPassword();
+	const encryptionKey = isHeadless() ? false : await askForPassword();
 
 	const projectName = `juno-${mainnet ? '' : 'dev-'}console`;
 

scripts/console.config.utils.mjs

@@ -3,17 +3,27 @@
 CONTAINER_NAME="juno-console"
 VOLUME="juno_console"
 
+RUN_FLAGS="-it"
+START_FLAGS="-i"
+
+for arg in "$@"; do
+  if [ "$arg" = "--headless" ]; then
+    RUN_FLAGS=""
+    START_FLAGS=""
+  fi
+done
+
 if docker ps -a -q -f name="^/${CONTAINER_NAME}$" | grep -q .; then
   if [ "$(docker inspect -f '{{.State.Running}}' "$CONTAINER_NAME")" = "true" ]; then
     echo "✋  Container '$CONTAINER_NAME' is already running..."
   else
     echo "▶️  Starting the emulator..."
-    docker start -a -i "$CONTAINER_NAME"
+    docker start -a $START_FLAGS "$CONTAINER_NAME"
   fi
 else
   echo "🚀  Running new emulator..."
 
-  docker run -it \
+  docker run $RUN_FLAGS \
     --name "$CONTAINER_NAME" \
     -p 5987:5987 \
     -p 5999:5999 \

scripts/emulator.sh

@@ -0,0 +1,63 @@
+const DEFAULT_TIMEOUT_IN_MILLISECONDS = 2 * 60 * 1000;
+const RETRY_IN_MILLISECONDS = 500;
+
+const waitEmulatorReady = async ({ count }) => {
+	const ready = await isEmulatorReady();
+
+	if (ready) {
+		return 'ready';
+	}
+
+	const nextCount = count - 1;
+
+	if (nextCount === 0) {
+		return 'timeout';
+	}
+
+	await new Promise((resolve) => setTimeout(resolve, RETRY_IN_MILLISECONDS));
+
+	return await waitEmulatorReady({ count: nextCount });
+};
+
+const isEmulatorReady = async () => {
+	try {
+		const { result } = await dispatchRequest({
+			request: 'health'
+		});
+
+		return result === 'ok';
+	} catch (_e) {
+		return false;
+	}
+};
+
+const dispatchRequest = async ({ request, timeout = 5000 }) => {
+	const adminPort = 5999;
+
+	try {
+		const response = await fetch(`http://localhost:${adminPort}/${request}`, {
+			signal: AbortSignal.timeout(timeout)
+		});
+
+		if (!response.ok) {
+			return { result: 'not_ok', response };
+		}
+
+		return { result: 'ok', response };
+	} catch (err) {
+		return { result: 'error', err };
+	}
+};
+
+console.log('Waiting for emulator...');
+
+const status = await waitEmulatorReady({
+	count: DEFAULT_TIMEOUT_IN_MILLISECONDS / RETRY_IN_MILLISECONDS
+});
+
+if (status === 'timeout') {
+	console.error('❌ The emulator is not ready. Operation timed out.');
+	process.exit(1);
+}
+
+console.log('Emulator is ready. ✅');