backwards compatibility

Author: SeungjinYang

sky/global_user_state.py

@@ -1783,6 +1783,10 @@ def get_clusters(
             'workspace': row.workspace,
             'is_managed': bool(row.is_managed),
             'config_hash': row.config_hash,
+            # TODO (syang) We still need to return this field for backwards
+            # compatibility.
+            # Remove this field at or after v0.10.7 or v0.11.0
+            'storage_mounts_metadata': None,
         }
         if not summary_response:
             record['last_creation_yaml'] = row.last_creation_yaml

sky/schemas/api/responses.py

@@ -98,8 +98,11 @@ class StatusResponse(ResponseBaseModel):
     # metadata is a JSON, so we use Any here.
     metadata: Optional[Dict[str, Any]] = None
     cluster_hash: str
-    # pydantic cannot generate the pydantic-core schema for
-    # storage_mounts_metadata, so we use Any here.
+    # This field has been deprecated and always returns None.
+    # Itwill be removed in the future.
+    # Remove this field at or after v0.10.7 or v0.11.0
+    # TODO (syang) We still need to return this field for backwards
+    # compatibility so the encoder can still encode this field.
     storage_mounts_metadata: Optional[Dict[str, Any]] = None
     cluster_ever_up: bool
     status_updated_at: int

sky/server/requests/serializers/decoders.py

@@ -60,14 +60,12 @@ def decode_status(
         if 'handle' in cluster and cluster['handle'] is not None:
             cluster['handle'] = decode_and_unpickle(cluster['handle'])
         cluster['status'] = status_lib.ClusterStatus(cluster['status'])
-        # this field is to be deprecated in the future.
-        # do not decode this field if it is not present.
-        if ('storage_mounts_metadata' in cluster and
-                cluster['storage_mounts_metadata'] is not None):
-            cluster['storage_mounts_metadata'] = decode_and_unpickle(
-                cluster['storage_mounts_metadata'])
         if 'is_managed' not in cluster:
             cluster['is_managed'] = False
+        # TODO (syang) remove this code after the field is removed from
+        # the response, at or after v0.10.7 or v0.11.0
+        if 'storage_mounts_metadata' in cluster:
+            del cluster['storage_mounts_metadata']
         response.append(responses.StatusResponse.model_validate(cluster))
     return response
 

sky/server/requests/serializers/encoders.py

@@ -65,6 +65,9 @@ def encode_status(
         handle = serialize_utils.prepare_handle_for_backwards_compatibility(
             cluster['handle'])
         response_cluster['handle'] = pickle_and_encode(handle)
+        # TODO (syang) We still need to return this field for backwards
+        # compatibility.
+        # Remove this field at or after v0.10.7 or v0.11.0
         response_cluster['storage_mounts_metadata'] = pickle_and_encode(
             response_cluster['storage_mounts_metadata'])
         response.append(response_cluster)