Optional env var for slash command + upgrade Starlette (#6)

Author: ccaruceru

.github/workflows/test.yml

@@ -31,36 +31,6 @@ jobs:
       run: |
         pylint tests multi_reaction_add multi_reaction_add/oauth/installation_store/google_cloud_storage multi_reaction_add/oauth/state_store/google_cloud_storage
 
-  pydocstyle:
-    runs-on: ubuntu-latest
-    steps:
-    - uses: actions/checkout@v3
-    - name: Set up Python 3.10
-      uses: actions/setup-python@v4
-      with:
-        python-version: "3.10"
-    - name: Install dependencies
-      run: |
-        python -m pip install --upgrade pip
-        pip install pydocstyle
-    - name: Pydocsyle
-      run: pydocstyle multi_reaction_add
-
-  darglint:
-    runs-on: ubuntu-latest
-    steps:
-    - uses: actions/checkout@v3
-    - name: Set up Python 3.10
-      uses: actions/setup-python@v4
-      with:
-        python-version: "3.10"
-    - name: Install dependencies
-      run: |
-        python -m pip install --upgrade pip
-        pip install darglint
-    - name: Darglint
-      run: darglint multi_reaction_add
-
   coverage:
     runs-on: ubuntu-latest
     steps:

.pydocstylerc

@@ -1,4 +1,6 @@
 # https://www.codeac.io/documentation/pylint-configuration.html
+[MAIN]
+load-plugins=pylint.extensions.docparams,pylint.extensions.docstyle
 
 [DESIGN]
 max-args=8
@@ -11,3 +13,11 @@ min-similarity-lines=6
 
 [VARIABLES]
 redefining-builtins-modules=asyncio
+
+# https://pylint.readthedocs.io/en/v2.17.4/user_guide/checkers/extensions.html#parameter-documentation-checker
+[tool.pylint.parameter_documentation]
+accept-no-param-doc = false
+accept-no-raise-doc = false
+accept-no-return-doc = false
+accept-no-yields-doc = false
+default-docstring-type = google

.pylintrc

@@ -2,7 +2,7 @@
 
 FROM python:3.10-alpine3.17 as builder
 
-RUN apk add gcc==12.2.1_git20220924-r4 musl-dev==1.2.3-r4
+RUN apk add gcc==12.2.1_git20220924-r4 musl-dev==1.2.3-r5
 
 COPY requirements.txt .
 

Dockerfile

@@ -259,24 +259,25 @@ After all information has been set and the application is deployed, users are no
 
 # Environment variables
 
-Mandatory environment variables for the App Engine Service are taken from the app's **Basic Information** page (see [Slack Application](#slack-application) section):
+Mandatory environment variables for the App Engine Service / Docker image are taken from the app's **Basic Information** page (see [Slack Application](#slack-application) section):
 - SLACK_CLIENT_ID: the **Client ID** 
 - SLACK_CLIENT_SECRET: the **Client Secret**
 - SLACK_SIGNING_SECRET: the **Signing Secret**
 
     <img src="docs/img/app-credentials.png" alt="app-credentials" width="500"/>
 
-Along with [Google Cloud Storage](https://cloud.google.com/storage/) variables:
 - GOOGLE_APPLICATION_CREDENTIALS: path to a json file with credentials for an account with permissions to GCS buckets (e.g. sa-multireact-key.json). Not required if the bot is running inside Google Cloud.
 - SLACK_INSTALLATION_GOOGLE_BUCKET_NAME: name of a bucket used to store Slack app install data per user (e.g. slack-multireact-installation)
 - SLACK_STATE_GOOGLE_BUCKET_NAME: bucket name for storing temporary OAuth state (e.g. slack-multireact-oauthstate)
 - USER_DATA_BUCKET_NAME: bucket for user emoji data (e.g. slack-multireact-userdata)
 
-Optional variables can be set for the underlying [Uvicorn ASGI](https://www.uvicorn.org/settings/), like:
-- UVICORN_PORT: specify a server socket to bind. Defaults to `3000`.
-- UVICORN_WORKERS: the number of worker processes. Defaults to `1`.
-- UVICORN_LOG_LEVEL: log verosity. defaults to `info`.
-- UVICORN_HOST: network interfaces to bind the server. Default to `0.0.0.0`.
+Optional environment variables:
+- SLACK_SLASH_COMMAND: specifies what is the slash command the app should listen for. Useful for multiple deployment in the same Slack workspace. Defaults to `/multireact`
+- [Uvicorn ASGI](https://www.uvicorn.org/settings/) variables, like:
+    - UVICORN_PORT: specify a server socket to bind. Defaults to `3000`.
+    - UVICORN_WORKERS: the number of worker processes. Defaults to `1`.
+    - UVICORN_LOG_LEVEL: log verosity. defaults to `info`.
+    - UVICORN_HOST: network interfaces to bind the server. Default to `0.0.0.0`.
 
 # Development
 Make sure you have at least Python version **3.10**, [ngrok](https://ngrok.com/download) and [Google Cloud SDK](https://cloud.google.com/sdk/docs/install), then run:
@@ -335,25 +336,13 @@ Use the following `.vscode/launch.json` file to setup a debug configuration for
 Then press `F5` to start debugging.
 
 ## Linting
-Use [pylint](http://pylint.pycqa.org/en/latest/tutorial.html) to run static code analysis. **Code rate should always be 10.00/10**.
+Use [pylint](http://pylint.pycqa.org/en/latest/tutorial.html) to run static code analysis and check if the code has well formatted docstrings according to [Google style](https://sphinxcontrib-napoleon.readthedocs.io/en/latest/example_google.html). **Code rate should always be 10.00/10**.
 ```bash
 pip install pylint
 
 pylint tests multi_reaction_add multi_reaction_add/oauth/installation_store/google_cloud_storage multi_reaction_add/oauth/state_store/google_cloud_storage
 ```
 
-Then use [pydocstyle](http://www.pydocstyle.org/en/stable/usage.html) and [darglint](https://github.com/terrencepreilly/darglint) to check if the code has well formatted docstrings according to [Google style](https://sphinxcontrib-napoleon.readthedocs.io/en/latest/example_google.html). **No errors or warnings should be reported.**
-```bash
-pip install pydocstyle darglint
-
-pydocstyle multi_reaction_add
-darglint multi_reaction_add
-```
-
-_ℹ Note: Darglint errors can be "cryptic" and you should check the [documentation](https://pythonrepo.com/repo/terrencepreilly-darglint-python-linters-style-checkers#error-codes) for the error code explanations._
-
-_ℹ Note: Darglint takes a couple of minutes to finish._
-
 ## Testing and code coverage
 
 The [tests](tests) folder contains unit tests for the app logic. You can run the tests from commandline with:

README.md

@@ -42,6 +42,7 @@
 storage_client = Client()  # initialize the Google Storage client
 bucket = storage_client.bucket(os.environ["USER_DATA_BUCKET_NAME"])
 slack_client_id = os.environ["SLACK_CLIENT_ID"]
+slash_command = os.environ.get("SLACK_SLASH_COMMAND", "/multireact")
 # initialize the app with the OAuth configuration
 app = AsyncApp(
     signing_secret=os.environ["SLACK_SIGNING_SECRET"],
@@ -69,7 +70,7 @@
 
 
 # https://api.slack.com/interactivity/slash-commands, https://slack.dev/bolt-python/concepts#commands
-@app.command("/multireact")
+@app.command(slash_command)
 async def save_or_display_reactions(
         ack: AsyncAck,
         client: AsyncWebClient,
@@ -121,20 +122,20 @@ async def save_or_display_reactions(
             reactions = " ".join(reactions)
             blob.upload_from_string(reactions)
             await respond("Great! Your new reactions are saved :sunglasses: "
-                          "Type `/multireact` to see them at any time.")
+                          f"Type `{slash_command}` to see them at any time.")
             logger.info("User %s saved %s", user_id, reactions)
 
     else:  # otherwise, report to user any reactions they have
         if blob.exists():  # display any reactions the user has saved
             reactions = blob.download_as_text(encoding="utf-8")
             reactions = " ".join([f":{r}:" for r in reactions.split(" ")])
             await respond(f"Your current reactions are: {reactions}. "
-                           "Type `/multireact <new list of emojis>` to change them.")
+                          f"Type `{slash_command} <new list of emojis>` to change them.")
             logger.info("User %s loaded %s", user_id, reactions)
 
         else:  # or say that user doesn't have any
             await respond("You do not have any reactions set :anguished:\n"
-                          "Type `/multireact <list of emojis>` to set one.")
+                          f"Type `{slash_command} <list of emojis>` to set one.")
             logger.info("User %s has no reactions", user_id)
 
 
@@ -220,7 +221,7 @@ async def add_reactions(
                         "text": {
                             "type": "mrkdwn",
                             "text": ("You do not have any reactions set :anguished:\n"
-                                     "Type `/multireact <list of emojis>` in the chat to set one.")
+                                     f"Type `{slash_command} <list of emojis>` in the chat to set one.")
                         }
                     }
                 ]
@@ -266,9 +267,9 @@ async def update_home_tab(
     user_id = event["user"]
     # https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed#domain_name_is_included_in_the_request_data
     if "host" in request.headers and len(request.headers["host"]) > 0:
-        view = build_home_tab_view(app_url=f"https://{request.headers['host'][0]}")
+        view = build_home_tab_view(slash_command, app_url=f"https://{request.headers['host'][0]}")
     else:
-        view = build_home_tab_view()
+        view = build_home_tab_view(slash_command)
 
     await client.views_publish(
         user_id=user_id,  # Use the user ID associated with the event

multi_reaction_add/handlers.py

@@ -180,10 +180,11 @@ def user_data_key(slack_client_id: str, enterprise_id: Optional[str], team_id: s
             f"{slack_client_id}/none-{team_id}/{user_id}")
 
 
-def build_home_tab_view(app_url: str = None) -> dict:
+def build_home_tab_view(slash_command: str, app_url: str = None) -> dict:
     """Builds a Slack Block Kit view for the App Home Tab.
 
     Args:
+        slash_command (str): Slack slash command the app responds to.
         app_url (str): Application URL to add additional pictures in the view. Defaults to None.
 
     Returns:
@@ -204,7 +205,7 @@ def build_home_tab_view(app_url: str = None) -> dict:
             "type": "section",
             "text": {
                 "type": "mrkdwn",
-                "text": "Type `/multireact <list of emojis>` in any chat to set a list of emojis for later usage."
+                "text": f"Type `{slash_command} <list of emojis>` in any chat to set a list of emojis for later usage."
             }
         }
     ])
@@ -226,7 +227,7 @@ def build_home_tab_view(app_url: str = None) -> dict:
         "type": "section",
         "text": {
             "type": "mrkdwn",
-            "text": "You can view what you saved any moment by typing `/multireact` in any chat."
+            "text": f"You can view what you saved any moment by typing `{slash_command}` in any chat."
         }
     })
     if app_url:

multi_reaction_add/internals.py

@@ -2,7 +2,7 @@ slack-bolt==1.16.2
 google-cloud-storage==2.7.0
 uvicorn==0.20.0
 aiohttp==3.8.3
-starlette==0.25.0
+starlette==0.28.0
 python-json-logger==2.0.4
 
 # pin the sdk dependency of bolt

requirements.txt

@@ -28,7 +28,7 @@
                                             install, oauth_redirect
 
 
-# pylint: disable=too-many-instance-attributes,attribute-defined-outside-init
+# pylint: disable=too-many-instance-attributes,attribute-defined-outside-init,missing-param-doc,missing-return-doc,missing-return-type-doc
 class TestHandlers(unittest.IsolatedAsyncioTestCase):
     """Test all methods from handlers.py"""
 
@@ -272,7 +272,7 @@ async def test_update_home_tab(self, build_home_tab_view: Mock):
             event={"user": "uid"},
             logger=self.logger,
             request=request)
-        build_home_tab_view.assert_called_once_with(app_url="https://host1")
+        build_home_tab_view.assert_called_once_with("/multireact", app_url="https://host1")
         self.client.views_publish.assert_awaited_once_with(user_id="uid", view="view")
 
         build_home_tab_view.reset_mock()
@@ -284,7 +284,7 @@ async def test_update_home_tab(self, build_home_tab_view: Mock):
             event={"user": "uid"},
             logger=self.logger,
             request=request)
-        self.assertEqual(build_home_tab_view.call_args, call())
+        build_home_tab_view.assert_called_once_with("/multireact")
         self.client.views_publish.assert_awaited_once_with(user_id="uid", view="view")
 
     @patch.dict("os.environ", {"SLACK_CLIENT_ID": "", "SLACK_CLIENT_SECRET": ""})

tests/test_handlers.py

@@ -14,7 +14,7 @@
 
 from multi_reaction_add.oauth.installation_store.google_cloud_storage import GoogleCloudStorageInstallationStore
 
-# pylint: disable=too-many-instance-attributes,attribute-defined-outside-init
+# pylint: disable=too-many-instance-attributes,attribute-defined-outside-init,missing-param-doc
 class TestGoogleInstallationStore(unittest.IsolatedAsyncioTestCase):
     """Tests for GoogleCloudStorageInstallationStore"""