Add logging for local LSIF ZIP caching

changelogs/unreleased/jv-log-lsif-zip-cache.yml

+---
+title: Add logging for local LSIF ZIP caching
+merge_request: 579
+author:
+type: added

internal/lsif_transformer/parser/parser.go

@@ -2,11 +2,14 @@ package parser
 
 import (
 	"archive/zip"
+	"context"
 	"errors"
 	"fmt"
 	"io"
 	"io/ioutil"
 	"os"
+
+	"gitlab.com/gitlab-org/labkit/log"
 )
 
 var (
@@ -23,7 +26,7 @@ type Config struct {
 	TempPath string
 }
 
-func NewParser(r io.Reader, config Config) (io.ReadCloser, error) {
+func NewParser(ctx context.Context, r io.Reader, config Config) (io.ReadCloser, error) {
 	docs, err := NewDocs(config)
 	if err != nil {
 		return nil, err
@@ -45,6 +48,7 @@ func NewParser(r io.Reader, config Config) (io.ReadCloser, error) {
 	if err != nil {
 		return nil, err
 	}
+	log.WithContextFields(ctx, log.Fields{"lsif_zip_cache_bytes": size}).Print("cached incoming LSIF zip on disk")
 
 	zr, err := zip.NewReader(tempFile, size)
 	if err != nil {

internal/lsif_transformer/parser/parser_test.go

@@ -3,6 +3,7 @@ package parser
 import (
 	"archive/zip"
 	"bytes"
+	"context"
 	"encoding/json"
 	"io"
 	"io/ioutil"
@@ -42,7 +43,7 @@ func createFiles(t *testing.T, filePath, tmpDir string) {
 	file, err := os.Open(filePath)
 	require.NoError(t, err)
 
-	parser, err := NewParser(file, Config{})
+	parser, err := NewParser(context.Background(), file, Config{})
 	require.NoError(t, err)
 
 	zipFileName := tmpDir + ".zip"

internal/lsif_transformer/parser/performance_test.go

 package parser
 
 import (
+	"context"
 	"io"
 	"io/ioutil"
 	"os"
@@ -21,7 +22,7 @@ func BenchmarkGenerate(b *testing.B) {
 			file, err := os.Open(filePath)
 			require.NoError(b, err)
 
-			parser, err := NewParser(file, Config{})
+			parser, err := NewParser(context.Background(), file, Config{})
 			require.NoError(b, err)
 
 			_, err = io.Copy(ioutil.Discard, parser)

internal/upload/rewrite.go

@@ -187,7 +187,7 @@ func handleLsifUpload(ctx context.Context, reader io.Reader, tempPath, filename
 		TempPath: tempPath,
 	}
 
-	return parser.NewParser(reader, parserConfig)
+	return parser.NewParser(ctx, reader, parserConfig)
 }
 
 func (rew *rewriter) copyPart(ctx context.Context, name string, p *multipart.Part) error {