[Firebase] Cloud Functions로 Algolia와 Firestore 연동하기

 

 

안녕하세요 Foma 입니다!

 

오늘은 Cloud Functions 을 이용해서 Firestore 데이터베이스와 Algolia의 인덱스를 연동하는걸 정리해보겠습니다.

 

이번 글에서는 클라우드 펑션 기본세팅과 알고리아 기본세팅이 필요하므로 

 

클라우드 펑션세팅은 여기 에서 알고리아 기본세팅은 여기 에서 먼저 보고 와주세요~

 

바로 시작할게요~

---

Pod

 

먼저 Algolia와 Cloud Function과 Firestore를 코코아팟에 추가해주세요.

 

 pod 'AlgoliaSearchClient', '~> 8.0'
  
 pod 'Firebase/Functions'
 
 pod 'Firebase/Firestore'

 

 

터미널에서 functions로 이동후 npm으로 알고리아를 설치해줍니다.

 

cd functions
npm install algoliasearch

 

Algolia 대쉬보드로 들어가 앱 이름과 API키를 저장해줍니다.

 

Site Search & Discovery powered by AI

 

터미널에 앱이름과 어드민 APIKEY를 적어줍니다.

firebase functions:config:set algolia.app="앱이름" algolia.key="어드민APIKEY"

 

성공적으로 완료됐다면 아래와 같이 출력될거에요!

 

---

Visual Studio

 

비쥬얼 스튜디오에서 해당 프로젝트의 functions 파일로 들어가 index.js 파일을 열어주세요!

 

아래와 같이 기본 세팅을 해줍니다.

//클라우드 펑션 세팅
const functions = require("firebase-functions");

//어드민 세팅
const admin = require('firebase-admin');

//알고리아 세팅
const algoliasearch = require('algoliasearch');

//알고리아 앱아이디
const APP_ID = functions.config().algolia.app;

//알고리아 어드민키
const ADMIN_KEY = functions.config().algolia.key;

//알고리아 클라이언트 세팅
const client = algoliasearch(APP_ID, ADMIN_KEY);

//알고리아 인덱스 이름 세팅
const index = client.initIndex('인덱스 이름');

//어드민을 파이어스토어로 세팅
admin.initializeApp(functions.config().firestore);

 

생성되었을때

 

(아파트 관련 데이터를 관리하고 있어서 Apart 도큐먼트로 지정했지만 컬렉션이름/{컬렉션이름 + Id}로 해주시면 됩니다.)

 

exports.onApartsCreated = functions.firestore.document("Apart/{ApartId}").onCreate((snap, context) => {
    const apart = snap.data();
    const objectID = snap.id;
    index.saveObject({ ...apart, objectID });
});

 

수정되었을때

 

exports.onApartUpdated = functions.firestore.document("Apart/{ApartId}").onUpdate((snap, context) => {

    const apart = snap.after.data();
    const objectID = snap.after.id;
    index.saveObject({ ...apart, objectID });
});

삭제되었을때

 

exports.onApartDeleted = functions.firestore.document("Apart/{ApartId}").onDelete((snap, context) => {

    const id = snap.id;
    index.deleteObject(id);
});

 

함수배포

 

위와 같이 생성,수정,삭제 되었을때 함수를 만들어주시고 파이어베이스에 함수를 배포해줍니다.

 

터미널에 아래와 같이 입력합니다.

firebase deploy --only functions

(혹시 다음과 같은 에러가 뜨시는 분들은 .eslintrc.js 파일을 삭제하고 eslint를 다시 만들어주세요. 이게 맞는 방법인지는 모르겠으나 전 해결되었습니다....)

 

--eslint init

 

오류가 나신 분들은 다음과 같이 세팅해주세요.

 

 

성공적으로 함수가 배포되었다면 아래와 같이 Deploy complete가 나오고 프로젝트 콘솔 주소가 나옵니다.

 

---

Firebase Console

 

파이어베이스 콘솔로 이동합니다.

 

Cloud Functions 탭에 보면 성공적으로 3개의 함수가 올라가있는걸 볼 수 있습니다!

 

위 함수들은 파이어스토어에서 생성,수정,삭제되었을때 알아서 실행될거에요.

 

---

Xcode

 

이제 프로젝트로 이동해서 파이어스토어에 데이터를 작성해봅시다.

 

파이어스토어를 import 해주시고

import FirebaseFirestore

 

생성

 

Firestore에 문서를 생성합니다.

 

    Firestore.firestore().collection("Apart").addDocument(data: ["aptName":"한사랑아파트"])

 

Apart 컬렉션에 데이터가 생기고

 

 

 

Functions의 로그탭을 가서 확인해보면

 

 

Apart가 생성되었을때의 함수가 실행되는 것을 볼 수 있습니다.

 

 

 

또한 Algolia에 Indicies로 가면 Apart 인덱스가 생기고 해당 오브젝트가 생성된걸 볼 수 있습니다.

 

 

수정

 

파이어스토어에서 해당 문서의 아파트 이름을 장미아파트로 바꿔보겠습니다.

 

 Firestore.firestore().collection("Apart").document("Gsw0Qg39ZZsXuIcgAUGq").updateData(["aptName":"장미아파트"])

 

파이어스토어에서 아파트 이름이 장미아파트로 수정되었고

 

 

Functions의 로그로 들어가서 확인해보면 업데이트 함수가 실행된 걸 볼 수 있습니다.

 

 

또한 Algolia의 해당 오브젝트도 장미아파트로 잘 바뀐걸 볼 수 있습니다.

 

 

 

삭제

 

마지막으로 해당 문서를 파이어스토어에서 삭제해줍니다.

 

Firestore.firestore().collection("Apart").document("Gsw0Qg39ZZsXuIcgAUGq").delete()

 

파이어스토어의 데이터가 삭제되고

 

Functions의 삭제 함수가 실행된걸 볼 수 있습니다.

 

 

Algolia에서도 해당 오브젝트가 삭제된 걸 볼 수 있습니다!

 

---

오늘은 이렇게 클라우드 펑션으로 파이어스토어와 알고리아 데이터를 연결시키는 법에 대해서 알아보았습니다.

 

예전부터 클라우드 펑션에 대해 공부하고 싶었는데 구체적으로 알아보게 돼서 기분이 좋네요 ㅎㅎ

 

혹시라도 틀린점이 있거나 궁금하신 점이 있다면 댓글로 알려주세요!

---

Reference

 

fireship.io/lessons/algolia-cloud-functions/

 

www.algolia.com/doc/