v2.2.0 - Support Link and Image Preview + Fix embed deserialization

Release info

Recently a version 2.1.5 added support for group preview embeds. Unfortunately that version also introduced a severe bug that caused deserialization of any message containing an embed to fail. Version 2.2.0 finally fixes this problem, and version 2.1.5 will be marked as deprecated.

Additionally, support was added for link and image preview embeds. These embeds will automatically be enabled for you, unless you opt out using ChatMessageSendingOptions. Of course, you can also add new or override existing embed implementations using a new deserializer.

This release also contains other minor improvements, such as resolving a couple of warnings, or improving performance by removing a few unnecessary locks.

Changes

• Added: IChatEmbedDeserializer to allow deserialization of chat embeds.
• Added: support for Link and Image preview embeds through LinkPreviewChatEmbed and ImagePreviewChatEmbed respectively.
• Added: ChatMessageSendingOptions provide 2 predefined statics: DisableEmbeds and DisableLinkDetection.
• Change: Chat Messages and retrieved chat histories will now have Embeds property properly populated.
• Change: UrlMetadataMessage now uses headers with version 2.
• Change: ChatMessageSerializer now has a constructor that takes a IChatEmbedDeserializer.
• Change: ChatHistoryResponseSerializer now has a constructor that takes a IChatEmbedDeserializer.
• Change: Removed unnecessary locks in CommandsSystem, MessageSerializerProvider and ResponseSerializerProvider.
• Fix: an error when a message containing an embed is received.
• Fix: warnings logged due to link metadata message not having a serializer registered with the provider.

Obsoletions:

• BuildDefaultServiceProvider method in WolfClient is now obsolete - the constructors that use this method have been obsolete since v2.0.0. Both the constructors and the method will be removed in a future release.
• BuildDefaultServiceProvider method in CommandsSystem is now obsolete - the constructors that use this method have been obsolete since v2.0.0. Both the constructors and the method will be removed in a future release.

Package URL

Main meta-package - NuGet.org
Wolfringo.Hosting - NuGet.org

v2.1.5 - Group link preview support and other minor tweaks

Release info

Caution

This release has been deprecated due to a bug that caused errors during deserialization of any message containing an embed. Please use version 2.2.0 or newer instead.

This release focuses on minor improvements enabled by later .NET framework, as well as enables sending of group previews and gives greater control over how group and website links are handled.

Changes

• Added: ChatMessageSendingOptions class used in CommandContext and Sender utility to configure how message gets pre-processed.
• Added: Support for sending embeds in chat messages - currently GroupPreviewChatEmbed. Note: deserializing embeds is unsupported in this release.
• Added: SlowModeRate property for chat responses.
• Change: ID field in chat message classes is no longer obsolete as WOLF seems to be using them again.
• Change: Improve thread safety when handling IDs in underlying socket client.
• Change: System.Threading.Lock will be used instead of System.Object or other types for locking when running on .NET 9.0 or greater.
• Fix: Structured logs now contain content of binary messages when logging exceptions.

Package URL

Main meta-package - NuGet.org
Wolfringo.Hosting - NuGet.org

v2.1.4 - Fix group member updates

Release info

Over past 3 years, WOLF protocol changed the group member update events to be way more convoluted and completely breaking Wolfringo's caching of group members. This patch prioritizes fixing this, so group member updates such as joins, leaves, privileges (admin & mod), silences and owner changes are getting properly captured and cached again.

Changes

• Added: GroupMemberPrivilegedAddEvent, GroupMemberPrivilegedUpdateEvent and GroupMemberPrivilegedDeleteEvent.
• Added: IGroupMemberPrivilegedEvent interface which is implemented by the above events to streamline handling by cache service.
• Added: Reputation property for WolfGroup.
• Change: Default caching implementation has been updated to handle the events that WOLF servers now send.
• Fix: Stack overflow exception when parsing certain group chat events, such as member leaving.

Obsoletions:

• GroupMemberUpdateEvent is now obsolete - seems WOLF protocol no longer uses this event type, and it'll be removed in a later release of Wolfringo.

Package URL

Main meta-package - NuGet.org
Wolfringo.Hosting - NuGet.org

v2.1.3 - hotfix for link detection & caret return

Release info

A second small hotfix for link detection added in v2.1.1.

Changes

• Fix: http/https link detection will now end link on caret return as well as new line, to avoid issues with some new line formatting.

Package URL

Main meta-package - NuGet.org
Wolfringo.Hosting - NuGet.org

v2.1.2 - hotfix for link detection & new lines

Release info

A small hotfix for link detection added in v2.1.1

Changes

• Fix: http/https link detection will now end link on new line in addition to space.

Package URL

Main meta-package - NuGet.org
Wolfringo.Hosting - NuGet.org

v2.1.1 - http and https links support

Release info

A quick follow up update to v2.1.0 - enabling Sender and CommandContext to detect http/https links.

Changes

• Added: Sender utility and CommandContext extension methods will now automatically detect http/https links and generate metadata required for the link to be clickable.

Obsoletions:

• AvatarUtilities is now obsolete - the old, deterministic way to get avatar links no longer works, and a redesign of the class is required. It's planned for a future release.

Package URL

Main meta-package - NuGet.org
Wolfringo.Hosting - NuGet.org

v2.1.0 - Fixes after 3 years

Release info

An upgrade that focuses on fixing some issues caused by WOLF protocol changes over past 3 years.
See Upgrade Guide for any potential breaking changes.

Changes

• Added: Add GroupMemberRegularListMessage and GroupMemberPrivilegedListMessage.
• Added: support for ChatMessage metadata for links (normal URLs and group links).
• Added: GroupLinkDetectionHelper internal utility class which helps with generating group links from text.
• Added: [HelpOrder] attribute to allow more customization of help message.
• Change: Separated PrefixRequirement from PrefixAttribute to combat the way CLR handles nullables in attribute constructors.
• Fix: prefix checks for empty prefixes.
• Fix: updating group member list for groups with more than 100 members in [RequireGroupPrivilege] CommandContext and Sender Utility extensions.
• Fix: fix Sender Utility method for joining a group by name - group will now be requested separately to get the ID.
• Fix: serialization errors when WOLF server responds with an error response.
• Fix: some logging bugs and issues.
• Fix: some CancellationToken race conditions.

Obsoletions:

• GroupMembersListMessage is now obsolete - using it will fail retrieving more than 100 group members.
• GroupName property and related constructor in GroupJoinMessage is now obsolete, as WOLF protocol changes made it not work.

Package URL

Main meta-package - NuGet.org
Wolfringo.Hosting - NuGet.org

v2.0.1 - Fix old logging bug

Release info

This small update fixes an old bug that caused silenced messages to be logged as error, along with other really small tweaks.

Changes

• Change: CommandsListBuilder now accepts ICommandsService instead of CommandsService in constructor.
• Fix: Logging of silenced sending exception in commands now checks for a proper error code.

Package URL

Main meta-package - NuGet.org
Wolfringo.Hosting - NuGet.org

v2.0.0 - Client and CommandService builder, help command, cache separation, and much more!

Release info

Wolfringo v2.0 brings some significant changes - streamlined client and commands initialization, separation of caching and client logic, addition of help command support, and many more.
See Upgrade Guide for help with migrating and high level breakdown of new features!

As a bonus, official documentation page now has a set of guides on Customizing Wolfringo, which should make it much easier for you to tweak Wolfringo's internals!

Changes

• Added: WolfClientBuilder that makes creation of a WolfClient much easier! See Getting Started to check out the new flow!
• Added: CommandsServiceBuilder that makes creation of a CommandsService much easier! See Commands System to check out the new flow!
• Added: Easy help command support. See Help Command to learn more!
• Added: {{RecipientID}} and {{RecipientName}} placeholders are now supported in command argument error messages.
• Added: [ArgumentText] attribute for command method arguments.
• Added: Support for checking URL metadata.
• Added: Support for requesting group achievements.
• Added: Both standard and regex commands now support a timeout.
• Added: Regex commands now support a Regex engine timeout to prevent potential attacks.
• Added: Extension method for ChatMessage class: GetMessageWithoutPrefix.
• Added: CommandContextOptions class which can now be injected into command method.
• Added: CommandRequirementsResult class for use by command requirements.
• Added: IWolfTokenProvider interface, along with ConstantWolfTokenProvider, RandomizedWolfTokenProvider and HostedWolfTokenProvider classes, which are used by WolfClient. This increases flexibility of resolving token. They replace WolfTokenProvider.
• Added: A new IWolfClientCache interface which allows for cache customization via Dependency Injection.
• Added: A new WolfClientCache class with default caching implementation. This replaces old WolfEntityCacheContainer, which is now removed.
• Added: A new WolfCacheOptions class for configuring built-in caching.
• Change: Caching related properties have been removed from WolfClient.
• Change: IWolfEntityCache<TEntity> has been renamed to IWolfCachedEntityCollection<TEntity>.
• Change: WolfEntityCacheExtensions has been renamed to WolfCachedEntityCollectionExtensions.
• Change: Caching related types (including IWolfClientCacheAccessor) were moved from TehGM.Wolfringo.Utilities to new TehGM.Wolfringo.Caching namespace.
• Change: DefaultServerURL, BetaServerURL and DefaultDevice constants have been moved from WolfClient to a new WolfClientOptions class.
• Change: ServerURL, Device and IgnoreOwnChatMessages properties of WolfClient have been moved to a new WolfClientOptions class.
• Change: It is now possible to provide a custom ISocketClient to WolfClient.
• Change: WolfClient's OnMessageSentInternalAsync and OnMessageReceivedInternalAsync were renamed to OnMessageSentAsync and OnMessageReceivedAsync respectively. Since caching logic has been moved to IWolfClientCache, they also are now empty, so overriding them is completely safe.
• Change: UserAchievementListResponse has been replaced by EntityAchievementListResponse, which supports both user and group achievements.
• Change: Sender utility now returns achievements with nullable timestamps. This is due to how WOLF server handles them.
• Change: Command requirements' CheckAsync method now returns ICommandResult instead of a boolean. Supporting AbortOnFail and SendMessageWhenSkipping properties and ResultFromBoolean method were added to CommandRequirementAttribute class.
• Change: StandardCommandInstance and RegexCommandInstance now inherit from a shared CommandInstanceBase class.
• Change: CommandsOptions now implement a new ICommandOptions interface.
• Change: Some WolfClient constructors were removed or marked as obsolete. Favour using WolfClientBuilder.
• Change: Some CommandsService constructors were removed or marked as obsolete. Favour using CommandsServiceBuilder.
• Change: Types implementing ICommandResult are now classes instead of structs.
• Change: IsSuccess property of ICommandResult is now obsolete. Favour using Status property.
• Change: Exception property has been removed from most of classes implementing ICommandResult.
• Change: ErrorMessage property of ICommandRequirement has been removed. It is still present in CommandRequirementAttribute, so existing error messages should still work just fine.
• Change: ICommandsService now has Commands property, containing all instance descriptors currently active within the service.
• Change: SimpleServiceProvider and CombinedServiceProvider classes were removed, as they're no longer needed internally.
• Change: CommandInstanceDescriptorExtensions class has been moved from TehGM.Wolfringo.Commands.Initialization to TehGM.Wolfringo.Commands namespace.
• Change: Command instance descriptor extension methods now use new internal attribute cache class DescriptorAttributeCache. This cache uses lazy reflection for performance.
• Change: Priority property of CommandInstanceDescriptor has been removed. Favour using extension methods.
• Change: JSON Converters have been modified to support JsonPath.
• Change: "command" argument has been renamed to "eventName" in signatures of built-in message and response serializers.
• Change: Constructor of HostedWolfClient has been simplified.
• Change: IHostedWolfClientServiceBuilder now has a new ConfigureCaching method.
• Fix: Requesting specific achievements has been optimized, which should result in a slightly reduced network usage.
• Fix: Dependency Injection mechanisms for Commands now correctly differentiate between argument with default value and optional argument.
• Fix: Some Sender methods were not configuring await properly. This is now fixed.

Package URL

Main meta-package - NuGet.org
Wolfringo.Hosting - NuGet.org

v1.1.2 - Fix to crashes when user icon is null

Release info

This update fixes a rare crash when user's icon is null for some reason.

Changes

• Change: IconID with AvatarUtility is now optional.
• Fix: Made WolfUser's and WolfGroup's Icon fields nullable.

Package URL

Main meta-package - NuGet.org
Wolfringo.Hosting - NuGet.org