From 7a36fb4562b72c0b886f38b32f7ccb072c9b4319 Mon Sep 17 00:00:00 2001
From: Olaoluwa Osuntokun <laolu32@gmail.com>
Date: Tue, 17 Jan 2017 13:01:07 -0800
Subject: [PATCH] channeldb: fix assumption that both channel edges will always
 be advertised
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

This commit fixes a prior bug in the graph database due to an invalid
assumption that both channel edges would _always_ be advertised. This
assumption is invalid, as it’s up to a node’s policy if the advertise
their direction of the channel.

The fix for this assumption is straight forward: ErrEdgeNotFound is no
longer a critical error, instead a nil pointer will now be passed into
the passed callback function.
---
 channeldb/graph.go | 35 ++++++++++++++++++++++++++---------
 1 file changed, 26 insertions(+), 9 deletions(-)

diff --git a/channeldb/graph.go b/channeldb/graph.go
index 0be6434d..8fd1eb46 100644
--- a/channeldb/graph.go
+++ b/channeldb/graph.go
@@ -116,6 +116,9 @@ type ChannelGraph struct {
 // edges as since this is a directed graph, both the in/out edges are visited.
 // If the callback returns an error, then the transaction is aborted and the
 // iteration stops early.
+//
+// NOTE: If an edge can't be found, ro wasn't advertised, then a nil pointer
+// will be passed into the callback.
 func (c *ChannelGraph) ForEachChannel(cb func(*ChannelEdge, *ChannelEdge) error) error {
 	// TODO(roasbeef): ptr map to reduce # of allocs? no duplicates
 
@@ -147,25 +150,39 @@ func (c *ChannelGraph) ForEachChannel(cb func(*ChannelEdge, *ChannelEdge) error)
 			// the edge information.
 			node1Pub := edgeInfo[:33]
 			edge1, err := fetchChannelEdge(edges, chanID, node1Pub, nodes)
-			if err != nil {
+			if err != nil && err != ErrEdgeNotFound &&
+				err != ErrGraphNodeNotFound {
 				return err
 			}
-			edge1.db = c.db
-			edge1.Node.db = c.db
+
+			// The targeted edge may have not been advertised
+			// within the network, so we ensure it's non-nil before
+			// deferencing its attributes.
+			if edge1 != nil {
+				edge1.db = c.db
+				if edge1.Node != nil {
+					edge1.Node.db = c.db
+				}
+			}
 
 			// Similarly, the second node is contained within the
 			// latter half of the edge information.
 			node2Pub := edgeInfo[33:]
 			edge2, err := fetchChannelEdge(edges, chanID, node2Pub, nodes)
-			if err != nil {
+			if err != nil && err != ErrEdgeNotFound &&
+				err != ErrGraphNodeNotFound {
 				return err
 			}
-			edge2.db = c.db
-			edge2.Node.db = c.db
 
-			// TODO(roasbeef): second edge might not have
-			// propagated through network yet (or possibly never
-			// will be)
+			// The targeted edge may have not been advertised
+			// within the network, so we ensure it's non-nil before
+			// deferencing its attributes.
+			if edge2 != nil {
+				edge2.db = c.db
+				if edge2.Node != nil {
+					edge2.Node.db = c.db
+				}
+			}
 
 			// With both edges read, execute the call back. IF this
 			// function returns an error then the transaction will