internal/core/adt: add Assert for debugging

Change-Id: I0875cd65aa388997990793e3953032b0b9b89a51
Reviewed-on: https://cue-review.googlesource.com/c/cue/+/7762
Reviewed-by: CUE cueckoo <[email protected]>
Reviewed-by: Marcel van Lohuizen <[email protected]>

Author: mpvl

internal/core/adt/context.go

@@ -16,6 +16,7 @@ package adt
 
 import (
 	"fmt"
+	"os"
 	"reflect"
 	"regexp"
 
@@ -28,6 +29,36 @@ import (
 	"cuelang.org/go/cue/token"
 )
 
+// Debug sets whether extra aggressive checking should be done.
+// This should typically default to true for pre-releases and default to
+// false otherwise.
+var Debug bool = os.Getenv("CUE_DEBUG") != "0"
+
+// Assert panics if the condition is false. Assert can be used to check for
+// conditions that are considers to break an internal variant or unexpected
+// condition, but that nonetheless probably will be handled correctly down the
+// line. For instance, a faulty condition could lead to to error being caught
+// down the road, but resulting in an inaccurate error message. In production
+// code it is better to deal with the bad error message than to panic.
+//
+// It is advisable for each use of Assert to document how the error is expected
+// to be handled down the line.
+func Assert(name string, b bool) {
+	if Debug && !b {
+		panic("assertion failed: " + name)
+	}
+}
+
+// Assertf either panics or reports an error to c if the condition is not met.
+func (c *OpContext) Assertf(pos token.Pos, b bool, format string, args ...interface{}) {
+	if !b {
+		if Debug {
+			panic(fmt.Sprintf("assertion failed: "+format, args...))
+		}
+		c.addErrf(0, pos, format, args...)
+	}
+}
+
 // A Unifier implements a strategy for CUE's unification operation. It must
 // handle the following aspects of CUE evaluation:
 //
@@ -658,6 +689,10 @@ func (c *OpContext) node(x Expr, scalar bool) *Vertex {
 		return emptyNode
 
 	case *StructMarker, *ListMarker:
+		if node == nil {
+			Assert("unexpected markers with nil node", false)
+			return emptyNode
+		}
 
 	default:
 		if v.Kind()&StructKind != 0 {

internal/core/eval/eval.go

@@ -1068,13 +1068,14 @@ type envList struct {
 
 func (n *nodeContext) addBottom(b *adt.Bottom) {
 	n.errs = adt.CombineErrors(nil, n.errs, b)
+	// TODO(errors): consider doing this
+	// n.kindExpr = n.errs
+	// n.kind = 0
 }
 
 func (n *nodeContext) addErr(err errors.Error) {
 	if err != nil {
-		n.errs = adt.CombineErrors(nil, n.errs, &adt.Bottom{
-			Err: err,
-		})
+		n.addBottom(&adt.Bottom{Err: err})
 	}
 }