Skip to content

CHANGELOG.md

Latest commit

 

History

History
559 lines (360 loc) · 18.8 KB

CHANGELOG.md

File metadata and controls

559 lines (360 loc) · 18.8 KB
Raw

Changelog

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

Legend: 🔒️ security fixes; ⚡️ major features/updates; ❗️ breaking changes; 👉 important notes.

UNRELEASED - YYYY-MM-DD

Security

No security updates are included in this release.

Added

  • OslcQuery.SubmitPost() now submits form-encoded OSLC queries over HTTP POST.
  • RootServicesHelper now resolves OSLC Root Services documents from direct /rootservices or /rootservices.xml URIs, the standard /.well-known/oslc/rootservices.xml location, and the legacy relative /rootservices fallback.
  • ⚡️ The IBM Jazz ERM (also known as Doors NG), ETM, and EWM samples now target .NET 10 and have been tested against Jazz.net. Run them with OSLC4Net_SDK\Examples\scripts\test-jazz_net.ps1.
  • Added an opt-in SharpFuzz harness for the OSLC query parsers under OSLC4Net_SDK/Tests/OSLC4Net.Fuzzing, with a 90-second CI smoke run and weekly or manually triggered extended campaigns.

Changed

  • OSLC4Net.Core now requires .NET 10 to use the [Experimental] annotation.
  • OSLC4Net.Client now requires .NET 10.
  • ❗️ SignedByteNode now maps xsd:byte to C# sbyte (signed byte) instead of byte.
  • 👉 Core Property no longer implements IComparable<T> because it is mutable. Use PropertyNameComparer to sort properties by name.
    • Code that creates Property collections must prevent duplicates, including collections in AutomationPlan.
  • ❗️ Generated OSLC domain models now declare each RDF property once, based on OslcPropertyDefinition, instead of redeclaring inherited properties on derived classes. Update binary consumers and reflection code that depend on a derived declaration; source code can continue to access the property through the derived type.
    • ChangeNotice.AffectedByDefect now comes from ChangeRequest.
    • ChangeSetSelections.Selects now comes from Selections.
    • KerML.AssociationStructure now inherits the relevant properties from Association.
  • ❗️ Generated CLR property names are now namespace-qualified when distinct RDF predicates have the same local name:
    • KerML:
      • Element.Source is now Element.SourceDcterms.
      • Association.Source2, Connector.Source2, and Relationship.Source2 are now SourceKerml.
    • SysMLV2:
      • Element.Source is now Element.SourceDcterms.
      • Association.Source2, Connector.Source2, Relationship.Source2, FlowDefinition.Source, FlowUsage.Source, and TransitionUsage.Source2 are now SourceSysml.
    • SPDX:
      • Core.Artifact.IntendedUse is now IntendedUseCore.
      • Dataset.DatasetPackage.IntendedUse is now IntendedUseDataset.

Deprecated

  • The RDF type getters and setters, GetRdfTypes() and GetTypes(), are deprecated; use the .Types property instead.

Removed

No features are removed in this release.

Fixed

  • Meziantou.Analyzer now uses PrivateAssets="all", so it is not exposed as a transitive dependency of built NuGet packages.
  • Query results now recognize membership predicates declared through ldp:hasMemberRelation or supplied explicitly to OslcQuery, and they support ldp:contains query containers.
  • Query result total counts are now parsed from RDF literal nodes.
  • OSLC shapes now reflect properties backed by URI collections correctly (thanks to @ZUOXIANGE).
  • When RDF graph parsing produces malformed URI nodes in a query response, OslcQueryResult.GetMembersUrls(), GetMembers<T>(), GetNextPageUrl(), and GetTotalCount() now return empty results or null instead of throwing ArgumentNullException.
  • Property.cs now uses InvalidOperationException instead of SystemException, resolving compiler warning CA2201.
  • OslcRdfOutputFormatter now serializes server-side OSLC query responses without paging by keeping a missing ResponseInfo next page as null instead of passing an empty string to new Uri("").
  • DotNetRdfHelper.CreateDotNetRdfGraph now serializes an empty ResponseInfo container for queries that match no members, even when the oslc namespace prefix is not already registered.
  • OslcRdfOutputFormatter now builds the ResponseInfo container subject URI with UriHelper.BuildAbsolute, so requests using a non-default port no longer produce an invalid host:port:port authority or throw UriFormatException.
  • EnumerableWrapper now disposes wrapped enumerators through IDisposable instead of reflecting a public Dispose method. Serializing a ResponseInfo container whose members are wrapped no longer throws NullReferenceException for enumerators that implement IDisposable explicitly.
  • OSLC query parsing now reports malformed property trees, unknown or duplicate prefixes, duplicate selected properties, and malformed search terms as parse failures instead of leaking implementation exceptions.
  • The AFL++ helper now opts out of external core-pattern crash notification checks in CI and local test runs.

0.6.3 - 2025-11-15

Security

This release does not contain security updates.

Added

This release does not contain new features.

Changed

  • StringValue interface is now publicly accessible and inherits from the Value interface (#422)

Deprecated

  • 👉 Support for .NET 8 and 9 is deprecated. Going forward, only .NET 10 will be supported.

Removed

This release does not remove any features.

Fixed

This release does not contain bug fixes.

0.6.2 - 2025-08-13

Security

This release does not contain security updates.

Added

This release does not contain new features.

Changed

  • RDF/XML output is now produced using PrettyRdfXmlWriter instead of RdfXmlWriter. Pretty-printing is still configurable with OslcOutputFormatConfig.

Deprecated

This release does not introduce deprecations.

Removed

This release does not remove any features.

Fixed

This release does not contain bug fixes.

0.6.1 - 2025-08-13

Security

This release does not contain security updates.

Added

  • The QName class now has properties NamespaceUri, LocalPart, and Prefix.
  • ⚡️ OslcOutputFormatConfig configure RDF output formatting (pretty-printing, DTD, JSON-LD mode)

Changed

This release does not contain other significant changes.

Deprecated

  • 👉 QName getters GetNamespaceURI, GetLocalPart, and GetPrefix are deprecated in favor of C# properties and are scheduled for removal in the next release.

Removed

This release does not remove any features.

Fixed

This release does not contain bug fixes.

0.6.0 - 2025-07-06

Security

This release does not contain security updates.

Added

  • ⚡️ TextOutputFormatter/TextInputFormatter implementations for OSLC RDF, enabling the use of OSLC4Net in ASP.NET Core API servers
    • 👉 see sample server under OSLC4Net_SDK/Examples/OSLC4NetExamples.Server.NetCoreApi
  • ⚡️ JSON-LD 1.1 support
  • Initial support for RDFS inference during deserialization was added.
  • 👉 Docs are now published to https://oslc4net.github.io/

Changed

  • ❗️ Major changes to exceptions from Core and Client packages.
    • Getters were replaced with read-only properties
    • I18n resource strings were removed along with the corresponding constructors.
    • Error codes OSLC001..OSLC014 from Core were renamed to OSLC1001..OSLC1014, while codes OSLCC001..OSLCC004 from Client were renamed into OSLC2001..OSLC2014. All OSLC4Net error codes now have 4 digits for consistency.
  • ❗️ DotNetRdfHelper is no longer static

Deprecated

  • 👉 OSLC4Net.Client.Oslc.Resources.ChangeRequest.GetRdfTypes and all similar methods. Use OSLC4Net.Core.Model.IExtendedResource.GetTypes instead or, better yet, OSLC4Net.Core.Model.AbstractResourceRecord.Types.

Removed

  • ❗️ Legacy OSLC JSON support was removed to reduce maintenance overhead now that the JSON-LD support is added.
  • I18n resource strings were removed along with the corresponding constructors on exceptions. Also, MessageExtractor helpers were removed.
  • log4net dependency - all logging is now done via standard ILogger abstraction.
  • ServiceProviderRegistryURIs - oslc4net will no longer try to guess/compute the SP catalog URI.

Fixed

  • OSLC4Net.Core.Model.IExtendedResource.GetTypes is now annotated properly and should be populated correctly on deserialization.

0.5.0 - 2025-04-13

Security

This release does not contain security updates.

Added

  • ⚡️ CI integration tests against OSLC RefImpl CM/RM based on NET Aspire
  • ⚡️ Ability to define OSLC resource POCOs using C# properties instead of Java-style getters/setters.
  • ⚡️ Support for the OSLC Requirements Management 2.1 domain with property-based code.
  • Added full vocabulary definitions for FOAF, DC Terms, DC Elements, LDP, PROV-O, QUDT, SKOS.
  • Redirect loop protection for OslcClient (max 20 redirects as in Firefox/Blink/WebKit)
  • Follow redirects on more responses statuses (was: 301, became: 301, 302, 307, 308, and in case of GET requests, 303 too)
  • ❗️ OslcResponse can now expose multiple response resources, the Graph and, in case of error, the oslc:Error resource.

Changed

  • dotNetRDF dependency was updated to v3.3.1
  • ❗️ OslcClient was updated to support async operations consistently

Deprecated

  • Most non-async methods in client classes.
  • Further OSLC JSON deprecations. Clients should rely on RDF instead (RDF/XML, Turtle)
  • Old OSLC Requirements Management classes that were hand-rolled and used Java code style.

Removed

  • ❗️ Multiple non-async methods in OslcClient
  • ❗️ A property exposing OslcRestClient in ServiceProviderRegistryClient

Fixed

  • Minor bug fixes to pass acceptance tests against OSLC RefImpl Change Management server.

0.4.6 - 2024-11-15

Security

This release does not contain security updates.

Added

This release does not contain new features.

Changed

  • Dependency updates in connection with .NET 9 release.

Deprecated

This release does not introduce deprecations.

Removed

This release does not remove any features.

Fixed

  • Requirement.SetDecomposes() cleared affectedBy by mistake.

0.4.5 - 2024-10-19

Security

  • 🔒️ Transitive dependency System.Net.Http was set to version 4.3.4 to avoid failing the build when NU1903 is treated as error.
  • 🔒️ Transitive dependency System.Text.RegularExpressions was set to version 4.3.1 to avoid failing the build when NU1903 is treated as error.

Added

This release does not contain new features.

Changed

  • Significant build changes to manage package versions centrally.
  • NuGet/assembly versions are now set based on the git tag name.
  • 👉 "snapshot" builds how have the version similar to 999.9.9-ts.202410192025, where 202410192025 is a timestamp; please note that such snapshot builds are only available via Github Packages.

Deprecated

This release does not introduce deprecations.

Removed

  • Dependencies on "bridge" packages added during the migration from .NET Framework to .NET 6:
    • System.Configuration.ConfigurationManager
    • System.Data.DataSetExtensions
    • Microsoft.CSharp

Fixed

  • Example and test project had <IsPackable>false</IsPackable> property set to prevent pushing their packages to NuGet.

0.4.4 - 2024-10-19

YANKED - deploy to NuGet.org did not succeed.

0.4.3 - 2024-10-19

Security

This release does not contain security updates.

Added

  • ️⚡️ An example project using OslcClient and basic auth to retrieve a WorkItem (OSLC ChangeRequest) from Jazz.
  • OslcClient::ForBasicAuth() factory method.
  • ️️️⚡️ OslcClient.GetResourceAsync() strongly typed async method that returns OslcResponse<T> with either a typed resource or an error.
  • Support for complex MIME type strings for content negotiation. Current Accept string is set to text/turtle;q=1.0, application/rdf+xml;q=0.9, application/n-triples;q=0.8, text/n3;q=0.7 by default.
  • OSLC Query results now expose a .TotalCount property.

Changed

  • ❗️ OSLC4Net.Client now requires netstandard2.1 (was: netstandard2.0)
  • Upgraded dotNetRDF to v3.3.0

Deprecated

  • Some constructors on OslcClient were deprecated (around skipping TLS checks).
  • 👉 log4net logging will be replaced with the standard Microsoft ILogger in a future release.
  • Direct use of IEnumerator properties on OslcQueryResponse to iterate over response pages.
  • Multiple symbols on OSLC Query related code with Java-like signatures (various Get* methods) and string types. Prefer C# props of type Uri.

Removed

This release does not remove any features.

Fixed

  • OslcClient no longer overwrites most of the headers (#204). It was a similar issue to #19 (but happening with OslcRestClient).
  • Ensure OSLC Query responses are processed correctly when they contain multiple oslc:ResponseInfo objects (!203).

0.4.2 - 2024-10-09

Security

  • 🔒️❗️ OSLC4Net.Client now defaults to strong TLS certificate checking. Skipping TLS checks now requires explicit configuration.

Added

  • ⚡️ Support for .NET 6+ was added by migrating most of the projects in the solution to target netstandard2.0.

Changed

  • ⚡️ OSLC4Net.Core now targets netstandard2.0, which allows it to be used under .NET Framework 4.7.2 or higher as well as .NET 6+.
  • ⚡️ dotNetRDF was upgraded from v1 to v3 to enable targeting netstandard2.0.
    • One of the key breaking changes is that ITriple and INode no longer have the .Graph property.
    • ❗️ This caused breaking changes to some of the method signatures in OSLC4Net.DotNetRdfProvider to allow the IGraph instance to be passed.
  • OSLC4Net.Client now targets netstandard2.0.
    • ❗️ The main breaking change is the replacement of the legacy WebRequestHandler with HttpClientHandler. This caused some method/constructor signatures to change.
    • ❗️ RemoteCertificateValidationCallback was replaced with a lambda function.
  • OSLC4Net.Query now targets netstandard2.0. The Antlr3 runtime package targeting PCL was replaced with a package targeting NETStandard1.0 (Antlr 4 targets NETStandard2.0).
  • ❗️ JsonMediaTypeFormatter was renamed into OslcJsonMediaTypeFormatter to better reflect its purpose (support a bespoke OSLC JSON format) and avoid conflict with System.Net.Http.Formatting.MediaTypeFormatter.
  • Test projects were migrated from MSTestV2 to xUnit (except for integration tests for OSLC CM)

Deprecated

  • .NET 6 support is deprecated as the EOL is approaching soon. Given that all non-Framework libraries target netstandard2.0, this should have no impact on the users.

Removed

  • .NET 7 support was removed since the SDK has reached EOL.
  • Newtonsoft.Json package was only used in the StockQuoteSample ASP.NET MVC project. Its references were removed from all other projects.

Fixed

This release does not contain bug fixes.

[0.4.1] - YANKED

YANKED due to NuGet deployment issues.

[0.4.0] - YANKED

YANKED due to NuGet deployment issues.

0.3.0-alpha - 2023-04-29

Security

  • 🔒️ Updated log4net in response to CVE-2018-1285 (CVSS 9.8/10).
  • 🔒️ Updated Newtonsoft.Json in response to CWE-755.

Added

  • CI configuration based on Github Actions (MSBuild, NuGet, VStest).

Changed

  • 👉 Since 2017-04-15, the project is hosted on Github under the OSLC community org.
  • The project now targets .NET 4.8 instead of .NET 4.5.
  • ⚡️ Nuget project configuration was migrated from packages.config to PackageReference.
  • ⚡️ The StockQuoteSample was updated to ASP.NET MVC 5.
  • Migrated from MSBuild-based NuGet package restore to NuGet 2.7+ Automatic Package Restore.
  • Migrated from MSTestV1 ( Microsoft.VisualStudio.QualityTools.UnitTestFramework) to MSTestV2 ( MSTest.Test*).
  • ❗️👉 AssemblyVersion was set to 0.3.0.0 (from 1.0.0.0 in the v0.2.3). This could be a breaking change in some cases, but given that the project was used by a small number of people, the version being obviously wrong (given being present in the 0.2.3 release) and not having a Nuget release before, we decided to go ahead. Furthermore, switching from a direct assembly reference or a project reference to a Nuget package would require changes to the project references anyway.

Deprecated

  • Service Provider Catalog autodetection on the local host, port 8080, should not be relied upon, as the corresponding logic is deprecated.

Removed

  • ❗️ Support for .NET 4.5, 4.6, and 4.7 was dropped.

Fixed

  • System.Net.Http.Formatting issues were resolved by removing references to related SDK-provider assemblies, assembly extensions, and replacing them with a uniform reference to Microsoft.AspNet.WebApi.Client 5.2.9.

0.2.3 - 2013-07-26

Security

This release does not contain security updates.

Added

  • ⚡️ Turtle support (marshalling/unmarshalling)
  • ⚡️ OSLC Query support
  • ⚡️ OAuth 1.0a support

Changed

  • Improved the client

Deprecated

This release does not introduce deprecations.

Removed

This release does not remove any features.

Fixed

This release does not contain bug fixes.

TEMPLATE:

UNRELEASED - YYYY-MM-DD

Security

This release does not contain security updates.

Added

This release does not contain new features.

Changed

This release does not contain other significant changes.

Deprecated

This release does not introduce deprecations.

Removed

This release does not remove any features.

Fixed

This release does not contain bug fixes.