-
Notifications
You must be signed in to change notification settings - Fork 209
/
AppConfig.java
337 lines (275 loc) · 12.6 KB
/
AppConfig.java
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
package com.slack.api.bolt;
import com.slack.api.Slack;
import com.slack.api.SlackConfig;
import com.slack.api.bolt.meta.BoltLibraryVersion;
import com.slack.api.bolt.service.builtin.oauth.view.OAuthInstallPageRenderer;
import com.slack.api.bolt.service.builtin.oauth.view.OAuthRedirectUriPageRenderer;
import com.slack.api.bolt.service.builtin.oauth.view.default_impl.OAuthDefaultInstallPageRenderer;
import com.slack.api.bolt.service.builtin.oauth.view.default_impl.OAuthDefaultRedirectUriPageRenderer;
import com.slack.api.util.http.SlackHttpClient;
import lombok.AllArgsConstructor;
import lombok.Builder;
import lombok.Data;
import lombok.NoArgsConstructor;
import java.util.HashMap;
import java.util.Map;
import java.util.Optional;
/**
* Configuration for a Slack App.
*/
@Data
@Builder(toBuilder = true)
@NoArgsConstructor
@AllArgsConstructor
public class AppConfig {
public static final class EnvVariableName {
private EnvVariableName() {
}
public static final String SLACK_BOT_TOKEN = "SLACK_BOT_TOKEN";
public static final String SLACK_SIGNING_SECRET = "SLACK_SIGNING_SECRET";
public static final String SLACK_VERIFICATION_TOKEN = "SLACK_VERIFICATION_TOKEN";
public static final String SLACK_CLIENT_ID = "SLACK_CLIENT_ID";
public static final String SLACK_CLIENT_SECRET = "SLACK_CLIENT_SECRET";
public static final String SLACK_REDIRECT_URI = "SLACK_REDIRECT_URI";
public static final String SLACK_SCOPES = "SLACK_SCOPES";
public static final String SLACK_USER_SCOPES = "SLACK_USER_SCOPES";
public static final String SLACK_INSTALL_PATH = "SLACK_INSTALL_PATH";
public static final String SLACK_REDIRECT_URI_PATH = "SLACK_REDIRECT_URI_PATH";
public static final String SLACK_OAUTH_CANCELLATION_URL = "SLACK_OAUTH_CANCELLATION_URL";
public static final String SLACK_OAUTH_COMPLETION_URL = "SLACK_OAUTH_COMPLETION_URL";
@Deprecated // will be removed in v2.0
public static final String SLACK_APP_CLIENT_ID = "SLACK_APP_CLIENT_ID";
@Deprecated // will be removed in v2.0
public static final String SLACK_APP_CLIENT_SECRET = "SLACK_APP_CLIENT_SECRET";
@Deprecated // will be removed in v2.0
public static final String SLACK_APP_REDIRECT_URI = "SLACK_APP_REDIRECT_URI";
@Deprecated // will be removed in v2.0
public static final String SLACK_APP_SCOPE = "SLACK_APP_SCOPE";
@Deprecated // will be removed in v2.0
public static final String SLACK_APP_USER_SCOPE = "SLACK_APP_USER_SCOPE";
@Deprecated // will be removed in v2.0
public static final String SLACK_APP_OAUTH_START_PATH = "SLACK_APP_OAUTH_START_PATH";
@Deprecated // will be removed in v2.0
public static final String SLACK_APP_OAUTH_CALLBACK_PATH = "SLACK_APP_OAUTH_CALLBACK_PATH";
@Deprecated // will be removed in v2.0
public static final String SLACK_APP_OAUTH_CANCELLATION_URL = "SLACK_APP_OAUTH_CANCELLATION_URL";
@Deprecated // will be removed in v2.0
public static final String SLACK_APP_OAUTH_COMPLETION_URL = "SLACK_APP_OAUTH_COMPLETION_URL";
}
@Builder.Default
private transient Slack slack = Slack.getInstance(SlackConfig.DEFAULT, buildSlackHttpClient());
private static SlackHttpClient buildSlackHttpClient() {
Map<String, String> userAgentCustomInfo = new HashMap<>();
userAgentCustomInfo.put("bolt", BoltLibraryVersion.get());
SlackHttpClient client = new SlackHttpClient(SlackConfig.DEFAULT, userAgentCustomInfo);
return client;
}
@Builder.Default
private String singleTeamBotToken = System.getenv(EnvVariableName.SLACK_BOT_TOKEN);
@Builder.Default
private String signingSecret = System.getenv(EnvVariableName.SLACK_SIGNING_SECRET);
@Deprecated
@Builder.Default
private String verificationToken = System.getenv(EnvVariableName.SLACK_VERIFICATION_TOKEN);
// https://api.slack.com/docs/oauth
public boolean isDistributedApp() {
return clientId != null && clientSecret != null;
}
// --------------------------
@Builder.Default
private boolean oAuthInstallPathEnabled = false;
public boolean isOAuthInstallPathEnabled() {
return oAuthInstallPathEnabled || oAuthStartEnabled;
}
@Deprecated // will be removed in v2.0 - use oAuthInstallPathEnabled
@Builder.Default
private boolean oAuthStartEnabled = false;
@Deprecated
public boolean isOAuthStartEnabled() {
return isOAuthInstallPathEnabled();
}
@Deprecated
public void setOAuthStartEnabled(boolean enabled) {
setOAuthInstallPathEnabled(enabled);
}
// --------------------------
@Builder.Default
private boolean oAuthRedirectUriPathEnabled = false;
public boolean isOAuthRedirectUriPathEnabled() {
return oAuthRedirectUriPathEnabled || oAuthCallbackEnabled;
}
@Deprecated // will be removed in v2.0 - use oAuthRedirectUriPathEnabled
@Builder.Default
private boolean oAuthCallbackEnabled = false;
@Deprecated
public boolean isOAuthCallbackEnabled() {
return isOAuthRedirectUriPathEnabled();
}
@Deprecated
public void setOAuthCallbackEnabled(boolean enabled) {
setOAuthRedirectUriPathEnabled(enabled);
}
// --------------------------
// OAuth flow page renderer
/**
* If you prefer the behavior in v1.0 - 1.3, set this flag as false
*/
@Builder.Default
private boolean oAuthInstallPageRenderingEnabled = true;
/**
* Renders the web page content to display to installers.
*/
@Builder.Default
private transient OAuthInstallPageRenderer oAuthInstallPageRenderer =
new OAuthDefaultInstallPageRenderer();
/**
* Renders the web page content to display to installers.
*/
@Builder.Default
private transient OAuthRedirectUriPageRenderer oAuthRedirectUriPageRenderer =
new OAuthDefaultRedirectUriPageRenderer();
// --------------------------
/**
* Returns true if auth.test call result cache in MultiTeamsAuthorization middleware
* is enabled. The default is false.
*/
@Builder.Default
private boolean authTestCacheEnabled = false;
/**
* Returns the millisecond value to keep cached auth.test response in cache.
* Negative value indicates the cache is permanent. The default is 10 minutes.
*/
@Builder.Default
private long authTestCacheExpirationMillis = 600_000L;
@Builder.Default
// https://api.slack.com/authentication/migration
private boolean classicAppPermissionsEnabled = false;
/**
* The thread pool size for the built-in handy executor service.
*/
@Builder.Default
private int threadPoolSize = 10;
@Builder.Default
private String clientId = Optional.ofNullable(System.getenv(EnvVariableName.SLACK_CLIENT_ID))
.orElse(System.getenv(EnvVariableName.SLACK_APP_CLIENT_ID));
@Builder.Default
private String clientSecret = Optional.ofNullable(System.getenv(EnvVariableName.SLACK_CLIENT_SECRET))
.orElse(System.getenv(EnvVariableName.SLACK_APP_CLIENT_SECRET));
@Builder.Default
private String redirectUri = Optional.ofNullable(System.getenv(EnvVariableName.SLACK_REDIRECT_URI))
.orElse(System.getenv(EnvVariableName.SLACK_APP_REDIRECT_URI));
@Builder.Default
private String scope = Optional.ofNullable(System.getenv(EnvVariableName.SLACK_SCOPES))
.orElse(System.getenv(EnvVariableName.SLACK_APP_SCOPE));
@Builder.Default
private String userScope = Optional.ofNullable(System.getenv(EnvVariableName.SLACK_USER_SCOPES))
.orElse(System.getenv(EnvVariableName.SLACK_APP_USER_SCOPE));
private String appPath;
// --------------------------
@Deprecated // will be removed in v2.0 - use getOauthInstallRequestURI instead
public String getOauthStartRequestURI() {
return getOauthInstallRequestURI();
}
public String getOauthInstallRequestURI() {
if (appPath == null) {
return getOauthInstallPath();
} else {
return appPath + getOauthInstallPath();
}
}
// --------------------------
@Deprecated // will be removed in v2.0 - use getOauthRedirectUriRequestURI instead
public String getOauthCallbackRequestURI() {
return getOauthRedirectUriRequestURI();
}
public String getOauthRedirectUriRequestURI() {
if (appPath == null) {
return getOauthRedirectUriPath();
} else {
return appPath + getOauthRedirectUriPath();
}
}
// --------------------------
// NOTE: We should not change this default value in v1.x as it's a breaking change to existing users.
// We will be changing this in v2.0.
private static final String DEFAULT_OAUTH_INSTALL_PATH = "start";
@Deprecated // will be removed in v2.0 - use oauthInstallPath instead
@Builder.Default
private String oauthStartPath = Optional.ofNullable(System.getenv(EnvVariableName.SLACK_INSTALL_PATH))
.orElse(Optional.ofNullable(System.getenv(EnvVariableName.SLACK_APP_OAUTH_START_PATH))
.orElse(DEFAULT_OAUTH_INSTALL_PATH));
@Deprecated
public String getOauthStartPath() {
return getOauthInstallPath();
}
@Deprecated
public void setOauthStartPath(String oauthStartPath) {
setOauthInstallPath(oauthStartPath);
}
@Builder.Default
private String oauthInstallPath = Optional.ofNullable(System.getenv(EnvVariableName.SLACK_INSTALL_PATH))
.orElse(Optional.ofNullable(System.getenv(EnvVariableName.SLACK_APP_OAUTH_START_PATH))
.orElse(DEFAULT_OAUTH_INSTALL_PATH));
public String getOauthInstallPath() {
String path = this.oauthInstallPath;
String legacyPath = this.oauthStartPath;
if (path != null
&& path.equals(DEFAULT_OAUTH_INSTALL_PATH) == false
&& legacyPath.equals(DEFAULT_OAUTH_INSTALL_PATH)) {
return path;
} else {
return legacyPath;
}
}
public void setOauthInstallPath(String oauthInstallPath) {
this.oauthInstallPath = oauthInstallPath;
this.oAuthInstallPathEnabled = oauthInstallPath != null;
}
// --------------------------
// NOTE: We should not change this default value in v1.x as it's a breaking change to existing users.
// We will be changing this in v2.0.
private static final String DEFAULT_OAUTH_REDIRECT_URI_PATH = "callback";
@Deprecated // will be removed in v2.0 - use oauthRedirectUriPath instead
@Builder.Default
private String oauthCallbackPath = Optional.ofNullable(System.getenv(EnvVariableName.SLACK_REDIRECT_URI_PATH))
.orElse(Optional.ofNullable(System.getenv(EnvVariableName.SLACK_APP_OAUTH_CALLBACK_PATH))
.orElse(DEFAULT_OAUTH_REDIRECT_URI_PATH));
@Deprecated
public String getOauthCallbackPath() {
return getOauthRedirectUriPath();
}
@Deprecated
public void setOauthCallbackPath(String oauthCallbackPath) {
setOauthRedirectUriPath(oauthCallbackPath);
}
@Builder.Default
private String oauthRedirectUriPath = Optional.ofNullable(System.getenv(EnvVariableName.SLACK_REDIRECT_URI_PATH))
.orElse(Optional.ofNullable(System.getenv(EnvVariableName.SLACK_APP_OAUTH_CALLBACK_PATH))
.orElse(DEFAULT_OAUTH_REDIRECT_URI_PATH));
public String getOauthRedirectUriPath() {
String path = this.oauthRedirectUriPath;
String legacyPath = this.oauthCallbackPath;
if (path != null
&& path.equals(DEFAULT_OAUTH_REDIRECT_URI_PATH) == false
&& legacyPath.equals(DEFAULT_OAUTH_REDIRECT_URI_PATH)) {
return path;
} else {
return legacyPath;
}
}
public void setOauthRedirectUriPath(String oauthRedirectUriPath) {
this.oauthRedirectUriPath = oauthRedirectUriPath;
this.oAuthRedirectUriPathEnabled = oauthRedirectUriPath != null;
}
// --------------------------
@Builder.Default
private String oauthCancellationUrl = Optional.ofNullable(System.getenv(EnvVariableName.SLACK_OAUTH_CANCELLATION_URL))
.orElse(System.getenv(EnvVariableName.SLACK_APP_OAUTH_CANCELLATION_URL));
@Builder.Default
private String oauthCompletionUrl = Optional.ofNullable(System.getenv(EnvVariableName.SLACK_OAUTH_COMPLETION_URL))
.orElse(System.getenv(EnvVariableName.SLACK_APP_OAUTH_COMPLETION_URL));
@Builder.Default
private boolean alwaysRequestUserTokenNeeded = false;
@Builder.Default
private boolean appInitializersEnabled = true;
}