Skip to content

test: add coverage for untested WebClient and IncomingWebhook behavior #2581

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.

Sign up for GitHub

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

Merged
WilliamBergamin merged 2 commits into from
May 6, 2026
+59 −0
Merged

test: add coverage for untested WebClient and IncomingWebhook behavior #2581

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
86d634e
test: add coverage for untested WebClient and IncomingWebhook behavior
WilliamBergamin May 5, 2026
77233e4
use try finally pattern
WilliamBergamin May 5, 2026
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
39 changes: 39 additions & 0 deletions packages/web-api/src/WebClient.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
import assert from 'node:assert/strict';
import fs from 'node:fs';
import { afterEach, beforeEach, describe, it } from 'node:test';
import zlib from 'node:zlib';
import type { ContextActionsBlock } from '@slack/types';
import axios, { type InternalAxiosRequestConfig } from 'axios';
import nock, { type ReplyHeaders } from 'nock';
Expand Down Expand Up @@ -465,6 +466,44 @@ describe('WebClient', () => {
}
});

it('should set error.body to the raw string when HTTP error response is not valid JSON', async () => {
const htmlBody = '<html><body><h1>502 Bad Gateway</h1></body></html>';
const scope = nock('https://slack.com').post(/api/).reply(502, htmlBody);
const client = new WebClient(token, { retryConfig: { retries: 0 } });
try {
await client.apiCall('method');
assert.fail('expected error to be thrown');
} catch (error) {
const e = error as WebAPIHTTPError;
assert.strictEqual(e.code, ErrorCode.HTTPError);
assert.strictEqual(e.statusCode, 502);
assert.strictEqual(e.body, htmlBody);
} finally {
scope.done();
}
});

describe('admin.analytics.getFile GZIP response', () => {
it('should decompress GZIP response and return file_data array', async () => {
const fileData = [
{ date: '2024-01-01', user_id: 'U123', messages_posted: 5 },
{ date: '2024-01-01', user_id: 'U456', messages_posted: 10 },
];
const ndjson = fileData.map((d) => JSON.stringify(d)).join('\n');
const gzipped = zlib.gzipSync(Buffer.from(ndjson));
const scope = nock('https://slack.com')
.post('/api/admin.analytics.getFile')
.reply(200, gzipped, { 'content-type': 'application/gzip' });
try {
const client = new WebClient(token, { retryConfig: rapidRetryPolicy });
const result = await client.apiCall('admin.analytics.getFile', { type: 'member' });
assert.deepStrictEqual(result.file_data, fileData);
} finally {
scope.done();
}
});
});

it('should properly serialize simple API arguments', async () => {
const scope = nock('https://slack.com')
// NOTE: this could create false negatives if the serialization order changes (it shouldn't matter)
Expand Down
20 changes: 20 additions & 0 deletions packages/webhook/src/IncomingWebhook.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -116,5 +116,25 @@ describe('IncomingWebhook', () => {
}
});
});

describe('User-Agent header', () => {
it('should send the User-Agent header with every request', async () => {
const scope = nock('https://hooks.slack.com', {
reqheaders: {
'User-Agent': (value) => {
return /@slack:webhook/.test(value);
},
},
})
.post(/services/)
.reply(200, 'ok');
try {
const webhook = new IncomingWebhook(url);
await webhook.send('Hello');
} finally {
scope.done();
}
});
});
});
});
Loading