test: add Discord.js mocks and example tests #180

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

Jump to bottom

Open

sgoodrow wants to merge 16 commits into main from refactor/discord-mocks-modular-structure

Owner

sgoodrow commented Jul 18, 2025 •

edited

Loading

Establishes testing patterns for working with discord.js and implements a few example tests.

sgoodrow and others added 2 commits

July 18, 2025 08:26


          Refactor Discord.js mocks into modular structure with type-safe helpers

d149514

- Split monolithic discord-mocks.ts into focused, co-located files
- Created reusable mock helpers with proper Jest typing
- Implemented Pick<> types for Discord.js property inheritance
- Added type-safe conversion functions with controlled assertions
- Organized structure: utils/, mocks/, matchers/, helpers/
- Eliminated type casts and 'any' usage where possible
- Added comprehensive tests for applications feature

🤖 Generated with [Claude Code](https://claude.ai/code)

Co-Authored-By: Claude <[email protected]>


          fix: ci?

412c9cd

sgoodrow commented

View reviewed changes

src/features/applications/request-application-button-commands.test.ts Outdated

Comment on lines 22 to 23

    
                    const { interaction, threadChannel } = setupApplicationTest();

                    const resolvedThreadChannel = await threadChannel;

Owner Author

sgoodrow Jul 18, 2025

This is weird, just make setupApplicationTest async.

sgoodrow commented

View reviewed changes

src/features/applications/request-application-button-commands.test.ts Outdated

Comment on lines 31 to 33

    
                    expect(resolvedThreadChannel).toHaveSentMessage(

                      `Volunteer Application sent to **${interaction.user.username}** (<@${interaction.user.id}>)`

                    );

Owner Author

sgoodrow Jul 18, 2025

This matcher should probably read more like 'toHaveReceivedMessage'

sgoodrow commented

View reviewed changes

src/features/applications/request-application-button-commands.test.ts Outdated

Comment on lines 38 to 41

    
                    const interaction = createMockButtonInteraction({ guild });

                    await expect(

                      requestApplication.execute(asButtonInteraction(interaction))

Owner Author

sgoodrow Jul 18, 2025

Seems like the mock generator should already perform asButtonInteraction cast, no?

sgoodrow commented

View reviewed changes

src/features/applications/request-application-button-commands.test.ts Outdated

    
                    expect(buttonBuilder).toHaveCustomId("volunteer-application");

                    expect(buttonBuilder).toHaveLabel("Volunteer Application");

                    expect(buttonBuilder.data.style).toBe(1);

Owner Author

sgoodrow Jul 18, 2025

What is 1? Maybe add a custom matcher for this

sgoodrow commented

View reviewed changes

src/features/applications/request-application-button-commands.test.ts Outdated

Comment on lines 79 to 89

    
                    const dmCall = interaction.user.send.mock.calls[0][0];

                    const content =

                      typeof dmCall === "string" ? dmCall : (dmCall as any).content;

                    expect(content).toContain("DO NOT REPLY TO THIS MESSAGE");

                    expect(content).toContain("How do I apply?");

                    expect(content).toContain(

                      "https://docs.google.com/forms/d/e/1FAIpQLSelYSgoouJCOIV9qoOQ1FdOXj8oGC2pfv7P47iUUd1hjOic-g/viewform"

                    );

                    expect(content).toContain("What happens to an application?");

                    expect(content).toContain("less than a week");

Owner Author

sgoodrow Jul 18, 2025

This could be cleaner, both how we get the content and how we assert on it. Probably a helper for getting the content on the interaction mock, and a fixture for the assert.

sgoodrow commented

View reviewed changes

src/features/applications/update-applications.test.ts Outdated

Comment on lines 18 to 27

    
              jest.mock("../../shared/action/instructions-ready-action", () => ({

                InstructionsReadyAction: class {

                  createOrUpdateInstructions = mockCreateOrUpdateInstructions;

                  getChannel = mockGetChannel;

                },

              }));

              jest.mock("../../shared/action/ready-action", () => ({

                readyActionExecutor: jest.fn((action, options) => action.execute()),

              }));

Owner Author

sgoodrow Jul 18, 2025

Not crazy about this. Probably a cleaner way to do this. I expect we will need to do it a lot, also it looks like tight coupling. Maybe some IoC could fix this.

sgoodrow commented

View reviewed changes

src/features/applications/update-applications.test.ts Outdated

    
                  client = asClient(createMockClient());

                  // Create instance using constructor

                  action = new UpdateApplicationInfoAction(client);

                  jest.clearAllMocks();

Owner Author

sgoodrow Jul 18, 2025

Just do this in a global before each if its needed. But also, is it?

sgoodrow commented

View reviewed changes

src/features/applications/update-applications.test.ts Outdated

    
                let action: UpdateApplicationInfoAction;

                beforeEach(() => {

                  client = asClient(createMockClient());

Owner Author

sgoodrow Jul 18, 2025

Why not do the cast inside the mock generator?

sgoodrow commented

View reviewed changes

src/features/applications/update-applications.test.ts Outdated

    
                  it("should create instructions with volunteer roles embed and button", async () => {

                    await action.execute();

                    expect(mockCreateOrUpdateInstructions).toHaveBeenCalledWith(

Owner Author

sgoodrow Jul 18, 2025

Not sure this is particularly useful as an assert. Maybe more we can do in the embed assert instead in order to check for other things like buttons.

sgoodrow commented

View reviewed changes

src/features/applications/update-applications.test.ts Outdated

    
                describe("channel getter", () => {

                  it("should get applications channel with correct ID", () => {

                    // Access the protected property through reflection

                    const channel = (action as any).channel;

Owner Author

sgoodrow Jul 18, 2025

ew, cast to any

sgoodrow commented

View reviewed changes

src/features/applications/update-applications.ts

    
              ) => readyActionExecutor(new UpdateApplicationInfoAction(client), options);

              class UpdateApplicationInfoAction extends InstructionsReadyAction {

              export class UpdateApplicationInfoAction extends InstructionsReadyAction {

Owner Author

sgoodrow Jul 18, 2025

Would be nice to not have to export this. Might mean tests need to interact at a higher level. That might also alleviate the need to mock that higher level tho.

sgoodrow commented

View reviewed changes

src/test/mocks/create-mock-guild.ts Outdated

    
                createMockThreadChannel,

              } from "./create-mock-thread-channel";

              export type TestGuild = Pick<Guild, "id"> & {

Owner Author

sgoodrow Jul 18, 2025

Standardize on these interface names. Do they start with Test or Mock?

sgoodrow and others added 14 commits

July 18, 2025 11:45


          refactor: improve testing architecture with proper mocks

72d7d06

- Eliminate asClient() and asButtonInteraction() casting
- Implement proper TypeScript structural typing for mocks
- Add integration testing via updateApplicationInfo
- Organize tests: integration tests + focused unit tests
- Standardize Mock* naming conventions
- Add shared mock utilities and better organization
- All 13 tests passing with cleaner, more maintainable code


          experiment: explore MSW for Discord.js testing

df263e5

- Added MSW setup for HTTP request mocking
- Created Discord API handlers and test examples
- Discovered MSW is not suitable for Discord.js testing because:
  * Discord.js abstracts away HTTP layer complexity
  * Heavy reliance on caching, rate limiting, WebSocket events
  * Would require reverse-engineering entire Discord API
  * Current mock-based approach is more appropriate
- Removed MSW experiment and dependencies
- Confirmed current testing strategy is the right approach


          refactor: add lightweight Discord test helpers

64a885d

- Create setupDiscordMocks() and resetDiscordMocks() helpers
- Reduce Jest mocking boilerplate from 20+ lines to 2 lines
- Keep same test structure, just eliminate repetitive setup
- Easy to adopt in existing tests without architectural changes
- Sets foundation for future dependency injection refactor


          Refactor Discord testing framework with beautiful BDD patterns

32822c1

Major improvements to Discord bot testing infrastructure:

## Testing Framework Enhancements
- **Beautiful BDD syntax**: `when("scenario", ({ it }) => { it("test", async ({ interaction, user }) => {...}) })`
- **Automatic setup**: No more manual imports or setup calls - objects provided as test parameters
- **Real integration testing**: Tests use `interactionCreateListener` to test actual Discord flow
- **Flexible config**: Optional config overrides per test block: `when("scenario", { config: {...} }, ({ it }) => {...})`

## Test Infrastructure
- Created `describe-discord.ts` with enhanced `when()` helper providing custom `it` function
- Created `discord-ui-expectations.ts` with reusable UI testing helpers
- Created `test-setup.ts` with `setupInteractionTest()` for consistent mock objects
- Enhanced `setup.ts` with automatic config mocking and comprehensive service mocks

## Developer Experience
- **Shared constants**: `features/applications/constants.ts` used by both production and test code
- **ESLint improvements**: Added `curly` rule requiring braces for all if statements
- **Better formatting**: 100 character line width for improved readability
- **Documentation**: Updated `CLAUDE.md` with successful testing patterns and philosophy

## API Examples
```typescript
// Simple test
when("handling volunteer applications", ({ it }) => {
  it("processes workflow correctly", async ({ interaction, threadChannel }) => {
    await requestApplication.execute(interaction);
    expect(threadChannel).toHaveReceivedMessage(...);
  });
});

// With custom config
when("special case", { config: { customValue: "test" } }, ({ it }) => {
  it("works with overrides", async ({ user, guild }) => {
    // Test logic here
  });
});
```

This establishes a beautiful, reusable testing framework that optimizes for both architectural soundness and developer joy.

🤖 Generated with [Claude Code](https://claude.ai/code)

Co-Authored-By: Claude <[email protected]>


          Add missing config test helper

146fe07

Essential utility for mocking config values in tests, supports the new Discord testing framework.

🤖 Generated with [Claude Code](https://claude.ai/code)

Co-Authored-By: Claude <[email protected]>


          Apply curly braces linting to test infrastructure

86a38be

Consistent formatting across all test helpers, mocks, and matchers following the new ESLint curly rule.

🤖 Generated with [Claude Code](https://claude.ai/code)

Co-Authored-By: Claude <[email protected]>


          Apply curly braces linting to core shared components

4679c13

Consistent formatting across listeners, commands, actions, and shared utilities following the new ESLint curly rule.

🤖 Generated with [Claude Code](https://claude.ai/code)

Co-Authored-By: Claude <[email protected]>


          Apply curly braces linting to miscellaneous features

deceee3

Consistent formatting across applications, auctions, gatehouse-tags, threads, wakeup, and removed features following the new ESLint curly rule.

🤖 Generated with [Claude Code](https://claude.ai/code)

Co-Authored-By: Claude <[email protected]>


          Apply curly braces linting to banking and inventory features

88dce1e

Consistent formatting across bank-hours, bank-inventory, bank-request-info, and jewelry-request-info features following the new ESLint curly rule.

🤖 Generated with [Claude Code](https://claude.ai/code)

Co-Authored-By: Claude <[email protected]>


          Apply curly braces linting to raid and bot management features

443de56

Consistent formatting across bp, raid-bots, raid-schedule-info, and raider-enlistment features following the new ESLint curly rule.

🤖 Generated with [Claude Code](https://claude.ai/code)

Co-Authored-By: Claude <[email protected]>


          Apply curly braces linting to DKP and invite management features

acdec8e

Consistent formatting across dkp-records and invite-list features following the new ESLint curly rule.

🤖 Generated with [Claude Code](https://claude.ai/code)

Co-Authored-By: Claude <[email protected]>


          Apply curly braces linting to services and data layer

bcfbc48

Consistent formatting across services, database, and redis modules following the new ESLint curly rule.

🤖 Generated with [Claude Code](https://claude.ai/code)

Co-Authored-By: Claude <[email protected]>


          Apply formatting updates to configuration files

45faee2

Update VSCode settings and Jest configuration to align with new formatting and linting rules.

🤖 Generated with [Claude Code](https://claude.ai/code)

Co-Authored-By: Claude <[email protected]>


          test(setup): ensure stable Discord mocks between tests; add modular d…

576b343

…iscord testing library and custom matchers; wire global setup with reset calls; green tests

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet