Check envd version before building images (#2122)

Signed-off-by: Kevin Su <[email protected]>

flytekit/image_spec/image_spec.py

@@ -7,10 +7,14 @@
 from abc import abstractmethod
 from dataclasses import asdict, dataclass
 from functools import lru_cache
+from importlib import metadata
 from typing import List, Optional, Union
 
 import click
 import requests
+from packaging.version import Version
+
+from flytekit.exceptions.user import FlyteAssertion
 
 DOCKER_HUB = "docker.io"
 _F_IMG_ID = "_F_IMG_ID"
@@ -206,6 +210,16 @@ def build(cls, image_spec: ImageSpec):
             click.secho(f"Image {img_name} not found. Building...", fg="blue")
             if image_spec.builder not in cls._REGISTRY:
                 raise Exception(f"Builder {image_spec.builder} is not registered.")
+            if image_spec.builder == "envd":
+                envd_version = metadata.version("envd")
+                # flytekit v1.10.2+ copies the workflow code to the WorkDir specified in the Dockerfile. However, envd<0.3.39
+                # overwrites the WorkDir when building the image, resulting in a permission issue when flytekit downloads the file.
+                if Version(envd_version) < Version("0.3.39"):
+                    raise FlyteAssertion(
+                        f"envd version {envd_version} is not compatible with flytekit>v1.10.2."
+                        f" Please upgrade envd to v0.3.39+."
+                    )
+
             cls._REGISTRY[image_spec.builder].build_image(image_spec)
             cls._BUILT_IMAGES.add(img_name)
 

plugins/flytekit-envd/flytekitplugins/envd/image_builder.py

@@ -1,8 +1,8 @@
-import json
 import os
 import pathlib
 import shutil
 import subprocess
+from importlib import metadata
 
 import click
 from packaging.version import Version
@@ -108,9 +108,7 @@ def build():
     if image_spec.source_root:
         shutil.copytree(image_spec.source_root, pathlib.Path(cfg_path).parent, dirs_exist_ok=True)
 
-        version_command = "envd version -s -f json"
-        envd_version = json.loads(EnvdImageSpecBuilder().execute_command(version_command)[0])["envd"].replace("v", "")
-
+        envd_version = metadata.version("envd")
         # Indentation is required by envd
         if Version(envd_version) <= Version("0.3.37"):
             envd_config += '    io.copy(host_path="./", envd_path="/root")'