Skip to content

docs(ios): notify shipped in 6.3.0; 7.0.0-beta1 added urgent and the flush delay - #129

Open
dsheikherev wants to merge 2 commits into
mainfrom
docs/ios-notify-release-notes
Open

dsheikherev wants to merge 2 commits into
mainfrom
docs/ios-notify-release-notes

Conversation

@dsheikherev

Copy link
Copy Markdown
Contributor

Summary

The release notes got the history of Bugsee.notify wrong.

  • notify is public in Bugsee.h from 6.3.0, with four overloads (title; body; severity; fields). 6.2.1 has none. The 6.3.0 notes did not list it.
  • The 7.0.0-beta1 notes presented notification relay as a new feature. What 7.x actually added, in bugsee-cocoa 178a9962 (Aug 31, before beta1), is the urgent: overload and BugseeOptionConfigNotifyFlushDelay.

Changes:

  • v6/release-notes.md: notification relay added to 6.3.0.
  • release-notes.md: the 7.0.0-beta1 entry now names the urgent: overload and the flush delay, and says notify itself shipped in 6.3.0.

Test plan

  • cspell: 0 issues
  • npm run build: success

🤖 Generated with Claude Code

…flush delay

Bugsee.notify is public in Bugsee.h from 6.3.0 (four overloads; 6.2.1 has none), but the
6.3.0 notes did not list it, and the 7.0.0-beta1 notes presented notification relay as new.
What 7.x added (bugsee-cocoa 178a9962, before beta1) is the urgent: overload and
BugseeOptionConfigNotifyFlushDelay.

- v6/release-notes.md: add notification relay to 6.3.0.
- release-notes.md: the 7.0.0-beta1 entry names what is new and says notify shipped in 6.3.0.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Change-Id: Ia5082760dae7676fd0c3682949d3b8e8562a1b98
@coderabbitai

coderabbitai Bot commented Nov 2, 2026 •

Copy link
Copy Markdown

Important

  • Trigger review

This repository does not receive automatic reviews because it has fewer than 10 stars.

Run configuration
  • Source mode: Auto
  • Repository: Unavailable
  • Branch: Unavailable
  • File: No configuration file from this repository applied
  • Commit: Unavailable
  • Layers: Organization UI
  • Review profile: CHILL
  • Plan: Advanced
  • Run ID: b7d159b7-71b5-46ed-9125-65297c3a4d16
  • 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

@claude

claude Bot commented Nov 2, 2026 •

Copy link
Copy Markdown

Claude finished @dsheikherev's task in 32s —— View job


Review of PR #129

  • Read the diff and surrounding docs (notification-relay.mdx, migration.mdx §9.4, configuration.mdx, v6/release-notes.md)
  • Cross-checked the claims against the other iOS pages
  • Posted findings

I did not run cspell or the build. The PR description says both passed. I also could not check the bugsee-cocoa commit 178a9962, so the 6.3.0 and 7.0.0-beta1 history is taken from the PR description.

Findings

1. P3, docs/sdk/ios/release-notes.md:392-394 (inline comment posted)

  • "posts the notification right away instead of queueing it" overstates what notification-relay.mdx says. Urgent notifications skip the line only if the SDK has a server session and the network is reachable. Otherwise they are queued.
  • Correction to my inline comment: the Wi-Fi-only setting that applies to urgent posts is BugseeOptionConfigWifiOnlyUpload. My wording there was garbled. The flush delay does not apply to urgent notifications.
  • The entry reads as if batching is new. migration.mdx §9.4 says 6.x always waited one second and 7.x defaults to 0, so the default changed.

2. P3, outside the diff, docs/sdk/ios/migration.mdx:1490

  • Step 7 still lists notify among things to "adopt" as new in 7.x. That contradicts §9.4 and this PR, which say notify already exists in 6.3. Suggest listing only the urgent: overload and the flush delay.
  • docs/sdk/ios/notification-relay.mdx:3 describes the page as "Bugsee.notify on iOS 7.x". A short "available since 6.3.0" note would match the corrected history.

Summary

  1. Overall risk: Low. This is a docs-only change to two release-notes files, with no code, config or navigation impact.
  2. Merge recommendation: Approve once the author decides on the wording in finding 1. It is not blocking, and the factual correction itself looks right and agrees with migration.mdx §9.4.
  3. Most important fixes:
    • Tighten the urgent: wording and mention the default flush-delay change (finding 1).
    • Align migration.mdx:1490 with the corrected history (finding 2).
  4. Positives:
    • The 6.3.0 entry puts notify in the right release.
    • The 7.0.0-beta1 entry now names the urgent: overload and BugseeOptionConfigNotifyFlushDelay.
    • The new 6.3.0 line matches the long-line style of that file.
      · Branch: docs/ios-notify-release-notes

Comment thread docs/sdk/ios/release-notes.md Outdated
Comment on lines +392 to +394
- Feat: Notification relay gains an `urgent:` overload, which posts the notification right away
instead of queueing it, and `BugseeOptionConfigNotifyFlushDelay`, which batches nearby
notifications into one upload. `Bugsee.notify` itself shipped in 6.3.0.

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Severity: P3 Low
Location: docs/sdk/ios/release-notes.md:392-394
Problem: Two small accuracy gaps against the pages this entry summarizes.

  1. "posts the notification right away instead of queueing it" overstates it. notification-relay.mdx says an urgent notification skips the line ahead of the queue, but only if the SDK has a server session and the network is reachable (honoring BugseeOptionConfigNotifyFlushDelay-independent Wi-Fi-only rules). Otherwise it is queued like any other, and delivery is at-least-once.
  2. BugseeOptionConfigNotifyFlushDelay is described as if batching is new. migration.mdx §9.4 says 6.x always waited a fixed one second and 7.x defaults to 0, so the default flush behavior changed. A reader upgrading from 6.3.x would not learn that from this entry.
    Impact: Readers may assume urgent notifications bypass the queue unconditionally, and may not realise default batching changed in 7.x.
    Scenario: An app calls notify(..., urgent: true) while offline. The release note suggests it was sent immediately, but it is queued.
    Fix:
Suggested change
- Feat: Notification relay gains an `urgent:` overload, which posts the notification right away
instead of queueing it, and `BugseeOptionConfigNotifyFlushDelay`, which batches nearby
notifications into one upload. `Bugsee.notify` itself shipped in 6.3.0.
- Feat: Notification relay gains an `urgent:` overload, which skips ahead of the queue and posts that one
notification right away when the network is available, and `BugseeOptionConfigNotifyFlushDelay`, which sets
how long to wait before flushing the queue (default `0`; 6.x always waited one second). `Bugsee.notify`
itself shipped in 6.3.0.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Applied in the latest commit, reflowed to the file's line width. Confirmed the 6.x behavior in the 6.3.0 source: BGSNotificationRelayManager.m has kRelayCoalesceDelay = 1.0.

…; 6.x waited one second

Per review: an urgent notification skips the queue but is still queued while offline, and
the flush delay changed the default, since 6.3.0 coalesced for a fixed second
(kRelayCoalesceDelay = 1.0) and 7.x defaults to 0, as migration.mdx 9.4 says.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Change-Id: Ic09c234d37ba2ebd3051e5e9020bc61f6ad5246f
@claude

claude Bot commented Nov 2, 2026 •

Copy link
Copy Markdown

Claude finished @dsheikherev's task in 17s —— View job


Re-review of PR #129 after the latest push (2a1b488)

I read the diff against origin/main and compared the two release-note entries with notification-relay.mdx and migration.mdx §9.4. I did not run cspell or the build, and I could not check bugsee-cocoa 178a9962. The 6.3.0 and 7.0.0-beta1 history comes from the PR description and from §9.4.

Earlier findings

  • Finding 1 (release-notes.md:392-394, urgent wording and flush-delay default): fixed.
    • The entry now says an urgent notification posts "right away when the network is available" and "skips ahead of the queue". That matches notification-relay.mdx:97-101.
    • It now says the flush delay defaults to 0 and that 6.x always waited one second. That matches migration.mdx:1364-1368.
  • Finding 2a (migration.mdx:1490): still open, not a blocker.
    • Step 7 still lists notify among the things to "adopt", but §9.4 and this PR say it already exists in 6.3.
    • Suggested wording: "Adopt the report handler, breadcrumbs, the urgent: notify overload, the new detection options and, on iOS 27, the Crash Report Extension."
    • This file is outside the diff, so it can go in a follow-up.
  • Finding 2b (notification-relay.mdx:3, "available since 6.3.0" note): still open and optional.

New findings

None. The 6.3.0 entry in v6/release-notes.md (title, optional body, severity and fields; queued on the device and uploaded in batches) agrees with §9.4.

Summary

  1. Overall risk: Low. This is a docs-only change to two release-notes files.
  2. Merge recommendation: Approve. The factual correction is consistent with the rest of the iOS docs.
  3. Most important remaining item: the stale "adopt notify" wording at migration.mdx:1490. It is optional and could go in this PR or a follow-up.
  4. Positives:
    • notify is now attributed to the right release.
    • The 7.0.0-beta1 entry names the actual additions, the urgent: overload and BugseeOptionConfigNotifyFlushDelay.
    • The urgent and flush-delay caveats now match the detailed pages.
      · Branch: docs/ios-notify-release-notes

This branch has not been deployed

No deployments
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.

1 participant