All files / src index.ts

92.31% Statements 48/52
75% Branches 6/8
100% Functions 5/5
92.16% Lines 47/51

Press n or j to go to the next uncovered block, b, p or k for the previous block.

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126                                  6x   6x       6x 6x 6x 6x 6x     6x         6x   6x   6x   6x       2x 2x   2x       2x 2x           6x         5x 5x 5x   5x   70x     5x 4x 4x 4x 4x       1x 1x 1x 1x               6x     1x 1x 1x           6x   8x   8x   8x 8x   2x 2x   1x 1x   5x 5x            
'use strict';
/*
 * Copyright 2021 Algolia
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *    https://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
 
import algoliaSearch from 'algoliasearch';
import { firestore } from 'firebase-admin';
import * as functions from 'firebase-functions';
import { EventContext, Change } from 'firebase-functions';
import { DocumentSnapshot } from 'firebase-functions/lib/providers/firestore';
 
import config from './config';
import extract from './extract';
import * as logs from './logs';
import { ChangeType, getChangeType, areFieldsUpdated } from './util';
import { version } from './version';
import DocumentData = firestore.DocumentData;
 
const client = algoliaSearch(
  config.algoliaAppId,
  config.algoliaAPIKey,
);
 
client.addAlgoliaAgent('firestore_integration', version);
 
export const index = client.initIndex(config.algoliaIndexName);
 
logs.init();
 
const handleCreateDocument = async (
  snapshot: DocumentSnapshot,
  timestamp: Number
) => {
  try {
    const data = await extract(snapshot, timestamp);
 
    logs.debug({
      ...data
    });
 
    logs.createIndex(snapshot.id, data);
    await index.partialUpdateObject(data, { createIfNotExists: true });
  } catch (e) {
    logs.error(e);
  }
};
 
const handleUpdateDocument = async (
  before: DocumentSnapshot,
  after: DocumentSnapshot,
  timestamp: Number
) => {
  try {
    Eif (areFieldsUpdated(config, before, after)) {
      logs.debug('Detected a change, execute indexing');
 
      const beforeData: DocumentData = await before.data();
      // loop through the after data snapshot to see if any properties were removed
      const undefinedAttrs = Object.keys(beforeData).filter(key => after.get(key) === undefined);
 
      // if no attributes were removed, then use partial update of the record.
      if (undefinedAttrs.length === 0) {
        const data = await extract(after, timestamp);
        logs.updateIndex(after.id, data);
        logs.debug("execute partialUpdateObject");
        await index.partialUpdateObject(data, { createIfNotExists: true });
      }
      // if an attribute was removed, then use save object of the record.
      else {
        const data = await extract(after, 0);
        logs.updateIndex(after.id, data);
        logs.debug("execute saveObject");
        await index.saveObject(data);
      }
    }
  } catch (e) {
    logs.error(e);
  }
};
 
const handleDeleteDocument = async (
  deleted: DocumentSnapshot,
) => {
  try {
    logs.deleteIndex(deleted.id);
    await index.deleteObject(deleted.id);
  } catch (e) {
    logs.error(e);
  }
};
 
export const executeIndexOperation = functions.handler.firestore.document
  .onWrite(async (change: Change<DocumentSnapshot>, context: EventContext): Promise<void> => {
    logs.start();
 
    const eventTimestamp = Date.parse(context.timestamp);
 
    const changeType = getChangeType(change);
    switch (changeType) {
      case ChangeType.CREATE:
        await handleCreateDocument(change.after, eventTimestamp);
        break;
      case ChangeType.DELETE:
        await handleDeleteDocument(change.before);
        break;
      case ChangeType.UPDATE:
        await handleUpdateDocument(change.before, change.after, eventTimestamp);
        break;
      default: {
        throw new Error(`Invalid change type: ${ changeType }`);
      }
    }
  });