CHANGELOG.md

   1 # Changelog
   2
   3 This file lists changes for the GoVPP releases.
   4
   5 <!-- TEMPLATE
   6 ### Fixes
   7 -
   8 ### Features
   9 -
  10 ### Other
  11 -
  12 -->
  13
  14 ## 0.4.0 (in development)
  15 > _NOT RELEASED YET_
  16
  17 ### Binapi Generator
  18 - generator code has been split into multiple packages:
  19   - [vppapi](binapigen/vppapi) - parses VPP API (`.api.json`) files
  20   - [binapigen](binapigen) - processes parsed VPP API and handles code generation
  21 - previously required manual patches for generated code should no longer be needed
  22 - many generated aliases were removed and referenced to `*_types` files for simpler reading
  23 - any types imported from other VPP API (`*_types.api`) files are now automatically resolved for generated Go code
  24 - marshal/unmarshal methods for memory client messages are now generated
  25 - generated new helper methods for more convenient IP and MAC address conversion
  26 - added option to generate HTTP handlers for RPC services
  27 - RPC service code is now generated into a separated file (`*_rpc.ba.go`) in the same directory and uses low level
  28   stream API
  29 - generated code now contains comment with information about versions of VPP and binapi-generator
  30 - in addition to the file name, the binapi generator now accepts full path (including extension, e.g. `/usr/share/vpp/api/core/vpe.api.json`)
  31 - dependency on `github.com/lunixbochs/struc` was removed
  32
  33 ### Features
  34 - [socketclient](adapter/socketclient) received a new method to add client name
  35 - added list of compatible messages to `CompatibilityError`
  36 - removed global binary API adapter - this change allows GoVPP to manage multiple VPP connections with different
  37   sockets simultaneously
  38 - added support for the stats v2. The statsclient adapter recognized the version automatically so the `StatsAPI`
  39   remained unchanged. In relation to this change, the legacy support (i.e. stat segment v0) for VPP <=19.04 was dropped.
  40 - GoVPP now recognizes VPP state `NotResponding` which can be used to prevent disconnecting in case the VPP hangs
  41   or is overloaded
  42 - added method `SetLogger` for setting the global logger
  43
  44 ### Fixes
  45 - `MsgCodec` will recover panic occurring during a message decoding
  46 - calling `Unsubscibe` will close the notification channel
  47 - GoVPP omits sending `sockclnt_delete` while cleaning up socket clients in order to remove VPP duplicate close
  48   complaints - VPP handles it itself
  49 - fixed major bug causing GoVPP to not receive stats updates after VPP restart
  50 - fixed name conflict in generated union field constructors
  51 - size of unions composed of another unions is now calculated correctly
  52 - fixed race condition in the VPP adapter mock
  53
  54 ### Other
  55 - improved log messages to provide more relevant info
  56 - updated extras/libmemif to be compatible again
  57 - default health check parameter was increased to 250 milliseconds (up from 100 milliseconds), and the default
  58   threshold was increased to 2 (up from 1)
  59
  60 #### Examples
  61 - added more code samples of working with unions in [union example](examples/union-example)
  62 - added profiling mode to [perf bench](examples/perf-bench) example
  63 - improved [simple client](examples/simple-client) example to work properly even with multiple runs
  64 - added [multi-vpp](examples/multi-vpp) example displaying management of two VPP instances from single
  65   application
  66 - added [stream-client](examples/stream-client) example showing usage of the new stream API
  67
  68 #### Dependencies
  69 - updated `github.com/sirupsen/logrus` dep to `v1.6.0`
  70 - updated `github.com/lunixbochs/struc` dep to `v0.0.0-20200521075829-a4cb8d33dbbe`
  71
  72 ## 0.3.5
  73 > _18 May 2020_
  74
  75 ### Fixes
  76 - statsclient: Fix stats data errors and panic for VPP 20.05
  77
  78 ## 0.3.4
  79 > _17 April 2020_
  80
  81 ### Features
  82 - binapi-generator: Format generated Go source code in-process
  83
  84 ## 0.3.3
  85 > _9 April 2020_
  86
  87 ### Fixes
  88 - proxy: Unexport methods that do not satisfy rpc to remove warning
  89
  90 ## 0.3.2
  91 > _20 March 2020_
  92
  93 ### Fixes
  94 - statsclient: Fix panic occurring with VPP 20.05-rc0 (master)
  95
  96 ## 0.3.1
  97 > _18 March 2020_
  98
  99 ### Fixes
 100 - Fix import path in examples/binapi
 101
 102 ## 0.3.0
 103 > _18 March 2020_
 104
 105 ### Fixes
 106 - binapi-generator: Fix parsing default meta parameter
 107
 108 ### Features
 109 - api: Improve compatibility checking with new error types:
 110   `adapter.UnknownMsgError` and `api.CompatibilityError`
 111 - api: Added exported function `api.GetRegisteredMessageTypes()`
 112   for getting list of all registered message types
 113 - binapi-generator: Support imports of common types from other packages
 114 - binapi-generator: Generate `Reset()` method for messages
 115 - binapi-generator: Compact generated methods
 116
 117 ### Other
 118 - deps: Update `github.com/bennyscetbun/jsongo` to `v1.1.0`
 119 - regenerate examples/binapi for latest VPP from stable/2001
 120
 121 ## 0.2.0
 122 > _04 November 2019_
 123
 124 ### Fixes
 125 - fixed socketclient for 19.08
 126 - fixed binapi compatibility with master (20.01-rc0)
 127 - fixed panic during stat data conversion
 128
 129 ### Features
 130 - introduce proxy for remote access to stats and binapi
 131 - optimizations for statclient
 132
 133 ### Other
 134 - migrate to Go modules
 135 - print info for users when sockets are missing
 136
 137 ## 0.1.0
 138 > _03 July 2019_
 139
 140 The first release that introduces versioning for GoVPP.