Initial commit on new repo

- add Dockerfile
- refactor main method
- web route for /img
- add LICENSE
- test for main + code coverage back to 99%
- update README (docker, deployment, examples, instructions)
- fix test_async_issue test
- fix linting

Author: ccaruceru

.coveragerc

@@ -0,0 +1,4 @@
+[report]
+
+exclude_lines =
+    if __name__ == .__main__.:

.dockerignore

@@ -0,0 +1,11 @@
+.vscode
+__pycache__
+*.json
+*.md
+htmlcov
+.coverage
+docs
+tests
+.gitignore
+.pydocstylerc
+.pylintrc

.gcloudignore

@@ -7,8 +7,10 @@ README.md
 *.template
 *.yaml
 tests
-.pylintrc
-.pydocstylerc
+*rc
 htmlcov
 .coverage
 docs
+Dockerfile
+.dockerignore
+LICENSE

Dockerfile

@@ -0,0 +1,37 @@
+### STEP 1: build dependencies
+
+FROM python:3.8-alpine3.14 as builder
+
+RUN apk add gcc==10.3.1_git20210424-r2 musl-dev==1.2.2-r3
+
+COPY requirements.txt .
+
+RUN pip install -r requirements.txt
+
+
+### STEP 2: assemble runtime
+
+FROM python:3.8-alpine3.14
+
+ENV GUNICORN_PORT=3000
+ENV GUNICORN_WORKERS=1
+ENV GUNICORN_THREADS=8
+ENV GOOGLE_APPLICATION_CREDENTIALS=/credentials.json
+
+EXPOSE ${GUNICORN_PORT}
+
+LABEL maintainer="ccaruceru"
+
+# copy built packages
+COPY --from=builder /usr/local/lib/python3.8 /usr/local/lib/python3.8
+
+WORKDIR /app
+
+COPY multi_reaction_add multi_reaction_add
+COPY resources resources
+
+ENTRYPOINT [ "/bin/sh", "-c" ]
+
+CMD ["python -m gunicorn --bind :${GUNICORN_PORT} --workers ${GUNICORN_WORKERS} \
+     --threads ${GUNICORN_THREADS} --timeout 0 --worker-class aiohttp.GunicornWebWorker \
+     multi_reaction_add.handlers:entrypoint"]

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021- ccaruceru
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -4,24 +4,30 @@
 Example:
     $ python multi_reaction_add
 
-TODO:
+Todo:
     * create new client for emoji update to avoid concurrency problems(?)
     * use X-Cloud-Trace-Context to group logs:
         https://cloud.google.com/appengine/docs/standard/python3/writing-application-logs#writing_structured_logs
 """
 
 import os
 import logging
-from aiohttp import web
 
 from multi_reaction_add.handlers import app
 from multi_reaction_add.internals import check_env
 
 
-if __name__ == "__main__":
+def main():
+    """Main entrypoint for standalone module run.
+
+    Example:
+        $ python -m multi_react_add
+    """
     check_env()
-    # add static /img route for debugging
-    app.web_app().add_routes([web.static("/img", "resources/img")])
     port = int(os.environ.get("PORT", 3000))
     logging.info("Listening on port %d", port)
     app.start(port)
+
+
+if __name__ == "__main__":
+    main()

multi_reaction_add/__main__.py

@@ -107,8 +107,8 @@ async def save_or_display_reactions(
         client (AsyncWebClient): an initialzied slack web client to communicate with slack API
         command (dict): json payload with information about the command triggered by the user
                         E.g.
-                            {'token': 'MKxqqxT4PQMBnyNJdjAocKOF', 'team_id': 'T01S9QDF7AT', 'team_domain': 'ccc-yzo4468', 'channel_id': 'D01T36EUQTT', 'channel_name': 'directmessage', 'user_id': 'U01SWNKJR6G', 'user_name': 'user.name', 'command': '/multireact', 'text': ':+1::raised_hands::eyes::clap::large_blue_circle::100::heart:', 'api_app_id': 'A01S9QL1VAT', 'is_enterprise_install': 'false', 'response_url': 'https://hooks.slack...WRrsPnTqV8QtqZ5Un0', 'trigger_id': '1917238991...9a29a6da4'} # pylint: disable=line-too-long
-                            {'api_app_id': 'A01TWV8NAEN', 'channel_id': 'D01SQA99362', 'channel_name': 'directmessage', 'command': '/multireact', 'enterprise_id': 'EG26V10SE', 'enterprise_name': 'ABK-SB', 'is_enterprise_install': 'false', 'response_url': 'https://hooks.slack....UFIRvQgGs0', 'team_domain': 'kingcom-sandbox', 'team_id': 'T8T3GKUKZ', 'token': 'wF8MDfFS8BLd30KFYLT1MlZa', 'trigger_id': '1995489393941.299118...b1d2b8f830', 'user_id': 'U01SXA059B5', 'user_name': 'cris.c'}
+                            {'token': 'MKxqqxT4PQMBnyNJdjAocKOF', 'team_id': '<tid>', 'team_domain': '<tname>', 'channel_id': 'D01T36EUQTT', 'channel_name': 'directmessage', 'user_id': 'U01SWNKJR6G', 'user_name': 'user.name', 'command': '/multireact', 'text': ':+1::eyes::clap:', 'api_app_id': '<id>', 'is_enterprise_install': 'false', 'response_url': 'https://hooks.slack...WRrsPnTqV8QtqZ5Un0', 'trigger_id': '1917238991...9a29a6da4'} # pylint: disable=line-too-long
+                            {'api_app_id': '<id>', 'channel_id': 'D01SQA99362', 'channel_name': 'directmessage', 'command': '/multireact', 'enterprise_id': '<eid>', 'enterprise_name': '<ename>', 'is_enterprise_install': 'false', 'response_url': 'https://hooks.slack....UFIRvQgGs0', 'team_domain': '<tname>', 'team_id': '<tid>', 'token': 'wF8MDfFS8BLd30KFYLT1MlZa', 'trigger_id': '1995489393941.299118...b1d2b8f830', 'user_id': 'U01SXA059B5', 'user_name': '<uname>'}
         respond (AsyncRespond): function that sends an ephemeral response for slack commands
         logger (Logger): optional logger passed to all handlers
     """
@@ -173,8 +173,8 @@ async def add_reactions(
         ack (AsyncAck): function to inform slack that an event has been received
         shortcut (dict): json payload with information about the shortcut triggered by the user
                          E.g.
-                            {'type': 'message_action', 'token': 'MKxqqxT4PQMBnyNJdjAocKOF', 'action_ts': '1617307130.812650', 'team': {'id': 'T01S9QDF7AT', 'domain': 'ccc-yzo4468'}, 'user': {'id': 'U01SWNKJR6G', 'username': 'user.name', 'team_id': 'T01S9QDF7AT', 'name': 'User Name'}, 'channel': {'id': 'C01S9QDFYNT', 'name': 'general'}, 'is_enterprise_install': False, 'enterprise': None, 'callback_id': 'add_reactions', 'trigger_id': '1921893944...3e6a446fbc18', 'response_url': 'https://hooks.slack...L9Vdrbee00sZG', 'message_ts': '1617307089.003400', 'message': {'client_msg_id': '6f9e6469-1...70b17af92b', 'type': 'message', 'text': 'asdfghjkl', 'user': 'U01SWNKJR6G', 'ts': '1617307089.003400', 'team': 'T01S9QDF7AT', 'blocks': [{'type': 'rich_text', 'block_id': 'm3V', 'elements': [{'type': 'rich_text_section', 'elements': [{'type': 'text', 'text': 'asdfghjkl'}]}]}]}} # pylint: disable=line-too-long
-                            {'action_ts': '1619339417.302061', 'callback_id': 'add_reactions', 'channel': {'id': 'C01V7KXNRRS', 'name': 'slapp-1119'}, 'enterprise': {'id': 'EG26V10SE', 'name': 'ABK-SB'}, 'is_enterprise_install': False, 'message': {'blocks': [...], 'client_msg_id': '437b2675-6524-4724-a...69a4e0b9f6', 'team': 'T8T3GKUKZ',  'text': '210', 'ts': '1619339414.000200', 'type': 'message', 'user': 'U01SXA059B5'}, 'message_ts': '1619339414.000200', 'response_url': 'https://hooks.slack....tkt5yMCogg', 'team': {'domain': 'kingcom-sandbox', 'enterprise_id': 'EG26V10SE', 'enterprise_name': 'ABK-SB',  'id': 'T8T3GKUKZ'}, 'token': 'wF8MDfFS8BLd30KFYLT1MlZa', 'trigger_id': '1991796659910.299118...7619ad8bd4', 'type': 'message_action', 'user': {'id': 'U01SXA059B5', 'name': 'cris.c', 'team_id': 'T8T3GKUKZ', 'username': 'cris.c'}}
+                            {'type': 'message_action', 'token': 'MKxqqxT4PQMBnyNJdjAocKOF', 'action_ts': '1617307130.812650', 'team': {'id': '<tid>', 'domain': '<domain>'}, 'user': {'id': 'U01SWNKJR6G', 'username': 'user.name', 'team_id': '<tid>', 'name': 'User Name'}, 'channel': {'id': 'C01S9QDFYNT', 'name': 'general'}, 'is_enterprise_install': False, 'enterprise': None, 'callback_id': 'add_reactions', 'trigger_id': '1921893944...3e6a446fbc18', 'response_url': 'https://hooks.slack...L9Vdrbee00sZG', 'message_ts': '1617307089.003400', 'message': {'client_msg_id': '6f9e6469-1...70b17af92b', 'type': 'message', 'text': 'asdfghjkl', 'user': 'U01SWNKJR6G', 'ts': '1617307089.003400', 'team': '<tid>', 'blocks': [{'type': 'rich_text', 'block_id': 'm3V', 'elements': [{'type': 'rich_text_section', 'elements': [{'type': 'text', 'text': 'asdfghjkl'}]}]}]}} # pylint: disable=line-too-long
+                            {'action_ts': '1619339417.302061', 'callback_id': 'add_reactions', 'channel': {'id': 'C01V7KXNRRS', 'name': '<chname>'}, 'enterprise': {'id': '<eid>', 'name': '<ename>'}, 'is_enterprise_install': False, 'message': {'blocks': [...], 'client_msg_id': '437b2675-6524-4724-a...69a4e0b9f6', 'team': '<tid>',  'text': '210', 'ts': '1619339414.000200', 'type': 'message', 'user': 'U01SXA059B5'}, 'message_ts': '1619339414.000200', 'response_url': 'https://hooks.slack....tkt5yMCogg', 'team': {'domain': '<domain>', 'enterprise_id': '<eid>', 'enterprise_name': '<ename>',  'id': '<tid>'}, 'token': 'wF8MDfFS8BLd30KFYLT1MlZa', 'trigger_id': '1991796659910.299118...7619ad8bd4', 'type': 'message_action', 'user': {'id': 'U01SXA059B5', 'name': '<uname>', 'team_id': '<tid>', 'username': '<uname>'}}
         client (AsyncWebClient): an initialzied slack web client to communicate with slack API
         logger (Logger): optional logger passed to all handlers
         context (AsyncBoltContext): a dictionary added to all handlers which can be used to enrich events with
@@ -309,6 +309,8 @@ async def update_home_tab(
     Args:
         client (AsyncWebClient): an initialzied slack web client to communicate with slack API
         event (dict): payload from slack server for app home opened event
+                      E.g.
+                          {'type': 'app_home_opened', 'user': 'U01SWNKJR6G', 'channel': 'D02FP4JLJ56', 'tab': 'home', 'event_ts': '1632136426.209403'}  # pylint: disable=line-too-long
         logger (Logger): optional logger passed to all handlers
         request (AsyncBoltRequest): entire request payload from slack server
     """
@@ -330,3 +332,5 @@ async def update_home_tab(
 
 # add the warmup route for aiohttp
 app.web_app().add_routes([web.get("/_ah/warmup", warmup)])
+# add static /img route for local runs/debugging
+app.web_app().add_routes([web.static("/img", "resources/img")])

multi_reaction_add/handlers.py

@@ -94,7 +94,7 @@ async def _get_reactions_in_team(client: AsyncWebClient, logger: logging.Logger)
         """Gets the custom + standard emojis available in a Slack workspace, and community emojis too.
 
         It returns the basic community emojis from emojidex.com because they are not included in the
-        Slack API response. https://king.slack.com/help/requests/3477073
+        Slack API response.
 
         Args:
             client (AsyncWebClient): an initialized slack WebClient for API calls

multi_reaction_add/internals.py

@@ -0,0 +1,21 @@
+# -*- coding: utf-8 -*-
+"""Module holding boilerplate code for running the tests"""
+
+import os
+from contextlib import contextmanager, ContextDecorator
+from unittest.mock import patch
+
+@contextmanager
+def patch_import() -> ContextDecorator:
+    """Returns a context manager where the google storage client library has been patched for testing
+
+    Yields:
+        ContextDecorator: a context manager
+    """
+    # necessary OS env vars for handlers.py module
+    keys = ["SLACK_CLIENT_ID", "SLACK_CLIENT_SECRET", "SLACK_SIGNING_SECRET",
+            "SLACK_INSTALLATION_GOOGLE_BUCKET_NAME", "SLACK_STATE_GOOGLE_BUCKET_NAME", "USER_DATA_BUCKET_NAME"]
+    # patch google storage client call and os env vars
+    with patch.dict(os.environ, {k:"" for k in keys}) as mock_env:  # pylint: disable=unused-variable
+        with patch("google.cloud.storage.Client") as mock_storage_client:
+            yield mock_storage_client