Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix #496 Add clientOptions.logger option (and improvements to other attributes too) #856

Merged
merged 3 commits into from
Mar 25, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions codecov.yml
Original file line number Diff line number Diff line change
@@ -1,2 +1,10 @@
ignore:
- "examples/" # ignore examples folder and all its contents
coverage:
status:
project:
default:
threshold: 2.0%
patch:
default:
target: 50%
28 changes: 21 additions & 7 deletions src/App.ts
Original file line number Diff line number Diff line change
Expand Up @@ -237,13 +237,27 @@ export default class App {
this.logger.setLevel(this.logLevel);
}
this.errorHandler = defaultErrorHandler(this.logger);
this.clientOptions = {
agent,
// App propagates only the log level to WebClient as WebClient has its own logger
logLevel: this.logger.getLevel(),
tls: clientTls,
slackApiUrl: clientOptions !== undefined ? clientOptions.slackApiUrl : undefined,
};

this.clientOptions = clientOptions !== undefined ? clientOptions : {};
if (agent !== undefined && this.clientOptions.agent === undefined) {
this.clientOptions.agent = agent;
}
if (clientTls !== undefined && this.clientOptions.tls === undefined) {
this.clientOptions.tls = clientTls;
}
Comment on lines +242 to +247
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In the past versions, clientOptions.agent was overwritten if agent exists in the App constructor arguments. This is the same for clientOptions.tls vs clientTls.

if (logLevel !== undefined && logger === undefined) {
// only logLevel is passed
this.clientOptions.logLevel = logLevel;
} else {
if (logLevel !== undefined) {
// If the constructor has both, logLevel is ignored
this.logger.warn(
"As `logger` is passed as well, `logLevel` argument won't be used. Set the log level to the `logger` instance instead.",
);
}
// Since v3.4, WebClient starts sharing loggger with App
this.clientOptions.logger = this.logger;
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The visible change would be the name of logger. I think it's better for most apps.

}
// the public WebClient instance (app.client) - this one doesn't have a token
this.client = new WebClient(undefined, this.clientOptions);

Expand Down