Skip to content

feat: mark deprecated classes and methods for future removal#1417

Merged
ndorin merged 4 commits intomainfrom
maintenance/add-deprecations
May 8, 2026
Merged

feat: mark deprecated classes and methods for future removal#1417
ndorin merged 4 commits intomainfrom
maintenance/add-deprecations

Conversation

@ndorin
Copy link
Copy Markdown
Contributor

@ndorin ndorin commented May 8, 2026

This pull request adds [Obsolete] attributes to several classes, interfaces, methods, and enum members across the codebase. The purpose is to mark these components as deprecated, indicating they are no longer supported and will be removed in a future release. This helps developers avoid using outdated code and prepares the codebase for future clean-up.

Deprecation of core classes and interfaces:

  • Marked DebugContext, WebApiPasscodeClient, and the static class ConfigUpdater as obsolete, signaling that these classes are no longer supported and will be removed in a future release. [1] [2] [3]
  • Marked the interfaces ILogStrings and ILogStringsWithLevel as obsolete. [1] [2]

Deprecation of device and camera-related components:

  • Marked the CameraVisca class as obsolete, instructing users to use the CameraVisca plugin instead.

Deprecation of routing signal types:

  • Marked the UsbOutput, UsbInput, and SecondaryAudio members of the eRoutingSignalType enum as obsolete.

Deprecation of methods:

  • Marked the SetInterfaces method in DeviceStateMessageBase and the LoadLogoServer method as obsolete, providing guidance on alternative approaches. [1] [2]

Copilot AI review requested due to automatic review settings May 8, 2026 19:14
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

This PR marks a set of legacy APIs across Essentials/Core as deprecated by adding [Obsolete] attributes (and a few small formatting/tidy changes), helping steer developers away from unsupported components ahead of future removal.

Changes:

  • Added [Obsolete] attributes to selected classes/interfaces/methods/enum members across multiple projects.
  • Deprecated specific device/routing/logging-related APIs (e.g., CameraVisca, eRoutingSignalType members, ILogStrings*, DebugContext).
  • Minor whitespace/formatting updates in touched files (notably ConfigUpdater and WebApiPasscodeClient).

Reviewed changes

Copilot reviewed 9 out of 9 changed files in this pull request and generated 3 comments.

Show a summary per file
File Description
src/PepperDash.Essentials/ControlSystem.cs Marks LoadLogoServer as obsolete.
src/PepperDash.Essentials.MobileControl.Messengers/Messengers/DeviceStateMessageBase.cs Marks SetInterfaces as obsolete and adds using System;.
src/PepperDash.Essentials.Devices.Common/Cameras/CameraVisca.cs Marks CameraVisca as obsolete in favor of plugin usage.
src/PepperDash.Essentials.Core/Routing/eRoutingSignalType.cs Marks several enum members as obsolete.
src/PepperDash.Essentials.Core/Interfaces/ILogStringsWithLevel.cs Marks ILogStringsWithLevel as obsolete and formats signature spacing.
src/PepperDash.Essentials.Core/Interfaces/ILogStrings.cs Marks ILogStrings as obsolete.
src/PepperDash.Essentials.Core/Config/Essentials/ConfigUpdater.cs Marks ConfigUpdater as obsolete; formatting changes also surfaced a null-check logic bug.
src/PepperDash.Core/WebApi/Presets/WebApiPasscodeClient.cs Marks class as obsolete; formatting changes surfaced unprofessional comment and event-invocation race pattern.
src/PepperDash.Core/Logging/DebugContext.cs Marks DebugContext as obsolete.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread src/PepperDash.Essentials.Core/Config/Essentials/ConfigUpdater.cs Outdated
Comment thread src/PepperDash.Core/WebApi/Presets/WebApiPasscodeClient.cs Outdated
Comment thread src/PepperDash.Core/WebApi/Presets/WebApiPasscodeClient.cs Outdated
ndorin and others added 3 commits May 8, 2026 13:19
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
@ndorin ndorin requested a review from andrew-welker May 8, 2026 19:20
@ndorin ndorin merged commit 17adac6 into main May 8, 2026
2 checks passed
@ndorin ndorin deleted the maintenance/add-deprecations branch May 8, 2026 22:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants