はじめに

この記事はGo Advent Calender23日目の記事です。

ファイルパスを検索し結果をJSONで返すREST APIサーバーを立てます。
ひとまず動きのイメージを掴むデモです。

検索窓に検索キーワードを入力し、検索ボタンを押すとlocateコマンドを走らせて、結果をブラウザに表示します。

本記事はlocate-server v3.1.0の時点のREADMEを補完するドキュメントを記事としました。

この記事を読むために必要な知識を挙げます。

Go
- Gin
ShellScript
- locate
- updatedb
HTML5
JavaScript
- jQuery
- Ajax
Docker
- Docker Compose

どれも入門レベルの知識で済むと思います。

実行

前提条件

サーバーを立ち上げるホストマシンに下記パッケージが必要です。

mlocate
gocate

mlocateはlocate、updatedbを実行するパッケージです。
普通のLinuxディストリビューションには標準で入っていると思います。
gocate¹はlocate²とupdatedbコマンドを並列実行できるコマンドです。このlocate-serverのために自作しました。これのおかげで検索実行時間が20秒から4秒台に縮まりました。³

サーバーサイドの実行

Linuxファイルシステムの検索
/var/lib/mlocate にupdatedbまたは gocate -init で作成したデータベースファイルが既にある

とした場合

$ locate-server

だけで実行できます。

主なコマンドラインオプションをつけて説明すると、

$ locate-server \
  -dir /home/mydir/mlocate \  # XXX.dbが保存されているディレクトリの指定(default: /var/lib/mlocate)
  -trim '/mnt'             \  # ファイル名のprefixを削除します
  -root '\\ns\FileShare'   \  # ファイル名のprefixに追加します
  -windows-path-separate   \  # ファイルセパレータ'\'を使用します(default: false)

ショートオプションで縮めて書くと下記のようになります。

$ locate-server -d /home/mydir/mlocate -t '/mnt' -r '\\ns\FileShare' -s

クライアントサイドの実行

サーバーサイドでサーバーを立ち上げたら、クライアントはブラウザのURL欄に localhost:8080 と入力するとトップページが表示されます。

内部動作(サーバーサイド)

サーバーサイドの動作概要

ウェブブラウザからの入力で指定ディレクトリ下にあるファイル内の文字列に対してlocateコマンドを使用した正規表現検索を行い、結果をJSONにしてクライアントに送ります。
JSONを受け取ったクライアントは、static下に配置されたJavaScriptファイルでHTMLに変換して描画します。

ディレクトリ構造

パッケージのディレクトリ構造は次のようになります。

locate-server
├── main.go
├── cmd
│   ├── api
│   │   ├── api.go
│   │   ├── api_test.go
│   │   ├── query.go
│   │   └── query_test.go
│   ├── cache
│   │   └── cache.go
│   └── locater
│       ├── command.go
│       ├── command_test.go
│       ├── frecency.go
│       ├── frecency_test.go
│       ├── locater.go
│       └── locater_test.go
├── static
│   ├── datalist.js
│   ├── main.js
│   ├── locater.js
│   ├── icons8-検索-50.png
│   ├── search-location-solid.png
│   ├── style.css
│   └── tooltips.js
├── templates
│   └── index.tmpl
├── test
├── Dockerfile
└── docker-compose.yml

ページの表示

main.go

import (
	/* snip...*/
	"github.com/gin-gonic/gin"  //...(1)
)

func main() {

	/* snip...*/

	// Open server
	route := gin.Default()
	route.Static("/static", "./static")  //...(2)
	route.LoadHTMLGlob("templates/*")  //...(3)

	// Top page
	route.GET("/", topPage)  //...(4)

	// Result view
	route.GET("/search", searchPage)  //...(4)

	// API
	route.GET("/history", fetchHistory)  //...(5)
	route.GET("/json", fetchJSON)  //...(6)
	route.GET("/status", fetchStatus)  //...(7)

	// Listen and serve on 0.0.0.0:8080
	route.Run(":" + strconv.Itoa(port)) // => :8080 ...(8)
}

フレームワークにginを採用しています。
css, JavaScript, favicon用pngファイルはstaticに置いてあります。
トップページの表示はtemplates/index.htmlにgin.H{}構造体の内容を埋め込んで表示します。
トップページと検索ページは結果の表示がされているかどうかだけで、同じテンプレートを使用します。
APIを今のところ3つ用意しています。いずれもGETメソッドです。/historyは検索履歴をFrecencyスコア順にしてJSONで取得します。
/jsonはlocate検索を走らせて検索結果をJSONで取得します。
/statusはDBのlocate -Sの出力をJSONで取得します。
デフォルトでは8080ポートでサーバーを公開します。

template/index.tmpl

<html>
    <head>
		<!-- snip -->
    </head>
    <body>

		<!-- 1 -->

      <!-- GET method URI-->
      <form name="form1" method="get" action="/search">
        <a href=/ class="fas fa-home" title="Locate Server Home"></a>
        <!-- 検索窓 -->
        <input type="text" name="q" value="{{ .query }}" size="50" list="search-history" placeholder="検索キーワードを入力">
        <!-- 検索履歴 Frecency リスト -->
        <datalist id="search-history"></datalist>
        <!-- 検索ボタン -->
        <input type="submit" id="submit" value="&#xf002;" class="fas">
        <input type="button" onclick="toggleMenu('hidden-explain')" value="&#xf05a;" class=fas title="Help"> <!--// Help折りたたみ展開ボタン -->
      </form>

		<!-- snip -->

		<!-- 2 -->

      <!-- Database status -->
      <div id="search-status">
        <b><a href=/status>DB</a> last update: {{ .lastUpdateTime }}</b><br>
      </div>

		<!-- 3 -->

      <!-- Search result -->
      <div class="loader-wrap">
        <div class="loader">Loading...</div>
      </div>
      <table id="result"></table>
      <div id="error-view"><div>


		<!-- 4 -->

    <script src="https://ajax.googleapis.com/ajax/libs/jquery/3.5.1/jquery.min.js"></script>
    <script type="text/javascript" src="/static/locater.js"></script>
    <script type="text/javascript" src="/static/main.js"></script>
    <script type="text/javascript" src="/static/tooltips.js"></script>
    <script type="text/javascript" src="/static/datalist.js"></script>
  </body>
</html>

検索フォームです。/search?q=キーワードのページに飛びます。
DBのステータス表示です。
検索結果とエラーを表示します。ページを読み込むまで、ロードスピナーが回ります。
使用するJavaScriptファイルです。

検索結果を返すページ

ユーザーが主にアクセスするページです。
topPage()はsearchPage()の簡略版なので、省略します。

main.go/searchPage()

func searchPage(c *gin.Context) {
	// 検索文字数チェックOK
	/* LocateStats()の結果が前と異なっていたら
	locateS更新
	cacheを初期化 */
	if l, err := cmd.LocateStats(locater.Dbpath); string(l) != string(locateS) {  //...(1)
		// DB更新されていたら
		if err != nil {
			log.Error(err)
		}
		locateS = l // 保持するDB情報の更新
		// Initialize cache
		// nil map assignment errorを発生させないために必要
		caches = cache.New() // Reset cache ...(2)
		// Count number of search target files
		var n int64
		n, err = cmd.LocateStatsSum(locateS)
		if err != nil {
			log.Error(err)
		}
		locater.Stats.Items = cmd.Ambiguous(n)  //...(3)
		// Update LastUpdateTime for database
		locater.Stats.LastUpdateTime = cmd.DBLastUpdateTime(locater.Dbpath)  //...(3)
	}
	// Response
	q := c.Query("q")
	c.HTML(http.StatusOK, "index.tmpl", gin.H{  //...(4)
		"title":          q,
		"lastUpdateTime": locater.Stats.LastUpdateTime,
		"query":          q,
	})
}

locate -Sの結果が検索前と異なっていないかのチェックです。異なる場合、DBが更新されたので、2,3の処理を行います。
キャッシュをリセットします。
DBのファイル数、DBの更新時間を再取得します。
タイトルと更新時間と、ページ遷移前に検索窓に入力された文字列を検索窓に再入力してページを表示します。

検索結果を返すAPIの実装

main.go/json

func fetchJSON(c *gin.Context) {
	// locater.Query initialize
	// Shallow copy locater to local
	// for blocking to rewrite
	// locater{} struct while searching
	local := locater  //...(1)

	// Parse query
	query, err := api.New(c)  //...(2)
	local.Query = api.Query{
		Q:       query.Q,
		Logging: query.Logging,
		Limit:   query.Limit,
	}

	/* snip...*/

	local.SearchWords, local.ExcludeWords, err = api.QueryParser(query.Q)  //..

	/* snip...*/

	// Execute locate command
	start := time.Now()  //...(3)
	result, ok, err := caches.Traverse(&local) // err <- OS command error ...(4)
	/* snip...*/
	end := (time.Since(start)).Nanoseconds()  //...(3)
	local.Stats.SearchTime = float64(end) / float64(time.Millisecond)

	// Response & Logging
	if err != nil {
		log.Errorf("%s [ %-50s ]", err, query.Q)
		c.JSON(500, local)
		// 500 Internal Server Error
		// 何らかのサーバ内で起きたエラー
		return
	}
	local.Paths = result
	getpushLog := "PUSH result to cache"
	if ok {
		getpushLog = "GET result from cache"
	}
	if !query.Logging {
		getpushLog = "NO LOGGING result"
	}
	l := []interface{}{len(local.Paths), local.Stats.SearchTime, getpushLog, query.Q}  //...(6)
	log.Noticef("%8dfiles %3.3fmsec %s [ %-50s ]", l...)  //...(6)
		if len(local.Paths) == 0 {
			local.Error = "no content"
			c.JSON(204, local)  //...(7)
			// 204 No Content
			// リクエストに対して送信するコンテンツは無いが
			// ヘッダは有用である
			return
		}
		c.JSON(http.StatusOK, local)  //...(7)
		// 200 OK
		// リクエストが正常に処理できた
	}
}

global変数locaterをshallow copyしてlocalに代入します。関数の引数として与えられればわざわざこんな行は必要ないのですが、route.GET()関数に渡せるのは関数のみですので、どうしたらいいやら。クロージャ使えばいいのか？
Query構造体を、gin.Contextを基に、ページのコンテキストから取得します。(後述)
コマンド実行時間の計測を行い、ミリ秒で返します。
キャッシュの中を検索し、検索結果があればresultに結果を入れて、okにtrueが入ります。キャッシュ内に検索結果がなければ、locate(gocate)コマンドを実行して、resultに検索結果を格納し、okにfalseが入ります。この一行が"検索サーバー"としてのメインの仕事を担います。(後述)
logに表示する奴らをまとめています。型がバラバラなので、[]interfaceを使います。
log表示です。URLに&logging=falseを指定すると後述する検索履歴のスコアに加算されないようにしてログへ記録します。ログへ記録することが検索履歴のスコアへ影響を及ぼすため、テスト用または今後実装する機能のためにログへの記録制御を行います。
検索結果、クエリ制御、エラー等々ひっくるめてLocate構造体に入れて、JSONオブジェクトを返します。

cmd/api/query.go

type (
	// Query : URL で指定されてくるAPIオプション
	Query struct {  //...(2)
		Q       string `form:"q"`       // 検索キーワード,除外キーワードクエリ
		Logging bool   `form:"logging"` // LOGFILEに検索記録を残すか default ture
		// 検索結果上限数
		// LimitをUintにしなかったのは、head の-nオプションが負の整数も受け付けるため。
		// 負の整数を受け付けた場合は、-n=-1と同じく、制限なしに検索結果を出力する
		Limit int `form:"limit"`
	}
)

// New : Query constructor
// Default value Logging: ture <= always log search query
//									if ommited URL request &logging
// Default value Limit: -1 <= dump all result
//									if ommited URL request &limit
func New(c *gin.Context) (*Query, error) {
	query := Query{Logging: true, Limit: -1}  //...(2)
	err := c.ShouldBind(&query)  //...(1)
	return &query, err
}

Query構造体を、gin.Contextを基に、ページのコンテキストから取得します。
構造体を指定してから、gin.Context.ShouldBind()を使うと、boolianやint型を類推して構造体に当てはめてくれるので、strconv.Atoi()とかしなくて済むので大変楽です。

cmd/cache/cache.go

type (
	// Map is normalized queries key and PathMap value pair
	Map map[Key]*cmd.Paths
	// Key : cache Map key
	Key struct {
		Word  string // Normalized query
		Limit int    // Number of results
	}
)

// Traverse : 検索結果をcacheの中から探し、あれば検索結果と検索数を返し、
// なければLocater.Cmd()を走らせて検索結果と検索数を得る
func (cache *Map) Traverse(l *cmd.Locater) (paths cmd.Paths, ok bool, err error) {
	w := cmd.Normalize(l.SearchWords, l.ExcludeWords)  //...(1)
	k := Key{w, l.Query.Limit}  //...(1)
	if v, ok := (*cache)[k]; !ok {  //...(2)
		// normalizedがcacheになければresultsをcacheに登録
		paths, err = l.Locate()  //...(3)
		(*cache)[k] = &paths  //...(3)
	} else {
		paths = *v  //...(4)
	}
	return
}

検索語(SearchWords)と除外語(ExcludeWords)を正規化(Normalize)して、MapのKeyとします。
cacheからキーワードkを探します。
結果がなければlocate(gocate)コマンドで検索し、pathsをcacheに登録して返します。(後述)
結果があればその値vをpathsとして返します。

cmd/locater/locater.go

// Locate excute locate (or gocate) command
// split from Locater.Cmd()
func (l *Locater) Locate() (Paths, error) {
	out, err := pipeline.Output(l.CmdGen()...)  //...(1)
	outslice := strings.Split(string(out), "\n")  //...(1)
	outslice = outslice[:len(outslice)-1] // Pop last element cause \\n
	return outslice, err
}

// CmdGen : shell実行用パイプラインコマンドを発行する
func (l *Locater) CmdGen() (pipeline [][]string) {
	locate := []string{  //...(2)
		"gocate",               // locate command path
		"--database", l.Dbpath, //Add database option
		"--",            // Inject locate option
		"--ignore-case", // Ignore case distinctions when matching patterns.
		"--quiet",       // Report no error messages about reading databases
		"--existing",    // Print only entries that refer to files existing at the time locate is run.
		"--nofollow",    // When  checking  whether files exist do not follow trailing symbolic links.
	}
	// -> gocate --database -- --ignore-case --quiet --regex hoge.*my.*name

	// Include PATTERNs
	// -> locate --ignore-case --quiet --regex hoge.*my.*name
	locate = append(locate, "--regex", strings.Join(l.SearchWords, ".*"))  //...(3)

	pipeline = append(pipeline, locate)

	// Exclude PATTERNs
	for _, ex := range l.ExcludeWords {
		// COMMAND | grep -ivE EXCLUDE1 | grep -ivE EXCLUDE2
		pipeline = append(pipeline, []string{"grep", "-ivE", ex})  //...(4)
	}

	// Limit option
	if l.Query.Limit > 0 {
		pipeline = append(pipeline, []string{"head", "-n", strconv.Itoa(l.Query.Limit)})  //...(5)
	}

	if l.Args.Debug {
		log.Debugf("Execute command %v", pipeline)
	}
	return  // => locate ... | grep -ivE ... | head -n ... ...(6)
}

l.CmdGen()でコマンド文字列の生成を行い、locate(gocate)コマンドを実行します。pipeline.Output()の結果は[]byteで返ってくるので、[]stringに変えて返却します。
locate(gocate)コマンドの文字列を生成します。構造体の定義は常時つくオプションです。
l.SearchWordsはSliceなので、locateに渡せるように".*"を挟みます。
除外するキーワードをgrep -vで排除します。-iでignore case, -Eで正規表現。
出力行数をhead -nで制御します。テスト環境(Linux上のDocker)ではうまくいって、本番環境(Windows上のDocker)でうまく動いていないような...。gocateを改造して--limitオプション付けるか思案中。
最終的にコマンドラインに入力する文字列 `locate "検索語" | grep -ivE "除外語" | head -n "結果上限数" を返します。

検索履歴のスコアを返すAPIの実装

/historyで返す検索履歴を解析し、frecencyスコア算出、その順序でJSONオブジェクトにして返します。
スコアはfrecency(frequently 頻繁に + recency 最近のからなる造語)を算出します。、

main.go/history

route.GET("/history", func(c *gin.Context) {
	searchHistory, err := cmd.Datalist(LOGFILE)  //...(1)
	/* snip...*/
	c.JSON(http.StatusOK, searchHistory)
})

frecency.go

// Scoring : 日時から頻出度を算出する
func Scoring(t time.Time) int {  //...(2)
	since := time.Since(t).Hours()
	switch {
	case since < 6:
		return 32
	case since < 24:
		return 16
	case since < 24*7:
		return 8
	case since < 24*14:
		return 4
	case since < 24*28:
		return 2
	default:
		return 1
	}
}

//ScoreSum : 履歴マップの検索日時リストからスコア合計を算出する
func ScoreSum(tl []time.Time) (score int) {
	for _, t := range tl {  //...(3)
		score += Scoring(t)  //...(3)
	}
	return
}

LOGFILEを解析して、frecencyスコア順で返します。詳細はcmd/locater/frecency.goを参照してください。
スコアの参照は現在時刻からの経過時間(Hour単位)でスコアを出します。
検索回数分足し算します。

main.go/status

func fetchStatus(c *gin.Context) {
	l, err := cmd.LocateStats(locater.Args.Dbpath) // err <- OS command error ...(1)
	ss := strings.Split(string(l), "\n")  //...(4)
	/* snip...*/
	c.JSON(http.StatusOK, gin.H{  //...(5)
		"locate-S": ss,
		"error":    err,
	})
}

command.go

// LocateStats : Result of `locate -S`
func LocateStats(s string) ([]byte, error) {
	dbs, err := filepath.Glob(s + "/*.db")  //...(2)
	if err != nil {
		return []byte{}, err
	}
	d := strings.Join(dbs, ":")  //...(3)
	b, err := exec.Command("locate", "-Sd", d).Output()  //...(3)
	// => locate -Sd /var/lib/mlocate/db1.db:/var/lib/mlocate/db2.db:...
	if err != nil {
		return b, err
	}
	return b, err
}

LocateStats()を実行してlocate -Sの結果を得ます。
dbファイルを列挙します。
":"でつなげて locate -Sd /var/lib/mlocate/db1.db:/var/lib/mlocate/db2.db:... のように実行します。
[]byte型なので、stringにし、改行で区切ってsliceとします。
4の結果をJSONにして送ります。

API

説明	メソッド	URI	パラメータ
ファイルパスを検索する	GET	/json	q=, logging=, limit=
検索履歴を見る	GET	/history	gt=, lt=
DBの状態確認	GET	/status	なし

サーバーを立ち上げた状態で

$ curl -fsSL localhost:8080/json?q=usr+bin+sh&limit=10&logging=false

とすると、

検索上限数10
Frecency スコアに影響しないログ出力
gocate -- --regex 'usr.*bin.*sh' (細かいオプションは省略)

上記の条件で検索した結果をJSONにして標準出力に表示します。

内部動作(クライアントサイド)

~~初めての~~フロントエンド開発していきます。

クライアントサイドの動作概要

検索

ユーザーはトップページから検索ボタンをクリックすると/searchページに飛びます。

ここまではサーバーサイドmain.goに書かれていること。
/searchページに飛ぶとmain.jsのmain()が走ります。
JavaScriptでJSONをパースします。

JavaScriptPrimer 第2部/Ajax通信を参考にしました。

main.js

function main(){
  const url = new URL(window.location.href);
  fetchSearchHistory(url.origin + "/history");
  const query = url.searchParams.get("q");
  if (query){  // queryがなければ終了,あればサーバーからJSON呼び出し
    fetchJSONPath(url.href.replace("search", "json"));  //...(1)
  }
}

URLのsearchをjsonに変えて、/json APIをたたきます。

検索キーワードサジェスト機能

検索履歴を検索フォームに入れて以前の検索キーワードを探しやすくします。

main.js

function main(){
  const url = new URL(window.location.href);
  fetchSearchHistory(url.origin + "/history");  //...(1)
  const query = url.searchParams.get("q");
  if (query){  // queryがなければ終了,あればサーバーからJSON呼び出し
    fetchJSONPath(url.href.replace("search", "json"));
  }
}

async function fetchSearchHistory(url){
  try{
    const history = await fetchLocatePath(url);
    // 検索キーワード履歴のdatalist <id=search-history>を埋める
    history.forEach((h) =>{
      $("#search-history").append("<option>" + h.word + "</option>");  //...(2)
    });
  } catch(error) {
    console.error(`Error occured (${error})`); // Promiseチェーンの中で発生したエラーを受け取る
  }
}

datalist.js

$("q").on('input', function () {  //...(3)
    var val = this.value;
    if($('#searched-words option').filter(function(){
        return this.value.toUpperCase() === val.toUpperCase();
    }).length) {
        //send ajax request
        alert(this.value);
    }
});

history APIをたたき、検索履歴をJSONで取得します。
検索キーワード候補を検索窓に埋め込みます。(キーワード補完、「もしかして」機能)
一文字打つたびに、検索履歴をFrecency スコア順に表示します。

検索結果の遅延表示

ページ下部付近にくると検索結果を100件ごとに表示します。
なぜ遅延させているかというと、JavaScriptの正規表現が遅いことと、検索結果件数(1~数万件)によってページ読み込み時間が大幅に変わってきてしまうためです。
100件ごとに正規表現ハイライトすれば、待たされる感覚がなくなります。

main.js

async function fetchJSONPath(url){
  try {
    const locaterJSON = await fetchLocatePath(url);
    const locater = new Locater(locaterJSON);  //...(1)
		/* snip...*/
    if (!locater.error) {
			/* snip...*/
      // Rolling next data
      let n = 0;
      const shift = 100;
      locater.lazyLoad(n, shift);  //...(2)
      $(window).on("scroll", function(){ // scrollで下限近くまで来ると次をロード  //...(2)
        const inner = $(window).innerHeight();
        const outer = $(window).outerHeight();
        const bottom = inner - outer;
        const tp = $(window).scrollTop();
        if (tp * 1.05 >= bottom) {
          //スクロールの位置が下部5%の範囲に来た場合
          n += shift;
          locater.lazyLoad(n, shift);  //...(2)
        }
      });
    } else {
      console.error("error: ", locater.error);
      const err = document.getElementById("error-view");
      err.innerHTML = "<p>" + locater.error + "</p>";
    }
  // 今のところcatchする例外発生ない
  } catch(error) {
    console.error(`Error occured (${error})`); // Promiseチェーンの中で発生したエラーを受け取る
  }
}

locater.js

class Locater {  //...(1)
  constructor(json){
    this.args = json.args;  // command line argument
    this.query = json.query;  // API args
    this.searchWords = json.searchWords;  // search word for searching
    this.excludeWords = json.excludeWords;  // exclude word for searching
    this.paths = json.paths;  // result of locate command
    this.stats = json.stats;  // stats info at database
    this.error = json.error; // Error message
  }
  /* snip...*/

/json APIを非同期に実行し、クラス構文でlocaterを生成します。
locater.lazyLoad()では100件ずつ(n~n+100件)の行をリンクとしてHTMLテンプレートのid=resultに追加していきます。

locater.js/Locater.lazyLoad()

// 検索パス表示
lazyLoad(n, shift){
	const folderIcon = '<i class="far fa-folder-open" title="クリックでフォルダを開く"></i>';  //...(1)
	const sep = this.args.pathSplitWin ? "\\" : "/";
	const dataArray = this.paths.slice(n, n + shift);  //...(2)
	dataArray.forEach((p) =>{  //...(2)
		const modified = this.pathModify(p);  //...(3)
		const highlight = this.highlightRegex(modified);  //...(4)
		const dir = Locater.dirname(modified, sep);  //...(5)
		let result = `<a href="file://${modified}">${highlight}</a>`;
		result += `<a href="file://${dir}"> ${folderIcon} </a>`;
		$("#result").append("<tr><td>" + result + "</td></tr>");
	});
}

フォルダ―アイコンはFont Awesomeからフリーの物を選びました。
n~n+shift件ずつ処理します。関数呼び出し時に0~100, 100~200, ... と増えていきます。(sliceだから0~99件目、の処理か。)
(指定されていれば)パスのプレフィックスを追加、削除、パスセパレートをUNIX式からWindows式に変更します。
正規表現を用いて、検索ワードの背景を黄色くします。前方一致でハイライトしていますので、locateコマンドのマッチとは差異があります。(既知のバグ)
ファイルの親ディレクトリをフォルダ―アイコンのリンクに指定します。
id=resultに追加していきます。

デプロイ

Docker, Docker Composeを使用しています。

Dockerfile

FROM golang:1.17.0-alpine3.14 AS go_official  #...(1)
RUN apk --update --no-cache add git &&\
    go install github.com/u1and0/gocate@v0.3.0  #...(2)
WORKDIR /go/src/github.com/u1and0/locate-server
# For go module using go-pipeline
ENV GO111MODULE=on
COPY ./main.go /go/src/github.com/u1and0/locate-server/main.go
COPY ./go.mod /go/src/github.com/u1and0/locate-server/go.mod
COPY ./go.sum /go/src/github.com/u1and0/locate-server/go.sum
COPY ./cmd /go/src/github.com/u1and0/locate-server/cmd
RUN go build -o /go/bin/locate-server

FROM frolvlad/alpine-glibc:alpine-3.14_glibc-2.33  #...(3)
RUN apk --update --no-cache add mlocate tzdata
WORKDIR /var/www  #...(4)
COPY --from=go_official /go/bin/locate-server /usr/bin/locate-server  #...(5)
COPY --from=go_official /go/bin/gocate /usr/bin/gocate  #...(5)
COPY ./static /var/www/static  #...(4)
COPY ./templates /var/www/templates  #...(4)
ENTRYPOINT ["/usr/bin/locate-server"]

multistage buildでlocate-serverのバイナリをbuildします。
依存性のあるgocateもインストールします。
実行するコンテナを作成します。glibcありにしないとgo buildでエラー吐きます。⁴
HTML, CSS, JS ファイルをコピーします。コマンドの実行ディレクトリと同じ場所にする必要があります。(同じ場所にしないとtemplateが見つからないエラー)
goのバイナリをビルドコンテナからコピーしてきます。

docker-compose.yml(一例)

version: "3"
services:
    web:
        # image: u1and0/locate-server:latest  #...(1)
        build:  #...(1)
            context: .
        ports:
          - 8081:8080
        volumes:
            - db:/var/lib/mlocate  #...(2)
        environment:
            - TZ=Asia/Tokyo
        working_dir: /var/www
        entrypoint: /usr/bin/locate-server
        # command: ["-debug"]  #...(3)

    db:
        image: busybox
        volumes:
            - /var/lib/mlocate:/var/lib/mlocate  #...(2)

    app:
        build:
             context: ./app
        volumes:
            - db:/var/lib/mlocate  #...(2)

volumes:
    db:

サービス名	説明
web	locate-server実行コンテナ
db	appとwebが共有するデータベースコンテナ
app	updatedbをcronで実行するコンテナ

イメージをpullするか、git cloneした後のDockerfileからイメージを作成します。
webとappで共有するフォルダを指定します。
webコンテナのentrypointが/usr/bin/locate-serverなので、locate-serverのオプションはcommandに追記します。

appコンテナはホストマシンでupdatedbを行うなら不要です。
そうするとdbも不要です。直接ホスト上の/var/lib/mlocateディレクトリでもマウントしておけばいいわけですので。

web:
    volumes:
        - /var/lib/mlocate:/var/lib/mlocate

appコンテナでupdatedbを定期実行させていても、dbコンテナは不要かも、と考えるかもしれません。
appにもwebにも直接ホスト上の/var/lib/mlocateディレクトリをマウントしておけばいいわけですので。

web:
    volumes:
        - /var/lib/mlocate:/var/lib/mlocate

app:
    volumes:
        - /var/lib/mlocate:/var/lib/mlocate

しかしながら、私の本番環境ではWindows上のVirtualboxでDockerコンテナ立てています。
ホスト上のntfs形式のディレクトリにdb置いたら検索がとてつもなく遅くなってしまったので、あえてdb置く場所はコンテナ上にしております。

インストール

Dockerを使えない場合は、go install ⁴

$ go install github.com/u1and0/locate-server@latest

補足

上記説明で触れなかったユースケースを箇条書きで示します。

Google検索のローカルファイル検索版を目指して作りました。
- シンプルな検索フォームだけのデザイン
- 検索結果のキャッシュ
- 他人の検索結果を表示できるようにする機能(「もしかして」機能)
ローカルファイルを開く機能はブラウザに備えられていませんので、拡張機能が必要です。
- せっかくのRESTFUL APIサーバー、JSONをパースできればなんでもいいので、クライアントサイドは別途デスクトップアプリを作るか。
  - ﾍｲｼｬは~~古臭い~~厳しいので、勝手に色々インストールするのはダメなんです。拡張機能はグレーゾーン。
  - IE対応はlocate-server version 2.Xまで。REST APIサーバー化すると、ECMAScriptが扱えなくてIEでは表示できません。
社内用の共有ファイルサーバーのファイル数が多すぎ、探すのメンドすぎなので、作りました。
- WindowsユーザーにLinuxの機能を使ってもらう方針から、クライアントサイドのインターフェースはブラウザ(API)、サーバーサイドはVirtualboxを挟んだDockerコンテナでの運用をメインに考えて作りました。
本番環境での検索時間は4-6秒(ファイル数600万件, ntfs形式,おそらくサーバーのドライブはHDD)ですが、体感もっと早くしたいです。locateコマンドは標準出力に逐次結果を表示しているので、Ajaxで非同期に結果を表示できないのか？できるでしょ？
キャッシュを使うとDBを検索せず、メモリにアクセスするだけなので、マイクロ秒オーダーで検索結果を返せます。(リソースも使わないのでエコ)
- だからキャッシュ機能と「もしかして」機能をなるべく使わせるように作りこむのです。改良点。
- キャッシュはlocate-server起動時、DB更新時にリセットされます。リセットされたら検索履歴から再検索してキャッシュを再生成しておく機能なんかも思案中。(commit 914b756)

まとめ

locateコマンドを実行するサーバーとして、Go言語の入門中に思いついたことですが、実現してみるとぜひ他人(特に非エンジニア)に使ってもらいたいツールになりました。
このコードを最小化して、Linuxコマンドの実行結果をブラウザに表示(JSONで返す)というフレームワークとして捉えて⁵やると、ファイル検索以外にも用途⁶がありそうですね。

下記、サーバーマシンのホスト名をブラウザに表示するサーバーを立ち上げるサンプルです。
わずか17行、import文とか除くとたった8行で書けてしまうんです。

main.go

package main

import (
	"fmt"
	"os/exec"

	"github.com/gin-gonic/gin"
)

func main() {
	router := gin.Default()
	name, _ := exec.Command("whoami").Output()  // 任意のコマンドを実行
	router.GET("/hello", func(c *gin.Context) {
		c.String(200, fmt.Sprintf("Hello World! My name is %s", name))
	})
	router.Run(":8080")
}

locateコマンドについて詳細をつめた際、制作したドキュメントです。あなたの知らないlocateの世界 ↩
gocateコマンドについて詳細をつめた際、制作したドキュメントです。並列実行できるlocateコマンドの実装 ↩
たぶんファイルシステムがntfsではなくext4だったらlocateでも十分速いと思います。テスト環境(Linux)でほぼ同数のファイル検索に10秒以上かかったことがありません。テスト環境のドライブがHDDではなくSSDであることも起因しているかもしれません。テスト環境のCPUスレッド数が6に対して、本番環境(Windows)のスレッド数が24あるので、並列実行できるプロセス数は本番環境のほうが多いはずですが、パフォーマンスは本番環境のほうが悪いです。 ↩
CGO_ENABLED=0 go buildとすればエラー吐きません。 ↩ ↩²
locate, gocateコマンドを別のコマンドに変えてしまえば良いだけです。 ↩
grep検索するサーバーとかね ↩