Release 0.24.2 rc.4

.github/actions/get_test_infos/action.yml

@@ -0,0 +1,45 @@
+name: Get test infos
+description:
+    'Gets a list of test info objects for each npm project with an npm test script
+    The shape of the object is
+    {
+    path: string, // The path to the test
+    name: string, // The name of the test
+    type: string, // The type of test (e.g. ex (example), prop (property test), e2e, (end to end test) etc)
+    displayPath: string // An abbreviated version of the path for display purposes only
+    }'
+inputs:
+    directories:
+        description: List of directories to search for npm projects with an npm test script
+        required: true
+    exclude-dirs:
+        description: List of directories to exclude from the search
+        required: false
+        default: ''
+    node-version:
+        description: The version of Node.js to use
+        required: true
+        default: '20.x'
+outputs:
+    test-infos:
+        description: All of the test info objects found by this action
+        value: ${{ steps.get-test-infos.outputs.test-infos }}
+runs:
+    using: composite
+    steps:
+        - uses: actions/checkout@v4
+
+        - uses: actions/setup-node@v4
+          with:
+              node-version: ${{ inputs.node-version }}
+
+        - name: Get test infos
+          id: get-test-infos
+          run: |
+              # Export the input variables to make them available to the script
+              export INPUT_DIRECTORIES="${{ inputs.directories }}"
+              export INPUT_EXCLUDE_DIRS="${{ inputs.exclude-dirs }}"
+              # Run the script
+              TEST_INFOS=$(./.github/actions/get_test_infos/get_test_infos.sh | base64 -d)
+              echo "test-infos=${TEST_INFOS}" >> "$GITHUB_OUTPUT"
+          shell: bash

.github/actions/get_test_infos/dir_to_test_info.ts

@@ -0,0 +1,48 @@
+import { basename } from 'path';
+
+type TestInfo = {
+    path: string;
+    name: string;
+    type: Type;
+    displayPath: string;
+};
+
+type Type = 'ex' | 'e2e' | 'prop' | '';
+
+export function dirToTestInfo(dir: string): TestInfo {
+    const path = dir;
+    const name = basename(dir);
+    const type = getType(dir);
+    const displayPath = generateDisplayPath(dir);
+
+    return { path, name, type, displayPath };
+}
+
+function getType(dir: string): Type {
+    if (dir.includes('examples/')) return 'ex';
+    if (dir.includes('/end_to_end/')) return 'e2e';
+    if (dir.includes('/property/')) return 'prop';
+    return '';
+}
+
+function generateDisplayPath(path: string): string {
+    const replacements = {
+        examples: 'ex',
+        property: 'prop',
+        end_to_end: 'e2e',
+        functional_syntax: 'func',
+        functional_api: 'func',
+        class_syntax: 'class',
+        class_api: 'class',
+        candid_rpc: 'crpc',
+        http_server: 'http',
+        tests: 't'
+    };
+
+    return path
+        .split('/')
+        .map((dir) => {
+            return replacements[dir] || dir;
+        })
+        .join('/');
+}

.github/actions/get_test_infos/discover_test_dirs.ts

@@ -0,0 +1,46 @@
+import { promises as fs } from 'fs';
+import path from 'path';
+
+// Recursively find directories and check for package.json with a test script
+export async function discoverTestDirs(dirToSearch: string): Promise<string[]> {
+    const files = await fs.readdir(dirToSearch, { withFileTypes: true });
+
+    return files.reduce(
+        async (accPromise, file) => {
+            const acc = await accPromise;
+
+            const fullPath = path.join(dirToSearch, file.name);
+
+            if (file.isDirectory() && !fullPath.includes('node_modules')) {
+                // Check for package.json and if it contains a test script
+                const packageJsonPath = path.join(fullPath, 'package.json');
+                const hasTestScript = await checkForTestScript(packageJsonPath);
+
+                // Recurse into subdirectory
+                return [
+                    ...acc,
+                    ...(hasTestScript ? [fullPath] : []),
+                    ...(await discoverTestDirs(fullPath))
+                ];
+            }
+
+            return [];
+        },
+        Promise.resolve([] as string[])
+    );
+}
+
+// Check if package.json exists and contains a test script
+async function checkForTestScript(packageJsonPath: string): Promise<boolean> {
+    try {
+        const packageJson = await fs.readFile(packageJsonPath, 'utf-8');
+        const packageData = JSON.parse(packageJson);
+        return (
+            packageData.scripts !== undefined &&
+            packageData.scripts.test !== undefined
+        );
+    } catch {
+        // Return false if the file doesn't exist or there's a JSON error
+        return false;
+    }
+}

.github/actions/get_test_infos/get_test_infos.sh

@@ -0,0 +1,20 @@
+#!/bin/bash
+
+# Inputs from action.yml or environment variables
+DIRECTORIES=($INPUT_DIRECTORIES)
+EXCLUDE_DIRS=($INPUT_EXCLUDE_DIRS)
+
+# Convert arrays to comma-separated strings for passing into Node.js
+directories=$(IFS=, ; echo "${DIRECTORIES[*]}")
+exclude_dirs=$(IFS=, ; echo "${EXCLUDE_DIRS[*]}")
+
+# Get test infos
+json_result=$(npx tsx .github/actions/get_test_infos/index.js "$directories" "$exclude_dirs")
+
+# Format the result
+result="${json_result//'%'/'%25'}"
+result="${result//$'\n'/'%0A'}"
+result="${result//$'\r'/'%0D'}"
+
+# Output the final result as base64
+echo "$result" | base64

.github/actions/get_test_infos/get_test_infos.ts

@@ -0,0 +1,25 @@
+import { discoverTestDirs } from './discover_test_dirs.js';
+import { dirToTestInfo } from './dir_to_test_info.js';
+
+export async function getTestInfos(dirs: string[], excludeDirs: string[]) {
+    const allDirs = (
+        await dirs.reduce(
+            async (accPromise, dir) => {
+                const acc = await accPromise;
+                const discoveredDirs = await discoverTestDirs(dir);
+                return [...acc, ...discoveredDirs];
+            },
+            Promise.resolve([] as string[])
+        )
+    )
+        .filter((dir) => dir && !isExcluded(dir, excludeDirs))
+        .sort();
+
+    const testInfos = allDirs.map((dir) => dirToTestInfo(dir));
+
+    return testInfos;
+}
+
+function isExcluded(dir, excludeDirs) {
+    return excludeDirs.some((exclude) => dir.includes(exclude));
+}

.github/actions/get_test_infos/index.ts

@@ -0,0 +1,20 @@
+import { getTestInfos } from './get_test_infos.js';
+
+// Parse command-line arguments
+const [, , dirsArg, excludeDirsArg] = process.argv;
+
+// Convert comma-separated strings to arrays
+const dirs = dirsArg.split(',').filter((path) => path !== '');
+const excludeDirs = excludeDirsArg.split(',').filter((path) => path !== '');
+
+async function main() {
+    try {
+        const result = await getTestInfos(dirs, excludeDirs);
+        process.stdout.write(JSON.stringify(result));
+    } catch (error) {
+        console.error('Error processing directories:', error);
+        process.exit(1);
+    }
+}
+
+main();

.github/actions/should_release/action.yml

@@ -0,0 +1,27 @@
+name: Should release
+description: Determines if the current pull request is for testing or for starting a release
+outputs:
+    should-release:
+        description: Returns true if this branch should start a release, otherwise false
+        value: ${{ steps.determine-should-release.outputs.should-release }}
+runs:
+    using: composite
+    steps:
+        - uses: actions/checkout@v4
+          with:
+              ref: ${{ github.event.pull_request.head.ref }} # This is necessary for this job to be able to get the correct commit message from `git log`
+
+        - id: determine-should-release
+          run: |
+              BRANCH_NAME="${{ github.head_ref }}"
+              RELEASE_VERSION="${BRANCH_NAME:9}"
+              COMMIT_MESSAGE=$(git log -1 --pretty=format:"%s")
+              IS_RELEASE_BRANCH_PR="${{ startsWith(github.head_ref, 'release--') }}"
+
+              SHOULD_RELEASE="false"
+              if [[ $IS_RELEASE_BRANCH_PR == "true" && "$COMMIT_MESSAGE" == "release--$RELEASE_VERSION" ]]; then
+                  SHOULD_RELEASE="true"
+              fi
+
+              echo "should-release=${SHOULD_RELEASE}" >> "$GITHUB_OUTPUT"
+          shell: bash

.github/scripts/install_global_dependencies.sh

@@ -0,0 +1,58 @@
+#!/bin/bash
+
+# File path for the global dependencies
+GLOBAL_DEPENDENCIES_FILE="$PWD/global_dependencies.json"
+
+# Ensure jq is installed for JSON parsing
+if ! command -v jq &> /dev/null; then
+  echo "jq could not be found. Please install jq to parse JSON."
+  exit 1
+fi
+
+# Extract the rustc version from the JSON file
+RUST_VERSION=$(jq -r '.dependencies.rustc // empty' "$GLOBAL_DEPENDENCIES_FILE")
+
+if [[ -z "$RUST_VERSION" ]]; then
+  echo "Rust version not found in $GLOBAL_DEPENDENCIES_FILE"
+  exit 1
+fi
+
+# Install Rust using rustup with the extracted version
+echo "Installing Rust version $RUST_VERSION"
+curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh -s -- -y --default-toolchain "$RUST_VERSION"
+source $HOME/.cargo/env
+
+rustup target add wasm32-wasi
+
+# Extract the wasi2ic version and repository URL
+WASI2IC_VERSION=$(jq -r '.dependencies.wasi2ic // empty' "$GLOBAL_DEPENDENCIES_FILE")
+
+# Determine if WASI2IC_VERSION is a URL (repo) or just a version number
+if [[ $WASI2IC_VERSION =~ ^https?:// ]]; then
+  WASI2IC_URL=$WASI2IC_VERSION
+else
+  WASI2IC_URL=""
+fi
+
+if [[ -z "$WASI2IC_VERSION" ]]; then
+  echo "wasi2ic version not found in $GLOBAL_DEPENDENCIES_FILE"
+  exit 1
+fi
+
+# Install wasi2ic
+if [[ -n "$WASI2IC_URL" ]]; then
+  echo "Installing wasi2ic from repository $WASI2IC_URL"
+  cargo install --git "$WASI2IC_URL"
+else
+  echo "Installing wasi2ic version $WASI2IC_VERSION"
+  cargo install wasi2ic --version "$WASI2IC_VERSION"
+fi
+
+# Confirm installation
+echo "\nThe following global dependencies were installed"
+rustc --version
+cargo --version
+
+rustup target list --installed | grep wasm32-wasi
+
+cargo install --list | grep wasi2ic

publish-github-action.sh → .github/scripts/publish_github_action.sh

@@ -8,13 +8,17 @@ VERSION=$1
 
 directories_json_string_with_linebreaks=$2
 directories_json_string="${directories_json_string_with_linebreaks//$'\\n'/''}"
-directories=$(echo "$directories_json_string" | jq -c -r '.[]')
+directories=$(echo "$directories_json_string" | jq -c -r '.[] | .path')
 
 sed -E -i "s/(\"version\": \")(.*)(\")/\1$VERSION\3/" package.json
 sed -E -i "s/(\"version\": \")(.*)(\")/\1$VERSION\3/" dfx_extension/extension.json
 # TODO we need to keep the dependencies.json file up-to-date as well
 npm install
 
+# Build the binary templates
+npx azle template
+npx azle template --experimental
+
 if [[ "$VERSION" == *"-rc."* ]];
 then
     npm publish --tag next