mage-ai 0.9.45__py3-none-any.whl → 0.9.47__py3-none-any.whl

mage_ai/api/constants.py

@@ -52,3 +52,5 @@ ATTRIBUTE_OPERATION_TYPE_DISABLE_TO_ACCESS_MAPPING = {
 
 META_KEY_LIMIT = '_limit'
 META_KEY_OFFSET = '_offset'
+
+DOWNLOAD_TOKEN_LIFESPAN = 60  # Lifespan of generated download token in seconds

mage_ai/api/operations/base.py

@@ -2,7 +2,7 @@ import importlib
 import importlib.util
 import inspect
 from collections import UserList
-from typing import Any, Callable, Dict, Union
+from typing import Any, Callable, Dict, List, Union
 
 import dateutil.parser
 import inflection
@@ -25,7 +25,19 @@ from mage_ai.api.operations.constants import (
 )
 from mage_ai.api.parsers.BaseParser import BaseParser
 from mage_ai.api.presenters.BasePresenter import CustomDict, CustomList
+from mage_ai.api.resources.BaseResource import BaseResource
 from mage_ai.api.result_set import ResultSet
+from mage_ai.authentication.permissions.constants import EntityName
+from mage_ai.data_preparation.models.global_hooks.models import (
+    GlobalHooks,
+    Hook,
+    HookCondition,
+    HookOperation,
+    HookStage,
+    HookStrategy,
+)
+from mage_ai.data_preparation.models.project import Project
+from mage_ai.data_preparation.models.project.constants import FeatureUUID
 from mage_ai.orchestration.db import db_connection
 from mage_ai.orchestration.db.errors import DoesNotExistError
 from mage_ai.settings import REQUIRE_USER_PERMISSIONS
@@ -49,6 +61,7 @@ class BaseOperation():
         self.oauth_token = kwargs.get('oauth_token')
         self.options = kwargs.get('options', {})
         self.payload = kwargs.get('payload') or {}
+        self.payload_mutated = None
         self._query = kwargs.get('query', {}) or {}
         self.resource = kwargs.get('resource')
         self.resource_parent = kwargs.get('resource_parent')
@@ -62,12 +75,36 @@ class BaseOperation():
     async def execute(self):
         db_connection.start_cache()
 
+        presented_init = None
+        metadata = None
+        result = None
+
+        resource_key = 'resource'
+        if LIST == self.action:
+            resource_key = 'resources'
+
         response = {}
         try:
             already_validated = False
 
             result = await self.__executed_result()
-            presented = await self.__present_results(result)
+            presented_init = await self.__present_results(result)
+
+            if isinstance(result, ResultSet):
+                metadata = result.metadata
+
+            results_altered = self.__run_hooks_after(
+                condition=HookCondition.SUCCESS,
+                metadata=metadata,
+                operation_resource=result,
+                payload=self.payload_mutated,
+                **{
+                    resource_key: presented_init,
+                },
+            )
+
+            metadata = results_altered['metadata']
+            presented = results_altered[resource_key]
 
             if isinstance(presented, CustomDict) or isinstance(presented, CustomList):
                 already_validated = presented.already_validated
@@ -146,8 +183,7 @@ class BaseOperation():
                     presented_results_parsed,
                 ) >= 1 else presented_results_parsed
 
-            if isinstance(result, ResultSet):
-                response['metadata'] = result.metadata
+            response['metadata'] = metadata
 
             if settings.DEBUG:
                 debug_payload = {}
@@ -181,10 +217,21 @@ class BaseOperation():
                 if not REQUIRE_USER_PERMISSIONS:
                     err.message = 'You don’t have access to this project. ' + \
                         'Please ask an admin or owner for permissions.'
+
+            results_altered = self.__run_hooks_after(
+                condition=HookCondition.FAILURE,
+                error=self.__present_error(err),
+                metadata=metadata,
+                operation_resource=result,
+                payload=self.payload_mutated,
+                **{
+                    resource_key: presented_init,
+                },
+            )
+            response['error'] = results_altered['error']
+
             if settings.DEBUG:
                 raise err
-            else:
-                response['error'] = self.__present_error(err)
 
         db_connection.stop_cache()
 
@@ -220,13 +267,176 @@ class BaseOperation():
     def query(self, value):
         self._query = value
 
-    async def __executed_result(self):
+    def __run_hooks(
+        self,
+        operation_type: HookOperation,
+        stage: HookStage,
+        condition: HookCondition = None,
+        error: Dict = None,
+        meta: Dict = None,
+        metadata: Dict = None,
+        operation_resource: Union[BaseResource, Dict, List[BaseResource]] = None,
+        payload: Dict = None,
+        query: Dict = None,
+        resource: Dict = None,
+        resources: List[Dict] = None,
+    ) -> List[Hook]:
+        project = Project()
+        if not project.is_feature_enabled(FeatureUUID.GLOBAL_HOOKS):
+            return None
+
+        operation_types = [operation_type]
+        if HookOperation.UPDATE == operation_type:
+            operation_types.append(HookOperation.UPDATE_ANYWHERE)
+
+        try:
+            global_hooks = GlobalHooks.load_from_file()
+            hooks = global_hooks.get_and_run_hooks(
+                operation_types,
+                EntityName(self.__classified_class()),
+                stage,
+                conditions=[condition] if condition else None,
+                error=error,
+                meta=meta,
+                metadata=metadata,
+                operation_resource=operation_resource,
+                payload=payload,
+                query=query,
+                resource=resource,
+                resource_id=self.pk,
+                resource_parent_id=self.resource_parent_id,
+                resources=resources,
+                user=dict(id=self.user.id) if self.user else None,
+            )
+        except Exception:
+            hooks = []
+
+        try:
+            if hooks:
+                for hook in (hooks or []):
+                    if hook.status and HookStrategy.RAISE == hook.status.strategy:
+                        raise Exception(hook.status.error)
+
+            return hooks
+        except Exception as err:
+            raise err
+
+    def __run_hooks_after(
+        self,
+        condition: HookCondition = None,
+        error: Dict = None,
+        metadata: Dict = None,
+        operation_resource: Union[BaseResource, List[BaseResource]] = None,
+        payload: Dict = None,
+        resource: Dict = None,
+        resources: List[Dict] = None,
+    ) -> Union[Dict, List[Dict]]:
+        hooks = self.__run_hooks(
+            condition=condition,
+            error=error,
+            meta=self.meta,
+            metadata=metadata,
+            operation_resource=operation_resource,
+            operation_type=HookOperation(self.action),
+            payload=payload,
+            query=self.query,
+            resource=resource,
+            resources=resources,
+            stage=HookStage.AFTER,
+        )
+
+        if not hooks:
+            return dict(
+                error=error,
+                metadata=metadata,
+                resource=resource,
+                resources=resources,
+            )
+
+        for hook in (hooks or []):
+            output = hook.output
+
+            if not output:
+                continue
+
+            if output.get('error'):
+                error = merge_dict(error, output.get('error') or {})
+
+            if output.get('metadata'):
+                metadata = merge_dict(metadata, output.get('metadata') or {})
+
+            if output.get('resource'):
+                output_resource = output.get('resource')
+                if isinstance(output_resource, dict):
+                    resource = CustomDict(merge_dict(resource or {}, output_resource or {}))
+                    resource.already_validated = False
+
+        return dict(
+            error=error,
+            metadata=metadata,
+            resource=resource,
+            resources=resources,
+        )
+
+    def __run_hooks_before(
+        self,
+        operation_resource: Union[BaseResource, Dict, List[BaseResource]] = None,
+        payload: Dict = None,
+        **kwargs,
+    ) -> Dict:
+        if not payload:
+            payload = {}
+
+        hooks = self.__run_hooks(
+            operation_type=HookOperation(self.action),
+            stage=HookStage.BEFORE,
+            meta=self.meta,
+            operation_resource=operation_resource,
+            payload=payload,
+            query=self.query,
+        )
+
+        if not hooks:
+            return payload
+
+        for hook in (hooks or []):
+            output = hook.output
+            if not output:
+                continue
+
+            if output.get('meta'):
+                value = output.get('meta') or {}
+                if isinstance(value, dict):
+                    self.meta = merge_dict(self.meta, value)
+
+            if output.get('payload'):
+                value = output.get('payload') or {}
+                if isinstance(value, dict):
+                    payload = merge_dict(payload, value)
+
+            if output.get('query'):
+                value = output.get('query') or {}
+                if isinstance(value, dict):
+                    self.query = merge_dict(self.query, value)
+
+        self.payload_mutated = payload
+
+        return payload
+
+    async def __executed_result(self) -> Union[BaseResource, Dict, List[BaseResource]]:
         if self.action in [CREATE, LIST]:
             return await self.__create_or_index()
         elif self.action in [DELETE, DETAIL, UPDATE]:
             return await self.__delete_show_or_update()
 
-    async def __create_or_index(self):
+    async def __create_or_index(self) -> Union[BaseResource, Dict, List[BaseResource]]:
+        operation_resource = None,
+        payload = None
+        if CREATE == self.action:
+            payload = self.__payload_for_resource()
+            operation_resource = payload
+        payload = self.__run_hooks_before(operation_resource=operation_resource, payload=payload)
+
         updated_options = await self.__updated_options()
 
         policy = self.__policy_class()(None, self.user, **updated_options)
@@ -250,7 +460,6 @@ class BaseOperation():
                     **parsed_value,
                 )
 
-            payload = self.__payload_for_resource()
             if parser:
                 payload = await parser.parse_write_attributes_and_authorize(
                     payload,
@@ -263,12 +472,14 @@ class BaseOperation():
             options = updated_options.copy()
             options.pop('payload', None)
 
-            return await self.__resource_class().process_create(
+            result = await self.__resource_class().process_create(
                 payload,
                 self.user,
                 result_set_from_external=policy.result_set(),
                 **options,
             )
+
+            return result
         elif LIST == self.action:
             def _build_authorize_query(
                 parsed_value: Any,
@@ -302,7 +513,7 @@ class BaseOperation():
                 **options,
             )
 
-    async def __delete_show_or_update(self):
+    async def __delete_show_or_update(self) -> BaseResource:
         updated_options = await self.__updated_options()
 
         res = await self.__resource_class().process_member(
@@ -311,6 +522,14 @@ class BaseOperation():
             **updated_options,
         )
 
+        payload = None
+        if UPDATE == self.action:
+            payload = self.__payload_for_resource()
+        payload = self.__run_hooks_before(
+            payload=payload,
+            operation_resource=res,
+        )
+
         policy = self.__policy_class()(res, self.user, **updated_options)
         await policy.authorize_action(self.action)
 
@@ -370,7 +589,6 @@ class BaseOperation():
                     **parsed_value,
                 )
 
-            payload = self.__payload_for_resource()
             if parser:
                 payload = await parser.parse_write_attributes_and_authorize(
                     payload,

mage_ai/api/policies/BasePolicy.py

@@ -616,17 +616,17 @@ class BasePolicy(UserPermissionMixIn, ResultSetMixIn):
     async def __validate_condition(
         self,
         action,
-        conditions: List[Callable[['BasePolicy'], None]],
+        conditions_functions: List[Callable[['BasePolicy'], None]],
         attribute_operation: AttributeOperationType = None,
         operation: OperationType = None,
         override_permission_conditions: List[Callable[['BasePolicy'], None]] = None,
         **kwargs,
     ):
-        if not conditions or len(conditions) == 0:
+        if not conditions_functions or len(conditions_functions) == 0:
             return
 
         validation = False
-        for condition in conditions:
+        for condition in conditions_functions:
             validation = condition(self)
             if validation is not None and inspect.isawaitable(validation):
                 validation = await validation

mage_ai/api/policies/ComputeClusterPolicy.py

@@ -0,0 +1,96 @@
+from mage_ai.api.oauth_scope import OauthScope
+from mage_ai.api.operations.constants import OperationType
+from mage_ai.api.policies.BasePolicy import BasePolicy
+from mage_ai.api.presenters.ComputeClusterPresenter import ComputeClusterPresenter
+
+
+class ComputeClusterPolicy(BasePolicy):
+    pass
+
+
+ComputeClusterPolicy.allow_actions(
+    [
+        OperationType.DETAIL,
+        OperationType.LIST,
+    ],
+    scopes=[
+        OauthScope.CLIENT_PRIVATE,
+    ],
+    condition=lambda policy: policy.has_at_least_viewer_role(),
+    override_permission_condition=lambda _policy: True,
+)
+
+
+ComputeClusterPolicy.allow_actions(
+    [
+        OperationType.CREATE,
+        OperationType.DELETE,
+        OperationType.UPDATE,
+    ],
+    scopes=[
+        OauthScope.CLIENT_PRIVATE,
+    ],
+    condition=lambda policy: policy.has_at_least_editor_role(),
+    override_permission_condition=lambda _policy: True,
+)
+
+
+ComputeClusterPolicy.allow_read(
+    ComputeClusterPresenter.default_attributes,
+    scopes=[
+        OauthScope.CLIENT_PRIVATE,
+    ],
+    on_action=[
+        OperationType.DETAIL,
+        OperationType.LIST,
+    ],
+    condition=lambda policy: policy.has_at_least_viewer_role(),
+    override_permission_condition=lambda _policy: True,
+)
+
+
+ComputeClusterPolicy.allow_read(
+    ComputeClusterPresenter.default_attributes,
+    scopes=[
+        OauthScope.CLIENT_PRIVATE,
+    ],
+    on_action=[
+        OperationType.CREATE,
+        OperationType.DELETE,
+        OperationType.UPDATE,
+    ],
+    condition=lambda policy: policy.has_at_least_editor_role(),
+    override_permission_condition=lambda _policy: True,
+)
+
+
+ComputeClusterPolicy.allow_write(
+    [
+        'active',
+    ],
+    scopes=[
+        OauthScope.CLIENT_PRIVATE,
+    ],
+    on_action=[
+        OperationType.CREATE,
+        OperationType.DELETE,
+        OperationType.UPDATE,
+    ],
+    condition=lambda policy: policy.has_at_least_editor_role(),
+    override_permission_condition=lambda _policy: True,
+)
+
+
+ComputeClusterPolicy.allow_query(
+    [
+        'include_all_states',
+    ],
+    scopes=[
+        OauthScope.CLIENT_PRIVATE,
+    ],
+    on_action=[
+        OperationType.LIST,
+    ],
+    condition=lambda policy: policy.has_at_least_viewer_role(),
+    override_permission_condition=lambda _policy: True,
+)

mage_ai/api/policies/ComputeConnectionPolicy.py

@@ -0,0 +1,74 @@
+from mage_ai.api.oauth_scope import OauthScope
+from mage_ai.api.operations.constants import OperationType
+from mage_ai.api.policies.BasePolicy import BasePolicy
+from mage_ai.api.presenters.ComputeConnectionPresenter import ComputeConnectionPresenter
+
+
+class ComputeConnectionPolicy(BasePolicy):
+    pass
+
+
+ComputeConnectionPolicy.allow_actions(
+    [
+        OperationType.LIST,
+    ],
+    scopes=[
+        OauthScope.CLIENT_PRIVATE,
+    ],
+    condition=lambda policy: policy.has_at_least_viewer_role(),
+    override_permission_condition=lambda _policy: True,
+)
+
+
+ComputeConnectionPolicy.allow_actions(
+    [
+        OperationType.UPDATE,
+    ],
+    scopes=[
+        OauthScope.CLIENT_PRIVATE,
+    ],
+    condition=lambda policy: policy.has_at_least_editor_role(),
+    override_permission_condition=lambda _policy: True,
+)
+
+
+ComputeConnectionPolicy.allow_read(
+    ComputeConnectionPresenter.default_attributes,
+    scopes=[
+        OauthScope.CLIENT_PRIVATE,
+    ],
+    on_action=[
+        OperationType.LIST,
+    ],
+    condition=lambda policy: policy.has_at_least_viewer_role(),
+    override_permission_condition=lambda _policy: True,
+)
+
+
+ComputeConnectionPolicy.allow_read(
+    ComputeConnectionPresenter.default_attributes,
+    scopes=[
+        OauthScope.CLIENT_PRIVATE,
+    ],
+    on_action=[
+        OperationType.UPDATE,
+    ],
+    condition=lambda policy: policy.has_at_least_editor_role(),
+    override_permission_condition=lambda _policy: True,
+)
+
+
+ComputeConnectionPolicy.allow_write(
+    [
+        'action',
+        'connection',
+    ],
+    scopes=[
+        OauthScope.CLIENT_PRIVATE,
+    ],
+    on_action=[
+        OperationType.UPDATE,
+    ],
+    condition=lambda policy: policy.has_at_least_editor_role(),
+    override_permission_condition=lambda _policy: True,
+)

mage_ai/api/policies/ComputeServicePolicy.py

@@ -0,0 +1,50 @@
+from mage_ai.api.oauth_scope import OauthScope
+from mage_ai.api.operations.constants import OperationType
+from mage_ai.api.policies.BasePolicy import BasePolicy
+from mage_ai.api.presenters.ComputeServicePresenter import ComputeServicePresenter
+
+
+class ComputeServicePolicy(BasePolicy):
+    pass
+
+
+ComputeServicePolicy.allow_actions(
+    [
+        OperationType.DETAIL,
+        OperationType.LIST,
+    ],
+    scopes=[
+        OauthScope.CLIENT_PRIVATE,
+    ],
+    condition=lambda policy: policy.has_at_least_viewer_role(),
+    override_permission_condition=lambda _policy: True,
+)
+
+
+ComputeServicePolicy.allow_read(
+    ComputeServicePresenter.default_attributes,
+    scopes=[
+        OauthScope.CLIENT_PRIVATE,
+    ],
+    on_action=[
+        OperationType.DETAIL,
+        OperationType.LIST,
+    ],
+    condition=lambda policy: policy.has_at_least_viewer_role(),
+    override_permission_condition=lambda _policy: True,
+)
+
+
+ComputeServicePolicy.allow_query(
+    [
+        'with_clusters',
+    ],
+    scopes=[
+        OauthScope.CLIENT_PRIVATE,
+    ],
+    on_action=[
+        OperationType.DETAIL,
+    ],
+    condition=lambda policy: policy.has_at_least_viewer_role(),
+    override_permission_condition=lambda _policy: True,
+)

mage_ai/api/policies/DownloadPolicy.py

@@ -0,0 +1,29 @@
+from mage_ai.api.oauth_scope import OauthScope
+from mage_ai.api.operations import constants
+from mage_ai.api.policies.BasePolicy import BasePolicy
+from mage_ai.api.presenters.DownloadPresenter import DownloadPresenter
+
+
+class DownloadPolicy(BasePolicy):
+    pass
+
+
+DownloadPolicy.allow_actions([
+    constants.CREATE,
+], scopes=[
+    OauthScope.CLIENT_PRIVATE,
+], condition=lambda policy: policy.has_at_least_viewer_role())
+
+DownloadPolicy.allow_read(DownloadPresenter.default_attributes + [], scopes=[
+    OauthScope.CLIENT_PRIVATE,
+], on_action=[
+    constants.CREATE,
+], condition=lambda policy: policy.has_at_least_viewer_role())
+
+DownloadPolicy.allow_write([
+    'ignore_folder_structure',
+], scopes=[
+    OauthScope.CLIENT_PRIVATE,
+], on_action=[
+    constants.CREATE,
+], condition=lambda policy: policy.has_at_least_viewer_role())