Migrate from fishjam-dev to fishjam-cloud organization (#1)

* Migrate from fishjam-dev to fishjam-cloud organization

* Fix CI

* Rename membrane-clound -> fishjam-cloud

* feat/cluster health report (#2)

* feat: cluster health report

* Refactor github workflow

* Refactor github workflow

---------

Co-authored-by: Kamil Kołodziej <[email protected]>

Author: Karolk99

.circleci/config.yml

@@ -0,0 +1,32 @@
+name: CI
+
+on: [push]
+
+jobs:
+  lint:
+
+    runs-on: ubuntu-latest
+    name: lint
+    steps:
+      - uses: actions/checkout@v4
+      - name: Set up Python 3.8
+        uses: actions/setup-python@v5
+        with:
+          python-version: 3.8
+      - name: Install poetry
+        run: pip install poetry
+      - name: Install project dependencies
+        run: poetry install --no-ansi --with=dev
+      - name: Lint
+        run: poetry run lint
+      - name: Check format
+        run: poetry run format_check
+  
+  test:
+    runs-on: ubuntu-latest
+    name: test
+    steps:
+      - uses: actions/checkout@v4
+      - run: docker compose -f docker-compose-test.yaml up test --exit-code-from test
+      - run: docker compose -f docker-compose-test.yaml down
+      - run: docker compose -f docker-compose-test.yaml up examples --exit-code-from examples

.github/workflows/ci.yml

@@ -1,3 +1,3 @@
 [submodule "protos"]
 	path = protos
-	url = https://github.com/fishjam-dev/protos.git
+	url = https://github.com/fishjam-cloud/protos.git

.gitmodules

@@ -1,10 +1,10 @@
 # Fishjam Python Server SDK
 
-[![CircleCI](https://dl.circleci.com/status-badge/img/gh/fishjam-dev/python-server-sdk/tree/main.svg?style=svg)](https://dl.circleci.com/status-badge/redirect/gh/fishjam-dev/python-server-sdk/tree/main)
+[![CircleCI](https://dl.circleci.com/status-badge/img/gh/fishjam-cloud/python-server-sdk/tree/main.svg?style=svg)](https://dl.circleci.com/status-badge/redirect/gh/fishjam-cloud/python-server-sdk/tree/main)
 
-Python server SDK for the [Fishjam Media Server](https://github.com/fishjam-dev/fishjam).
+Python server SDK for the [Fishjam Media Server](https://github.com/fishjam-cloud/fishjam).
 
-Read the docs [here](https://fishjam-dev.github.io/python-server-sdk)
+Read the docs [here](https://fishjam-cloud.github.io/python-server-sdk)
 
 ## Installation
 
@@ -55,7 +55,7 @@ All methods in `RoomApi` may raise one of the exceptions deriving from `fishjam.
 
 Notifier allows for receiving real-time updates from the Fishjam Server.
 
-You can read more about notifications in the [Fishjam Docs](https://fishjam-dev.github.io/fishjam-docs/next/getting_started/notifications).
+You can read more about notifications in the [Fishjam Docs](https://fishjam-cloud.github.io/fishjam-docs/next/getting_started/notifications).
 
 Create `Notifier` instance
 ```python
@@ -141,6 +141,13 @@ You can check linter by running
 poetry run lint
 ```
 
+## Documentation
+Documentation is generated via openapi-python-client.
+
+To update documentation you need to:
+- in `poetry_scripts.py` change branch from which openapi.yaml should be downloaded
+- run `poetry run update-client`
+
 ## Copyright and License
 
 Copyright 2023, [Software Mansion](https://swmansion.com/?utm_source=git&utm_medium=readme&utm_campaign=fishjam)

README.md

@@ -1,8 +1,6 @@
-version: "3"
-
 services:
   fishjam:
-    image: "ghcr.io/fishjam-dev/fishjam:${TAG:-edge}"
+    image: "ghcr.io/fishjam-cloud/fishjam:${TAG:-edge}"
     container_name: fishjam
     restart: on-failure
     healthcheck:

docker-compose-test.yaml

@@ -8,7 +8,11 @@
 from .component_options_file import ComponentOptionsFile
 from .component_options_hls import ComponentOptionsHLS
 from .component_options_hls_subscribe_mode import ComponentOptionsHLSSubscribeMode
+from .component_options_hlss3_credentials import ComponentOptionsHLSS3Credentials
 from .component_options_recording import ComponentOptionsRecording
+from .component_options_recording_s3_credentials import (
+    ComponentOptionsRecordingS3Credentials,
+)
 from .component_options_recording_subscribe_mode import (
     ComponentOptionsRecordingSubscribeMode,
 )
@@ -33,9 +37,9 @@
 from .dial_config import DialConfig
 from .error import Error
 from .health_report import HealthReport
-from .health_report_distribution import HealthReportDistribution
-from .health_report_status import HealthReportStatus
 from .healthcheck_response import HealthcheckResponse
+from .node_status import NodeStatus
+from .node_status_status import NodeStatusStatus
 from .peer import Peer
 from .peer_details_response import PeerDetailsResponse
 from .peer_details_response_data import PeerDetailsResponseData
@@ -63,8 +67,10 @@
     "ComponentHLS",
     "ComponentOptionsFile",
     "ComponentOptionsHLS",
+    "ComponentOptionsHLSS3Credentials",
     "ComponentOptionsHLSSubscribeMode",
     "ComponentOptionsRecording",
+    "ComponentOptionsRecordingS3Credentials",
     "ComponentOptionsRecordingSubscribeMode",
     "ComponentOptionsRTSP",
     "ComponentOptionsSIP",
@@ -84,8 +90,8 @@
     "Error",
     "HealthcheckResponse",
     "HealthReport",
-    "HealthReportDistribution",
-    "HealthReportStatus",
+    "NodeStatus",
+    "NodeStatusStatus",
     "Peer",
     "PeerDetailsResponse",
     "PeerDetailsResponseData",

fishjam/_openapi_client/models/__init__.py

@@ -9,7 +9,9 @@
 from ..types import UNSET, Unset
 
 if TYPE_CHECKING:
-    from ..models.s3_credentials import S3Credentials
+    from ..models.component_options_hlss3_credentials import (
+        ComponentOptionsHLSS3Credentials,
+    )
 
 
 T = TypeVar("T", bound="ComponentOptionsHLS")
@@ -23,7 +25,7 @@ class ComponentOptionsHLS:
     """Whether the component should use LL-HLS"""
     persistent: Union[Unset, bool] = False
     """Whether the video is stored after end of stream"""
-    s3: Union[Unset, None, "S3Credentials"] = UNSET
+    s3: Union[Unset, None, "ComponentOptionsHLSS3Credentials"] = UNSET
     """An AWS S3 credential that will be used to send HLS stream. The stream will only be uploaded if credentials are provided"""
     subscribe_mode: Union[
         Unset, ComponentOptionsHLSSubscribeMode
@@ -67,21 +69,23 @@ def to_dict(self) -> Dict[str, Any]:
     @classmethod
     def from_dict(cls: Type[T], src_dict: Dict[str, Any]) -> T:
         """@private"""
-        from ..models.s3_credentials import S3Credentials
+        from ..models.component_options_hlss3_credentials import (
+            ComponentOptionsHLSS3Credentials,
+        )
 
         d = src_dict.copy()
         low_latency = d.pop("lowLatency", UNSET)
 
         persistent = d.pop("persistent", UNSET)
 
         _s3 = d.pop("s3", UNSET)
-        s3: Union[Unset, None, S3Credentials]
+        s3: Union[Unset, None, ComponentOptionsHLSS3Credentials]
         if _s3 is None:
             s3 = None
         elif isinstance(_s3, Unset):
             s3 = UNSET
         else:
-            s3 = S3Credentials.from_dict(_s3)
+            s3 = ComponentOptionsHLSS3Credentials.from_dict(_s3)
 
         _subscribe_mode = d.pop("subscribeMode", UNSET)
         subscribe_mode: Union[Unset, ComponentOptionsHLSSubscribeMode]

fishjam/_openapi_client/models/component_options_hls.py

@@ -0,0 +1,84 @@
+from typing import Any, Dict, List, Type, TypeVar
+
+from attrs import define as _attrs_define
+from attrs import field as _attrs_field
+
+T = TypeVar("T", bound="ComponentOptionsHLSS3Credentials")
+
+
+@_attrs_define
+class ComponentOptionsHLSS3Credentials:
+    """An AWS S3 credential that will be used to send HLS stream. The stream will only be uploaded if credentials are
+    provided
+
+    """
+
+    access_key_id: str
+    """An AWS access key identifier, linked to your AWS account."""
+    bucket: str
+    """The name of the S3 bucket where your data will be stored."""
+    region: str
+    """The AWS region where your bucket is located."""
+    secret_access_key: str
+    """The secret key that is linked to the Access Key ID."""
+    additional_properties: Dict[str, Any] = _attrs_field(init=False, factory=dict)
+    """@private"""
+
+    def to_dict(self) -> Dict[str, Any]:
+        """@private"""
+        access_key_id = self.access_key_id
+        bucket = self.bucket
+        region = self.region
+        secret_access_key = self.secret_access_key
+
+        field_dict: Dict[str, Any] = {}
+        field_dict.update(self.additional_properties)
+        field_dict.update(
+            {
+                "accessKeyId": access_key_id,
+                "bucket": bucket,
+                "region": region,
+                "secretAccessKey": secret_access_key,
+            }
+        )
+
+        return field_dict
+
+    @classmethod
+    def from_dict(cls: Type[T], src_dict: Dict[str, Any]) -> T:
+        """@private"""
+        d = src_dict.copy()
+        access_key_id = d.pop("accessKeyId")
+
+        bucket = d.pop("bucket")
+
+        region = d.pop("region")
+
+        secret_access_key = d.pop("secretAccessKey")
+
+        component_options_hlss3_credentials = cls(
+            access_key_id=access_key_id,
+            bucket=bucket,
+            region=region,
+            secret_access_key=secret_access_key,
+        )
+
+        component_options_hlss3_credentials.additional_properties = d
+        return component_options_hlss3_credentials
+
+    @property
+    def additional_keys(self) -> List[str]:
+        """@private"""
+        return list(self.additional_properties.keys())
+
+    def __getitem__(self, key: str) -> Any:
+        return self.additional_properties[key]
+
+    def __setitem__(self, key: str, value: Any) -> None:
+        self.additional_properties[key] = value
+
+    def __delitem__(self, key: str) -> None:
+        del self.additional_properties[key]
+
+    def __contains__(self, key: str) -> bool:
+        return key in self.additional_properties

fishjam/_openapi_client/models/component_options_hlss3_credentials.py

@@ -9,7 +9,9 @@
 from ..types import UNSET, Unset
 
 if TYPE_CHECKING:
-    from ..models.s3_credentials import S3Credentials
+    from ..models.component_options_recording_s3_credentials import (
+        ComponentOptionsRecordingS3Credentials,
+    )
 
 
 T = TypeVar("T", bound="ComponentOptionsRecording")
@@ -19,7 +21,7 @@
 class ComponentOptionsRecording:
     """Options specific to the Recording component"""
 
-    credentials: Union[Unset, None, "S3Credentials"] = UNSET
+    credentials: Union[Unset, None, "ComponentOptionsRecordingS3Credentials"] = UNSET
     """An AWS S3 credential that will be used to send HLS stream. The stream will only be uploaded if credentials are provided"""
     path_prefix: Union[Unset, None, str] = UNSET
     """Path prefix under which all recording are stored"""
@@ -56,17 +58,19 @@ def to_dict(self) -> Dict[str, Any]:
     @classmethod
     def from_dict(cls: Type[T], src_dict: Dict[str, Any]) -> T:
         """@private"""
-        from ..models.s3_credentials import S3Credentials
+        from ..models.component_options_recording_s3_credentials import (
+            ComponentOptionsRecordingS3Credentials,
+        )
 
         d = src_dict.copy()
         _credentials = d.pop("credentials", UNSET)
-        credentials: Union[Unset, None, S3Credentials]
+        credentials: Union[Unset, None, ComponentOptionsRecordingS3Credentials]
         if _credentials is None:
             credentials = None
         elif isinstance(_credentials, Unset):
             credentials = UNSET
         else:
-            credentials = S3Credentials.from_dict(_credentials)
+            credentials = ComponentOptionsRecordingS3Credentials.from_dict(_credentials)
 
         path_prefix = d.pop("pathPrefix", UNSET)