port-ocean 0.5.18__tar.gz → 0.5.20__tar.gz

{port_ocean-0.5.18 → port_ocean-0.5.20}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: port-ocean
-Version: 0.5.18
+Version: 0.5.20
 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.5.18 → port_ocean-0.5.20}/port_ocean/cli/cookiecutter/{{cookiecutter.integration_slug}}/.port/spec.yaml

@@ -1,4 +1,3 @@
-type: {{cookiecutter.integration_slug}}
 description: {{cookiecutter.integration_name}} integration for Port Ocean
 icon: Cookiecutter # Should be one of the available icons in Port
 features:

{port_ocean-0.5.18 → port_ocean-0.5.20}/port_ocean/cli/cookiecutter/{{cookiecutter.integration_slug}}/pyproject.toml

@@ -1,5 +1,5 @@
 [tool.poetry]
-name = "{{cookiecutter.integration_name}}"
+name = "{{cookiecutter.integration_slug}}"
 version = "0.1.0"
 description = "{{cookiecutter.integration_short_description}}"
 authors = ["{{cookiecutter.full_name}} <{{cookiecutter.email}}>"]

{port_ocean-0.5.18 → port_ocean-0.5.20}/port_ocean/config/base.py

@@ -16,16 +16,15 @@ PROVIDER_CONFIG_PATTERN = r"^[a-zA-Z0-9]+ .*$"
 
 def read_yaml_config_settings_source(
     settings: "BaseOceanSettings", base_path: str
-) -> str:
+) -> dict[str, Any]:
     yaml_file = getattr(settings.__config__, "yaml_file", "")
 
     assert yaml_file, "Settings.yaml_file not properly configured"
     path = Path(base_path, yaml_file)
 
     if not path.exists():
-        raise FileNotFoundError(f"Could not open yaml settings file at: {path}")
-
-    return path.read_text("utf-8")
+        return {}
+    return yaml.safe_load(path.read_text("utf-8"))
 
 
 def parse_config_provider(value: str) -> tuple[str, str]:
@@ -122,8 +121,7 @@ def decamelize_config(
 def load_providers(
     settings: "BaseOceanSettings", existing_values: dict[str, Any], base_path: str
 ) -> dict[str, Any]:
-    yaml_content = read_yaml_config_settings_source(settings, base_path)
-    data = yaml.safe_load(yaml_content)
+    data = read_yaml_config_settings_source(settings, base_path)
     snake_case_config = decamelize_config(settings, data)
     return parse_providers(settings, snake_case_config, existing_values)
 

{port_ocean-0.5.18 → port_ocean-0.5.20}/port_ocean/config/settings.py

@@ -1,12 +1,14 @@
 from typing import Any, Literal
 
-from pydantic import Extra, AnyHttpUrl, parse_obj_as, validator
+from pydantic import Extra, AnyHttpUrl, parse_obj_as
+from pydantic.class_validators import root_validator
 from pydantic.env_settings import InitSettingsSource, EnvSettingsSource, BaseSettings
 from pydantic.fields import Field
 from pydantic.main import BaseModel
 
 from port_ocean.config.base import BaseOceanSettings, BaseOceanModel
 from port_ocean.core.event_listener import EventListenerSettingsType
+from port_ocean.utils.misc import get_integration_name
 
 LogLevelType = Literal["ERROR", "WARNING", "INFO", "DEBUG", "CRITICAL"]
 
@@ -36,16 +38,27 @@ class PortSettings(BaseOceanModel, extra=Extra.allow):
     client_id: str = Field(..., sensitive=True)
     client_secret: str = Field(..., sensitive=True)
     base_url: AnyHttpUrl = parse_obj_as(AnyHttpUrl, "https://api.getport.io")
+    port_app_config_cache_ttl: int = 60
 
 
 class IntegrationSettings(BaseOceanModel, extra=Extra.allow):
-    identifier: str
-    type: str
+    identifier: str = Field(..., min_length=1)
+    type: str = Field(..., min_length=1)
     config: dict[str, Any] | BaseModel
 
-    @validator("identifier", "type")
-    def validate_lower(cls, v: str) -> str:
-        return v.lower()
+    @root_validator(pre=True)
+    def a(cls, values: dict[str, Any]) -> dict[str, Any]:
+        integ_type = values.get("type")
+
+        if not integ_type:
+            integ_type = get_integration_name()
+
+        values["type"] = integ_type.lower() if integ_type else None
+        values["identifier"] = values.get(
+            "identifier", f"my-{integ_type}-integration".lower()
+        )
+
+        return values
 
 
 class IntegrationConfiguration(BaseOceanSettings, extra=Extra.allow):

{port_ocean-0.5.18 → port_ocean-0.5.20}/port_ocean/core/event_listener/base.py

@@ -1,5 +1,4 @@
 from abc import abstractmethod
-from asyncio import Task
 from typing import TypedDict, Callable, Any, Awaitable
 
 from pydantic import Extra
@@ -22,7 +21,6 @@ class BaseEventListener:
         events: EventListenerEvents,
     ):
         self.events = events
-        self._tasks_to_close: list[Task[Any]] = []
 
     async def start(self) -> None:
         signal_handler.register(self._stop)
@@ -32,11 +30,6 @@ class BaseEventListener:
     async def _start(self) -> None:
         pass
 
-    def stop(self) -> None:
-        self._stop()
-        for task in self._tasks_to_close:
-            task.cancel()
-
     def _stop(self) -> None:
         """
         Can be used for event listeners that need cleanup before exiting.

{port_ocean-0.5.18 → port_ocean-0.5.20}/port_ocean/core/event_listener/polling.py

@@ -10,6 +10,7 @@ from port_ocean.core.event_listener.base import (
     EventListenerSettings,
 )
 from port_ocean.utils.repeat import repeat_every
+from port_ocean.utils.signal import signal_handler
 
 
 class PollingEventListenerSettings(EventListenerSettings):
@@ -79,7 +80,7 @@ class PollingEventListener(BaseEventListener):
                 running_task: Task[Any] = get_event_loop().create_task(
                     self.events["on_resync"]({})  # type: ignore
                 )
-                self._tasks_to_close.append(running_task)
+                signal_handler.register(running_task.cancel)
 
                 await running_task
 

port_ocean-0.5.20/port_ocean/core/handlers/port_app_config/base.py

@@ -0,0 +1,82 @@
+from abc import abstractmethod
+from typing import Type, Any
+
+from loguru import logger
+from pydantic import ValidationError
+
+from port_ocean.context.event import event
+from port_ocean.context.ocean import PortOceanContext
+from port_ocean.core.handlers.base import BaseHandler
+from port_ocean.core.handlers.port_app_config.models import PortAppConfig
+from port_ocean.utils.misc import get_time
+
+
+class PortAppConfigCache:
+    _port_app_config: PortAppConfig | None
+    _retrieval_time: float
+
+    def __init__(self, cache_ttl: int):
+        self._cache_ttl = cache_ttl
+
+    @property
+    def port_app_config(self) -> PortAppConfig:
+        if self._port_app_config is None:
+            raise ValueError("Port app config is not set")
+        return self._port_app_config
+
+    @port_app_config.setter
+    def port_app_config(self, value: PortAppConfig) -> None:
+        self._retrieval_time = get_time()
+        self._port_app_config = value
+
+    @property
+    def is_cache_invalid(self) -> bool:
+        return (
+            not self._port_app_config
+            or self._retrieval_time + self._cache_ttl < get_time()
+        )
+
+
+class BasePortAppConfig(BaseHandler):
+    """Abstract base class for managing port application configurations.
+
+    This class defines methods for obtaining and processing port application configurations.
+
+    Attributes:
+        context (Any): The context to be used during port application configuration.
+        CONFIG_CLASS (Type[PortAppConfig]): The class used for defining port application configuration settings.
+    """
+
+    CONFIG_CLASS: Type[PortAppConfig] = PortAppConfig
+
+    def __init__(self, context: PortOceanContext):
+        super().__init__(context)
+        self._app_config_cache = PortAppConfigCache(
+            self.context.config.port.port_app_config_cache_ttl
+        )
+
+    @abstractmethod
+    async def _get_port_app_config(self) -> dict[str, Any]:
+        pass
+
+    async def get_port_app_config(self, use_cache: bool = True) -> PortAppConfig:
+        """
+        Retrieve and parse the port application configuration.
+
+        :param use_cache: Determines whether to use the cached port-app-config if it exists, or to fetch it regardless
+        :return: The parsed port application configuration.
+        """
+        if not use_cache or self._app_config_cache.is_cache_invalid:
+            raw_config = await self._get_port_app_config()
+            try:
+                self._app_config_cache.port_app_config = self.CONFIG_CLASS.parse_obj(
+                    raw_config
+                )
+            except ValidationError:
+                logger.error(
+                    "Invalid port app config found. Please check that the integration has been configured correctly."
+                )
+                raise
+
+        event.port_app_config = self._app_config_cache.port_app_config
+        return self._app_config_cache.port_app_config

{port_ocean-0.5.18 → port_ocean-0.5.20}/port_ocean/core/integrations/mixins/sync_raw.py

@@ -362,7 +362,11 @@ class SyncRawMixin(HandlerMixin, EventsMixin):
             EventType.RESYNC,
             trigger_type=trigger_type,
         ):
-            app_config = await self.port_app_config_handler.get_port_app_config()
+            # If a resync is triggered due to a mappings change, we want to make sure that we have the updated version
+            # rather than the old cache
+            app_config = await self.port_app_config_handler.get_port_app_config(
+                use_cache=False
+            )
 
             creation_results: list[tuple[list[Entity], list[Exception]]] = []
 

{port_ocean-0.5.18 → port_ocean-0.5.20}/port_ocean/core/utils.py

@@ -28,14 +28,6 @@ def is_same_entity(first_entity: Entity, second_entity: Entity) -> bool:
     )
 
 
-def get_unique(array: list[Entity]) -> list[Entity]:
-    result: list[Entity] = []
-    for item in array:
-        if all(not is_same_entity(item, seen_item) for seen_item in result):
-            result.append(item)
-    return result
-
-
 def get_port_diff(
     before: Iterable[Entity],
     after: Iterable[Entity],

{port_ocean-0.5.18 → port_ocean-0.5.20}/port_ocean/ocean.py

@@ -1,7 +1,8 @@
 import asyncio
 import sys
 import threading
-from typing import Callable, Any, Dict
+from contextlib import asynccontextmanager
+from typing import Callable, Any, Dict, AsyncIterator
 
 from fastapi import FastAPI, APIRouter
 from loguru import logger
@@ -21,7 +22,7 @@ from port_ocean.core.integrations.base import BaseIntegration
 from port_ocean.log.sensetive import sensitive_log_filter
 from port_ocean.middlewares import request_handler
 from port_ocean.utils.repeat import repeat_every
-from port_ocean.utils.signal import init_signal_handler
+from port_ocean.utils.signal import signal_handler, init_signal_handler
 from port_ocean.version import __integration_version__
 
 
@@ -93,14 +94,17 @@ class Ocean:
     async def __call__(self, scope: Scope, receive: Receive, send: Send) -> None:
         self.fast_api_app.include_router(self.integration_router, prefix="/integration")
 
-        @self.fast_api_app.on_event("startup")
-        async def startup() -> None:
-            init_signal_handler()
+        @asynccontextmanager
+        async def lifecycle(_: FastAPI) -> AsyncIterator[None]:
             try:
+                init_signal_handler()
                 await self.integration.start()
                 await self._setup_scheduled_resync()
+                yield None
+                signal_handler.exit()
             except Exception:
-                logger.exception("Failed to start integration")
+                logger.exception("Integration had a fatal error. Shutting down.")
                 sys.exit("Server stopped")
 
+        self.fast_api_app.router.lifespan_context = lifecycle
         await self.fast_api_app(scope, receive, send)

{port_ocean-0.5.18 → port_ocean-0.5.20}/port_ocean/utils/misc.py

@@ -29,13 +29,25 @@ def get_function_location(func: Callable[..., Any]) -> str:
     return f"{file_path}:{line_number}"
 
 
-def get_integration_version() -> str:
+def get_pyproject_data() -> dict[str, Any] | None:
     try:
         with open("./pyproject.toml", "rb") as toml_file:
             pyproject_data = tomli.load(toml_file)
-            return pyproject_data["tool"]["poetry"]["version"]
+            return pyproject_data["tool"]["poetry"]
     except (FileNotFoundError, KeyError):
-        return ""
+        return None
+
+
+def get_integration_version() -> str:
+    if data := get_pyproject_data():
+        return data["version"]
+    return ""
+
+
+def get_integration_name() -> str:
+    if data := get_pyproject_data():
+        return data["name"]
+    return ""
 
 
 def get_spec_file(path: Path = Path(".")) -> dict[str, Any] | None:

{port_ocean-0.5.18 → port_ocean-0.5.20}/port_ocean/utils/queue_utils.py

@@ -33,6 +33,7 @@ async def process_in_queue(
     This function executes multiple asynchronous tasks in a bounded way
     (e.g. having 200 tasks to execute, while running only 20 concurrently),
     to prevent overload and memory issues when dealing with large sets of data and tasks.
+    read more -> https://stackoverflow.com/questions/38831322/making-1-milion-requests-with-aiohttp-asyncio-literally
 
     Usage:
     ```python

{port_ocean-0.5.18 → port_ocean-0.5.20}/port_ocean/utils/signal.py

@@ -1,4 +1,3 @@
-import signal
 from typing import Callable, Any
 
 from werkzeug.local import LocalProxy, LocalStack
@@ -13,10 +12,8 @@ from port_ocean.utils.misc import generate_uuid
 class SignalHandler:
     def __init__(self) -> None:
         self._handlers: dict[str, Callable[[], Any]] = {}
-        signal.signal(signal.SIGINT, lambda _, __: self._exit())
-        signal.signal(signal.SIGTERM, lambda _, __: self._exit())
 
-    def _exit(self) -> None:
+    def exit(self) -> None:
         """
         Handles the exit signal.
         """

{port_ocean-0.5.18 → port_ocean-0.5.20}/pyproject.toml

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

port_ocean-0.5.18/port_ocean/cli/cookiecutter/{{cookiecutter.integration_slug}}/config.yaml

@@ -1,17 +0,0 @@
-{{ "# This is an example configuration file for the integration service." }}
-{{ "# Please copy this file to config.yaml file in the integration folder and edit it to your needs." }}
-
-port:
-  clientId: "{{ '{{' }} from env PORT_CLIENT_ID {{ '}}' }}" {{ "# Can be loaded via environment variable: PORT_CLIENT_ID" }}
-  clientSecret: "{{ '{{' }} from env PORT_CLIENT_SECRET {{ '}}' }}" {{ "# Can be loaded via environment variable: PORT_CLIENT_SECRET" }}
-{{ "# The event listener to use for the integration service." }}
-eventListener:
-  type: KAFKA
-integration:
-  {{ "# The identifier of this integration instance." }}
-  identifier: "{{ '{{' }} from env INTEGRATION_IDENTIFIER {{ '}}' }}"
-  {{ "# The type of the integration." }}
-  type: "My Integration type (Gitlab, Jira, etc.)"
-  config:
-    myGitToken: "{{ '{{' }} from env MY_GIT_TOKEN {{ '}}' }}"
-    someApplicationUrl: "https://I-Am-Not-A-Real-Url.com"

port_ocean-0.5.18/port_ocean/core/handlers/port_app_config/base.py

@@ -1,44 +0,0 @@
-from abc import abstractmethod
-from typing import Type, Any
-
-from loguru import logger
-from pydantic import ValidationError
-
-from port_ocean.context.event import event
-from port_ocean.core.handlers.base import BaseHandler
-from port_ocean.core.handlers.port_app_config.models import PortAppConfig
-
-
-class BasePortAppConfig(BaseHandler):
-    """Abstract base class for managing port application configurations.
-
-    This class defines methods for obtaining and processing port application configurations.
-
-    Attributes:
-        context (Any): The context to be used during port application configuration.
-        CONFIG_CLASS (Type[PortAppConfig]): The class used for defining port application configuration settings.
-    """
-
-    CONFIG_CLASS: Type[PortAppConfig] = PortAppConfig
-
-    @abstractmethod
-    async def _get_port_app_config(self) -> dict[str, Any]:
-        pass
-
-    async def get_port_app_config(self) -> PortAppConfig:
-        """Retrieve and parse the port application configuration.
-
-        Returns:
-            PortAppConfig: The parsed port application configuration.
-        """
-        raw_config = await self._get_port_app_config()
-        try:
-            config = self.CONFIG_CLASS.parse_obj(raw_config)
-        except ValidationError:
-            logger.error(
-                "Invalid port app config found. Please check that the integration has been configured correctly."
-            )
-            raise
-
-        event.port_app_config = config
-        return config