All files / src extract.ts

92.59% Statements 25/27
75% Branches 6/8
100% Functions 3/3
92.59% Lines 25/27

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                                      6x 6x 6x 6x 6x   6x 6x 6x   6x     7x         7x 7x 3x               4x 14x 14x   14x 14x               7x     6x   7x 7x 7x 1x       6x                        
'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 { DocumentSnapshot } from 'firebase-functions/lib/providers/firestore';
 
import config from './config';
import * as logs from './logs';
import { dataProcessor, valueProcessor } from './processors';
import transform from './transform';
import { getObjectSizeInBytes, getFields, isValidValue } from './util';
 
const PAYLOAD_MAX_SIZE = 102400;
const PAYLOAD_TOO_LARGE_ERR_MSG = 'Record is too large.';
const trim = /^[\s\uFEFF\xA0]+|[\s\uFEFF\xA0]+$/g;
 
const getPayload = async (snapshot: DocumentSnapshot): Promise<any> => {
    let payload: {
    [key: string]: boolean | string | number;
  } = {
    objectID: snapshot.id,
    path: snapshot.ref.path
  };
 
  const fields = getFields(config);
  if (fields.length === 0) {
    payload = {
      ...dataProcessor(snapshot.data()),
      ...payload
    };
  } else {
 
    // Fields have been defined by user.  Start pulling data from the document to create payload
    // to send to Algolia.
    fields.forEach(item => {
      let firebaseField = item.replace(trim, '');
      const [ field, value ] = valueProcessor(firebaseField, snapshot.get(firebaseField));
 
      Eif (isValidValue(value)) {
        payload[field] = value;
      } else {
        logs.fieldNotExist(firebaseField);
      }
    });
  }
 
  // adding the objectId in the return to make sure to restore to original if changed in the post processing.
  return transform(payload);
}
 
export default async function extract(snapshot: DocumentSnapshot, timestamp: Number): Promise<any> {
  // Check payload size and make sure its within limits before sending for indexing
  const payload = await getPayload(snapshot);
  Eif (getObjectSizeInBytes(payload) < PAYLOAD_MAX_SIZE) {
    if (timestamp === 0) {
      return {
        ...payload
      };
    } else {
      return {
        ...payload,
        lastmodified: {
          _operation: 'IncrementSet',
          value: timestamp,
        },
      };
    }
  } else {
    throw new Error(PAYLOAD_TOO_LARGE_ERR_MSG);
  }
}