Document mocking issue with context-aware interfaces

neo4j · Sep 23, 2022 · e4b6e09 · e4b6e09
1 parent 6590ab1
commit e4b6e09
Showing 1 changed file with 8 additions and 0 deletions.
diff --git a/MIGRATION_GUIDE.md b/MIGRATION_GUIDE.md
@@ -367,6 +367,14 @@ are all internal to the driver.
 This should have 0 impact as they were internal utilities unreachable from
 the public APIs.
 
+### Private functions in interfaces
+
+Both `neo4j.SessionWithContext` and `neo4j.ResultWithContext` define unexported functions.
+These are needed to avoid duplication between the `context.Context`-aware interface and their legacy, pre v5, variants.
+This may, however, cause issues with mocking libraries based on code generation.
+
+It is possible to mock these interfaces, as explained [here](https://groups.google.com/g/golang-nuts/c/6hpUErAfMHI).
+
 ### Behavior changes
 
 #### `ResultSummary#ContainUpdates`