Add SqliteMessageQueue and related tests #526

2chanhaeng · 2026-01-16T23:12:30Z

Summary

Introduce the SqliteMessageQueue class along with a testing framework for
message queues. Refactor existing tests to utilize the new testMessageQueue
utility for improved test structure and readability.

Related issue

closes SqliteMessageQueue for single-node deployments #477

Changes

Added SqliteMessageQueue class to @fedify/sqlite package implementing
the MessageQueue interface using SQLite as the backing store
Added testMessageQueue() utility function to @fedify/testing package
for standardized testing of MessageQueue implementations
Added waitFor() and getRandomKey() helper functions to @fedify/testing
Refactored message queue tests across multiple packages to use
testMessageQueue:
- @fedify/amqp
- @fedify/denokv
- @fedify/postgres
- @fedify/redis
Added new test file for SqliteMessageQueue
Exported new classes and functions from their respective modules

Benefits

Provides a SQLite-based message queue implementation
Reduces code duplication across message queue test files by providing
a reusable test harness
Ensures consistent test coverage across all MessageQueue implementations
Makes it easier to add new MessageQueue implementations in the future
with standardized testing

Checklist

Did you add a changelog entry to the CHANGES.md?
Did you write some relevant docs about this change (if it's a new feature)?
Did you write a regression test to reproduce the bug (if it's a bug fix)?
Did you write some tests for this change (if it's a new feature)?
Did you run mise test on your machine?

gemini-code-assist · 2026-01-16T23:12:59Z

Summary of Changes

Hello @2chanhaeng, I'm Gemini Code Assist¹! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request significantly enhances the message queuing capabilities by introducing a new SQLite-based message queue implementation. Concurrently, it establishes a robust and standardized testing framework for message queues, which has been applied to existing implementations. This dual approach not only expands the available message queue options but also improves the consistency, reliability, and maintainability of message queue tests across the project, making future integrations and testing more efficient.

Highlights

New SqliteMessageQueue Implementation: Introduced a new SqliteMessageQueue class within the @fedify/sqlite package, providing a SQLite-backed message queuing solution. This implementation supports enqueueing single and multiple messages, including delayed messages, and listening for incoming messages using a polling mechanism.
Standardized Message Queue Testing Framework: Developed a new testMessageQueue() utility function in the @fedify/testing package. This utility provides a standardized and reusable test harness for MessageQueue implementations, ensuring consistent test coverage and reducing boilerplate code.
Refactoring of Existing Message Queue Tests: Refactored the message queue tests for @fedify/amqp, @fedify/denokv, @fedify/postgres, and @fedify/redis to utilize the newly created testMessageQueue() utility. This streamlines the test files, improves readability, and ensures uniformity across different message queue implementations.
New Testing Helper Functions: Added waitFor() and getRandomKey() helper functions to the @fedify/testing package. These functions assist in asynchronous test assertions and generating unique keys for test resources, respectively.

Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature	Command	Description
Code Review	`/gemini review`	Performs a code review for the current pull request in its current state.
Pull Request Summary	`/gemini summary`	Provides a summary of the current pull request in its current state.
Comment	@gemini-code-assist	Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help	`/gemini help`	Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩

gemini-code-assist

Code Review

This pull request introduces a new SqliteMessageQueue and a standardized testing utility, testMessageQueue, to unify message queue tests across the repository. The refactoring of existing tests to use this new utility is a great step towards reducing code duplication and ensuring consistent test coverage.

My review focuses on the new implementations. I've found a couple of critical issues in the SqliteMessageQueue related to race conditions and error handling that could lead to message loss and listener crashes. I've also identified areas for improvement in the new testMessageQueue utility to make it more robust and align with the MessageQueue interface. Additionally, I've suggested a minor improvement to the SQLite test to ensure proper cleanup of temporary database files.

packages/sqlite/src/mq.ts

packages/testing/src/mq-tester.ts

packages/sqlite/src/mq.test.ts

codecov · 2026-01-16T23:20:37Z

Codecov Report

❌ Patch coverage is 95.34884% with 14 lines in your changes missing coverage. Please review.
✅ All tests successful. No failed tests found.

Files with missing lines	Patch %	Lines
packages/sqlite/src/mq.ts	94.66%	11 Missing ⚠️
packages/testing/src/mq-tester.ts	96.62%	3 Missing ⚠️

Files with missing lines	Coverage Δ
packages/postgres/src/mq.ts	`90.47% <ø> (ø)`
packages/sqlite/src/mod.ts	`100.00% <100.00%> (ø)`
packages/testing/src/mod.ts	`100.00% <100.00%> (ø)`
packages/testing/src/mq-tester.ts	`96.62% <96.62%> (ø)`
packages/sqlite/src/mq.ts	`94.66% <94.66%> (ø)`

... and 2 files with indirect coverage changes

🚀 New features to boost your workflow:

📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

- Remove `let Temporal ...` - Export `@fedify/sqlite` - Add missing dependencies

sij411 · 2026-01-17T23:02:07Z

packages/postgres/src/kv.test.ts

 }

-const dbUrl = process.env.DATABASE_URL;
+const dbUrl = process.env.POSTGRES_URL;


If this renaming is intentional, could you explain why this is needed?

The other database URL variable names are matched with their respective database names.(e.g. REDIS_URL for redis) Therefore, to avoid confusion, I've also modified this one to match the naming convention.

Aha, and that won't have side-effects, right? It's an environment variable so I just worried about that. If that's fine then I got no worries.

Well, I checked again, and then I found more DATABASE_URL! Because of you, I could check one more time. Thanks!

Fixed at df0e05a!

sij411 · 2026-01-18T01:30:29Z

How about adding [Symbol.dispose]() for consistency with other MessageQueue implementations?

packages/testing/src/mq-tester.ts

packages/sqlite/src/mq.ts

2chanhaeng · 2026-01-18T10:16:28Z

How about adding [Symbol.dispose]() for consistency with other MessageQueue implementations?

That's a good idea, but it seems to go beyond #477. How about you create a separate issue for it?

fedify-dev#526 (comment)

SqliteMessageQueue.listen fedify-dev#526 (comment)

sij411 · 2026-01-19T01:15:31Z

How about adding [Symbol.dispose]() for consistency with other MessageQueue implementations?

That's a good idea, but it seems to go beyond #477. How about you create a separate issue for it?

Well, the cleanup method belongs to sqlite/src/ mq.ts so i don't think that's out of scope if you implement it for only SqliteMessageQueue. It seems quite simple but caring other message queues should be handled in other PR like you said. (Neither amqp has that)

…lose method

2chanhaeng

How about adding [Symbol.dispose]() for consistency with other MessageQueue implementations?

That's a good idea, but it seems to go beyond #477. How about you create a separate issue for it?

Well, the cleanup method belongs to sqlite/src/ mq.ts so i don't think that's out of scope if you implement it for only SqliteMessageQueue. It seems quite simple but caring other message queues should be handled in other PR like you said. (Neither amqp has that)

Oh, OK. I added it at 80e11c6!

dahlia · 2026-01-19T08:30:27Z

packages/testing/src/mq-tester.ts

@@ -0,0 +1,169 @@
+import type { MessageQueue } from "@fedify/fedify";
+import { test as defaultTest } from "@fedify/fixture";


Hmm, it makes @fedify/testing (which is public) depend on @fedify/fixture, which is not public. I guess we should either:

Extract @fedify/testing/mq-tester into @fedify/fixture/mq-tester, or

Make it depend on node:test instead of @fedify/fixture.

How about removing the default value of TestMessageQueueOptions.test and making it non-optional? Then the dependency can be removed.

Turns out that's… quite unnecessarily too abstract! How about letting it be used like:

test("...", () => testMessageQueue());

… instead of:

testMessageQueue("...", { test });

which seem an unneeded IoC?

Yeah, that will be more useful!

gemini-code-assist bot reviewed Jan 16, 2026

View reviewed changes

packages/sqlite/src/mq.ts Outdated Show resolved Hide resolved

packages/testing/src/mq-tester.ts Show resolved Hide resolved

packages/sqlite/src/mq.test.ts Outdated Show resolved Hide resolved

2chanhaeng added 8 commits January 17, 2026 22:19

Created SqliteMessageQueue

0a455d7

Created testMessageQueue

bb11559

Refactor message queue testso with testMessageQueue

3b548b9

Fix types

e7a765d

Add docs

1f79b86

Refactor listen() with DELETE ... RETURNING

d0f1ccb

Fix docs, temporal and export

9a5bfcb

Fix test error

62164e3

- Remove `let Temporal ...` - Export `@fedify/sqlite` - Add missing dependencies

2chanhaeng force-pushed the smq branch from abd16db to 62164e3 Compare January 17, 2026 22:20

2chanhaeng marked this pull request as ready for review January 17, 2026 22:34

sij411 reviewed Jan 17, 2026

View reviewed changes

sij411 reviewed Jan 18, 2026

View reviewed changes

packages/testing/src/mq-tester.ts Outdated Show resolved Hide resolved

packages/sqlite/src/mq.ts Outdated Show resolved Hide resolved

packages/sqlite/src/mq.ts Outdated Show resolved Hide resolved

packages/sqlite/src/mq.ts Outdated Show resolved Hide resolved

2chanhaeng added 5 commits January 18, 2026 15:40

Remove initialize from TestMessageQueueOptions

2dc776b

fedify-dev#526 (comment)

Fix comment about

bdb4328

fedify-dev#526 (comment)

Add note about SqliteMessageQueue's DELETE ... RETURNING requirement

3110664

fedify-dev#526 (comment)

Fix

1390819

SqliteMessageQueue.listen fedify-dev#526 (comment)

Optimize SqliteMessageQueue.listen

ee2b6e2

sij411 approved these changes Jan 19, 2026

View reviewed changes

2chanhaeng added 2 commits January 19, 2026 06:43

Fix unchanged DATABASE_URL

df0e05a

SqliteMessageQueue: implement Disposable interface and add database c…

80e11c6

…lose method

2chanhaeng commented Jan 19, 2026

View reviewed changes

dahlia requested changes Jan 19, 2026

View reviewed changes

		@@ -0,0 +1,169 @@
		import type { MessageQueue } from "@fedify/fedify";
		import { test as defaultTest } from "@fedify/fixture";

Uh oh!

Add SqliteMessageQueue and related tests #526

Are you sure you want to change the base?

Add SqliteMessageQueue and related tests #526

Uh oh!

Conversation

2chanhaeng commented Jan 16, 2026

Summary

Related issue

Changes

Benefits

Checklist

Uh oh!

gemini-code-assist bot commented Jan 16, 2026

Summary of Changes

Highlights

Footnotes

Uh oh!

gemini-code-assist bot left a comment

Choose a reason for hiding this comment

Code Review

Uh oh!

Uh oh!

Uh oh!

Uh oh!

codecov bot commented Jan 16, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

sij411 commented Jan 18, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

2chanhaeng commented Jan 18, 2026

Uh oh!

sij411 commented Jan 19, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

2chanhaeng left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

codecov bot commented Jan 16, 2026 •

edited

Loading

sij411 commented Jan 18, 2026 •

edited

Loading

sij411 commented Jan 19, 2026 •

edited

Loading