Merge branch 'master' into AmozPay-typer-doc

Author: AmozPay

docker/Dockerfile

@@ -16,11 +16,11 @@ RUN python3.9 -m venv /opt/venv
 ENV PATH="/opt/venv/bin:$PATH"
 ENV PATH="/opt/venv/bin:$PATH"
 
-RUN pip install --upgrade pip wheel
+RUN pip install --upgrade pip wheel twine
 
 # Preinstall dependencies for faster steps
 RUN pip install --upgrade secp256k1 coincurve aiohttp eciespy python-magic typer
-RUN pip install --upgrade aleph-message eth_account pynacl base58
+RUN pip install --upgrade 'aleph-message~=0.2.3' eth_account pynacl base58
 RUN pip install --upgrade pytest pytest-cov pytest-asyncio mypy types-setuptools pytest-asyncio fastapi requests
 
 WORKDIR /opt/aleph-client/

scripts/build-to-publish.sh

@@ -17,4 +17,5 @@ $DOCKER_COMMAND build -t aleph-client -f docker/Dockerfile .
 $DOCKER_COMMAND run -ti --rm \
   -w /opt/aleph-client \
   -v "$(pwd)/dist":/opt/aleph-client/dist \
-  aleph-client bash
+  --entrypoint /bin/bash \
+  aleph-client

setup.cfg

@@ -36,17 +36,14 @@ install_requires =
     eciespy
     typing_extensions
     typer
-    aleph-message@git+https://github.com/aleph-im/aleph-message.git@hoh-new-type-alephmessage
+    aleph-message~=0.2.3
     eth_account>=0.4.0
     python-magic
 # The usage of test_requires is discouraged, see `Dependency Management` docs
 # tests_require = pytest; pytest-cov
 # Require a specific Python version, e.g. Python 2.7 or >= 3.4
 # python_requires = >=2.7,!=3.0.*,!=3.1.*,!=3.2.*,!=3.3.*
 
-dependency_links =
-    https://github.com/aleph-im/aleph-message.git@hoh-new-type-alephmessage#aleph-message
-
 [options.packages.find]
 where = src
 exclude =
@@ -67,7 +64,7 @@ testing =
     base58
     fastapi
     requests
-    aleph-pytezos@git+https://github.com/aleph-im/aleph-pytezos.git@e584ede63c4302c6c22ac1777fda6676655d664a
+    aleph-pytezos==0.1.0
 mqtt =
     aiomqtt
     certifi
@@ -85,7 +82,7 @@ solana =
     base58
 tezos =
     pynacl
-    aleph-pytezos@git+https://github.com/aleph-im/aleph-pytezos.git@e584ede63c4302c6c22ac1777fda6676655d664a
+    aleph-pytezos==0.1.0
 docs =
     sphinxcontrib-plantuml
 

src/aleph_client/asynchronous.py

@@ -24,11 +24,12 @@
     AggregateMessage,
     StoreMessage,
     ProgramMessage,
-    MessagesResponse,
 )
+from pydantic import ValidationError
 
 from aleph_client.types import Account, StorageEnum, GenericMessage
 from .exceptions import MessageNotFoundError, MultipleMessagesError
+from .models import MessagesResponse
 from .utils import get_message_type_value
 
 logger = logging.getLogger(__name__)
@@ -308,6 +309,7 @@ async def create_program(
     memory: int = settings.DEFAULT_VM_MEMORY,
     vcpus: int = settings.DEFAULT_VM_VCPUS,
     timeout_seconds: float = settings.DEFAULT_VM_TIMEOUT,
+    persistent: bool = False,
     encoding: Encoding = Encoding.zip,
     volumes: List[Dict] = None,
     subscriptions: Optional[List[Dict]] = None,
@@ -321,10 +323,10 @@ async def create_program(
     ## Register the different ways to trigger a VM
     if subscriptions:
         # Trigger on HTTP calls and on Aleph message subscriptions.
-        triggers = {"http": True, "message": subscriptions}
+        triggers = {"http": True, "persistent": persistent, "message": subscriptions}
     else:
         # Trigger on HTTP calls.
-        triggers = {"http": True}
+        triggers = {"http": True, "persistent": persistent}
 
     content = ProgramContent(
         **{
@@ -373,6 +375,9 @@ async def create_program(
         }
     )
 
+    # Ensure that the version of aleph-message used supports the field.
+    assert content.on.persistent == persistent
+
     return await submit(
         account=account,
         content=content.dict(exclude_none=True),
@@ -572,6 +577,8 @@ async def get_messages(
     end_date: Optional[Union[datetime, float]] = None,
     session: Optional[ClientSession] = None,
     api_server: str = settings.API_HOST,
+    ignore_invalid_messages: bool = True,
+    invalid_messages_log_level: int = logging.NOTSET,
 ) -> MessagesResponse:
     session = session or get_fallback_session()
 
@@ -607,8 +614,36 @@ async def get_messages(
 
     async with session.get(f"{api_server}/api/v0/messages.json", params=params) as resp:
         resp.raise_for_status()
-        messages_json = await resp.json()
-        return MessagesResponse(**messages_json)
+        response_json = await resp.json()
+        messages_raw = response_json["messages"]
+
+        # All messages may not be valid according to the latest specification in
+        # aleph-message. This allows the user to specify how errors should be handled.
+        messages: List[AlephMessage] = []
+        for message_raw in messages_raw:
+            try:
+                message = Message(**message_raw)
+                messages.append(message)
+            except KeyError as e:
+                if not ignore_invalid_messages:
+                    raise e
+                logger.log(
+                    level=invalid_messages_log_level,
+                    msg=f"KeyError: Field '{e.args[0]}' not found",
+                )
+            except ValidationError as e:
+                if not ignore_invalid_messages:
+                    raise e
+                if invalid_messages_log_level:
+                    logger.log(level=invalid_messages_log_level, msg=e)
+
+        return MessagesResponse(
+            messages=messages,
+            pagination_page=response_json["pagination_page"],
+            pagination_total=response_json["pagination_total"],
+            pagination_per_page=response_json["pagination_per_page"],
+            pagination_item=response_json["pagination_item"],
+        )
 
 
 async def get_message(

src/aleph_client/models.py

@@ -0,0 +1,14 @@
+from typing import List
+
+from aleph_message.models import AlephMessage
+from pydantic import BaseModel
+
+
+class MessagesResponse(BaseModel):
+    """Response from an Aleph node API on the path /api/v0/messages.json"""
+
+    messages: List[AlephMessage]
+    pagination_page: int
+    pagination_total: int
+    pagination_per_page: int
+    pagination_item: str

src/aleph_client/synchronous.py

@@ -75,6 +75,7 @@ def create_program(
     memory: int = settings.DEFAULT_VM_MEMORY,
     vcpus: int = settings.DEFAULT_VM_VCPUS,
     timeout_seconds: float = settings.DEFAULT_VM_TIMEOUT,
+    persistent: bool = False,
     encoding: Encoding = Encoding.zip,
     volumes: List[Dict] = None,
     subscriptions: Optional[List[Dict]] = None,
@@ -93,6 +94,7 @@ def create_program(
         memory=memory,
         vcpus=vcpus,
         timeout_seconds=timeout_seconds,
+        persistent=persistent,
         encoding=encoding,
         volumes=volumes,
         subscriptions=subscriptions,

tests/unit/test_asynchronous.py

@@ -112,7 +112,7 @@ async def test_create_store():
     mock_session = new_mock_session_with_post_success()
 
     mock_ipfs_push_file = AsyncMock()
-    mock_ipfs_push_file.return_value = "FAKE-HASH"
+    mock_ipfs_push_file.return_value = "QmRTV3h1jLcACW4FRfdisokkQAk4E4qDhUzGpgdrd4JAFy"
 
     with patch("aleph_client.asynchronous.ipfs_push_file", mock_ipfs_push_file):
 
@@ -129,15 +129,15 @@ async def test_create_store():
         await create_store(
             account=account,
             # file_content=b"HELLO",
-            file_hash="FAKE-HASH",
+            file_hash="QmRTV3h1jLcACW4FRfdisokkQAk4E4qDhUzGpgdrd4JAFy",
             channel="TEST",
             storage_engine=StorageEnum.ipfs,
             session=mock_session,
             api_server="https://example.org",
         )
 
     mock_storage_push_file = AsyncMock()
-    mock_storage_push_file.return_value = "FAKE-HASH"
+    mock_storage_push_file.return_value = "QmRTV3h1jLcACW4FRfdisokkQAk4E4qDhUzGpgdrd4JAFy"
 
     with patch("aleph_client.asynchronous.storage_push_file", mock_storage_push_file):
 
@@ -194,7 +194,7 @@ async def test_forget():
 
     new_post = await forget(
         account=account,
-        hashes=["FAKE-HASH"],
+        hashes=["QmRTV3h1jLcACW4FRfdisokkQAk4E4qDhUzGpgdrd4JAFy"],
         reason="GDPR",
         channel="TEST",
         session=mock_session,