Add Support for App Manifest Endpoints (apps.manifest.*) #1123

misscoded · 2021-10-06T05:19:43Z

Summary

This pull request introduces support for the App Manifest endpoints, including:

apps.manifest.create
apps.manifest.delete
apps.manifest.export
apps.manifest.update
apps.manifest.validate
tooling.tokens.rotate

Category (place an `x` in each of the `[ ]`)

Requirements (place an `x` in each `[ ]`)

I've read and understood the Contributing Guidelines and have done my best effort to follow them.
I've read and agree to the Code of Conduct.
I've run python3 -m venv .venv && source .venv/bin/activate && ./scripts/run_validation.sh after making the changes.

misscoded · 2021-10-06T05:20:52Z

tests/slack_sdk_async/web/test_web_client_coverage.py

@@ -15,7 +15,7 @@


 class TestWebClientCoverage(unittest.TestCase):
-    # 240 endpoints as of Sept 4, 2021
+    # 240 endpoints as of Sept 4, 2021 // TODO :: update before merge


Since this relies on the publicly accessible methods, not sure how this is to be changed (or not)

You can manually add the new elements to all_api_methods in the following line of code with a TODO comment saying # TODO: we will delete this once the APIs are publicly available.

misscoded · 2021-10-06T05:22:36Z

tests/slack_sdk_async/web/test_web_client_coverage.py

@@ -366,6 +366,23 @@ async def run_method(self, method_name, method, async_method):
                    method(client_id="111.222", client_secret="xxx")["method"]
                )
                await async_method(client_id="111.222", client_secret="xxx")
+            elif method_name == "apps_manifest_create":


I've always had issues with running tests locally, but the ones currently failing either are websockets or sqlite3 related. Can debug further tomorrow, but would appreciate any guidance on how to ensure all is well.

For the sqlite3 errors, perhaps your local environment has an old version of file based databases. You can delete logs/*.db files to fix the errors. I'm not sure about the error with websockets package but you can try running tests using the scripts under scripts directory after setting up a plain python venv (python 3 -m venv .venv && source .venv/bin/activate).

Your suggestion resolved the issues I was having. Thank you!

seratch · 2021-10-06T22:25:36Z

@misscoded I just adjusted the GH Actions settings to enable CI builds for PRs toward feat- branches. Can you rebase onto the latest main revision? 0045b5d

codecov · 2021-10-06T22:30:26Z

Codecov Report

Merging #1123 (af2ba93) into feat-app-manifests (0045b5d) will increase coverage by 0.05%.
The diff coverage is 100.00%.

@@                  Coverage Diff                   @@
##           feat-app-manifests    #1123      +/-   ##
======================================================
+ Coverage               88.05%   88.10%   +0.05%     
======================================================
  Files                     110      110              
  Lines                   10681    10735      +54     
======================================================
+ Hits                     9405     9458      +53     
- Misses                   1276     1277       +1

Impacted Files	Coverage Δ
slack_sdk/web/async_client.py	`90.16% <100.00%> (+0.18%)`	⬆️
slack_sdk/web/client.py	`91.57% <100.00%> (+0.15%)`	⬆️
slack_sdk/web/legacy_client.py	`91.17% <100.00%> (+0.16%)`	⬆️
slack_sdk/socket_mode/builtin/internals.py	`70.85% <0.00%> (-0.45%)`	⬇️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 0045b5d...af2ba93. Read the comment docs.

misscoded · 2021-10-06T22:42:24Z

slack_sdk/web/async_client.py

+    async def apps_manifest_create(
+        self,
+        *,
+        manifest: str,


@seratch I want to verify I've crafted these signatures correctly. For testing purposes (and as I mentioned in the corresponding PR), I used the following:

client.apps_manifest_create(token=CONFIGURATION_ACCESS_TOKEN, manifest=VALID_APP_MANIFEST)

Again, since these tokens are so specific to this set of methods, I assume the explicit passing of the tooling token will be often utilized. Does anything need to change about the arguments to encourage this, or is what is here fine?

First of all, for all methods except api.test, token argument is available as part of kwargs. The current code works as-is.

For apps.connections.open API method, we added app_token this way for consistency with Node SDK. We may want to have something similar for tooling tokens but I think that it's not really necessary so far.

Speaking of realistic use cases, I don't think developers often want to use bot token along with tooling token in a single WebClient instance. When using apps.manifest.* endpoints, it's rare to reuse a WebClient associated with a specific workspace installation (except the case where you would like to send manifest via an existing Slack app; I don't think this is a common use case). For this reason, I think the current code should be fine.

If many people think explicit name of the argument should exist here and we receive such feedback a lot, we may revisit, though.

seratch

Looks good me (I may add integration tests later but it's okay not to have it so far). You can merge this PR if you squash commits into one in advance (or using the button to squash commits).

seratch · 2021-10-06T23:28:58Z

slack_sdk/web/async_client.py

+    async def apps_manifest_create(
+        self,
+        *,
+        manifest: str,


First of all, for all methods except api.test, token argument is available as part of kwargs. The current code works as-is.

For apps.connections.open API method, we added app_token this way for consistency with Node SDK. We may want to have something similar for tooling tokens but I think that it's not really necessary so far.

Speaking of realistic use cases, I don't think developers often want to use bot token along with tooling token in a single WebClient instance. When using apps.manifest.* endpoints, it's rare to reuse a WebClient associated with a specific workspace installation (except the case where you would like to send manifest via an existing Slack app; I don't think this is a common use case). For this reason, I think the current code should be fine.

If many people think explicit name of the argument should exist here and we receive such feedback a lot, we may revisit, though.

AntonVanGoethem · 2021-10-08T15:59:56Z

Hi everyone, awesome that you are adding support for this! Any idea on when it would be merged? I'm planning on using it to automagically change for example the slash command url with the latest ngrok link for local development. Will this be possible? The only thing I don't understand yet are the access tokens, they seems to only be valid for 12 hours? Thanks so much!

misscoded · 2021-10-08T20:57:17Z

Hi @AntonVanGoethem -- love that you're excited about this new functionality! Your use case sounds compelling, and though I've never tried it myself, I don't see why it wouldn't be possible.

In terms of availability, as this feature is still in beta, we'll be cutting a dedicated beta release here shortly, so stay tuned. 🙂

In the meantime, if you'd like to learn more about access tokens, I'd recommend checking out the documentation on these new app configuration tokens. I can confirm that they do expire after 12 hours, at which point (or ideally before) you need to refresh the token. To refresh config tokens, a call can be made to tooling.tokens.rotate, using the corresponding refresh token as an argument.

Hope this helps!

AntonVanGoethem · 2021-10-11T09:13:28Z

Okay, thanks a lot!

BeRT2me

Any updates on this "beta release"?

misscoded added enhancement M-T: A feature request for new functionality web-client labels Oct 6, 2021

misscoded requested a review from seratch October 6, 2021 05:19

misscoded commented Oct 6, 2021

View reviewed changes

misscoded added 3 commits October 6, 2021 15:26

Add support for apps.manfiest.* endpoints

4ade7da

Add support for tooling.tokens.rotate

49003dc

Update list of supported endpoints

8d1b672

misscoded force-pushed the 1119-apps-manifest-endpoints branch from e8b104c to 8d1b672 Compare October 6, 2021 22:27

Recover missed change in ci-build config

ef8338f

misscoded force-pushed the 1119-apps-manifest-endpoints branch from b40bcfd to ef8338f Compare October 6, 2021 22:33

Checkout main version of ci-build change

af2ba93

misscoded commented Oct 6, 2021

View reviewed changes

seratch approved these changes Oct 6, 2021

View reviewed changes

misscoded merged commit 441ed5e into slackapi:feat-app-manifests Oct 8, 2021

seratch added this to the 3.x milestone Oct 17, 2021

BeRT2me reviewed Jul 21, 2022

View reviewed changes

WilliamBergamin mentioned this pull request Jun 22, 2023

cant use apps.manifest methods #1381

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add Support for App Manifest Endpoints (apps.manifest.*) #1123

Add Support for App Manifest Endpoints (apps.manifest.*) #1123

misscoded commented Oct 6, 2021

misscoded Oct 6, 2021

seratch Oct 6, 2021

misscoded Oct 6, 2021

seratch Oct 6, 2021

misscoded Oct 6, 2021

seratch commented Oct 6, 2021

codecov bot commented Oct 6, 2021 •

edited

misscoded Oct 6, 2021

seratch Oct 6, 2021

seratch left a comment

seratch Oct 6, 2021

AntonVanGoethem commented Oct 8, 2021

misscoded commented Oct 8, 2021

AntonVanGoethem commented Oct 11, 2021

BeRT2me left a comment •

edited

Add Support for App Manifest Endpoints (apps.manifest.*) #1123

Add Support for App Manifest Endpoints (apps.manifest.*) #1123

Conversation

misscoded commented Oct 6, 2021

Summary

Category (place an x in each of the [ ])

Requirements (place an x in each [ ])

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

seratch commented Oct 6, 2021

codecov bot commented Oct 6, 2021 • edited

Codecov Report

Choose a reason for hiding this comment

Choose a reason for hiding this comment

seratch left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

AntonVanGoethem commented Oct 8, 2021

misscoded commented Oct 8, 2021

AntonVanGoethem commented Oct 11, 2021

BeRT2me left a comment • edited

Choose a reason for hiding this comment

Category (place an `x` in each of the `[ ]`)

Requirements (place an `x` in each `[ ]`)

codecov bot commented Oct 6, 2021 •

edited

BeRT2me left a comment •

edited