Resolves microsoft#173 - Onboard New Environment API

Author: jmuziki

docs/how_to/optional_feature.md

@@ -6,17 +6,19 @@ fabric-cicd has an expected default flow; however, there will always be cases wh
 
 For scenarios that aren't supported by default, fabric-cicd offers `feature-flags`. Below is an exhaustive list of currently supported features.
 
-| Flag Name                    | Description                                         |
-| ---------------------------- | --------------------------------------------------- |
-| `enable_lakehouse_unpublish` | Set to enable the deletion of Lakehouses            |
-| `disable_print_identity`     | Set to disable printing the executing identity name |
+| Flag Name                     | Description                                         |
+| ----------------------------- | --------------------------------------------------- |
+| `enable_lakehouse_unpublish`  | Set to enable the deletion of Lakehouses            |
+| `disable_print_identity`      | Set to disable printing the executing identity name |
+| `disable_legacy_environments` | Set to migrate to new Environment API               |
 
 <span class="md-h3-nonanchor">Example</span>
 
 ```python
 from fabric_cicd import append_feature_flag
 append_feature_flag("enable_lakehouse_unpublish")
 append_feature_flag("disable_print_identity")
+append_feature_flag("disable_legacy_environments")
 ```
 
 ## Debugging

src/fabric_cicd/_common/_fabric_endpoint.py

@@ -182,7 +182,7 @@ def _handle_response(
         url = response.headers.get("Location")
         method = "GET"
         body = "{}"
-        response_json = response.json()
+        response_json = response.json() if response.content else None
 
         if long_running:
             status = response_json.get("status")
@@ -204,8 +204,8 @@ def _handle_response(
             else:
                 handle_retry(
                     attempt=iteration_count - 1,
-                    base_delay=0.5,
-                    response_retry_after=retry_after,
+                    base_delay=kwargs.get("base_delay", 0.5),
+                    response_retry_after=kwargs.get("retry_after", retry_after),
                     max_retries=kwargs.get("max_retries", 5),
                     prepend_message="Operation in progress.",
                 )

src/fabric_cicd/_items/_environment.py

@@ -10,7 +10,7 @@
 import dpath
 import yaml
 
-from fabric_cicd import FabricWorkspace
+from fabric_cicd import FabricWorkspace, constants
 from fabric_cicd._common._fabric_endpoint import handle_retry
 from fabric_cicd._parameter._utils import check_parameter_structure
 
@@ -35,7 +35,41 @@ def publish_environments(fabric_workspace_obj: FabricWorkspace) -> None:
             item_type=item_type,
             skip_publish_logging=True,
         )
-        _publish_environment_metadata(fabric_workspace_obj, item_name=item_name)
+
+        if "disable_legacy_environments" in constants.FEATURE_FLAG:
+            item_guid = fabric_workspace_obj.repository_items[item_type][item_name].guid
+            _publish_environment(fabric_workspace_obj, item_guid=item_guid)
+        else:  # TODO: remove this when legacy environments are deprecated
+            logger.warning(
+                """The legacy Microsoft Fabric environments API is being deprecated, the rollout is incremental across regions and should be completed April 12th 2025. \r
+                Use the temporary feature flag below to force a switch to the new API during the rollout period. \r
+                You will be automatically opted into the new API after the deadline: ref-> https://learn.microsoft.com/en-us/fabric/data-engineering/environment-public-api \n
+                >>> from fabric_cicd import append_feature_flag
+                >>> append_feature_flag("disable_legacy_environments")\n"""
+            )
+            _publish_environment_metadata(fabric_workspace_obj, item_name=item_name)
+
+
+def _publish_environment(fabric_workspace_obj: FabricWorkspace, item_guid: str) -> None:
+    """
+    Publishes compute settings and libraries for a given environment item.
+
+    Args:
+        fabric_workspace_obj: The FabricWorkspace object.
+        item_guid: Guid of the environment item whose compute settings are to be published.
+    """
+    logger.info("Publishing Libraries & Spark Settings")
+    # Publish updated settings
+    # https://learn.microsoft.com/en-us/rest/api/fabric/environment/spark-libraries/publish-environment
+    fabric_workspace_obj.endpoint.invoke(
+        method="POST",
+        url=f"{fabric_workspace_obj.base_api_url}/environments/{item_guid}/staging/publish",
+        base_delay=5,
+        retry_after=120,
+        max_retries=20,
+    )
+
+    logger.info("Published")
 
 
 def _publish_environment_metadata(fabric_workspace_obj: FabricWorkspace, item_name: str) -> None:

src/fabric_cicd/fabric_workspace.py

@@ -416,7 +416,10 @@ def _publish_item(
         metadata_body = {"displayName": item_name, "type": item_type}
 
         # Only shell deployment, no definition support
-        shell_only_publish = item_type in constants.SHELL_ONLY_PUBLISH
+        if "disable_legacy_environments" in constants.FEATURE_FLAG:
+            shell_only_publish = item_type in ["Lakehouse"]
+        else:  # TODO: remove this when legacy environments are deprecated
+            shell_only_publish = item_type in ["Environment", "Lakehouse"]
 
         if kwargs.get("creation_payload"):
             creation_payload = {"creationPayload": kwargs["creation_payload"]}