Mike Gerwitz

Activist for User Freedom

aboutsummaryrefslogtreecommitdiffstats
blob: 0e5201a2b0f3f866c34fed6887cbc2f294bee9ee (plain)
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
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
/**
 * Delta Processor
 *
 *  Copyright (C) 2010-2019 R-T Specialty, LLC.
 *
 *  This file is part of the Liza Data Collection Framework.
 *
 *  liza is free software: you can redistribute it and/or modify
 *  it under the terms of the GNU Affero General Public License as
 *  published by the Free Software Foundation, either version 3 of the
 *  License, or (at your option) any later version.
 *
 *  This program is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU General Public License for more details.
 *
 *  You should have received a copy of the GNU Affero General Public License
 *  along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */

import { DeltaDao } from "../system/db/DeltaDao";
import { DocumentId } from "../document/Document";
import { AmqpPublisher } from "./AmqpPublisher";
import { EventEmitter } from "events";
import {
    DeltaType,
    applyDelta,
    DeltaDocument,
    Delta,
    ReverseDelta,
} from "../bucket/delta";

/** Deltas and state of data prior to their application */
type DeltaState = [
    Delta<any>,
    Record<string, any>,
    Record<string, any>,
];


/**
 * Process deltas for a quote and publish to a queue
 *
 * TODO: Decouple from applyDelta
 */
export class DeltaProcessor
{
    /** The ratedata delta type */
    readonly DELTA_RATEDATA: DeltaType = 'ratedata';

    /** The data delta type */
    readonly DELTA_DATA: DeltaType = 'data';


    /**
     * Initialize processor
     *
     * @param _dao       - Delta dao
     * @param _publisher - Amqp Publisher
     * @param _emitter   - Event emiter instance
     */
    constructor(
        private readonly _dao:       DeltaDao,
        private readonly _publisher: AmqpPublisher,
        private readonly _emitter:   EventEmitter,
    ) {}


    /**
     * Process unpublished deltas
     */
    process(): Promise<void>
    {
        return this._dao.getUnprocessedDocuments()
            .then( docs => this._processNext( docs ) );
    }


    private _processNext( docs: DeltaDocument[] ): Promise<void>
    {
        const doc = docs.shift();

        if ( !doc )
        {
            return Promise.resolve();
        }

        return this._processDocument( doc )
            .then( _ => this._processNext( docs ) )
    }


    private _processDocument( doc: DeltaDocument ): Promise<void>
    {
        const deltas          = this._getTimestampSortedDeltas( doc );
        const doc_id          = doc.id;
        const bucket          = doc.data;
        const ratedata        = doc.ratedata || {};
        const last_updated_ts = doc.lastUpdate;

        const history = this._applyDeltas( deltas, bucket, ratedata );

        return this._processNextDelta( doc_id, history )
            .then( _ =>
                this._dao.markDocumentAsProcessed( doc_id, last_updated_ts )
            )
            .then( _ =>
            {
                this._emitter.emit( 'document-processed', { doc_id: doc_id } );
            } )
            .catch( e =>
            {
                this._emitter.emit( 'error', e );
                return this._dao.setErrorFlag( doc_id );
            } );
    }


    /**
     * Produce states of buckets at each point in history
     *
     * For bucket data, each tuple will contain the state of the bucket
     * prior to the corresponding delta having been applied.  For rate data,
     * the tuple will also contain the state of the bucket at the point of
     * rating.
     *
     * @param deltas   - deltas to apply
     * @param bucket   - current state of bucket prior to deltas
     * @param ratedata - current state of ratedata prior to deltas
     *
     * @return deltas paired with state prior to its application
     */
    private _applyDeltas(
        deltas:   Delta<any>[],
        bucket:   Record<string, any>,
        ratedata: Record<string, any>,
    ): DeltaState[]
    {
        const pairs: DeltaState[] = [];

        let bucket_state   = bucket;
        let ratedata_state = ratedata;
        let i              = deltas.length;

        while ( i-- )
        {
            let delta = deltas[ i ];

            pairs[ i ] = [
                delta,
                bucket_state,
                ( delta.type === this.DELTA_RATEDATA ) ? ratedata_state : {},
            ];

            // Don't apply the final delta, since we won't use it
            if ( i === 0 )
            {
                break;
            }

            if ( delta.type === this.DELTA_DATA )
            {
                bucket_state = applyDelta(
                    Object.create( bucket_state ),
                    deltas[ i ].data,
                );
            }
            else
            {
                ratedata_state = applyDelta(
                    Object.create( ratedata_state ),
                    deltas[ i ].data,
                );
            }
        }

        return pairs;
    }


    private _processNextDelta(
        doc_id:  DocumentId,
        history: DeltaState[],
    ): Promise<void>
    {
        if ( history.length === 0 )
        {
            return Promise.resolve();
        }

        const [ delta, bucket, ratedata ] = history[ 0 ];

        const delta_uid = doc_id + '_' + delta.timestamp + '_' + delta.type;

        this._emitter.emit( 'delta-process-start', delta_uid );

        return this._publisher.publish( doc_id, delta, bucket, ratedata )
            .then( _ => this._dao.advanceDeltaIndex( doc_id, delta.type ) )
            .then( _ => this._emitter.emit( 'delta-process-end', delta_uid ) )
            .then( _ => this._processNextDelta(
                doc_id,
                history.slice( 1 ),
            ) );
    }



    /**
     * Get sorted list of deltas
     *
     * @param doc - the document
     *
     * @return a list of deltas sorted by timestamp
     */
    private _getTimestampSortedDeltas( doc: DeltaDocument ): Delta<any>[]
    {
        const data_deltas     = this._getDeltas( doc, this.DELTA_RATEDATA );
        const ratedata_deltas = this._getDeltas( doc, this.DELTA_DATA );
        const deltas          = data_deltas.concat( ratedata_deltas );

        deltas.sort( this._sortByTimestamp );

        return deltas;
    }


    /**
     * Get trimmed delta list
     *
     * @param doc  - the document
     * @param type - the delta type to get
     *
     * @return a trimmed list of deltas
     */
    private _getDeltas( doc: DeltaDocument, type: DeltaType ): Delta<any>[]
    {
        const deltas_obj           = doc.rdelta || <ReverseDelta<any>>{};
        const deltas: Delta<any>[] = deltas_obj[ type ] || [];

        // Get type specific delta index
        let published_count = 0;
        if ( doc.totalPublishDelta )
        {
            published_count = doc.totalPublishDelta[ type ] || 0;
        }

        // Only return the unprocessed deltas
        const deltas_trimmed = deltas.slice( published_count );

        // Mark each delta with its type
        deltas_trimmed.forEach( delta =>
        {
            delta.type = type;
        } );

        return deltas_trimmed;
    }


    /**
     * Sort an array of deltas by timestamp
     *
     * @param a - The first delta to compare
     * @param b - The second delta to compare
     *
     * @return a sort value
     */
    private _sortByTimestamp( a: Delta<any>, b: Delta<any> ): number
    {
        if ( a.timestamp < b.timestamp )
        {
            return -1;
        }

        if ( a.timestamp > b.timestamp ) {
            return 1;
        }

        return 0;
    }
}