port-ocean 0.17.5__tar.gz → 0.17.7__tar.gz

{port_ocean-0.17.5 → port_ocean-0.17.7}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: port-ocean
-Version: 0.17.5
+Version: 0.17.7
 Summary: Port Ocean is a CLI tool for managing your Port projects.
 Home-page: https://app.getport.io
 Keywords: ocean,port-ocean,port

{port_ocean-0.17.5 → port_ocean-0.17.7}/port_ocean/core/defaults/initialize.py

@@ -68,7 +68,7 @@ async def _initialize_required_integration_settings(
             )
             integration = await port_client.create_integration(
                 integration_config.integration.type,
-                integration_config.event_listener.to_request(),
+                integration_config.event_listener.get_changelog_destination_details(),
                 port_app_config=default_mapping,
             )
         elif not integration.get("config"):
@@ -77,7 +77,7 @@ async def _initialize_required_integration_settings(
             )
             integration = await port_client.patch_integration(
                 integration_config.integration.type,
-                integration_config.event_listener.to_request(),
+                integration_config.event_listener.get_changelog_destination_details(),
                 port_app_config=default_mapping,
             )
     except httpx.HTTPStatusError as err:
@@ -85,8 +85,10 @@ async def _initialize_required_integration_settings(
         raise err
 
     logger.info("Checking for diff in integration configuration")
-    changelog_destination = integration_config.event_listener.to_request().get(
-        "changelog_destination"
+    changelog_destination = (
+        integration_config.event_listener.get_changelog_destination_details().get(
+            "changelog_destination"
+        )
     )
     if (
         integration.get("changelogDestination") != changelog_destination

{port_ocean-0.17.5 → port_ocean-0.17.7}/port_ocean/core/event_listener/base.py

@@ -78,8 +78,16 @@ class EventListenerSettings(BaseOceanModel, extra=Extra.allow):
     type: str
     should_resync: bool = True
 
-    def to_request(self) -> dict[str, Any]:
+    def get_changelog_destination_details(self) -> dict[str, Any]:
         """
-        Converts the Settings object to a dictionary representation (request format).
+        Returns the changelog destination configuration for the event listener.
+        By default, returns an empty dict. Only KAFKA and WEBHOOK event listeners need to override this
+        to provide their specific changelog destination details.
+
+        Returns:
+            dict[str, Any]: The changelog destination configuration. For example:
+                - KAFKA returns {"type": "KAFKA"}
+                - WEBHOOK returns {"type": "WEBHOOK", "url": "https://example.com/resync"}
+                - Other event listeners return {}
         """
-        return {"type": self.type}
+        return {}

{port_ocean-0.17.5 → port_ocean-0.17.7}/port_ocean/core/event_listener/http.py

@@ -27,9 +27,17 @@ class HttpEventListenerSettings(EventListenerSettings):
     type: Literal["WEBHOOK"]
     app_host: AnyHttpUrl = Field(..., sensitive=True)
 
-    def to_request(self) -> dict[str, Any]:
+    def get_changelog_destination_details(self) -> dict[str, Any]:
+        """
+        Returns the changelog destination configuration for the webhook event listener.
+        For webhook event listeners, this specifies the URL where changelog events should be sent.
+
+        Returns:
+            dict[str, Any]: A dictionary with the webhook URL where changelog events should be sent,
+                           constructed by appending "/resync" to the app_host.
+        """
         return {
-            **super().to_request(),
+            "type": self.type,
             "url": self.app_host + "/resync",
         }
 

{port_ocean-0.17.5 → port_ocean-0.17.7}/port_ocean/core/event_listener/kafka.py

@@ -46,6 +46,19 @@ class KafkaEventListenerSettings(EventListenerSettings):
     kafka_security_enabled: bool = True
     consumer_poll_timeout: int = 1
 
+    def get_changelog_destination_details(self) -> dict[str, Any]:
+        """
+        Returns the changelog destination configuration for the Kafka event listener.
+        For Kafka event listeners, this specifies that changelog events should be sent via Kafka.
+
+        Returns:
+            dict[str, Any]: A dictionary with type "KAFKA" to indicate that changelog events
+                           should be sent through the Kafka message bus.
+        """
+        return {
+            "type": self.type,
+        }
+
 
 class KafkaEventListener(BaseEventListener):
     """

{port_ocean-0.17.5 → port_ocean-0.17.7}/port_ocean/core/event_listener/once.py

@@ -23,9 +23,6 @@ class OnceEventListenerSettings(EventListenerSettings):
 
     type: Literal["ONCE"]
 
-    def to_request(self) -> dict[str, Any]:
-        return {}
-
 
 class OnceEventListener(BaseEventListener):
     """

{port_ocean-0.17.5 → port_ocean-0.17.7}/port_ocean/core/event_listener/polling.py

@@ -27,9 +27,6 @@ class PollingEventListenerSettings(EventListenerSettings):
     resync_on_start: bool = True
     interval: int = 60
 
-    def to_request(self) -> dict[str, Any]:
-        return {}
-
 
 class PollingEventListener(BaseEventListener):
     """

{port_ocean-0.17.5 → port_ocean-0.17.7}/port_ocean/core/integrations/mixins/sync_raw.py

@@ -147,6 +147,7 @@ class SyncRawMixin(HandlerMixin, EventsMixin):
         return CalculationResult(
             objects_diff[0].entity_selector_diff._replace(passed=modified_objects),
             errors=objects_diff[0].errors,
+            misonfigured_entity_keys=objects_diff[0].misonfigured_entity_keys,
         )
 
     async def _unregister_resource_raw(
@@ -162,7 +163,7 @@ class SyncRawMixin(HandlerMixin, EventsMixin):
             return [], []
 
         objects_diff = await self._calculate_raw([(resource, results)])
-        entities_selector_diff, errors = objects_diff[0]
+        entities_selector_diff, errors, _ = objects_diff[0]
 
         await self.entities_state_applier.delete(
             entities_selector_diff.passed, user_agent_type
@@ -245,7 +246,7 @@ class SyncRawMixin(HandlerMixin, EventsMixin):
         if not resource_mappings:
             return []
 
-        diffs, errors = zip(
+        diffs, errors, misconfigured_entity_keys = zip(
             *await asyncio.gather(
                 *(
                     self._register_resource_raw(
@@ -258,6 +259,8 @@ class SyncRawMixin(HandlerMixin, EventsMixin):
 
         diffs = list(diffs)
         errors = sum(errors, [])
+        misconfigured_entity_keys = list(misconfigured_entity_keys)
+
 
         if errors:
             message = f"Failed to register {len(errors)} entities. Skipping delete phase due to incomplete state"

{port_ocean-0.17.5 → port_ocean-0.17.7}/port_ocean/tests/core/handlers/mixins/test_sync_raw.py

@@ -164,6 +164,14 @@ def mock_sync_raw_mixin(
     return sync_raw_mixin
 
 
+@pytest.fixture
+def mock_sync_raw_mixin_with_jq_processor(
+    mock_sync_raw_mixin: SyncRawMixin,
+) -> SyncRawMixin:
+    mock_sync_raw_mixin._entity_processor = JQEntityProcessor(mock_context)  # type: ignore
+    return mock_sync_raw_mixin
+
+
 @asynccontextmanager
 async def no_op_event_context(
     existing_event: EventContext,
@@ -398,3 +406,147 @@ async def test_sync_raw_mixin_dependency(
                     "entity_3-entity_1-entity_4-entity_2-entity_5",
                     "entity_3-entity_1-entity_4-entity_5-entity_2",
                 )
+
+
+@pytest.mark.asyncio
+async def test_register_raw(
+    mock_sync_raw_mixin_with_jq_processor: SyncRawMixin, mock_ocean: Ocean
+) -> None:
+    kind = "service"
+    user_agent_type = UserAgentType.exporter
+    raw_entity = [
+        {"id": "entity_1", "name": "entity_1", "web_url": "https://example.com"},
+    ]
+    expected_result = [
+        {
+            "identifier": "entity_1",
+            "blueprint": "service",
+            "name": "entity_1",
+            "properties": {"url": "https://example.com"},
+        },
+    ]
+
+    async with event_context(EventType.HTTP_REQUEST, trigger_type="machine") as event:
+        # Use patch to mock the method instead of direct assignment
+        with patch.object(
+            mock_sync_raw_mixin_with_jq_processor.port_app_config_handler,
+            "get_port_app_config",
+            return_value=PortAppConfig(
+                enable_merge_entity=True,
+                delete_dependent_entities=True,
+                create_missing_related_entities=False,
+                resources=[
+                    ResourceConfig(
+                        kind=kind,
+                        selector=Selector(query="true"),
+                        port=PortResourceConfig(
+                            entity=MappingsConfig(
+                                mappings=EntityMapping(
+                                    identifier=".id | tostring",
+                                    title=".name",
+                                    blueprint='"service"',
+                                    properties={"url": ".web_url"},
+                                    relations={},
+                                )
+                            )
+                        ),
+                    )
+                ],
+            ),
+        ):
+            # Ensure the event.port_app_config is set correctly
+            event.port_app_config = await mock_sync_raw_mixin_with_jq_processor.port_app_config_handler.get_port_app_config(
+                use_cache=False
+            )
+
+            def upsert_side_effect(
+                entities: list[Entity], user_agent_type: UserAgentType
+            ) -> list[Entity]:
+                # Simulate returning the passed entities
+                return entities
+
+            # Patch the upsert method with the side effect
+            with patch.object(
+                mock_sync_raw_mixin_with_jq_processor.entities_state_applier,
+                "upsert",
+                side_effect=upsert_side_effect,
+            ):
+                # Call the register_raw method
+                registered_entities = (
+                    await mock_sync_raw_mixin_with_jq_processor.register_raw(
+                        kind, raw_entity, user_agent_type
+                    )
+                )
+
+                # Assert that the registered entities match the expected results
+                assert len(registered_entities) == len(expected_result)
+                for entity, result in zip(registered_entities, expected_result):
+                    assert entity.identifier == result["identifier"]
+                    assert entity.blueprint == result["blueprint"]
+                    assert entity.properties == result["properties"]
+
+
+@pytest.mark.asyncio
+async def test_unregister_raw(
+    mock_sync_raw_mixin_with_jq_processor: SyncRawMixin, mock_ocean: Ocean
+) -> None:
+    kind = "service"
+    user_agent_type = UserAgentType.exporter
+    raw_entity = [
+        {"id": "entity_1", "name": "entity_1", "web_url": "https://example.com"},
+    ]
+    expected_result = [
+        {
+            "identifier": "entity_1",
+            "blueprint": "service",
+            "name": "entity_1",
+            "properties": {"url": "https://example.com"},
+        },
+    ]
+
+    async with event_context(EventType.HTTP_REQUEST, trigger_type="machine") as event:
+        # Use patch to mock the method instead of direct assignment
+        with patch.object(
+            mock_sync_raw_mixin_with_jq_processor.port_app_config_handler,
+            "get_port_app_config",
+            return_value=PortAppConfig(
+                enable_merge_entity=True,
+                delete_dependent_entities=True,
+                create_missing_related_entities=False,
+                resources=[
+                    ResourceConfig(
+                        kind=kind,
+                        selector=Selector(query="true"),
+                        port=PortResourceConfig(
+                            entity=MappingsConfig(
+                                mappings=EntityMapping(
+                                    identifier=".id | tostring",
+                                    title=".name",
+                                    blueprint='"service"',
+                                    properties={"url": ".web_url"},
+                                    relations={},
+                                )
+                            )
+                        ),
+                    )
+                ],
+            ),
+        ):
+            # Ensure the event.port_app_config is set correctly
+            event.port_app_config = await mock_sync_raw_mixin_with_jq_processor.port_app_config_handler.get_port_app_config(
+                use_cache=False
+            )
+
+            # Call the unregister_raw method
+            unregistered_entities = (
+                await mock_sync_raw_mixin_with_jq_processor.unregister_raw(
+                    kind, raw_entity, user_agent_type
+                )
+            )
+
+            # Assert that the unregistered entities match the expected results
+            assert len(unregistered_entities) == len(expected_result)
+            for entity, result in zip(unregistered_entities, expected_result):
+                assert entity.identifier == result["identifier"]
+                assert entity.blueprint == result["blueprint"]
+                assert entity.properties == result["properties"]

{port_ocean-0.17.5 → port_ocean-0.17.7}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "port-ocean"
-version = "0.17.5"
+version = "0.17.7"
 description = "Port Ocean is a CLI tool for managing your Port projects."
 readme = "README.md"
 homepage = "https://app.getport.io"