Very Popular
Latest
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425import { assertEquals, assertExists, assertInstanceOf, assertRejects, isHttpError, mf,} from "./dev_deps.ts";import { SlackAPI } from "./mod.ts";import { HttpError } from "./deps.ts";
Deno.test("SlackAPI class", async (t) => { mf.install(); // mock out calls to `fetch`
await t.step( "instantiated with default API URL", async (t) => { const client = SlackAPI("test-token");
await t.step("base methods exist on client", () => { assertEquals(typeof client.apiCall, "function"); assertEquals(typeof client.response, "function"); assertEquals(typeof client.setSlackApiUrl, "function"); });
await t.step("apiCall method", async (t) => { await t.step("should call the default API URL", async () => { mf.mock("POST@/api/chat.postMessage", (req: Request) => { assertEquals(req.url, "https://slack.com/api/chat.postMessage"); assertExists(req.headers.has("user-agent")); return new Response('{"ok":true}'); });
await client.apiCall("chat.postMessage", {});
mf.reset(); });
await t.step( "should prioritize calling provided token vs. token instantiated client with", async () => { mf.mock("POST@/api/chat.postMessage", (req: Request) => { assertEquals(req.headers.get("authorization"), "Bearer override"); assertExists(req.headers.has("user-agent")); return new Response('{"ok":true}'); });
await client.apiCall("chat.postMessage", { token: "override" });
mf.reset();
mf.mock("POST@/api/chat.postMessage", (req: Request) => { assertEquals( req.headers.get("authorization"), "Bearer test-token", ); return new Response('{"ok":true}'); });
await client.apiCall("chat.postMessage", {});
mf.reset(); }, );
await t.step( "should throw an HttpError if HTTP response status code >= 400", async () => { mf.mock("POST@/api/chat.postMessage", () => { return new Response("ratelimited", { status: 429, headers: { "Retry-After": "120" }, }); });
await assertRejects( async () => { return await client.apiCall("chat.postMessage", {}); }, (error: Error) => { assertInstanceOf(error, HttpError); if (isHttpError(error)) { assertEquals(error.headers?.get("Retry-After"), "120"); assertEquals(error.status, 429); assertEquals(error.message, "429: ratelimited"); } }, );
mf.reset(); }, );
await t.step( "should return successful response JSON", async () => { mf.mock("POST@/api/chat.postMessage", () => { return new Response( '{"ok":true, "channel": "C123", "message": {}}', ); });
const res = await client.apiCall("chat.postMessage", {}); assertEquals(res.ok, true); assertEquals(res.channel, "C123"); assertEquals(res.message, {});
mf.reset(); }, );
await t.step("toFetchResponse method", async (t) => { await t.step( "should return usable Response with payload {'ok': false}", async () => { mf.mock("POST@/api/chat.postMessage", () => { return new Response('{"ok":false}', { headers: { "Retry-After": "120" }, }); });
const res = await client.apiCall("chat.postMessage", {}); assertEquals(res.ok, false); const fullRes = res.toFetchResponse(); assertInstanceOf(fullRes, Response); assertEquals(fullRes.headers?.get("Retry-After"), "120");
mf.reset(); }, ); }); });
await t.step("response method", async (t) => { await t.step( "should throw an HttpError if HTTP response status code >= 400", async () => { mf.mock("POST@/api/chat.postMessage", () => { return new Response("ratelimited", { status: 429, headers: { "Retry-After": "120" }, }); });
await assertRejects( async () => { return await client.response( "https://slack.com/api/chat.postMessage", {}, ); }, (error: Error) => { assertInstanceOf(error, HttpError); if (isHttpError(error)) { assertEquals(error.headers?.get("Retry-After"), "120"); assertEquals(error.status, 429); assertEquals(error.message, "429: ratelimited"); } }, );
mf.reset(); }, );
await t.step( "should return successful response JSON", async () => { mf.mock("POST@/api/chat.postMessage", () => { return new Response( '{"ok":true, "channel": "C123", "message": {}}', ); });
const res = await client.response( "https://slack.com/api/chat.postMessage", {}, ); assertEquals(res.ok, true); assertEquals(res.channel, "C123"); assertEquals(res.message, {});
mf.reset(); }, );
await t.step("toFetchResponse method", async (t) => { await t.step( "should return usable Response with payload {'ok': false}", async () => { mf.mock("POST@/api/chat.postMessage", () => { return new Response('{"ok":false}', { headers: { "Retry-After": "120" }, }); });
const res = await client.response( "https://slack.com/api/chat.postMessage", {}, ); assertEquals(res.ok, false); const fullRes = res.toFetchResponse(); assertInstanceOf(fullRes, Response); assertEquals(fullRes.headers?.get("Retry-After"), "120");
mf.reset(); }, ); }); }); }, );
await t.step( "instantiated with custom API URL", async (t) => { const client = SlackAPI("test-token", { slackApiUrl: "https://apitown.com/", });
await t.step("apiCall method", async (t) => { await t.step("should call the custom API URL", async () => { mf.mock("POST@/chat.postMessage", (req: Request) => { assertEquals(req.url, "https://apitown.com/chat.postMessage"); return new Response('{"ok":true}'); });
await client.apiCall("chat.postMessage", {});
mf.reset(); }); }); }, );
await t.step( "instantiated with custom API URL without trailing slash", async (t) => { const client = SlackAPI("test-token", { slackApiUrl: "https://apitown.com", });
await t.step("apiCall method", async (t) => { await t.step("should call the custom API URL", async () => { mf.mock("POST@/chat.postMessage", (req: Request) => { assertEquals(req.url, "https://apitown.com/chat.postMessage"); return new Response('{"ok":true}'); });
await client.apiCall("chat.postMessage", {});
mf.reset(); }); }); }, );
await t.step( "calling custom method accessor functions", async (t) => { const client = SlackAPI("test-token");
await t.step( "should provide single level deep api method functions", async () => { mf.mock("POST@/api/chat.postMessage", () => { return new Response('{"ok":true}'); });
const res = await client.chat.postMessage({ channel: "", text: "" }); assertEquals(res.ok, true);
mf.reset(); }, );
await t.step( "should provide deeply nested api method functions", async () => { mf.mock("POST@/api/admin.apps.approved.list", () => { return new Response('{"ok":true}'); });
const res = await client.admin.apps.approved.list(); assertEquals(res.ok, true);
mf.reset(); }, );
await t.step( "should allow for typed method calls", async () => { mf.mock("POST@/api/apps.datastore.put", () => { return new Response('{"ok":true}'); });
const TestDatastore = { name: "test", attributes: { id: "string", email: "string", }, primary_key: "id", } as const; // casted as const to validate primary_key requirement
const res = await client.apps.datastore.put<typeof TestDatastore>({ datastore: "test", item: { id: "sample", email: "test@test.com", }, }); assertEquals(res.ok, true);
mf.reset(); }, );
await t.step( "should allow for typed method calls for external auth", async () => { mf.mock("POST@/api/apps.auth.external.get", () => { return new Response('{"ok":true, "external_token": "abcd"}'); }); const TestExternalAuthId = { external_token_id: "ET12345", }; const res = await client.apps.auth.external.get(TestExternalAuthId); assertEquals(res.ok, true); assertEquals(res.external_token, "abcd"); mf.reset(); }, );
await t.step( "should allow for typed method calls for external auth with force_refresh", async () => { mf.mock("POST@/api/apps.auth.external.get", () => { return new Response('{"ok":true, "external_token": "abcd"}'); }); const res = await client.apps.auth.external.get({ external_token_id: "ET12345", force_refresh: true, }); assertEquals(res.ok, true); assertEquals(res.external_token, "abcd"); mf.reset(); }, );
await t.step( "should allow for typed method calls for external auth delete method", async () => { mf.mock("POST@/api/apps.auth.external.delete", () => { return new Response('{"ok":true}'); }); const res = await client.apps.auth.external.delete({ external_token_id: "ET12345", }); assertEquals(res.ok, true); mf.reset(); }, ); }, );
mf.uninstall();});
Deno.test("SlackApi.setSlackApiUrl()", async (t) => { mf.install(); const testClient = SlackAPI("test-token");
await t.step("override url", async () => { testClient.setSlackApiUrl("https://something.slack.com/api/");
mf.mock("POST@/api/chat.postMessage", (req: Request) => { assertEquals( req.url, "https://something.slack.com/api/chat.postMessage", ); return new Response('{"ok":true}'); });
await testClient.apiCall("chat.postMessage", {});
mf.reset(); });
await t.step("override url without trailing slash", async () => { testClient.setSlackApiUrl("https://something.slack.com/api");
mf.mock("POST@/api/chat.postMessage", (req: Request) => { assertEquals( req.url, "https://something.slack.com/api/chat.postMessage", ); return new Response('{"ok":true}'); });
await testClient.apiCall("chat.postMessage", {});
mf.reset(); });
await t.step("reset url", async () => { testClient.setSlackApiUrl("https://slack.com/api/");
mf.mock("POST@/api/chat.postMessage", (req: Request) => { assertEquals( req.url, "https://slack.com/api/chat.postMessage", ); return new Response('{"ok":true}'); });
await testClient.apiCall("chat.postMessage", {});
mf.reset(); });
mf.uninstall();});