Merge branch 'fp-attempt-9001' into unit-test-get-messages

tests/helpers/messages/deleteMessages.ts

@@ -0,0 +1,36 @@
+import { Bot } from "../../../src/bot.ts";
+import { assertExists } from "../../deps.ts";
+import { delayUntil } from "../../utils.ts";
+
+async function ifItFailsBlameWolf(bot: Bot, channelId: bigint, reason?: string) {
+  const message = await bot.helpers.sendMessage(channelId, "Hello World!");
+  const secondMessage = await bot.helpers.sendMessage(channelId, "Hello World 2!");
+
+  // Assertions
+  assertExists(message);
+  assertExists(secondMessage);
+  // Delay the execution by to allow MESSAGE_CREATE event to be processed
+  await delayUntil(10000, () => bot.cache.messages.has(message.id) && bot.cache.messages.has(secondMessage.id));
+  // Make sure the message was created.
+  if (!bot.cache.messages.has(message.id) || !bot.cache.messages.has(secondMessage.id)) {
+    throw new Error(`The message seemed to be sent but it was not cached. Reason: ${reason}`);
+  }
+
+  // Delete the messages now
+  await bot.helpers.deleteMessages(channelId, [message.id, secondMessage.id], reason);
+
+  // Wait to give it time for MESSAGE_DELETE event
+  await delayUntil(10000, () => !bot.cache.messages.has(message.id) && !bot.cache.messages.has(secondMessage.id));
+  // Make sure they are gone from cache
+  if (bot.cache.messages.has(message.id) || bot.cache.messages.has(secondMessage.id)) {
+    throw new Error("The messages should have been deleted but they are still in cache.");
+  }
+}
+
+export async function deleteMessagesWithoutReasonTest(bot: Bot, channelId: bigint, t: Deno.TestContext) {
+  await ifItFailsBlameWolf(bot, channelId);
+}
+
+export async function deleteMessagesWithReasonTest(bot: Bot, channelId: bigint, t: Deno.TestContext) {
+  await ifItFailsBlameWolf(bot, channelId, "with a reason");
+}

tests/helpers/messages/getMessage.ts

@@ -0,0 +1,22 @@
+import { Bot } from "../../../src/bot.ts";
+import { assertEquals, assertExists } from "../../deps.ts";
+import { delayUntil } from "../../utils.ts";
+
+export async function getMessageTest(bot: Bot, channelId: bigint, t: Deno.TestContext) {
+  const message = await bot.helpers.sendMessage(channelId, "Hello World!");
+
+  // Assertions
+  assertExists(message);
+  // Delay the execution by to allow MESSAGE_CREATE event to be processed
+  await delayUntil(10000, () => bot.cache.messages.has(message.id));
+  // Make sure the message was created.
+  if (!bot.cache.messages.has(message.id)) {
+    throw new Error("The message seemed to be sent but it was not cached. Reason: ${reason}");
+  }
+
+  // Fetch the message
+  const fetchedMessage = await bot.helpers.getMessage(channelId, message.id);
+  // Check if getMessage has worked
+  assertEquals(fetchedMessage.id, message.id);
+  assertEquals(fetchedMessage.content, message.content);
+}

tests/helpers/messages/sendMessage.ts

@@ -0,0 +1,89 @@
+import { Bot } from "../../../src/bot.ts";
+import { assertExists } from "../../deps.ts";
+import { delayUntil } from "../../utils.ts";
+import { CreateMessage } from "../../../src/types/messages/create_message.ts";
+import { DiscordMessageComponentTypes } from "https://raw.githubusercontent.com/discordeno/discordeno/cool-stuff/src/types/messages/components/message_component_types.ts";
+import { DiscordButtonStyles } from "https://raw.githubusercontent.com/discordeno/discordeno/cool-stuff/src/types/messages/components/button_styles.ts";
+
+async function ifItFailsBlameWolf(bot: Bot, channelId: bigint, content: string | CreateMessage) {
+  const message = await bot.helpers.sendMessage(channelId, content);
+  // Assertions
+  assertExists(message);
+  // Delay the execution by to allow MESSAGE_CREATE event to be processed
+  await delayUntil(10000, () => bot.cache.messages.has(message.id));
+  // Make sure the message was created.
+  if (!bot.cache.messages.has(message.id)) {
+    throw new Error("The message seemed to be sent but it was not cached.");
+  }
+}
+
+export async function sendMessageWithTextTest(bot: Bot, channelId: bigint, t: Deno.TestContext) {
+  await ifItFailsBlameWolf(bot, channelId, "Hello World!");
+}
+
+export async function sendMessageWithComponents(bot: Bot, channelId: bigint, t: Deno.TestContext) {
+  await ifItFailsBlameWolf(bot, channelId, {
+    content: "Hello World!",
+    components: [
+      {
+        type: DiscordMessageComponentTypes.ActionRow,
+        components: [
+          {
+            type: DiscordMessageComponentTypes.Button,
+            label: "Doc",
+            style: DiscordButtonStyles.Link,
+            url: `https://discordeno.mod.land/`,
+          },
+          {
+            type: DiscordMessageComponentTypes.Button,
+            label: "Server",
+            style: DiscordButtonStyles.Link,
+            url: `https://discord.gg/ddeno`,
+          },
+        ],
+      },
+      {
+        type: DiscordMessageComponentTypes.ActionRow,
+        components: [
+          {
+            type: DiscordMessageComponentTypes.Button,
+            label: "Hi",
+            customId: `hi`,
+            style: DiscordButtonStyles.Primary,
+          },
+        ],
+      },
+    ],
+  });
+}
+
+export async function sendMessageWithEmbedsTest(bot: Bot, channelId: bigint, t: Deno.TestContext) {
+  await ifItFailsBlameWolf(bot, channelId, {
+    embeds: [
+      {
+        title: "Hello World",
+        description:
+          "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nullam at cursus libero. Sed egestas nec ligula sit amet sollicitudin. Curabitur.",
+        color: 0x00ff00,
+        footer: {
+          text: "Discordeno Best Lib",
+        },
+        author: {
+          name: "Cacahe",
+        },
+      },
+      {
+        title: "Goodbye World",
+        description:
+          "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Aenean libero enim, blandit tincidunt magna non, auctor pellentesque lacus. Nulla diam.",
+        color: 0x0000ff,
+        footer: {
+          text: "Discordeno Best Lib",
+        },
+        author: {
+          name: "Wolf",
+        },
+      },
+    ],
+  });
+}

tests/local.ts

@@ -1,4 +1,4 @@
 import "./local/snowflake.ts";
-import "./util/validateLength.ts";
-import "./util/hasProperty.ts";
+import "./util/validate_length.ts";
+import "./util/utils.ts";
 import "./util/hash.ts";

tests/mod.ts

@@ -3,10 +3,17 @@ import { createBot, createEventHandlers, DiscordChannelTypes, startBot, stopBot
 import { assertEquals, assertExists } from "./deps.ts";
 import { deleteMessageWithReasonTest, deleteMessageWithoutReasonTest } from "./helpers/messages/deleteMessage.ts";
 import { getMessagesTest } from "./helpers/messages/getMessages.ts";
+import { deleteMessagesWithoutReasonTest, deleteMessagesWithReasonTest } from "./helpers/messages/deleteMessages.ts";
 import { delayUntil } from "./utils.ts";
+import {
+  sendMessageWithComponents,
+  sendMessageWithEmbedsTest,
+  sendMessageWithTextTest,
+} from "./helpers/messages/sendMessage.ts";
 
 // CONDUCT LOCAL TESTS FIRST BEFORE RUNNING API TEST
 import "./local.ts";
+import { getMessageTest } from "./helpers/messages/getMessage.ts";
 
 Deno.test("[Bot] - Starting Tests", async (t) => {
   // CHANGE TO TRUE WHEN DEBUGGING SANITIZATION ERRORS
@@ -77,20 +84,29 @@ Deno.test("[Bot] - Starting Tests", async (t) => {
 
     // ALL MESSAGE RELATED TESTS THAT DEPEND ON AN EXISTING CHANNEL
     await t.step("Message related tests", async (t) => {
-      const message = await bot.helpers.sendMessage(channel.id, "Testing");
-
-      // Assertions
-      assertExists(message);
-
-      // Delay the execution to allow MESSAGE_CREATE event to be processed
-      await delayUntil(10000, () => bot.cache.messages.has(message.id));
-
-      if (!bot.cache.messages.has(message.id)) {
-        throw new Error("The message seemed to be sent but it was not cached.");
-      }
-
       // CONDUCT ALL TESTS RELATED TO A MESSAGE HERE
       await Promise.all([
+        t.step({
+          name: "[message] send message with text",
+          fn: async (t) => {
+            await sendMessageWithTextTest(bot, channel.id, t);
+          },
+          ...sanitizeMode,
+        }),
+        t.step({
+          name: "[message] send message with embeds",
+          fn: async (t) => {
+            await sendMessageWithEmbedsTest(bot, channel.id, t);
+          },
+          ...sanitizeMode,
+        }),
+        t.step({
+          name: "[message] send message with components",
+          fn: async (t) => {
+            await sendMessageWithComponents(bot, channel.id, t);
+          },
+          ...sanitizeMode,
+        }),
         t.step({
           name: "[message] delete message without a reason",
           fn: async (t) => {
@@ -105,11 +121,32 @@ Deno.test("[Bot] - Starting Tests", async (t) => {
           },
           ...sanitizeMode,
         }),
+        t.step({
+          name: "[message] delete messages without a reason",
+          fn: async (t) => {
+            await deleteMessagesWithoutReasonTest(bot, channel.id, t);
+          },
+          ...sanitizeMode,
+        }),
+        t.step({
+          name: "[message] delete messages with a reason",
+          fn: async (t) => {
+            await deleteMessagesWithReasonTest(bot, channel.id, t);
+          },
+          ...sanitizeMode,
+        }),
+        t.step({
+          name: "[message] fetch a message",
+          fn: async (t) => {
+            await getMessageTest(bot, channel.id, t);
+          },
+          ...sanitizeMode,
+        }),
         t.step({
           name: "[message] fetch messages",
           fn: async (t) => {
             await getMessagesTest(bot, channel.id, t);
-          },
+           },
           ...sanitizeMode,
         }),
       ]);

tests/util/utils.ts

@@ -1,5 +1,8 @@
-import { hasProperty } from "../../src/util/utils.ts";
+import { hasProperty, delay } from "../../src/util/utils.ts";
 import { assertEquals } from "../deps.ts";
+
+// hasProperty
+
 const obj = { prop: "lts372005" };
 Deno.test({
   name: "[utils] hasProperty does HAVE property",
@@ -13,3 +16,15 @@ Deno.test({
     assertEquals(hasProperty(obj, "lts372005"), false);
   },
 });
+
+// delay
+
+Deno.test({
+  name: "[utils] delay 2000 ms",
+  async fn() {
+    const before = Date.now();
+    await delay(2000);
+    const after = Date.now();
+    if (after - before < 2000) throw new Error(`delay(2000) delayed ${after - before}ms`);
+  },
+});