fix(1528): better warnings about webclient fallbacks #1529
Merged
Conversation
This file contains 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
|
|
1 task
seratch
requested changes
Sep 5, 2022
| @@ -278,7 +278,7 @@ describe('WebClient', function () { | |||
| .map((v) => ({ method, args: Object.assign({}, v, args) })) | |||
| return acc.concat(textPatterns) | |||
| }, []).forEach(({ method, args }) => { | |||
| it(`should send both text and fallback-argument-specific warning to logs when client executes ${method} without text argument(${args.text === "" ? "empty" : args.text}) nor without attachment-level fallback argument (${args.attachments[0].fallback === " " ? "empty" : args.attachments[0].fallback})`, function () { | |||
There was a problem hiding this comment.
All the existing tests should behave the same. My intention here is that we should change the behavior only for the pattern with no text + valid fallbacks for all attachments, which is your situation. Can you add a new test pattern to cover your situation?
packages/web-api/src/WebClient.ts
Outdated
| @@ -714,9 +714,10 @@ function warnIfFallbackIsMissing(method: string, logger: Logger, options?: WebAP | |||
| 'Alternatively, you can provide an attachment-level `fallback` argument, though this is now considered a legacy field (see https://api.slack.com/reference/messaging/attachments#legacy_fields for more details).'; | |||
| if (isTargetMethod && typeof options === 'object') { | |||
| if (isEmptyText(options)) { | |||
There was a problem hiding this comment.
My intention of the new requirement is something like this:
if (missingAttachmentFallbackDetected(options)) {
if (isEmptyText(options)) {
logger.warn(buildMissingTextWarning());
}
logger.warn(buildMissingFallbackWarning());
}There was a problem hiding this comment.
i couldn't use that snippet ^ exactly because i think it broke existing functionality but i just pushed a commit that i think matches your original intention. could you give this another look when you get a chance?
seratch
added
enhancement
seratch
approved these changes
Oct 28, 2022
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Summary
fixes #1528
this PR updates the warning logic for the conversation api to better match this logic:
Requirements