birdclaw 0.8.2 → 0.8.4
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +33 -0
- package/README.md +10 -8
- package/bin/birdclaw.mjs +4 -66
- package/dist/cli/birdclaw.js +28165 -0
- package/dist/client/assets/AvatarChip-DLoqM5xD.js +1 -0
- package/dist/client/assets/ProfilePreview-BejAuYsJ.js +1 -0
- package/dist/client/assets/SavedTimelineView-BIS7HKpp.js +1 -0
- package/dist/client/assets/SmartTimestamp-BR0-9se2.js +1 -0
- package/dist/client/assets/TimelineRouteFrame-CyGPj0eM.js +1 -0
- package/dist/client/assets/blocks-7UDKQp8H.js +1 -0
- package/dist/client/assets/bookmarks-CbBkMvXk.js +1 -0
- package/dist/client/assets/chunk-C0phanGV.js +1 -0
- package/dist/client/assets/circle-check-C_Vq3ElD.js +1 -0
- package/dist/client/assets/client-stream-contracts-ys3XhWG4.js +5 -0
- package/dist/client/assets/createLucideIcon-JV8isFFR.js +1 -0
- package/dist/client/assets/data-sources-Cm2bpNvg.js +1 -0
- package/dist/client/assets/discuss-DTjaOugw.js +1 -0
- package/dist/client/assets/dms-CGd6Eogq.js +1 -0
- package/dist/client/assets/inbox-BHlGuOy2.js +1 -0
- package/dist/client/assets/index-CEIG7S6s.js +31 -0
- package/dist/client/assets/index-bpFrQ5yG.css +1 -0
- package/dist/client/assets/likes-cLrcAQem.js +1 -0
- package/dist/client/assets/links-CM9QO1LC.js +1 -0
- package/dist/client/assets/mapbox-BxTlqXt9.js +2 -0
- package/dist/client/assets/mapbox-gl-dgf_hX3a.js +3215 -0
- package/dist/client/assets/mentions-CxKCgzIf.js +1 -0
- package/dist/client/assets/network-map-B5a3whqj.js +2 -0
- package/dist/client/assets/profile-analyze-CRtNEwlb.js +1 -0
- package/dist/client/assets/profile-hydration-client-YEtJsNTv.js +1 -0
- package/dist/client/assets/profiles._handle-C82_HoKX.js +1 -0
- package/dist/client/assets/query-client-fYu2rzRC.js +17 -0
- package/dist/client/assets/rate-limits-ScaEwdVK.js +1 -0
- package/dist/client/assets/react-dom-DHl6Ug7F.js +1 -0
- package/dist/client/assets/react-nBylq1U5.js +1 -0
- package/dist/client/assets/repeat-2-xCwHM9hD.js +1 -0
- package/dist/client/assets/routes-q7ZaW4En.js +1 -0
- package/dist/client/assets/schemas-I9r6F6ya.js +64 -0
- package/dist/client/assets/search-Dq5kYsxA.js +1 -0
- package/dist/client/assets/sparkles-CQVlvHsZ.js +1 -0
- package/dist/client/assets/styles-B8s3tt3r.css +2 -0
- package/dist/client/assets/today-CeG1O7Py.js +1 -0
- package/dist/client/assets/triangle-alert-CBL7s2pf.js +1 -0
- package/dist/client/assets/useTimelineRouteData-1HsqgvUi.js +1 -0
- package/dist/client/assets/users-CHbKlqUr.js +1 -0
- package/dist/server/assets/AvatarChip-zUDAEmjL.js +105 -0
- package/dist/server/assets/FeedState-ntW0Q2GB.js +214 -0
- package/dist/server/assets/ProfileAnalysisStream-BFvhVdhn.js +198 -0
- package/dist/server/assets/ProfilePreview-C6gAor_j.js +752 -0
- package/dist/server/assets/SavedTimelineView-BG1jnBp1.js +64 -0
- package/dist/server/assets/SmartTimestamp-DfwE1NGf.js +45 -0
- package/dist/server/assets/SyncNowButton-BOn_IBXS.js +76 -0
- package/dist/server/assets/TimelineRouteFrame-CU7ilM7U.js +85 -0
- package/dist/server/assets/TweetRichText-DhCVv1-6.js +74 -0
- package/dist/server/assets/_tanstack-start-manifest_v-C-ZRnG_n.js +148 -0
- package/dist/server/assets/account-selection-CTdFGWRk.js +44 -0
- package/dist/server/assets/blocks-C1mgGTB3.js +299 -0
- package/dist/server/assets/blocks-DSgQghqP.js +17 -0
- package/dist/server/assets/bookmarks-BJN8tykY.js +14 -0
- package/dist/server/assets/client-stream-contracts-C2xbWVjm.js +769 -0
- package/dist/server/assets/data-sources-BnA1Q94p.js +180 -0
- package/dist/server/assets/discuss-CJ1dau1j.js +15 -0
- package/dist/server/assets/discuss-QTo08NCN.js +338 -0
- package/dist/server/assets/dms-BuLj4bp8.js +368 -0
- package/dist/server/assets/dms-DAyQrVM2.js +240 -0
- package/dist/server/assets/empty-plugin-adapters-DzrEkdBF.js +5 -0
- package/dist/server/assets/inbox-CkGOaW1q.js +214 -0
- package/dist/server/assets/inbox-DpWd1EzC.js +146 -0
- package/dist/server/assets/likes-DBOAtsJU.js +14 -0
- package/dist/server/assets/links-DAhSjynu.js +240 -0
- package/dist/server/assets/links-DmH5lxHO.js +468 -0
- package/dist/server/assets/mentions-BH2MzKtB.js +26 -0
- package/dist/server/assets/network-map-D3CzRcC4.js +224 -0
- package/dist/server/assets/network-map-D5DoLOwR.js +582 -0
- package/dist/server/assets/profile-analyze-BP65PED0.js +90 -0
- package/dist/server/assets/profile-analyze-C1NoM0tV.js +9 -0
- package/dist/server/assets/profile-hydration-client-GJ4kwJS8.js +133 -0
- package/dist/server/assets/profiles._handle-DjwlN_ac.js +184 -0
- package/dist/server/assets/profiles._handle-DsLNj2Ca.js +12 -0
- package/dist/server/assets/query-client-BdauHBgd.js +923 -0
- package/dist/server/assets/rate-limits-VAr2qzYD.js +262 -0
- package/dist/server/assets/route-search-BUlQ5lGM.js +117 -0
- package/dist/server/assets/router-DqkwSPiM.js +17026 -0
- package/dist/server/assets/routes-A9c9ZhwN.js +26 -0
- package/dist/server/assets/start-FaDOTmto.js +4 -0
- package/dist/server/assets/today-B5hVM57Z.js +17 -0
- package/dist/server/assets/today-fvGiZ7ud.js +303 -0
- package/dist/server/assets/ui-qbmcMSSX.js +137 -0
- package/{src/components/useDebouncedValue.ts → dist/server/assets/useDebouncedValue-DOnA6Xcy.js} +4 -4
- package/dist/server/assets/useTimelineRouteData-27cxynxa.js +1101 -0
- package/dist/server/server.js +5520 -0
- package/package.json +27 -34
- package/playwright.config.ts +0 -35
- package/scripts/browser-perf.mjs +0 -427
- package/scripts/build-docs-site.mjs +0 -967
- package/scripts/docs-site-assets.mjs +0 -311
- package/scripts/run-vitest.mjs +0 -21
- package/scripts/sanitize-node-options.mjs +0 -23
- package/scripts/start-test-server.mjs +0 -42
- package/src/cli-moderation.ts +0 -210
- package/src/cli.ts +0 -2336
- package/src/components/AccountSwitcher.tsx +0 -186
- package/src/components/AppNav.tsx +0 -118
- package/src/components/AvatarChip.tsx +0 -58
- package/src/components/BrandMark.tsx +0 -67
- package/src/components/ConversationThread.tsx +0 -131
- package/src/components/DmWorkspace.tsx +0 -286
- package/src/components/EmbeddedTweetCard.tsx +0 -55
- package/src/components/FeedState.tsx +0 -147
- package/src/components/FloatingPreview.tsx +0 -382
- package/src/components/InboxCard.tsx +0 -152
- package/src/components/LinkPreviewCard.tsx +0 -292
- package/src/components/MarkdownViewer.tsx +0 -777
- package/src/components/ProfileAnalysisStream.tsx +0 -428
- package/src/components/ProfilePreview.tsx +0 -129
- package/src/components/SavedTimelineView.tsx +0 -155
- package/src/components/SmartTimestamp.tsx +0 -72
- package/src/components/SyncNowButton.tsx +0 -140
- package/src/components/ThemeSlider.tsx +0 -80
- package/src/components/TimelineCard.tsx +0 -533
- package/src/components/TimelineRouteFrame.tsx +0 -186
- package/src/components/TweetArticleCard.tsx +0 -66
- package/src/components/TweetMediaGrid.tsx +0 -185
- package/src/components/TweetRichText.tsx +0 -159
- package/src/components/account-selection.ts +0 -64
- package/src/components/useTimelineRouteData.ts +0 -323
- package/src/lib/account-sync-job.ts +0 -666
- package/src/lib/actions-transport.ts +0 -300
- package/src/lib/api-client.ts +0 -419
- package/src/lib/archive-finder.ts +0 -185
- package/src/lib/archive-import.ts +0 -2764
- package/src/lib/authored-live.ts +0 -1072
- package/src/lib/avatar-cache.ts +0 -349
- package/src/lib/backup.ts +0 -2741
- package/src/lib/bird-actions.ts +0 -294
- package/src/lib/bird-command.ts +0 -130
- package/src/lib/bird.ts +0 -1140
- package/src/lib/blocklist.ts +0 -136
- package/src/lib/blocks-write.ts +0 -167
- package/src/lib/blocks.ts +0 -389
- package/src/lib/bookmark-sync-job.ts +0 -536
- package/src/lib/client-cache.ts +0 -109
- package/src/lib/config.ts +0 -224
- package/src/lib/conversation-surface.ts +0 -205
- package/src/lib/data-sources.ts +0 -219
- package/src/lib/db.ts +0 -1135
- package/src/lib/dms-live.ts +0 -933
- package/src/lib/effect-runtime.ts +0 -45
- package/src/lib/follow-graph.ts +0 -1097
- package/src/lib/geocoding.ts +0 -296
- package/src/lib/http-effect.ts +0 -222
- package/src/lib/identity-search-index.ts +0 -369
- package/src/lib/inbox.ts +0 -241
- package/src/lib/link-index.ts +0 -641
- package/src/lib/link-insights.ts +0 -860
- package/src/lib/link-preview-metadata.ts +0 -754
- package/src/lib/location.ts +0 -137
- package/src/lib/media-fetch.ts +0 -860
- package/src/lib/media-includes.ts +0 -165
- package/src/lib/mention-threads-live.ts +0 -917
- package/src/lib/mentions-export.ts +0 -147
- package/src/lib/mentions-live.ts +0 -1238
- package/src/lib/moderation-target.ts +0 -216
- package/src/lib/moderation-write.ts +0 -131
- package/src/lib/mutes-write.ts +0 -167
- package/src/lib/mutes.ts +0 -84
- package/src/lib/ndjson-stream.ts +0 -106
- package/src/lib/network-map.ts +0 -382
- package/src/lib/openai.ts +0 -117
- package/src/lib/period-digest.ts +0 -1552
- package/src/lib/present.ts +0 -118
- package/src/lib/profile-affiliation-hydration.ts +0 -228
- package/src/lib/profile-affiliations.ts +0 -262
- package/src/lib/profile-analysis.ts +0 -1272
- package/src/lib/profile-bio-entities.ts +0 -318
- package/src/lib/profile-history.ts +0 -164
- package/src/lib/profile-hydration.ts +0 -180
- package/src/lib/profile-replies.ts +0 -77
- package/src/lib/profile-resolver.ts +0 -650
- package/src/lib/queries.ts +0 -2381
- package/src/lib/research.ts +0 -652
- package/src/lib/search-discussion.ts +0 -1016
- package/src/lib/seed.ts +0 -613
- package/src/lib/sqlite.ts +0 -147
- package/src/lib/sync-cache.ts +0 -65
- package/src/lib/theme-transition.ts +0 -113
- package/src/lib/theme.tsx +0 -165
- package/src/lib/timeline-collections-live.ts +0 -581
- package/src/lib/timeline-live.ts +0 -452
- package/src/lib/tweet-account-edges.ts +0 -48
- package/src/lib/tweet-lookup.ts +0 -46
- package/src/lib/tweet-render.ts +0 -430
- package/src/lib/tweet-search-live.ts +0 -566
- package/src/lib/types.ts +0 -723
- package/src/lib/ui.ts +0 -529
- package/src/lib/url-expansion-store.ts +0 -110
- package/src/lib/url-expansion.ts +0 -343
- package/src/lib/url-safety.ts +0 -220
- package/src/lib/web-sync.ts +0 -516
- package/src/lib/whois.ts +0 -1079
- package/src/lib/x-profile.ts +0 -365
- package/src/lib/x-web.ts +0 -199
- package/src/lib/xurl-rate-limits.ts +0 -267
- package/src/lib/xurl.ts +0 -1677
- package/src/routeTree.gen.ts +0 -723
- package/src/router.tsx +0 -20
- package/src/routes/__root.tsx +0 -79
- package/src/routes/api/action.tsx +0 -147
- package/src/routes/api/avatar.tsx +0 -50
- package/src/routes/api/blocks.tsx +0 -35
- package/src/routes/api/conversation.tsx +0 -45
- package/src/routes/api/data-sources.tsx +0 -24
- package/src/routes/api/inbox.tsx +0 -43
- package/src/routes/api/link-insights.tsx +0 -85
- package/src/routes/api/link-preview.tsx +0 -47
- package/src/routes/api/network-map.tsx +0 -55
- package/src/routes/api/period-digest.tsx +0 -101
- package/src/routes/api/profile-analysis.tsx +0 -97
- package/src/routes/api/profile-hydrate.tsx +0 -54
- package/src/routes/api/query.tsx +0 -115
- package/src/routes/api/search-discussion.tsx +0 -113
- package/src/routes/api/status.tsx +0 -28
- package/src/routes/api/sync.tsx +0 -105
- package/src/routes/api/xurl-rate-limits.tsx +0 -24
- package/src/routes/blocks.tsx +0 -377
- package/src/routes/bookmarks.tsx +0 -18
- package/src/routes/data-sources.tsx +0 -257
- package/src/routes/discuss.tsx +0 -419
- package/src/routes/dms.tsx +0 -432
- package/src/routes/inbox.tsx +0 -226
- package/src/routes/index.tsx +0 -32
- package/src/routes/likes.tsx +0 -18
- package/src/routes/links.tsx +0 -994
- package/src/routes/mentions.tsx +0 -32
- package/src/routes/network-map.tsx +0 -1035
- package/src/routes/profile-analyze.tsx +0 -112
- package/src/routes/profiles.$handle.tsx +0 -228
- package/src/routes/rate-limits.tsx +0 -309
- package/src/routes/today.tsx +0 -511
- package/src/styles.css +0 -257
- package/tsconfig.json +0 -29
- package/vite.config.ts +0 -29
- /package/{public → dist/client}/birdclaw-mark.png +0 -0
- /package/{public → dist/client}/favicon.ico +0 -0
- /package/{public → dist/client}/logo192.png +0 -0
- /package/{public → dist/client}/logo512.png +0 -0
- /package/{public → dist/client}/manifest.json +0 -0
- /package/{public → dist/client}/robots.txt +0 -0
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "birdclaw",
|
|
3
|
-
"version": "0.8.
|
|
3
|
+
"version": "0.8.4",
|
|
4
4
|
"description": "Local Twitter memory in SQLite for archives, DMs, likes, bookmarks, and moderation",
|
|
5
5
|
"homepage": "https://github.com/steipete/birdclaw#readme",
|
|
6
6
|
"license": "MIT",
|
|
@@ -13,20 +13,13 @@
|
|
|
13
13
|
},
|
|
14
14
|
"files": [
|
|
15
15
|
"bin/",
|
|
16
|
-
"
|
|
17
|
-
"
|
|
18
|
-
"
|
|
19
|
-
"!src/**/*.test.tsx",
|
|
20
|
-
"!src/test/",
|
|
21
|
-
"public/",
|
|
16
|
+
"dist/cli/",
|
|
17
|
+
"dist/client/",
|
|
18
|
+
"dist/server/",
|
|
22
19
|
"CHANGELOG.md",
|
|
23
20
|
"LICENSE",
|
|
24
21
|
"README.md",
|
|
25
|
-
"package.json"
|
|
26
|
-
"playwright.config.ts",
|
|
27
|
-
"pnpm-lock.yaml",
|
|
28
|
-
"tsconfig.json",
|
|
29
|
-
"vite.config.ts"
|
|
22
|
+
"package.json"
|
|
30
23
|
],
|
|
31
24
|
"type": "module",
|
|
32
25
|
"imports": {
|
|
@@ -37,8 +30,8 @@
|
|
|
37
30
|
},
|
|
38
31
|
"scripts": {
|
|
39
32
|
"dev": "BIRDCLAW_LOCAL_WEB=1 vite dev --host 127.0.0.1 --port 3000",
|
|
40
|
-
"build": "vite build",
|
|
41
|
-
"preview": "
|
|
33
|
+
"build": "vite build && node scripts/build-cli.mjs",
|
|
34
|
+
"preview": "node bin/birdclaw.mjs serve",
|
|
42
35
|
"test": "node ./scripts/run-vitest.mjs run",
|
|
43
36
|
"coverage": "node ./scripts/run-vitest.mjs run --coverage",
|
|
44
37
|
"e2e": "playwright test",
|
|
@@ -46,36 +39,31 @@
|
|
|
46
39
|
"format": "oxfmt --write bin src scripts playwright vite.config.ts vitest.config.ts playwright.config.ts",
|
|
47
40
|
"format:check": "oxfmt --check bin src scripts playwright vite.config.ts vitest.config.ts playwright.config.ts",
|
|
48
41
|
"lint": "oxlint --import-plugin --node-plugin --vitest-plugin --deny-warnings -A require-mock-type-parameters -A no-control-regex bin src scripts playwright vite.config.ts vitest.config.ts playwright.config.ts",
|
|
49
|
-
"check": "pnpm run format:check && pnpm run lint",
|
|
42
|
+
"check": "pnpm run format:check && pnpm run lint && pnpm run typecheck",
|
|
43
|
+
"prepack": "pnpm run build",
|
|
44
|
+
"pack:smoke": "node scripts/package-smoke.mjs",
|
|
50
45
|
"perf:browser": "node ./scripts/browser-perf.mjs",
|
|
51
46
|
"cli": "tsx src/cli.ts",
|
|
52
47
|
"docs:site": "node scripts/build-docs-site.mjs"
|
|
53
48
|
},
|
|
54
49
|
"dependencies": {
|
|
55
|
-
"@
|
|
56
|
-
"@
|
|
57
|
-
"@tanstack/react-router": "1.170.15",
|
|
58
|
-
"@tanstack/react-router-ssr-query": "1.167.1",
|
|
59
|
-
"@tanstack/react-start": "1.168.25",
|
|
60
|
-
"@tanstack/router-plugin": "^1.168.18",
|
|
61
|
-
"@vitejs/plugin-react": "^6.0.2",
|
|
50
|
+
"@tanstack/react-query": "^5.101.0",
|
|
51
|
+
"@tanstack/react-router": "1.170.16",
|
|
62
52
|
"commander": "^15.0.0",
|
|
63
53
|
"effect": "^3.21.3",
|
|
64
|
-
"
|
|
65
|
-
"
|
|
66
|
-
"mapbox-gl": "^3.24.0",
|
|
54
|
+
"lucide-react": "^1.20.0",
|
|
55
|
+
"mapbox-gl": "^3.25.0",
|
|
67
56
|
"react": "^19.2.7",
|
|
68
57
|
"react-dom": "^19.2.7",
|
|
69
58
|
"react-map-gl": "^8.1.1",
|
|
70
59
|
"supercluster": "^8.0.1",
|
|
71
|
-
"tailwindcss": "^4.3.0",
|
|
72
|
-
"tsx": "^4.22.4",
|
|
73
|
-
"vite": "^8.0.16",
|
|
74
60
|
"zod": "^4.4.3"
|
|
75
61
|
},
|
|
76
62
|
"devDependencies": {
|
|
77
|
-
"@playwright/test": "^1.
|
|
63
|
+
"@playwright/test": "^1.61.0",
|
|
78
64
|
"@tailwindcss/typography": "^0.5.20",
|
|
65
|
+
"@tailwindcss/vite": "^4.3.1",
|
|
66
|
+
"@tanstack/react-start": "1.168.26",
|
|
79
67
|
"@testing-library/dom": "^10.4.1",
|
|
80
68
|
"@testing-library/jest-dom": "^6.9.1",
|
|
81
69
|
"@testing-library/react": "^16.3.2",
|
|
@@ -84,13 +72,18 @@
|
|
|
84
72
|
"@types/react": "^19.2.17",
|
|
85
73
|
"@types/react-dom": "^19.2.3",
|
|
86
74
|
"@types/supercluster": "^7.1.3",
|
|
87
|
-
"@typescript/native-preview": "7.0.0-dev.
|
|
88
|
-
"@
|
|
75
|
+
"@typescript/native-preview": "7.0.0-dev.20260617.2",
|
|
76
|
+
"@vitejs/plugin-react": "^6.0.2",
|
|
77
|
+
"@vitest/coverage-v8": "^4.1.9",
|
|
78
|
+
"esbuild": "^0.28.1",
|
|
89
79
|
"jsdom": "^29.1.1",
|
|
90
|
-
"oxfmt": "^0.
|
|
91
|
-
"oxlint": "^1.
|
|
80
|
+
"oxfmt": "^0.55.0",
|
|
81
|
+
"oxlint": "^1.70.0",
|
|
82
|
+
"tailwindcss": "^4.3.1",
|
|
83
|
+
"tsx": "^4.22.4",
|
|
92
84
|
"typescript": "^6.0.3",
|
|
93
|
-
"
|
|
85
|
+
"vite": "^8.0.16",
|
|
86
|
+
"vitest": "^4.1.9"
|
|
94
87
|
},
|
|
95
88
|
"engines": {
|
|
96
89
|
"node": ">=25.8.1 <27"
|
package/playwright.config.ts
DELETED
|
@@ -1,35 +0,0 @@
|
|
|
1
|
-
import path from "node:path";
|
|
2
|
-
import { defineConfig, devices } from "@playwright/test";
|
|
3
|
-
|
|
4
|
-
const testHome = path.join(process.cwd(), ".playwright-home");
|
|
5
|
-
const port = process.env.BIRDCLAW_PLAYWRIGHT_PORT ?? "3000";
|
|
6
|
-
const baseURL = `http://127.0.0.1:${port}`;
|
|
7
|
-
|
|
8
|
-
export default defineConfig({
|
|
9
|
-
testDir: "./playwright",
|
|
10
|
-
fullyParallel: false,
|
|
11
|
-
retries: 0,
|
|
12
|
-
workers: 1,
|
|
13
|
-
use: {
|
|
14
|
-
baseURL,
|
|
15
|
-
trace: "on-first-retry",
|
|
16
|
-
},
|
|
17
|
-
projects: [
|
|
18
|
-
{
|
|
19
|
-
name: "chromium",
|
|
20
|
-
use: { ...devices["Desktop Chrome"] },
|
|
21
|
-
},
|
|
22
|
-
],
|
|
23
|
-
webServer: {
|
|
24
|
-
command: "node ./scripts/start-test-server.mjs",
|
|
25
|
-
url: baseURL,
|
|
26
|
-
reuseExistingServer: false,
|
|
27
|
-
timeout: 120000,
|
|
28
|
-
env: {
|
|
29
|
-
BIRDCLAW_PLAYWRIGHT_PORT: port,
|
|
30
|
-
BIRDCLAW_HOME: testHome,
|
|
31
|
-
BIRDCLAW_DISABLE_LIVE_PROFILE_LOOKUP: "1",
|
|
32
|
-
BIRDCLAW_DISABLE_LIVE_WRITES: "1",
|
|
33
|
-
},
|
|
34
|
-
},
|
|
35
|
-
});
|
package/scripts/browser-perf.mjs
DELETED
|
@@ -1,427 +0,0 @@
|
|
|
1
|
-
#!/usr/bin/env node
|
|
2
|
-
import { spawn } from "node:child_process";
|
|
3
|
-
import path from "node:path";
|
|
4
|
-
import { setTimeout as sleep } from "node:timers/promises";
|
|
5
|
-
import { chromium } from "@playwright/test";
|
|
6
|
-
import { withSanitizedNodeOptions } from "./sanitize-node-options.mjs";
|
|
7
|
-
|
|
8
|
-
const DEFAULT_BASE_URL = "http://localhost:3000";
|
|
9
|
-
const DEFAULT_ITERATIONS = 5;
|
|
10
|
-
const READY_TIMEOUT_MS = 20_000;
|
|
11
|
-
|
|
12
|
-
const SCENARIOS = {
|
|
13
|
-
home: {
|
|
14
|
-
path: "/",
|
|
15
|
-
ready: async (page) => waitForAny(page, ['[data-perf="timeline-card"]']),
|
|
16
|
-
},
|
|
17
|
-
mentions: {
|
|
18
|
-
path: "/mentions",
|
|
19
|
-
ready: async (page) => waitForAny(page, ['[data-perf="timeline-card"]']),
|
|
20
|
-
},
|
|
21
|
-
"sidebar-roundtrip": {
|
|
22
|
-
path: "/",
|
|
23
|
-
ready: async (page) => waitForAny(page, ['[data-perf="timeline-card"]']),
|
|
24
|
-
action: async (page) => {
|
|
25
|
-
await page.getByRole("link", { name: "Mentions" }).click();
|
|
26
|
-
await page.waitForURL("**/mentions");
|
|
27
|
-
await waitForAny(page, ['[data-perf="timeline-card"]']);
|
|
28
|
-
const queryCallsBeforeReturn = await page.evaluate(
|
|
29
|
-
() =>
|
|
30
|
-
performance
|
|
31
|
-
.getEntriesByType("resource")
|
|
32
|
-
.filter((entry) => entry.name.includes("/api/query")).length,
|
|
33
|
-
);
|
|
34
|
-
await page.getByRole("link", { name: "Home" }).click();
|
|
35
|
-
await page.waitForURL((url) => url.pathname === "/");
|
|
36
|
-
await waitForAny(page, ['[data-perf="timeline-card"]']);
|
|
37
|
-
const queryCallsAfterReturn = await page.evaluate(
|
|
38
|
-
() =>
|
|
39
|
-
performance
|
|
40
|
-
.getEntriesByType("resource")
|
|
41
|
-
.filter((entry) => entry.name.includes("/api/query")).length,
|
|
42
|
-
);
|
|
43
|
-
if (queryCallsAfterReturn !== queryCallsBeforeReturn) {
|
|
44
|
-
throw new Error("Returning Home issued a new query request");
|
|
45
|
-
}
|
|
46
|
-
},
|
|
47
|
-
},
|
|
48
|
-
"mentions-search": {
|
|
49
|
-
path: "/mentions",
|
|
50
|
-
ready: async (page) => {
|
|
51
|
-
await page.getByPlaceholder("Search mentions").fill("peekaboo");
|
|
52
|
-
await waitForAny(page, ['[data-perf="timeline-card"]']);
|
|
53
|
-
},
|
|
54
|
-
},
|
|
55
|
-
links: {
|
|
56
|
-
path: "/links",
|
|
57
|
-
ready: async (page) =>
|
|
58
|
-
waitForAny(page, [
|
|
59
|
-
'[data-perf="link-insight-row"]',
|
|
60
|
-
"text=No links in this window.",
|
|
61
|
-
]),
|
|
62
|
-
},
|
|
63
|
-
"links-toggle": {
|
|
64
|
-
path: "/links",
|
|
65
|
-
ready: async (page) =>
|
|
66
|
-
waitForAny(page, [
|
|
67
|
-
'[data-perf="link-insight-row"]',
|
|
68
|
-
"text=No links in this window.",
|
|
69
|
-
]),
|
|
70
|
-
action: async (page) => {
|
|
71
|
-
await page.getByRole("button", { name: "videos" }).click();
|
|
72
|
-
await waitForAny(page, [
|
|
73
|
-
'[data-perf="link-insight-row"]',
|
|
74
|
-
"text=No links in this window.",
|
|
75
|
-
]);
|
|
76
|
-
},
|
|
77
|
-
},
|
|
78
|
-
};
|
|
79
|
-
|
|
80
|
-
function parseArgs(argv) {
|
|
81
|
-
const options = {
|
|
82
|
-
baseUrl: process.env.BIRDCLAW_PERF_URL || DEFAULT_BASE_URL,
|
|
83
|
-
iterations: DEFAULT_ITERATIONS,
|
|
84
|
-
scenarios: Object.keys(SCENARIOS),
|
|
85
|
-
json: false,
|
|
86
|
-
budgets: {},
|
|
87
|
-
};
|
|
88
|
-
|
|
89
|
-
for (const arg of argv) {
|
|
90
|
-
if (arg === "--json") {
|
|
91
|
-
options.json = true;
|
|
92
|
-
} else if (arg.startsWith("--url=")) {
|
|
93
|
-
options.baseUrl = arg.slice("--url=".length).replace(/\/$/, "");
|
|
94
|
-
} else if (arg.startsWith("--iterations=")) {
|
|
95
|
-
options.iterations = Math.max(
|
|
96
|
-
1,
|
|
97
|
-
Number.parseInt(arg.split("=")[1] ?? "", 10),
|
|
98
|
-
);
|
|
99
|
-
} else if (arg.startsWith("--scenario=")) {
|
|
100
|
-
options.scenarios = arg
|
|
101
|
-
.slice("--scenario=".length)
|
|
102
|
-
.split(",")
|
|
103
|
-
.map((value) => value.trim())
|
|
104
|
-
.filter(Boolean);
|
|
105
|
-
} else if (arg.startsWith("--budget-ready-ms=")) {
|
|
106
|
-
options.budgets.readyMs = Number(arg.split("=")[1]);
|
|
107
|
-
} else if (arg.startsWith("--budget-action-ms=")) {
|
|
108
|
-
options.budgets.actionMs = Number(arg.split("=")[1]);
|
|
109
|
-
} else if (arg.startsWith("--budget-api-p95-ms=")) {
|
|
110
|
-
options.budgets.apiP95Ms = Number(arg.split("=")[1]);
|
|
111
|
-
} else if (arg.startsWith("--budget-preview-calls=")) {
|
|
112
|
-
options.budgets.previewCalls = Number(arg.split("=")[1]);
|
|
113
|
-
}
|
|
114
|
-
}
|
|
115
|
-
|
|
116
|
-
for (const scenario of options.scenarios) {
|
|
117
|
-
if (!SCENARIOS[scenario]) {
|
|
118
|
-
throw new Error(`Unknown scenario: ${scenario}`);
|
|
119
|
-
}
|
|
120
|
-
}
|
|
121
|
-
|
|
122
|
-
return options;
|
|
123
|
-
}
|
|
124
|
-
|
|
125
|
-
async function isReachable(baseUrl) {
|
|
126
|
-
try {
|
|
127
|
-
const response = await fetch(baseUrl, {
|
|
128
|
-
signal: AbortSignal.timeout(1000),
|
|
129
|
-
});
|
|
130
|
-
return response.ok || response.status < 500;
|
|
131
|
-
} catch {
|
|
132
|
-
return false;
|
|
133
|
-
}
|
|
134
|
-
}
|
|
135
|
-
|
|
136
|
-
async function startServerIfNeeded(baseUrl) {
|
|
137
|
-
if (await isReachable(baseUrl)) {
|
|
138
|
-
return null;
|
|
139
|
-
}
|
|
140
|
-
|
|
141
|
-
const url = new URL(baseUrl);
|
|
142
|
-
const port = url.port || "3000";
|
|
143
|
-
const viteBin = path.join(
|
|
144
|
-
process.cwd(),
|
|
145
|
-
"node_modules",
|
|
146
|
-
"vite",
|
|
147
|
-
"bin",
|
|
148
|
-
"vite.js",
|
|
149
|
-
);
|
|
150
|
-
const child = spawn(
|
|
151
|
-
process.execPath,
|
|
152
|
-
[viteBin, "dev", "--port", port, "--host", "127.0.0.1"],
|
|
153
|
-
{
|
|
154
|
-
cwd: process.cwd(),
|
|
155
|
-
stdio: ["ignore", "pipe", "pipe"],
|
|
156
|
-
env: {
|
|
157
|
-
...withSanitizedNodeOptions(process.env),
|
|
158
|
-
BIRDCLAW_LOCAL_WEB: "1",
|
|
159
|
-
},
|
|
160
|
-
},
|
|
161
|
-
);
|
|
162
|
-
|
|
163
|
-
const deadline = Date.now() + 30_000;
|
|
164
|
-
while (Date.now() < deadline) {
|
|
165
|
-
if (await isReachable(baseUrl)) {
|
|
166
|
-
return child;
|
|
167
|
-
}
|
|
168
|
-
await sleep(250);
|
|
169
|
-
}
|
|
170
|
-
|
|
171
|
-
child.kill("SIGTERM");
|
|
172
|
-
throw new Error(`Timed out waiting for ${baseUrl}`);
|
|
173
|
-
}
|
|
174
|
-
|
|
175
|
-
async function waitForAny(page, selectors) {
|
|
176
|
-
await page.waitForFunction(
|
|
177
|
-
(values) =>
|
|
178
|
-
values.some((selector) => {
|
|
179
|
-
if (selector.startsWith("text=")) {
|
|
180
|
-
return document.body.innerText.includes(selector.slice(5));
|
|
181
|
-
}
|
|
182
|
-
return Boolean(document.querySelector(selector));
|
|
183
|
-
}),
|
|
184
|
-
selectors,
|
|
185
|
-
{ timeout: READY_TIMEOUT_MS },
|
|
186
|
-
);
|
|
187
|
-
}
|
|
188
|
-
|
|
189
|
-
function percentile(values, point) {
|
|
190
|
-
if (values.length === 0) return 0;
|
|
191
|
-
const sorted = [...values].sort((left, right) => left - right);
|
|
192
|
-
const index = Math.min(
|
|
193
|
-
sorted.length - 1,
|
|
194
|
-
Math.ceil(sorted.length * point) - 1,
|
|
195
|
-
);
|
|
196
|
-
return sorted[index] ?? 0;
|
|
197
|
-
}
|
|
198
|
-
|
|
199
|
-
function median(values) {
|
|
200
|
-
return percentile(values, 0.5);
|
|
201
|
-
}
|
|
202
|
-
|
|
203
|
-
function round(value) {
|
|
204
|
-
return Math.round(value);
|
|
205
|
-
}
|
|
206
|
-
|
|
207
|
-
function apiBucket(rawUrl) {
|
|
208
|
-
const url = new URL(rawUrl);
|
|
209
|
-
if (url.pathname === "/api/link-insights") {
|
|
210
|
-
return `${url.pathname}:${url.searchParams.get("kind") ?? "unknown"}`;
|
|
211
|
-
}
|
|
212
|
-
return url.pathname;
|
|
213
|
-
}
|
|
214
|
-
|
|
215
|
-
function summarizeRuns(runs) {
|
|
216
|
-
const ready = runs.map((run) => run.readyMs);
|
|
217
|
-
const action = runs
|
|
218
|
-
.map((run) => run.actionMs)
|
|
219
|
-
.filter((value) => typeof value === "number");
|
|
220
|
-
const apiDurations = runs.flatMap((run) => run.apiDurationsMs);
|
|
221
|
-
return {
|
|
222
|
-
readyMedianMs: round(median(ready)),
|
|
223
|
-
readyP95Ms: round(percentile(ready, 0.95)),
|
|
224
|
-
actionMedianMs: action.length > 0 ? round(median(action)) : null,
|
|
225
|
-
actionP95Ms: action.length > 0 ? round(percentile(action, 0.95)) : null,
|
|
226
|
-
apiP95Ms: round(percentile(apiDurations, 0.95)),
|
|
227
|
-
apiCallsMedian: round(median(runs.map((run) => run.apiCalls))),
|
|
228
|
-
previewCallsMedian: round(median(runs.map((run) => run.previewCalls))),
|
|
229
|
-
rowsMedian: round(median(runs.map((run) => run.rows))),
|
|
230
|
-
previewsMedian: round(median(runs.map((run) => run.previews))),
|
|
231
|
-
endpoints: summarizeEndpoints(runs),
|
|
232
|
-
};
|
|
233
|
-
}
|
|
234
|
-
|
|
235
|
-
function summarizeEndpoints(runs) {
|
|
236
|
-
const totals = new Map();
|
|
237
|
-
for (const run of runs) {
|
|
238
|
-
for (const [endpoint, count] of Object.entries(run.apiEndpoints)) {
|
|
239
|
-
totals.set(endpoint, (totals.get(endpoint) ?? 0) + count);
|
|
240
|
-
}
|
|
241
|
-
}
|
|
242
|
-
return [...totals.entries()]
|
|
243
|
-
.map(([endpoint, count]) => ({
|
|
244
|
-
endpoint,
|
|
245
|
-
medianCalls: Math.round(count / runs.length),
|
|
246
|
-
}))
|
|
247
|
-
.sort((left, right) => right.medianCalls - left.medianCalls)
|
|
248
|
-
.slice(0, 8);
|
|
249
|
-
}
|
|
250
|
-
|
|
251
|
-
async function runScenario(browser, baseUrl, name) {
|
|
252
|
-
const scenario = SCENARIOS[name];
|
|
253
|
-
const page = await browser.newPage({
|
|
254
|
-
viewport: { width: 1474, height: 910 },
|
|
255
|
-
});
|
|
256
|
-
const requestStart = new Map();
|
|
257
|
-
const apiDurationsMs = [];
|
|
258
|
-
let apiCalls = 0;
|
|
259
|
-
let previewCalls = 0;
|
|
260
|
-
const apiEndpoints = {};
|
|
261
|
-
|
|
262
|
-
page.on("request", (request) => {
|
|
263
|
-
if (request.url().includes("/api/")) {
|
|
264
|
-
requestStart.set(request, performance.now());
|
|
265
|
-
}
|
|
266
|
-
});
|
|
267
|
-
page.on("response", (response) => {
|
|
268
|
-
const request = response.request();
|
|
269
|
-
const startedAt = requestStart.get(request);
|
|
270
|
-
if (startedAt === undefined) return;
|
|
271
|
-
requestStart.delete(request);
|
|
272
|
-
apiCalls += 1;
|
|
273
|
-
const endpoint = apiBucket(response.url());
|
|
274
|
-
apiEndpoints[endpoint] = (apiEndpoints[endpoint] ?? 0) + 1;
|
|
275
|
-
apiDurationsMs.push(performance.now() - startedAt);
|
|
276
|
-
if (response.url().includes("/api/link-preview")) {
|
|
277
|
-
previewCalls += 1;
|
|
278
|
-
}
|
|
279
|
-
});
|
|
280
|
-
|
|
281
|
-
const startedAt = performance.now();
|
|
282
|
-
await page.goto(`${baseUrl}${scenario.path}`, {
|
|
283
|
-
waitUntil: "domcontentloaded",
|
|
284
|
-
});
|
|
285
|
-
await scenario.ready(page);
|
|
286
|
-
const readyMs = performance.now() - startedAt;
|
|
287
|
-
|
|
288
|
-
let actionMs = null;
|
|
289
|
-
if (scenario.action) {
|
|
290
|
-
const actionStartedAt = performance.now();
|
|
291
|
-
await scenario.action(page);
|
|
292
|
-
actionMs = performance.now() - actionStartedAt;
|
|
293
|
-
}
|
|
294
|
-
|
|
295
|
-
await page.waitForTimeout(250);
|
|
296
|
-
const counts = await page.evaluate(() => ({
|
|
297
|
-
rows: document.querySelectorAll(
|
|
298
|
-
'[data-perf="timeline-card"], [data-perf="link-insight-row"]',
|
|
299
|
-
).length,
|
|
300
|
-
previews: document.querySelectorAll('[data-perf="link-preview-card"]')
|
|
301
|
-
.length,
|
|
302
|
-
}));
|
|
303
|
-
await page.close();
|
|
304
|
-
|
|
305
|
-
return {
|
|
306
|
-
readyMs,
|
|
307
|
-
actionMs,
|
|
308
|
-
apiCalls,
|
|
309
|
-
previewCalls,
|
|
310
|
-
apiEndpoints,
|
|
311
|
-
apiDurationsMs,
|
|
312
|
-
rows: counts.rows,
|
|
313
|
-
previews: counts.previews,
|
|
314
|
-
};
|
|
315
|
-
}
|
|
316
|
-
|
|
317
|
-
function budgetFailures(name, summary, budgets) {
|
|
318
|
-
const failures = [];
|
|
319
|
-
if (
|
|
320
|
-
Number.isFinite(budgets.readyMs) &&
|
|
321
|
-
summary.readyP95Ms > budgets.readyMs
|
|
322
|
-
) {
|
|
323
|
-
failures.push(
|
|
324
|
-
`${name} ready p95 ${summary.readyP95Ms}ms > ${budgets.readyMs}ms`,
|
|
325
|
-
);
|
|
326
|
-
}
|
|
327
|
-
if (
|
|
328
|
-
Number.isFinite(budgets.actionMs) &&
|
|
329
|
-
summary.actionP95Ms !== null &&
|
|
330
|
-
summary.actionP95Ms > budgets.actionMs
|
|
331
|
-
) {
|
|
332
|
-
failures.push(
|
|
333
|
-
`${name} action p95 ${summary.actionP95Ms}ms > ${budgets.actionMs}ms`,
|
|
334
|
-
);
|
|
335
|
-
}
|
|
336
|
-
if (
|
|
337
|
-
Number.isFinite(budgets.apiP95Ms) &&
|
|
338
|
-
summary.apiP95Ms > budgets.apiP95Ms
|
|
339
|
-
) {
|
|
340
|
-
failures.push(
|
|
341
|
-
`${name} api p95 ${summary.apiP95Ms}ms > ${budgets.apiP95Ms}ms`,
|
|
342
|
-
);
|
|
343
|
-
}
|
|
344
|
-
if (
|
|
345
|
-
Number.isFinite(budgets.previewCalls) &&
|
|
346
|
-
summary.previewCallsMedian > budgets.previewCalls
|
|
347
|
-
) {
|
|
348
|
-
failures.push(
|
|
349
|
-
`${name} preview calls median ${summary.previewCallsMedian} > ${budgets.previewCalls}`,
|
|
350
|
-
);
|
|
351
|
-
}
|
|
352
|
-
return failures;
|
|
353
|
-
}
|
|
354
|
-
|
|
355
|
-
function printHuman(results, failures) {
|
|
356
|
-
console.log("browser perf");
|
|
357
|
-
for (const result of results) {
|
|
358
|
-
const summary = result.summary;
|
|
359
|
-
console.log("");
|
|
360
|
-
console.log(`scenario: ${result.name}`);
|
|
361
|
-
console.log(`ready median: ${summary.readyMedianMs}ms`);
|
|
362
|
-
console.log(`ready p95: ${summary.readyP95Ms}ms`);
|
|
363
|
-
if (summary.actionMedianMs !== null) {
|
|
364
|
-
console.log(`action median: ${summary.actionMedianMs}ms`);
|
|
365
|
-
console.log(`action p95: ${summary.actionP95Ms}ms`);
|
|
366
|
-
}
|
|
367
|
-
console.log(`api p95: ${summary.apiP95Ms}ms`);
|
|
368
|
-
console.log(`api calls median: ${summary.apiCallsMedian}`);
|
|
369
|
-
console.log(`preview calls median: ${summary.previewCallsMedian}`);
|
|
370
|
-
console.log(`rows median: ${summary.rowsMedian}`);
|
|
371
|
-
console.log(`preview cards median: ${summary.previewsMedian}`);
|
|
372
|
-
if (summary.endpoints.length > 0) {
|
|
373
|
-
console.log("top endpoints:");
|
|
374
|
-
for (const endpoint of summary.endpoints) {
|
|
375
|
-
console.log(`- ${endpoint.endpoint}: ${endpoint.medianCalls}`);
|
|
376
|
-
}
|
|
377
|
-
}
|
|
378
|
-
}
|
|
379
|
-
if (failures.length > 0) {
|
|
380
|
-
console.log("");
|
|
381
|
-
console.log("budget failures:");
|
|
382
|
-
for (const failure of failures) {
|
|
383
|
-
console.log(`- ${failure}`);
|
|
384
|
-
}
|
|
385
|
-
}
|
|
386
|
-
}
|
|
387
|
-
|
|
388
|
-
async function main() {
|
|
389
|
-
const options = parseArgs(process.argv.slice(2));
|
|
390
|
-
const server = await startServerIfNeeded(options.baseUrl);
|
|
391
|
-
const browser = await chromium.launch({ headless: true });
|
|
392
|
-
const results = [];
|
|
393
|
-
const failures = [];
|
|
394
|
-
|
|
395
|
-
try {
|
|
396
|
-
for (const name of options.scenarios) {
|
|
397
|
-
await runScenario(browser, options.baseUrl, name);
|
|
398
|
-
const runs = [];
|
|
399
|
-
for (let index = 0; index < options.iterations; index += 1) {
|
|
400
|
-
runs.push(await runScenario(browser, options.baseUrl, name));
|
|
401
|
-
}
|
|
402
|
-
const summary = summarizeRuns(runs);
|
|
403
|
-
results.push({ name, summary, runs });
|
|
404
|
-
failures.push(...budgetFailures(name, summary, options.budgets));
|
|
405
|
-
}
|
|
406
|
-
} finally {
|
|
407
|
-
await browser.close();
|
|
408
|
-
if (server) {
|
|
409
|
-
server.kill("SIGTERM");
|
|
410
|
-
}
|
|
411
|
-
}
|
|
412
|
-
|
|
413
|
-
if (options.json) {
|
|
414
|
-
console.log(JSON.stringify({ results, failures }, null, 2));
|
|
415
|
-
} else {
|
|
416
|
-
printHuman(results, failures);
|
|
417
|
-
}
|
|
418
|
-
|
|
419
|
-
if (failures.length > 0) {
|
|
420
|
-
process.exitCode = 1;
|
|
421
|
-
}
|
|
422
|
-
}
|
|
423
|
-
|
|
424
|
-
main().catch((error) => {
|
|
425
|
-
console.error(error instanceof Error ? error.stack || error.message : error);
|
|
426
|
-
process.exit(1);
|
|
427
|
-
});
|