Add find_installation support in #877

Author: seratch

slack_sdk/oauth/installation_store/amazon_s3/__init__.py

@@ -60,6 +60,22 @@ def save(self, installation: Installation):
             )
             self.logger.debug(f"S3 put_object response: {response}")
 
+            # per workspace
+            entity: str = json.dumps(installation.__dict__)
+            response = self.s3_client.put_object(
+                Bucket=self.bucket_name,
+                Body=entity,
+                Key=f"{workspace_path}/installer-latest",
+            )
+            self.logger.debug(f"S3 put_object response: {response}")
+            response = self.s3_client.put_object(
+                Bucket=self.bucket_name,
+                Body=entity,
+                Key=f"{workspace_path}/installer-{history_version}",
+            )
+            self.logger.debug(f"S3 put_object response: {response}")
+
+            # per workspace per user
             u_id = installation.user_id or none
             entity: str = json.dumps(installation.__dict__)
             response = self.s3_client.put_object(
@@ -84,6 +100,16 @@ def save(self, installation: Installation):
             )
             self.logger.debug(f"S3 put_object response: {response}")
 
+            # per workspace
+            entity: str = json.dumps(installation.__dict__)
+            response = self.s3_client.put_object(
+                Bucket=self.bucket_name,
+                Body=entity,
+                Key=f"{workspace_path}/installer-latest",
+            )
+            self.logger.debug(f"S3 put_object response: {response}")
+
+            # per workspace per user
             u_id = installation.user_id or none
             entity: str = json.dumps(installation.__dict__)
             response = self.s3_client.put_object(
@@ -94,17 +120,30 @@ def save(self, installation: Installation):
             self.logger.debug(f"S3 put_object response: {response}")
 
     async def async_find_bot(
-        self, *, enterprise_id: Optional[str], team_id: Optional[str],
+        self,
+        *,
+        enterprise_id: Optional[str],
+        team_id: Optional[str],
+        is_enterprise_install: Optional[bool] = False,
     ) -> Optional[Bot]:
-        return self.find_bot(enterprise_id=enterprise_id, team_id=team_id)
+        return self.find_bot(
+            enterprise_id=enterprise_id,
+            team_id=team_id,
+            is_enterprise_install=is_enterprise_install,
+        )
 
     def find_bot(
-        self, *, enterprise_id: Optional[str], team_id: Optional[str],
+        self,
+        *,
+        enterprise_id: Optional[str],
+        team_id: Optional[str],
+        is_enterprise_install: Optional[bool] = False,
     ) -> Optional[Bot]:
-        # Not yet implemented: org-apps support
         none = "none"
         e_id = enterprise_id or none
         t_id = team_id or none
+        if is_enterprise_install:
+            t_id = none
         workspace_path = f"{self.client_id}/{e_id}-{t_id}"
         try:
             fetch_response = self.s3_client.get_object(
@@ -118,3 +157,50 @@ def find_bot(
             message = f"Failed to find bot installation data for enterprise: {e_id}, team: {t_id}: {e}"
             self.logger.warning(message)
             return None
+
+    async def async_find_installation(
+        self,
+        *,
+        enterprise_id: Optional[str],
+        team_id: Optional[str],
+        user_id: Optional[str] = None,
+        is_enterprise_install: Optional[bool] = False,
+    ) -> Optional[Installation]:
+        return self.find_installation(
+            enterprise_id=enterprise_id,
+            team_id=team_id,
+            user_id=user_id,
+            is_enterprise_install=is_enterprise_install,
+        )
+
+    def find_installation(
+        self,
+        *,
+        enterprise_id: Optional[str],
+        team_id: Optional[str],
+        user_id: Optional[str] = None,
+        is_enterprise_install: Optional[bool] = False,
+    ) -> Optional[Installation]:
+        none = "none"
+        e_id = enterprise_id or none
+        t_id = team_id or none
+        if is_enterprise_install:
+            t_id = none
+        workspace_path = f"{self.client_id}/{e_id}-{t_id}"
+        try:
+            key = (
+                f"{workspace_path}/installer-{user_id}-latest"
+                if user_id
+                else f"{workspace_path}/installer-latest"
+            )
+            fetch_response = self.s3_client.get_object(
+                Bucket=self.bucket_name, Key=key,
+            )
+            self.logger.debug(f"S3 get_object response: {fetch_response}")
+            body = fetch_response["Body"].read().decode("utf-8")
+            data = json.loads(body)
+            return Installation(**data)
+        except Exception as e:  # skipcq: PYL-W0703
+            message = f"Failed to find an installation data for enterprise: {e_id}, team: {t_id}: {e}"
+            self.logger.warning(message)
+            return None

slack_sdk/oauth/installation_store/async_cacheable_installation_store.py

@@ -10,6 +10,7 @@
 class AsyncCacheableInstallationStore(AsyncInstallationStore):
     underlying: AsyncInstallationStore
     cached_bots: Dict[str, Bot]
+    cached_installations: Dict[str, Installation]
 
     def __init__(self, installation_store: AsyncInstallationStore):
         """A simple memory cache wrapper for any installation stores.
@@ -18,6 +19,7 @@ def __init__(self, installation_store: AsyncInstallationStore):
         """
         self.underlying = installation_store
         self.cached_bots = {}
+        self.cached_installations = {}
 
     @property
     def logger(self) -> Logger:
@@ -27,14 +29,45 @@ async def async_save(self, installation: Installation):
         return await self.underlying.async_save(installation)
 
     async def async_find_bot(
-        self, *, enterprise_id: Optional[str], team_id: Optional[str]
+        self,
+        *,
+        enterprise_id: Optional[str],
+        team_id: Optional[str],
+        is_enterprise_install: Optional[bool] = False,
     ) -> Optional[Bot]:
+        if is_enterprise_install or team_id is None:
+            team_id = ""
         key = f"{enterprise_id}-{team_id}"
         if key in self.cached_bots:
             return self.cached_bots[key]
         bot = await self.underlying.async_find_bot(
-            enterprise_id=enterprise_id, team_id=team_id
+            enterprise_id=enterprise_id,
+            team_id=team_id,
+            is_enterprise_install=is_enterprise_install,
         )
         if bot:
             self.cached_bots[key] = bot
         return bot
+
+    async def async_find_installation(
+        self,
+        *,
+        enterprise_id: Optional[str],
+        team_id: Optional[str],
+        user_id: Optional[str] = None,
+        is_enterprise_install: Optional[bool] = False,
+    ) -> Optional[Installation]:
+        if is_enterprise_install or team_id is None:
+            team_id = ""
+        key = f"{enterprise_id}-{team_id}-{user_id}"
+        if key in self.cached_installations:
+            return self.cached_installations[key]
+        installation = await self.underlying.async_find_installation(
+            enterprise_id=enterprise_id,
+            team_id=team_id,
+            user_id=user_id,
+            is_enterprise_install=is_enterprise_install,
+        )
+        if installation:
+            self.cached_installations[key] = installation
+        return installation

slack_sdk/oauth/installation_store/async_installation_store.py

@@ -14,6 +14,20 @@ async def async_save(self, installation: Installation):
         raise NotImplementedError()
 
     async def async_find_bot(
-        self, *, enterprise_id: Optional[str], team_id: Optional[str],
+        self,
+        *,
+        enterprise_id: Optional[str],
+        team_id: Optional[str],
+        is_enterprise_install: Optional[bool] = False,
     ) -> Optional[Bot]:
         raise NotImplementedError()
+
+    async def async_find_installation(
+        self,
+        *,
+        enterprise_id: Optional[str],
+        team_id: Optional[str],
+        user_id: Optional[str] = None,
+        is_enterprise_install: Optional[bool] = False,
+    ) -> Optional[Installation]:
+        raise NotImplementedError()

slack_sdk/oauth/installation_store/cacheable_installation_store.py

@@ -8,6 +8,7 @@
 class CacheableInstallationStore(InstallationStore):
     underlying: InstallationStore
     cached_bots: Dict[str, Bot]
+    cached_installations: Dict[str, Installation]
 
     def __init__(self, installation_store: InstallationStore):
         """A simple memory cache wrapper for any installation stores.
@@ -16,6 +17,7 @@ def __init__(self, installation_store: InstallationStore):
         """
         self.underlying = installation_store
         self.cached_bots = {}
+        self.cached_installations = {}
 
     @property
     def logger(self) -> Logger:
@@ -25,12 +27,45 @@ def save(self, installation: Installation):
         return self.underlying.save(installation)
 
     def find_bot(
-        self, *, enterprise_id: Optional[str], team_id: Optional[str]
+        self,
+        *,
+        enterprise_id: Optional[str],
+        team_id: Optional[str],
+        is_enterprise_install: Optional[bool] = False,
     ) -> Optional[Bot]:
+        if is_enterprise_install or team_id is None:
+            team_id = ""
         key = f"{enterprise_id}-{team_id}"
         if key in self.cached_bots:
             return self.cached_bots[key]
-        bot = self.underlying.find_bot(enterprise_id=enterprise_id, team_id=team_id)
+        bot = self.underlying.find_bot(
+            enterprise_id=enterprise_id,
+            team_id=team_id,
+            is_enterprise_install=is_enterprise_install,
+        )
         if bot:
             self.cached_bots[key] = bot
         return bot
+
+    def find_installation(
+        self,
+        *,
+        enterprise_id: Optional[str],
+        team_id: Optional[str],
+        user_id: Optional[str] = None,
+        is_enterprise_install: Optional[bool] = False,
+    ) -> Optional[Installation]:
+        if is_enterprise_install or team_id is None:
+            team_id = ""
+        key = f"{enterprise_id}-{team_id}={user_id}"
+        if key in self.cached_installations:
+            return self.cached_installations[key]
+        installation = self.underlying.find_installation(
+            enterprise_id=enterprise_id,
+            team_id=team_id,
+            user_id=user_id,
+            is_enterprise_install=is_enterprise_install,
+        )
+        if installation:
+            self.cached_installations[key] = installation
+        return installation

slack_sdk/oauth/installation_store/file/__init__.py

@@ -53,6 +53,14 @@ def save(self, installation: Installation):
             with open(f"{team_installation_dir}/bot-{history_version}", "w") as f:
                 f.write(entity)
 
+            # per workspace
+            entity: str = json.dumps(installation.__dict__)
+            with open(f"{team_installation_dir}/installer-latest", "w") as f:
+                f.write(entity)
+            with open(f"{team_installation_dir}/installer-{history_version}", "w") as f:
+                f.write(entity)
+
+            # per workspace per user
             u_id = installation.user_id or none
             entity: str = json.dumps(installation.__dict__)
             with open(f"{team_installation_dir}/installer-{u_id}-latest", "w") as f:
@@ -74,17 +82,30 @@ def save(self, installation: Installation):
                 f.write(entity)
 
     async def async_find_bot(
-        self, *, enterprise_id: Optional[str], team_id: Optional[str],
+        self,
+        *,
+        enterprise_id: Optional[str],
+        team_id: Optional[str],
+        is_enterprise_install: Optional[bool] = False,
     ) -> Optional[Bot]:
-        return self.find_bot(enterprise_id=enterprise_id, team_id=team_id)
+        return self.find_bot(
+            enterprise_id=enterprise_id,
+            team_id=team_id,
+            is_enterprise_install=is_enterprise_install,
+        )
 
     def find_bot(
-        self, *, enterprise_id: Optional[str], team_id: Optional[str],
+        self,
+        *,
+        enterprise_id: Optional[str],
+        team_id: Optional[str],
+        is_enterprise_install: Optional[bool] = False,
     ) -> Optional[Bot]:
-        # Not yet implemented: org-apps support
         none = "none"
         e_id = enterprise_id or none
         t_id = team_id or none
+        if is_enterprise_install:
+            t_id = none
         bot_filepath = f"{self.base_dir}/{e_id}-{t_id}/bot-latest"
         try:
             with open(bot_filepath) as f:
@@ -95,6 +116,49 @@ def find_bot(
             self.logger.warning(message)
             return None
 
+    async def async_find_installation(
+        self,
+        *,
+        enterprise_id: Optional[str],
+        team_id: Optional[str],
+        user_id: Optional[str] = None,
+        is_enterprise_install: Optional[bool] = False,
+    ) -> Optional[Installation]:
+        return self.find_installation(
+            enterprise_id=enterprise_id,
+            team_id=team_id,
+            user_id=user_id,
+            is_enterprise_install=is_enterprise_install,
+        )
+
+    def find_installation(
+        self,
+        *,
+        enterprise_id: Optional[str],
+        team_id: Optional[str],
+        user_id: Optional[str] = None,
+        is_enterprise_install: Optional[bool] = False,
+    ) -> Optional[Installation]:
+        none = "none"
+        e_id = enterprise_id or none
+        t_id = team_id or none
+        if is_enterprise_install:
+            t_id = none
+        installation_filepath = f"{self.base_dir}/{e_id}-{t_id}/installer-latest"
+        if user_id is not None:
+            installation_filepath = (
+                f"{self.base_dir}/{e_id}-{t_id}/installer-{user_id}-latest"
+            )
+
+        try:
+            with open(installation_filepath) as f:
+                data = json.loads(f.read())
+                return Installation(**data)
+        except FileNotFoundError as e:
+            message = f"Failed to find an installation data for enterprise: {e_id}, team: {t_id}: {e}"
+            self.logger.warning(message)
+            return None
+
     @staticmethod
     def _mkdir(path: Union[str, Path]):
         if isinstance(path, str):

slack_sdk/oauth/installation_store/installation_store.py

@@ -14,6 +14,20 @@ def save(self, installation: Installation):
         raise NotImplementedError()
 
     def find_bot(
-        self, *, enterprise_id: Optional[str], team_id: Optional[str],
+        self,
+        *,
+        enterprise_id: Optional[str],
+        team_id: Optional[str],
+        is_enterprise_install: Optional[bool] = False,
     ) -> Optional[Bot]:
         raise NotImplementedError()
+
+    def find_installation(
+        self,
+        *,
+        enterprise_id: Optional[str],
+        team_id: Optional[str],
+        user_id: Optional[str] = None,
+        is_enterprise_install: Optional[bool] = False,
+    ) -> Optional[Installation]:
+        raise NotImplementedError()