[release] prepare v0.34.0 release

8032cf1 src/goToolsInformation: update hardcoded latest version of gopls for release
6e5058c chore: Set permissions for GitHub actions
caee58d docs: update "debug a program as root" to work with snap and package tests
450ffa7 CHANGELOG.md: prepare for v0.33.1
1cd7544 build/all.bash: rearrange test order
27ca045 package.json: sync doc with [email protected]
150c57f src/goVulncheck: show the vulncheck result in vulncheck.view
0d481b8 src/goMain: register VulncheckResultViewProvider
dd2efbc test/gopls/vulncheck: increase 'populate webview' test timeout
69e5534 src/goVulncheck: add VulncheckResultViewProvider
84ac6ba docs/debugging.md: instruction for `console` and debugging as root
c9cc7b4 test/integration/codelens: fix type error
cdd8871 codelens: skip run-test and debug-test links and explorer entry for TestMain(*testing.M)
5c2db73 src/language: remove deep-equal dependency
70500e7 vscode-go: update to LSP 3.17 and vscode-languageclient v8.0.0
1660a85 vscode-go: update @types/vscode and engines.vscode
7c79ef4 vscode-go: unify tsconfig for build and test
3b44015 test: fix type errors
924ca36 src/goVulncheck: rename VulncheckResult to VulncheckReport
070d2fa src/goExplorer.ts: add handler registrations to disposables
b75abf0 test/integration: increase test timeout
5a9bc67 vscode-go: make all context properties optional
ff8fb94 src/goMain.ts: move setGOROOTEnvVar to goEnv
1ea929e src/goMain.ts: move tools update logic to goInstallTools
47b1555 src/goMain.ts: cleanup activate function
a1303d3 src/goMain.ts: remove goCtx export
41cf6d4 src/goMain.ts: move diagnostic collections to context
7854360 src/goMain.ts: move runBuilds to commands
4eef175 vscode-go: refactor various commands to factory pattern
74c0476 src/goTest.ts: refactor goTest to factory pattern
044fec8 vscode-go: refactor goDoctor, goFillStruct, and goImpl to factory pattern
b8c8806 src/goModifyTags.ts: refactor goModifyTags to factory pattern
934fcc8 src/goMain.ts: refactor debugger factory activation
b0d0c71 src/goMain.ts: refactor codelens activation
4ba68e0 src/goMain.ts: refactor welcome panel activation
d9980fd src/goVulncheck: replace gopls custom command with `gopls vulncheck`
68e1355 src/goDocumentSymbols: refactor DocumentSymbolProvider to remove fallback code
43bc5f9 src/goDeveloperSurvey: prepare 2022 mid dev survey
29bdea3 build/all.bash: disable packages.json setting test
eea25f4 src/goMain.ts: remove unused imports
c0f7791 src/commands: separate command logic from goMain.ts
cf8170e src/goMain.ts: simplify command registration
b83469b src/goFillStruct.ts: fix type error
750ae4a src/context.ts: remove mutex from context
71a933a src/commands: create startLanguageServer command
5897ed5 src/language: create go extension context
7c02b7d test/gopls: fix strict type errors
8519776 test/gopls/testdata: update workspace testdata configuration
4ad096e src/goVulncheck.ts: only run vulncheck for active editors of go files
8abfcaa vscode-go: add strict typecheck step to CI
01cc238 package.json: update typescript
398f8dd src/debugAdapter: fix strict type errors
492f2fc src/misc: fix strict type errors in various commands and data providers
8de5e1f src/misc: fix strict type errors in util files
8d8695b src/language: fix strict type errors
1f5edd0 src/goTest: fix strict type errors
f08030f vscode-go: create separate tsconfig for builds
5d06597 package.json: change version to v0.34.0-dev
9227019 src/goLanguageServer: timeout LanguageClient.stop call
27e8258 src/util.ts: throw error when getGoVersion fails

Change-Id: I835bc5799682c8d2df889dd3eabda8fc37100d9e

Author: suzmue

.github/workflows/wiki.yml

@@ -8,10 +8,15 @@ on:
       - 'docs/**'
 
 # A workflow run is made up of one or more jobs that can run sequentially or in parallel
+permissions:
+  contents: read
+
 jobs:
   # This workflow contains a single job called "build"
   publish:
     # The type of runner that the job will run on
+    permissions:
+      contents: write  # for Git to git push
     runs-on: ubuntu-latest
 
     # Steps represent a sequence of tasks that will be executed as part of the job

.vscode/tasks.json

@@ -33,7 +33,7 @@
 	"tasks": [
 		{
 			"type": "typescript",
-			"tsconfig": "tsconfig.json",
+			"tsconfig": "./tsconfig.build.json",
 			"problemMatcher": [
 				"$tsc"
 			]
@@ -49,7 +49,7 @@
 			"group": {
 				"kind": "build",
 				"isDefault": true
-			}
+			},
 		},
 		{
 			"type": "npm",

build/Dockerfile

@@ -2,7 +2,6 @@
 ARG GOVERSION=1
 FROM golang:${GOVERSION} AS gobuilder
 
-ENV GO111MODULE on
 ENV GOBIN /gobin
 
 # Install other Go tools tests depend on
@@ -12,22 +11,19 @@ RUN go run /scratch/installtools/main.go
 
 FROM node:latest
 
-# Prepare a home directory under workspace.
-RUN mkdir -p /workspace/vscodego
-ENV HOME=/workspace/vscodego
-
 # GO111MODULE=auto
 RUN mkdir /go
 COPY --from=gobuilder /gobin /go/bin
 COPY --from=gobuilder /usr/local/go /usr/local/go
 
 # Add the default GOPATH/bin to the PATH.
 # Add the directories of the go tool chains to PATH.
-ENV PATH /workspace/vscodego/go/bin:/go/bin:/usr/local/go/bin:${PATH}
+ENV PATH /go/bin:/usr/local/go/bin:${PATH}
 ENV DEBIAN_FRONTEND noninteractive
 
 RUN apt-get -qq update && apt-get install -qq -y libnss3 libgtk-3-dev libxss1 libasound2 xvfb libsecret-1-0 jq > /dev/null
 RUN npm install -g typescript vsce
 
+USER node
 WORKDIR /workspace
 ENTRYPOINT ["build/all.bash"]

build/all.bash

@@ -42,27 +42,26 @@ go_binaries_info() {
 }
 
 run_test() {
-  echo "**** Run test ****"
   df -h | grep shm
+
+  echo "**** Run settings generator ****"
+  go run ./tools/generate.go -w=false -gopls=true
+
+  echo "**** Run Go tests ****"
+  go test ./...
+
+  echo "**** Test build ****"
   npm ci
   npm run compile
+
+  echo "**** Run test ****"
   npm run unit-test
   npm test --silent
-  npm run lint
-
-  # BUG(github.com/golang/vscode-go/issues/2230): Disable test temporarily.
-  # echo "**** Run settings generator ****"
-  # go run tools/generate.go -w=false -gopls=true
 
-  echo "**** Check if vsce works ****"
-  vsce package
-
-  echo "**** Run Go tests ****"
-  go test ./...
-  # TODO(hyangah): see if go clean -modcache makes kokoro builder happy
-  go clean -modcache
+  npm run lint
 }
 
+
 run_test_in_docker() {
   echo "**** Building the docker image ***"
   docker build -t vscode-test-env ${GOVERSION:+ --build-arg GOVERSION="${GOVERSION}"} -f ./build/Dockerfile .

docs/debugging.md

@@ -343,6 +343,148 @@ VS Code implements a generic, language-agnostic debugger UI based on [Debug Adap
 
 For information on debugging using the legacy debug adapter, please see the old [Debugging Documentation](https://github.com/golang/vscode-go/blob/master/docs/debugging.md). Note that many new or enhanced features discussed in this document may not be available with the legacy debug adapter.
 
+### Handling STDIN
+
+The Go extension and `dlv` started as a subprocess of the extension do not have access to `tty`. The Go extension captures and forwards STDOUT/STDERR of the debug program to VS Code, so they can appear in `DEBUG OUTPUT` panel. But this arrangement does not handle STDIN.
+
+When the target program needs to read from STDIN or access terminals (`tty`), use the `"console"` launch option that controls where the `dlv` debugger and the target process run:
+
+* `integratedTerminal` for the terminal inside VS Code
+* `externalTerminal` for the terminal outside VS Code
+
+The Go extension delegates interaction with terminals to VS Code [using Debug Adapter Protocol's `RunInTerminal` functionality](https://github.com/golang/vscode-go/discussions/1626). For configuring VS Code's terminal related behavior, see VS Code's [documentation](https://code.visualstudio.com/docs/editor/integrated-terminal).
+
+### Debugging programs and tests as root
+
+In order to run and debug a program or a package test running as root, the debugger (`dlv`) must run with root privilege, too. You can start the debug session with root privilege utilizing the `"asRoot"` AND `"console"` launch options. This is currently supported only on Linux and Mac.
+
+When `asRoot` is true, the Go extension will use the `sudo` command to run `dlv`. Since `sudo` may ask you to enter password, the debug session needs [terminal access](#handling-stdin) so set `"console": "integratedTerminal"` or `"console": "externalTerminal"` in the launch configuration.
+
+#### Debug a program as root
+
+For example, the following launch configuration will start `myprogram` and debug it by running `sudo dlv dap` command in the integrated terminal.
+
+```json
+{
+    "name": "Launch as Root",
+    "request": "launch",
+    "mode": "exec",
+    "asRoot": true,
+    "program": "${workspaceRoot}/myprogram",
+    "console": "integratedTerminal",
+    ...
+}
+```
+
+The `asRoot` setting can be used with `auto`/`test`/`debug` launch modes that **build** the target binary to debug. That means the `go` command will be invoked as root to compile the binary, too. This can cause issues:
+
+* by default, `sudo` does not preserve the user's current environment variables (see documentations about sudo's `--preserve-env` option). For example, `PATH` or library paths required for build may be different.
+* Go environment variable settings usually associated in the home directory are different.
+* Module/build caches used during build as root may be different from the caches used in your normal build. If they are the same, you may encounter permission errors due to cache data written to the caches as root.
+
+Instead, you can arrange the `exec` launch mode to work with a pre-launch [task](https://code.visualstudio.com/docs/editor/tasks).
+
+First, configure a debug build task to compile the target binary.
+
+In `.vscode/tasks.json`:
+```json
+{
+    ...
+    "tasks": [
+        {
+            "label": "go: build (debug)",
+            "type": "shell",
+            "command": "go",
+            "args": [
+                "build",
+                "-gcflags=all=-N -l",
+                "-o",
+                "${fileDirname}/__debug_bin"
+            ],
+            "options": {
+                "cwd": "${fileDirname}"
+            },
+            ...
+        }
+    ]
+}
+```
+
+The `-gcflags=all=-N -l` flag tells the `go build` command to preserve the debug information. The `-o` flag causes the compiled binary to be placed in `"${fileDirname}/__debug_bin"`. Extra build flags and environment variables *used for build* should be configured here as `args` or `options`'s `env` settings.
+
+It might be useful to add `__debug_bin` to your `.gitignore` to avoid debugging binaries getting checked-in into your repository.
+
+Then, configure the launch config to run the task before starting debugging.
+
+In `.vscode/launch.json`:
+```json
+    ...
+    "configurations": [
+        {
+            "name": "Launch Package as root",
+            "type": "go",
+            "request": "launch",
+            "mode": "exec",
+            "asRoot": true,
+            "console": "integratedTerminal",
+            "program": "${fileDirname}/__debug_bin",
+            "preLaunchTask": "go: build (debug)",
+        }
+    ]
+```
+
+Settings (`args`, `cwd`, `env`, ...) configured in the above `launch.json` will only apply when *running* the compiled binary, not when building the binary.
+
+#### Debug a package test as root
+
+To debug package tests as root add the following launch and task configurations.
+
+In `.vscode/tasks.json`:
+```json
+    ...
+    "tasks": [
+        {
+            ...
+        },
+        {
+            "label": "go test (debug)",
+            "type": "shell",
+            "command": "go",
+            "args": [
+                "test",
+                "-c",
+                "-o",
+                "${fileDirname}/__debug_bin"
+            ],
+            "options": {
+                "cwd": "${fileDirname}",
+            },
+            ...
+        }
+    ]
+```
+
+In `.vscode/launch.json`:
+```json
+    ...
+    "configurations": [
+        {
+            ...
+        },
+        {
+            "name": "Debug Package Test as root",
+            "type": "go",
+            "request": "launch",
+            "mode": "exec",
+            "asRoot": true,
+            "program": "${fileDirname}/__debug_bin",
+            "cwd": "${fileDirname}",
+            "console": "integratedTerminal",
+            "preLaunchTask": "go test (debug)"
+        }
+    ]
+```
+
 ### Manually installing `dlv`
 
 On rare occasions, you may want to install `dlv` by yourself instead of letting the extension handle its installation.

media/reset.css

@@ -0,0 +1,30 @@
+/*---------------------------------------------------------
+ * Copyright 2022 The Go Authors. All rights reserved.
+ * Licensed under the MIT License. See LICENSE in the project root for license information.
+ *--------------------------------------------------------*/
+
+html {
+	box-sizing: border-box;
+	font-size: 13px;
+}
+
+*,
+*:before,
+*:after {
+	box-sizing: inherit;
+}
+
+body,
+h1,
+h2,
+h3,
+h4,
+h5,
+h6,
+p,
+ol,
+ul {
+	margin: 0;
+	padding: 0;
+	font-weight: normal;
+}

media/vscode.css

@@ -0,0 +1,45 @@
+/*---------------------------------------------------------
+ * Copyright 2022 The Go Authors. All rights reserved.
+ * Licensed under the MIT License. See LICENSE in the project root for license information.
+ *--------------------------------------------------------*/
+
+:root {
+	--container-paddding: 20px;
+	--input-padding-vertical: 6px;
+	--input-padding-horizontal: 4px;
+	--input-margin-vertical: 4px;
+	--input-margin-horizontal: 0;
+}
+
+body {
+	padding: 0 var(--container-paddding);
+	color: var(--vscode-foreground);
+	font-size: var(--vscode-font-size);
+	font-weight: var(--vscode-font-weight);
+	font-family: var(--vscode-font-family);
+	background-color: var(--vscode-editor-background);
+}
+
+body>*,
+form>* {
+	margin-block-start: var(--input-margin-vertical);
+	margin-block-end: var(--input-margin-vertical);
+}
+
+*:focus {
+	outline-color: var(--vscode-focusBorder) !important;
+}
+
+a {
+	color: var(--vscode-textLink-foreground);
+}
+
+a:hover,
+a:active {
+	color: var(--vscode-textLink-activeForeground);
+}
+
+code {
+	font-size: var(--vscode-editor-font-size);
+	font-family: var(--vscode-editor-font-family);
+}

media/vulncheckView.css

@@ -0,0 +1,42 @@
+/*---------------------------------------------------------
+ * Copyright 2022 The Go Authors. All rights reserved.
+ * Licensed under the MIT License. See LICENSE in the project root for license information.
+ *--------------------------------------------------------*/
+
+.log {
+	font-weight: lighter;
+}
+
+.vuln {
+	text-align: left;
+	padding-bottom: 1em;
+}
+
+.vuln-desc {
+	padding-top: 0.5em;
+	padding-bottom: 0.5em;
+}
+
+.vuln-details {
+	padding-bottom: 0.5em;
+}
+
+details summary {
+	cursor: pointer;
+	position: relative;
+}
+
+details summary>* {
+	display: inline;
+	position: relative;
+}
+
+.stacks {
+	padding: 1em;
+}
+
+.stack {
+	padding: 1em;
+	font-size: var(--vscode-editor-font-size);
+	font-family: var(--vscode-editor-font-family);
+}