Change Log

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.

v3.8.0 (2023-12-06)

Full Changelog

Added

• [Core Framework] Guarentee ordering by rank from GetServiceReferences

• [Core Framework] Add BundleTracker

• [Core Framework] Initializer list support for AnyMap

Changed

• [Core Framework] Remove manual reference counting for serviceRegistrations

• [Core Framework] Ensure ServiceRegistrationU objects are not discarded from call to RegisterService

• [Core Framework] Update README to reflect correct compiler/OS versions

• [Declarative Services] Ensure multiple listeners for same factory PID are honored

• Update github workflows

• Use custom boost namespace to avoid symbol collision

• Update 3rd party dependency versions

• [Core Framework] Guarentee hash of serviceReference is conserved after destruction of serviceRegistrationBase object

Removed

• Update to allow custom boost namespace and remove absl dependency

Deprecated

Fixed

• [Core Framework] Data Race Condition fix for Bundles dataStorage location

• [Core Framework] Remove problematic std::move calls.

• [Core Framework] Flag Checking

• [Core Framework] Include cstdint in FileSystem.cpp

• [Core Framework] Fix code scanning alerts

• [Config Admin, Declarative Services] Fix code scanning alerts

• [Declarative Services] Fix race condition when addint SCRExtensionRegistry

• [Core Framework] Recoup performance losses

• [Core Framework] Recoup performance losses

• [Core Framework] BundleContextTest.NoSegfaultWithServiceFactory sporadic failure fix

• [Core Framework] Allow char const* properties in LDAPFilters

• [Core Framework] Reformat hpp FileSystem

• [Core Framework] Disable incorrect TSAN warnings

• [Core Framework] Fix potential deadlock in ServiceTracker

• [Core Framework] Update tests to remove unnecessary globals

• [Core Framework] Fix serviceTracker deadlock on close()

• [Core Framework] Update github workflows

• [Core Framework] Remove unused variable and add missing include

• [Declarative Services] Fix redundant bundle validation checks

• [Core Framework] Fix serviceTracker deadlock

v3.7.6 (2023-04-25)

Full Changelog

Added

• [Declarative Services] Add benchmark test infrastructure to DS

• [Core Framework] Make nested JSON queries using LDAP build-time configurable

• [Core Framework] Support nested JSON queries using LDAP

Changed

• Upgrade GitHub Actions to use Ubuntu 22.04 and remove use of Ubuntu 18.04

Removed

Deprecated

Fixed

• [Core Framework] clang-tidy improvement for CMakeResourceDependencies

• [Core Framework] GetService performance micro-optimizations

• [Declarative Services] Fix sporadic crash caused by concurrent access to ComponentMgrImpl vector

v3.7.5 (2023-03-14)

Full Changelog

Added

Changed

Removed

Deprecated

Fixed

• [Core Framework] Performance improvements

• [Core Framework] Fix undefined behavior

• [Declarative Services] Fix race with Declarative Services service object construction

• [Core Framework] RegisterService performance improvement

v3.7.4 (2022-11-02)

Full Changelog

Added

• Support arm64 on macOS

Changed

• Code formatting, no functional changes:

  • updated formatting - clang-fromat ran on all files

  • Clang-format git hook pre-commit enforcement

  • clang-format ran on all files

• [Core Framework] Upgrade jsoncpp

Removed

Deprecated

Fixed

• [Configuration Admin] Fix deadlock in ConfigurationAdminImpl::RemoveConfigurations

• [Configuration Admin] configurations using the same pid are not updated properly

• [Declarative Services] Ensure ~SCRBundleExtension does not throw

• Fix broken static build configurations on macOS

(UNRELEASED) v3.7.3 (2022-08-29)

Full Changelog

Added

• Add MSVC analysis to project

Changed

• [Declarative Services] Improve error message that is generated when an appropriate constructor isn’t found for the Service Instance.

• [Configuration Admin] Remove automatic config object creation

• Updated CI to use macos-12

• Update CXX_STANDARD to 17 for doc

• [Core Framework] Upgrade miniz to v3.0

• [Core Framework] Remove manual ref counting for BundleResource

• Add ignore for 3rdparty code for MSVC code analysis

• [Core Framework/Declarative Services] Add log messages when shared library loading throws an exception

Removed

Deprecated

Fixed

• [Declarative Services] Factory Configuration Bug Fix

• [Configuration Admin] Fix race that results in a missed config updated event

• [Core Framework] Fixed sporadic race conditions during framework shutdown

• [Core Framework] Ensure that the ServiceTracker::GetTrackingCount() method returns -1 if the tracker has been opened and then closed.

• Added missing include for <thread>

• [Declarative Services] BugFix when creating instance name for factory components

• [Configuration Admin] Fix race in ConfigurationNotifier::NotifyAllListeners()

• [Configuration Admin] Fix deadlock

• [Core Framework] Improve performance of LDAP matching

• [Core Framework] Fix CFRlogger accessviolation

• Cleaned up some security warnings regarding ‘noexcept’

• [Configuration Admin] Multiple services and factory services in bundle dependent on same configuration pid

• Disable code signing for bundle with no c++ code

• Fix compilation issue for arm macOS native compilation

• [Core Framework] Add file handle leak test

• [Configuration Admin] ListConfigurations fix for empty configuration objects.

v3.7.2 (2022-06-16)

Full Changelog

General Note

The last time CppMicroServices was upgraded to a new version on GitHub was two years ago. We think it will not be useful to include every change since then; below we have captured all of the relevant changes between v3.6.0 and v3.7.2.

Added

• [Log Service] LogService Implementation

• [Declarative Services] Added thread pool to DS

• [Core Framework] Anymap erase and compare

• Provide updated manifest.json schema in repo

• [Configuration Admin/Declarative Services] Configadmin ds integration

• GitHub Actions used as CI/CD solution

• [AsyncWorkService] Added AsyncWorkService interface to CppMicroServices

• GitHub Actions runs workflow for clang build with ASAN, TSAN, and UBSAN enabled

• [AsyncWorkService] AsyncWorkService DS Integration

• [AsyncWorkService] AsyncWorkService ConfigAdmin Integration

• [Security/Core Framework] bundle validation mechanism

Changed

• [Core Framework] Migrated all test driver tests to gtest

• Optimize the string creation in us_service_interface_iid<void>()

• [Core Framework] Improve the performance of removing service listeners

• [Declarative Services] Reduce possibility for symbol conflicts with autogenerated DS files

• Switch project to c++17

• Upgraded to CMake 3.17

• [Core Framework] Switch code to use std::string_view instead of abseil

• [Core Framework] Integrate LogService core framework and add more detail to exception messages

Removed

• [Core Framework] Remove Bundle Threads

• TravisCI and Appveyor removed as CI/CD solution

Deprecated

Fixed

• [Core Framework] Fix ServiceTracker race

• [Core Framework] Made ToJSON for strings do proper escaping of special characters

• [Core Framework] Fix issues with line endings in BundleResourceTest.cpp test

• Fix #301 so TSAN buidls work on Linux

• [Configuration Admin] ConfigAdmin remove notification when configuration object is created

• [Configuration Admin] Fix TestConcurrentBindUnbind error

• [Core Framework] Fix ServiceTracker race

• [Configuration Admin] RemoveBoundServicesCache fix

• [Declarative Services] Prevent nullptr from being passed to service constructors

• [Declarative Services] fix segfault when service class ctor throws

• [Core Framework] Fix bug when an AddingService method returns nullptr

• [Configuration Admin] Fix deadlock in ConfigAdmin Update, UpdateIfDifferent, and Remove

• [Configuration Admin] Fix ConfigurationAdmin ListConfigurations and Fix Race Conditions in DS

• [Resource Compimler] Allow ResourceCompiler to accept Unicode Command-line arguments

• [Core Framework] service tracker doesn’t track services after a close and then open

• Fix warning suppression leakage to non-CppMicroServices code inside translation units

• [Core Framework] Fix leak in ServiceListeners.cpp

• [Core Framework] Ensure that any BundleContext functions do not segfault if the bundle context is invalid

• Fixed issue where DS/CA do not build if US_BUILD_TESTING isn’t ON

• Fixed build issues when building in “getting_started” dir

• [Core Framework] Fix check-then-act-race in GetServiceFromFactory

• [Core Framework] Fix bug in FindResources() for data-only bundles

• [Core Framework] Fix check-then-act race for BundleContext

• [Declarative Services] Fix inheritance for ComponentException

• [Core Framework] Add –max-threads flag for core framework mem test

• [Core Framework] Fix leaked file handle

v3.6.0 (2020-08-13)

Full Changelog

Added

• [Declarative Services] Support dynamic policy reference option

• Added initial implementation of Configuration Admin

Changed

• BundleContext::InstallBundles

Removed

Deprecated

Fixed

• Fixed data race in BundleRegistry::Install

• Fixed race condition in Declarative Services

• Removed gtest dependency when not building the tests

v3.5.0 (2020-07-04)

Full Changelog

Added

• Bundle::GetSymbol API

• SharedLibraryException

Changed

• Migrate a handful of tests from the legacy test suite to gtest based test suite

• Improve shared library loading error messages

• c++17 compatible - https://github.com/CppMicroServices/CppMicroServices/pull/465 - https://github.com/CppMicroServices/CppMicroServices/pull/479

Removed

• Remove dead code and partially implemented features

• Remove code with license conflicts

Deprecated

Fixed

• Correctly install Declarative Services and LogService headers

• Infinite loop in GetCurrentWorkingDir

• Use cross build objcopy

• Service reference dependency deadlock

• Instantiating multiple service implementations within the same service component

• Codecov integration

• BundleRegistry deadlock

• Remove unnecessary copying of AnyMap

• Minimum and maximum cardinality values

• Error if duplicate service component reference names are used

• Improve performance of ServiceTrackers

v3.4.0 (2019-12-10)

Full Changelog

Added

• Declarative Services

• Expose checksum from zip archive.

• Framework property (org.cppmicroservices.library.load.options) to control library loading options on macOS and Linux.

• Add gmock

Changed

Removed

Deprecated

• The following Bundle method functions:

  • GetProperties

  • GetProperty

  • GetPropertyKeys

Fixed

• static ServiceTracker object crashes in ServiceTracker::Close()

• Does the ServiceTracker deleter close the service?

• Optimize peak heap allocation when installing bundles

• Change GetHeaders API to return a const ref

• How do service consumers know whether to use BundleContext::GetService or ServiceObjects?

• Add a testpoint to validate the return value of ServiceFactory::GetService

• Invalid Bundle causes crash on method invocation

• Use correct framework event severity and exception types for service factory errors

• Raspberry Pi arm build failing

• Service ctor exception crash

• Update library loading error messages

• Unknown Cmake Command “add_compile_definitions”

• GetChildResources() should not have a dependency on GetChildren()

• Improved code coverage to 90%

• Various performance improvements to:

  • Reduce the number of open file handles

  • Reduce peak heap memory utilization

  • AtCompoundKey

  • ServiceTracker

  • Service look up

  • Bundle installs

v3.3.0 (2018-02-20)

Full Changelog

Added

• Support constructing long LDAP expressions using concise C++ #246

• Bundle manifest validation #182

Fixed

• Fix seg faults when using default constructed LDAPFilter #251

v3.2.0 (2017-10-30)

Full Changelog

Added

• Code coverage metrics. #219

• GTest integration. #200

• Support boolean properties in LDAP filter creation. #224

• Unicode support. #245

Changed

• Re-enable single-threaded build configuration. #239

Fixed

• Fix a race condition when getting and ungetting a service. #202

• Make reading the current working directory thread-safe. #209

• Guard against recursive service factory calls. #213

• Fix LDAP filter match logic to properly handle keys starting with the same sub-string. #227

• Fix seg fault when using a default constructed LDAPFilter instance. #232

• Several fixes with respect to error code handling. #238

• IsConvertibleTo method doesn’t check for validity of member. #240

v3.1.0 (2017-06-01)

Full Changelog

Changed

• Improved BadAnyCastException message. #181

• Support installing bundles that do not have .DLL/.so/.dylib file extensions. #205

Deprecated

• The following BundleContext member functions:

  • RemoveBundleListener

  • RemoveFrameworkListener

  • RemoveServiceListener

  And the variants of

  • AddBundleListener

  • AddFrameworkListener,

  • AddServiceListener

  that take member functions.

• The free functions:

  • ServiceListenerMemberFunctor

  • BundleListenerMemberFunctor

  • BindFrameworkListenerToFunctor

• The functions

  • ShrinkableVector::operator[std::size_t]

  • ShrinkableMap::operator[const Key&]

Fixed

• Cannot add more than one listener if its expressed as a lambda. #95

• Removing Listeners does not work well #83

• Crash when trying to acquire bundle context #172

• Fix for unsafe_any_cast #198

• Stopping a framework while bundle threads are still running may deadlock #210

v3.0.0 (2017-02-08)

Full Changelog

See the migration guide for moving from a 2.x release to 3.x.

Added

• Added MinGW-w64 to the continuous integration matrix #168

• Include major version number in library names and install dirs #144

• Integrated coverity scan reports #16

• Added OS X to the continuous integration matrix #136

• Building for Android is now supported #106

• Enhanced the project structure to support sub-projects #14

• The bundle life-cycle now supports all states as described by OSGi and is controllable by the user #25

• Added support for framework listeners and improved logging #40

• Implemented framework properties #42

• Static bundles embedded into an executable are now auto-installed #109

• LDAP queries can now be run against bundle meta-data #53

• Resources from bundles can now be accessed without loading their shared library #15

• Support last modified time for embedded resources #13

Changed

• Fix up bundle property and manifest header handling #135

• Introduced C++11 features #35

• Re-organize header files #43, #67

• Improved memory management for framework objects and services #38

• Removed static globals #31

• Switched to using OSGi nomenclature in class names and functions #46

• Improved static bundle support #21

• The resource compiler was ported to C++ and gained improved command line options #55

• Changed System Bundle ID to 0 #45

• Output exception details (if available) for troubleshooting #27

• Using the US_DECLARE_SERVICE_INTERFACE macro is now optional #24

• The Any::ToString() function now outputs JSON formatted text #12

Removed

• The autoload feature was removed from the framework #75

Fixed

• Headers with _p.h suffix do not get resolved in Xcode for automatic-tracking of counterparts #93

• usUtils.cpp - Crash can occur if FormatMessage(...) fails #33

• Using US_DECLARE_SERVICE_INTERFACE with Qt does not work #19

• Fixed documentation of public headers. #165

v2.1.1 (2014-01-22)

Full Changelog

Fixed

• Resource compiler not found error #11

v2.1.0 (2014-01-11)

Full Changelog

Changed

• Use the version number from CMakeLists.txt in the manifest file #10

Fixed

• Build fails on Mac OS Mavericks with 10.9 SDK #7

• Comparison of service listener objects is buggy on VS 2008 #9

• Service listener memory leak #8

v2.0.0 (2013-12-23)

Full Changelog

Major release with backwards incompatible changes. See the migration guide for a detailed list of changes.

Added

• Removed the base class requirement for service objects

• Improved compile time type checking when working with the service registry

• Added a new service factory class for creating multiple service instances based on RFC 195 Service Scopes

• Added ModuleFindHook and ModuleEventHook classes

• Added Service Hooks support

• Added the utility class us::LDAPProp for creating LDAP filter strings fluently

• Added support for getting file locations for writing persistent data

Removed

• Removed the output stream operator for us::Any

Fixed

• US_ABI_LOCAL and symbol visibility for gcc < 4 #6

v1.0.0 (2013-07-18)

Initial release.

Fixed

• Build fails on Windows with VS 2012 RC due to CreateMutex #5

• usConfig.h not added to framework on Mac #4

• US_DEBUG logs even when not in debug mode #3

• Segmentation error after unloading module #2

• Build fails on Ubuntu 12.04 #1