FirestoreとElasticSearchを組み合わせて 検索に強いFirebaseアプリを作る

import { IndicesCreateRequest, MappingTextProperty } from "@elastic/elasticsearch/lib/api/types";

export const reportIndexName = 'インデックスの名前';
const textParam:MappingTextProperty = {
  type: 'text',
  search_analyzer: 'ja_kuromoji_search_analyzer',
  analyzer: 'ja_kuromoji_index_analyzer',
  fields: {
    ngram: {
      type: 'text',
      search_analyzer: 'ja_ngram_search_analyzer',
      analyzer: 'ja_ngram_index_analyzer'
    },
    keyword: {
      type: 'keyword'
    }
  }
}
export const reportBody:IndicesCreateRequest = {
  index: reportIndexName,
  settings: {
    // 日本語の全文検索設定などを記述しますが長いのでここでは省略します
    // 詳しくはElasticSearchの全文検索ガイドを参照してください
    // https://www.elastic.co/jp/blog/how-to-implement-japanese-full-text-search-in-elasticsearch
  },
  mappings: {
    properties: {
      // ここからデータのスキーマ設定
      id: { type: 'keyword' },
      groupId: { type: 'keyword' },
      createTs: { type: 'unsigned_long' },
      owner: { type: 'keyword' },
      state: { type: 'keyword' },
      body: textParam, // 全文検索対応させる
      content: { type: 'keyword', index: false, doc_values: false } // firestoreのデータ丸コピ用。検索には使わないのでindex: falseを指定
    }
  }
}

async function makeElastic () {
  const esClient = new Client({
    cloud: {
      id: 'Elastic CloudだとCloudIDが割り当てられます。管理画面からクラウドIDを控えてここに書きます'
    },
    auth: {
      username: 'username。Elastic Cloudから確認できます',
      password: '同上'
    }
  })

  try {
    await esClient.indices.create(先程作ったスキーマJSON);
    console.info('○○○○ 成功 ○○○○');
  } catch (e) {
    console.error('XXXXXX 失敗 XXXXXX');
  }
}

import * as functions from 'firebase-functions';
import { ELASTIC_CLOUD_ID, ELASTIC_PW, ELASTIC_USER_NAME } from 'どこか遠いところからとってきて';
import { Client } from '@elastic/elasticsearch';
import { MYREPORT } from 'これは型定義ファイル（Nipoオリジナル)';
const client = new Client({
  cloud: { id: ELASTIC_CLOUD_ID },
  auth: {
    username: ELASTIC_USER_NAME,
    password: ELASTIC_PW
  }
})

/**
 * 例えば group/xxxxx/document/xxxxxのデータが変わったときに発火する
 */
export const esPushReport = functions.firestore.document('group/{groupId}/document/{documentId}').onWrite(async (change, context) => {
  const groupId = <string>context.params.groupId;
  const documentId = <string>context.params.documentId;

  const index = '先程作ったElasticのインデックス名';
  if (!change.after.exists) {
    // Firestoreからデータが削除された場合は、ElasticSearchからも削除しないといけません。
    await client.delete({ index: index, id: documentId });
    return;
  }

  const FSReport = <MYREPORT>change.after.data();

  const v = {
    index: index,
    id: documentId,
    document: {
      // ここでElasticSearchのスキーマに合うような形に変形させておきます。
      // FirestoreとElasticSearchは互換性がありそうで微妙に形が変わるのでそこだけ注意
      body: FSReport.body,
      content: JSON.stringify(FSReport)
    }
  }
  try {
    // Elasitic Searchへ書き込み処理
    await client.index(v);
  } catch (e) {
    functions.logger.error(e);
  }
})

import * as functions from 'firebase-functions';
import { DocumentReference, getFirestore } from 'firebase-admin/firestore';
import { Client } from '@elastic/elasticsearch';
import { authError, ELASTIC_CLOUD_ID, ELASTIC_PW, ELASTIC_USER_NAME } from '../_components/const';
import checkUserHogehoge from './check';
import { QueryDslQueryContainer, SearchRequest } from '@elastic/elasticsearch/lib/api/types';
import { CFQueryParam } from '../if';
import { FSGroup } from '@FRONT/if';

/**
 * クエリ実行の例。フロントからのリクエストで発動する。contextの中にはアクセス者のFirebaseIDなどが格納されているため、これらの情報を使い適切な権限を確認します
 */
export default functions.https.onCall(async(data, context) => {
  try {
    // 詳細は明かせませんが、起動直後に権限のチェックをしっかり行い、権限不足は速攻弾くような仕組みを作っておくと良いです。
    // Cloud Functionsはセキュリティルールを貫通してアクセスできるので特に念入りにチェックします
    await checkUserHogehoge({ context: context });
    if (result.result === false) { return result; }
  } catch (e) {
    return { error: true, message: 'あなたはふさわしくないわ' };
  }
  // 第一関門のセキュリティチェックを抜けたらElasticSearchに問い合わせする準備が始まります。
  const client = new Client({
    cloud: { id: ELASTIC_CLOUD_ID },
    auth: {
      username: ELASTIC_USER_NAME,
      password: ELASTIC_PW
    }
  })
  const elasticFilter:QueryDslQueryContainer[] = []
  // Elastic のクエリでFilterをセットします。例えばアクセス可能なユーザで絞り込むなど。
  // context.auth.uidは正しいIDであることが保証されるためFilterに使うことで安全性が高まります。
  // セキュリティルールが使えないので特に念入りに！
  elasticFilter.push({ term: { owner: context.auth?.uid } });
  // mustやshouldなど様々なクエリが使えます。今回は簡略のため空欄のままです。
  const must:QueryDslQueryContainer[] = [];
  const should:QueryDslQueryContainer[] = [];
  // 最終的にクエリの形になるように組み立てます。
  const query:SearchRequest = {
    // ここではdataのチェックを省いていますが、dataはフロントからのパラメータのため本当はちゃんと正しい値かチェックしたほうがよいです
    index: data.index,
    from: data.from,
    size: data.size,
    sort: data.sort,
    query: {
      bool: {
        filter: elasticFilter,
        must: must,
        should: should,
        must_not: data.mustNot
      }
    }
  }
  // Elasitic Searchへ問い合わせをします
  const esRes = await client.search(query);
  const returnVal = {
    total: esRes.hits.total,
    hits: esRes.hits.hits
  }
  // ElasticSearchの結果をフロントに返却します
  return returnVal;
})