Skip to content

chore(catalog): resync the vendored catalog so the drift check passes again - #307

Merged
GeiserX merged 1 commit into
mainfrom
chore/catalog-sync-306
Nov 16, 2026
Merged

GeiserX merged 1 commit into
mainfrom
chore/catalog-sync-306

Conversation

@GeiserX

@GeiserX GeiserX commented Nov 16, 2026 •

Copy link
Copy Markdown
Owner

Desktop's copy of the service catalog fell behind the web app. Nine files in services/ no longer matched the web catalog, so the weekly drift check failed.

What changed in the web catalog

  • EarnApp, PacketStream and ProxyBase gained health signals. A copy that looks healthy but earns nothing now shows as failing. Desktop already reads health_signals, including unless, window_hours and min_matches. All the new patterns compile in Go.
  • Honeygain, IPRoyal, ProxyBase, ProxyRack and TraffMonetizer mark their device name or id with identifier. Desktop already reads it.
  • Bitping says program: false, because it has no referral programme. Desktop already reads it.
  • EarnApp and ProxyRack declare device_link.id_shape, and EarnApp also sets id_shape_unique. _schema.yml documents both keys.

The fix

  • make catalog-sync copies the web files in. The overlay (digest pins and the Mysterium native: block) still applies.
  • DeviceLink now reads id_shape and id_shape_unique. Without them the strict-decode test failed on this sync (field id_shape not found in type catalog.DeviceLink).
  • The web app uses these keys to mask claimable device ids in text that anyone other than the owner sees. Desktop has no such reader. Its notices and container logs show only in the owner's window, and the fleet API and the pairing heartbeat carry only slugs and status. So Desktop reads the keys and masks nothing. catalog-overlay/README.md records this under "Fields Desktop reads differently".

Referral check

I compared the referral link and code of all nine changed services with our records. Each one is correct and unchanged. Bitping has no referral programme, so it keeps its plain signup link.

Checks

  • go run ./cmd/catalogsync -check -ref main: services matches GeiserX/CashPilot@main (54 files).
  • go vet ./...: clean.
  • go test passes for internal/catalog, internal/catalogsync, internal/health and internal/services, and for the root package's referral, README and rating tests.

Fixes #306

Summary by CodeRabbit

  • New Features

    • Device IDs can be masked in text and links shown to non-owners when a service provides a matching ID pattern.
    • Service health reporting now flags repeated connection timeouts, rejected or shared IP addresses, and prolonged relay connection failures.
  • Documentation

    • Clarified how device identifiers and ID-masking settings are handled, including differences between Desktop and web-app behavior.

Desktop's copy of the service catalog had fallen nine files behind the web
app, so the weekly drift check failed. The web catalog gained health
signals for EarnApp, PacketStream and ProxyBase (a copy that looks healthy
but earns nothing now shows as failing), marks device names and ids with
`identifier`, records that Bitping has no referral programme, and declares
each device_link's id shape.

The id shape keys are new to Desktop's loader, and the strict-decode test
refuses a vendored key the loader does not read, so DeviceLink now reads
`id_shape` and `id_shape_unique`. The web app uses them to mask claimable
device ids in text shown to anyone but the owner. Desktop has no such
reader: its notices and logs show only in the owner's window, and the
fleet API and pairing heartbeat carry slugs and status. The overlay README
says so.

Every referral link and code in the nine files is unchanged and correct.

Fixes #306
@coderabbitai

coderabbitai Bot commented Nov 16, 2026 •

Copy link
Copy Markdown

Explain Change →

No actionable comments were generated in the recent review.

Walkthrough

The catalog schema and Go model now include identity markers and device ID shape metadata. Service entries add identifier annotations, ID shape constraints, referral status, and health signals for selected log patterns. The README describes Desktop’s handling of the device ID shape fields.

Changes: Catalog updates

Layer / File(s) Summary
Catalog identity and device ID shape contract
internal/catalog/catalog.go, services/_schema.yml, catalog-overlay/README.md
The Go model adds optional device ID shape fields. The schema describes identity markers and ID shape masking. The README documents that Desktop reads but does not use the shape fields and does not mask device IDs.
Service identity and ID shape metadata
services/bandwidth/bitping.yml, services/bandwidth/earnapp.yml, services/bandwidth/honeygain.yml, services/bandwidth/iproyal.yml, services/bandwidth/proxybase.yml, services/bandwidth/proxyrack.yml, services/bandwidth/traffmonetizer.yml
Selected environment values are marked as identifiers. EarnApp and ProxyRack add device ID shape constraints. Bitping’s referral programme is marked unavailable, with a check date.
Service log-based health signals
services/bandwidth/earnapp.yml, services/bandwidth/packetstream.yml, services/bandwidth/proxybase.yml
EarnApp, PacketStream, and Proxybase add failing health signals triggered by configured log matches and time windows.

Estimated code review effort: 3 (Moderate) | ~20 minutes

Change: Bug fix

Possibly related PRs

Merge Risk: Minimal · up to 3bb54

This change syncs Desktop's service catalog with the web catalog, adding identifier markers, device-ID shape metadata and health signals. Desktop reads the new shape fields but does not use them. No concrete defect was found, so the change looks safe to merge.

Pre-merge checks: Passed 4

Check name Status Explanation
Description Check Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check Passed The title names a chore that resyncs the vendored catalog. The PR syncs nine drifted files in services/ with GeiserX/CashPilot@main, and the stated goal is passing the drift check. The title matches t…
Linked Issues check Passed Issue #306 requires syncing the nine drifted files with GeiserX/CashPilot@main, reviewing referral URLs and codes, and declaring deliberate differences in catalog-overlay/. The PR syncs all nine liste…
Out of Scope Changes check Passed The changes fall into four groups, and each supports the sync. (1) services/ YAML files: these are the synced web catalog content that issue #306 requests. (2) internal/catalog/catalog.go: adds IDShap…
Full details: Title check

Explanation

The title names a chore that resyncs the vendored catalog. The PR syncs nine drifted files in services/ with GeiserX/CashPilot@main, and the stated goal is passing the drift check. The title matches the main change and the stated goal. It does not mention the added health signals, identifier markers, or DeviceLink id_shape fields, but it does not need to cover every detail.

Full details: Linked Issues check

Explanation

Issue #306 requires syncing the nine drifted files with GeiserX/CashPilot@main, reviewing referral URLs and codes, and declaring deliberate differences in catalog-overlay/. The PR syncs all nine listed files: _schema.yml, bandwidth/bitping.yml, earnapp.yml, honeygain.yml, iproyal.yml, packetstream.yml, proxybase.yml, proxyrack.yml and traffmonetizer.yml. The PR reports that the -check run matches main across 54 files. The PR reports the referral check for the nine services and states that all are unchanged and correct. The one deliberate difference, the handling of id_shape and id_shape_unique, is recorded in catalog-overlay/README.md. The issue's procnet.py rule does not apply. The drift log lists no procnet.py change, and the PR does not touch that file. Limit: the sync result and referral review are author-reported. I did not read the web catalog or the synced service files, so I did not verify them independently.

Full details: Out of Scope Changes check

Explanation

The changes fall into four groups, and each supports the sync. (1) services/ YAML files: these are the synced web catalog content that issue #306 requests. (2) internal/catalog/catalog.go: adds IDShape and IDShapeUnique to DeviceLink. The PR states that the strict-decode test fails on this sync without these fields, so the change supports the synced content. (3) services/_schema.yml: documents the new keys that the synced files use. (4) catalog-overlay/README.md: records the deliberate difference that Desktop reads id_shape without masking. The issue asks for such differences to be declared in catalog-overlay/. No change in the summary is unrelated to the catalog sync. Limit: I did not inspect the diff hunks, so this verdict relies on the PR summary and description.

Finishing Touches

Generate unit tests (beta)

  • Commit to this branch
  • Create a new PR
  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

Share

Recent review info

Run configuration

Commits

Reviewing files that changed from the base of the PR and between b5e35df and 3bb54eb.

Files selected for processing: 11

  • catalog-overlay/README.md
  • internal/catalog/catalog.go
  • services/_schema.yml
  • services/bandwidth/bitping.yml
  • services/bandwidth/earnapp.yml
  • services/bandwidth/honeygain.yml
  • services/bandwidth/iproyal.yml
  • services/bandwidth/packetstream.yml
  • services/bandwidth/proxybase.yml
  • services/bandwidth/proxyrack.yml
  • services/bandwidth/traffmonetizer.yml

Included review availability: This review used your included allowance. Your plan provides up to 1 included review per hour; 0 remain after this review.

@codecov

codecov Bot commented Nov 16, 2026 •

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 77.47%. Comparing base (b5e35df) to head (3bb54eb).
⚠️ Report is 1 commits behind head on main.

Additional details and impacted files

Impacted file tree graph

@@            Coverage Diff             @@
##             main     #307      +/-   ##
==========================================
+ Coverage   77.46%   77.47%   +0.01%     
==========================================
  Files          93       93              
  Lines       14539    14539              
==========================================
+ Hits        11262    11264       +2     
+ Misses       2333     2332       -1     
+ Partials      944      943       -1     
Files with missing lines Coverage Δ
internal/catalog/catalog.go 74.43% <ø> (ø)

... and 1 file with indirect coverage changes

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@GeiserX

GeiserX commented Nov 16, 2026

Copy link
Copy Markdown
Owner Author

Waiting on the macOS build only. On this head, GeiserX CI passed ubuntu, frontend and govulncheck, and the geiresx fork run passed windows, ubuntu, frontend and govulncheck (https://github.com/geiresx/CashPilot-Desktop/actions/runs/43956109016). The macOS job is still queued in both pools, and Windows is still queued here. CodeRabbit reviewed this head and found nothing. The referral links and codes of all nine changed services are correct. Merge once macOS goes green in either pool.

@GeiserX
GeiserX merged commit e7adbf9 into main Nov 16, 2026
11 checks passed
@GeiserX
GeiserX deleted the chore/catalog-sync-306 branch November 16, 2026 22:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Catalog drift: services/ no longer matches the CashPilot web catalog

1 participant