fix: adjust how we run npx, so it supports all windows versions (#454)

* fix: adjust how we run npx, so it supports all windows versions
* chore: make client generator snapshots platform specific

src/algokit/cli/doctor.py

@@ -12,6 +12,7 @@
     DOCKER_COMPOSE_MINIMUM_VERSION,
     DOCKER_COMPOSE_VERSION_COMMAND,
 )
+from algokit.core.utils import is_windows as get_is_windows
 from algokit.core.version_prompt import get_latest_github_version
 
 logger = logging.getLogger(__name__)
@@ -40,7 +41,7 @@ def doctor_command(*, copy_to_clipboard: bool) -> None:
     Will search the system for AlgoKit dependencies and show their versions, as well as identifying any
     potential issues."""
     os_type = platform.system()
-    is_windows = os_type == "Windows"
+    is_windows = get_is_windows()
     service_outputs = {
         "timestamp": DoctorResult(ok=True, output=dt.datetime.now(dt.timezone.utc).replace(microsecond=0).isoformat()),
         "AlgoKit": _get_algokit_version_output(),

src/algokit/core/bootstrap.py

@@ -1,14 +1,13 @@
 import logging
 import os
-import platform
 from pathlib import Path
 
 import click
 from packaging import version
 
 from algokit.core import proc, questionary_extensions
 from algokit.core.conf import ALGOKIT_CONFIG, get_algokit_config, get_current_package_version
-from algokit.core.utils import find_valid_pipx_command
+from algokit.core.utils import find_valid_pipx_command, is_windows
 
 ENV_TEMPLATE_PATTERN = ".env*.template"
 MAX_BOOTSTRAP_DEPTH = 2
@@ -162,8 +161,7 @@ def bootstrap_npm(project_dir: Path) -> None:
         logger.info(f"{package_json_path} doesn't exist; nothing to do here, skipping bootstrap of npm")
     else:
         logger.info("Installing npm dependencies")
-        is_windows = platform.system() == "Windows"
-        cmd = ["npm" if not is_windows else "npm.cmd", "install"]
+        cmd = ["npm" if not is_windows() else "npm.cmd", "install"]
         try:
             proc.run(
                 cmd,

src/algokit/core/typed_client_generation.py

@@ -10,6 +10,7 @@
 import click
 
 from algokit.core import proc
+from algokit.core.utils import is_windows
 
 logger = logging.getLogger(__name__)
 
@@ -96,11 +97,10 @@ def __init__(self) -> None:
         npx_path = shutil.which("npx")
         if not npx_path:
             raise click.ClickException("Typescript generator requires Node.js and npx to be installed.")
-        self._npx_path = npx_path
 
     def generate(self, app_spec: Path, output: Path) -> None:
         cmd = [
-            self._npx_path,
+            "npx" if not is_windows() else "npx.cmd",
             "--yes",
             TYPESCRIPT_NPX_PACKAGE,
             "generate",

src/algokit/core/utils.py

@@ -141,10 +141,9 @@ def get_base_python_path() -> str | None:
     # this will be the value of `home = <path>` in pyvenv.cfg if it exists
     if base_home := getattr(sys, "_home", None):
         base_home_path = Path(base_home)
-        is_windows = platform.system() == "Windows"
         for name in ("python", "python3", f"python3.{sys.version_info.minor}"):
             candidate_path = base_home_path / name
-            if is_windows:
+            if is_windows():
                 candidate_path = candidate_path.with_suffix(".exe")
             if candidate_path.is_file():
                 return str(candidate_path)
@@ -158,3 +157,7 @@ def is_binary_mode() -> bool:
     return: True if running in a native binary frozen environment, False otherwise.
     """
     return getattr(sys, "frozen", False) and hasattr(sys, "_MEIPASS")
+
+
+def is_windows() -> bool:
+    return platform.system() == "Windows"

tests/generate/test_generate_client.py

@@ -5,7 +5,9 @@
 import pytest
 from _pytest.tmpdir import TempPathFactory
 from algokit.core.typed_client_generation import TYPESCRIPT_NPX_PACKAGE, _snake_case
+from algokit.core.utils import is_windows
 from approvaltests.namer import NamerFactory
+from approvaltests.pytest.py_test_namer import PyTestNamer
 from pytest_mock import MockerFixture
 
 from tests.utils.approvals import verify
@@ -20,6 +22,10 @@ def _normalize_output(output: str) -> str:
     return output.replace("\\", "/").replace(TYPESCRIPT_NPX_PACKAGE, "{typed_client_package}")
 
 
+def _get_npx_command() -> str:
+    return "npx" if not is_windows() else "npx.cmd"
+
+
 @pytest.fixture()
 def cwd(tmp_path_factory: TempPathFactory) -> Path:
     return tmp_path_factory.mktemp("cwd")
@@ -102,6 +108,7 @@ def test_generate_client_python_arc32_filename(arc32_json: Path, options: str, e
     assert (arc32_json.parent / expected_output_path).read_text()
 
 
+@pytest.mark.usefixtures("mock_platform_system")
 @pytest.mark.parametrize(
     ("options", "expected_output_path"),
     [
@@ -116,17 +123,20 @@ def test_generate_client_typescript(
     application_json: Path,
     options: str,
     expected_output_path: Path,
+    request: pytest.FixtureRequest,
 ) -> None:
     result = invoke(f"generate client {options} {application_json.name}", cwd=application_json.parent)
     assert result.exit_code == 0
     verify(
         _normalize_output(result.output),
+        namer=PyTestNamer(request),
         options=NamerFactory.with_parameters(*options.split()),
     )
+    npx = _get_npx_command()
     assert len(proc_mock.called) == 1
     assert (
         proc_mock.called[0].command
-        == f"/bin/npx --yes {TYPESCRIPT_NPX_PACKAGE} generate -a {application_json} -o {expected_output_path}".split()
+        == f"{npx} --yes {TYPESCRIPT_NPX_PACKAGE} generate -a {application_json} -o {expected_output_path}".split()
     )
 
 
@@ -138,12 +148,21 @@ def test_npx_missing(application_json: Path, which_mock: WhichMock) -> None:
     verify(_normalize_output(result.output))
 
 
-def test_npx_failed(proc_mock: ProcMock, application_json: Path) -> None:
-    proc_mock.should_bad_exit_on(f"/bin/npx --yes {TYPESCRIPT_NPX_PACKAGE} generate -a {application_json} -o client.ts")
+@pytest.mark.usefixtures("mock_platform_system")
+def test_npx_failed(
+    proc_mock: ProcMock,
+    application_json: Path,
+    request: pytest.FixtureRequest,
+) -> None:
+    npx = _get_npx_command()
+    proc_mock.should_bad_exit_on(f"{npx} --yes {TYPESCRIPT_NPX_PACKAGE} generate -a {application_json} -o client.ts")
     result = invoke(f"generate client -o client.ts {application_json.name}", cwd=application_json.parent)
 
     assert result.exit_code == 1
-    verify(_normalize_output(result.output))
+    verify(
+        _normalize_output(result.output),
+        namer=PyTestNamer(request),
+    )
 
 
 def test_generate_client_recursive(cwd: Path, dir_with_app_spec_factory: DirWithAppSpecFactory) -> None:

tests/generate/test_generate_client.test_generate_client_typescript[linux---output {contract_name}.ts-HelloWorldApp.ts].approved.txt

@@ -0,0 +1,4 @@
+Generating TypeScript client code for application specified in {current_working_directory}/application.json and writing to HelloWorldApp.ts
+DEBUG: Running 'npx --yes {typed_client_package} generate -a {current_working_directory}/application.json -o HelloWorldApp.ts' in '{current_working_directory}'
+DEBUG: npx: STDOUT
+DEBUG: npx: STDERR

tests/generate/test_generate_client.test_generate_client_typescript[linux--l typescript-HelloWorldAppClient.ts].approved.txt

@@ -0,0 +1,4 @@
+Generating TypeScript client code for application specified in {current_working_directory}/application.json and writing to HelloWorldAppClient.ts
+DEBUG: Running 'npx --yes {typed_client_package} generate -a {current_working_directory}/application.json -o HelloWorldAppClient.ts' in '{current_working_directory}'
+DEBUG: npx: STDOUT
+DEBUG: npx: STDERR

tests/generate/test_generate_client.test_generate_client_typescript[linux--o client.py --language typescript-client.py].approved.txt

@@ -0,0 +1,4 @@
+Generating TypeScript client code for application specified in {current_working_directory}/application.json and writing to client.py
+DEBUG: Running 'npx --yes {typed_client_package} generate -a {current_working_directory}/application.json -o client.py' in '{current_working_directory}'
+DEBUG: npx: STDOUT
+DEBUG: npx: STDERR

tests/generate/test_generate_client.test_generate_client_typescript[linux--o client.ts-client.ts].approved.txt

@@ -0,0 +1,4 @@
+Generating TypeScript client code for application specified in {current_working_directory}/application.json and writing to client.ts
+DEBUG: Running 'npx --yes {typed_client_package} generate -a {current_working_directory}/application.json -o client.ts' in '{current_working_directory}'
+DEBUG: npx: STDOUT
+DEBUG: npx: STDERR

tests/generate/test_generate_client.test_generate_client_typescript[macOS---output {contract_name}.ts-HelloWorldApp.ts].approved.txt

@@ -0,0 +1,4 @@
+Generating TypeScript client code for application specified in {current_working_directory}/application.json and writing to HelloWorldApp.ts
+DEBUG: Running 'npx --yes {typed_client_package} generate -a {current_working_directory}/application.json -o HelloWorldApp.ts' in '{current_working_directory}'
+DEBUG: npx: STDOUT
+DEBUG: npx: STDERR

tests/generate/test_generate_client.test_generate_client_typescript[macOS--l typescript-HelloWorldAppClient.ts].approved.txt

@@ -0,0 +1,4 @@
+Generating TypeScript client code for application specified in {current_working_directory}/application.json and writing to HelloWorldAppClient.ts
+DEBUG: Running 'npx --yes {typed_client_package} generate -a {current_working_directory}/application.json -o HelloWorldAppClient.ts' in '{current_working_directory}'
+DEBUG: npx: STDOUT
+DEBUG: npx: STDERR

tests/generate/test_generate_client.test_generate_client_typescript[macOS--o client.py --language typescript-client.py].approved.txt

@@ -0,0 +1,4 @@
+Generating TypeScript client code for application specified in {current_working_directory}/application.json and writing to client.py
+DEBUG: Running 'npx --yes {typed_client_package} generate -a {current_working_directory}/application.json -o client.py' in '{current_working_directory}'
+DEBUG: npx: STDOUT
+DEBUG: npx: STDERR

tests/generate/test_generate_client.test_generate_client_typescript[macOS--o client.ts-client.ts].approved.txt

@@ -0,0 +1,4 @@
+Generating TypeScript client code for application specified in {current_working_directory}/application.json and writing to client.ts
+DEBUG: Running 'npx --yes {typed_client_package} generate -a {current_working_directory}/application.json -o client.ts' in '{current_working_directory}'
+DEBUG: npx: STDOUT
+DEBUG: npx: STDERR

tests/generate/test_generate_client.test_generate_client_typescript[windows---output {contract_name}.ts-HelloWorldApp.ts].approved.txt

@@ -0,0 +1,4 @@
+Generating TypeScript client code for application specified in {current_working_directory}/application.json and writing to HelloWorldApp.ts
+DEBUG: Running 'npx.cmd --yes {typed_client_package} generate -a {current_working_directory}/application.json -o HelloWorldApp.ts' in '{current_working_directory}'
+DEBUG: npx.cmd: STDOUT
+DEBUG: npx.cmd: STDERR

tests/generate/test_generate_client.test_generate_client_typescript[windows--l typescript-HelloWorldAppClient.ts].approved.txt

@@ -0,0 +1,4 @@
+Generating TypeScript client code for application specified in {current_working_directory}/application.json and writing to HelloWorldAppClient.ts
+DEBUG: Running 'npx.cmd --yes {typed_client_package} generate -a {current_working_directory}/application.json -o HelloWorldAppClient.ts' in '{current_working_directory}'
+DEBUG: npx.cmd: STDOUT
+DEBUG: npx.cmd: STDERR

tests/generate/test_generate_client.test_generate_client_typescript[windows--o client.py --language typescript-client.py].approved.txt

@@ -0,0 +1,4 @@
+Generating TypeScript client code for application specified in {current_working_directory}/application.json and writing to client.py
+DEBUG: Running 'npx.cmd --yes {typed_client_package} generate -a {current_working_directory}/application.json -o client.py' in '{current_working_directory}'
+DEBUG: npx.cmd: STDOUT
+DEBUG: npx.cmd: STDERR

tests/generate/test_generate_client.test_generate_client_typescript[windows--o client.ts-client.ts].approved.txt

@@ -0,0 +1,4 @@
+Generating TypeScript client code for application specified in {current_working_directory}/application.json and writing to client.ts
+DEBUG: Running 'npx.cmd --yes {typed_client_package} generate -a {current_working_directory}/application.json -o client.ts' in '{current_working_directory}'
+DEBUG: npx.cmd: STDOUT
+DEBUG: npx.cmd: STDERR

tests/generate/test_generate_client.test_npx_failed.approved.txt → tests/generate/test_generate_client.test_npx_failed[linux].approved.txt

@@ -1,5 +1,5 @@
 Generating TypeScript client code for application specified in {current_working_directory}/application.json and writing to client.ts
-DEBUG: Running '/bin/npx --yes {typed_client_package} generate -a {current_working_directory}/application.json -o client.ts' in '{current_working_directory}'
-DEBUG: /bin/npx: STDOUT
-DEBUG: /bin/npx: STDERR
+DEBUG: Running 'npx --yes {typed_client_package} generate -a {current_working_directory}/application.json -o client.ts' in '{current_working_directory}'
+DEBUG: npx: STDOUT
+DEBUG: npx: STDERR
 Error: Client generation failed for {current_working_directory}/application.json.

tests/generate/test_generate_client.test_npx_failed[macOS].approved.txt

@@ -0,0 +1,5 @@
+Generating TypeScript client code for application specified in {current_working_directory}/application.json and writing to client.ts
+DEBUG: Running 'npx --yes {typed_client_package} generate -a {current_working_directory}/application.json -o client.ts' in '{current_working_directory}'
+DEBUG: npx: STDOUT
+DEBUG: npx: STDERR
+Error: Client generation failed for {current_working_directory}/application.json.

tests/generate/test_generate_client.test_npx_failed[windows].approved.txt

@@ -0,0 +1,5 @@
+Generating TypeScript client code for application specified in {current_working_directory}/application.json and writing to client.ts
+DEBUG: Running 'npx.cmd --yes {typed_client_package} generate -a {current_working_directory}/application.json -o client.ts' in '{current_working_directory}'
+DEBUG: npx.cmd: STDOUT
+DEBUG: npx.cmd: STDERR
+Error: Client generation failed for {current_working_directory}/application.json.