Google Cloud Storage OAuth backend #1628
Next
Next commit
oauth installation and state store for google cloud storage
- Loading branch information
commit 78b032241526a9e0998d2935840e127a89e2ec6f
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,347 @@ | ||
| # -*- coding: utf-8 -*- | ||
| """Store Slack bot install data to a Google Cloud Storage bucket.""" | ||
|
|
||
| import json | ||
| import logging | ||
| from logging import Logger | ||
| from typing import Optional | ||
|
|
||
| from google.cloud.storage import Client # type: ignore[import-untyped] | ||
|
|
||
| from slack_sdk.oauth.installation_store.async_installation_store import AsyncInstallationStore | ||
| from slack_sdk.oauth.installation_store.installation_store import InstallationStore | ||
| from slack_sdk.oauth.installation_store.models.bot import Bot | ||
| from slack_sdk.oauth.installation_store.models.installation import Installation | ||
|
|
||
|
|
||
| class GoogleCloudStorageInstallationStore(InstallationStore, AsyncInstallationStore): | ||
| """Store Slack user installation data to a Google Cloud Storage bucket. | ||
|
|
||
| https://api.slack.com/authentication/oauth-v2 | ||
|
|
||
| Attributes: | ||
| storage_client (Client): A Google Cloud Storage client to access the bucket | ||
| bucket_name (str): Bucket to store user installation data for current Slack app | ||
| client_id (str): Slack application client id | ||
| """ | ||
|
|
||
| def __init__( | ||
| self, | ||
| *, | ||
| storage_client: Client, | ||
| bucket_name: str, | ||
| client_id: str, | ||
| logger: Logger = logging.getLogger(__name__), | ||
| ): | ||
| """Creates a new instance. | ||
|
|
||
| Args: | ||
| storage_client (Client): A Google Cloud Storage client to access the bucket | ||
| bucket_name (str): Bucket to store user installation data for current Slack app | ||
| client_id (str): Slack application client id | ||
| logger (Logger): Custom logger for logging. Defaults to a new logger for this module. | ||
| """ | ||
| self.storage_client = storage_client | ||
| self.bucket = self.storage_client.bucket(bucket_name) | ||
| self.client_id = client_id | ||
| self._logger = logger | ||
|
|
||
| @property | ||
| def logger(self) -> Logger: | ||
| """Gets the internal logger if it exists, otherwise creates a new one. | ||
|
|
||
| Returns: | ||
| Logger: the logger | ||
| """ | ||
| if self._logger is None: | ||
| self._logger = logging.getLogger(__name__) | ||
| return self._logger | ||
|
|
||
| async def async_save(self, installation: Installation): | ||
| """Save user's app authorization. | ||
|
|
||
| Args: | ||
| installation (Installation): information about the user and the app usage authorization | ||
| """ | ||
| self.save(installation) | ||
|
|
||
| def save(self, installation: Installation): | ||
| """Save user's app authorization. | ||
|
|
||
| Args: | ||
| installation (Installation): information about the user and the app usage authorization | ||
| """ | ||
| # save bot data | ||
| self.save_bot(installation.to_bot()) | ||
|
|
||
| # per workspace | ||
| entity = json.dumps(installation.__dict__) | ||
| self._save_entity( | ||
| data_type="installer", | ||
| entity=entity, | ||
| enterprise_id=installation.enterprise_id, | ||
| team_id=installation.team_id, | ||
| user_id=None, | ||
| ) | ||
| self.logger.debug("Uploaded %s to Google bucket as installer", entity) | ||
|
|
||
| # per workspace per user | ||
| self._save_entity( | ||
| data_type="installer", | ||
| entity=entity, | ||
| enterprise_id=installation.enterprise_id, | ||
| team_id=installation.team_id, | ||
| user_id=installation.user_id or "none", | ||
| ) | ||
| self.logger.debug("Uploaded %s to Google bucket as installer-%s", entity, installation.user_id) | ||
|
|
||
| async def async_save_bot(self, bot: Bot): | ||
| """Save bot user authorization. | ||
|
|
||
| Args: | ||
| bot (Bot): data bout the bot | ||
| """ | ||
| self.save_bot(bot) | ||
|
|
||
| def save_bot(self, bot: Bot): | ||
| """Save bot user authorization. | ||
|
|
||
| Args: | ||
| bot (Bot): data bout the bot | ||
| """ | ||
| entity = json.dumps(bot.__dict__) | ||
| self._save_entity(data_type="bot", entity=entity, enterprise_id=bot.enterprise_id, team_id=bot.team_id, user_id=None) | ||
| self.logger.debug("Uploaded %s to Google bucket as bot", entity) | ||
|
|
||
| def _save_entity( | ||
| self, data_type: str, entity: str, enterprise_id: Optional[str], team_id: Optional[str], user_id: Optional[str] | ||
| ): | ||
| """Saves data to a GCS bucket. | ||
|
|
||
| Args: | ||
| data_type (str): data type | ||
| entity (str): data payload | ||
| enterprise_id (Optional[str]): Slack Enterprise Grid ID | ||
| team_id (Optional[str]): Slack workspace/team ID | ||
| user_id (Optional[str]): Slack user ID | ||
| """ | ||
| key = self._key(data_type=data_type, enterprise_id=enterprise_id, team_id=team_id, user_id=user_id) | ||
| blob = self.bucket.blob(key) | ||
| blob.upload_from_string(entity) | ||
|
|
||
| async def async_find_bot( | ||
| self, | ||
| *, | ||
| enterprise_id: Optional[str], | ||
| team_id: Optional[str], | ||
| is_enterprise_install: Optional[bool] = False, | ||
| ) -> Optional[Bot]: | ||
| """Check if a Slack bot user has been installed in a Slack workspace. | ||
|
|
||
| Args: | ||
| enterprise_id (Optional[str]): Slack Enterprise Grid ID | ||
| team_id (Optional[str]): Slack workspace/team ID | ||
| is_enterprise_install (Optional[str]): True if the Slack app is installed across multiple workspaces in an | ||
| Enterprise Grid. Defaults to False. | ||
|
|
||
| Returns: | ||
| Optional[Bot]: A Slack bot/app identifier object if found, else None | ||
| """ | ||
| 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], | ||
| is_enterprise_install: Optional[bool] = False, | ||
| ) -> Optional[Bot]: | ||
| """Check if a Slack bot user has been installed in a Slack workspace. | ||
|
|
||
| Args: | ||
| enterprise_id (Optional[str]): Slack Enterprise Grid ID | ||
| team_id (Optional[str]): Slack workspace/team ID | ||
| is_enterprise_install (Optional[str]): True if the Slack app is installed across multiple workspaces in an | ||
| Enterprise Grid. Defaults to False | ||
|
|
||
| Returns: | ||
| Optional[Bot]: A Slack bot/app identifier object if found, else None | ||
| """ | ||
| key = self._key( | ||
| data_type="bot", | ||
| enterprise_id=enterprise_id, | ||
| is_enterprise_install=is_enterprise_install, | ||
| team_id=team_id, | ||
| user_id=None, | ||
| ) | ||
| try: | ||
| blob = self.bucket.blob(key) | ||
| body = blob.download_as_text(encoding="utf-8") | ||
| self.logger.debug("Downloaded %s from Google bucket", body) | ||
| data = json.loads(body) | ||
| return Bot(**data) | ||
| except Exception as exc: | ||
| self.logger.warning( | ||
| "Failed to find bot installation data for enterprise: %s, team: %s: %s", enterprise_id, team_id, exc | ||
| ) | ||
| 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]: | ||
| """Check if a Slack user has installed the app. | ||
|
|
||
| Args: | ||
| enterprise_id (Optional[str]): Slack Enterprise Grid ID | ||
| team_id (Optional[str]): Slack workspace/team ID | ||
| user_id (Optional[str]): Slack user ID. Defaults to None. | ||
| is_enterprise_install (Optional[str]): True if the Slack app is installed across multiple workspaces in an | ||
| Enterprise Grid. Defaults to False | ||
|
|
||
| Returns: | ||
| Optional[Installation]: A installation identifier object if found, else None | ||
| """ | ||
| 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]: | ||
| """Check if a Slack user has installed the app. | ||
|
|
||
| Args: | ||
| enterprise_id (Optional[str]): Slack Enterprise Grid ID | ||
| team_id (Optional[str]): Slack workspace/team ID | ||
| user_id (Optional[str]): Slack user ID. Defaults to None. | ||
| is_enterprise_install (Optional[str]): True if the Slack app is installed across multiple workspaces in an | ||
| Enterprise Grid. Defaults to False | ||
|
|
||
| Returns: | ||
| Optional[Installation]: A installation identifier object if found, else None | ||
| """ | ||
| key = self._key( | ||
| data_type="installer", | ||
| enterprise_id=enterprise_id, | ||
| is_enterprise_install=is_enterprise_install, | ||
| team_id=team_id, | ||
| user_id=user_id, | ||
| ) | ||
| try: | ||
| blob = self.bucket.blob(key) | ||
| body = blob.download_as_text(encoding="utf-8") | ||
| self.logger.debug("Downloaded %s from Google bucket", body) | ||
| data = json.loads(body) | ||
| return Installation(**data) | ||
| except Exception as exc: | ||
| self.logger.warning( | ||
| "Failed to find an installation data for enterprise: %s, team: %s: %s", enterprise_id, team_id, exc | ||
| ) | ||
| return None | ||
|
|
||
| # | ||
| # adaptation of https://gist.github.com/seratch/d81a445ef4467b16f047156bf859cda8 | ||
| # | ||
|
|
||
| async def async_delete_installation( | ||
| self, *, enterprise_id: Optional[str], team_id: Optional[str], user_id: Optional[str] = None | ||
| ) -> None: | ||
| """Deletes a user's Slack installation data. | ||
|
|
||
| Args: | ||
| enterprise_id (Optional[str]): Slack Enterprise Grid ID | ||
| team_id (Optional[str]): Slack workspace/team ID | ||
| user_id (Optional[str]): Slack user ID | ||
| """ | ||
| self.delete_installation(enterprise_id=enterprise_id, team_id=team_id, user_id=user_id) | ||
|
|
||
| def delete_installation( | ||
| self, *, enterprise_id: Optional[str], team_id: Optional[str], user_id: Optional[str] = None | ||
| ) -> None: | ||
| """Deletes a user's Slack installation data. | ||
|
|
||
| Args: | ||
| enterprise_id (Optional[str]): Slack Enterprise Grid ID | ||
| team_id (Optional[str]): Slack workspace/team ID | ||
| user_id (Optional[str]): Slack user ID | ||
| """ | ||
| self._delete_entity(data_type="installer", enterprise_id=enterprise_id, team_id=team_id, user_id=user_id) | ||
| self.logger.debug("Uninstalled app for enterprise: %s, team: %s, user: %s", enterprise_id, team_id, user_id) | ||
|
|
||
| async def async_delete_bot(self, *, enterprise_id: Optional[str], team_id: Optional[str]) -> None: | ||
| """Deletes Slack bot user install data from the workspace. | ||
|
|
||
| Args: | ||
| enterprise_id (Optional[str]): Slack Enterprise Grid ID | ||
| team_id (Optional[str]): Slack workspace/team ID | ||
| """ | ||
| self.delete_bot(enterprise_id=enterprise_id, team_id=team_id) | ||
|
|
||
| def delete_bot(self, *, enterprise_id: Optional[str], team_id: Optional[str]) -> None: | ||
| """Deletes Slack bot user install data from the workspace. | ||
|
|
||
| Args: | ||
| enterprise_id (Optional[str]): Slack Enterprise Grid ID | ||
| team_id (Optional[str]): Slack workspace/team ID | ||
| """ | ||
| self._delete_entity(data_type="bot", enterprise_id=enterprise_id, team_id=team_id, user_id=None) | ||
| self.logger.debug("Uninstalled bot for enterprise: %s, team: %s", enterprise_id, team_id) | ||
|
|
||
| def _delete_entity( | ||
| self, data_type: str, enterprise_id: Optional[str], team_id: Optional[str], user_id: Optional[str] | ||
| ) -> None: | ||
| """Deletes an object from a Google Cloud Storage bucket. | ||
|
|
||
| Args: | ||
| data_type (str): data type | ||
| enterprise_id (Optional[str]): Slack Enterprise Grid ID | ||
| team_id (Optional[str]): Slack workspace/team ID | ||
| user_id (Optional[str]): Slack user ID | ||
| """ | ||
| key = self._key(data_type=data_type, enterprise_id=enterprise_id, team_id=team_id, user_id=user_id) | ||
| blob = self.bucket.blob(key) | ||
| if blob.exists(): | ||
| blob.delete() | ||
|
|
||
| def _key( | ||
| self, | ||
| data_type: str, | ||
| enterprise_id: Optional[str], | ||
| team_id: Optional[str], | ||
| user_id: Optional[str], | ||
| is_enterprise_install: Optional[bool] = None, | ||
| ) -> str: | ||
| """Helper method to create a path to an object in a GCS bucket. | ||
|
|
||
| Args: | ||
| data_type (str): object type | ||
| enterprise_id (Optional[str]): Slack Enterprise Grid ID | ||
| team_id (Optional[str]): Slack workspace/team ID | ||
| user_id (Optional[str]): Slack user ID | ||
|
|
||
| Returns: | ||
| str: path to data corresponding to input args | ||
| """ | ||
| none = "none" | ||
| e_id = enterprise_id or none | ||
| t_id = none if is_enterprise_install else team_id or none | ||
|
|
||
| workspace_path = f"{self.client_id}/{e_id}-{t_id}" | ||
| return f"{workspace_path}/{data_type}-{user_id}" if user_id else f"{workspace_path}/{data_type}" | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I could be wrong, but to make this really async you should use for async methods
gcloud-aio-storagepackage that supports async GCS as there is no support for it in original Google Cloud Storage package:https://talkiq.github.io/gcloud-aio/autoapi/storage/index.html
This is to all async methods here - but also question to other storages (File, S3, SQLite etc.) that are doing this and they aren't trully async as they just use synchronous methods. SQLite for example needs to use
aiosqlitefor async methods to be trully async.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thank's for pointing this out. It's true that this implementation doesn't provide true async support because it relies on the synchronous methods of the official
google-cloud-storagepackage. However, one of the goals here is to unblock users who need to work with the async version of the app and still support GCS.Looking at
gcloud-aio-storage, it does offer proper async methods but it lacks support for certain features like themax_resultsparameter when doinglist_blobsthat's used inside the InstallationStore.I agree that the asynchronous aspect of the app as a whole should be addressed, but in a future PR to ensure a more consistent approach across all backend/storage providers.