fastled 1.2.68__tar.gz → 1.2.74__tar.gz

{fastled-1.2.68 → fastled-1.2.74}/Dockerfile

@@ -41,8 +41,8 @@
 
 # This will be set to arm64 to support MacOS M1+ devices (and Linux-based arm64 devices)
 ARG PLATFORM_TAG=""
-# ARG EMSDK_VERSION_TAG="4.0.4"
-ARG EMSDK_VERSION_TAG="3.1.70"
+ARG EMSDK_VERSION_TAG="4.0.8"
+# ARG EMSDK_VERSION_TAG="3.1.70"
 
 # Use only Emscripten base image
 FROM emscripten/emsdk:${EMSDK_VERSION_TAG}${PLATFORM_TAG}

{fastled-1.2.68 → fastled-1.2.74}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: fastled
-Version: 1.2.68
+Version: 1.2.74
 Summary: FastLED Wasm Compiler
 Home-page: https://github.com/zackees/fastled-wasm
 Maintainer: Zachary Vorhies

{fastled-1.2.68 → fastled-1.2.74}/compiler/compile.py

@@ -89,6 +89,33 @@ def copy_files(src_dir: Path, js_src: Path) -> None:
             shutil.copy2(item, js_src / item.name)
 
 
+def _banner(msg: str) -> str:
+    """
+    Create a banner for the given message.
+    Example:
+    msg = "Hello, World!"
+    print -> "#################"
+             "# Hello, World! #"
+             "#################"
+    """
+    lines = msg.split("\n")
+    # Find the width of the widest line
+    max_width = max(len(line) for line in lines)
+    width = max_width + 4  # Add 4 for "# " and " #"
+
+    # Create the top border
+    banner = "\n" + "#" * width + "\n"
+
+    # Add each line with proper padding
+    for line in lines:
+        padding = max_width - len(line)
+        banner += f"# {line}{' ' * padding} #\n"
+
+    # Add the bottom border
+    banner += "#" * width + "\n"
+    return banner
+
+
 def compile(
     compiler_root: Path, build_mode: BuildMode, auto_clean: bool, no_platformio: bool
 ) -> int:
@@ -96,7 +123,7 @@ def compile(
     max_attempts = 1
     env = os.environ.copy()
     env["BUILD_MODE"] = build_mode.name
-    print(f"Build mode: {build_mode.name}")
+    print(_banner(f"WASM is building in mode: {build_mode.name}"))
     cmd_list: list[str] = []
     if no_platformio:
         # execute build_archive.syh
@@ -113,6 +140,7 @@ def compile(
             cmd_list.append("-v")
 
     def _open_process(cmd_list: list[str] = cmd_list) -> subprocess.Popen:
+        print(_banner("Running command:\n  " + subprocess.list2cmdline(cmd_list)))
         out = subprocess.Popen(
             cmd_list,
             cwd=compiler_root,
@@ -138,7 +166,7 @@ def compile(
             relative_output = _make_timestamps_relative("\n".join(output_lines))
             print(relative_output)
             if process.returncode == 0:
-                print(f"Compilation successful on attempt {attempt}")
+                print(_banner(f"Compilation successful on attempt {attempt}"))
                 return 0
             else:
                 raise subprocess.CalledProcessError(process.returncode, ["pio", "run"])
@@ -199,7 +227,7 @@ def transform_to_cpp(src_dir: Path) -> None:
 def insert_headers(
     src_dir: Path, exclusion_folders: List[Path], file_extensions: List[str]
 ) -> None:
-    print("Inserting headers in source files...")
+    print(_banner("Inserting headers in source files..."))
     for file in src_dir.rglob("*"):
         if (
             file.suffix in file_extensions
@@ -213,7 +241,7 @@ def process_ino_files(src_dir: Path) -> None:
     transform_to_cpp(src_dir)
     exclusion_folders: List[Path] = []
     insert_headers(src_dir, exclusion_folders, _FILE_EXTENSIONS)
-    print("Transform to cpp and insert header operations completed.")
+    print(_banner("Transform to cpp and insert header operations completed."))
 
 
 def _make_timestamps_relative(stdout: str) -> str:
@@ -381,7 +409,7 @@ def process_compile(
     if rtn != 0:
         print("Compilation failed.")
         raise RuntimeError("Compilation failed.")
-    print("Compilation successful.")
+    print(_banner("Compilation successful."))
 
 
 def cleanup(args: Args, js_src: Path) -> None:
@@ -422,9 +450,15 @@ def run(args: Args) -> int:
     print(f"Using mapped directory: {args.mapped_dir}")
 
     if args.profile:
-        print("Enabling profiling for compilation.")
+        print(_banner("Enabling profiling for compilation."))
         # Profile linking
         os.environ["EMPROFILE"] = "2"
+    else:
+        print(
+            _banner(
+                "Build process profiling is disabled\nuse --profile to get metrics on how long the build process took."
+            )
+        )
 
     try:
 
@@ -477,6 +511,8 @@ def run(args: Args) -> int:
                 return 1
 
             def _get_build_dir_platformio() -> Path:
+                # First assert there is only one build artifact directory.
+                # The name is dynamic: it's your sketch folder name.
                 build_dirs = [d for d in PIO_BUILD_DIR.iterdir() if d.is_dir()]
                 if len(build_dirs) != 1:
                     raise RuntimeError(
@@ -493,16 +529,17 @@ def run(args: Args) -> int:
             else:
                 build_dir = _get_build_dir_platformio()
 
-            print("Copying output files...")
+            print(_banner("Copying output files..."))
             out_dir: Path = src_dir / _FASTLED_OUTPUT_DIR_NAME
             out_dir.mkdir(parents=True, exist_ok=True)
 
-            for file in ["fastled.js", "fastled.wasm"]:
-                _src = build_dir / file
-                _dst = out_dir / file
-                print(f"Copying {_src} to {_dst}")
-                shutil.copy2(_src, _dst)
+            # Copy all fastled.* build artifacts
+            for file_path in build_dir.glob("fastled.*"):
+                _dst = out_dir / file_path.name
+                print(f"Copying {file_path} to {_dst}")
+                shutil.copy2(file_path, _dst)
 
+            # Copy static files.
             print(f"Copying {_INDEX_HTML_SRC} to output directory")
             shutil.copy2(_INDEX_HTML_SRC, out_dir / "index.html")
             print(f"Copying {_INDEX_CSS_SRC} to output directory")
@@ -510,23 +547,30 @@ def run(args: Args) -> int:
 
             # copy all js files in _FASTLED_COMPILER_DIR to output directory
             Path(out_dir / "modules").mkdir(parents=True, exist_ok=True)
-            for _file in _FASTLED_MODULES_DIR.iterdir():
-                if _file.suffix == ".js":
-                    print(f"Copying {_file} to output directory")
-                    shutil.copy2(_file, out_dir / "modules" / _file.name)
-
-            fastled_js_mem = build_dir / "fastled.js.mem"
-            fastled_wasm_map = build_dir / "fastled.wasm.map"
-            fastled_js_symbols = build_dir / "fastled.js.symbols"
-            if fastled_js_mem.exists():
-                print(f"Copying {fastled_js_mem} to output directory")
-                shutil.copy2(fastled_js_mem, out_dir / fastled_js_mem.name)
-            if fastled_wasm_map.exists():
-                print(f"Copying {fastled_wasm_map} to output directory")
-                shutil.copy2(fastled_wasm_map, out_dir / fastled_wasm_map.name)
-            if fastled_js_symbols.exists():
-                print(f"Copying {fastled_js_symbols} to output directory")
-                shutil.copy2(fastled_js_symbols, out_dir / fastled_js_symbols.name)
+
+            # Recursively copy all non-hidden files and directories
+            print(f"Copying files from {_FASTLED_MODULES_DIR} to {out_dir / 'modules'}")
+            shutil.copytree(
+                src=_FASTLED_MODULES_DIR,
+                dst=out_dir / "modules",
+                dirs_exist_ok=True,
+                ignore=shutil.ignore_patterns(".*"),
+            )  # Ignore hidden files
+
+            # Now long needed since now we do glob copy.
+            # fastled_js_mem = build_dir / "fastled.js.mem"
+            # fastled_wasm_map = build_dir / "fastled.wasm.map"
+            # fastled_js_symbols = build_dir / "fastled.js.symbols"
+            # if fastled_js_mem.exists():
+            #     print(f"Copying {fastled_js_mem} to output directory")
+            #     shutil.copy2(fastled_js_mem, out_dir / fastled_js_mem.name)
+            # if fastled_wasm_map.exists():
+            #     print(f"Copying {fastled_wasm_map} to output directory")
+            #     shutil.copy2(fastled_wasm_map, out_dir / fastled_wasm_map.name)
+            # if fastled_js_symbols.exists():
+            #     print(f"Copying {fastled_js_symbols} to output directory")
+            # shutil.copy2(fastled_js_symbols, out_dir / fastled_js_symbols.name)
+
             print("Copying index.js to output directory")
             shutil.copy2(_INDEX_JS_SRC, out_dir / "index.js")
             optional_input_data_dir = src_dir / "data"
@@ -546,7 +590,7 @@ def run(args: Args) -> int:
                     if _file.is_file():  # Only copy files, not directories
                         filename: str = _file.name
                         if filename.endswith(".embedded.json"):
-                            print("Embedding data file")
+                            print(_banner("Embedding data file"))
                             filename_no_embedded = filename.replace(
                                 ".embedded.json", ""
                             )
@@ -577,13 +621,13 @@ def run(args: Args) -> int:
                             )
 
             # Write manifest file even if empty
-            print("Writing manifest files.json")
+            print(_banner("Writing manifest files.json"))
             manifest_json_str = json.dumps(manifest, indent=2, sort_keys=True)
             with open(out_dir / "files.json", "w") as f:
                 f.write(manifest_json_str)
         cleanup(args, SKETCH_SRC)
 
-        print("Compilation process completed successfully")
+        print(_banner("Compilation process completed successfully"))
         return 0
 
     except Exception as e:

{fastled-1.2.68 → fastled-1.2.74}/src/fastled/__init__.py

@@ -13,7 +13,7 @@ from .types import BuildMode, CompileResult, CompileServerError
 # IMPORTANT! There's a bug in github which will REJECT any version update
 # that has any other change in the repo. Please bump the version as the
 # ONLY change in a commit, or else the pypi update and the release will fail.
-__version__ = "1.2.68"
+__version__ = "1.2.74"
 
 DOCKER_FILE = (
     "https://raw.githubusercontent.com/zackees/fastled-wasm/refs/heads/main/Dockerfile"

{fastled-1.2.68 → fastled-1.2.74}/src/fastled/app.py

@@ -43,6 +43,8 @@ def run_server(args: Args) -> int:
 
 
 def main() -> int:
+    from fastled import __version__
+
     args = parse_args()
     interactive: bool = args.interactive
     has_server = args.server
@@ -52,6 +54,9 @@ def main() -> int:
     # directory: Path | None = Path(args.directory).absolute() if args.directory else None
     directory: Path | None = Path(args.directory) if args.directory else None
 
+    # now it is safe to print out the version
+    print(f"FastLED version: {__version__}")
+
     if update:
         # Force auto_update to ensure update check happens
         compile_server = CompileServer(interactive=False, auto_updates=True)

{fastled-1.2.68 → fastled-1.2.74}/src/fastled/compile_server_impl.py

@@ -13,6 +13,7 @@ from fastled.docker_manager import (
     Container,
     DockerManager,
     RunningContainer,
+    Volume,
 )
 from fastled.interactive_srcs import INTERACTIVE_SOURCES
 from fastled.settings import DEFAULT_CONTAINER_NAME, IMAGE_NAME, SERVER_PORT
@@ -209,27 +210,32 @@ class CompileServerImpl:
         else:
             server_command = ["python", "/js/run.py", "server"] + SERVER_OPTIONS
         ports = {80: port}
-        volumes = None
+        volumes = []
         if self.fastled_src_dir:
             print(
                 f"Mounting FastLED source directory {self.fastled_src_dir} into container /host/fastled/src"
             )
-            volumes = {
-                str(self.fastled_src_dir): {"bind": "/host/fastled/src", "mode": "ro"}
-            }
+            volumes.append(
+                Volume(
+                    host_path=str(self.fastled_src_dir),
+                    container_path="/host/fastled/src",
+                    mode="ro",
+                )
+            )
         if self.interactive:
             # add the mapped directory to the container
             print(f"Mounting {self.mapped_dir} into container /mapped")
-            # volumes = {str(self.mapped_dir): {"bind": "/mapped", "mode": "rw"}}
-            # add it
             assert self.mapped_dir is not None
             dir_name = self.mapped_dir.name
             if not volumes:
-                volumes = {}
-            volumes[str(self.mapped_dir)] = {
-                "bind": f"/mapped/{dir_name}",
-                "mode": "rw",
-            }
+                volumes = []
+            volumes.append(
+                Volume(
+                    host_path=str(self.mapped_dir),
+                    container_path=f"/mapped/{dir_name}",
+                    mode="rw",
+                )
+            )
             if self.fastled_src_dir is not None:
                 # to allow for interactive compilation
                 interactive_sources = list(INTERACTIVE_SOURCES)
@@ -237,11 +243,13 @@ class CompileServerImpl:
                     src_path = Path(src).absolute()
                     if src_path.exists():
                         print(f"Mounting {src} into container")
-                        src_str = str(src_path)
-                        volumes[src_str] = {
-                            "bind": f"/js/fastled/{src}",
-                            "mode": "rw",
-                        }
+                        volumes.append(
+                            Volume(
+                                host_path=str(src_path),
+                                container_path=f"/js/fastled/{src}",
+                                mode="rw",
+                            )
+                        )
                     else:
                         print(f"Could not find {src}")
 
@@ -277,6 +285,8 @@ class CompileServerImpl:
         return self.docker.is_container_running(self.container_name)
 
     def stop(self) -> None:
+        if self.docker.is_suspended:
+            return
         if self.running_container:
             self.running_container.detach()
             self.running_container = None

{fastled-1.2.68 → fastled-1.2.74}/src/fastled/docker_manager.py

@@ -3,6 +3,7 @@ New abstraction for Docker management with improved Ctrl+C handling.
 """
 
 import _thread
+import json
 import os
 import platform
 import subprocess
@@ -11,6 +12,7 @@ import threading
 import time
 import traceback
 import warnings
+from dataclasses import dataclass
 from datetime import datetime, timezone
 from pathlib import Path
 
@@ -63,8 +65,69 @@ def get_lock(image_name: str) -> FileLock:
     return out
 
 
+@dataclass
+class Volume:
+    """
+    Represents a Docker volume mapping between host and container.
+
+    Attributes:
+        host_path: Path on the host system (e.g., "C:\\Users\\username\\project")
+        container_path: Path inside the container (e.g., "/app/data")
+        mode: Access mode, "rw" for read-write or "ro" for read-only
+    """
+
+    host_path: str
+    container_path: str
+    mode: str = "rw"
+
+    def to_dict(self) -> dict[str, dict[str, str]]:
+        """Convert the Volume object to the format expected by Docker API."""
+        return {self.host_path: {"bind": self.container_path, "mode": self.mode}}
+
+    @classmethod
+    def from_dict(cls, volume_dict: dict[str, dict[str, str]]) -> list["Volume"]:
+        """Create Volume objects from a Docker volume dictionary."""
+        volumes = []
+        for host_path, config in volume_dict.items():
+            volumes.append(
+                cls(
+                    host_path=host_path,
+                    container_path=config["bind"],
+                    mode=config.get("mode", "rw"),
+                )
+            )
+        return volumes
+
+
+class PrintFilter:
+    """Provides filtering for text output so that source files match up with local names."""
+
+    def __init__(self) -> None:
+        pass
+
+    def _remove_ino_cpp(self, text: str) -> str:
+        return text.replace(".ino.cpp", ".ino")
+
+    def _filter_all(self, text: str) -> str:
+        text = self._remove_ino_cpp(text)
+        return text
+
+    def print(self, text: str | bytes) -> None:
+        """Prints the text to the console."""
+        if isinstance(text, bytes):
+            text = text.decode("utf-8")
+        text = self._filter_all(text)
+        print(text, end="")
+
+
 class RunningContainer:
-    def __init__(self, container, first_run=False):
+    def __init__(
+        self,
+        container: Container,
+        first_run: bool = False,
+        filter: PrintFilter | None = None,
+    ) -> None:
+        self.filter = filter or PrintFilter()
         self.container = container
         self.first_run = first_run
         self.running = True
@@ -81,7 +144,8 @@ class RunningContainer:
                 for log in self.container.logs(
                     follow=False, since=from_date, until=to_date, stream=True
                 ):
-                    print(log.decode("utf-8"), end="")
+                    # print(log.decode("utf-8"), end="")
+                    self.filter.print(log)
                 time.sleep(0.1)
                 from_date = to_date
                 to_date = _utc_now_no_tz()
@@ -104,10 +168,46 @@ class RunningContainer:
         self.detach()
 
 
+def _hack_to_fix_mac(volumes: list[Volume] | None) -> list[Volume] | None:
+    """Fixes the volume mounts on MacOS by removing the mode."""
+    if volumes is None:
+        return None
+    if sys.platform != "darwin":
+        # Only macos needs hacking.
+        return volumes
+
+    volumes = volumes.copy()
+    # Work around a Docker bug on MacOS where the expected network socket to the
+    # the host is not mounted correctly. This was actually fixed in recent versions
+    # of docker client but there is a large chunk of Docker clients out there with
+    # this bug in it.
+    #
+    # This hack is done by mounting the socket directly to the container.
+    # This socket talks to the docker daemon on the host.
+    #
+    # Found here.
+    # https://github.com/docker/docker-py/issues/3069#issuecomment-1316778735
+    # if it exists already then return the input
+    for volume in volumes:
+        if volume.host_path == "/var/run/docker.sock":
+            return volumes
+    # ok it doesn't exist, so add it
+    volumes.append(
+        Volume(
+            host_path="/var/run/docker.sock",
+            container_path="/var/run/docker.sock",
+            mode="rw",
+        )
+    )
+    return volumes
+
+
 class DockerManager:
     def __init__(self) -> None:
         from docker.errors import DockerException
 
+        self.is_suspended: bool = False
+
         try:
             self._client: DockerClient | None = None
             self.first_run = False
@@ -314,8 +414,6 @@ class DockerManager:
 
                     # Quick check for latest version
                     with Spinner(f"Pulling newer version of {image_name}:{tag}..."):
-                        # This needs to be swapped out using the the command line interface AI!
-                        # _ = self.client.images.pull(image_name, tag=tag)
                         cmd_list = ["docker", "pull", f"{image_name}:{tag}"]
                         cmd_str = subprocess.list2cmdline(cmd_list)
                         print(f"Running command: {cmd_str}")
@@ -355,8 +453,8 @@ class DockerManager:
         self,
         container: Container,
         command: str | None,
-        volumes: dict | None,
-        ports: dict | None,
+        volumes_dict: dict[str, dict[str, str]] | None,
+        ports: dict[int, int] | None,
     ) -> bool:
         """Compare if existing container has matching configuration"""
         try:
@@ -386,7 +484,7 @@ class DockerManager:
                 return False
 
             # Check volumes if specified
-            if volumes:
+            if volumes_dict:
                 container_mounts = (
                     {
                         m["Source"]: {"bind": m["Destination"], "mode": m["Mode"]}
@@ -396,7 +494,7 @@ class DockerManager:
                     else {}
                 )
 
-                for host_dir, mount in volumes.items():
+                for host_dir, mount in volumes_dict.items():
                     if host_dir not in container_mounts:
                         print(f"Volume {host_dir} not found in container mounts.")
                         return False
@@ -446,7 +544,7 @@ class DockerManager:
         tag: str,
         container_name: str,
         command: str | None = None,
-        volumes: dict[str, dict[str, str]] | None = None,
+        volumes: list[Volume] | None = None,
         ports: dict[int, int] | None = None,
         remove_previous: bool = False,
     ) -> Container:
@@ -455,11 +553,23 @@ class DockerManager:
         If it exists with different config, remove and recreate it.
 
         Args:
-            volumes: Dict mapping host paths to dicts with 'bind' and 'mode' keys
-                    Example: {'/host/path': {'bind': '/container/path', 'mode': 'rw'}}
+            volumes: List of Volume objects for container volume mappings
             ports: Dict mapping host ports to container ports
                     Example: {8080: 80} maps host port 8080 to container port 80
         """
+        volumes = _hack_to_fix_mac(volumes)
+        # Convert volumes to the format expected by Docker API
+        volumes_dict = None
+        if volumes is not None:
+            volumes_dict = {}
+            for volume in volumes:
+                volumes_dict.update(volume.to_dict())
+
+        # Serialize the volumes to a json string
+        if volumes_dict:
+            volumes_str = json.dumps(volumes_dict)
+            print(f"Volumes: {volumes_str}")
+            print("Done")
         image_name = f"{image_name}:{tag}"
         try:
             container: Container = self.client.containers.get(container_name)
@@ -469,7 +579,9 @@ class DockerManager:
                 container.remove(force=True)
                 raise NotFound("Container removed due to remove_previous")
             # Check if configuration matches
-            elif not self._container_configs_match(container, command, volumes, ports):
+            elif not self._container_configs_match(
+                container, command, volumes_dict, ports
+            ):
                 print(
                     f"Container {container_name} exists but with different configuration. Removing and recreating..."
                 )
@@ -517,7 +629,7 @@ class DockerManager:
                 name=container_name,
                 detach=True,
                 tty=True,
-                volumes=volumes,
+                volumes=volumes_dict,
                 ports=ports,  # type: ignore
                 remove=True,
             )
@@ -529,9 +641,16 @@ class DockerManager:
         tag: str,
         container_name: str,
         command: str | None = None,
-        volumes: dict[str, dict[str, str]] | None = None,
+        volumes: list[Volume] | None = None,
         ports: dict[int, int] | None = None,
     ) -> None:
+        # Convert volumes to the format expected by Docker API
+        volumes = _hack_to_fix_mac(volumes)
+        volumes_dict = None
+        if volumes is not None:
+            volumes_dict = {}
+            for volume in volumes:
+                volumes_dict.update(volume.to_dict())
         # Remove existing container
         try:
             container: Container = self.client.containers.get(container_name)
@@ -548,9 +667,13 @@ class DockerManager:
                 "--name",
                 container_name,
             ]
-            if volumes:
-                for host_dir, mount in volumes.items():
-                    docker_command.extend(["-v", f"{host_dir}:{mount['bind']}"])
+            if volumes_dict:
+                for host_dir, mount in volumes_dict.items():
+                    docker_volume_arg = [
+                        "-v",
+                        f"{host_dir}:{mount['bind']}:{mount['mode']}",
+                    ]
+                    docker_command.extend(docker_volume_arg)
             if ports:
                 for host_port, container_port in ports.items():
                     docker_command.extend(["-p", f"{host_port}:{container_port}"])
@@ -591,6 +714,8 @@ class DockerManager:
         """
         Suspend (pause) the container.
         """
+        if self.is_suspended:
+            return
         if isinstance(container, str):
             container_name = container
             # container = self.get_container(container)