Skip to content

3.0.1

Latest
Latest

Choose a tag to compare

View all tags
@github-actions github-actions released this 07 May 03:46
· 8 commits to refs/heads/master since this release
3.0.1
06338de
This commit was created on GitHub.com and signed with GitHub’s verified signature.
GPG key ID: B5690EEEBB952194
Verified
Learn about vigilant mode.

Changelog

Added

  • New Roslyn base-call analyzer (MessageAwareComponentBaseCallAnalyzer) that flags MessageAwareComponent subclasses whose lifecycle overrides forget to invoke base.Awake(), base.OnEnable(), base.OnDisable(), base.OnDestroy(), or base.RegisterMessageHandlers(). Introduces diagnostics DXMSG006 (missing base call), DXMSG007 (lifecycle method hidden with new), DXMSG008 (opt-out marker), DXMSG009 (method implicitly hides a lifecycle method without override/new), and DXMSG010 (base.{method}() chains into an override that does not reach MessageAwareComponent). DXMSG006's diagnostic message is now per-method: each guarded method emits a sentence describing the runtime consequence (registration token never created, handlers not re-enabled, memory leak, etc.) so users immediately see what breaks. The inspector overlay HelpBox renders the same per-method sentences. Severity is tunable per project via .editorconfig (e.g. dotnet_diagnostic.DXMSG006.severity = error). Ships as a separate WallstopStudios.DxMessaging.Analyzer.dll deployed alongside the existing source-generator DLL by SetupCscRsp so it loads under both Unity 2021's Roslyn 3.8 analyzer host and newer Unity versions. Diagnostic help links now open the current analyzer reference page in the DxMessaging repository.
  • Runtime self-check breadcrumb on MessageAwareComponent: OnEnable now logs a one-time Debug.LogError per instance when the registration token is null, with a link to the DXMSG006 reference. Gated on UNITY_EDITOR || DEBUG, so release builds pay no cost. Catches the case where the analyzer DLL was disabled or did not run, surfacing the silent failure as a loud editor error instead.
  • New public [DxIgnoreMissingBaseCall] attribute (DxMessaging.Core.Attributes) for source-level opt-out of the base-call analyzer. Applied to a class, every guarded lifecycle method on that class is exempt; applied to a single method, only that method is exempt. The analyzer still emits an Info-level DXMSG008 at the suppression site so opt-outs remain auditable, and the inspector overlay's snapshot honours the same scoping (method-level suppresses only the annotated method, type-level opts out the entire type). Not inherited -- derived classes must opt out explicitly.
  • New inspector overlay (MessageAwareComponentInspectorOverlay) for every MessageAwareComponent subclass: missing-base-call warnings reported by the analyzer or harvested from the Unity console are surfaced as a HelpBox in the inspector header without clobbering user-defined [CustomEditor]s (the overlay hooks Editor.finishedDefaultHeaderGUI). The overlay restores the previous session's report immediately on Unity Editor startup (loaded from Library/DxMessaging/baseCallReport.json) instead of waiting for the first post-reload scan to complete; the HelpBox is annotated (cached from previous session -- refreshing...) until the first scan refreshes it. A companion fallback editor (MessageAwareComponentFallbackEditor) hosts the overlay for subclasses with no other custom editor and renders the body via DrawDefaultInspector() so subclasses with no serialized fields no longer leave an empty vertical gap below the inspector header.
  • New DxMessaging project-wide settings asset (DxMessagingSettings, stored at Assets/Editor/DxMessagingSettings.asset) accessible from Unity's Project Settings. Controls diagnostics targets applied to IMessageBus.GlobalDiagnosticsTargets, the editor message buffer size, the domain-reload warning suppression, the base-call analyzer toggle, the project-wide base-call ignore list, and the optional Unity console bridge that feeds the inspector overlay.
  • New docs/reference/analyzers.md reference page documenting every DXMSG### diagnostic the package emits, with severity, source generator/analyzer, trigger conditions, message text, and code samples for each. Added to the Reference section of the documentation site navigation.
  • Added llms.txt plus README onboarding guidance so users can connect AI assistants with accurate DxMessaging package context.
  • Test-suite hardening: parameterized scenario fixture (MessageScenario, MessageScenarios, ScenarioHarness, AllocationAssertions) under Tests/Runtime/TestUtilities/ enabling kind-parameterized tests.
  • Behavioural gap closures: HandlerExceptionTests, ReentrantEmissionTests, NullAndInvalidInputTests, SingleThreadContractTests pinning exception-in-handler, re-entrancy, null-input, and threading contracts.
  • AllocationMatrixTests covering zero-GC dispatch across kinds, interceptors, post-processors, diagnostics, and priority-based dispatch.
  • Expanded coverage now pins source-generator and analyzer behaviour that users rely on: generic / record struct / nested partial / nullable annotation cases for DxMessageIdGenerator; [DxOptionalParameter] permutations and DXMSG005 boundary cases for DxAutoConstructorGenerator; positive opt-out cases for DxIgnoreMissingBaseCallAttribute. No runtime API change.
  • Three new public read-only registration counters on IMessageBus: RegisteredInterceptors, RegisteredPostProcessors, and RegisteredGlobalAcceptAll. Lets diagnostic and leak-check tooling distinguish interceptor / post-processor / global accept-all leaks from regular handler leaks, and lets external monitors aggregate the bus's registration footprint without reflecting on internals. MessageBus aggregates the counters on each read by walking the per-message-type caches; consumers polling these properties in tight loops should snapshot at region boundaries.
  • Runtime memory-reclamation foundations: DxMessagingRuntimeSettings loads from Resources/DxMessagingRuntimeSettings and hot-reloads eviction cadence, enablement, trim opt-out, and pool-cap changes without recreating the bus. Pooled internal collections and typed/bus slot registries preserve existing dispatch APIs while making empty handler and interceptor slots reclaimable. IMessageBus.Trim(force) and MessageHandler.TrimAll(force) reset dirty empty slots and trim shared pools on demand, OccupiedTypeSlots / OccupiedTargetSlots expose the retained bus and dirty typed-handler slot footprint for diagnostics, and idle sweeps run from emits and Unity's PlayerLoop. New user-facing reference and tuning docs ship at docs/reference/runtime-settings.md (per-setting reference table) and docs/guides/memory-reclamation.md (forced trim, idle sweep, and pool tuning narrative).
  • New explicit-factory registration helpers across all three DI integrations: VContainerRegistrationExtensions.RegisterDxMessagingBus, ReflexRegistrationExtensions.AddDxMessagingBus, and ZenjectRegistrationExtensions.BindDxMessagingBus. Each helper exposes the bus under both the concrete MessageBus contract and the IMessageBus interface, accepts an overloadable lifetime where the container supports it, accepts a user-supplied Func<TResolver, MessageBus> factory, and accepts an IDxMessagingClock overload that constructs the bus through the new internal-only MessageBus.CreateForInternalUse factory so test-side clocks (for example FakeClock) can be injected through the container. The VContainer helper registers both contracts in one registration call, avoiding VContainer environments where chained .AsSelf().As<IMessageBus>() drops the concrete contract and fails with No such registration of type: DxMessaging.Core.MessageBus.MessageBus; the DI samples either call the helper directly or document the corresponding helper preference for their container shape.

Changed

  • Mutation tests now exercise every messaging kind (Untargeted/Targeted/Broadcast) via a single parameterized fixture ([ValueSource(MessageScenarios.AllKinds)]) across MutationDuringEmissionTests, MutationInterceptorTests, and MutationDestructionTests. Users get tighter cross-kind parity guarantees; no runtime API change. (~720 lines of duplication removed; test count preserved.)
  • Renamed UntargetedTests, TargetedTests, BroadcastTests to EmitUntargetedSpecificTests, EmitTargetedSpecificTests, EmitBroadcastSpecificTests to clarify that kind-common tests live in EmitTests and kind-specific tests live in the renamed files. (Test-suite hardening is test-only; no Runtime/ behavior was modified.)
  • Documentation now warns up front that MessageAwareComponent subclasses must call base.Awake(), base.OnEnable(), base.OnDisable(), base.OnDestroy(), and base.RegisterMessageHandlers() from any override; admonitions added to the Quick Start, Getting Started Guide, Visual Guide, README, FAQ, and Troubleshooting pages all link to DXMSG006 (issue #195).

Fixed

  • Cross-priority deregistration during in-flight emit no longer drops handlers from the current dispatch.
    • Previously, when a handler at one priority removed a handler at a later priority of the same emission, the later priority's typed-handler stack was rebuilt from the now-mutated registry on first touch and the scheduled-for-removal handler was silently skipped, breaking the documented "frozen handler list per emission" contract.
    • This affected sourced-broadcast, broadcast-without-source, and targeted-without-targeting dispatch (the targeted/untargeted paths already pre-froze every bucket up-front).
    • The bus now pre-freezes every priority bucket's typed-handler caches up-front for every dispatch surface (sourced-broadcast, broadcast-without-source, targeted-without-targeting) and uses the per-emission snapshot count for the dispatch-loop early-out.
    • The sourced-broadcast and broadcast-without-source dispatch loops also no longer short-circuit on the live cache.handlers.Count == 0 when the per-emission snapshot still holds the deregistered handler.
    • Post-processor prefreeze no longer takes a single-bucket/single-entry fast-path that skipped pre-freezing per-MessageHandler post-processor caches; a regular handler that registers a new post-processor on the same MessageHandler+priority during its own callback now sees the new post-processor on the next emission, not the in-flight one.
    • The same fix extends to cross-MessageHandler post-processor dispatch: the inner per-handler RunFastHandlers overload used by TargetedWithoutTargeting/BroadcastWithoutSource post-processors now consults the per-emission snapshot list directly instead of bailing on the live cache.entries count, so a sibling MessageHandler removing a not-yet-dispatched post-processor no longer silently skips the snapshot-pinned invocation.
    • RegisterGlobalAcceptAll (HandleGlobalUntargeted/HandleGlobalTargeted/HandleGlobalBroadcast) is intentionally NOT covered by this fix. The bus's global accept-all dispatch path prefreezes lazily per-entry inside the dispatch loop, so a sibling MessageHandler that removes another's global registration mid-emit causes the removed handler to be skipped on the in-flight emission. The behavior is pinned by MutationPostProcessorAcrossHandlersTests.RemoveOtherGlobalAcceptAllAcrossHandlersDuringDispatch; if a future change introduces upfront global-handler prefreeze, that test must be updated to expect the snapshot semantics that the per-kind paths already provide.
  • DxMessagingStaticState.Reset is now race-safe against deferred deregistrations. Previously, when a message-aware component was destroyed but its disable callback had not yet run (Unity defers Object.Destroy to end of frame) and Reset ran in between, the deferred token teardown would log spurious "Received over-deregistration of {type} for {handler}" errors against the user's Unity console. The bus now stamps each captured deregister closure with a generation counter and silently no-ops closures captured before a Reset. Applied uniformly across every register entry point (untargeted, targeted, broadcast, GlobalAcceptAll, and all three interceptor kinds). The same race-safety guarantee is now propagated to user-installed custom global buses via MessageBus.BumpResetGeneration(), which DxMessagingStaticState.Reset invokes on the active global bus when it differs from the built-in default; the custom bus's sinks are intentionally left intact to avoid clobbering state the user installed it to preserve. User code is unaffected except that previously-spurious error logs disappear.
  • MessageRegistrationToken.RemoveRegistration(handle) no longer leaks the staged registration entry, so a Disable()/Enable() cycle after RemoveRegistration no longer silently re-registers the removed handler. The fix also drops the matching metadata and call-count entries so diagnostic mode does not accumulate stale handles.
  • Resolved issue #204 (build artifacts and orphaned .meta files leaking into the npm tarball) and prevented its regression: scripts/validate-npm-meta.js now runs validateNoBuildArtifactsInTarball (rejects bin/, obj/, *.pdb, *.tmp, *.csproj.user, .vs/, .idea/, *.suo, and *.DotSettings.user paths in the tarball) and validatePublishedFilesArePairedWithMetas (every shipped Unity-relevant file has its .meta neighbour and every shipped directory has its directory .meta), wired into prepack and the validate-npm-meta workflow so the next publish cannot reintroduce the regression.

Pull Requests

Contributors

@Copilot, Dependabot (@dependabot)[bot], Eli Pinkerton (@wallstop), copilot-swe-agent[bot] and dependabot[bot]

Contributors

wallstop and dependabot
Assets 3
Loading