Repository navigation
Releases
pipeline/4.5.130
This release moves .NET toward one behavior across every 51Degrees language. Each element it changes now follows the published 51Degrees specifications, which in turn follow the RFCs they cite, so that the same input gives the same answer in .NET, Java, Node.js, Python, PHP, Go, Rust and C. .NET was the reference the other languages were aligned to, so many of its changes are small. The native libraries take the C library release 51degrees-cxx 4.5.105. Each change names the package family it is in.
This release adds .NET 10. Every package gains a net10.0 build and keeps the builds it had, so a .NET 10 application now loads code built for .NET 10, where it loaded the .NET 8 or .NET Standard 2.0 build before. One kind of .NET 10 web application has to raise two package versions before it will restore, which is set out under "Before you upgrade".
Before you upgrade
- The client-side ETag is a weak entity tag. The JavaScript and JSON endpoints send
W/"...", where they sent a bare number, and compareIf-None-Matchweakly, as RFC 9110 section 8.8.3 and section 13.1.2 ask. Code that reads the ETag as a number needs to allow forW/and the double quotes (#96, pipeline). - Web integration options in a configuration file now take effect. On ASP.NET Core nothing bound
PipelineWebIntegrationOptionsto the configuration, so the defaults always applied. A file that setsClientSideEvidenceEnabledorUseSetHeaderPropertiesto false now turns that feature off, so check both values (#115, pipeline). - Usage Sharing accepts no Evidence. It reads the web request instead, so a Pipeline that holds it no longer accepts every header. A Flow Element of your own that read a header it did not declare must name the key in its
EvidenceKeyFilter, or read the request from the newserver.http-requestEvidence value (#100, pipeline). - An application that builds its own Evidence has to give Usage Sharing the web request. This applies to an application that adds a value to Evidence only when
EvidenceKeyFilteron the Pipeline or the Flow Data includes its key. An application that uses the web integration has nothing to change. Up topipeline4.5.129 Usage Sharing accepted the headers it shares, so that check kept them. Usage Sharing now accepts none, so the same check drops every header that no other Flow Element reads, and those headers stop being shared. Add the request to the Flow Data underConstants.EVIDENCE_HTTPREQUEST_KEYinFiftyOne.Pipeline.Core, which isserver.http-request. The value is anIReadOnlyDictionary<string, object>that holds each value of the request under the key it would have as Evidence, such asheader.user-agent,cookie.51D_ScreenPixelsWidth,query.nameandserver.client-ip. Usage Sharing shares every Evidence value in the Flow Data, then each value of that dictionary whose key the Evidence does not hold. Its rules still apply, so theCookieheader, a blocked header and a cookie whose name does not start51D_are left out. The dictionary itself is never shared, is not sent to the cloud service and takes no part in a cache key. On ASP.NET Core,IWebRequestEvidenceService.AddEvidenceFromRequestinFiftyOne.Pipeline.Webadds the request for you (#100, pipeline). - On .NET Framework, session Evidence is renamed. A session value is
session.<name>and the session object issession.session, where they were<name>andsession(#100, pipeline). IpiOnPremiseEngineBuilderdefaults to the Balanced performance profile. With no profile set it loaded the whole Data File into memory. CallSetPerformanceProfile(PerformanceProfiles.MaxPerformance)to keep the old behavior.IpiOnPremisePipelineBuilderalready used Balanced (#102, ip-intelligence).- A client IP value is read only when all of it is one address. .NET read the first entry of a list, trimmed white space and dropped a zone index. A list such as
203.0.113.1, 198.51.100.7, a padded value,fe80::1%eth0and01.2.3.4are now skipped, and the Engine tries the next client IP key. Pass one address in each value (#130, ip-intelligence). - Property lists are read only.
IFlowElement.PropertiesandIAspectEngine.Propertiesreturn a read only list, and code that changes the list gets aNotSupportedException. Copy the list first, for examplenew List<IElementPropertyMetaData>(element.Properties)(#99, pipeline). - The JavaScript Builder needs a Sequence Element. Without one it renders sequence 1 and an empty session id, whatever the request carried. The web integration already adds one (#132, pipeline).
- Settings that were accepted now stop the Pipeline build. These are a JavaScript Builder protocol other than
httporhttps(#59) and an object name that the script cannot declare, such aswindow,documentorlocation(#123, pipeline). - Evidence named
resourceorlicenseno longer replaces the configured key. The Cloud Request Engine leaves out Evidence namedresource,license,licenceorvalues. Set the keys withSetResourceKeyandSetLicenseKey(#124, pipeline). - A .NET 10 web application may have to raise two package versions. This applies only to an application that targets
net10.0, usesFiftyOne.Pipeline.Webdirectly or through another package, and namesMicrosoft.AspNetCore.Mvc.Razor.RuntimeCompilationorMicrosoft.Extensions.FileProviders.Embeddedin its own project file at a version below 10.0.14. The newnet10.0build ofFiftyOne.Pipeline.Webneeds both at 10.0.14 or later, where the build a .NET 10 application loaded before needed 6.0.15. NuGet then stops the restore with NU1605, "Detected package downgrade", which the .NET SDK treats as an error. Change both versions in the project file to 10.0.14 or later, or remove the two references so thatFiftyOne.Pipeline.Webbrings them in. An application that targetsnet8.0, or that names neither package, needs no change (#95, Pipeline). - An Engine built with no Property names keeps the first Data File's Properties. A Property that only a later Data File holds reads as unavailable until the Engine is built again (#137, device-detection and ip-intelligence).
- A Property with no value gives a message.
NoValueMessage, and the JSONnullreason, of an on-premise Property with no value hold "None of the results contain a value for the requested property.", where they were null (#116, device-detection and ip-intelligence). - The agent signature element accepts only the eight Evidence keys its specification names. A signature that covers any other header is reported Unverified with the reason
ComponentUnavailable(#106, pipeline). - A 51Did with white space inside it, or with characters from both base64 alphabets, is refused.
FodId.TryParsereportsInvalidBase64, and the string constructor andFodId.FromBase64throwFormatException(#85, pipeline). - The Usage Sharing builder checks its back-off settings.
SetFailuresWindowSeconds,SetInitialRecoveryDelaySeconds,SetMaxRecoveryDelaySecondsandSetRecoveryMultiplierreject a value the back-off cannot use.RecoverySeconds,UseExponentialBackoffandCreateRecoveryStrategyonShareUsageBuilderBaseare obsolete (#88, pipeline). _51DEGREES_CLOUD_ENDPOINTreplacesFOD_CLOUD_API_URL, which still works in this release. When no endpoint is set in code or configuration,CloudRequestEngineBuilderandDidClientread_51DEGREES_CLOUD_ENDPOINT, and readFOD_CLOUD_API_URLonly when the new name is unset or empty. The first use of the old name in a process is reported as deprecated, as a warning through the builder's logger, and byDidClientthroughSystem.Diagnostics.Trace.Constants.FOD_CLOUD_API_URLandDidClient.EndpointEnvironmentVariablestill holdFOD_CLOUD_API_URLand compile with an obsolete warning, andConstants.CLOUD_ENDPOINT_ENV_VARand the newDidClient.CloudEndpointEnvironmentVariablehold the new name. Set_51DEGREES_CLOUD_ENDPOINTto the same value as the old name (#131, #143, pipeline). The examples, tests and CI scripts also read every old name in the table under "Environment variables" as a deprecated name, when its new name is unset or empty (#144).
What changes
Web integration and client-side caching
- A request whose
If-None-Matchmatches gets 304 for GET and HEAD, and 412 for any other method, as RFC ...
location/4.5.197
This release moves .NET toward one behavior across every 51Degrees language. Each element it changes now follows the published 51Degrees specifications, which in turn follow the RFCs they cite, so that the same input gives the same answer in .NET, Java, Node.js, Python, PHP, Go, Rust and C. .NET was the reference the other languages were aligned to, so many of its changes are small. The native libraries take the C library release 51degrees-cxx 4.5.105. Each change names the package family it is in.
This release adds .NET 10. Every package gains a net10.0 build and keeps the builds it had, so a .NET 10 application now loads code built for .NET 10, where it loaded the .NET 8 or .NET Standard 2.0 build before. One kind of .NET 10 web application has to raise two package versions before it will restore, which is set out under "Before you upgrade".
Before you upgrade
- The client-side ETag is a weak entity tag. The JavaScript and JSON endpoints send
W/"...", where they sent a bare number, and compareIf-None-Matchweakly, as RFC 9110 section 8.8.3 and section 13.1.2 ask. Code that reads the ETag as a number needs to allow forW/and the double quotes (#96, pipeline). - Web integration options in a configuration file now take effect. On ASP.NET Core nothing bound
PipelineWebIntegrationOptionsto the configuration, so the defaults always applied. A file that setsClientSideEvidenceEnabledorUseSetHeaderPropertiesto false now turns that feature off, so check both values (#115, pipeline). - Usage Sharing accepts no Evidence. It reads the web request instead, so a Pipeline that holds it no longer accepts every header. A Flow Element of your own that read a header it did not declare must name the key in its
EvidenceKeyFilter, or read the request from the newserver.http-requestEvidence value (#100, pipeline). - An application that builds its own Evidence has to give Usage Sharing the web request. This applies to an application that adds a value to Evidence only when
EvidenceKeyFilteron the Pipeline or the Flow Data includes its key. An application that uses the web integration has nothing to change. Up topipeline4.5.129 Usage Sharing accepted the headers it shares, so that check kept them. Usage Sharing now accepts none, so the same check drops every header that no other Flow Element reads, and those headers stop being shared. Add the request to the Flow Data underConstants.EVIDENCE_HTTPREQUEST_KEYinFiftyOne.Pipeline.Core, which isserver.http-request. The value is anIReadOnlyDictionary<string, object>that holds each value of the request under the key it would have as Evidence, such asheader.user-agent,cookie.51D_ScreenPixelsWidth,query.nameandserver.client-ip. Usage Sharing shares every Evidence value in the Flow Data, then each value of that dictionary whose key the Evidence does not hold. Its rules still apply, so theCookieheader, a blocked header and a cookie whose name does not start51D_are left out. The dictionary itself is never shared, is not sent to the cloud service and takes no part in a cache key. On ASP.NET Core,IWebRequestEvidenceService.AddEvidenceFromRequestinFiftyOne.Pipeline.Webadds the request for you (#100, pipeline). - On .NET Framework, session Evidence is renamed. A session value is
session.<name>and the session object issession.session, where they were<name>andsession(#100, pipeline). IpiOnPremiseEngineBuilderdefaults to the Balanced performance profile. With no profile set it loaded the whole Data File into memory. CallSetPerformanceProfile(PerformanceProfiles.MaxPerformance)to keep the old behavior.IpiOnPremisePipelineBuilderalready used Balanced (#102, ip-intelligence).- A client IP value is read only when all of it is one address. .NET read the first entry of a list, trimmed white space and dropped a zone index. A list such as
203.0.113.1, 198.51.100.7, a padded value,fe80::1%eth0and01.2.3.4are now skipped, and the Engine tries the next client IP key. Pass one address in each value (#130, ip-intelligence). - Property lists are read only.
IFlowElement.PropertiesandIAspectEngine.Propertiesreturn a read only list, and code that changes the list gets aNotSupportedException. Copy the list first, for examplenew List<IElementPropertyMetaData>(element.Properties)(#99, pipeline). - The JavaScript Builder needs a Sequence Element. Without one it renders sequence 1 and an empty session id, whatever the request carried. The web integration already adds one (#132, pipeline).
- Settings that were accepted now stop the Pipeline build. These are a JavaScript Builder protocol other than
httporhttps(#59) and an object name that the script cannot declare, such aswindow,documentorlocation(#123, pipeline). - Evidence named
resourceorlicenseno longer replaces the configured key. The Cloud Request Engine leaves out Evidence namedresource,license,licenceorvalues. Set the keys withSetResourceKeyandSetLicenseKey(#124, pipeline). - A .NET 10 web application may have to raise two package versions. This applies only to an application that targets
net10.0, usesFiftyOne.Pipeline.Webdirectly or through another package, and namesMicrosoft.AspNetCore.Mvc.Razor.RuntimeCompilationorMicrosoft.Extensions.FileProviders.Embeddedin its own project file at a version below 10.0.14. The newnet10.0build ofFiftyOne.Pipeline.Webneeds both at 10.0.14 or later, where the build a .NET 10 application loaded before needed 6.0.15. NuGet then stops the restore with NU1605, "Detected package downgrade", which the .NET SDK treats as an error. Change both versions in the project file to 10.0.14 or later, or remove the two references so thatFiftyOne.Pipeline.Webbrings them in. An application that targetsnet8.0, or that names neither package, needs no change (#95, Pipeline). - An Engine built with no Property names keeps the first Data File's Properties. A Property that only a later Data File holds reads as unavailable until the Engine is built again (#137, device-detection and ip-intelligence).
- A Property with no value gives a message.
NoValueMessage, and the JSONnullreason, of an on-premise Property with no value hold "None of the results contain a value for the requested property.", where they were null (#116, device-detection and ip-intelligence). - The agent signature element accepts only the eight Evidence keys its specification names. A signature that covers any other header is reported Unverified with the reason
ComponentUnavailable(#106, pipeline). - A 51Did with white space inside it, or with characters from both base64 alphabets, is refused.
FodId.TryParsereportsInvalidBase64, and the string constructor andFodId.FromBase64throwFormatException(#85, pipeline). - The Usage Sharing builder checks its back-off settings.
SetFailuresWindowSeconds,SetInitialRecoveryDelaySeconds,SetMaxRecoveryDelaySecondsandSetRecoveryMultiplierreject a value the back-off cannot use.RecoverySeconds,UseExponentialBackoffandCreateRecoveryStrategyonShareUsageBuilderBaseare obsolete (#88, pipeline). _51DEGREES_CLOUD_ENDPOINTreplacesFOD_CLOUD_API_URL, which still works in this release. When no endpoint is set in code or configuration,CloudRequestEngineBuilderandDidClientread_51DEGREES_CLOUD_ENDPOINT, and readFOD_CLOUD_API_URLonly when the new name is unset or empty. The first use of the old name in a process is reported as deprecated, as a warning through the builder's logger, and byDidClientthroughSystem.Diagnostics.Trace.Constants.FOD_CLOUD_API_URLandDidClient.EndpointEnvironmentVariablestill holdFOD_CLOUD_API_URLand compile with an obsolete warning, andConstants.CLOUD_ENDPOINT_ENV_VARand the newDidClient.CloudEndpointEnvironmentVariablehold the new name. Set_51DEGREES_CLOUD_ENDPOINTto the same value as the old name (#131, #143, pipeline). The examples, tests and CI scripts also read every old name in the table under "Environment variables" as a deprecated name, when its new name is unset or empty (#144).
What changes
Web integration and client-side caching
- A request whose
If-None-Matchmatches gets 304 for GET and HEAD, and 412 for any other method, as RFC ...
ip-intelligence/4.5.156
This release moves .NET toward one behavior across every 51Degrees language. Each element it changes now follows the published 51Degrees specifications, which in turn follow the RFCs they cite, so that the same input gives the same answer in .NET, Java, Node.js, Python, PHP, Go, Rust and C. .NET was the reference the other languages were aligned to, so many of its changes are small. The native libraries take the C library release 51degrees-cxx 4.5.105. Each change names the package family it is in.
This release adds .NET 10. Every package gains a net10.0 build and keeps the builds it had, so a .NET 10 application now loads code built for .NET 10, where it loaded the .NET 8 or .NET Standard 2.0 build before. One kind of .NET 10 web application has to raise two package versions before it will restore, which is set out under "Before you upgrade".
Before you upgrade
- The client-side ETag is a weak entity tag. The JavaScript and JSON endpoints send
W/"...", where they sent a bare number, and compareIf-None-Matchweakly, as RFC 9110 section 8.8.3 and section 13.1.2 ask. Code that reads the ETag as a number needs to allow forW/and the double quotes (#96, pipeline). - Web integration options in a configuration file now take effect. On ASP.NET Core nothing bound
PipelineWebIntegrationOptionsto the configuration, so the defaults always applied. A file that setsClientSideEvidenceEnabledorUseSetHeaderPropertiesto false now turns that feature off, so check both values (#115, pipeline). - Usage Sharing accepts no Evidence. It reads the web request instead, so a Pipeline that holds it no longer accepts every header. A Flow Element of your own that read a header it did not declare must name the key in its
EvidenceKeyFilter, or read the request from the newserver.http-requestEvidence value (#100, pipeline). - An application that builds its own Evidence has to give Usage Sharing the web request. This applies to an application that adds a value to Evidence only when
EvidenceKeyFilteron the Pipeline or the Flow Data includes its key. An application that uses the web integration has nothing to change. Up topipeline4.5.129 Usage Sharing accepted the headers it shares, so that check kept them. Usage Sharing now accepts none, so the same check drops every header that no other Flow Element reads, and those headers stop being shared. Add the request to the Flow Data underConstants.EVIDENCE_HTTPREQUEST_KEYinFiftyOne.Pipeline.Core, which isserver.http-request. The value is anIReadOnlyDictionary<string, object>that holds each value of the request under the key it would have as Evidence, such asheader.user-agent,cookie.51D_ScreenPixelsWidth,query.nameandserver.client-ip. Usage Sharing shares every Evidence value in the Flow Data, then each value of that dictionary whose key the Evidence does not hold. Its rules still apply, so theCookieheader, a blocked header and a cookie whose name does not start51D_are left out. The dictionary itself is never shared, is not sent to the cloud service and takes no part in a cache key. On ASP.NET Core,IWebRequestEvidenceService.AddEvidenceFromRequestinFiftyOne.Pipeline.Webadds the request for you (#100, pipeline). - On .NET Framework, session Evidence is renamed. A session value is
session.<name>and the session object issession.session, where they were<name>andsession(#100, pipeline). IpiOnPremiseEngineBuilderdefaults to the Balanced performance profile. With no profile set it loaded the whole Data File into memory. CallSetPerformanceProfile(PerformanceProfiles.MaxPerformance)to keep the old behavior.IpiOnPremisePipelineBuilderalready used Balanced (#102, ip-intelligence).- A client IP value is read only when all of it is one address. .NET read the first entry of a list, trimmed white space and dropped a zone index. A list such as
203.0.113.1, 198.51.100.7, a padded value,fe80::1%eth0and01.2.3.4are now skipped, and the Engine tries the next client IP key. Pass one address in each value (#130, ip-intelligence). - Property lists are read only.
IFlowElement.PropertiesandIAspectEngine.Propertiesreturn a read only list, and code that changes the list gets aNotSupportedException. Copy the list first, for examplenew List<IElementPropertyMetaData>(element.Properties)(#99, pipeline). - The JavaScript Builder needs a Sequence Element. Without one it renders sequence 1 and an empty session id, whatever the request carried. The web integration already adds one (#132, pipeline).
- Settings that were accepted now stop the Pipeline build. These are a JavaScript Builder protocol other than
httporhttps(#59) and an object name that the script cannot declare, such aswindow,documentorlocation(#123, pipeline). - Evidence named
resourceorlicenseno longer replaces the configured key. The Cloud Request Engine leaves out Evidence namedresource,license,licenceorvalues. Set the keys withSetResourceKeyandSetLicenseKey(#124, pipeline). - A .NET 10 web application may have to raise two package versions. This applies only to an application that targets
net10.0, usesFiftyOne.Pipeline.Webdirectly or through another package, and namesMicrosoft.AspNetCore.Mvc.Razor.RuntimeCompilationorMicrosoft.Extensions.FileProviders.Embeddedin its own project file at a version below 10.0.14. The newnet10.0build ofFiftyOne.Pipeline.Webneeds both at 10.0.14 or later, where the build a .NET 10 application loaded before needed 6.0.15. NuGet then stops the restore with NU1605, "Detected package downgrade", which the .NET SDK treats as an error. Change both versions in the project file to 10.0.14 or later, or remove the two references so thatFiftyOne.Pipeline.Webbrings them in. An application that targetsnet8.0, or that names neither package, needs no change (#95, Pipeline). - An Engine built with no Property names keeps the first Data File's Properties. A Property that only a later Data File holds reads as unavailable until the Engine is built again (#137, device-detection and ip-intelligence).
- A Property with no value gives a message.
NoValueMessage, and the JSONnullreason, of an on-premise Property with no value hold "None of the results contain a value for the requested property.", where they were null (#116, device-detection and ip-intelligence). - The agent signature element accepts only the eight Evidence keys its specification names. A signature that covers any other header is reported Unverified with the reason
ComponentUnavailable(#106, pipeline). - A 51Did with white space inside it, or with characters from both base64 alphabets, is refused.
FodId.TryParsereportsInvalidBase64, and the string constructor andFodId.FromBase64throwFormatException(#85, pipeline). - The Usage Sharing builder checks its back-off settings.
SetFailuresWindowSeconds,SetInitialRecoveryDelaySeconds,SetMaxRecoveryDelaySecondsandSetRecoveryMultiplierreject a value the back-off cannot use.RecoverySeconds,UseExponentialBackoffandCreateRecoveryStrategyonShareUsageBuilderBaseare obsolete (#88, pipeline). _51DEGREES_CLOUD_ENDPOINTreplacesFOD_CLOUD_API_URL, which still works in this release. When no endpoint is set in code or configuration,CloudRequestEngineBuilderandDidClientread_51DEGREES_CLOUD_ENDPOINT, and readFOD_CLOUD_API_URLonly when the new name is unset or empty. The first use of the old name in a process is reported as deprecated, as a warning through the builder's logger, and byDidClientthroughSystem.Diagnostics.Trace.Constants.FOD_CLOUD_API_URLandDidClient.EndpointEnvironmentVariablestill holdFOD_CLOUD_API_URLand compile with an obsolete warning, andConstants.CLOUD_ENDPOINT_ENV_VARand the newDidClient.CloudEndpointEnvironmentVariablehold the new name. Set_51DEGREES_CLOUD_ENDPOINTto the same value as the old name (#131, #143, pipeline). The examples, tests and CI scripts also read every old name in the table under "Environment variables" as a deprecated name, when its new name is unset or empty (#144).
What changes
Web integration and client-side caching
- A request whose
If-None-Matchmatches gets 304 for GET and HEAD, and 412 for any other method, as RFC ...
device-detection/4.5.181
This release moves .NET toward one behavior across every 51Degrees language. Each element it changes now follows the published 51Degrees specifications, which in turn follow the RFCs they cite, so that the same input gives the same answer in .NET, Java, Node.js, Python, PHP, Go, Rust and C. .NET was the reference the other languages were aligned to, so many of its changes are small. The native libraries take the C library release 51degrees-cxx 4.5.105. Each change names the package family it is in.
This release adds .NET 10. Every package gains a net10.0 build and keeps the builds it had, so a .NET 10 application now loads code built for .NET 10, where it loaded the .NET 8 or .NET Standard 2.0 build before. One kind of .NET 10 web application has to raise two package versions before it will restore, which is set out under "Before you upgrade".
Before you upgrade
- The client-side ETag is a weak entity tag. The JavaScript and JSON endpoints send
W/"...", where they sent a bare number, and compareIf-None-Matchweakly, as RFC 9110 section 8.8.3 and section 13.1.2 ask. Code that reads the ETag as a number needs to allow forW/and the double quotes (#96, pipeline). - Web integration options in a configuration file now take effect. On ASP.NET Core nothing bound
PipelineWebIntegrationOptionsto the configuration, so the defaults always applied. A file that setsClientSideEvidenceEnabledorUseSetHeaderPropertiesto false now turns that feature off, so check both values (#115, pipeline). - Usage Sharing accepts no Evidence. It reads the web request instead, so a Pipeline that holds it no longer accepts every header. A Flow Element of your own that read a header it did not declare must name the key in its
EvidenceKeyFilter, or read the request from the newserver.http-requestEvidence value (#100, pipeline). - An application that builds its own Evidence has to give Usage Sharing the web request. This applies to an application that adds a value to Evidence only when
EvidenceKeyFilteron the Pipeline or the Flow Data includes its key. An application that uses the web integration has nothing to change. Up topipeline4.5.129 Usage Sharing accepted the headers it shares, so that check kept them. Usage Sharing now accepts none, so the same check drops every header that no other Flow Element reads, and those headers stop being shared. Add the request to the Flow Data underConstants.EVIDENCE_HTTPREQUEST_KEYinFiftyOne.Pipeline.Core, which isserver.http-request. The value is anIReadOnlyDictionary<string, object>that holds each value of the request under the key it would have as Evidence, such asheader.user-agent,cookie.51D_ScreenPixelsWidth,query.nameandserver.client-ip. Usage Sharing shares every Evidence value in the Flow Data, then each value of that dictionary whose key the Evidence does not hold. Its rules still apply, so theCookieheader, a blocked header and a cookie whose name does not start51D_are left out. The dictionary itself is never shared, is not sent to the cloud service and takes no part in a cache key. On ASP.NET Core,IWebRequestEvidenceService.AddEvidenceFromRequestinFiftyOne.Pipeline.Webadds the request for you (#100, pipeline). - On .NET Framework, session Evidence is renamed. A session value is
session.<name>and the session object issession.session, where they were<name>andsession(#100, pipeline). IpiOnPremiseEngineBuilderdefaults to the Balanced performance profile. With no profile set it loaded the whole Data File into memory. CallSetPerformanceProfile(PerformanceProfiles.MaxPerformance)to keep the old behavior.IpiOnPremisePipelineBuilderalready used Balanced (#102, ip-intelligence).- A client IP value is read only when all of it is one address. .NET read the first entry of a list, trimmed white space and dropped a zone index. A list such as
203.0.113.1, 198.51.100.7, a padded value,fe80::1%eth0and01.2.3.4are now skipped, and the Engine tries the next client IP key. Pass one address in each value (#130, ip-intelligence). - Property lists are read only.
IFlowElement.PropertiesandIAspectEngine.Propertiesreturn a read only list, and code that changes the list gets aNotSupportedException. Copy the list first, for examplenew List<IElementPropertyMetaData>(element.Properties)(#99, pipeline). - The JavaScript Builder needs a Sequence Element. Without one it renders sequence 1 and an empty session id, whatever the request carried. The web integration already adds one (#132, pipeline).
- Settings that were accepted now stop the Pipeline build. These are a JavaScript Builder protocol other than
httporhttps(#59) and an object name that the script cannot declare, such aswindow,documentorlocation(#123, pipeline). - Evidence named
resourceorlicenseno longer replaces the configured key. The Cloud Request Engine leaves out Evidence namedresource,license,licenceorvalues. Set the keys withSetResourceKeyandSetLicenseKey(#124, pipeline). - A .NET 10 web application may have to raise two package versions. This applies only to an application that targets
net10.0, usesFiftyOne.Pipeline.Webdirectly or through another package, and namesMicrosoft.AspNetCore.Mvc.Razor.RuntimeCompilationorMicrosoft.Extensions.FileProviders.Embeddedin its own project file at a version below 10.0.14. The newnet10.0build ofFiftyOne.Pipeline.Webneeds both at 10.0.14 or later, where the build a .NET 10 application loaded before needed 6.0.15. NuGet then stops the restore with NU1605, "Detected package downgrade", which the .NET SDK treats as an error. Change both versions in the project file to 10.0.14 or later, or remove the two references so thatFiftyOne.Pipeline.Webbrings them in. An application that targetsnet8.0, or that names neither package, needs no change (#95, Pipeline). - An Engine built with no Property names keeps the first Data File's Properties. A Property that only a later Data File holds reads as unavailable until the Engine is built again (#137, device-detection and ip-intelligence).
- A Property with no value gives a message.
NoValueMessage, and the JSONnullreason, of an on-premise Property with no value hold "None of the results contain a value for the requested property.", where they were null (#116, device-detection and ip-intelligence). - The agent signature element accepts only the eight Evidence keys its specification names. A signature that covers any other header is reported Unverified with the reason
ComponentUnavailable(#106, pipeline). - A 51Did with white space inside it, or with characters from both base64 alphabets, is refused.
FodId.TryParsereportsInvalidBase64, and the string constructor andFodId.FromBase64throwFormatException(#85, pipeline). - The Usage Sharing builder checks its back-off settings.
SetFailuresWindowSeconds,SetInitialRecoveryDelaySeconds,SetMaxRecoveryDelaySecondsandSetRecoveryMultiplierreject a value the back-off cannot use.RecoverySeconds,UseExponentialBackoffandCreateRecoveryStrategyonShareUsageBuilderBaseare obsolete (#88, pipeline). _51DEGREES_CLOUD_ENDPOINTreplacesFOD_CLOUD_API_URL, which still works in this release. When no endpoint is set in code or configuration,CloudRequestEngineBuilderandDidClientread_51DEGREES_CLOUD_ENDPOINT, and readFOD_CLOUD_API_URLonly when the new name is unset or empty. The first use of the old name in a process is reported as deprecated, as a warning through the builder's logger, and byDidClientthroughSystem.Diagnostics.Trace.Constants.FOD_CLOUD_API_URLandDidClient.EndpointEnvironmentVariablestill holdFOD_CLOUD_API_URLand compile with an obsolete warning, andConstants.CLOUD_ENDPOINT_ENV_VARand the newDidClient.CloudEndpointEnvironmentVariablehold the new name. Set_51DEGREES_CLOUD_ENDPOINTto the same value as the old name (#131, #143, pipeline). The examples, tests and CI scripts also read every old name in the table under "Environment variables" as a deprecated name, when its new name is unset or empty (#144).
What changes
Web integration and client-side caching
- A request whose
If-None-Matchmatches gets 304 for GET and HEAD, and 412 for any other method, as RFC ...
common/5.1.10
This release moves .NET toward one behavior across every 51Degrees language. Each element it changes now follows the published 51Degrees specifications, which in turn follow the RFCs they cite, so that the same input gives the same answer in .NET, Java, Node.js, Python, PHP, Go, Rust and C. .NET was the reference the other languages were aligned to, so many of its changes are small. The native libraries take the C library release 51degrees-cxx 4.5.105. Each change names the package family it is in.
This release adds .NET 10. Every package gains a net10.0 build and keeps the builds it had, so a .NET 10 application now loads code built for .NET 10, where it loaded the .NET 8 or .NET Standard 2.0 build before. One kind of .NET 10 web application has to raise two package versions before it will restore, which is set out under "Before you upgrade".
Before you upgrade
- The client-side ETag is a weak entity tag. The JavaScript and JSON endpoints send
W/"...", where they sent a bare number, and compareIf-None-Matchweakly, as RFC 9110 section 8.8.3 and section 13.1.2 ask. Code that reads the ETag as a number needs to allow forW/and the double quotes (#96, pipeline). - Web integration options in a configuration file now take effect. On ASP.NET Core nothing bound
PipelineWebIntegrationOptionsto the configuration, so the defaults always applied. A file that setsClientSideEvidenceEnabledorUseSetHeaderPropertiesto false now turns that feature off, so check both values (#115, pipeline). - Usage Sharing accepts no Evidence. It reads the web request instead, so a Pipeline that holds it no longer accepts every header. A Flow Element of your own that read a header it did not declare must name the key in its
EvidenceKeyFilter, or read the request from the newserver.http-requestEvidence value (#100, pipeline). - An application that builds its own Evidence has to give Usage Sharing the web request. This applies to an application that adds a value to Evidence only when
EvidenceKeyFilteron the Pipeline or the Flow Data includes its key. An application that uses the web integration has nothing to change. Up topipeline4.5.129 Usage Sharing accepted the headers it shares, so that check kept them. Usage Sharing now accepts none, so the same check drops every header that no other Flow Element reads, and those headers stop being shared. Add the request to the Flow Data underConstants.EVIDENCE_HTTPREQUEST_KEYinFiftyOne.Pipeline.Core, which isserver.http-request. The value is anIReadOnlyDictionary<string, object>that holds each value of the request under the key it would have as Evidence, such asheader.user-agent,cookie.51D_ScreenPixelsWidth,query.nameandserver.client-ip. Usage Sharing shares every Evidence value in the Flow Data, then each value of that dictionary whose key the Evidence does not hold. Its rules still apply, so theCookieheader, a blocked header and a cookie whose name does not start51D_are left out. The dictionary itself is never shared, is not sent to the cloud service and takes no part in a cache key. On ASP.NET Core,IWebRequestEvidenceService.AddEvidenceFromRequestinFiftyOne.Pipeline.Webadds the request for you (#100, pipeline). - On .NET Framework, session Evidence is renamed. A session value is
session.<name>and the session object issession.session, where they were<name>andsession(#100, pipeline). IpiOnPremiseEngineBuilderdefaults to the Balanced performance profile. With no profile set it loaded the whole Data File into memory. CallSetPerformanceProfile(PerformanceProfiles.MaxPerformance)to keep the old behavior.IpiOnPremisePipelineBuilderalready used Balanced (#102, ip-intelligence).- A client IP value is read only when all of it is one address. .NET read the first entry of a list, trimmed white space and dropped a zone index. A list such as
203.0.113.1, 198.51.100.7, a padded value,fe80::1%eth0and01.2.3.4are now skipped, and the Engine tries the next client IP key. Pass one address in each value (#130, ip-intelligence). - Property lists are read only.
IFlowElement.PropertiesandIAspectEngine.Propertiesreturn a read only list, and code that changes the list gets aNotSupportedException. Copy the list first, for examplenew List<IElementPropertyMetaData>(element.Properties)(#99, pipeline). - The JavaScript Builder needs a Sequence Element. Without one it renders sequence 1 and an empty session id, whatever the request carried. The web integration already adds one (#132, pipeline).
- Settings that were accepted now stop the Pipeline build. These are a JavaScript Builder protocol other than
httporhttps(#59) and an object name that the script cannot declare, such aswindow,documentorlocation(#123, pipeline). - Evidence named
resourceorlicenseno longer replaces the configured key. The Cloud Request Engine leaves out Evidence namedresource,license,licenceorvalues. Set the keys withSetResourceKeyandSetLicenseKey(#124, pipeline). - A .NET 10 web application may have to raise two package versions. This applies only to an application that targets
net10.0, usesFiftyOne.Pipeline.Webdirectly or through another package, and namesMicrosoft.AspNetCore.Mvc.Razor.RuntimeCompilationorMicrosoft.Extensions.FileProviders.Embeddedin its own project file at a version below 10.0.14. The newnet10.0build ofFiftyOne.Pipeline.Webneeds both at 10.0.14 or later, where the build a .NET 10 application loaded before needed 6.0.15. NuGet then stops the restore with NU1605, "Detected package downgrade", which the .NET SDK treats as an error. Change both versions in the project file to 10.0.14 or later, or remove the two references so thatFiftyOne.Pipeline.Webbrings them in. An application that targetsnet8.0, or that names neither package, needs no change (#95, Pipeline). - An Engine built with no Property names keeps the first Data File's Properties. A Property that only a later Data File holds reads as unavailable until the Engine is built again (#137, device-detection and ip-intelligence).
- A Property with no value gives a message.
NoValueMessage, and the JSONnullreason, of an on-premise Property with no value hold "None of the results contain a value for the requested property.", where they were null (#116, device-detection and ip-intelligence). - The agent signature element accepts only the eight Evidence keys its specification names. A signature that covers any other header is reported Unverified with the reason
ComponentUnavailable(#106, pipeline). - A 51Did with white space inside it, or with characters from both base64 alphabets, is refused.
FodId.TryParsereportsInvalidBase64, and the string constructor andFodId.FromBase64throwFormatException(#85, pipeline). - The Usage Sharing builder checks its back-off settings.
SetFailuresWindowSeconds,SetInitialRecoveryDelaySeconds,SetMaxRecoveryDelaySecondsandSetRecoveryMultiplierreject a value the back-off cannot use.RecoverySeconds,UseExponentialBackoffandCreateRecoveryStrategyonShareUsageBuilderBaseare obsolete (#88, pipeline). _51DEGREES_CLOUD_ENDPOINTreplacesFOD_CLOUD_API_URL, which still works in this release. When no endpoint is set in code or configuration,CloudRequestEngineBuilderandDidClientread_51DEGREES_CLOUD_ENDPOINT, and readFOD_CLOUD_API_URLonly when the new name is unset or empty. The first use of the old name in a process is reported as deprecated, as a warning through the builder's logger, and byDidClientthroughSystem.Diagnostics.Trace.Constants.FOD_CLOUD_API_URLandDidClient.EndpointEnvironmentVariablestill holdFOD_CLOUD_API_URLand compile with an obsolete warning, andConstants.CLOUD_ENDPOINT_ENV_VARand the newDidClient.CloudEndpointEnvironmentVariablehold the new name. Set_51DEGREES_CLOUD_ENDPOINTto the same value as the old name (#131, #143, pipeline). The examples, tests and CI scripts also read every old name in the table under "Environment variables" as a deprecated name, when its new name is unset or empty (#144).
What changes
Web integration and client-side caching
- A request whose
If-None-Matchmatches gets 304 for GET and HEAD, and 412 for any other method, as RFC ...
caching/4.5.4
This release moves .NET toward one behavior across every 51Degrees language. Each element it changes now follows the published 51Degrees specifications, which in turn follow the RFCs they cite, so that the same input gives the same answer in .NET, Java, Node.js, Python, PHP, Go, Rust and C. .NET was the reference the other languages were aligned to, so many of its changes are small. The native libraries take the C library release 51degrees-cxx 4.5.105. Each change names the package family it is in.
This release adds .NET 10. Every package gains a net10.0 build and keeps the builds it had, so a .NET 10 application now loads code built for .NET 10, where it loaded the .NET 8 or .NET Standard 2.0 build before. One kind of .NET 10 web application has to raise two package versions before it will restore, which is set out under "Before you upgrade".
Before you upgrade
- The client-side ETag is a weak entity tag. The JavaScript and JSON endpoints send
W/"...", where they sent a bare number, and compareIf-None-Matchweakly, as RFC 9110 section 8.8.3 and section 13.1.2 ask. Code that reads the ETag as a number needs to allow forW/and the double quotes (#96, pipeline). - Web integration options in a configuration file now take effect. On ASP.NET Core nothing bound
PipelineWebIntegrationOptionsto the configuration, so the defaults always applied. A file that setsClientSideEvidenceEnabledorUseSetHeaderPropertiesto false now turns that feature off, so check both values (#115, pipeline). - Usage Sharing accepts no Evidence. It reads the web request instead, so a Pipeline that holds it no longer accepts every header. A Flow Element of your own that read a header it did not declare must name the key in its
EvidenceKeyFilter, or read the request from the newserver.http-requestEvidence value (#100, pipeline). - An application that builds its own Evidence has to give Usage Sharing the web request. This applies to an application that adds a value to Evidence only when
EvidenceKeyFilteron the Pipeline or the Flow Data includes its key. An application that uses the web integration has nothing to change. Up topipeline4.5.129 Usage Sharing accepted the headers it shares, so that check kept them. Usage Sharing now accepts none, so the same check drops every header that no other Flow Element reads, and those headers stop being shared. Add the request to the Flow Data underConstants.EVIDENCE_HTTPREQUEST_KEYinFiftyOne.Pipeline.Core, which isserver.http-request. The value is anIReadOnlyDictionary<string, object>that holds each value of the request under the key it would have as Evidence, such asheader.user-agent,cookie.51D_ScreenPixelsWidth,query.nameandserver.client-ip. Usage Sharing shares every Evidence value in the Flow Data, then each value of that dictionary whose key the Evidence does not hold. Its rules still apply, so theCookieheader, a blocked header and a cookie whose name does not start51D_are left out. The dictionary itself is never shared, is not sent to the cloud service and takes no part in a cache key. On ASP.NET Core,IWebRequestEvidenceService.AddEvidenceFromRequestinFiftyOne.Pipeline.Webadds the request for you (#100, pipeline). - On .NET Framework, session Evidence is renamed. A session value is
session.<name>and the session object issession.session, where they were<name>andsession(#100, pipeline). IpiOnPremiseEngineBuilderdefaults to the Balanced performance profile. With no profile set it loaded the whole Data File into memory. CallSetPerformanceProfile(PerformanceProfiles.MaxPerformance)to keep the old behavior.IpiOnPremisePipelineBuilderalready used Balanced (#102, ip-intelligence).- A client IP value is read only when all of it is one address. .NET read the first entry of a list, trimmed white space and dropped a zone index. A list such as
203.0.113.1, 198.51.100.7, a padded value,fe80::1%eth0and01.2.3.4are now skipped, and the Engine tries the next client IP key. Pass one address in each value (#130, ip-intelligence). - Property lists are read only.
IFlowElement.PropertiesandIAspectEngine.Propertiesreturn a read only list, and code that changes the list gets aNotSupportedException. Copy the list first, for examplenew List<IElementPropertyMetaData>(element.Properties)(#99, pipeline). - The JavaScript Builder needs a Sequence Element. Without one it renders sequence 1 and an empty session id, whatever the request carried. The web integration already adds one (#132, pipeline).
- Settings that were accepted now stop the Pipeline build. These are a JavaScript Builder protocol other than
httporhttps(#59) and an object name that the script cannot declare, such aswindow,documentorlocation(#123, pipeline). - Evidence named
resourceorlicenseno longer replaces the configured key. The Cloud Request Engine leaves out Evidence namedresource,license,licenceorvalues. Set the keys withSetResourceKeyandSetLicenseKey(#124, pipeline). - A .NET 10 web application may have to raise two package versions. This applies only to an application that targets
net10.0, usesFiftyOne.Pipeline.Webdirectly or through another package, and namesMicrosoft.AspNetCore.Mvc.Razor.RuntimeCompilationorMicrosoft.Extensions.FileProviders.Embeddedin its own project file at a version below 10.0.14. The newnet10.0build ofFiftyOne.Pipeline.Webneeds both at 10.0.14 or later, where the build a .NET 10 application loaded before needed 6.0.15. NuGet then stops the restore with NU1605, "Detected package downgrade", which the .NET SDK treats as an error. Change both versions in the project file to 10.0.14 or later, or remove the two references so thatFiftyOne.Pipeline.Webbrings them in. An application that targetsnet8.0, or that names neither package, needs no change (#95, Pipeline). - An Engine built with no Property names keeps the first Data File's Properties. A Property that only a later Data File holds reads as unavailable until the Engine is built again (#137, device-detection and ip-intelligence).
- A Property with no value gives a message.
NoValueMessage, and the JSONnullreason, of an on-premise Property with no value hold "None of the results contain a value for the requested property.", where they were null (#116, device-detection and ip-intelligence). - The agent signature element accepts only the eight Evidence keys its specification names. A signature that covers any other header is reported Unverified with the reason
ComponentUnavailable(#106, pipeline). - A 51Did with white space inside it, or with characters from both base64 alphabets, is refused.
FodId.TryParsereportsInvalidBase64, and the string constructor andFodId.FromBase64throwFormatException(#85, pipeline). - The Usage Sharing builder checks its back-off settings.
SetFailuresWindowSeconds,SetInitialRecoveryDelaySeconds,SetMaxRecoveryDelaySecondsandSetRecoveryMultiplierreject a value the back-off cannot use.RecoverySeconds,UseExponentialBackoffandCreateRecoveryStrategyonShareUsageBuilderBaseare obsolete (#88, pipeline). _51DEGREES_CLOUD_ENDPOINTreplacesFOD_CLOUD_API_URL, which still works in this release. When no endpoint is set in code or configuration,CloudRequestEngineBuilderandDidClientread_51DEGREES_CLOUD_ENDPOINT, and readFOD_CLOUD_API_URLonly when the new name is unset or empty. The first use of the old name in a process is reported as deprecated, as a warning through the builder's logger, and byDidClientthroughSystem.Diagnostics.Trace.Constants.FOD_CLOUD_API_URLandDidClient.EndpointEnvironmentVariablestill holdFOD_CLOUD_API_URLand compile with an obsolete warning, andConstants.CLOUD_ENDPOINT_ENV_VARand the newDidClient.CloudEndpointEnvironmentVariablehold the new name. Set_51DEGREES_CLOUD_ENDPOINTto the same value as the old name (#131, #143, pipeline). The examples, tests and CI scripts also read every old name in the table under "Environment variables" as a deprecated name, when its new name is unset or empty (#144).
What changes
Web integration and client-side caching
- A request whose
If-None-Matchmatches gets 304 for GET and HEAD, and 412 for any other method, as RFC ...
pipeline/4.5.129
What's Changed
- Make the Doxyfiles work from the documentation build layout by @Jamesr51d in #38
- Let four examples start when run from a clone by @Jamesr51d in #46
- Run the nightly and publish with the same inputs as the Node monorepo by @Jamesr51d in #45
- Release candidate by @jwrosewell in #51
- Release candidate by @jwrosewell in #68
- Release candidate by @jwrosewell in #72
Full Changelog: https://github.com/51Degrees/51degrees-dotnet/commits/pipeline/4.5.129
location/4.5.196
What's Changed
- Make the Doxyfiles work from the documentation build layout by @Jamesr51d in #38
- Let four examples start when run from a clone by @Jamesr51d in #46
- Run the nightly and publish with the same inputs as the Node monorepo by @Jamesr51d in #45
- Release candidate by @jwrosewell in #51
- Release candidate by @jwrosewell in #68
- Release candidate by @jwrosewell in #72
Full Changelog: https://github.com/51Degrees/51degrees-dotnet/commits/location/4.5.196
ip-intelligence/4.5.155
What's Changed
- Make the Doxyfiles work from the documentation build layout by @Jamesr51d in #38
- Let four examples start when run from a clone by @Jamesr51d in #46
- Run the nightly and publish with the same inputs as the Node monorepo by @Jamesr51d in #45
- Release candidate by @jwrosewell in #51
- Release candidate by @jwrosewell in #68
- Release candidate by @jwrosewell in #72
Full Changelog: https://github.com/51Degrees/51degrees-dotnet/commits/ip-intelligence/4.5.155
device-detection/4.5.180
What's Changed
- Make the Doxyfiles work from the documentation build layout by @Jamesr51d in #38
- Let four examples start when run from a clone by @Jamesr51d in #46
- Run the nightly and publish with the same inputs as the Node monorepo by @Jamesr51d in #45
- Release candidate by @jwrosewell in #51
- Release candidate by @jwrosewell in #68
- Release candidate by @jwrosewell in #72
Full Changelog: https://github.com/51Degrees/51degrees-dotnet/commits/device-detection/4.5.180