Skip to content

Latest commit

 

History

History
235 lines (204 loc) · 18.5 KB

CHANGELOG.md

File metadata and controls

235 lines (204 loc) · 18.5 KB
Raw

Overview

This log describes the functionality of tagged versions within the repository.

Tags

  • 1.1.0-RELEASE Released 2018-07-12

    Overview:
    • This release provides an initial fix for the scalability bottleneck which prevented the use of more than ~4000 monitors in the Disruptor implementation. The default monitor implementation now uses a single shared work queue from which ten threads take off tasks. The chosen implementation is configurable via a property ('CA_MONITOR_NOTIFIER') which may be set differently for each context or globally. The following values are supported:
      • MultipleWorkerBlockingQueueMonitorNotificationServiceImpl <<< DEFAULT
      • SingleWorkerBlockingQueueMonitorNotificationServiceImpl
      • DisruptorMonitorNotificationServiceOldImpl"
      • DisruptorMonitorNotificationServiceNewImpl
    • Additionally, various cleanups have been made with the intention of making this library more maintainable in the future.
    Change List:
    • Issue #23 Documentation Improvements.
      • added comment to README file on CA version compatibility.
      • added PDF of CA Protocol Specification. Source is here.
      • added Enterprise Architect Model which can be useful for analysing/documenting the behaviour of this library.
      • added additional logging (but no functional differences).
    • Issue #24: Upgraded for compatibility with latest versions of Java, Gradle, Disruptor, JUnit etc
      • adjusted build system for Junit 5.
      • added Mockito framework to support unit testing of TCPTransport.
    • Issue #25 Fixed bug in TCPTransport receive buffer processing.
      • added Unit Test which fails on the implementation before the fix.
    • Issue #26 Removed TAB character from source files.
    • Issue #27 Eliminated Javadoc warnings.
    • Issue #28 Fix monitor scalability bottleneck.
      • provided support for configurable MonitorNotificationService.
      • added some additional performance tests.
      • added new test to explore socket handling performance.
      • removed Disruptor from monitor interface.
      • removed queue zize from monitor interface.
    • Issue #29 Create software release 1.1.0-RELEASE.
      • fixed bug in unit test which could result in test raising NPE.
      • added parameterized unit testing for monitors.
    • Issue #30 Upgrade to Junit5.
    • Issue #31 Adapt project structure so that 'src/test/java' tree is congruent with 'src/main/java' tree.
    • Issue #32 Add support for uploading builds to PSI artifactory.
    • Issue #33 Cleanup warnings detected by IntelliJ.
    • Issue #34 Provide direct access to socket ByteBuffer through MonitorNotificationService interface.
    • Issue #35 Revert Java buildCompatibility target to Java 8.
    • Issue #36 Revert to java.util.logging throughout.

  • 1.2.0 Released 2018-07-30

    Overview:
    • Provides configurability of the monitor -> consumer notification engine so that the user can choose between a number of implementations including,
      • BlockingQueueMultipleWorkerMonitorNotificationServiceImpl (default)
      • BlockingQueueSingleWorkerMonitorNotificationServiceImpl
      • DisruptorOldMonitorNotificationServiceImpl
      • DisruptorNewMonitorNotificationServiceImpl
      • StripedExecutorServiceMonitorNotificationServiceImpl
    • Changes the default monitor notification engine so that it buffers notification messages to slow consumers rather than throwing them away.
    • Now reports notification buffer overruns to stdout rather than silently throwing them away.
    • Fixes an issue which could occasionally occur with notification messages being delivered out of sequence.
    • Improves the monitor documentation available in the README file and in the MONITOR_INFO file.
    • Provides documentation on measured library performance. See the MONITOR_INFO file.
    • Increases the test coverage (includes more unit tests; switched to parameterized testing).
    Change List:
    • Issue #37 Investigate and where necessary fix bug suggested by Fabian with respect to out of order notifications.
    • Issue #39 Provide the ability for library users to configure the appropriate monitor notification strategies.
    • Issue #40 Decide on whether to keep possibility to send special monitor values (currently null) when a channel disconnects.
    • Issue #41 Write a monitor notification service impl that buffers to ensure that notifications are not dropped (eg suitable for archiver)
    • Issue #42 Create software release 1.2.0.
    • Issue #43 Add support for StripedExecutorService.

  • 1.2.1 Released 2018-09-18

    Overview:

    As previous release, except now fixed deployment for Java 8 target.

    Change List:
    • Issue #45 Reverted to building for Java 8 target.
    • Issue #46 Create software release 1.2.1.
    • Issue #47 Add initial support for deploying via bintray/jcenter.

  • 1.2.2 Released 2019-10-09

    Overview:

    Bug fix release to handle connection problems when operating through PSI's channel access gateway.

    Change List:
    • Issue #48 Create software release 1.2.2.
    • Issue #49 Library fails to detect IOC connection state changes when operating through a firewall.
    • Issue #50 Switched to openjdk8.

  • 1.3.0 Released 2020-06-11.

    Overview:

    This release was triggered mainly by the need to address problems when interoperating with EPICS 7 Channel Access (see Issue #58). But several other changes have been implemented to bring the library to the state where we hope it will be easier to actively maintain it in the future. These changes include:

    • The build tool has been upgraded to a later version of Gradle.
    • The library dependencies have been upgraded to later versions.
    • Lots of code has been refactored following IntelliJ code inspection recommendations. The intention here was to remove warning messages and NOT to introduce functional changes.
    • The CA Repeater was completely refactored, hopefully now along more understandable lines. It's now possible to capture the output from the CA Repeater in the logs and to verify that the CA library registers with it correctly and that it correctly forwards the beacon messages sent from the IOC's. This change resulted in the need to create many new unit tests to verify the behaviour of the Java network stack (UDP flavour) and the CA protocol itself.
    • The JCA/CAJ-based Test Server class (which provides the basis for verifying the behaviour of the CA library) has been renamed to more explicitly state its purpose: 'EpicsChannelAccessTestServer'. It is now based on what is currently the most recent version available in the EPICS community (org.epics:jca:2.4.4-j8). When performing integration tests the test server is now spawned as a separate process rather than running from within the same JVM as the library itself. (Aside: note this decision was partly driven by the fact that it doesn't seem possible to cleanly shutdown the CAJ counter class without leaking threads).
    • The LMAX-Disruptor-based monitor notification engine has now been removed. Since CA Release 1.2.0 the default monitor notification engine was changed to an implementation based on a standard Java blocking queue. The decision to remove the Disruptor is based on the fact that we have no measurements to demonstrate that the Disruptor technology offers performance benefits, given the context in which we are actually using it. Also, there were issues with leaking threads when attempting to shutdown the Disruptor which reduced the stability of the integration tests.
    • The Example program was improved (but this still needs further work).
    • Also: thanks to JL Muir for his contributions which have been integrated. :-)

    The complete change list is shown below:

    Change List:
    • Issue #52 Fix readme Gradle fragment version. Credit JL Muir. :-)
    • Issue #53 README unclear about supported listeners. Credit JL Muir. :-)
    • Issue #54 Fix readme typo in Compatibility section. Credit JL Muir. :-)
    • Issue #55 Remove nonexistent Travis build status from readme. Credit JL Muir. :-)
    • Issue #56 Fix readme typos. Credit JL Muir. :-)
    • Issue #57 Improve robustness of some tests.
    • Issue #58 Library does not interoperate with CA in EPICS 7.0 - "client version too old".
    • Issue #59 Transition away from 'travis-ci.org' site to newer 'travis-ci.com' site.
    • Issue #60 Create software release 1.2.3. Note: this was never publicly released.
    • Issue #61 Get the Example Program Working.
    • Issue #62 Update CA test server to use more recent JCA release
    • Issue #63 Update dependencies to later versions.
    • Issue #64 Refactor project according to IntelliJ inspection suggestions.
    • Issue #65 Change name of CAJTestServer to EpicsChannelAccesstestServer.
    • Issue #66 Update gradle to more recent build paradigms.
    • Issue #67 Switch tests to use of hamcrest matchers.
    • Issue #68 Modernise build.
    • Issue #69 Update .gitignore file using output from generator tool.
    • Issue #70 Refactor CA Repeater for improved clarity.
    • Issue #71 Refactor Version integration for better clarity.
    • Issue #72 Add support for running tests from command-line when deployed on target platform.
    • Issue #73 Create Tool for sniffing UDP datagram packets.
    • Issue #74 Cleanup code formatting (no change of behaviour).
    • Issue #75 Add constant for CA Repeater Registration Interval (60 seconds).
    • Issue #76 Implement IntelliJ code improvement suggestions.
    • Issue #77 Change README.xx files to upper case (for better consistency with other repos).
    • Issue #78 Update Channel Access Test Server to use latest from JCA project.
    • Issue #79 Miscellaneous improvements to unit tests.
    • Issue #80 Update CHANGELOG with details of software release 1.3.0.
    • Issue #81 Refactor / simplify logging facilities.
    • Issue #82 Restructure using standard class template.
    • Issue #83 Further improvements to Example program.
    • Issue #84 Further test improvements
    • Issue #85 Modify Example program to start/stop EPICS Test Server automatically.
    • Issue #86 Create markdown file for developer notes.
    • Issue #87 Add various run targets to gradle build script.
    • Issue #88 Refactor general-purpose network related functions into separate class.
    • Issue #89 Start repeater registration process immediately after CA Repeater.
    • Issue #90 Refactor log messages to simpler form.
    • Issue #91 Fix channel connect bug: completable futures sometimes do not complete even when channels have responded that they are available online.
    • Issue #92 ControllableCounterProcessVariable has no clean way of shutting down without leaving dangling threads.
    • Issue #93 Retire LMAX Disruptor.
    Java Release Compatibility

    This CA library source code uses Java 8 constructs, but nothing later. The library is packaged to run on JVM platforms that support Java 8 and later.

    Deprecation Note: this may be the last release that supports Java 8. From the next release we may switch the source code to use Java 11 constructs.

    Test Results:
    • Mac OSX: 505 tests successful / 0 tests failed / 0 tests skipped.
    • Linux RHEL7: 505 tests successful / 0 tests failed / 0 tests skipped.
    • Windows 10: 505 tests successful / 0 tests failed / 0 tests skipped.

  • 1.3.1 Released 2020-06-26.

    Overview:

    This release fixes a regression bug in the previous 1.3.0 release which forced users of the library to explicitly define System properties "java.net.preferIPv4Stack" and "java.net.preferIPv6Stack". Improved library configuration options and documented them better. Fixed broken CA Repeater registration on Windows. Now validates Example program by testing. Now includes integration tests that were run previously in external project. Library log messages are now less verbose. The old chattier behaviour can be restored by setting the system property "CA_LIUBRARY_LOG_LEVEL". Other minor changes.

    Change List:
    • Issue #94 Update README file to match latest (1.3.1) implementation.
    • Issue #95 Cleanup implementation of the user-configurable parameters.
    • Issue #96 Extract Protocol Configuration and Library Configuration constants from Constants class.
    • Issue #97 Update CHANGELIST with details of release 1.3.1
    • Issue #98 Add test to check that the Example program runs to successful completion.
    • Issue #100 Set UdpBroadcastTransport to non-shareable mode bug.
    • Issue #101 Rename BroadcastTransport to UdpBroadcastTransport.
    • Issue #102 Rename TCPTransport to TcpTransport.
    • Issue #103 Add integration tests.
    • Issue #104 Reduce log messages from INFO to FINE to make library less noisy at runtime.
    • Issue #105 Improve library configuration
    Java Release Compatibility

    See previous release.

    Test Results:
    • Mac OSX: 531 tests successful / 0 tests failed / 0 tests skipped.
    • Linux RHEL7: 531 tests completed / 0 tests failed / 0 tests skipped.
    • Windows 10: 531 tests passed / 0 tests failed / 2 tests skipped.
    Integration Test Results:

  • 1.3.2 Released 2020-06-27.

    Overview:

    Fixed performance regression in Context create. Other code improvements triggered by testing.

    Change List:
    • Issue #107 Integration Test Loggers should be static.
    • Issue #108 Channel Integration Tests: Q20 does not close context.
    • Issue #109 Method isAlive can throw NPE if invoked before process started.
    • Issue #110 CA Repeater Service Startup Code Hardening.
    • Issue #111 Create release 1.3.2.
    Java Release Compatibility

    See previous release.

    Test Results:
    • Mac OSX: 536 tests successful / 0 tests failed / 0 tests skipped.
    • Linux RHEL7: 536 tests completed / 0 tests failed / 0 tests skipped.
    • Windows 10: 536 tests passed / 0 tests failed / 2 tests skipped.
    Integration Test Results: