Does `WebClient` log `response_metadata.warnings`?

[yvele]

The WebClient constructor takes logging parameters as described in the documentation:

export interface WebClientOptions {
  logger?: Logger;
  logLevel?: LogLevel;
}

When calling a WebClient request, the method returns a WebAPICallResult

export interface WebAPICallResult {
  ok: boolean;
  error?: string;
  response_metadata?: {
    warnings?: string[];
    next_cursor?: string;
    scopes?: string[];
    acceptedScopes?: string[];
    retryAfter?: number;
    messages?: string[];
  };
}

My question is: Should I log myself response_metadata.warnings or does WebClient automatically log result warnings?

Can this answer be specified in the documentation (and JSDoc) please?

➡ https://tools.slack.dev/node-slack-sdk/web-api#logging

Somehow related to:

• WebAPICallResult and the error handling is not intuitive #775

Packages:

Select all that apply:

• @slack/web-api

Reproducible in:

The Slack SDK version

"@slack/web-api": "~7.9.2"

Node.js runtime version

Node.js v22.12.0

[yvele]

After digging into the source code, I found that warnings in response_metadata are indeed logged automatically by the WebClient:

node-slack-sdk/packages/web-api/src/WebClient.ts

Lines 377 to 400 in 50741bb

	// log warnings in response metadata
	if (result.response_metadata !== undefined && result.response_metadata.warnings !== undefined) {
	result.response_metadata.warnings.forEach(this.logger.warn.bind(this.logger));
	}
	// log warnings and errors in response metadata messages
	// related to https://api.slack.com/changelog/2016-09-28-response-metadata-is-on-the-way
	if (result.response_metadata !== undefined && result.response_metadata.messages !== undefined) {
	for (const msg of result.response_metadata.messages) {
	const errReg: RegExp = /\[ERROR\](.*)/;
	const warnReg: RegExp = /\[WARN\](.*)/;
	if (errReg.test(msg)) {
	const errMatch = msg.match(errReg);
	if (errMatch != null) {
	this.logger.error(errMatch[1].trim());
	}
	} else if (warnReg.test(msg)) {
	const warnMatch = msg.match(warnReg);
	if (warnMatch != null) {
	this.logger.warn(warnMatch[1].trim());
	}
	}
	}
	}

I've found the blog post: https://api.slack.com/changelog/2016-09-28-response-metadata-is-on-the-way

This behavior is helpful, but it’s not currently documented. It would be great if the official documentation and/or relevant JSDoc comments could explicitly mention that response_metadata.warnings are logged automatically, so developers know they don’t need to log these manually.

[mwbrooks]

Hi @yvele 👋🏻

Thanks for looking into whether warnings in response_metadata are logged! 🙇🏻 That's a great suggestion to update our documentation I'm happy to put together a PR. 📝

Also, special thanks to those folks with the 👍🏻 reaction! ❤ Those silent votes go a long way to showing the maintainers what matters most to everyone! 🗳

[github-actions]

👋 It looks like this issue has been open for 30 days with no activity. We'll mark this as stale for now, and wait 10 days for an update or for further comment before closing this issue out. If you think this issue needs to be prioritized, please comment to get the thread going again! Maintainers also review issues marked as stale on a regular basis and comment or adjust status if the issue needs to be reprioritized.