test-rxdb/src/plugins/pipeline/flagged-functions.ts

A local realtime NoSQL Database for JavaScript applications -

import { ensureNotFalsy } from '../utils/index.ts';

/**
 * This is the most hacky thing we do in RxDB.
 * When a pipeline "transaction" is running,
 * we have to make all calls to the collection from the outside
 * wait while still make it possible to run reads and writes
 * from inside the transaction.
 * 
 * We can decide where the call came from by checking the stack `new Error().stack`
 * for a random "flag".
 * But creating random flagged functions requires eval which we should not use.
 * Instead we have a list of some flagged functions here
 * that can be used and checked for in the stacktrace.
 * 
 * 
 * When doing this with eval() instead it would look like:
 * ```ts
 * eval(`
 *     async function ${this.secretFunctionName}(docs){ const x = await _this.handler(docs); return x; }
 *     o.${this.secretFunctionName} = ${this.secretFunctionName};
 *   `);
 * await o[this.secretFunctionName](rxDocuments);
 * 
 * ```
 */
async function rx_pipeline_fn_1_(fn: any) {
    return await fn();
}
async function rx_pipeline_fn_2_(fn: any) {
    return await fn();
}
async function rx_pipeline_fn_3_(fn: any) {
    return await fn();
}
async function rx_pipeline_fn_4_(fn: any) {
    return await fn();
}
async function rx_pipeline_fn_5_(fn: any) {
    return await fn();
}
async function rx_pipeline_fn_6_(fn: any) {
    return await fn();
}
async function rx_pipeline_fn_7_(fn: any) {
    return await fn();
}
async function rx_pipeline_fn_8_(fn: any) {
    return await fn();
}
async function rx_pipeline_fn_9_(fn: any) {
    return await fn();
}
async function rx_pipeline_fn_10_(fn: any) {
    return await fn();
}
async function rx_pipeline_fn_11_(fn: any) {
    return await fn();
}
async function rx_pipeline_fn_12_(fn: any) {
    return await fn();
}
async function rx_pipeline_fn_13_(fn: any) {
    return await fn();
}
async function rx_pipeline_fn_14_(fn: any) {
    return await fn();
}
async function rx_pipeline_fn_15_(fn: any) {
    return await fn();
}
async function rx_pipeline_fn_16_(fn: any) {
    return await fn();
}
async function rx_pipeline_fn_17_(fn: any) {
    return await fn();
}
async function rx_pipeline_fn_18_(fn: any) {
    return await fn();
}
async function rx_pipeline_fn_19_(fn: any) {
    return await fn();
}
async function rx_pipeline_fn_20_(fn: any) {
    return await fn();
}





export const FLAGGED_FUNCTIONS = {
    rx_pipeline_fn_1_,
    rx_pipeline_fn_2_,
    rx_pipeline_fn_3_,
    rx_pipeline_fn_4_,
    rx_pipeline_fn_5_,
    rx_pipeline_fn_6_,
    rx_pipeline_fn_7_,
    rx_pipeline_fn_8_,
    rx_pipeline_fn_9_,
    rx_pipeline_fn_10_,
    rx_pipeline_fn_11_,
    rx_pipeline_fn_12_,
    rx_pipeline_fn_13_,
    rx_pipeline_fn_14_,
    rx_pipeline_fn_15_,
    rx_pipeline_fn_16_,
    rx_pipeline_fn_17_,
    rx_pipeline_fn_18_,
    rx_pipeline_fn_19_,
    rx_pipeline_fn_20_,
} as const;



const ids: (keyof typeof FLAGGED_FUNCTIONS)[] = Object.keys(FLAGGED_FUNCTIONS) as any;

export function blockFlaggedFunctionKey(): keyof typeof FLAGGED_FUNCTIONS {
    /**
     * If this happens and we have no more flagged keys left
     * it means that more pipeline handlers are running in parallel.
     * To fix this, add more functions.
     */
    const id = ensureNotFalsy(ids.pop(), 'no flagged keys left');
    return id;
}

export function releaseFlaggedFunctionKey(key: keyof typeof FLAGGED_FUNCTIONS) {
    ids.push(key);
}