☕ Rewriting tiny.coffee to < 100 lines of Go

History of tiny.coffee

There are people in this world that suffer from an incredible problem – the unresistable urge to buy vanity domains. I am one of those people, and one of favorites (excluding my brief ownership of ibm.lol)¹ is tiny.coffee.

At first I didn’t know what I wanted to do with it, but then I was inspired by parrot.live! When running curl parrot.live, you will be greeted with a ASCII party parrot in your terminal:

I decided to fork it into tiny.coffee. It just required a few HTML and ASCII changes, the JavaScript code was practically identical and didn’t need major tweaks. After adding a Dockerfile, it was deployed!

Although, my ASCII art left a lot to be desired:

If a user made a request via a web browser (or anything else without curl in the user agent), it would respond with a simple HTML webpage with a tiny party parrot holding coffee.

Aging like milk

The first version of tiny.coffee was deployed ~4 years ago and a bit has changed since then. It’s been moved from more machines/clouds than I can count. Most recently it was just a static site hosted on Vercel without the special curl user agent code path. This was meant to be temporary, but changing apartments/jobs and countless homelab rebuilds left it in limbo.

So, with my now “stable” homelab, I decide to spin it up again. I was quickly greeted by a familar site for JS devs:

npm WARN old lockfile
npm WARN old lockfile The package-lock.json file was created with an old version of npm,
npm WARN old lockfile so supplemental metadata must be fetched from the registry.
npm WARN old lockfile
npm WARN old lockfile This is a one-time fix-up, please be patient...
npm WARN old lockfile
npm WARN deprecated fsevents@1.2.4: fsevents 1 will break on node v14+ and could be using insecure binaries. Upgrade to fsevents 2.
npm WARN deprecated set-value@2.0.0: Critical bug fixed in v3.0.1, please upgrade to the latest version.
npm WARN deprecated ini@1.3.5: Please update to ini >=1.3.6 to avoid a prototype pollution issue
npm WARN deprecated set-value@0.4.3: Critical bug fixed in v3.0.1, please upgrade to the latest version.
npm WARN deprecated urix@0.1.0: Please see https://github.com/lydell/urix#deprecated
npm WARN deprecated resolve-url@0.2.1: https://github.com/lydell/resolve-url#deprecated
npm WARN deprecated source-map-url@0.4.0: See https://github.com/lydell/source-map-url#deprecated
npm WARN deprecated chokidar@2.0.4: Chokidar 2 does not receive security updates since 2019. Upgrade to chokidar 3 with 15x fewer dependencies
npm WARN deprecated debug@3.2.6: Debug versions >=3.2.0 <3.2.7 || >=4 <4.3.1 have a low-severity ReDos regression when used in a Node.js environment. It is recommended you upgrade to 3.2.7 or 4.3.1. (https://github.com/visionmedia/debug/issues/797)
npm WARN deprecated mixin-deep@1.3.1: Critical bug fixed in v2.0.1, please upgrade to the latest version.
npm WARN deprecated source-map-resolve@0.5.2: See https://github.com/lydell/source-map-resolve#deprecated

The deprecation warnings have deprecation warnings. And even better:

added 229 packages, and audited 230 packages in 8s

19 vulnerabilities (1 low, 8 moderate, 9 high, 1 critical)

To address issues that do not require attention, run:
  npm audit fix

To address all issues (including breaking changes), run:
  npm audit fix --force

Run `npm audit` for details.

This is why Snyk and Dependabot are so popular in the JS community. Even an app as simple as this with only two immediate dependencies links to over 200 packages with 19 vulnerabilites (with a critical and multiple high)!

# listing npm dependencies
rob@mbp$ cat package.json | jq '.dependencies'
{
  "colors": "1.1.2",
  "mz": "2.7.0"
}

# size of npm dependencies
rob@mbp$ du -h node_modules
7.1M	node_modules

# how many files of npm dependencies
rob@mbp$ find node_modules -type f | wc -l
    1271

And yes, many may argue both of these dependencies can be removed:

• colors can be replaced by ANSI escape sequences. Still has 24.8M weekly downloads on NPM at the time of writing this.
• mz isn’t nessary anymore in modern Node versions since we have fs/promises and util.promisify. Still has 3.8M weekly downloads on NPM at the time of writing this.

Instead of patching these dependencies, I figured it’d be a fun afternoon project to rewrite this in Go!

The rewrite

To me, Go was a perfect replacement. It has a great HTTP server in the net/http standard library and the static content (HTML & ASCII art) can actually be embeded in the binary directly using embed in Go >= 1.16. Everything required is already in the standard library, which means no dependencies!

Embedding static files

This can’t be easier. To “embed” a static file into the Go binary, it just needs a brief //go:embed comment above the variable, and it will contain the specified data at runtime:

var (
  //go:embed static/index.html
  indexHTML []byte // binary content of the index.html

  //go:embed frames/*.txt
  frameFS embed.FS // read-only filesystem containing ASCII coffee frames

  //...
)

Now, the compiled binary can be moved around without depending on a specific folder structure/path.

Serving the coffee

I’ll be using the default router in the net/http package and adding a single route to handle all requests. It will follow this pattern:

Nothing too complicated going on here, this can be contained to a for...select block with a couple channels. To account for both the user closing the connection and the two minute timeout, the default Request.Context can be wrapped in the context.WithTimeout and those cases can be handled together in a single channel. Otherwise, a time.Ticker will be used to send ANSI codes and a ASCII coffee frame every 100ms.

idx := 0
ticker := time.NewTicker(time.Millisecond * 100)
reqCancelCtx, cancel := context.WithTimeout(r.Context(), time.Minute * 2)
defer cancel()

for {
  select {
  case <-reqCancelCtx.Done():
    w.Write([]byte("no more coffee :(\n"))
    return
  case <-ticker.C:
    w.Write(ansiClear)
    w.Write(ansiColors[idx%len(ansiColors)])
    w.Write(frames[idx%len(frames)])
    w.Write(ansiReset)
    if f, ok := w.(http.Flusher); ok {
      f.Flush()
    }
    idx = idx + 1
  }
}

Note the f.Flush(), the default http.Transport in Go has a default write buffer size of 4KB, so the response writer will need to be flushed in order to get the coffee pouring in a timely matter.

Fresh coat of paint

My original ASCII art was horrible and the coffee mug was quite large for a tiny coffee, so I found some nice ASCII from ascii-art.de and slightly modified the “Double Espresso” from an unknown author.

The HTML also needed some sprucing up. I wanted to publicize the main attraction, so slapping curl tiny.coffee in the center of the page with a link to the source code under it seemed appropriate. Finally, making the original coffee party parrot bounce around like a mid-2000s DVD screensaver was the icing on the cake.

Bonus: Containerization and CI/CD

Static Go binaries are great, but they’re only portable to their target architecture/OS. It’d be great to automatically build and push a container image. With about ~50 lines of YAML this can be automated with GitHub Actions.

For the container itself, I’ll be using the base debian variant of Google’s distroless container images. Here’s the Dockerfile.

When a tag is pushed, the workflow will:

1. Create a new release via actions/github-script@v5 with a tag from the git ref (ie: vX.Y.Z) and set it as an output.
2. Login to GitHub container registry.
3. Extract image metadata from environment variables.
4. Build and push the image with the tag from Step 1.

The workflow is defined here, and the container image can be found here.

To run it locally, you can use podman or docker:

rob@mbp$ podman run -p 8000:8000 ghcr.io/robherley/tiny.coffee
2022/03/07 04:24:53 serving coffee on: 0.0.0.0:8000

And that’s it! Enjoy your coffee ☕