Support for deleting deployments

backend/app.py → backend/operate/cli.py

@@ -1,7 +1,7 @@
 # -*- coding: utf-8 -*-
 # ------------------------------------------------------------------------------
 #
-#   Copyright 2023 Valory AG
+#   Copyright 2024 Valory AG
 #
 #   Licensed under the Apache License, Version 2.0 (the "License");
 #   you may not use this file except in compliance with the License.
@@ -17,14 +17,14 @@
 #
 # ------------------------------------------------------------------------------
 
-"""Operate app entrypoint."""
-
+"""Operate app CLI module."""
 
 import os
+import shutil
 from pathlib import Path
 
 from aea_ledger_ethereum.ethereum import EthereumCrypto
-from clea import command, params, run
+from clea import group, params, run
 from operate.constants import KEY, KEYS, OPERATE, SERVICES
 from operate.http import Resource
 from operate.keys import Keys
@@ -86,15 +86,20 @@ def json(self) -> None:
         }
 
 
-@command(name="operate")
-def _operate(
+@group(name="operate")
+def _operate() -> None:
+    """Operate - deploy autonomous services."""
+
+
+@_operate.command(name="daemon")
+def _daemon(
     host: Annotated[str, params.String(help="HTTP server host string")] = "localhost",
     port: Annotated[int, params.Integer(help="HTTP server port")] = 8000,
     home: Annotated[
-        int, params.Directory(long_flag="--home", help="Home directory")
+        Path, params.Directory(long_flag="--home", help="Home directory")
     ] = None,
 ) -> None:
-    """Operate - deploy autonomous services."""
+    """Launch operate daemon."""
     app = App(home=home)
     uvicorn(
         app=Starlette(
@@ -118,6 +123,28 @@ def _operate(
     )
 
 
+@_operate.command(name="prune")
+def _prune(
+    home: Annotated[
+        Path, params.Directory(long_flag="--home", help="Home directory")
+    ] = None,
+) -> None:
+    """Delete unused/cached data."""
+    app = App(home=home)
+    for service in app.services.json:
+        if service["active"]:
+            continue
+        try:
+            shutil.rmtree(app.services.path / service["hash"])
+            print("Removed service " + service["hash"])
+        except PermissionError:
+            print(
+                "Error removing "
+                + service["hash"]
+                + " please try with admin previledges"
+            )
+
+
 def main() -> None:
     """CLI entry point."""
     run(cli=_operate)

backend/operate/services/manage.py

@@ -144,8 +144,9 @@ async def access(
     def json(self) -> GetServices:
         """Returns the list of available services."""
         data = []
-        for service in self.path.iterdir():
-            data.append(Service.load(path=service).json)
+        for path in self.path.iterdir():
+            service = Service.load(path=path)
+            data.append(service.json)
         return data
 
     def _stake(self) -> None:
@@ -337,12 +338,7 @@ def update(self, data: PutServices) -> ServiceType:
             reuse_multisig=True,
             update_token=old.chain_data["token"],
         )
-
-        # try:
-        #     shutil.rmtree(old.path)
-        # except Exception as e:
-        #     print(e)
-
+        old.delete({})
         return service.json
 
     def delete(self, data: DeleteServicesPayload) -> ServicesType:

backend/operate/services/service.py

@@ -364,13 +364,16 @@ class Service(
     service_path: Path
     path: Path
 
+    _helper: t.Optional[ServiceHelper]
+
     def __init__(
         self,
         service_path: Path,
         phash: str,
         keys: KeysType,
         ledger: t.Optional[LedgerConfig] = None,
         chain_data: t.Optional[ChainData] = None,
+        active: bool = False,
         name: t.Optional[str] = None,
     ) -> None:
         """Initialize object."""
@@ -379,10 +382,18 @@ def __init__(
         self.keys = keys
         self.hash = phash
         self.ledger = ledger
+        self.active = active
         self.service_path = service_path
-        self.helper = ServiceHelper(path=self.service_path)
         self.chain_data = chain_data or {}
         self.path = self.service_path.parent
+        self._helper = None
+
+    @property
+    def helper(self) -> ServiceHelper:
+        """Get service helper."""
+        if self._helper is None:
+            self._helper = ServiceHelper(path=self.service_path)
+        return t.cast(ServiceHelper, self._helper)
 
     def deployment(self) -> Deployment:
         """Load deployment object for the service."""
@@ -416,6 +427,7 @@ def json(self) -> ServiceType:
                 "readme": (
                     readme.read_text(encoding="utf-8") if readme.exists() else None
                 ),
+                "active": self.active,
             }
         )
 
@@ -437,6 +449,7 @@ def load(cls, path: Path) -> "Service":
             chain_data=config.get("chain_data"),
             service_path=Path(config["service_path"]),
             name=config["name"],
+            active=config["active"],
         )
 
     @classmethod
@@ -467,6 +480,7 @@ def new(
             ledger=ledger,
             service_path=Path(downloaded),
             name=name,
+            active=True,
         )
         service.store()
         return service
@@ -485,5 +499,12 @@ def __update(self, data: ServiceType) -> ServiceType:
 
     def delete(self, data: DeleteServicePayload) -> DeleteServiceResponse:
         """Delete service."""
-        shutil.rmtree(self.path)
+        try:
+            shutil.rmtree(self.path)
+        except (PermissionError, OSError):
+            # If we get permission error we set the service in-active
+            # user can then run operate prune with admin priviledges
+            # to clean up the cache/unused data
+            self.active = False
+            self.store()
         return DeleteServiceResponse({})

backend/operate/types.py

@@ -173,6 +173,7 @@ class ServiceType(TypedDict):
     readme: NotRequired[str]
     ledger: NotRequired[LedgerConfig]
     chain_data: NotRequired[ChainData]
+    active: bool
 
 
 ServicesType = t.List[ServiceType]
@@ -245,5 +246,6 @@ class DeployedNodes(TypedDict):
 class DeploymentType(TypedDict):
     """Deployment type."""
 
+    version: int
     status: Status
     nodes: DeployedNodes

backend/pyproject.toml

@@ -5,6 +5,9 @@ description = ""
 authors = ["David Vilela <[email protected]>"]
 readme = "README.md"
 
+[tool.poetry.scripts]
+operate = "operate.cli:main"
+
 [tool.poetry.dependencies]
 python = "^3.10"
 open-autonomy = "^0.14.2"

frontend/client/types.ts

@@ -27,8 +27,9 @@ export type Service = {
   hash: string;
   keys: Keys;
   readme?: string;
-  ledger?: LedgerConfig;
-  chain_data?: ChainData;
+  ledger: LedgerConfig;
+  chain_data: ChainData;
+  active: boolean;
 };
 
 export type ServiceTemplate = {

package.json

@@ -22,7 +22,7 @@
   "private": true,
   "scripts": {
     "build:frontend": "cd frontend && yarn build",
-    "dev:backend": "cd backend && poetry run python app.py",
+    "dev:backend": "cd backend && poetry run python operate/cli.py",
     "dev:frontend": "cd frontend && yarn dev",
     "dev:hardhat": "npx hardhat node",
     "install-deps": "yarn && concurrently \"yarn install:backend\" \"yarn install:frontend\" ",