Upgrade to Go 1.16 in webapp and searchcache (#2846)

KyleJu · Kyle Ju · jcscottiii · web-flow · commit 8bf23a6f68d1 · 2022-07-21T09:16:08.000-04:00
* Bump Go to 1.16 * Revert changes in go.mod * revert go.sum * Use docker hub and correct distroless image Following the example from: https://github.com/GoogleContainerTools/distroless/blob/db2d69aa294c7ff414ae12c6ffe578254745a4ca/examples/go/Dockerfile * Add docs for upgrading go * ran mandatory go mod tidy * typo * docs edit Co-authored-by: Kyle Ju <kyleju@chromium.org> Co-authored-by: James Scott <jamescscott@google.com>
diff --git a/Dockerfile b/Dockerfile
@@ -1,5 +1,5 @@
 # vim: set expandtab sw=4
-FROM golang:1.14-buster
+FROM golang:1.16-buster
 
 # Create a non-priviledged user to run browsers as (Firefox and Chrome do not
 # like to run as root).
diff --git a/api/query/cache/service/Dockerfile b/api/query/cache/service/Dockerfile
@@ -1,17 +1,17 @@
 # Production deployment spec for query cache service.
 
-# Base golang 1.14 image.
-FROM gcr.io/gcp-runtimes/go1-builder:1.14 as builder
+# Base golang 1.16 image.
+FROM golang:1.16-buster as builder
 
 RUN apt-get update
 RUN apt-get install -qy --no-install-suggests git
 WORKDIR /go/src/wpt.fyi
 
 COPY wpt.fyi .
-RUN /usr/local/go/bin/go build -o ../../bin/app ./api/query/cache/service
+RUN CGO_ENABLED=0 /usr/local/go/bin/go build -o ../../bin/app ./api/query/cache/service
 
 # Application image.
-FROM gcr.io/distroless/base:latest
+FROM gcr.io/distroless/static-debian11
 
 COPY --from=builder /go/bin/app /usr/local/bin/app
 
diff --git a/docs/upgrading-go.md b/docs/upgrading-go.md
@@ -0,0 +1,49 @@
+# Maintenance: Upgrading Golang
+
+This document details the files to change and the necessary steps when upgrading Golang. At the time of the writing, we only upgrade on minor version changes to Golang, not patch changes. If that changes, please update this document.
+
+## Step 1 - Change the Runtime Version in webapp's app.staging.yaml and app.yaml files
+
+Ensure that the desired version is available. Go to the [Golang standard runtime docs](https://cloud.google.com/appengine/docs/standard/go/runtime) to see the latest versions available.
+
+Once you have confirmed that the desired version is available:
+- Open [app.yaml](../webapp/web/app.yaml) and [app.staging.yaml](../webapp/web/app.staging.yaml)
+- Change the `runtime` line to match the new version of Golang seen in the App Engine documentation.
+
+
+## Step 2 - Change the version in the Dockerfiles
+- tooling [Dockerfile](../Dockerfile) at the root of the repo
+- searchcache [Dockerfile](../api/query/cache/service/Dockerfile)
+
+The tooling image and the first stage of searchcache use the same Golang image. Check out the Golang [page](https://hub.docker.com/_/golang?tab=tags) on Docker Hub for the latest tags. Currently, we are using the `buster` [release](https://wiki.debian.org/DebianReleases) of Debian. As a result pick the `golang:<latest stable version>-buster` tag. If buster is superseded by a new version, you should change that as well.
+
+## Step 3 - Change the version in go.mod
+
+There is a line with the Golang version in the [go.mod](../go.mod) file. Change it to the latest major and minor version.
+
+## Step 4 - Run go mod tidy
+
+*Expand section for directions*
+<!-- TODO add more instructions for setups like local and docker compose  -->
+
+<details>
+  <summary>Running "go mod tidy" in webplatformtests/wpt.fyi Docker container</summary>
+  
+  ### Terminal 1
+
+  You need to run `go mod tidy` **but** `webplatformtests/wpt.fyi:latest` won't have the changes for the latest version of Golang from your changes to the tooling image in step 2. As a result, you will need to build the tooling image locally.
+
+  ```sh
+  # From the root of the repository
+  docker build --tag webplatformtests/wpt.fyi:latest .
+  ```
+
+  Follow the steps in the main [README.md](../README.md) to start up the instance. It will use this locally built version of Dockerfile
+
+  ### Terminal 2
+  ```sh
+  docker exec wptd-dev-instance go mod tidy
+  ```
+  This will update your go.mod and go.sum.
+
+</details>
diff --git a/go.mod b/go.mod
@@ -1,6 +1,6 @@
 module github.com/web-platform-tests/wpt.fyi
 
-go 1.14
+go 1.16
 
 require (
 	cloud.google.com/go/cloudtasks v0.1.0
diff --git a/go.sum b/go.sum
@@ -207,7 +207,6 @@ github.com/golang/protobuf v1.5.0/go.mod h1:FsONVRAS9T7sI+LIUmWTfcYkHO4aIWwzhcaS
 github.com/golang/protobuf v1.5.1/go.mod h1:DopwsBzvsk0Fs44TXzsVbJyPhcCPeIwnvohx4u74HPM=
 github.com/golang/protobuf v1.5.2 h1:ROPKBNFfQgOUMifHyP+KYbvpjbdoFNs+aK7DXlji0Tw=
 github.com/golang/protobuf v1.5.2/go.mod h1:XVQd3VNwM+JqD3oG2Ue2ip4fOMUkwXdXDdiuN0vRsmY=
-github.com/golang/snappy v0.0.3 h1:fHPg5GQYlCeLIPB9BZqMVR5nR9A+IM5zcgeTdjMYmLA=
 github.com/golang/snappy v0.0.3/go.mod h1:/XxbfmMg8lxefKM7IXC3fBNl/7bRcc72aCRzEWrmP2Q=
 github.com/gomodule/redigo v1.8.9 h1:Sl3u+2BI/kk+VEatbj0scLdrFhjPmbxOc1myhDP41ws=
 github.com/gomodule/redigo v1.8.9/go.mod h1:7ArFNvsTjH8GMMzB4uy1snslv2BwmginuMs06a1uzZE=
diff --git a/webapp/web/app.staging.yaml b/webapp/web/app.staging.yaml
@@ -2,7 +2,7 @@
 # Use of this source code is governed by a BSD-style license that can be
 # found in the LICENSE file.
 
-runtime: go114
+runtime: go116
 instance_class: F4_1G
 
 inbound_services:
diff --git a/webapp/web/app.yaml b/webapp/web/app.yaml
@@ -2,7 +2,7 @@
 # Use of this source code is governed by a BSD-style license that can be
 # found in the LICENSE file.
 
-runtime: go114
+runtime: go116
 instance_class: F4_1G
 
 inbound_services:
