Repository navigation
Rename COV subscription methods to idiomatic casing (deprecate old names) - #14
Merged
Merged
Conversation
…mes) The four COV subscription methods used all-caps `COV`, inconsistent with the rest of the API (covEvents, BacnetCovReference, BacnetConfirmedService. subscribeCov, ...), and subscribeCOV/unsubscribeCOV took `propId` while every other method uses `propertyId`. Add subscribeCov / unsubscribeCov (with `propertyId`) / subscribeCovPropertyMultiple / unsubscribeCovPropertyMultiple as the real methods on both BacnetClient and the FakeBacnetClient test double, and keep the old names as @deprecated forwarders so existing code keeps working (removable at 1.0). Move all first-party callers (PropertyMonitor, the example, the interop tool) and tests to the new names, and document allocateProcessId on the subscribe methods so distinct subscribers get distinct process ids. The fake records the new service names. format, analyze --fatal-infos (no deprecated self-use) and the unit suite are clean. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01Q3Woz4Bu11Eqhjsh6q3q5b
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Pre-1.0 API-consistency polish. The four COV subscription methods used all-caps
COV(inconsistent withcovEvents,BacnetCovReference,BacnetConfirmedService.subscribeCov, …) andsubscribeCOV/unsubscribeCOVtookpropIdwhile every other method usespropertyId.subscribeCov,unsubscribeCov(withpropertyId),subscribeCovPropertyMultiple,unsubscribeCovPropertyMultiple— on bothBacnetClientand theFakeBacnetClienttest double.subscribeCOV/… names (and thepropIdparam) remain as@Deprecatedforwarders, so existing code keeps working with a deprecation hint; removable at 1.0.PropertyMonitor, the example, the interop tool) and tests moved to the new names.allocateProcessIdis now documented on the subscribe methods so distinct subscribers get distinct process ids. The fake records the new service names.Deliberately not included (investigated, declined): a positional constructor for
BacnetPropertyReference— it can't be added without a breaking change (a second unnamed constructor is impossible) or redundant API, for low value; andenrollmentFilterencoding in GetEnrollmentSummary — it needs a newBACnetRecipientProcesschoice encoder for a niche service, low value. The pub.dev presentation items (screenshots, LICENSE copyright holder, topic swap) are left to the maintainer.Checklist
dart format,dart analyze --fatal-infosanddart testpass — analyze is clean of deprecated self-use; unit (333) and integration suites greenCHANGELOG.md🤖 Generated with Claude Code
https://claude.ai/code/session_01Q3Woz4Bu11Eqhjsh6q3q5b
Generated by Claude Code