Skip to content

A self-hostable bookmark-everything app (links, notes and images) with AI-based automatic tagging and full text search

tests: add feed worker e2e tests

Mohamed Bassema8b1e8ea015f
diff --git a/.dockerignore b/.dockerignore
index 615cb7e2..748c949b 100644
--- a/.dockerignore
+++ b/.dockerignore
@@ -26,3 +26,4 @@ packages/benchmarks
# next.js
.next/
out/
+.claude/worktrees
diff --git a/packages/e2e_tests/setup/html/feed.xml b/packages/e2e_tests/setup/html/feed.xml
new file mode 100644
index 00000000..4b495147
--- /dev/null
+++ b/packages/e2e_tests/setup/html/feed.xml
@@ -0,0 +1,23 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<rss version="2.0">
+ <channel>
+ <title>Test RSS Feed</title>
+ <link>http://nginx:80</link>
+ <description>A test RSS feed for e2e testing</description>
+ <item>
+ <title>First Test Article</title>
+ <link>http://nginx:80/hello.html</link>
+ <guid>test-entry-1</guid>
+ <description>This is the first test article</description>
+ <category>tech</category>
+ <category>testing</category>
+ </item>
+ <item>
+ <title>Second Test Article</title>
+ <link>http://nginx:80/hello.html?article=2</link>
+ <guid>test-entry-2</guid>
+ <description>This is the second test article</description>
+ <category>news</category>
+ </item>
+ </channel>
+</rss>
diff --git a/packages/e2e_tests/tests/workers/feed.test.ts b/packages/e2e_tests/tests/workers/feed.test.ts
new file mode 100644
index 00000000..ed45c7b2
--- /dev/null
+++ b/packages/e2e_tests/tests/workers/feed.test.ts
@@ -0,0 +1,150 @@
+import { assert, beforeEach, describe, expect, inject, it } from "vitest";
+
+import { createTestUser } from "../../utils/api";
+import { waitUntil } from "../../utils/general";
+import { getTrpcClient } from "../../utils/trpc";
+
+describe("Feed Worker Tests", () => {
+ const port = inject("karakeepPort");
+
+ if (!port) {
+ throw new Error("Missing required environment variables");
+ }
+
+ let apiKey: string;
+
+ beforeEach(async () => {
+ apiKey = await createTestUser();
+ });
+
+ it("should fetch and parse an RSS feed and create bookmarks", async () => {
+ const trpcClient = getTrpcClient(apiKey);
+
+ // Create a feed pointing to the RSS file served by nginx
+ const feed = await trpcClient.feeds.create.mutate({
+ name: "Test Feed",
+ url: "http://nginx:80/feed.xml",
+ enabled: true,
+ });
+
+ expect(feed.id).toBeDefined();
+ expect(feed.lastFetchedStatus).toBe("pending");
+
+ // Trigger a manual fetch
+ await trpcClient.feeds.fetchNow.mutate({ feedId: feed.id });
+
+ // Wait until the feed has been fetched successfully
+ await waitUntil(async () => {
+ const updated = await trpcClient.feeds.get.query({ feedId: feed.id });
+ return updated.lastFetchedStatus === "success";
+ }, "Feed is fetched successfully");
+
+ // Verify the feed status
+ const fetchedFeed = await trpcClient.feeds.get.query({ feedId: feed.id });
+ expect(fetchedFeed.lastFetchedStatus).toBe("success");
+ expect(fetchedFeed.lastFetchedAt).toBeDefined();
+
+ // Verify bookmarks were created from the feed entries
+ const bookmarks = await trpcClient.bookmarks.getBookmarks.query({
+ archived: false,
+ });
+
+ expect(bookmarks.bookmarks.length).toBe(2);
+
+ const titles = bookmarks.bookmarks.map((b) => b.title);
+ expect(titles).toContain("First Test Article");
+ expect(titles).toContain("Second Test Article");
+
+ const urls = bookmarks.bookmarks.map((b) => {
+ assert(b.content.type === "link");
+ return b.content.url;
+ });
+ expect(urls).toContain("http://nginx:80/hello.html");
+ expect(urls).toContain("http://nginx:80/hello.html?article=2");
+ });
+
+ it("should import tags from RSS categories when importTags is enabled", async () => {
+ const trpcClient = getTrpcClient(apiKey);
+
+ // Create a feed with importTags enabled
+ const feed = await trpcClient.feeds.create.mutate({
+ name: "Test Feed With Tags",
+ url: "http://nginx:80/feed.xml",
+ enabled: true,
+ importTags: true,
+ });
+
+ // Trigger a manual fetch
+ await trpcClient.feeds.fetchNow.mutate({ feedId: feed.id });
+
+ // Wait until the feed has been fetched successfully
+ await waitUntil(async () => {
+ const updated = await trpcClient.feeds.get.query({ feedId: feed.id });
+ return updated.lastFetchedStatus === "success";
+ }, "Feed with tags is fetched successfully");
+
+ // Verify bookmarks were created
+ const bookmarks = await trpcClient.bookmarks.getBookmarks.query({
+ archived: false,
+ });
+ expect(bookmarks.bookmarks.length).toBe(2);
+
+ // Find the first article and check its tags
+ const firstArticle = bookmarks.bookmarks.find(
+ (b) => b.title === "First Test Article",
+ );
+ assert(firstArticle);
+ const firstTags = firstArticle.tags.map((t) => t.name);
+ expect(firstTags).toContain("tech");
+ expect(firstTags).toContain("testing");
+
+ // Find the second article and check its tags
+ const secondArticle = bookmarks.bookmarks.find(
+ (b) => b.title === "Second Test Article",
+ );
+ assert(secondArticle);
+ const secondTags = secondArticle.tags.map((t) => t.name);
+ expect(secondTags).toContain("news");
+ });
+
+ it("should not create duplicate bookmarks on re-fetch", async () => {
+ const trpcClient = getTrpcClient(apiKey);
+
+ const feed = await trpcClient.feeds.create.mutate({
+ name: "Test Feed Dedup",
+ url: "http://nginx:80/feed.xml",
+ enabled: true,
+ });
+
+ // First fetch
+ await trpcClient.feeds.fetchNow.mutate({ feedId: feed.id });
+ await waitUntil(async () => {
+ const updated = await trpcClient.feeds.get.query({ feedId: feed.id });
+ return updated.lastFetchedStatus === "success";
+ }, "First feed fetch completes");
+
+ const afterFirstFetch = await trpcClient.feeds.get.query({
+ feedId: feed.id,
+ });
+ assert(afterFirstFetch.lastFetchedAt);
+ const firstFetchedAt = afterFirstFetch.lastFetchedAt;
+
+ const firstFetch = await trpcClient.bookmarks.getBookmarks.query({
+ archived: false,
+ });
+ expect(firstFetch.bookmarks.length).toBe(2);
+
+ // Second fetch of the same feed - should not create duplicates
+ await trpcClient.feeds.fetchNow.mutate({ feedId: feed.id });
+ await waitUntil(async () => {
+ const updated = await trpcClient.feeds.get.query({ feedId: feed.id });
+ assert(updated.lastFetchedAt);
+ return updated.lastFetchedAt > firstFetchedAt;
+ }, "Second feed fetch completes");
+
+ const secondFetch = await trpcClient.bookmarks.getBookmarks.query({
+ archived: false,
+ });
+ expect(secondFetch.bookmarks.length).toBe(2);
+ });
+});