fix: Add stderr logging (#8)

Author: nieomylnieja

.goreleaser.yml

@@ -0,0 +1,38 @@
+version: 2
+project_name: nobl9-language-server
+
+builds:
+  - main: ./cmd/nobl9-language-server
+    env:
+      - CGO_ENABLED=0
+    mod_timestamp: '{{ .CommitTimestamp }}'
+    flags:
+      - -trimpath
+    ldflags:
+      - '-s -w -X github.com/nobl9/nobl9-language-server/internal/version.BuildVersion={{ .Version }} -X github.com/nobl9/nobl9-language-server/internal/version.BuildGitBranch={{ .Branch }} -X github.com/nobl9/nobl9-language-server/internal/version.BuildGitRevision={{ .ShortCommit }}'
+    goos:
+      - windows
+      - linux
+      - darwin
+    goarch:
+      - amd64
+      - arm64
+    binary: '{{ .ProjectName }}'
+
+archives:
+  - formats:
+      - binary
+    name_template: '{{ .ProjectName }}-{{ .Version }}-{{ .Os }}-{{ .Arch }}'
+
+checksum:
+  name_template: '{{ .ProjectName }}-{{ .Version }}.sha256'
+  algorithm: sha256
+
+release:
+  make_latest: false
+  draft: true
+  replace_existing_draft: false
+  prerelease: auto
+  github:
+    owner: nobl9
+    name: nobl9-language-server

cspell.json

@@ -33,6 +33,7 @@
     "docs.json"
   ],
   "words": [
+    "devel",
     "endef",
     "fname",
     "gcflags",

internal/version/VERSION

@@ -4,17 +4,12 @@ import (
 	_ "embed"
 	"fmt"
 	"runtime"
+	"runtime/debug"
 	"strings"
 )
 
 const programName = "nobl9-language-server"
 
-// BuildVersion defaults to VERSION file contents.
-// This is necessary since we don't have control over build flags when installed through `go install`.
-//
-//go:embed VERSION
-var embeddedBuildVersion string
-
 // Set during build time.
 var (
 	BuildGitRevision string
@@ -32,7 +27,15 @@ func GetUserAgent() string {
 func GetVersion() string {
 	version := BuildVersion
 	if version == "" {
-		version = embeddedBuildVersion
+		version = getRuntimeVersion()
 	}
 	return strings.TrimSpace(version)
 }
+
+func getRuntimeVersion() string {
+	info, ok := debug.ReadBuildInfo()
+	if !ok || info.Main.Version == "(devel)" {
+		return "0.0.0"
+	}
+	return strings.TrimPrefix(info.Main.Version, "v")
+}

internal/version/version.go

@@ -51,6 +51,13 @@ type TestCaseResponse struct {
 }
 
 func TestLSP(t *testing.T) {
+	// Currently, access to the Nobl9 API is mandatory.
+	// This test will fail if the following environment variables are not set.
+	// Since we're only operating on Project (which has no object references) we won't be calling the API anyway.
+	t.Setenv("NOBL9_LANGUAGE_SERVER_NO_CONFIG_FILE", "true")
+	t.Setenv("NOBL9_LANGUAGE_SERVER_CLIENT_ID", "fake-id")
+	t.Setenv("NOBL9_LANGUAGE_SERVER_CLIENT_SECRET", "fake-secret")
+
 	ctx, cancel := context.WithCancel(context.Background())
 
 	server := newServerCommand(t, ctx)
@@ -61,6 +68,12 @@ func TestLSP(t *testing.T) {
 	t.Cleanup(func() {
 		cancel()
 		server.Stop(t)
+
+		if t.Failed() {
+			logFileData, err := os.ReadFile(logFile)
+			require.NoError(t, err)
+			t.Logf("log file contents:\n%s", logFileData)
+		}
 	})
 
 	tests := []TestCase{

tests/server_test.go

@@ -42,7 +42,7 @@ func newServerCommand(t *testing.T, ctx context.Context) *serverCommand {
 	require.NoError(t, err)
 
 	stderr := new(bytes.Buffer)
-	cmd.Stderr = stderr
+	cmd.Stderr = io.MultiWriter(os.Stderr, stderr)
 
 	return &serverCommand{
 		IN:     inputPipe,
@@ -68,6 +68,10 @@ func (s *serverCommand) Start(t *testing.T) {
 func (s *serverCommand) Stop(t *testing.T) {
 	_, err := s.cmd.Process.Wait()
 	assert.NoError(t, err)
+
+	out, err := io.ReadAll(s.stderr)
+	assert.NoError(t, err)
+	assert.Empty(t, string(out))
 }
 
 func newJSONRPCClient(writer io.Writer, reader io.Reader) *jsonRPCClient {