こんにちは、ISSUEの寒河江です。

今回はfirestore×Golangを利用した場合のクエリオプションの設定方法についてご紹介します。firestoreのquery option引数というのは、`Limit`や`OrderBy`、`StartAfter`などfirestoreで提供されているqueryをオプションとしてまとめて実行クエリ関数の引数として渡すことを指しています。

## 利用しているライブラリ
firestoreにクエリを実行するGoのクライアントライブラリ
https://github.com/googleapis/google-cloud-go

最初に実装方法の結論を言うと下記になります。

## 結論
- firestoreのクエリをラッピングする
- Functional Options Patternを利用する
- クエリ実行前に、オプションを適用する`ApplyQuery`を実行する

クエリのを実行する関数
![img](/mosaic-code.jpg)

## firestoreのquery optionを実装した背景
元々、LimitやStartAfterはページネーション用に頻繁に利用していました。ただ、その度にmodelやinteractor用のinput(クリーンアーキテクチャを採用しています)などにoption用のstructを定義して引き回すのは冗長だなと感じていました。そこでオブションの定義をfirestoreパッケージに統一することにしました。


では、詳細な実装の流れをみていきます!

## firestoreのクエリをラッピングする


まずはfirestoreのラッパーを作成します。package名は`firestore`とします。
ちなみに[Functional Options Pattern](https://i-ssue.com/topics/a9f233eb-4507-4dba-97bd-6ec8ed8fdaf9#74)についてはこちらの記事でも触れているので先に読まれた方がわかりやすいかもしれません。

![img](/mosaic-code.jpg)

## Functional Options Patternを利用する

続いて、クエリをオプションで追加できるようにオプションを定義します。オプションには安全性、他のクエリオプションも増えていくことを見据えた拡張性、設定のしやすさからFunctional Options Patternを使いました。また、LimitとStartAfterをクエリとして追加しています。
![img](/mosaic-code.jpg)
他のクエリ、例えばOffsetなどを追加したい場合でも同様にオプション設定関数を定義するだけになります。
![img](/mosaic-code.jpg)

### ApplyQueryの追加
上記のクエリオプションを実際のfirestoreのクエリに適用する関数を定義します。

![img](/mosaic-code.jpg)

## クエリ実行前に、オプションを適用する`ApplyQuery`を実行する
準備は整いました！それではクエリオプションを使って、クエリを叩いてみます。

interactorからクエリの実行関数である`repository.List`にFunctional Options Patternでオプションを渡します。
![img](/mosaic-code.jpg)

![img](/mosaic-code.jpg)
こちらでしっかりオプションの内容が適用されたクエリが実行されます。

## オプションを指定しない場合
もちろん、オプションを指定しないクエリも書くことができます。下記はオプションを指定しないケースになります。主にinteractorの変更になります。
![img](/mosaic-code.jpg)

以上、firestoreのクエリオプションを設定についてです！
もっといい形があればさらに改良していこうと思います。

こんにちは、ISSUEの寒河江です。

今回はfirestore×Golangを利用した場合のクエリオプションの設定方法についてご紹介します。firestoreのquery option引数というのは、`Limit`や`OrderBy`、`StartAfter`などfirestoreで提供されているqueryをオプションとしてまとめて実行クエリ関数の引数として渡すことを指しています。

## 利用しているライブラリ
firestoreにクエリを実行するGoのクライアントライブラリ
https://github.com/googleapis/google-cloud-go

最初に実装方法の結論を言うと下記になります。

## 結論
- firestoreのクエリをラッピングする
- Functional Options Patternを利用する
- クエリ実行前に、オプションを適用する`ApplyQuery`を実行する

クエリのを実行する関数
```go
package database

import (
	"context"

	"github.com/pkg/errors"
	"google.golang.org/api/iterator"

	"github.com/.../domain/model"
	"github.com/.../infrastructure/customerr"

	"github.com/.../infrastructure/firestore"  // firestoreクエリのラッパー
	"github.com/.../usecase/repository"
)

func (r *userRepository) List(ctx context.Context, opts ...firestore.Option) ([]*model.User, error) {
	query := r.firebaseHandler.Collection("users").OrderBy("updateAt", firestore.Desc)
	
	// クエリオプションの適用(LimitやStartAfter)
	query = firestore.ApplyQuery(query, opts)
	
	iter := query.Documents(ctx)
	users := []*model.User{}
	for {
		doc, err := iter.Next()
		if err == iterator.Done {
			break
		}
		if err != nil {
			return nil, errors.Wrap(customerr.ErrFirestoreIterateAssign, err.Error())
		}

		user := &model.User{ID: doc.Ref.ID}
		if err := doc.DataTo(user); err != nil {
			return nil, errors.Wrap(customerr.ErrFirestoreObjectAssign, err.Error())
		}
		users = append(users, user)
	}
	return users, nil
}
```

## firestoreのquery optionを実装した背景
元々、LimitやStartAfterはページネーション用に頻繁に利用していました。ただ、その度にmodelやinteractor用のinput(クリーンアーキテクチャを採用しています)などにoption用のstructを定義して引き回すのは冗長だなと感じていました。そこでオブションの定義をfirestoreパッケージに統一することにしました。


では、詳細な実装の流れをみていきます!

## firestoreのクエリをラッピングする


まずはfirestoreのラッパーを作成します。package名は`firestore`とします。
ちなみに[Functional Options Pattern](https://i-ssue.com/topics/a9f233eb-4507-4dba-97bd-6ec8ed8fdaf9#74)についてはこちらの記事でも触れているので先に読まれた方がわかりやすいかもしれません。

```go
// 外部ライブラリcloud.google.com/go/firestoreのラッパー
// firestoreのクエリオプションを管理する
package firestore

import (
	"cloud.google.com/go/firestore"
)

type Query = firestore.Query

// ラッパーである本ファイル名前がぶつからないように定数についても定義し直してラッピングします。
const (
	Asc  = firestore.Asc  // Asc sorts results from smallest to largest.
	Desc = firestore.Desc // Desc sorts results from largest to smallest.
)
```

## Functional Options Patternを利用する

続いて、クエリをオプションで追加できるようにオプションを定義します。オプションには安全性、他のクエリオプションも増えていくことを見据えた拡張性、設定のしやすさからFunctional Options Patternを使いました。また、LimitとStartAfterをクエリとして追加しています。
```go
// 外部ライブラリcloud.google.com/go/firestoreのラッパー
// firestoreのクエリオプションを管理する
package firestore

import (
	"cloud.google.com/go/firestore"
)

type Query = firestore.Query

const (
	Asc  = firestore.Asc  // Asc sorts results from smallest to largest.
	Desc = firestore.Desc // Desc sorts results from largest to smallest.
)

//
// firestore query用のFunctional Options Pattern
//

// QueryOptions holds the state for the built up firestore query
type QueryOptions struct {
	limit      int 
	startAfter string
}

type Option func(*QueryOptions)

// BuildQueryOption returns QueryOptions built from the given arguments.
func BuildQueryOptions(opts ...Option) *QueryOptions {
	qo := &QueryOptions{}
	for _, o := range opts {
		o(qo)
	}
	return qo
}

// Limit the number of returned rows.
func Limit(limit int) Option {
	return func(o *QueryOptions) {
		o.limit = limit
	}
}

// StartAfter returns a new Query that specifies that results should start just after.
func StartAfter(stratAfter string) Option {
	return func(o *QueryOptions) {
		o.startAfter = startAfter
	}
}
```
他のクエリ、例えばOffsetなどを追加したい場合でも同様にオプション設定関数を定義するだけになります。
```go
func Offset(offset int) Option {
	return func(o *QueryOptions) {
		o.offset = offset
	}
}
```

### ApplyQueryの追加
上記のクエリオプションを実際のfirestoreのクエリに適用する関数を定義します。

```go
// 外部ライブラリcloud.google.com/go/firestoreのラッパー
// firestoreのクエリオプションを管理する
package firestore

import (
	"cloud.google.com/go/firestore"
)

type Query = firestore.Query

const (
	Asc  = firestore.Asc  // Asc sorts results from smallest to largest.
	Desc = firestore.Desc // Desc sorts results from largest to smallest.
)

// firestoreのQueryにQueryOptionsを適用する
func ApplyQuery(q firestore.Query, opts *QueryOptions) Query {
	if opts == nil {
		return q
	}

        // Limitの適用
	if opts.limit > 0 {
		q = q.Limit(opts.limit)
	}
        // StartAfterの適用
	if len(opts.startAfter) > 0 {
		q = q.StartAfter(opts.startAfter)
	}
	return q
}

・・・省略
```

## クエリ実行前に、オプションを適用する`ApplyQuery`を実行する
準備は整いました！それではクエリオプションを使って、クエリを叩いてみます。

interactorからクエリの実行関数である`repository.List`にFunctional Options Patternでオプションを渡します。
```go
package usecase

func (i *userInteractor) List(ctx context.Context, p *input.ListUsers) ([]*output.User, error) {
	dbUsers, err := i.userRepo.List(
		ctx,
		// 必要なfirestoreクエリオプション設定関数を渡す
		firestore.Limit(p.Limit),
		firestore.StartAfter(p.StartUpdateAt),
	)
	if err != nil {
		return nil, err
	}
}
```

```go
package repository

// ListIssues returns []*model.Issue.
func (r *userRepository) List(ctx context.Context, opts ...firestore.Option) ([]*model.User, error) {
	query := r.firebaseHandler.Collection("users").OrderBy("updateAt", firestore.Desc)  // ここはラッパーのfirestoreの定数Desc
	// optsからクエリの適用をする
	query = firestore.ApplyQuery(query, firestore.BuildQueryOptions(opts...))
	
	// クエリの実行
	iter := query.Documents(ctx)
	users := []*model.User{}
	for {
		doc, err := iter.Next()
		if err == iterator.Done {
			break
		}
		if err != nil {
			return nil, errors.Wrap(customerr.ErrFirestoreIterateAssign, err.Error())
		}

		user := &model.User{ID: doc.Ref.ID}
		if err := doc.DataTo(user); err != nil {
			return nil, errors.Wrap(customerr.ErrFirestoreObjectAssign, err.Error())
		}
		users = append(users, user)
	}
	return users, nil
}
```
こちらでしっかりオプションの内容が適用されたクエリが実行されます。

## オプションを指定しない場合
もちろん、オプションを指定しないクエリも書くことができます。下記はオプションを指定しないケースになります。主にinteractorの変更になります。
```go
package usecase

func (i *userInteractor) List(ctx context.Context, p *input.ListUsers) ([]*output.User, error) {
        // firestoreクエリオプションを渡さない
	dbUsers, err := i.userRepo.List(ctx)
	if err != nil {
		return nil, err
	}
}
```

以上、firestoreのクエリオプションを設定についてです！
もっといい形があればさらに改良していこうと思います。

利用

続きを読むには単価診断を受けてください（30秒）