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

Update code to fix TS v.4.4 compiler errors #1091

Merged
merged 12 commits into from
Aug 27, 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
16 changes: 8 additions & 8 deletions src/App.spec.ts
Original file line number Diff line number Diff line change
Expand Up @@ -92,7 +92,7 @@ describe('App', () => {
try {
new App({ signingSecret: '' }); // eslint-disable-line @typescript-eslint/no-unused-expressions
assert.fail();
} catch (error) {
} catch (error: any) {
// Assert
assert.propertyVal(error, 'code', ErrorCode.AppInitializationError);
}
Expand All @@ -107,7 +107,7 @@ describe('App', () => {
// eslint-disable-line @typescript-eslint/no-unused-expressions
new App({ token: '', authorize: authorizeCallback, signingSecret: '' });
assert.fail();
} catch (error) {
} catch (error: any) {
// Assert
assert.propertyVal(error, 'code', ErrorCode.AppInitializationError);
assert(authorizeCallback.notCalled);
Expand All @@ -123,7 +123,7 @@ describe('App', () => {
// eslint-disable-line @typescript-eslint/no-unused-expressions
new App({ token: '', clientId: '', clientSecret: '', stateSecret: '', signingSecret: '' });
assert.fail();
} catch (error) {
} catch (error: any) {
// Assert
assert.propertyVal(error, 'code', ErrorCode.AppInitializationError);
assert(authorizeCallback.notCalled);
Expand All @@ -139,7 +139,7 @@ describe('App', () => {
// eslint-disable-line @typescript-eslint/no-unused-expressions
new App({ authorize: authorizeCallback, clientId: '', clientSecret: '', stateSecret: '', signingSecret: '' });
assert.fail();
} catch (error) {
} catch (error: any) {
// Assert
assert.propertyVal(error, 'code', ErrorCode.AppInitializationError);
assert(authorizeCallback.notCalled);
Expand All @@ -165,7 +165,7 @@ describe('App', () => {
try {
new App({ authorize: noopAuthorize }); // eslint-disable-line @typescript-eslint/no-unused-expressions
assert.fail();
} catch (error) {
} catch (error: any) {
// Assert
assert.propertyVal(error, 'code', ErrorCode.AppInitializationError);
}
Expand All @@ -180,7 +180,7 @@ describe('App', () => {
// eslint-disable-line @typescript-eslint/no-unused-expressions
new App({ token: '', signingSecret: '', socketMode: true, receiver: fakeReceiver });
assert.fail();
} catch (error) {
} catch (error: any) {
// Assert
assert.propertyVal(error, 'code', ErrorCode.AppInitializationError);
}
Expand Down Expand Up @@ -476,7 +476,7 @@ describe('App', () => {
app.use(async ({ next }) => {
try {
await next!();
} catch (err) {
} catch (err: any) {
caughtError = err;
}
});
Expand Down Expand Up @@ -560,7 +560,7 @@ describe('App', () => {

try {
await fakeReceiver.sendEvent(dummyReceiverEvent);
} catch (err) {
} catch (err: any) {
actualError = err;
}

Expand Down
8 changes: 5 additions & 3 deletions src/App.ts
Original file line number Diff line number Diff line change
Expand Up @@ -676,9 +676,10 @@ export default class App {
authorizeResult = await this.authorize(source as AuthorizeSourceData<false>, bodyArg);
}
} catch (error) {
const e = error as any;
this.logger.warn('Authorization of incoming event did not succeed. No listeners will be called.');
error.code = 'slack_bolt_authorization_error';
return this.handleError(error);
e.code = 'slack_bolt_authorization_error';
return this.handleError(e);
}

// Try to set teamId from AuthorizeResult before using one from source
Expand Down Expand Up @@ -854,7 +855,8 @@ export default class App {
},
);
} catch (error) {
return this.handleError(error);
const e = error as any;
return this.handleError(e);
}
}

Expand Down
4 changes: 2 additions & 2 deletions src/conversation-store.spec.ts
Original file line number Diff line number Diff line change
Expand Up @@ -163,7 +163,7 @@ describe('MemoryStore', () => {
try {
await store.get('CONVERSATION_ID');
assert.fail();
} catch (error) {
} catch (error: any) {
// Assert
assert.instanceOf(error, Error);
assert.notInstanceOf(error, AssertionError);
Expand All @@ -184,7 +184,7 @@ describe('MemoryStore', () => {
try {
await store.get(dummyConversationId);
assert.fail();
} catch (error) {
} catch (error: any) {
// Assert
assert.instanceOf(error, Error);
assert.notInstanceOf(error, AssertionError);
Expand Down
5 changes: 3 additions & 2 deletions src/conversation-store.ts
Original file line number Diff line number Diff line change
Expand Up @@ -64,9 +64,10 @@ export function conversationContext<ConversationState = any>(
context.conversation = await store.get(conversationId);
logger.debug(`Conversation context loaded for ID: ${conversationId}`);
} catch (error) {
if (error.message !== undefined && error.message !== 'Conversation not found') {
const e = error as any;
if (e.message !== undefined && e.message !== 'Conversation not found') {
// The conversation data can be expired - error: Conversation expired
logger.debug(`Conversation context failed loading for ID: ${conversationId}, error: ${error.message}`);
logger.debug(`Conversation context failed loading for ID: ${conversationId}, error: ${e.message}`);
}
}
} else {
Expand Down
4 changes: 2 additions & 2 deletions src/middleware/builtin.spec.ts
Original file line number Diff line number Diff line change
Expand Up @@ -181,7 +181,7 @@ describe('directMention()', () => {

try {
await middleware(fakeArgs);
} catch (err) {
} catch (err: any) {
error = err;
}

Expand Down Expand Up @@ -308,7 +308,7 @@ describe('ignoreSelf()', () => {
let error;
try {
await middleware(fakeArgs);
} catch (err) {
} catch (err: any) {
error = err;
}

Expand Down
6 changes: 3 additions & 3 deletions src/receivers/ExpressReceiver.spec.ts
Original file line number Diff line number Diff line change
Expand Up @@ -166,7 +166,7 @@ describe('ExpressReceiver', function () {
let caughtError: Error | undefined;
try {
await receiver.start(port);
} catch (error) {
} catch (error: any) {
caughtError = error;
}

Expand All @@ -188,7 +188,7 @@ describe('ExpressReceiver', function () {
await receiver.start(port);
try {
await receiver.start(port);
} catch (error) {
} catch (error: any) {
caughtError = error;
}

Expand Down Expand Up @@ -230,7 +230,7 @@ describe('ExpressReceiver', function () {
let caughtError: Error | undefined;
try {
await receiver.stop();
} catch (error) {
} catch (error: any) {
caughtError = error;
}

Expand Down
51 changes: 49 additions & 2 deletions src/receivers/HTTPReceiver.spec.ts
Original file line number Diff line number Diff line change
Expand Up @@ -71,6 +71,8 @@ describe('HTTPReceiver', function () {
});
assert.isNotNull(receiver);
});
});
describe('request handling', function () {
it('should invoke installer generateInstallUrl if a request comes into the install path', async function () {
// Arrange
const installProviderStub = sinon.createStubInstance(InstallProvider);
Expand Down Expand Up @@ -113,7 +115,7 @@ describe('HTTPReceiver', function () {
assert(installProviderStub.generateInstallUrl.calledWith(sinon.match({ metadata, scopes, userScopes })));
assert.isTrue(writeHead.calledWith(200));
});
it('should rediect installers if directInstallEnabled is true', async function () {
it('should redirect installers if directInstallEnabled is true', async function () {
// Arrange
const installProviderStub = sinon.createStubInstance(InstallProvider);
const overrides = mergeOverrides(
Expand Down Expand Up @@ -156,7 +158,52 @@ describe('HTTPReceiver', function () {
assert(installProviderStub.generateInstallUrl.calledWith(sinon.match({ metadata, scopes, userScopes })));
assert.isTrue(writeHead.calledWith(302, sinon.match.object));
});
it('should return a 404 if a request comes into neither the install path nor the redirect URI path', async function () {
it('should invoke installer handler if a request comes into the redirect URI path', async function () {
// Arrange
const installProviderStub = sinon.createStubInstance(InstallProvider, {
handleCallback: sinon.stub().resolves() as unknown as Promise<void>,
});
const overrides = mergeOverrides(
withHttpCreateServer(this.fakeCreateServer),
withHttpsCreateServer(sinon.fake.throws('Should not be used.')),
);
const HTTPReceiver = await importHTTPReceiver(overrides);

const metadata = 'this is bat country';
const scopes = ['channels:read'];
const userScopes = ['chat:write'];
const callbackOptions = {};
const receiver = new HTTPReceiver({
logger: noopLogger,
clientId: 'my-clientId',
clientSecret: 'my-client-secret',
signingSecret: 'secret',
stateSecret: 'state-secret',
scopes,
installerOptions: {
authVersion: 'v2',
redirectUriPath: '/heyo',
callbackOptions,
metadata,
userScopes,
},
});
assert.isNotNull(receiver);
receiver.installer = installProviderStub as unknown as InstallProvider;
const fakeReq: IncomingMessage = sinon.createStubInstance(IncomingMessage) as IncomingMessage;
fakeReq.url = '/heyo';
fakeReq.headers = { host: 'localhost' };
fakeReq.method = 'GET';
const fakeRes: ServerResponse & {} = sinon.createStubInstance(ServerResponse) as unknown as ServerResponse;
const writeHead = sinon.fake();
const end = sinon.fake();
fakeRes.writeHead = writeHead;
fakeRes.end = end;
/* eslint-disable-next-line @typescript-eslint/await-thenable */
await receiver.requestListener(fakeReq, fakeRes);
assert(installProviderStub.handleCallback.calledWith(fakeReq, fakeRes, callbackOptions));
});
it('should throw if a request comes into neither the install path nor the redirect URI path', async function () {
// Arrange
const installProviderStub = sinon.createStubInstance(InstallProvider);
const overrides = mergeOverrides(
Expand Down
17 changes: 11 additions & 6 deletions src/receivers/HTTPReceiver.ts
Original file line number Diff line number Diff line change
Expand Up @@ -166,13 +166,14 @@ export default class HTTPReceiver implements Receiver {
try {
this.requestListener(req, res);
} catch (error) {
if (error.code === ErrorCode.HTTPReceiverDeferredRequestError) {
const e = error as any;
if (e.code === ErrorCode.HTTPReceiverDeferredRequestError) {
this.logger.info('An unhandled request was ignored');
res.writeHead(404);
res.end();
} else {
this.logger.error('An unexpected error was encountered');
this.logger.debug(`Error details: ${error}`);
this.logger.debug(`Error details: ${e}`);
res.writeHead(500);
res.end();
}
Expand Down Expand Up @@ -276,7 +277,8 @@ export default class HTTPReceiver implements Receiver {
try {
bufferedReq = await verifySlackAuthenticity({ signingSecret: this.signingSecret }, req);
} catch (err) {
this.logger.warn(`Request verification failed: ${err.message}`);
const e = err as any;
this.logger.warn(`Request verification failed: ${e.message}`);
res.writeHead(401);
res.end();
return;
Expand All @@ -289,7 +291,8 @@ export default class HTTPReceiver implements Receiver {
try {
body = parseBody(bufferedReq);
} catch (err) {
this.logger.warn(`Malformed request body: ${err.message}`);
const e = err as any;
this.logger.warn(`Malformed request body: ${e.message}`);
res.writeHead(400);
res.end();
return;
Expand Down Expand Up @@ -370,8 +373,9 @@ export default class HTTPReceiver implements Receiver {
this.logger.debug('stored response sent');
}
} catch (err) {
const e = err as any;
this.logger.error('An unhandled error occurred while Bolt processed an event');
this.logger.debug(`Error details: ${err}, storedResponse: ${storedResponse}`);
this.logger.debug(`Error details: ${e}, storedResponse: ${storedResponse}`);
res.writeHead(500);
res.end();
}
Expand Down Expand Up @@ -412,8 +416,9 @@ export default class HTTPReceiver implements Receiver {
res.end(body);
}
} catch (err) {
const e = err as any;
this.logger.error('An unhandled error occurred while Bolt processed a request to the installation path');
this.logger.debug(`Error details: ${err}`);
this.logger.debug(`Error details: ${e}`);
}
})();
}
Expand Down
3 changes: 2 additions & 1 deletion src/receivers/SocketModeReceiver.ts
Original file line number Diff line number Diff line change
Expand Up @@ -123,7 +123,8 @@ export default class SocketModeReceiver implements Receiver {
res.end(renderHtmlForInstallPath(url));
}
} catch (err) {
throw new Error(err);
const e = err as any;
throw new Error(e);
}
} else {
this.logger.error(`Tried to reach ${req.url} which isn't a valid route.`);
Expand Down