Skip to content

Docs: record content-based CloudKit subscription uniqueness finding (#387) - #416

Merged
leogdion merged 1 commit into
v1.0.0-beta.3from
docs/subscription-uniqueness-findings
Jul 1, 2026
Merged

Docs: record content-based CloudKit subscription uniqueness finding (#387)#416
leogdion merged 1 commit into
v1.0.0-beta.3from
docs/subscription-uniqueness-findings

Conversation

@leogdion

@leogdionleogdion commented Jun 30, 2026

Copy link
Copy Markdown
Member

Documentation-only. Captures the empirical finding that CloudKit enforces subscription uniqueness on (recordType, firesOn), not subscriptionID; duplicates surface as a misleading INTERNAL_ERROR ("could not find subscription we just created") with no formal CONFLICT/EXISTS code.

Added a subsection to the HandlingErrors.md docc article documenting the behavior and how MistKit infers it via the hedged isLikelyDuplicate hint / subscriptionLikelyDuplicate error (the API itself already landed); batch modifySubscriptions still returns raw failures via SubscriptionResult.failure.

Closes#387.

@leogdion@claude
docs: record content-based CloudKit subscription uniqueness finding (#…
843fd18
…387)
Empirical probing shows CloudKit enforces subscription uniqueness on
(recordType, firesOn), not subscriptionID; duplicates surface as a
misleading INTERNAL_ERROR. Captures how MistKit infers this via the
hedged isLikelyDuplicate hint / subscriptionLikelyDuplicate error.
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@coderabbitai

coderabbitaiBot commented Jun 30, 2026•
edited
Loading

Copy link
Copy Markdown

Important

Review skipped

Auto reviews are disabled on base/target branches other than the default branch.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 104c1f45-0d3a-48d5-8434-66edfa16c903

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

  • 🔍 Trigger review
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/subscription-uniqueness-findings

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

Comment @coderabbitai help to get the list of available commands.

@claude

claudeBot commented Jun 30, 2026

Copy link
Copy Markdown

Review: Docs — subscription-uniqueness findings (#416)

This PR adds a documentation subsection describing CloudKit's undocumented subscription-uniqueness behavior ((recordType, firesOn) collision → INTERNAL_ERROR) and the subscriptionLikelyDuplicate / isLikelyDuplicate hints MistKit uses to surface it. The prose is clear and the hedged framing matches the code's naming philosophy. Three issues surfaced that a maintainer should act on before merging.

1. Wrong error surface described — httpErrorWithDetails vs. in-body per-item failure [CONFIRMED bug, highest severity]

File:Sources/MistKit/Documentation.docc/HandlingErrors.md

The new section says:

…the rejection arrives as a generic CloudKitError/httpErrorWithDetails(statusCode:serverErrorCode:reason:) carrying serverErrorCodeINTERNAL_ERROR…

This is factually incorrect. CloudKit returns a 200 OK for subscriptions/modify, with per-item failures embedded in the response body (SubscriptionsModifyResponse.subscriptions). CloudKitResponseProcessor.processModifySubscriptionsResponse processes the .ok branch — the .badRequest/.unauthorized/.undocumented branch (which produces httpErrorWithDetails) is never hit for duplicates.

The actual path is:

  1. modifySubscriptions → 200 OK → SubscriptionResult.failure(OperationFailure{serverErrorCode: .internalError, reason: "could not find…"})
  2. createSubscription checks failure.isLikelyDuplicate → throws CloudKitError.subscriptionLikelyDuplicate

httpErrorWithDetails is reserved for HTTP-level rejections (non-2xx). A developer reading this section and trying to catch or understand the error flow will be looking in the wrong place.

Suggested fix: Replace the sentence with something like:

…the rejection arrives as an inline per-item failure inside an otherwise-successful HTTP 200 response body. createSubscription surfaces it as CloudKitError/subscriptionLikelyDuplicate(_:) (carrying the raw INTERNAL_ERROR code and the marker reason string); modifySubscriptions surfaces it as SubscriptionResult/failure(_:).

2. Uniqueness key narrowed from "query" to "recordType" [CONFIRMED]

File:Sources/MistKit/Documentation.docc/HandlingErrors.md

The section (and the empirical Note below it) says the uniqueness key is (recordType, firesOn). The authoritative doc comment in CloudKitError.swift (line 75) says:

same query + firesOn, regardless of subscriptionID

query in CloudKit means the full CKQuery-equivalent: record type plus any filter predicates. Documenting only recordType is misleading — two subscriptions with the same recordType but different filter predicates might not collide, while the current wording implies they would. Both occurrences should use "query" (or "query + firesOn") consistently with the rest of the codebase.

3. subscriptionOperationFailed and subscriptionLikelyDuplicate missing from the CloudKitError cases table [CONFIRMED]

File:Sources/MistKit/Documentation.docc/HandlingErrors.md (around line 80)

The PR adds a standalone subsection for the subscription-duplicate pattern but leaves the main CloudKitError cases table unchanged. That table is the canonical discovery surface for users who don't yet know what error to expect. Both subscriptionOperationFailed and subscriptionLikelyDuplicate should have rows there — otherwise a developer scanning the table during error-handling design won't find them.

Suggested additions:

|``CloudKitError/subscriptionOperationFailed(_:)``| No | A per-subscription failure in a batch `modifySubscriptions`||``CloudKitError/subscriptionLikelyDuplicate(_:)``| No | Inferred duplicate from `createSubscription`; see subsection below |

Minor / non-blocking

  • The ### Per-operation failures Topics group at the bottom is a reasonable addition, but SubscriptionOperationFailure and SubscriptionResult might sit more naturally adjacent to the existing ### Error types group (they are error-surface types, not a third category).
  • failure.reason ?? "" in the code example will log an empty string when reason is nil; failure.reason ?? "<no reason>" or failure.reason.map { "Subscription likely duplicate: \($0)" } ?? "Subscription likely duplicate" would be more informative, though this is style-level.

@codecov

codecovBot commented Jun 30, 2026•
edited
Loading

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 11.52%. Comparing base (9894d48) to head (843fd18).
⚠️ Report is 4 commits behind head on v1.0.0-beta.3.

❗ There is a different number of reports uploaded between BASE (9894d48) and HEAD (843fd18). Click for more details.

HEAD has 9 uploads less than BASE
FlagBASE (9894d48)HEAD (843fd18)
spm30
swift-6.3-noble10
swift-6.1-noble10
swift-6.2-noble10
swift-6.2-jammy10
swift-6.1-jammy10
swift-6.3-jammy10
Additional details and impacted files
@@ Coverage Diff @@## v1.0.0-beta.3 #416 +/- ##
==================================================
- Coverage 71.82% 11.52% -60.31% 
==================================================
Files 168 168 Lines 3844 3844 ==================================================
- Hits 2761 443 -2318 - Misses 1083 3401 +2318
FlagCoverage Δ
mistdemo-spm-macos11.42% <ø> (ø)
mistdemo-swift-6.2-jammy11.42% <ø> (ø)
mistdemo-swift-6.2-noble11.42% <ø> (ø)
mistdemo-swift-6.3-jammy11.42% <ø> (ø)
mistdemo-swift-6.3-noble11.52% <ø> (+0.10%)⬆️
spm?
swift-6.1-jammy?
swift-6.1-noble?
swift-6.2-jammy?
swift-6.2-noble?
swift-6.3-jammy?
swift-6.3-noble?

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@leogdion
leogdion marked this pull request as ready for review July 1, 2026 00:34
@leogdion
leogdion merged commit 97dd4a2 into v1.0.0-beta.3Jul 1, 2026
34 of 36 checks passed
@leogdion
leogdion deleted the docs/subscription-uniqueness-findings branch July 1, 2026 00:34
@claudeclaudeBot mentioned this pull request Aug 20, 2026
Merged
@leogdionleogdion mentioned this pull request Aug 20, 2026
Closed
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

1 participant

@leogdion
, 'i'); if (__m === '*' || __re.test(location.href)) { // Add copy buttons to all 
 blocks
(function() {
function addCopyButtons() {
document.querySelectorAll('pre code').forEach(function(codeBlock) {
if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;
codeBlock.parentElement.setAttribute('data-copy-added', 'true');
var btn = document.createElement('button');
btn.textContent = 'Copy';
btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';
btn.onmouseover = function() { this.style.opacity = '1'; };
btn.onmouseout = function() { this.style.opacity = '0.7'; };
btn.onclick = function() {
navigator.clipboard.writeText(codeBlock.textContent).then(function() {
btn.textContent = 'Copied!';
setTimeout(function() { btn.textContent = 'Copy'; }, 1500);
});
};
codeBlock.parentElement.style.position = 'relative';
codeBlock.parentElement.appendChild(btn);
});
}
addCopyButtons();
// Re-run on dynamic content
var observer = new MutationObserver(addCopyButtons);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
Docs: record content-based CloudKit subscription uniqueness finding (#387) by leogdion · Pull Request #416 · brightdigit/MistKit · GitHub
Skip to content
Docs: record content-based CloudKit subscription uniqueness finding (#387) - #416
Merged
leogdion merged 1 commit into
v1.0.0-beta.3from 
docs/subscription-uniqueness-findings
Jul 1, 2026
Merged
Docs: record content-based CloudKit subscription uniqueness finding (#387)#416
leogdion merged 1 commit into
v1.0.0-beta.3from 
docs/subscription-uniqueness-findings
Conversation
@leogdion
@leogdionleogdion
commented
Jun 30, 2026

Copy link


Copy Markdown

Member
Documentation-only. Captures the empirical finding that CloudKit enforces subscription uniqueness on (recordType, firesOn), not subscriptionID; duplicates surface as a misleading INTERNAL_ERROR ("could not find subscription we just created") with no formal CONFLICT/EXISTS code.
Added a subsection to the HandlingErrors.md docc article documenting the behavior and how MistKit infers it via the hedged isLikelyDuplicate hint / subscriptionLikelyDuplicate error (the API itself already landed); batch modifySubscriptions still returns raw failures via SubscriptionResult.failure.
Closes#387.
@leogdion@claude
docs: record content-based CloudKit subscription uniqueness finding (#…
843fd18
…387)
Empirical probing shows CloudKit enforces subscription uniqueness on
(recordType, firesOn), not subscriptionID; duplicates surface as a
misleading INTERNAL_ERROR. Captures how MistKit infers this via the
hedged isLikelyDuplicate hint / subscriptionLikelyDuplicate error.
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@coderabbitai
coderabbitaiBot
commented
Jun 30, 2026•

edited

Loading

Copy link


Copy Markdown

Important
Review skipped
Auto reviews are disabled on base/target branches other than the default branch.
Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro
Run ID: 104c1f45-0d3a-48d5-8434-66edfa16c903
You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.
Use the checkbox below for a quick retry:
  •  🔍 Trigger review
✨ Finishing Touches
🧪 Generate unit tests (beta)
  •  Create PR with unit tests
  •  Commit unit tests in branch docs/subscription-uniqueness-findings
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
Comment @coderabbitai help to get the list of available commands.
@claude
claudeBot
commented
Jun 30, 2026

Copy link


Copy Markdown

Review: Docs — subscription-uniqueness findings (#416)
This PR adds a documentation subsection describing CloudKit's undocumented subscription-uniqueness behavior ((recordType, firesOn) collision → INTERNAL_ERROR) and the subscriptionLikelyDuplicate / isLikelyDuplicate hints MistKit uses to surface it. The prose is clear and the hedged framing matches the code's naming philosophy. Three issues surfaced that a maintainer should act on before merging.
1. Wrong error surface described — httpErrorWithDetails vs. in-body per-item failure [CONFIRMED bug, highest severity]
File:Sources/MistKit/Documentation.docc/HandlingErrors.md
The new section says:
…the rejection arrives as a generic CloudKitError/httpErrorWithDetails(statusCode:serverErrorCode:reason:) carrying serverErrorCodeINTERNAL_ERROR…
This is factually incorrect. CloudKit returns a 200 OK for subscriptions/modify, with per-item failures embedded in the response body (SubscriptionsModifyResponse.subscriptions). CloudKitResponseProcessor.processModifySubscriptionsResponse processes the .ok branch — the .badRequest/.unauthorized/.undocumented branch (which produces httpErrorWithDetails) is never hit for duplicates.
The actual path is:
  1. modifySubscriptions → 200 OK → SubscriptionResult.failure(OperationFailure{serverErrorCode: .internalError, reason: "could not find…"})
  2. createSubscription checks failure.isLikelyDuplicate → throws CloudKitError.subscriptionLikelyDuplicate
httpErrorWithDetails is reserved for HTTP-level rejections (non-2xx). A developer reading this section and trying to catch or understand the error flow will be looking in the wrong place.
Suggested fix: Replace the sentence with something like:
…the rejection arrives as an inline per-item failure inside an otherwise-successful HTTP 200 response body. createSubscription surfaces it as CloudKitError/subscriptionLikelyDuplicate(_:) (carrying the raw INTERNAL_ERROR code and the marker reason string); modifySubscriptions surfaces it as SubscriptionResult/failure(_:).
2. Uniqueness key narrowed from "query" to "recordType" [CONFIRMED]
File:Sources/MistKit/Documentation.docc/HandlingErrors.md
The section (and the empirical Note below it) says the uniqueness key is (recordType, firesOn). The authoritative doc comment in CloudKitError.swift (line 75) says:
same query + firesOn, regardless of subscriptionID
query in CloudKit means the full CKQuery-equivalent: record type plus any filter predicates. Documenting only recordType is misleading — two subscriptions with the same recordType but different filter predicates might not collide, while the current wording implies they would. Both occurrences should use "query" (or "query + firesOn") consistently with the rest of the codebase.
3. subscriptionOperationFailed and subscriptionLikelyDuplicate missing from the CloudKitError cases table [CONFIRMED]
File:Sources/MistKit/Documentation.docc/HandlingErrors.md (around line 80)
The PR adds a standalone subsection for the subscription-duplicate pattern but leaves the main CloudKitError cases table unchanged. That table is the canonical discovery surface for users who don't yet know what error to expect. Both subscriptionOperationFailed and subscriptionLikelyDuplicate should have rows there — otherwise a developer scanning the table during error-handling design won't find them.
Suggested additions:
|``CloudKitError/subscriptionOperationFailed(_:)``| No | A per-subscription failure in a batch `modifySubscriptions`||``CloudKitError/subscriptionLikelyDuplicate(_:)``| No | Inferred duplicate from `createSubscription`; see subsection below |
Minor / non-blocking
  • The ### Per-operation failures Topics group at the bottom is a reasonable addition, but SubscriptionOperationFailure and SubscriptionResult might sit more naturally adjacent to the existing ### Error types group (they are error-surface types, not a third category).
  • failure.reason ?? "" in the code example will log an empty string when reason is nil; failure.reason ?? "<no reason>" or failure.reason.map { "Subscription likely duplicate: \($0)" } ?? "Subscription likely duplicate" would be more informative, though this is style-level.
@codecov
codecovBot
commented
Jun 30, 2026•

edited

Loading

Copy link


Copy Markdown

Codecov Report
✅ All modified and coverable lines are covered by tests.

✅ Project coverage is 11.52%. Comparing base (9894d48) to head (843fd18).
⚠️ Report is 4 commits behind head on v1.0.0-beta.3.
❗ There is a different number of reports uploaded between BASE (9894d48) and HEAD (843fd18). Click for more details.
HEAD has 9 uploads less than BASE
FlagBASE (9894d48)HEAD (843fd18)
spm30
swift-6.3-noble10
swift-6.1-noble10
swift-6.2-noble10
swift-6.2-jammy10
swift-6.1-jammy10
swift-6.3-jammy10
Additional details and impacted files
@@ Coverage Diff @@## v1.0.0-beta.3 #416 +/- ##
==================================================
- Coverage 71.82% 11.52% -60.31% 
==================================================
Files 168 168 Lines 3844 3844 ==================================================
- Hits 2761 443 -2318 - Misses 1083 3401 +2318 
FlagCoverage Δ
mistdemo-spm-macos11.42% <ø> (ø)
mistdemo-swift-6.2-jammy11.42% <ø> (ø)
mistdemo-swift-6.2-noble11.42% <ø> (ø)
mistdemo-swift-6.3-jammy11.42% <ø> (ø)
mistdemo-swift-6.3-noble11.52% <ø> (+0.10%)⬆️
spm?
swift-6.1-jammy?
swift-6.1-noble?
swift-6.2-jammy?
swift-6.2-noble?
swift-6.3-jammy?
swift-6.3-noble?
Flags with carried forward coverage won't be shown. Click here to find out more.
☔ View full report in Codecov by Harness.

📢 Have feedback on the report? Share it here.
 🚀 New features to boost your workflow: 
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
@leogdion
leogdion
marked this pull request as ready for review
July 1, 2026 00:34
@leogdion
leogdion
merged commit 97dd4a2
into
v1.0.0-beta.3Jul 1, 2026

34 of 36 checks passed

@leogdion
leogdion
deleted the

docs/subscription-uniqueness-findings

branch
July 1, 2026 00:34
@claudeclaudeBot
mentioned this pull request
Aug 20, 2026
 Merged

@leogdionleogdion
mentioned this pull request
Aug 20, 2026

Closed

Sign up for freeto join this conversation on GitHub.
Already have an account?
Sign in to comment

Reviewers


No reviews


Assignees


No one assigned


Labels


None yet


Projects


None yet


Milestone


No milestone


Development

Successfully merging this pull request may close these issues.

1 participant

@leogdion

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Force GitHub README to respect dark mode
(function() {
var style = document.createElement('style');
style.textContent = '
.markdown-body {
color-scheme: dark light;
}
.markdown-body pre { background: #161b22 !important; }
.markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }
.markdown-body table th, .markdown-body table td { border-color: #30363d !important; }
.markdown-body img { background: #0d1117; }
.markdown-body blockquote { border-left-color: #8b949e; }
.markdown-body hr { border-color: #30363d; }
';
document.head.appendChild(style);
})();
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
Docs: record content-based CloudKit subscription uniqueness finding (#387) by leogdion · Pull Request #416 · brightdigit/MistKit · GitHub
Skip to content
Docs: record content-based CloudKit subscription uniqueness finding (#387) - #416
Merged
leogdion merged 1 commit into
v1.0.0-beta.3from 
docs/subscription-uniqueness-findings
Jul 1, 2026
Merged
Docs: record content-based CloudKit subscription uniqueness finding (#387)#416
leogdion merged 1 commit into
v1.0.0-beta.3from 
docs/subscription-uniqueness-findings
Conversation
@leogdion
@leogdionleogdion
commented
Jun 30, 2026

Copy link


Copy Markdown

Member
Documentation-only. Captures the empirical finding that CloudKit enforces subscription uniqueness on (recordType, firesOn), not subscriptionID; duplicates surface as a misleading INTERNAL_ERROR ("could not find subscription we just created") with no formal CONFLICT/EXISTS code.
Added a subsection to the HandlingErrors.md docc article documenting the behavior and how MistKit infers it via the hedged isLikelyDuplicate hint / subscriptionLikelyDuplicate error (the API itself already landed); batch modifySubscriptions still returns raw failures via SubscriptionResult.failure.
Closes#387.
@leogdion@claude
docs: record content-based CloudKit subscription uniqueness finding (#…
843fd18
…387)
Empirical probing shows CloudKit enforces subscription uniqueness on
(recordType, firesOn), not subscriptionID; duplicates surface as a
misleading INTERNAL_ERROR. Captures how MistKit infers this via the
hedged isLikelyDuplicate hint / subscriptionLikelyDuplicate error.
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@coderabbitai
coderabbitaiBot
commented
Jun 30, 2026•

edited

Loading

Copy link


Copy Markdown

Important
Review skipped
Auto reviews are disabled on base/target branches other than the default branch.
Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro
Run ID: 104c1f45-0d3a-48d5-8434-66edfa16c903
You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.
Use the checkbox below for a quick retry:
  •  🔍 Trigger review
✨ Finishing Touches
🧪 Generate unit tests (beta)
  •  Create PR with unit tests
  •  Commit unit tests in branch docs/subscription-uniqueness-findings
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
Comment @coderabbitai help to get the list of available commands.
@claude
claudeBot
commented
Jun 30, 2026

Copy link


Copy Markdown

Review: Docs — subscription-uniqueness findings (#416)
This PR adds a documentation subsection describing CloudKit's undocumented subscription-uniqueness behavior ((recordType, firesOn) collision → INTERNAL_ERROR) and the subscriptionLikelyDuplicate / isLikelyDuplicate hints MistKit uses to surface it. The prose is clear and the hedged framing matches the code's naming philosophy. Three issues surfaced that a maintainer should act on before merging.
1. Wrong error surface described — httpErrorWithDetails vs. in-body per-item failure [CONFIRMED bug, highest severity]
File:Sources/MistKit/Documentation.docc/HandlingErrors.md
The new section says:
…the rejection arrives as a generic CloudKitError/httpErrorWithDetails(statusCode:serverErrorCode:reason:) carrying serverErrorCodeINTERNAL_ERROR…
This is factually incorrect. CloudKit returns a 200 OK for subscriptions/modify, with per-item failures embedded in the response body (SubscriptionsModifyResponse.subscriptions). CloudKitResponseProcessor.processModifySubscriptionsResponse processes the .ok branch — the .badRequest/.unauthorized/.undocumented branch (which produces httpErrorWithDetails) is never hit for duplicates.
The actual path is:
  1. modifySubscriptions → 200 OK → SubscriptionResult.failure(OperationFailure{serverErrorCode: .internalError, reason: "could not find…"})
  2. createSubscription checks failure.isLikelyDuplicate → throws CloudKitError.subscriptionLikelyDuplicate
httpErrorWithDetails is reserved for HTTP-level rejections (non-2xx). A developer reading this section and trying to catch or understand the error flow will be looking in the wrong place.
Suggested fix: Replace the sentence with something like:
…the rejection arrives as an inline per-item failure inside an otherwise-successful HTTP 200 response body. createSubscription surfaces it as CloudKitError/subscriptionLikelyDuplicate(_:) (carrying the raw INTERNAL_ERROR code and the marker reason string); modifySubscriptions surfaces it as SubscriptionResult/failure(_:).
2. Uniqueness key narrowed from "query" to "recordType" [CONFIRMED]
File:Sources/MistKit/Documentation.docc/HandlingErrors.md
The section (and the empirical Note below it) says the uniqueness key is (recordType, firesOn). The authoritative doc comment in CloudKitError.swift (line 75) says:
same query + firesOn, regardless of subscriptionID
query in CloudKit means the full CKQuery-equivalent: record type plus any filter predicates. Documenting only recordType is misleading — two subscriptions with the same recordType but different filter predicates might not collide, while the current wording implies they would. Both occurrences should use "query" (or "query + firesOn") consistently with the rest of the codebase.
3. subscriptionOperationFailed and subscriptionLikelyDuplicate missing from the CloudKitError cases table [CONFIRMED]
File:Sources/MistKit/Documentation.docc/HandlingErrors.md (around line 80)
The PR adds a standalone subsection for the subscription-duplicate pattern but leaves the main CloudKitError cases table unchanged. That table is the canonical discovery surface for users who don't yet know what error to expect. Both subscriptionOperationFailed and subscriptionLikelyDuplicate should have rows there — otherwise a developer scanning the table during error-handling design won't find them.
Suggested additions:
|``CloudKitError/subscriptionOperationFailed(_:)``| No | A per-subscription failure in a batch `modifySubscriptions`||``CloudKitError/subscriptionLikelyDuplicate(_:)``| No | Inferred duplicate from `createSubscription`; see subsection below |
Minor / non-blocking
  • The ### Per-operation failures Topics group at the bottom is a reasonable addition, but SubscriptionOperationFailure and SubscriptionResult might sit more naturally adjacent to the existing ### Error types group (they are error-surface types, not a third category).
  • failure.reason ?? "" in the code example will log an empty string when reason is nil; failure.reason ?? "<no reason>" or failure.reason.map { "Subscription likely duplicate: \($0)" } ?? "Subscription likely duplicate" would be more informative, though this is style-level.
@codecov
codecovBot
commented
Jun 30, 2026•

edited

Loading

Copy link


Copy Markdown

Codecov Report
✅ All modified and coverable lines are covered by tests.

✅ Project coverage is 11.52%. Comparing base (9894d48) to head (843fd18).
⚠️ Report is 4 commits behind head on v1.0.0-beta.3.
❗ There is a different number of reports uploaded between BASE (9894d48) and HEAD (843fd18). Click for more details.
HEAD has 9 uploads less than BASE
FlagBASE (9894d48)HEAD (843fd18)
spm30
swift-6.3-noble10
swift-6.1-noble10
swift-6.2-noble10
swift-6.2-jammy10
swift-6.1-jammy10
swift-6.3-jammy10
Additional details and impacted files
@@ Coverage Diff @@## v1.0.0-beta.3 #416 +/- ##
==================================================
- Coverage 71.82% 11.52% -60.31% 
==================================================
Files 168 168 Lines 3844 3844 ==================================================
- Hits 2761 443 -2318 - Misses 1083 3401 +2318 
FlagCoverage Δ
mistdemo-spm-macos11.42% <ø> (ø)
mistdemo-swift-6.2-jammy11.42% <ø> (ø)
mistdemo-swift-6.2-noble11.42% <ø> (ø)
mistdemo-swift-6.3-jammy11.42% <ø> (ø)
mistdemo-swift-6.3-noble11.52% <ø> (+0.10%)⬆️
spm?
swift-6.1-jammy?
swift-6.1-noble?
swift-6.2-jammy?
swift-6.2-noble?
swift-6.3-jammy?
swift-6.3-noble?
Flags with carried forward coverage won't be shown. Click here to find out more.
☔ View full report in Codecov by Harness.

📢 Have feedback on the report? Share it here.
 🚀 New features to boost your workflow: 
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
@leogdion
leogdion
marked this pull request as ready for review
July 1, 2026 00:34
@leogdion
leogdion
merged commit 97dd4a2
into
v1.0.0-beta.3Jul 1, 2026

34 of 36 checks passed

@leogdion
leogdion
deleted the

docs/subscription-uniqueness-findings

branch
July 1, 2026 00:34
@claudeclaudeBot
mentioned this pull request
Aug 20, 2026
 Merged

@leogdionleogdion
mentioned this pull request
Aug 20, 2026

Closed

Sign up for freeto join this conversation on GitHub.
Already have an account?
Sign in to comment

Reviewers


No reviews


Assignees


No one assigned


Labels


None yet


Projects


None yet


Milestone


No milestone


Development

Successfully merging this pull request may close these issues.

1 participant

@leogdion

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Highlight search terms from Google/DuckDuckGo/Bing referrer
(function() {
var ref = document.referrer;
var terms = [];
if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {
var url = new URL(ref);
var q = url.searchParams.get('q') || url.searchParams.get('p');
if (q) {
terms = q.split(/\s+/).filter(function(t) { return t.length > 2; });
}
}
if (terms.length === 0) return;
var style = document.createElement('style');
style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';
document.head.appendChild(style);
function highlight(node) {
if (node.nodeType === 3) { // text node
var text = node.textContent;
var found = false;
terms.forEach(function(term) {
var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\]\\]/g, '\\') + ')', 'gi');
if (regex.test(text)) {
found = true;
var frag = document.createDocumentFragment();
var parts = text.split(regex);
parts.forEach(function(part, i) {
if (i % 2 === 0) {
frag.appendChild(document.createTextNode(part));
} else {
var span = document.createElement('span');
span.className = 'userscript-highlight';
span.textContent = part;
frag.appendChild(span);
}
});
node.parentNode.replaceChild(frag, node);
}
});
} else if (node.nodeType === 1 && node.childNodes) { // element
var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];
if (!skipTags.includes(node.tagName)) {
Array.from(node.childNodes).forEach(highlight);
}
}
}
highlight(document.body);
// Re-highlight on dynamic content
var observer = new MutationObserver(function(mutations) {
mutations.forEach(function(m) {
m.addedNodes.forEach(function(node) {
if (node.nodeType === 1 || node.nodeType === 3) highlight(node);
});
});
});
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
Docs: record content-based CloudKit subscription uniqueness finding (#387) by leogdion · Pull Request #416 · brightdigit/MistKit · GitHub
Skip to content
Docs: record content-based CloudKit subscription uniqueness finding (#387) - #416
Merged
leogdion merged 1 commit into
v1.0.0-beta.3from 
docs/subscription-uniqueness-findings
Jul 1, 2026
Merged
Docs: record content-based CloudKit subscription uniqueness finding (#387)#416
leogdion merged 1 commit into
v1.0.0-beta.3from 
docs/subscription-uniqueness-findings
Conversation
@leogdion
@leogdionleogdion
commented
Jun 30, 2026

Copy link


Copy Markdown

Member
Documentation-only. Captures the empirical finding that CloudKit enforces subscription uniqueness on (recordType, firesOn), not subscriptionID; duplicates surface as a misleading INTERNAL_ERROR ("could not find subscription we just created") with no formal CONFLICT/EXISTS code.
Added a subsection to the HandlingErrors.md docc article documenting the behavior and how MistKit infers it via the hedged isLikelyDuplicate hint / subscriptionLikelyDuplicate error (the API itself already landed); batch modifySubscriptions still returns raw failures via SubscriptionResult.failure.
Closes#387.
@leogdion@claude
docs: record content-based CloudKit subscription uniqueness finding (#…
843fd18
…387)
Empirical probing shows CloudKit enforces subscription uniqueness on
(recordType, firesOn), not subscriptionID; duplicates surface as a
misleading INTERNAL_ERROR. Captures how MistKit infers this via the
hedged isLikelyDuplicate hint / subscriptionLikelyDuplicate error.
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@coderabbitai
coderabbitaiBot
commented
Jun 30, 2026•

edited

Loading

Copy link


Copy Markdown

Important
Review skipped
Auto reviews are disabled on base/target branches other than the default branch.
Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro
Run ID: 104c1f45-0d3a-48d5-8434-66edfa16c903
You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.
Use the checkbox below for a quick retry:
  •  🔍 Trigger review
✨ Finishing Touches
🧪 Generate unit tests (beta)
  •  Create PR with unit tests
  •  Commit unit tests in branch docs/subscription-uniqueness-findings
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
Comment @coderabbitai help to get the list of available commands.
@claude
claudeBot
commented
Jun 30, 2026

Copy link


Copy Markdown

Review: Docs — subscription-uniqueness findings (#416)
This PR adds a documentation subsection describing CloudKit's undocumented subscription-uniqueness behavior ((recordType, firesOn) collision → INTERNAL_ERROR) and the subscriptionLikelyDuplicate / isLikelyDuplicate hints MistKit uses to surface it. The prose is clear and the hedged framing matches the code's naming philosophy. Three issues surfaced that a maintainer should act on before merging.
1. Wrong error surface described — httpErrorWithDetails vs. in-body per-item failure [CONFIRMED bug, highest severity]
File:Sources/MistKit/Documentation.docc/HandlingErrors.md
The new section says:
…the rejection arrives as a generic CloudKitError/httpErrorWithDetails(statusCode:serverErrorCode:reason:) carrying serverErrorCodeINTERNAL_ERROR…
This is factually incorrect. CloudKit returns a 200 OK for subscriptions/modify, with per-item failures embedded in the response body (SubscriptionsModifyResponse.subscriptions). CloudKitResponseProcessor.processModifySubscriptionsResponse processes the .ok branch — the .badRequest/.unauthorized/.undocumented branch (which produces httpErrorWithDetails) is never hit for duplicates.
The actual path is:
  1. modifySubscriptions → 200 OK → SubscriptionResult.failure(OperationFailure{serverErrorCode: .internalError, reason: "could not find…"})
  2. createSubscription checks failure.isLikelyDuplicate → throws CloudKitError.subscriptionLikelyDuplicate
httpErrorWithDetails is reserved for HTTP-level rejections (non-2xx). A developer reading this section and trying to catch or understand the error flow will be looking in the wrong place.
Suggested fix: Replace the sentence with something like:
…the rejection arrives as an inline per-item failure inside an otherwise-successful HTTP 200 response body. createSubscription surfaces it as CloudKitError/subscriptionLikelyDuplicate(_:) (carrying the raw INTERNAL_ERROR code and the marker reason string); modifySubscriptions surfaces it as SubscriptionResult/failure(_:).
2. Uniqueness key narrowed from "query" to "recordType" [CONFIRMED]
File:Sources/MistKit/Documentation.docc/HandlingErrors.md
The section (and the empirical Note below it) says the uniqueness key is (recordType, firesOn). The authoritative doc comment in CloudKitError.swift (line 75) says:
same query + firesOn, regardless of subscriptionID
query in CloudKit means the full CKQuery-equivalent: record type plus any filter predicates. Documenting only recordType is misleading — two subscriptions with the same recordType but different filter predicates might not collide, while the current wording implies they would. Both occurrences should use "query" (or "query + firesOn") consistently with the rest of the codebase.
3. subscriptionOperationFailed and subscriptionLikelyDuplicate missing from the CloudKitError cases table [CONFIRMED]
File:Sources/MistKit/Documentation.docc/HandlingErrors.md (around line 80)
The PR adds a standalone subsection for the subscription-duplicate pattern but leaves the main CloudKitError cases table unchanged. That table is the canonical discovery surface for users who don't yet know what error to expect. Both subscriptionOperationFailed and subscriptionLikelyDuplicate should have rows there — otherwise a developer scanning the table during error-handling design won't find them.
Suggested additions:
|``CloudKitError/subscriptionOperationFailed(_:)``| No | A per-subscription failure in a batch `modifySubscriptions`||``CloudKitError/subscriptionLikelyDuplicate(_:)``| No | Inferred duplicate from `createSubscription`; see subsection below |
Minor / non-blocking
  • The ### Per-operation failures Topics group at the bottom is a reasonable addition, but SubscriptionOperationFailure and SubscriptionResult might sit more naturally adjacent to the existing ### Error types group (they are error-surface types, not a third category).
  • failure.reason ?? "" in the code example will log an empty string when reason is nil; failure.reason ?? "<no reason>" or failure.reason.map { "Subscription likely duplicate: \($0)" } ?? "Subscription likely duplicate" would be more informative, though this is style-level.
@codecov
codecovBot
commented
Jun 30, 2026•

edited

Loading

Copy link


Copy Markdown

Codecov Report
✅ All modified and coverable lines are covered by tests.

✅ Project coverage is 11.52%. Comparing base (9894d48) to head (843fd18).
⚠️ Report is 4 commits behind head on v1.0.0-beta.3.
❗ There is a different number of reports uploaded between BASE (9894d48) and HEAD (843fd18). Click for more details.
HEAD has 9 uploads less than BASE
FlagBASE (9894d48)HEAD (843fd18)
spm30
swift-6.3-noble10
swift-6.1-noble10
swift-6.2-noble10
swift-6.2-jammy10
swift-6.1-jammy10
swift-6.3-jammy10
Additional details and impacted files
@@ Coverage Diff @@## v1.0.0-beta.3 #416 +/- ##
==================================================
- Coverage 71.82% 11.52% -60.31% 
==================================================
Files 168 168 Lines 3844 3844 ==================================================
- Hits 2761 443 -2318 - Misses 1083 3401 +2318 
FlagCoverage Δ
mistdemo-spm-macos11.42% <ø> (ø)
mistdemo-swift-6.2-jammy11.42% <ø> (ø)
mistdemo-swift-6.2-noble11.42% <ø> (ø)
mistdemo-swift-6.3-jammy11.42% <ø> (ø)
mistdemo-swift-6.3-noble11.52% <ø> (+0.10%)⬆️
spm?
swift-6.1-jammy?
swift-6.1-noble?
swift-6.2-jammy?
swift-6.2-noble?
swift-6.3-jammy?
swift-6.3-noble?
Flags with carried forward coverage won't be shown. Click here to find out more.
☔ View full report in Codecov by Harness.

📢 Have feedback on the report? Share it here.
 🚀 New features to boost your workflow: 
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
@leogdion
leogdion
marked this pull request as ready for review
July 1, 2026 00:34
@leogdion
leogdion
merged commit 97dd4a2
into
v1.0.0-beta.3Jul 1, 2026

34 of 36 checks passed

@leogdion
leogdion
deleted the

docs/subscription-uniqueness-findings

branch
July 1, 2026 00:34
@claudeclaudeBot
mentioned this pull request
Aug 20, 2026
 Merged

@leogdionleogdion
mentioned this pull request
Aug 20, 2026

Closed

Sign up for freeto join this conversation on GitHub.
Already have an account?
Sign in to comment

Reviewers


No reviews


Assignees


No one assigned


Labels


None yet


Projects


None yet


Milestone


No milestone


Development

Successfully merging this pull request may close these issues.

1 participant

@leogdion

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Strip utm_, fbclid, gclid, etc. from all links on page
(function() {
var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',
'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',
'ref', 'ref_src', 'source', 'medium', 'campaign'];
function cleanUrl(url) {
try {
var u = new URL(url, window.location.origin);
var changed = false;
trackingParams.forEach(function(p) {
if (u.searchParams.has(p)) {
u.searchParams.delete(p);
changed = true;
}
});
return changed ? u.toString() : url;
} catch (e) {
return url;
}
}
function cleanLinks() {
document.querySelectorAll('a[href]').forEach(function(a) {
var clean = cleanUrl(a.href);
if (clean !== a.href) a.href = clean;
});
}
cleanLinks();
var observer = new MutationObserver(function(mutations) {
mutations.forEach(function(m) {
m.addedNodes.forEach(function(node) {
if (node.nodeType === 1) {
if (node.tagName === 'A') cleanLinks();
node.querySelectorAll('a[href]').forEach(function(a) {
var clean = cleanUrl(a.href);
if (clean !== a.href) a.href = clean;
});
}
});
});
});
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '
Docs: record content-based CloudKit subscription uniqueness finding (#387) by leogdion · Pull Request #416 · brightdigit/MistKit · GitHub
Skip to content
Docs: record content-based CloudKit subscription uniqueness finding (#387) - #416
Merged
leogdion merged 1 commit into
v1.0.0-beta.3from 
docs/subscription-uniqueness-findings
Jul 1, 2026
Merged
Docs: record content-based CloudKit subscription uniqueness finding (#387)#416
leogdion merged 1 commit into
v1.0.0-beta.3from 
docs/subscription-uniqueness-findings
Conversation
@leogdion
@leogdionleogdion
commented
Jun 30, 2026

Copy link


Copy Markdown

Member
Documentation-only. Captures the empirical finding that CloudKit enforces subscription uniqueness on (recordType, firesOn), not subscriptionID; duplicates surface as a misleading INTERNAL_ERROR ("could not find subscription we just created") with no formal CONFLICT/EXISTS code.
Added a subsection to the HandlingErrors.md docc article documenting the behavior and how MistKit infers it via the hedged isLikelyDuplicate hint / subscriptionLikelyDuplicate error (the API itself already landed); batch modifySubscriptions still returns raw failures via SubscriptionResult.failure.
Closes#387.
@leogdion@claude
docs: record content-based CloudKit subscription uniqueness finding (#…
843fd18
…387)
Empirical probing shows CloudKit enforces subscription uniqueness on
(recordType, firesOn), not subscriptionID; duplicates surface as a
misleading INTERNAL_ERROR. Captures how MistKit infers this via the
hedged isLikelyDuplicate hint / subscriptionLikelyDuplicate error.
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@coderabbitai
coderabbitaiBot
commented
Jun 30, 2026•

edited

Loading

Copy link


Copy Markdown

Important
Review skipped
Auto reviews are disabled on base/target branches other than the default branch.
Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro
Run ID: 104c1f45-0d3a-48d5-8434-66edfa16c903
You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.
Use the checkbox below for a quick retry:
  •  🔍 Trigger review
✨ Finishing Touches
🧪 Generate unit tests (beta)
  •  Create PR with unit tests
  •  Commit unit tests in branch docs/subscription-uniqueness-findings
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
Comment @coderabbitai help to get the list of available commands.
@claude
claudeBot
commented
Jun 30, 2026

Copy link


Copy Markdown

Review: Docs — subscription-uniqueness findings (#416)
This PR adds a documentation subsection describing CloudKit's undocumented subscription-uniqueness behavior ((recordType, firesOn) collision → INTERNAL_ERROR) and the subscriptionLikelyDuplicate / isLikelyDuplicate hints MistKit uses to surface it. The prose is clear and the hedged framing matches the code's naming philosophy. Three issues surfaced that a maintainer should act on before merging.
1. Wrong error surface described — httpErrorWithDetails vs. in-body per-item failure [CONFIRMED bug, highest severity]
File:Sources/MistKit/Documentation.docc/HandlingErrors.md
The new section says:
…the rejection arrives as a generic CloudKitError/httpErrorWithDetails(statusCode:serverErrorCode:reason:) carrying serverErrorCodeINTERNAL_ERROR…
This is factually incorrect. CloudKit returns a 200 OK for subscriptions/modify, with per-item failures embedded in the response body (SubscriptionsModifyResponse.subscriptions). CloudKitResponseProcessor.processModifySubscriptionsResponse processes the .ok branch — the .badRequest/.unauthorized/.undocumented branch (which produces httpErrorWithDetails) is never hit for duplicates.
The actual path is:
  1. modifySubscriptions → 200 OK → SubscriptionResult.failure(OperationFailure{serverErrorCode: .internalError, reason: "could not find…"})
  2. createSubscription checks failure.isLikelyDuplicate → throws CloudKitError.subscriptionLikelyDuplicate
httpErrorWithDetails is reserved for HTTP-level rejections (non-2xx). A developer reading this section and trying to catch or understand the error flow will be looking in the wrong place.
Suggested fix: Replace the sentence with something like:
…the rejection arrives as an inline per-item failure inside an otherwise-successful HTTP 200 response body. createSubscription surfaces it as CloudKitError/subscriptionLikelyDuplicate(_:) (carrying the raw INTERNAL_ERROR code and the marker reason string); modifySubscriptions surfaces it as SubscriptionResult/failure(_:).
2. Uniqueness key narrowed from "query" to "recordType" [CONFIRMED]
File:Sources/MistKit/Documentation.docc/HandlingErrors.md
The section (and the empirical Note below it) says the uniqueness key is (recordType, firesOn). The authoritative doc comment in CloudKitError.swift (line 75) says:
same query + firesOn, regardless of subscriptionID
query in CloudKit means the full CKQuery-equivalent: record type plus any filter predicates. Documenting only recordType is misleading — two subscriptions with the same recordType but different filter predicates might not collide, while the current wording implies they would. Both occurrences should use "query" (or "query + firesOn") consistently with the rest of the codebase.
3. subscriptionOperationFailed and subscriptionLikelyDuplicate missing from the CloudKitError cases table [CONFIRMED]
File:Sources/MistKit/Documentation.docc/HandlingErrors.md (around line 80)
The PR adds a standalone subsection for the subscription-duplicate pattern but leaves the main CloudKitError cases table unchanged. That table is the canonical discovery surface for users who don't yet know what error to expect. Both subscriptionOperationFailed and subscriptionLikelyDuplicate should have rows there — otherwise a developer scanning the table during error-handling design won't find them.
Suggested additions:
|``CloudKitError/subscriptionOperationFailed(_:)``| No | A per-subscription failure in a batch `modifySubscriptions`||``CloudKitError/subscriptionLikelyDuplicate(_:)``| No | Inferred duplicate from `createSubscription`; see subsection below |
Minor / non-blocking
  • The ### Per-operation failures Topics group at the bottom is a reasonable addition, but SubscriptionOperationFailure and SubscriptionResult might sit more naturally adjacent to the existing ### Error types group (they are error-surface types, not a third category).
  • failure.reason ?? "" in the code example will log an empty string when reason is nil; failure.reason ?? "<no reason>" or failure.reason.map { "Subscription likely duplicate: \($0)" } ?? "Subscription likely duplicate" would be more informative, though this is style-level.
@codecov
codecovBot
commented
Jun 30, 2026•

edited

Loading

Copy link


Copy Markdown

Codecov Report
✅ All modified and coverable lines are covered by tests.

✅ Project coverage is 11.52%. Comparing base (9894d48) to head (843fd18).
⚠️ Report is 4 commits behind head on v1.0.0-beta.3.
❗ There is a different number of reports uploaded between BASE (9894d48) and HEAD (843fd18). Click for more details.
HEAD has 9 uploads less than BASE
FlagBASE (9894d48)HEAD (843fd18)
spm30
swift-6.3-noble10
swift-6.1-noble10
swift-6.2-noble10
swift-6.2-jammy10
swift-6.1-jammy10
swift-6.3-jammy10
Additional details and impacted files
@@ Coverage Diff @@## v1.0.0-beta.3 #416 +/- ##
==================================================
- Coverage 71.82% 11.52% -60.31% 
==================================================
Files 168 168 Lines 3844 3844 ==================================================
- Hits 2761 443 -2318 - Misses 1083 3401 +2318 
FlagCoverage Δ
mistdemo-spm-macos11.42% <ø> (ø)
mistdemo-swift-6.2-jammy11.42% <ø> (ø)
mistdemo-swift-6.2-noble11.42% <ø> (ø)
mistdemo-swift-6.3-jammy11.42% <ø> (ø)
mistdemo-swift-6.3-noble11.52% <ø> (+0.10%)⬆️
spm?
swift-6.1-jammy?
swift-6.1-noble?
swift-6.2-jammy?
swift-6.2-noble?
swift-6.3-jammy?
swift-6.3-noble?
Flags with carried forward coverage won't be shown. Click here to find out more.
☔ View full report in Codecov by Harness.

📢 Have feedback on the report? Share it here.
 🚀 New features to boost your workflow: 
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
@leogdion
leogdion
marked this pull request as ready for review
July 1, 2026 00:34
@leogdion
leogdion
merged commit 97dd4a2
into
v1.0.0-beta.3Jul 1, 2026

34 of 36 checks passed

@leogdion
leogdion
deleted the

docs/subscription-uniqueness-findings

branch
July 1, 2026 00:34
@claudeclaudeBot
mentioned this pull request
Aug 20, 2026
 Merged

@leogdionleogdion
mentioned this pull request
Aug 20, 2026

Closed

Sign up for freeto join this conversation on GitHub.
Already have an account?
Sign in to comment

Reviewers


No reviews


Assignees


No one assigned


Labels


None yet


Projects


None yet


Milestone


No milestone


Development

Successfully merging this pull request may close these issues.

1 participant

@leogdion

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Auto-enable theater mode on YouTube
(function() {
function tryTheater() {
var btn = document.querySelector('button[aria-label="Theater mode"], ytd-player #player button[title="Theater mode"]');
if (btn && !btn.classList.contains('activated')) {
btn.click();
}
}
// Try immediately
tryTheater();
// Try after navigation (SPA)
var lastUrl = location.href;
setInterval(function() {
if (location.href !== lastUrl) {
lastUrl = location.href;
setTimeout(tryTheater, 500);
}
}, 1000);
// Also try on player load
var observer = new MutationObserver(tryTheater);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
Docs: record content-based CloudKit subscription uniqueness finding (#387) by leogdion · Pull Request #416 · brightdigit/MistKit · GitHub
Skip to content
Docs: record content-based CloudKit subscription uniqueness finding (#387) - #416
Merged
leogdion merged 1 commit into
v1.0.0-beta.3from 
docs/subscription-uniqueness-findings
Jul 1, 2026
Merged
Docs: record content-based CloudKit subscription uniqueness finding (#387)#416
leogdion merged 1 commit into
v1.0.0-beta.3from 
docs/subscription-uniqueness-findings
Conversation
@leogdion
@leogdionleogdion
commented
Jun 30, 2026

Copy link


Copy Markdown

Member
Documentation-only. Captures the empirical finding that CloudKit enforces subscription uniqueness on (recordType, firesOn), not subscriptionID; duplicates surface as a misleading INTERNAL_ERROR ("could not find subscription we just created") with no formal CONFLICT/EXISTS code.
Added a subsection to the HandlingErrors.md docc article documenting the behavior and how MistKit infers it via the hedged isLikelyDuplicate hint / subscriptionLikelyDuplicate error (the API itself already landed); batch modifySubscriptions still returns raw failures via SubscriptionResult.failure.
Closes#387.
@leogdion@claude
docs: record content-based CloudKit subscription uniqueness finding (#…
843fd18
…387)
Empirical probing shows CloudKit enforces subscription uniqueness on
(recordType, firesOn), not subscriptionID; duplicates surface as a
misleading INTERNAL_ERROR. Captures how MistKit infers this via the
hedged isLikelyDuplicate hint / subscriptionLikelyDuplicate error.
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@coderabbitai
coderabbitaiBot
commented
Jun 30, 2026•

edited

Loading

Copy link


Copy Markdown

Important
Review skipped
Auto reviews are disabled on base/target branches other than the default branch.
Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro
Run ID: 104c1f45-0d3a-48d5-8434-66edfa16c903
You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.
Use the checkbox below for a quick retry:
  •  🔍 Trigger review
✨ Finishing Touches
🧪 Generate unit tests (beta)
  •  Create PR with unit tests
  •  Commit unit tests in branch docs/subscription-uniqueness-findings
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
Comment @coderabbitai help to get the list of available commands.
@claude
claudeBot
commented
Jun 30, 2026

Copy link


Copy Markdown

Review: Docs — subscription-uniqueness findings (#416)
This PR adds a documentation subsection describing CloudKit's undocumented subscription-uniqueness behavior ((recordType, firesOn) collision → INTERNAL_ERROR) and the subscriptionLikelyDuplicate / isLikelyDuplicate hints MistKit uses to surface it. The prose is clear and the hedged framing matches the code's naming philosophy. Three issues surfaced that a maintainer should act on before merging.
1. Wrong error surface described — httpErrorWithDetails vs. in-body per-item failure [CONFIRMED bug, highest severity]
File:Sources/MistKit/Documentation.docc/HandlingErrors.md
The new section says:
…the rejection arrives as a generic CloudKitError/httpErrorWithDetails(statusCode:serverErrorCode:reason:) carrying serverErrorCodeINTERNAL_ERROR…
This is factually incorrect. CloudKit returns a 200 OK for subscriptions/modify, with per-item failures embedded in the response body (SubscriptionsModifyResponse.subscriptions). CloudKitResponseProcessor.processModifySubscriptionsResponse processes the .ok branch — the .badRequest/.unauthorized/.undocumented branch (which produces httpErrorWithDetails) is never hit for duplicates.
The actual path is:
  1. modifySubscriptions → 200 OK → SubscriptionResult.failure(OperationFailure{serverErrorCode: .internalError, reason: "could not find…"})
  2. createSubscription checks failure.isLikelyDuplicate → throws CloudKitError.subscriptionLikelyDuplicate
httpErrorWithDetails is reserved for HTTP-level rejections (non-2xx). A developer reading this section and trying to catch or understand the error flow will be looking in the wrong place.
Suggested fix: Replace the sentence with something like:
…the rejection arrives as an inline per-item failure inside an otherwise-successful HTTP 200 response body. createSubscription surfaces it as CloudKitError/subscriptionLikelyDuplicate(_:) (carrying the raw INTERNAL_ERROR code and the marker reason string); modifySubscriptions surfaces it as SubscriptionResult/failure(_:).
2. Uniqueness key narrowed from "query" to "recordType" [CONFIRMED]
File:Sources/MistKit/Documentation.docc/HandlingErrors.md
The section (and the empirical Note below it) says the uniqueness key is (recordType, firesOn). The authoritative doc comment in CloudKitError.swift (line 75) says:
same query + firesOn, regardless of subscriptionID
query in CloudKit means the full CKQuery-equivalent: record type plus any filter predicates. Documenting only recordType is misleading — two subscriptions with the same recordType but different filter predicates might not collide, while the current wording implies they would. Both occurrences should use "query" (or "query + firesOn") consistently with the rest of the codebase.
3. subscriptionOperationFailed and subscriptionLikelyDuplicate missing from the CloudKitError cases table [CONFIRMED]
File:Sources/MistKit/Documentation.docc/HandlingErrors.md (around line 80)
The PR adds a standalone subsection for the subscription-duplicate pattern but leaves the main CloudKitError cases table unchanged. That table is the canonical discovery surface for users who don't yet know what error to expect. Both subscriptionOperationFailed and subscriptionLikelyDuplicate should have rows there — otherwise a developer scanning the table during error-handling design won't find them.
Suggested additions:
|``CloudKitError/subscriptionOperationFailed(_:)``| No | A per-subscription failure in a batch `modifySubscriptions`||``CloudKitError/subscriptionLikelyDuplicate(_:)``| No | Inferred duplicate from `createSubscription`; see subsection below |
Minor / non-blocking
  • The ### Per-operation failures Topics group at the bottom is a reasonable addition, but SubscriptionOperationFailure and SubscriptionResult might sit more naturally adjacent to the existing ### Error types group (they are error-surface types, not a third category).
  • failure.reason ?? "" in the code example will log an empty string when reason is nil; failure.reason ?? "<no reason>" or failure.reason.map { "Subscription likely duplicate: \($0)" } ?? "Subscription likely duplicate" would be more informative, though this is style-level.
@codecov
codecovBot
commented
Jun 30, 2026•

edited

Loading

Copy link


Copy Markdown

Codecov Report
✅ All modified and coverable lines are covered by tests.

✅ Project coverage is 11.52%. Comparing base (9894d48) to head (843fd18).
⚠️ Report is 4 commits behind head on v1.0.0-beta.3.
❗ There is a different number of reports uploaded between BASE (9894d48) and HEAD (843fd18). Click for more details.
HEAD has 9 uploads less than BASE
FlagBASE (9894d48)HEAD (843fd18)
spm30
swift-6.3-noble10
swift-6.1-noble10
swift-6.2-noble10
swift-6.2-jammy10
swift-6.1-jammy10
swift-6.3-jammy10
Additional details and impacted files
@@ Coverage Diff @@## v1.0.0-beta.3 #416 +/- ##
==================================================
- Coverage 71.82% 11.52% -60.31% 
==================================================
Files 168 168 Lines 3844 3844 ==================================================
- Hits 2761 443 -2318 - Misses 1083 3401 +2318 
FlagCoverage Δ
mistdemo-spm-macos11.42% <ø> (ø)
mistdemo-swift-6.2-jammy11.42% <ø> (ø)
mistdemo-swift-6.2-noble11.42% <ø> (ø)
mistdemo-swift-6.3-jammy11.42% <ø> (ø)
mistdemo-swift-6.3-noble11.52% <ø> (+0.10%)⬆️
spm?
swift-6.1-jammy?
swift-6.1-noble?
swift-6.2-jammy?
swift-6.2-noble?
swift-6.3-jammy?
swift-6.3-noble?
Flags with carried forward coverage won't be shown. Click here to find out more.
☔ View full report in Codecov by Harness.

📢 Have feedback on the report? Share it here.
 🚀 New features to boost your workflow: 
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
@leogdion
leogdion
marked this pull request as ready for review
July 1, 2026 00:34
@leogdion
leogdion
merged commit 97dd4a2
into
v1.0.0-beta.3Jul 1, 2026

34 of 36 checks passed

@leogdion
leogdion
deleted the

docs/subscription-uniqueness-findings

branch
July 1, 2026 00:34
@claudeclaudeBot
mentioned this pull request
Aug 20, 2026
 Merged

@leogdionleogdion
mentioned this pull request
Aug 20, 2026

Closed

Sign up for freeto join this conversation on GitHub.
Already have an account?
Sign in to comment

Reviewers


No reviews


Assignees


No one assigned


Labels


None yet


Projects


None yet


Milestone


No milestone


Development

Successfully merging this pull request may close these issues.

1 participant

@leogdion

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Remove or un-stick sticky/fixed headers that block content
(function() {
function unstick() {
document.querySelectorAll('header, nav, [role="banner"], .header, .navbar, .sticky, .fixed-top, [style*="position: fixed"], [style*="position:sticky"]').forEach(function(el) {
if (el.style.position === 'fixed' || el.style.position === 'sticky' || getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {
el.style.position = 'static';
el.style.top = 'auto';
el.style.zIndex = 'auto';
}
});
}
unstick();
var observer = new MutationObserver(unstick);
observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });
})();
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
Docs: record content-based CloudKit subscription uniqueness finding (#387) by leogdion · Pull Request #416 · brightdigit/MistKit · GitHub
Skip to content
Docs: record content-based CloudKit subscription uniqueness finding (#387) - #416
Merged
leogdion merged 1 commit into
v1.0.0-beta.3from 
docs/subscription-uniqueness-findings
Jul 1, 2026
Merged
Docs: record content-based CloudKit subscription uniqueness finding (#387)#416
leogdion merged 1 commit into
v1.0.0-beta.3from 
docs/subscription-uniqueness-findings
Conversation
@leogdion
@leogdionleogdion
commented
Jun 30, 2026

Copy link


Copy Markdown

Member
Documentation-only. Captures the empirical finding that CloudKit enforces subscription uniqueness on (recordType, firesOn), not subscriptionID; duplicates surface as a misleading INTERNAL_ERROR ("could not find subscription we just created") with no formal CONFLICT/EXISTS code.
Added a subsection to the HandlingErrors.md docc article documenting the behavior and how MistKit infers it via the hedged isLikelyDuplicate hint / subscriptionLikelyDuplicate error (the API itself already landed); batch modifySubscriptions still returns raw failures via SubscriptionResult.failure.
Closes#387.
@leogdion@claude
docs: record content-based CloudKit subscription uniqueness finding (#…
843fd18
…387)
Empirical probing shows CloudKit enforces subscription uniqueness on
(recordType, firesOn), not subscriptionID; duplicates surface as a
misleading INTERNAL_ERROR. Captures how MistKit infers this via the
hedged isLikelyDuplicate hint / subscriptionLikelyDuplicate error.
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@coderabbitai
coderabbitaiBot
commented
Jun 30, 2026•

edited

Loading

Copy link


Copy Markdown

Important
Review skipped
Auto reviews are disabled on base/target branches other than the default branch.
Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro
Run ID: 104c1f45-0d3a-48d5-8434-66edfa16c903
You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.
Use the checkbox below for a quick retry:
  •  🔍 Trigger review
✨ Finishing Touches
🧪 Generate unit tests (beta)
  •  Create PR with unit tests
  •  Commit unit tests in branch docs/subscription-uniqueness-findings
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
Comment @coderabbitai help to get the list of available commands.
@claude
claudeBot
commented
Jun 30, 2026

Copy link


Copy Markdown

Review: Docs — subscription-uniqueness findings (#416)
This PR adds a documentation subsection describing CloudKit's undocumented subscription-uniqueness behavior ((recordType, firesOn) collision → INTERNAL_ERROR) and the subscriptionLikelyDuplicate / isLikelyDuplicate hints MistKit uses to surface it. The prose is clear and the hedged framing matches the code's naming philosophy. Three issues surfaced that a maintainer should act on before merging.
1. Wrong error surface described — httpErrorWithDetails vs. in-body per-item failure [CONFIRMED bug, highest severity]
File:Sources/MistKit/Documentation.docc/HandlingErrors.md
The new section says:
…the rejection arrives as a generic CloudKitError/httpErrorWithDetails(statusCode:serverErrorCode:reason:) carrying serverErrorCodeINTERNAL_ERROR…
This is factually incorrect. CloudKit returns a 200 OK for subscriptions/modify, with per-item failures embedded in the response body (SubscriptionsModifyResponse.subscriptions). CloudKitResponseProcessor.processModifySubscriptionsResponse processes the .ok branch — the .badRequest/.unauthorized/.undocumented branch (which produces httpErrorWithDetails) is never hit for duplicates.
The actual path is:
  1. modifySubscriptions → 200 OK → SubscriptionResult.failure(OperationFailure{serverErrorCode: .internalError, reason: "could not find…"})
  2. createSubscription checks failure.isLikelyDuplicate → throws CloudKitError.subscriptionLikelyDuplicate
httpErrorWithDetails is reserved for HTTP-level rejections (non-2xx). A developer reading this section and trying to catch or understand the error flow will be looking in the wrong place.
Suggested fix: Replace the sentence with something like:
…the rejection arrives as an inline per-item failure inside an otherwise-successful HTTP 200 response body. createSubscription surfaces it as CloudKitError/subscriptionLikelyDuplicate(_:) (carrying the raw INTERNAL_ERROR code and the marker reason string); modifySubscriptions surfaces it as SubscriptionResult/failure(_:).
2. Uniqueness key narrowed from "query" to "recordType" [CONFIRMED]
File:Sources/MistKit/Documentation.docc/HandlingErrors.md
The section (and the empirical Note below it) says the uniqueness key is (recordType, firesOn). The authoritative doc comment in CloudKitError.swift (line 75) says:
same query + firesOn, regardless of subscriptionID
query in CloudKit means the full CKQuery-equivalent: record type plus any filter predicates. Documenting only recordType is misleading — two subscriptions with the same recordType but different filter predicates might not collide, while the current wording implies they would. Both occurrences should use "query" (or "query + firesOn") consistently with the rest of the codebase.
3. subscriptionOperationFailed and subscriptionLikelyDuplicate missing from the CloudKitError cases table [CONFIRMED]
File:Sources/MistKit/Documentation.docc/HandlingErrors.md (around line 80)
The PR adds a standalone subsection for the subscription-duplicate pattern but leaves the main CloudKitError cases table unchanged. That table is the canonical discovery surface for users who don't yet know what error to expect. Both subscriptionOperationFailed and subscriptionLikelyDuplicate should have rows there — otherwise a developer scanning the table during error-handling design won't find them.
Suggested additions:
|``CloudKitError/subscriptionOperationFailed(_:)``| No | A per-subscription failure in a batch `modifySubscriptions`||``CloudKitError/subscriptionLikelyDuplicate(_:)``| No | Inferred duplicate from `createSubscription`; see subsection below |
Minor / non-blocking
  • The ### Per-operation failures Topics group at the bottom is a reasonable addition, but SubscriptionOperationFailure and SubscriptionResult might sit more naturally adjacent to the existing ### Error types group (they are error-surface types, not a third category).
  • failure.reason ?? "" in the code example will log an empty string when reason is nil; failure.reason ?? "<no reason>" or failure.reason.map { "Subscription likely duplicate: \($0)" } ?? "Subscription likely duplicate" would be more informative, though this is style-level.
@codecov
codecovBot
commented
Jun 30, 2026•

edited

Loading

Copy link


Copy Markdown

Codecov Report
✅ All modified and coverable lines are covered by tests.

✅ Project coverage is 11.52%. Comparing base (9894d48) to head (843fd18).
⚠️ Report is 4 commits behind head on v1.0.0-beta.3.
❗ There is a different number of reports uploaded between BASE (9894d48) and HEAD (843fd18). Click for more details.
HEAD has 9 uploads less than BASE
FlagBASE (9894d48)HEAD (843fd18)
spm30
swift-6.3-noble10
swift-6.1-noble10
swift-6.2-noble10
swift-6.2-jammy10
swift-6.1-jammy10
swift-6.3-jammy10
Additional details and impacted files
@@ Coverage Diff @@## v1.0.0-beta.3 #416 +/- ##
==================================================
- Coverage 71.82% 11.52% -60.31% 
==================================================
Files 168 168 Lines 3844 3844 ==================================================
- Hits 2761 443 -2318 - Misses 1083 3401 +2318 
FlagCoverage Δ
mistdemo-spm-macos11.42% <ø> (ø)
mistdemo-swift-6.2-jammy11.42% <ø> (ø)
mistdemo-swift-6.2-noble11.42% <ø> (ø)
mistdemo-swift-6.3-jammy11.42% <ø> (ø)
mistdemo-swift-6.3-noble11.52% <ø> (+0.10%)⬆️
spm?
swift-6.1-jammy?
swift-6.1-noble?
swift-6.2-jammy?
swift-6.2-noble?
swift-6.3-jammy?
swift-6.3-noble?
Flags with carried forward coverage won't be shown. Click here to find out more.
☔ View full report in Codecov by Harness.

📢 Have feedback on the report? Share it here.
 🚀 New features to boost your workflow: 
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
@leogdion
leogdion
marked this pull request as ready for review
July 1, 2026 00:34
@leogdion
leogdion
merged commit 97dd4a2
into
v1.0.0-beta.3Jul 1, 2026

34 of 36 checks passed

@leogdion
leogdion
deleted the

docs/subscription-uniqueness-findings

branch
July 1, 2026 00:34
@claudeclaudeBot
mentioned this pull request
Aug 20, 2026
 Merged

@leogdionleogdion
mentioned this pull request
Aug 20, 2026

Closed

Sign up for freeto join this conversation on GitHub.
Already have an account?
Sign in to comment

Reviewers


No reviews


Assignees


No one assigned


Labels


None yet


Projects


None yet


Milestone


No milestone


Development

Successfully merging this pull request may close these issues.

1 participant

@leogdion

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Universal Dark Mode - works on any site
(function() {
var enabled = true;
function applyDarkMode() {
if (!enabled) return;
// Create style element if it doesn't exist
var style = document.getElementById('universal-dark-mode-style');
if (!style) {
style = document.createElement('style');
style.id = 'universal-dark-mode-style';
document.head.appendChild(style);
}
// Dark mode CSS - inverts colors but preserves images/video
style.textContent = '
/* Invert everything except media */
html {
filter: invert(1) hue-rotate(180deg) !important;
background: #1a1a2e !important;
}
/* Restore images, videos, iframes, canvas */
img, video, iframe, canvas, svg, picture, [style*="background-image"] {
filter: invert(1) hue-rotate(180deg) !important;
}
/* Preserve specific elements that should not be inverted */
.no-dark-mode, .no-dark-mode *,
[data-theme="light"], [data-theme="light"],
.ace_editor, .ace_editor *,
.CodeMirror, .CodeMirror *,
.monaco-editor, .monaco-editor *,
.markdown-body pre, .markdown-body pre *,
.highlight, .highlight *,
pre code, pre code * {
filter: none !important;
}
/* Fix common UI elements */
.modal, .popup, .dropdown-menu, .tooltip, .popover {
filter: invert(1) hue-rotate(180deg) !important;
background: #2d2d44 !important;
border-color: #444 !important;
}
/* Scrollbars */
::-webkit-scrollbar { background: #1a1a2e !important; }
::-webkit-scrollbar-thumb { background: #444 !important; }
::-webkit-scrollbar-thumb:hover { background: #555 !important; }
/* Selection */
::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }
::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }
';
}
function removeDarkMode() {
var style = document.getElementById('universal-dark-mode-style');
if (style) style.remove();
}
// Toggle with Alt+Shift+D
document.addEventListener('keydown', function(e) {
if (e.altKey && e.shiftKey && e.key === 'D') {
e.preventDefault();
enabled = !enabled;
if (enabled) {
applyDarkMode();
console.log('[Universal Dark Mode] Enabled');
} else {
removeDarkMode();
console.log('[Universal Dark Mode] Disabled');
}
}
});
// Apply on load
applyDarkMode();
// Re-apply on dynamic content
var observer = new MutationObserver(function(mutations) {
if (enabled && !document.getElementById('universal-dark-mode-style')) {
applyDarkMode();
}
});
observer.observe(document.head, { childList: true });
console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');
})();
}
} catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); }
})();
})();
Docs: record content-based CloudKit subscription uniqueness finding (#387) by leogdion · Pull Request #416 · brightdigit/MistKit · GitHub
Skip to content
Docs: record content-based CloudKit subscription uniqueness finding (#387) - #416
Merged
leogdion merged 1 commit into
v1.0.0-beta.3from 
docs/subscription-uniqueness-findings
Jul 1, 2026
Merged
Docs: record content-based CloudKit subscription uniqueness finding (#387)#416
leogdion merged 1 commit into
v1.0.0-beta.3from 
docs/subscription-uniqueness-findings
Conversation
@leogdion
@leogdionleogdion
commented
Jun 30, 2026

Copy link


Copy Markdown

Member
Documentation-only. Captures the empirical finding that CloudKit enforces subscription uniqueness on (recordType, firesOn), not subscriptionID; duplicates surface as a misleading INTERNAL_ERROR ("could not find subscription we just created") with no formal CONFLICT/EXISTS code.
Added a subsection to the HandlingErrors.md docc article documenting the behavior and how MistKit infers it via the hedged isLikelyDuplicate hint / subscriptionLikelyDuplicate error (the API itself already landed); batch modifySubscriptions still returns raw failures via SubscriptionResult.failure.
Closes#387.
@leogdion@claude
docs: record content-based CloudKit subscription uniqueness finding (#…
843fd18
…387)
Empirical probing shows CloudKit enforces subscription uniqueness on
(recordType, firesOn), not subscriptionID; duplicates surface as a
misleading INTERNAL_ERROR. Captures how MistKit infers this via the
hedged isLikelyDuplicate hint / subscriptionLikelyDuplicate error.
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@coderabbitai
coderabbitaiBot
commented
Jun 30, 2026•

edited

Loading

Copy link


Copy Markdown

Important
Review skipped
Auto reviews are disabled on base/target branches other than the default branch.
Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro
Run ID: 104c1f45-0d3a-48d5-8434-66edfa16c903
You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.
Use the checkbox below for a quick retry:
  •  🔍 Trigger review
✨ Finishing Touches
🧪 Generate unit tests (beta)
  •  Create PR with unit tests
  •  Commit unit tests in branch docs/subscription-uniqueness-findings
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
Comment @coderabbitai help to get the list of available commands.
@claude
claudeBot
commented
Jun 30, 2026

Copy link


Copy Markdown

Review: Docs — subscription-uniqueness findings (#416)
This PR adds a documentation subsection describing CloudKit's undocumented subscription-uniqueness behavior ((recordType, firesOn) collision → INTERNAL_ERROR) and the subscriptionLikelyDuplicate / isLikelyDuplicate hints MistKit uses to surface it. The prose is clear and the hedged framing matches the code's naming philosophy. Three issues surfaced that a maintainer should act on before merging.
1. Wrong error surface described — httpErrorWithDetails vs. in-body per-item failure [CONFIRMED bug, highest severity]
File:Sources/MistKit/Documentation.docc/HandlingErrors.md
The new section says:
…the rejection arrives as a generic CloudKitError/httpErrorWithDetails(statusCode:serverErrorCode:reason:) carrying serverErrorCodeINTERNAL_ERROR…
This is factually incorrect. CloudKit returns a 200 OK for subscriptions/modify, with per-item failures embedded in the response body (SubscriptionsModifyResponse.subscriptions). CloudKitResponseProcessor.processModifySubscriptionsResponse processes the .ok branch — the .badRequest/.unauthorized/.undocumented branch (which produces httpErrorWithDetails) is never hit for duplicates.
The actual path is:
  1. modifySubscriptions → 200 OK → SubscriptionResult.failure(OperationFailure{serverErrorCode: .internalError, reason: "could not find…"})
  2. createSubscription checks failure.isLikelyDuplicate → throws CloudKitError.subscriptionLikelyDuplicate
httpErrorWithDetails is reserved for HTTP-level rejections (non-2xx). A developer reading this section and trying to catch or understand the error flow will be looking in the wrong place.
Suggested fix: Replace the sentence with something like:
…the rejection arrives as an inline per-item failure inside an otherwise-successful HTTP 200 response body. createSubscription surfaces it as CloudKitError/subscriptionLikelyDuplicate(_:) (carrying the raw INTERNAL_ERROR code and the marker reason string); modifySubscriptions surfaces it as SubscriptionResult/failure(_:).
2. Uniqueness key narrowed from "query" to "recordType" [CONFIRMED]
File:Sources/MistKit/Documentation.docc/HandlingErrors.md
The section (and the empirical Note below it) says the uniqueness key is (recordType, firesOn). The authoritative doc comment in CloudKitError.swift (line 75) says:
same query + firesOn, regardless of subscriptionID
query in CloudKit means the full CKQuery-equivalent: record type plus any filter predicates. Documenting only recordType is misleading — two subscriptions with the same recordType but different filter predicates might not collide, while the current wording implies they would. Both occurrences should use "query" (or "query + firesOn") consistently with the rest of the codebase.
3. subscriptionOperationFailed and subscriptionLikelyDuplicate missing from the CloudKitError cases table [CONFIRMED]
File:Sources/MistKit/Documentation.docc/HandlingErrors.md (around line 80)
The PR adds a standalone subsection for the subscription-duplicate pattern but leaves the main CloudKitError cases table unchanged. That table is the canonical discovery surface for users who don't yet know what error to expect. Both subscriptionOperationFailed and subscriptionLikelyDuplicate should have rows there — otherwise a developer scanning the table during error-handling design won't find them.
Suggested additions:
|``CloudKitError/subscriptionOperationFailed(_:)``| No | A per-subscription failure in a batch `modifySubscriptions`||``CloudKitError/subscriptionLikelyDuplicate(_:)``| No | Inferred duplicate from `createSubscription`; see subsection below |
Minor / non-blocking
  • The ### Per-operation failures Topics group at the bottom is a reasonable addition, but SubscriptionOperationFailure and SubscriptionResult might sit more naturally adjacent to the existing ### Error types group (they are error-surface types, not a third category).
  • failure.reason ?? "" in the code example will log an empty string when reason is nil; failure.reason ?? "<no reason>" or failure.reason.map { "Subscription likely duplicate: \($0)" } ?? "Subscription likely duplicate" would be more informative, though this is style-level.
@codecov
codecovBot
commented
Jun 30, 2026•

edited

Loading

Copy link


Copy Markdown

Codecov Report
✅ All modified and coverable lines are covered by tests.

✅ Project coverage is 11.52%. Comparing base (9894d48) to head (843fd18).
⚠️ Report is 4 commits behind head on v1.0.0-beta.3.
❗ There is a different number of reports uploaded between BASE (9894d48) and HEAD (843fd18). Click for more details.
HEAD has 9 uploads less than BASE
FlagBASE (9894d48)HEAD (843fd18)
spm30
swift-6.3-noble10
swift-6.1-noble10
swift-6.2-noble10
swift-6.2-jammy10
swift-6.1-jammy10
swift-6.3-jammy10
Additional details and impacted files
@@ Coverage Diff @@## v1.0.0-beta.3 #416 +/- ##
==================================================
- Coverage 71.82% 11.52% -60.31% 
==================================================
Files 168 168 Lines 3844 3844 ==================================================
- Hits 2761 443 -2318 - Misses 1083 3401 +2318 
FlagCoverage Δ
mistdemo-spm-macos11.42% <ø> (ø)
mistdemo-swift-6.2-jammy11.42% <ø> (ø)
mistdemo-swift-6.2-noble11.42% <ø> (ø)
mistdemo-swift-6.3-jammy11.42% <ø> (ø)
mistdemo-swift-6.3-noble11.52% <ø> (+0.10%)⬆️
spm?
swift-6.1-jammy?
swift-6.1-noble?
swift-6.2-jammy?
swift-6.2-noble?
swift-6.3-jammy?
swift-6.3-noble?
Flags with carried forward coverage won't be shown. Click here to find out more.
☔ View full report in Codecov by Harness.

📢 Have feedback on the report? Share it here.
 🚀 New features to boost your workflow: 
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
@leogdion
leogdion
marked this pull request as ready for review
July 1, 2026 00:34
@leogdion
leogdion
merged commit 97dd4a2
into
v1.0.0-beta.3Jul 1, 2026

34 of 36 checks passed

@leogdion
leogdion
deleted the

docs/subscription-uniqueness-findings

branch
July 1, 2026 00:34
@claudeclaudeBot
mentioned this pull request
Aug 20, 2026
 Merged

@leogdionleogdion
mentioned this pull request
Aug 20, 2026

Closed

Sign up for freeto join this conversation on GitHub.
Already have an account?
Sign in to comment

Reviewers


No reviews


Assignees


No one assigned


Labels


None yet


Projects


None yet


Milestone


No milestone


Development

Successfully merging this pull request may close these issues.

1 participant

@leogdion