goplsに独自Analyzerを組み込む

internal/lsp/source/options.godefaultAnalyzers()が返すmapに自作のAnalyzerを追加してgo installすれば使えるようになる*1

用途としてはチームのコーディング規約をtextDocument/diagnosticでチェックしたり、チェックに引っかかったコードの修正や一部だけ実装したコードの続きを生成するtextDocument/codeActionを実行したりなど。

今まではCIで独自Analyzerとreviewdog + action-suggesterを用いてチェックやコード修正を行っていたものを、goplsに組み込むことによってより早いコーディングのタイミングで行えるようになった。

もちろん補完やコードジャンプ、コード生成(textDocument/codeLens)などをカスタマイズしてさらに便利にすることもできるけど、本体の変更に追従するのが大変になりそうなので今のところはやっていない。
Analyzerの追加だけであればコンフリクトのことはほとんど考えなくて良いので定期的にupstreamを取り込むように設定するくらいでメンテナンスに関しては特に問題なさそう。
それにgoplsのCLI版で使えない機能を増やしすぎてしまうと、GoLandなどLSPに対応していないツールと差が開きすぎてしまうのも理由の一つ*2

*1:gopls/v0.9.4の場合

*2:今のチームは半分近くのメンバーがGoLandを使っているので

QNAPをTS-233に移行した

今までTS-231を使っていたけど、たまに落ちることがあったり去年ついにサポートが切れてしまったのでTS-233に移行した。

手順はTS-231の電源を落として、HDDを入れ替えて、TS-233を起動するだけ。

起動後は固定IPにしていたのがDHCPになっていた*1のでQfinderで探し、一応IP設定を戻しておいた。
それ以外はデータもアカウントもそのまま引き継がれていたので特に何もしなくて良かった。*2

普段からそんなに読み書きはしていなかったのであまり性能の違いを感じられていないけど、ブラウザからアクセスした時の画面がもたつかなくなっていたのは嬉しいポイント。
あとは長期間安定して動いてくれることを祈るばかり。

*1:TS-231にはNICが2枚あって、Adapter1を固定IP、Adapter2をDHCPにしていたらAdapter2の方が引き継がれたっぽい

*2:https://www.qnap.com/ja-jp/nas-migration/?os=qts&source=ts-231&destination=ts-233 に書いてあったものの、やってみるまではちょっと不安だった

golang.org/x/exp/jsonrpc2を使ってgoplsに接続する

最近golang.org/x/expjsonrpc2が追加されていることを知ったので試してみた。 pkg.go.dev

基本的な使い方としてはDialConnectionを作成し、

  • レスポンスが返ってくるメソッドはCall + Await
  • レスポンスが返ってこないメソッドはNotify

を呼べば良い。

Content-Lengthなんかの処理はConnectionOptionsがデフォルトで設定するHeaderFramerがやってくれる。

以前に書いたgoplsに接続するコードに比べるとだいぶスッキリした。 daisuzu.hatenablog.com

import (
    "context"
    "net"

    "golang.org/x/exp/jsonrpc2"
)

type Client struct {
    conn *jsonrpc2.Connection
}

func Connect(ctx context.Context, addr string, initializeParams map[string]any) (*Client, error) {
    conn, err := jsonrpc2.Dial(ctx,
        jsonrpc2.NetDialer("tcp", addr, net.Dialer{}),
        jsonrpc2.ConnectionOptions{}, // goplsに繋ぐ時は全てデフォルト値でOK
    )
    if err != nil {
        return nil, err
    }

    var initializeResult map[string]any // このサンプルではレスポンスを受け取るだけで使わない
    if err := conn.Call(ctx, "initialize", initializeParams).Await(ctx, &initializeResult); err != nil {
        return nil, err
    }

    if err := conn.Notify(ctx, "initialized", map[string]any{}); err != nil {
        return nil, err
    }

    return &Client{conn: conn}, nil
}

func (c *Client) Shutdown(ctx context.Context) error {
    return c.conn.Notify(ctx, "shutdown", map[string]any{})
}

go-cmpでmap内の時間文字列を近似比較する

以下のような関数をテストする際、期待する値もtime.Now()で生成して概ね問題ない。

func f() map[string]interface{} {
    return map[string]interface{}{
        "time": time.Now().Format("2006-01-02 15:04:05"),
    }
}

ただし関数内に多くの処理がある場合など、ごく稀に時間がズレてFAILしてしまうことがある。
こういった関数を作らないことで回避することもできるが、cmp.FilterPathを使うと次のような比較処理を実装できる。

  1. mapの特定のキーに対して、
  2. 値をinterface{}からtime.Timeに変換し、
  3. 2つの値の差が1秒以下ならOKとする
cmp.FilterPath(func(p cmp.Path) bool {
    if mi, ok := p.Index(-1).(cmp.MapIndex); ok {
        // 1. mapのキーがtimeの場合はComparerを使う
        return mi.Key().String() == "time"
    }
    return false
}, cmp.Comparer(func(x, y interface{}) bool {
    // 2. time.Timeに変換する
    xt, ok := parseTime(x)
    if !ok {
        return false
    }
    yt, ok := parseTime(y)
    if !ok {
        return false
    }

    if xt.Before(yt) {
        // xt.Sub(yt)が負の値にならないように入れ替える
        xt, yt = yt, xt
    }

    // 3. Durationが1秒以下ならOKとする
    return xt.Sub(yt) <= time.Second
}))

使用例はこちらgo.dev

Vimのterminalでパイプを使う

この記事はVim Advent Calendar 2021の9日目の記事です。

Vimにterminal機能が追加されてずいぶん経ちましたが、普段はtmux上でVimを使っていたので実際のところ使用頻度はそんなに高くありませんでした。
たまに使った時は出力がVimの中に閉じているため、検索したり編集したりはtmuxのペイン分割と比べてやりやすいなと思うことがあったくらいです。

ただ、最近になって似たようなコマンドを何度も実行することが増えてきて、その度にシェルの履歴から探してきてはコマンドライン引数を変更して実行するのが煩わしくなってきました。
例えば以下のようなコマンドです。

go test \
    # 1. 詳細な出力が欲しい(-v)
    # 2. カバレッジが取りたい(-covermode, -coverprofile, -coverpkg)
    # 3. 実行するテストを指定したい(-run)
    # 4. goldenファイルを更新したい(-golden)
    # 5. テストの分析がしたい時は出力を自作コマンドに流し込む

1〜4までは:executeを使って組み立てたcmdを実行するようにすれば良いので簡単です。

:execute 'terminal ' . cmd

ところが5で出力を流すのに、パイプ(|)をどのように使えば良いのかわかりませんでした。
いくつか試してみたところ、bash(やzsh)の-cオプションに""で実行したいコマンドを渡してあげれば良いことがわかりました。

" grepが効かない(`|`以降もvimコマンドの引数として扱われる)
:terminal vim -h | grep vimrc

" エラー
:terminal bash -c 'vim -h | grep vimrc'

" OK
:terminal bash -c "vim -h | grep vimrc"

これを自作コマンドにしておくと簡単に実行できます。

当初は柔軟に実行できる形にしようと思っていましたが、組み合わせはある程度固定化されていたので3、4パターンほどコマンドとして定義しておき、必要に応じて修正するような使い方をしています。
シェルスクリプトMakefileにしておくのも手かと思いますが、管理の手間などを考えると自分にとってはvimrcに書いておくのが一番楽でした。

curlとjqを組み合わせても良さそうなので、必要になったら同じようにしてやってみようと思っています。

Goのモジュールを個別に更新する

特に問題なければ go get -u ./... で全て更新してしまうのが楽ですが、更新できないモジュールがある場合は個別に更新する必要があります。

go list -m -u all で全モジュールとその更新有無を確認できるため、 -f でgo getコマンドを出力するようにし、必要なものだけ実行すると楽です。

例えばgoplsはそのまま実行すると以下のようになりますが、

$ go list -m -u all
golang.org/x/tools/gopls
github.com/BurntSushi/toml v0.4.1
github.com/davecgh/go-spew v1.1.1
github.com/google/go-cmp v0.5.6
github.com/google/safehtml v0.0.2
github.com/jba/templatecheck v0.6.0
github.com/kr/pretty v0.1.0 [v0.3.0]
github.com/kr/pty v1.1.1 [v1.1.8]
github.com/kr/text v0.1.0 [v0.2.0]
github.com/pkg/diff v0.0.0-20210226163009-20ebb0f2a09e
github.com/pmezard/go-difflib v1.0.0
github.com/rogpeppe/go-internal v1.8.0
github.com/sanity-io/litter v1.5.1
github.com/sergi/go-diff v1.1.0 [v1.2.0]
github.com/stretchr/objx v0.1.0 [v0.3.0]
github.com/stretchr/testify v1.4.0 [v1.7.0]
github.com/yuin/goldmark v1.4.1 [v1.4.4]
golang.org/x/crypto v0.0.0-20191011191535-87dc89f01550 [v0.0.0-20211108221036-ceb1ce70b4fa]
golang.org/x/mod v0.5.1
golang.org/x/net v0.0.0-20211015210444-4f30a5c0130f [v0.0.0-20211112202133-69e39bad7dc2]
golang.org/x/sync v0.0.0-20210220032951-036812b2e83c
golang.org/x/sys v0.0.0-20211019181941-9d821ace8654 [v0.0.0-20211113001501-0c823b97ae02]
golang.org/x/term v0.0.0-20201126162022-7de9c90e9dd1 [v0.0.0-20210927222741-03fcf44c2211]
golang.org/x/text v0.3.7
golang.org/x/tools v0.1.7 => ../
golang.org/x/xerrors v0.0.0-20200804184101-5ec99f83aff1
gopkg.in/check.v1 v1.0.0-20190902080502-41f04d3bba15 [v1.0.0-20201130134442-10cb98267c6c]
gopkg.in/errgo.v2 v2.1.0
gopkg.in/yaml.v2 v2.2.4 [v2.4.0]
honnef.co/go/tools v0.2.1 [v0.2.2]
mvdan.cc/gofumpt v0.1.1 [v0.2.0]
mvdan.cc/xurls/v2 v2.3.0

更新があり、直接使っている(not .Indirect)モジュールのgo getコマンドを生成すると以下のようになります。

$ go list -m -u -f '{{if (and .Update (not .Indirect))}}go get {{.Path}}@{{.Update.Version}}{{end}}' all
go get github.com/sergi/go-diff@v1.2.0
go get golang.org/x/sys@v0.0.0-20211113001501-0c823b97ae02
go get honnef.co/go/tools@v0.2.2
go get mvdan.cc/gofumpt@v0.2.0

aws-sdk-go-v2をモックせずにテストする

テストでaws-sdk-go-v2を使う場合はドキュメントにある通り、Clientのモックを用意するのが一般的な手法かと思います。
ただテストのためだけにinterfaceを書きたくないので、aws-sdk-go-v2が提供するClientをそのまま使える形にしたいです。

幸いaws-sdk-go-v2はClientをカスタマイズするためのオプションがあるため、大別して以下の2つの方法で実現可能です。

1つ目はAPIリクエストの送信先を変更する方法です。
こちらはWithEndpointResolverWithHTTPClientを用いることで、リクエストをhttptestで立ち上げたサーバーなど、任意の宛先に送信できます。

2つ目はClientの処理に任意の処理を割り込ませる方法です。
各Clientは下図のStackが実装されており、WithAPIOptionsで任意の処理を追加できるようになっています。 middleware
(詳細はイメージのリンク先へ)

通常はStackを順番に処理していくようになっていますが、途中で次を呼ばずに打ち切ってしまうこともできます。

例えばs3のGetObjectは以下のように呼ぶことでAWSにアクセスせずに"ok"を返せます。

input := &s3.GetObjectInput{
  Bucket: aws.String("bucket"),
  Key:    aws.String("key"),
}
output, err := client.GetObject(ctx, input, s3.WithAPIOptions(func(stack *middleware.Stack) error {
  return stack.Finalize.Add(
    middleware.FinalizeMiddlewareFunc("test",
      func(context.Context, middleware.FinalizeInput, middleware.FinalizeHandler) (middleware.FinalizeOutput, middleware.Metadata, error) {
        return middleware.FinalizeOutput{
          Result: &s3.GetObjectOutput{
            Body: io.NopCloser(strings.NewReader("ok")),
          },
        }, middleware.Metadata{}, nil
      },
    ),
    middleware.Before,
  )
}))

※ s3はFinalizeにリトライ処理があるため、それが呼ばれる前に処理を打ち切ることで数秒のロスを回避できる

しかし、実際のプロダクションコードだと個別のメソッドにオプションを渡すのは難しい形になっているかもしれません。
その際はClientをDIできるようにしておき、config.WithAPIOptionsを使ってClient側にオプションを設定します。

また、WithAPIOptionsはコードがそこそこ大きいのでfunc(*middleware.Stack) errorを返す関数を作成し、応答を渡せるようにしておくと使いやすいです。

以下がテストコードのサンプルです。

package main

import (
    "bytes"
    "context"
    "errors"
    "io"
    "strings"
    "testing"

    "github.com/aws/aws-sdk-go-v2/config"
    "github.com/aws/aws-sdk-go-v2/service/s3"
    "github.com/aws/smithy-go/middleware"
)

type resp struct {
    body string
    err  error
}

func middlewareForGetObject(r resp) func(*middleware.Stack) error {
    return func(stack *middleware.Stack) error {
        return stack.Finalize.Add(
            middleware.FinalizeMiddlewareFunc(
                "test",
                func(context.Context, middleware.FinalizeInput, middleware.FinalizeHandler) (middleware.FinalizeOutput, middleware.Metadata, error) {
                    return middleware.FinalizeOutput{
                        Result: &s3.GetObjectOutput{
                            Body: io.NopCloser(strings.NewReader(r.body)),
                        },
                    }, middleware.Metadata{}, r.err
                },
            ),
            middleware.Before,
        )
    }
}

func Test_GetObject(t *testing.T) {
    type args struct {
        bucket string
        key    string
    }
    tests := []struct {
        name    string
        args    args
        resp    resp
        want    []byte
        wantErr bool
    }{
        {
            name: "success",
            args: args{bucket: "Bucket", key: "Key"},
            resp: resp{body: "ok"},
            want: []byte("ok"),
        },
        {
            name:    "failure",
            args:    args{bucket: "Bucket", key: "Key"},
            resp:    resp{err: errors.New("object not found")},
            wantErr: true,
        },
    }
    for _, tt := range tests {
        t.Run(tt.name, func(t *testing.T) {
            ctx := context.TODO()

            cfg, err := config.LoadDefaultConfig(ctx,
                config.WithRegion("ap-northeast-1"),
                config.WithAPIOptions([]func(*middleware.Stack) error{middlewareForGetObject(tt.resp)}),
            )
            if err != nil {
                t.Fatal(err)
            }
            client := s3.NewFromConfig(cfg)

            out, err := client.GetObject(ctx, &s3.GetObjectInput{Bucket: &tt.args.bucket, Key: &tt.args.key})
            if (err != nil) != tt.wantErr {
                t.Errorf("GetObject() error = %v, wantErr %v", err, tt.wantErr)
                return
            }
            if tt.wantErr {
                return
            }

            got, _ := io.ReadAll(out.Body)
            if !bytes.Equal(tt.want, got) {
                t.Errorf("GetObject() = %q, want %q", got, tt.want)
            }
        })
    }
}