Changes for AWS support

config.template.toml

@@ -37,7 +37,7 @@ workspace_base = "./workspace"
 #save_trajectory_path="./trajectories"
 
 # File store path
-#file_store_path = "/tmp/file_store"
+#file_store_location = "/tmp/file_store"
 
 # File store type
 #file_store = "memory"

containers/app/Dockerfile

@@ -43,8 +43,8 @@ ENV WORKSPACE_BASE=/opt/workspace_base
 ENV OPENHANDS_BUILD_VERSION=$OPENHANDS_BUILD_VERSION
 ENV SANDBOX_USER_ID=0
 ENV FILE_STORE=local
-ENV FILE_STORE_PATH=/.openhands-state
-RUN mkdir -p $FILE_STORE_PATH
+ENV FILE_STORE_LOCATION=/.openhands-state
+RUN mkdir -p $FILE_STORE_LOCATION
 RUN mkdir -p $WORKSPACE_BASE
 
 RUN apt-get update -y \

docs/i18n/fr/docusaurus-plugin-content-docs/current/usage/configuration-options.md

@@ -98,7 +98,7 @@ Les options de configuration de base sont définies dans la section `[core]` du
   - Description : Chemin pour stocker les trajectoires (peut être un dossier ou un fichier). Si c'est un dossier, les trajectoires seront enregistrées dans un fichier nommé avec l'ID de session et l'extension .json, dans ce dossier.
 
 **Stockage de fichiers**
-- `file_store_path`
+- `file_store_location`
   - Type : `str`
   - Valeur par défaut : `"/tmp/file_store"`
   - Description : Chemin de stockage des fichiers

docs/i18n/fr/docusaurus-plugin-content-docs/current/usage/how-to/persist-session-data.md

@@ -13,6 +13,6 @@ Dans le fichier `config.toml`, spécifiez ce qui suit :
 [core]
 ...
 file_store="local"
-file_store_path="/absolute/path/to/openhands/cache/directory"
+file_store_location="/absolute/path/to/openhands/cache/directory"
 jwt_secret="secretpass"
 ```

docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/usage/configuration-options.md

@@ -97,7 +97,7 @@
   - 描述: 存储轨迹的路径(可以是文件夹或文件)。如果是文件夹,轨迹将保存在该文件夹中以会话 ID 命名的 .json 文件中。
 
 **文件存储**
-- `file_store_path`
+- `file_store_location`
   - 类型: `str`
   - 默认值: `"/tmp/file_store"`
   - 描述: 文件存储路径

docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/usage/how-to/persist-session-data.md

@@ -12,6 +12,6 @@
 [core]
 ...
 file_store="local"
-file_store_path="/absolute/path/to/openhands/cache/directory"
+file_store_location="/absolute/path/to/openhands/cache/directory"
 jwt_secret="secretpass"
 ```

docs/modules/usage/configuration-options.md

@@ -56,7 +56,7 @@ The core configuration options are defined in the `[core]` section of the `confi
   - Description: Path to store trajectories (can be a folder or a file). If it's a folder, the trajectories will be saved in a file named with the session id name and .json extension, in that folder.
 
 ### File Store
-- `file_store_path`
+- `file_store_location`
   - Type: `str`
   - Default: `"/tmp/file_store"`
   - Description: File store path

openhands/core/config/app_config.py

@@ -26,7 +26,7 @@ class AppConfig:
         sandbox: Sandbox configuration settings.
         runtime: Runtime environment identifier.
         file_store: Type of file store to use.
-        file_store_path: Path to the file store.
+        file_store_location: Path to the file store.
         save_trajectory_path: Either a folder path to store trajectories with auto-generated filenames, or a designated trajectory file path.
         workspace_base: Base path for the workspace. Defaults to `./workspace` as absolute path.
         workspace_mount_path: Path to mount the workspace. Defaults to `workspace_base`.
@@ -53,7 +53,7 @@ class AppConfig:
     security: SecurityConfig = field(default_factory=SecurityConfig)
     runtime: str = 'docker'
     file_store: str = 'local'
-    file_store_path: str = '/tmp/openhands_file_store'
+    file_store_location: str = '/tmp/openhands_file_store'
     save_trajectory_path: str | None = None
     workspace_base: str | None = None
     workspace_mount_path: str | None = None

openhands/core/config/utils.py

@@ -278,7 +278,7 @@ def finalize_config(cfg: AppConfig):
 
     if not cfg.jwt_secret:
         cfg.jwt_secret = get_or_create_jwt_secret(
-            get_file_store(cfg.file_store, cfg.file_store_path)
+            get_file_store(cfg.file_store, cfg.file_store_location)
         )
 
 

openhands/core/setup.py

@@ -37,7 +37,7 @@ def create_runtime(
     session_id = sid or generate_sid(config)
 
     # set up the event stream
-    file_store = get_file_store(config.file_store, config.file_store_path)
+    file_store = get_file_store(config.file_store, config.file_store_location)
     event_stream = EventStream(session_id, file_store)
 
     # agent class

openhands/server/shared.py

@@ -12,7 +12,7 @@
 
 config = load_app_config()
 openhands_config = load_openhands_config()
-file_store = get_file_store(config.file_store, config.file_store_path)
+file_store = get_file_store(config.file_store, config.file_store_location)
 
 client_manager = None
 redis_host = os.environ.get('REDIS_HOST')

openhands/storage/__init__.py

@@ -2,16 +2,21 @@
 from openhands.storage.google_cloud import GoogleCloudFileStore
 from openhands.storage.local import LocalFileStore
 from openhands.storage.memory import InMemoryFileStore
+from openhands.storage.minio import MinioFileStore
 from openhands.storage.s3 import S3FileStore
 
 
-def get_file_store(file_store: str, file_store_path: str | None = None) -> FileStore:
+def get_file_store(
+    file_store: str, file_store_location: str | None = None
+) -> FileStore:
     if file_store == 'local':
-        if file_store_path is None:
-            raise ValueError('file_store_path is required for local file store')
-        return LocalFileStore(file_store_path)
+        if file_store_location is None:
+            raise ValueError('file_store_location is required for local file store')
+        return LocalFileStore(file_store_location)
+    elif file_store == 'minio':
+        return MinioFileStore()
     elif file_store == 's3':
-        return S3FileStore()
+        return S3FileStore(file_store_location)
     elif file_store == 'google_cloud':
-        return GoogleCloudFileStore(file_store_path)
+        return GoogleCloudFileStore(file_store_location)
     return InMemoryFileStore()

openhands/storage/conversation/file_conversation_store.py

@@ -94,7 +94,7 @@ def get_conversation_metadata_filename(self, conversation_id: str) -> str:
     async def get_instance(
         cls, config: AppConfig, user_id: str | None
     ) -> FileConversationStore:
-        file_store = get_file_store(config.file_store, config.file_store_path)
+        file_store = get_file_store(config.file_store, config.file_store_location)
         return FileConversationStore(file_store)
 
 

openhands/storage/minio.py

@@ -0,0 +1,50 @@
+import io
+import os
+
+from minio import Minio
+
+from openhands.storage.files import FileStore
+
+
+class MinioFileStore(FileStore):
+    def __init__(self) -> None:
+        access_key = os.getenv('AWS_ACCESS_KEY_ID')
+        secret_key = os.getenv('AWS_SECRET_ACCESS_KEY')
+        endpoint = os.getenv('AWS_S3_ENDPOINT', 's3.amazonaws.com')
+        secure = os.getenv('AWS_S3_SECURE', 'true').lower() == 'true'
+        self.bucket = os.getenv('AWS_S3_BUCKET')
+        self.client = Minio(endpoint, access_key, secret_key, secure=secure)
+
+    def write(self, path: str, contents: str | bytes) -> None:
+        as_bytes = contents.encode('utf-8') if isinstance(contents, str) else contents
+        stream = io.BytesIO(as_bytes)
+        try:
+            self.client.put_object(self.bucket, path, stream, len(as_bytes))
+        except Exception as e:
+            raise FileNotFoundError(f'Failed to write to S3 at path {path}: {e}')
+
+    def read(self, path: str) -> str:
+        try:
+            return self.client.get_object(self.bucket, path).data.decode('utf-8')
+        except Exception as e:
+            raise FileNotFoundError(f'Failed to read from S3 at path {path}: {e}')
+
+    def list(self, path: str) -> list[str]:
+        if path and path != '/' and not path.endswith('/'):
+            path += '/'
+        try:
+            return [
+                obj.object_name for obj in self.client.list_objects(self.bucket, path)
+            ]
+        except Exception as e:
+            raise FileNotFoundError(f'Failed to list S3 objects at path {path}: {e}')
+
+    def delete(self, path: str) -> None:
+        try:
+            client = self.client
+            bucket = self.bucket
+            objects_to_delete = client.list_objects(bucket, prefix=path, recursive=True)
+            for obj in objects_to_delete:
+                client.remove_object(bucket, obj.object_name)
+        except Exception as e:
+            raise FileNotFoundError(f'Failed to delete S3 object at path {path}: {e}')

openhands/storage/s3.py

@@ -1,50 +1,110 @@
-import io
 import os
+from typing import Optional
 
-from minio import Minio
+import boto3
+import botocore
 
 from openhands.storage.files import FileStore
 
 
 class S3FileStore(FileStore):
-    def __init__(self) -> None:
-        access_key = os.getenv('AWS_ACCESS_KEY_ID')
-        secret_key = os.getenv('AWS_SECRET_ACCESS_KEY')
-        endpoint = os.getenv('AWS_S3_ENDPOINT', 's3.amazonaws.com')
-        secure = os.getenv('AWS_S3_SECURE', 'true').lower() == 'true'
-        self.bucket = os.getenv('AWS_S3_BUCKET')
-        self.client = Minio(endpoint, access_key, secret_key, secure=secure)
+    def __init__(self, bucket_name: Optional[str] = None) -> None:
+        if bucket_name is None:
+            bucket_name = os.environ['FILE_STORE_BUCKET']
+        self.bucket = bucket_name
+        self.client = boto3.client('s3')
 
     def write(self, path: str, contents: str | bytes) -> None:
-        as_bytes = contents.encode('utf-8') if isinstance(contents, str) else contents
-        stream = io.BytesIO(as_bytes)
         try:
-            self.client.put_object(self.bucket, path, stream, len(as_bytes))
-        except Exception as e:
-            raise FileNotFoundError(f'Failed to write to S3 at path {path}: {e}')
+            as_bytes = (
+                contents.encode('utf-8') if isinstance(contents, str) else contents
+            )
+            self.client.put_object(Bucket=self.bucket, Key=path, Body=as_bytes)
+        except botocore.exceptions.ClientError as e:
+            if e.response['Error']['Code'] == 'AccessDenied':
+                raise FileNotFoundError(
+                    f"Error: Access denied to bucket '{self.bucket}'."
+                )
+            elif e.response['Error']['Code'] == 'NoSuchBucket':
+                raise FileNotFoundError(
+                    f"Error: The bucket '{self.bucket}' does not exist."
+                )
+            raise FileNotFoundError(
+                f"Error: Failed to write to bucket '{self.bucket}' at path {path}: {e}"
+            )
 
     def read(self, path: str) -> str:
         try:
-            return self.client.get_object(self.bucket, path).data.decode('utf-8')
+            response = self.client.get_object(Bucket=self.bucket, Key=path)
+            return response['Body'].read().decode('utf-8')
+        except botocore.exceptions.ClientError as e:
+            # Catch all S3-related errors
+            if e.response['Error']['Code'] == 'NoSuchBucket':
+                raise FileNotFoundError(
+                    f"Error: The bucket '{self.bucket}' does not exist."
+                )
+            elif e.response['Error']['Code'] == 'NoSuchKey':
+                raise FileNotFoundError(
+                    f"Error: The object key '{path}' does not exist in bucket '{self.bucket}'."
+                )
+            else:
+                raise FileNotFoundError(
+                    f"Error: Failed to read from bucket '{self.bucket}' at path {path}: {e}"
+                )
         except Exception as e:
-            raise FileNotFoundError(f'Failed to read from S3 at path {path}: {e}')
+            raise FileNotFoundError(
+                f"Error: Failed to read from bucket '{self.bucket}' at path {path}: {e}"
+            )
 
     def list(self, path: str) -> list[str]:
         if path and path != '/' and not path.endswith('/'):
             path += '/'
         try:
-            return [
-                obj.object_name for obj in self.client.list_objects(self.bucket, path)
-            ]
+            response = self.client.list_objects_v2(Bucket=self.bucket, Prefix=path)
+            # Check if 'Contents' exists in the response
+            if 'Contents' in response:
+                objects = [obj['Key'] for obj in response['Contents']]
+                return objects
+            else:
+                return list()
+        except botocore.exceptions.ClientError as e:
+            # Catch all S3-related errors
+            if e.response['Error']['Code'] == 'NoSuchBucket':
+                raise FileNotFoundError(
+                    f"Error: The bucket '{self.bucket}' does not exist."
+                )
+            elif e.response['Error']['Code'] == 'AccessDenied':
+                raise FileNotFoundError(
+                    f"Error: Access denied to bucket '{self.bucket}'."
+                )
+            else:
+                raise FileNotFoundError(f"Error: {e.response['Error']['Message']}")
         except Exception as e:
-            raise FileNotFoundError(f'Failed to list S3 objects at path {path}: {e}')
+            raise FileNotFoundError(
+                f"Error: Failed to read from bucket '{self.bucket}' at path {path}: {e}"
+            )
 
     def delete(self, path: str) -> None:
         try:
-            client = self.client
-            bucket = self.bucket
-            objects_to_delete = client.list_objects(bucket, prefix=path, recursive=True)
-            for obj in objects_to_delete:
-                client.remove_object(bucket, obj.object_name)
+            self.client.delete_object(Bucket=self.bucket, Key=path)
+        except botocore.exceptions.ClientError as e:
+            if e.response['Error']['Code'] == 'NoSuchBucket':
+                raise FileNotFoundError(
+                    f"Error: The bucket '{self.bucket}' does not exist."
+                )
+            elif e.response['Error']['Code'] == 'AccessDenied':
+                raise FileNotFoundError(
+                    f"Error: Access denied to bucket '{self.bucket}'."
+                )
+            elif e.response['Error']['Code'] == 'NoSuchKey':
+                raise FileNotFoundError(
+                    f"Error: The object key '{path}' does not exist in bucket '{self.bucket}'."
+                )
+            else:
+                raise FileNotFoundError(
+                    f"Error: Failed to delete key '{path}' from bucket '{self.bucket}': {e}"
+                )
         except Exception as e:
-            raise FileNotFoundError(f'Failed to delete S3 object at path {path}: {e}')
+            raise FileNotFoundError(
+                f"Error: Failed to delete key '{path}' from bucket '{self.bucket}: {e}"
+            )

openhands/storage/settings/file_settings_store.py

@@ -33,5 +33,5 @@ async def store(self, settings: Settings):
     async def get_instance(
         cls, config: AppConfig, user_id: str | None
     ) -> FileSettingsStore:
-        file_store = get_file_store(config.file_store, config.file_store_path)
+        file_store = get_file_store(config.file_store, config.file_store_location)
         return FileSettingsStore(file_store)

tests/runtime/conftest.py

@@ -258,7 +258,7 @@ def _load_runtime(
         config.sandbox.base_container_image = base_container_image
         config.sandbox.runtime_container_image = None
 
-    file_store = get_file_store(config.file_store, config.file_store_path)
+    file_store = get_file_store(config.file_store, config.file_store_location)
     event_stream = EventStream(sid, file_store)
 
     runtime = runtime_cls(

tests/unit/test_agent_controller.py

@@ -132,7 +132,7 @@ async def test_react_to_exception(mock_agent, mock_event_stream, mock_status_cal
 @pytest.mark.asyncio
 async def test_run_controller_with_fatal_error():
     config = AppConfig()
-    file_store = get_file_store(config.file_store, config.file_store_path)
+    file_store = get_file_store(config.file_store, config.file_store_location)
     event_stream = EventStream(sid='test', file_store=file_store)
 
     agent = MagicMock(spec=Agent)

tests/unit/test_file_settings_store.py

@@ -66,7 +66,7 @@ async def test_store_and_load_data(file_settings_store):
 
 @pytest.mark.asyncio
 async def test_get_instance():
-    config = AppConfig(file_store='local', file_store_path='/test/path')
+    config = AppConfig(file_store='local', file_store_location='/test/path')
 
     with patch(
         'openhands.storage.settings.file_settings_store.get_file_store'