-
Notifications
You must be signed in to change notification settings - Fork 31
/
index.ts
260 lines (234 loc) · 9.03 KB
/
index.ts
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
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
/* eslint-disable import/no-unresolved */
/*
* 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 * as functions from 'firebase-functions';
import { EventContext } from 'firebase-functions';
import { DocumentData, DocumentSnapshot, getFirestore } from 'firebase-admin/firestore';
import { getExtensions } from 'firebase-admin/extensions';
import { getFunctions } from 'firebase-admin/functions';
import * as firebase from 'firebase-admin';
import { firestore } from 'firebase-admin';
import FieldPath = firestore.FieldPath;
import config from './config';
import extract from './extract';
import { areFieldsUpdated, ChangeType, getChangeType } from './util';
import { version } from './version';
import * as logs from './logs';
const DOCS_PER_INDEXING = 250;
const client = algoliaSearch(
config.algoliaAppId,
config.algoliaAPIKey,
);
client.addAlgoliaAgent('firestore_integration', version);
export const index = client.initIndex(config.algoliaIndexName);
firebase.initializeApp();
const firestoreDB = getFirestore(config.databaseId);
logs.init();
const handleCreateDocument = async (
snapshot: DocumentSnapshot,
timestamp: Number
) => {
try {
const forceDataSync = config.forceDataSync;
if (forceDataSync) {
const updatedSnapshot = await snapshot.ref.get();
const data = await extract(updatedSnapshot, 0);
logs.createIndex(updatedSnapshot.id, data);
logs.info('force sync data: execute saveObject');
await index.saveObject(data);
} else {
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 {
const forceDataSync = config.forceDataSync;
if (forceDataSync) {
const updatedSnapshot = await after.ref.get();
const data = await extract(updatedSnapshot, 0);
logs.updateIndex(updatedSnapshot.id, data);
logs.info('force sync data: execute saveObject');
await index.saveObject(data);
} else {
if (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 || after.get(key) === null);
logs.debug('undefinedAttrs', undefinedAttrs);
// 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);
// delete null value attributes before saving.
undefinedAttrs.forEach(attr => delete data[attr]);
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> => {
export const executeIndexOperation = functions.firestore
.document(config.collectionPath)
.onWrite(async (change, 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 }`);
}
}
});
export const executeFullIndexOperation = functions.tasks
.taskQueue()
.onDispatch(async (data: any) => {
const runtime = getExtensions().runtime();
logs.info('config', config);
logs.info('config.doFullIndexing', config.doFullIndexing);
if (!config.doFullIndexing) {
await runtime.setProcessingState(
'PROCESSING_COMPLETE',
'Existing documents were not indexed because "Indexing existing documents?" is configured to false. ' +
'If you want to run a full reindex, reconfigure this instance.'
);
return;
}
logs.info('config.collectionPath', config.collectionPath);
const docId = data['docId'] ?? null;
const pastSuccessCount = (data['successCount'] as number) ?? 0;
const pastErrorCount = (data['errorCount'] as number) ?? 0;
// We also track the start time of the first invocation, so that we can report the full length at the end.
const startTime = (data['startTime'] as number) ?? Date.now();
let query: firebase.firestore.Query;
logs.info('Is Collection Group?', config.collectionPath.indexOf('/') !== -1);
if (config.collectionPath.indexOf('/') === -1) {
query = firestoreDB
.collection(config.collectionPath);
} else {
query = firestoreDB
.collectionGroup(config.collectionPath.split('/').pop());
}
query = query.limit(DOCS_PER_INDEXING);
logs.debug('docId?', docId);
if (docId) {
let queryCursor = query.where(FieldPath.documentId(), '==', docId);
logs.debug('queryCursor?', queryCursor);
const querySnapshot = await queryCursor.get();
logs.debug('querySnapshot?', querySnapshot);
logs.debug('querySnapshot.docs?', querySnapshot.docs);
querySnapshot.docs.forEach(doc => query = query.startAfter(doc));
}
logs.debug('query', query);
const snapshot = await query.get();
const promises = await Promise.allSettled(
snapshot.docs.map((doc) => extract(doc, startTime))
);
logs.debug('promises.length', promises.length);
(promises as any).forEach(v => logs.info('v', v));
const records = (promises as any)
.filter(v => v.status === "fulfilled")
.map(v => v.value);
logs.info('records.length', records.length);
const responses = await index.saveObjects(records, {
autoGenerateObjectIDIfNotExist: true,
});
logs.debug('responses.objectIDs', responses.objectIDs);
logs.info('responses.taskIDs', responses.taskIDs);
const newSuccessCount = pastSuccessCount + records.length;
const newErrorCount = pastErrorCount;
if (snapshot.size === DOCS_PER_INDEXING) {
const newCursor = snapshot.docs[snapshot.size - 1];
const queue = getFunctions().taskQueue(
`locations/${config.location}/functions/executeFullIndexOperation`,
config.instanceId
);
await queue.enqueue({
docId: newCursor.id,
successCount: newSuccessCount,
errorCount: newErrorCount,
startTime: startTime,
});
} else {
// No more documents to index, time to set the processing state.
logs.fullIndexingComplete(newSuccessCount, newErrorCount);
if (newErrorCount === 0) {
return await runtime.setProcessingState(
'PROCESSING_COMPLETE',
`Successfully indexed ${ newSuccessCount } documents in ${
Date.now() - startTime
}ms.`
);
} else if (newErrorCount > 0 && newSuccessCount > 0) {
return await runtime.setProcessingState(
'PROCESSING_WARNING',
`Successfully indexed ${ newSuccessCount } documents, ${ newErrorCount } errors in ${
Date.now() - startTime
}ms. See function logs for specific error messages.`
);
}
return await runtime.setProcessingState(
'PROCESSING_FAILED',
`Successfully indexed ${ newSuccessCount } documents, ${ newErrorCount } errors in ${
Date.now() - startTime
}ms. See function logs for specific error messages.`
);
}
});