Skip to main content

A Go Gotcha that Got Me

Here's a little Go program that has a surprising output:
package main

import (
 "fmt"
 "net"
 "crypto/tls"
)
 
func main() {
 var c net.Conn

 c, err := tls.Dial("tcp", "www.jgc.org:80", nil)

 fmt.Printf("%v %v\n", c, err)

 if c == nil {
  fmt.Printf("Nil\n")
 } else {
  fmt.Printf("Not nil\n")
 }
}
This program tries to connect to my web site using TLS on the non-TLS port 80. That's done to force there to be a TLS error. The output is a little surprising:
  <nil> local error: record overflow
   Not nil
The Printf gives the value of c as but when the test c == nil is performed it's non-nil. 

So, what's going on? 

The answer is in the Go FAQ: Why is my nil error value not equal to nil?

In short, c is an interface (a net.Conn). The implementation of an interface is a type and a value. The type gives the actual type that implements that interface (in the case above it's a *tls.Conn) and the value is a pointer to the concrete example of that type. 

When the error occurs in the code above tls.Dial returns nil, err. The nil is a nil pointer to a tls.Conn. When the assignment to c happens c becomes non-nil (its type is now *tls.Conn) but its value is nil (since tls.Dial returned a nil pointer). Thus the nil test fails. 

The bottom line is that my code above is the wrong thing to do. Don't do nil tests on interface variables.

PS A lot of people have been asking me why I wasn't checking the value of err. In the real code I was, but a defer statement was acting on c and in it I had the code

if c != nil {
  c.Close()
}

In figuring out why that failed sometimes I discovered the gotcha.

Comments

Yves Junqueira said…
Most importantly, check the error result first before doing anything with the value.
Yves Junqueira said…
Most importantly, check the error result first before doing anything with the value.
rog peppe said…
Don't do nil tests on interface variables.

I'm not sure that's the right message to take home from this experience. Doing nil tests on interface variables is just fine. The thing to be aware of is that when you assign a non-interface value to an interface value, the interface value will never be nil.

This issue is why functions always return an error value of type "error" even when the type is known. The particular case you encountered is particularly easy to trip over because the signature of tls.Dial is almost exactly the same as that of net.Dial.

The particular pattern to watch for is:

x, err = something()

Note the "=" rather than :=.

It might be nice if there was a go vet check for this pattern actually. When go/types is ready, there may well be.

Popular posts from this blog

How to write a successful blog post

First, a quick clarification of 'successful'. In this instance, I mean a blog post that receives a large number of page views. For my, little blog the most successful post ever got almost 57,000 page views. Not a lot by some other standards, but I was pretty happy about it. Looking at the top 10 blog posts (by page views) on my site, I've tried to distill some wisdom about what made them successful. Your blog posting mileage may vary. 1. Avoid using the passive voice The Microsoft Word grammar checker has probably been telling you this for years, but the passive voice excludes the people involved in your blog post. And that includes you, the author, and the reader. By using personal pronouns like I, you and we, you will include the reader in your blog post. When I first started this blog I avoid using "I" because I thought I was being narcissistic. But we all like to read about other people, people help anchor a story in reality. Without people your bl

Your last name contains invalid characters

My last name is "Graham-Cumming". But here's a typical form response when I enter it: Does the web site have any idea how rude it is to claim that my last name contains invalid characters? Clearly not. What they actually meant is: our web site will not accept that hyphen in your last name. But do they say that? No, of course not. They decide to shove in my face the claim that there's something wrong with my name. There's nothing wrong with my name, just as there's nothing wrong with someone whose first name is Jean-Marie, or someone whose last name is O'Reilly. What is wrong is that way this is being handled. If the system can't cope with non-letters and spaces it needs to say that. How about the following error message: Our system is unable to process last names that contain non-letters, please replace them with spaces. Don't blame me for having a last name that your system doesn't like, whose fault is that? Saying "Your

The Elevator Button Problem

User interface design is hard. It's hard because people perceive apparently simple things very differently. For example, take a look at this interface to an elevator: From flickr Now imagine the following situation. You are on the third floor of this building and you wish to go to the tenth. The elevator is on the fifth floor and there's an indicator that tells you where it is. Which button do you press? Most people probably say: "press up" since they want to go up. Not long ago I watched someone do the opposite and questioned them about their behavior. They said: "well the elevator is on the fifth floor and I am on the third, so I want it to come down to me". Much can be learnt about the design of user interfaces by considering this, apparently, simple interface. If you think about the elevator button problem you'll find that something so simple has hidden depths. How do people learn about elevator calling? What's the right amount of