feat: show remaining CDN & cache-miss egress #538

bajtos · 2026-01-07T11:12:47Z

Update the demo app to show remaining egress allowances for each data set where the FilBeam service is enabled.

Screenshot showing the new version in practice:

version 2 using FolderSync icon

version 1 using RefreshCw icon

Signed-off-by: Miroslav Bajtoš <oss@bajtos.net>

cloudflare-workers-and-pages · 2026-01-07T11:14:09Z

Deploying with Cloudflare Workers

The latest updates on your project. Learn more about integrating Git with Workers.

Status	Name	Latest Commit	Preview URL	Updated (UTC)
✅ Deployment successful! View logs	synapse-dev	`8071a70`	Commit Preview URL Branch Preview URL	Feb 04 2026, 10:23 AM

apps/synapse-playground/src/components/warm-storage/data-sets-section.tsx

packages/synapse-react/src/warm-storage/use-data-sets.ts

Signed-off-by: Miroslav Bajtoš <oss@bajtos.net>

packages/synapse-react/src/warm-storage/use-data-sets.ts

rvagg · 2026-01-08T08:04:27Z

This seems fine to me and I appreciate the AGENTS.md edits but I'm going to leave it to @hugomrdias to review

apps/synapse-playground/src/lib/utils.ts

- Change format to "Egress remaining: X GiB delivery · Y GiB cache-miss" - Remove FolderSync icon, keep Globe icon with tooltip "This data set is using CDN" - Use binary units (KiB, MiB, GiB, TiB) instead of decimal units Co-Authored-By: Claude Code <noreply@anthropic.com> Signed-off-by: Miroslav Bajtoš <oss@bajtos.net>

bajtos · 2026-01-13T10:13:12Z

I addressed the review comments, this PR is ready for another round of reviews. 🙏🏻

Move CDN info (Globe icon + tooltip + egress quota display) into a dedicated CdnDetails component, simplifying data-sets-section.tsx. Co-Authored-By: Claude Code <noreply@anthropic.com> Signed-off-by: Miroslav Bajtoš <oss@bajtos.net>

Rename query key from `synapse-filbeam-egress-quota` to `synapse-filbeam-egress-quotas` for consistency with other query keys that use plural when the response contains multiple values. Co-Authored-By: Claude Code <noreply@anthropic.com> Signed-off-by: Miroslav Bajtoš <oss@bajtos.net>

…apse-core Simplify FilBeamService by delegating getDataSetStats to synapse-core's implementation, eliminating code duplication. Add requestGetJson option to synapse-core for testability. Update SynapseError to prioritize explicit details over cause.message. Co-Authored-By: Claude Code <noreply@anthropic.com> Signed-off-by: Miroslav Bajtoš <oss@bajtos.net>

Move detailed HTTP error handling and fetch tests from synapse-sdk to synapse-core, keeping only smoke tests in synapse-sdk to verify the delegation works correctly. Co-Authored-By: Claude Code <noreply@anthropic.com> Signed-off-by: Miroslav Bajtoš <oss@bajtos.net>

Move helper functions (getStatsBaseUrl, parseBigInt, validateStatsResponse) after the main getDataSetStats function for better code organization. Co-Authored-By: Claude Code <noreply@anthropic.com> Signed-off-by: Miroslav Bajtoš <oss@bajtos.net>

bajtos · 2026-01-20T13:16:39Z

packages/synapse-core/src/filbeam/stats.ts

+  const response = await requestGetJson<unknown>(url)
+
+  if (response.error) {
+    if (HttpError.is(response.error)) {
+      const status = response.error.response.status
+      if (status === 404) {
+        throw new GetDataSetStatsError(`Data set not found: ${options.dataSetId}`, {
+          cause: response.error,
+        })
+      }
+      const errorText = await response.error.response.text().catch(() => 'Unknown error')
+      throw new GetDataSetStatsError(`Failed to fetch data set stats`, {
+        details: `HTTP ${status} ${response.error.response.statusText}: ${errorText}`,
+        cause: response.error,
+      })
+    }
+    throw new GetDataSetStatsError('Unexpected error', { cause: response.error })
+  }
+
+  return validateStatsResponse(response.result)


Following up on #538 (comment) and #538 (comment).

If we apply both suggestions, then we can simplify this block as follows - is that what we want?

const response = await requestGetJson<unknown>(url) if (response.error) { throw new GetDataSetStatsError( 'Cannot get DataSet stats from FilBeam API.', { cause: response.error } ) } return { cdnEgressQuota: BigInt(response.result.cdnEgressQuota), cacheMissEgressQuota: BigInt(response.result.cacheMissEgressQuota), }

Copilot

Pull request overview

This PR adds the ability to display remaining CDN and cache-miss egress quotas for FilBeam-enabled data sets in the demo application. The implementation refactors FilBeam stats functionality from synapse-sdk into a new synapse-core module that can be shared between synapse-sdk and synapse-react packages.

Changes:

Moved FilBeam stats API logic from synapse-sdk to synapse-core with improved error handling and validation
Added a new React hook useEgressQuota in synapse-react for fetching egress quota data
Updated the playground app to display remaining egress allowances for data sets with FilBeam enabled

Reviewed changes

Copilot reviewed 15 out of 15 changed files in this pull request and generated 7 comments.

Show a summary per file

File	Description
packages/synapse-core/src/filbeam/stats.ts	New core implementation for fetching and validating FilBeam data set stats
packages/synapse-core/src/errors/filbeam.ts	New error class for FilBeam stats operations
packages/synapse-core/test/filbeam.test.ts	Comprehensive tests for FilBeam stats functionality
packages/synapse-core/src/filbeam/index.ts	Export module for FilBeam functionality
packages/synapse-core/src/errors/index.ts	Added export for FilBeam errors
packages/synapse-core/src/errors/base.ts	Improved error message handling to prioritize explicit details
packages/synapse-core/package.json	Added exports for filbeam module
packages/synapse-sdk/src/filbeam/service.ts	Refactored to delegate to synapse-core implementation
packages/synapse-sdk/src/test/filbeam-service.test.ts	Updated to smoke tests that verify delegation to synapse-core
packages/synapse-react/src/warm-storage/use-egress-quota.ts	New React hook for querying egress quotas
packages/synapse-react/src/warm-storage/index.ts	Added export for useEgressQuota hook
apps/synapse-playground/src/components/warm-storage/cdn-details.tsx	New component to display egress quota information
apps/synapse-playground/src/components/warm-storage/data-sets-section.tsx	Updated to use CdnDetails component
apps/synapse-playground/src/lib/utils.ts	Added formatBytes utility function
AGENTS.md	Added documentation about monorepo structure and testing practices

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

apps/synapse-playground/src/lib/utils.ts

packages/synapse-core/src/filbeam/stats.ts

apps/synapse-playground/src/components/warm-storage/cdn-details.tsx

packages/synapse-core/src/filbeam/stats.ts

packages/synapse-sdk/src/test/filbeam-service.test.ts

packages/synapse-core/src/filbeam/stats.ts

apps/synapse-playground/src/lib/utils.ts

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Signed-off-by: Miroslav Bajtoš <oss@bajtos.net>

AGENTS.md

Co-authored-by: Rod Vagg <rod@vagg.org>

rjan90 · 2026-01-26T10:07:40Z

From todays sync, this is waiting/blocked by #555 as it needs to be rebased on top of it

Resolved 3 merge conflicts: 1. packages/synapse-core/src/errors/base.ts - Kept HEAD's comment explaining the details fallback logic. 2. packages/synapse-sdk/src/filbeam/service.ts - Merged both approaches: - Uses Chain type from @filoz/synapse-core/chains (from master) - Delegates to coreGetDataSetStats from @filoz/synapse-core/filbeam (from HEAD) - Passes chain.id directly to the core function (avoiding the need for CHAIN_IDS constant) 3. packages/synapse-sdk/src/test/filbeam-service.test.ts - Updated tests to: - Use Chain types (mainnet, calibration) from synapse-core - Use mock request.json.get function matching synapse-core's interface - Kept simplified test structure (detailed validation tests are in synapse-core)

socket-security · 2026-02-04T09:40:31Z

Review the following changes in direct dependencies. Learn more about Socket for GitHub.

Diff	Package	Supply Chain Security	Vulnerability	Quality	Maintenance	License
	@types/assert@1.5.11
	@wagmi/cli@2.9.0
	@web3-storage/data-segment@5.3.0
	dnum@2.17.0

View full report

Move hardcoded stats URL from getStatsBaseUrl function into chain configuration (chain.filbeam.statsBaseUrl). Change getDataSetStats to accept chain object instead of chainId for consistency with other chain-aware functions. Co-Authored-By: Claude Code <noreply@anthropic.com> Signed-off-by: Miroslav Bajtoš <oss@bajtos.net>

bajtos · 2026-02-04T10:08:24Z

I reworked this PR to use the latest approach in the master branch.

The base URL for FilBeam stats lives in chain.filbeam.statsBaseUrl now.
An attempt to fetch stats for devnet throws a descriptive error.
synapse-sdk uses synapse-core to fetch stats

What remains: decide how to validate FilBeam stats API responses (#538 (comment)) and how to handle error responses (#538 (comment)). I outlined a potential alternative addressing both comments in #538 (comment).

@hugomrdias PTAL again, and let me know what needs to be changed or improved before we can land this.

Copilot

Pull request overview

Copilot reviewed 16 out of 16 changed files in this pull request and generated 6 comments.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

apps/synapse-playground/src/components/warm-storage/cdn-details.tsx

packages/synapse-core/src/filbeam/stats.ts

Copilot · 2026-02-04T10:09:29Z

apps/synapse-playground/src/components/warm-storage/cdn-details.tsx

+import { Tooltip, TooltipContent, TooltipTrigger } from '../ui/tooltip.tsx'
+
+export function CdnDetails({ dataSetId }: { dataSetId: bigint }) {
+  const { data: egressQuota } = useEgressQuota({ dataSetId })


The component doesn't handle loading or error states from the useEgressQuota hook. If the API request is slow or fails, the egress quota information will simply not appear, which could be confusing to users. Consider adding a loading skeleton (similar to the pattern used in services.tsx line 32-34) or an error state display to provide better user feedback. At minimum, showing a loading indicator while fetching would improve the user experience.

How do we feel about this?

Are we okay to ship the current version, since it is still an improvement, or is it required to handle loading & error states before we can ship the remaining egress indicators?

@juliangruber @hugomrdias

I think this is good enough for the playground components

apps/synapse-playground/src/components/warm-storage/cdn-details.tsx

apps/synapse-playground/src/lib/utils.ts

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Add test coverage for getDataSetStats when called with a chain that doesn't support FilBeam (chain.filbeam is null). Co-Authored-By: Claude Code <noreply@anthropic.com> Signed-off-by: Miroslav Bajtoš <oss@bajtos.net>

bajtos added 2 commits January 7, 2026 12:06

feat: show remaining CDN & cache-miss egress

fd491d0

Signed-off-by: Miroslav Bajtoš <oss@bajtos.net>

chore: document synapse-react in AGENTS.md

9aa16b7

Signed-off-by: Miroslav Bajtoš <oss@bajtos.net>

bajtos requested review from juliangruber and pyropy January 7, 2026 11:12

bajtos requested review from hugomrdias and rvagg as code owners January 7, 2026 11:12

github-project-automation bot added this to FOC Jan 7, 2026

github-project-automation bot moved this to 📌 Triage in FOC Jan 7, 2026

juliangruber approved these changes Jan 7, 2026

View reviewed changes

apps/synapse-playground/src/components/warm-storage/data-sets-section.tsx Outdated Show resolved Hide resolved

packages/synapse-react/src/warm-storage/use-data-sets.ts Outdated Show resolved Hide resolved

bajtos added 3 commits January 7, 2026 12:25

fixup! cache-miss icon RefreshCW -> FolderSync

2132a05

Signed-off-by: Miroslav Bajtoš <oss@bajtos.net>

fixup! npm run lint:fix

f029bc4

Signed-off-by: Miroslav Bajtoš <oss@bajtos.net>

fixup! code cleanup + better error logging

b1f0f04

Signed-off-by: Miroslav Bajtoš <oss@bajtos.net>

bajtos mentioned this pull request Jan 7, 2026

feat: access stats from browsers filbeam/worker#539

Merged

rjan90 moved this from 📌 Triage to 🔎 Awaiting review in FOC Jan 7, 2026

rjan90 added this to the M4: Filecoin Service Liftoff milestone Jan 7, 2026

bajtos mentioned this pull request Jan 7, 2026

fix: change FilBeam URL to stats.filbeam.com #539

Merged

fixup! forgotten err

10c3811

Signed-off-by: Miroslav Bajtoš <oss@bajtos.net>

bajtos commented Jan 7, 2026

View reviewed changes

packages/synapse-react/src/warm-storage/use-data-sets.ts Outdated Show resolved Hide resolved

Merge branch 'master' into feat-egress-allowance

c0bbd0e

rjan90 moved this from 🔎 Awaiting review to ✔️ Approved by reviewer in FOC Jan 7, 2026

rjan90 assigned bajtos Jan 7, 2026

rvagg removed their request for review January 8, 2026 08:04

BigLep moved this from ✔️ Approved by reviewer to 🔎 Awaiting review in FOC Jan 8, 2026

pyropy reviewed Jan 12, 2026

View reviewed changes

apps/synapse-playground/src/lib/utils.ts Outdated Show resolved Hide resolved

bajtos requested review from juliangruber and pyropy January 13, 2026 10:12

bajtos and others added 5 commits January 20, 2026 13:03

refactor(playground): extract CdnDetails component

47d0a25

Move CDN info (Globe icon + tooltip + egress quota display) into a dedicated CdnDetails component, simplifying data-sets-section.tsx. Co-Authored-By: Claude Code <noreply@anthropic.com> Signed-off-by: Miroslav Bajtoš <oss@bajtos.net>

bajtos requested review from Copilot, hugomrdias and rvagg January 20, 2026 13:12

Copilot started reviewing on behalf of bajtos January 20, 2026 13:13 View session

bajtos commented Jan 20, 2026

View reviewed changes

Copilot AI reviewed Jan 20, 2026

View reviewed changes

bajtos and others added 2 commits January 20, 2026 16:29

Fix formatBytes to support negative values

6f7f718

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

fix: harden the implementation of formatBytes

0063a33

Signed-off-by: Miroslav Bajtoš <oss@bajtos.net>

bajtos moved this from ⌨️ In Progress to 🔎 Awaiting review in FOC Jan 20, 2026

rvagg reviewed Jan 21, 2026

View reviewed changes

AGENTS.md Outdated Show resolved Hide resolved

rvagg reviewed Jan 21, 2026

View reviewed changes

AGENTS.md Outdated Show resolved Hide resolved

bajtos and others added 2 commits January 21, 2026 11:28

Update AGENTS.md

1bd4f2c

Co-authored-by: Rod Vagg <rod@vagg.org>

Update AGENTS.md

53c49e5

Co-authored-by: Rod Vagg <rod@vagg.org>

bajtos marked this pull request as draft January 27, 2026 09:21

bajtos requested a review from Copilot February 4, 2026 10:02

Copilot started reviewing on behalf of bajtos February 4, 2026 10:03 View session

bajtos marked this pull request as ready for review February 4, 2026 10:08

Copilot AI reviewed Feb 4, 2026

View reviewed changes

bajtos and others added 2 commits February 4, 2026 11:11

Update apps/synapse-playground/src/lib/utils.ts

a7f6bb4

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

test(core): add test for FilBeam unsupported chain error

8071a70

Add test coverage for getDataSetStats when called with a chain that doesn't support FilBeam (chain.filbeam is null). Co-Authored-By: Claude Code <noreply@anthropic.com> Signed-off-by: Miroslav Bajtoš <oss@bajtos.net>

feat: show remaining CDN & cache-miss egress #538

Are you sure you want to change the base?

feat: show remaining CDN & cache-miss egress #538

Uh oh!

Conversation

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

Uh oh!

Uh oh!

cloudflare-workers-and-pages bot commented Jan 7, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Deploying with Cloudflare Workers

Uh oh!

Uh oh!

Uh oh!

Uh oh!

rvagg commented Jan 8, 2026

Uh oh!

Uh oh!

bajtos commented Jan 13, 2026

Uh oh!

bajtos Jan 20, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

rjan90 commented Jan 26, 2026

Uh oh!

socket-security bot commented Feb 4, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

bajtos commented Feb 4, 2026

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI Feb 4, 2026

Choose a reason for hiding this comment

Uh oh!

bajtos Feb 4, 2026

Choose a reason for hiding this comment

Uh oh!

juliangruber Feb 4, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

7 participants

bajtos commented Jan 7, 2026 •

edited

Loading

cloudflare-workers-and-pages bot commented Jan 7, 2026 •

edited

Loading

socket-security bot commented Feb 4, 2026 •

edited

Loading