causal_consistency_helpers.js

/**
 * Helper functions for testing causal consistency.
 */

load('jstests/replsets/rslib.js');  // For startSetIfSupportsReadMajority.

function assertAfterClusterTimeReadFails(db, collName) {
    assert.commandFailed(db.runCommand(
        {find: collName, readConcern: {level: "majority", afterClusterTime: Timestamp(1, 1)}}));
}

function assertAfterClusterTimeReadSucceeds(db, collName) {
    assert.commandWorked(db.runCommand(
        {find: collName, readConcern: {level: "majority", afterClusterTime: Timestamp(1, 1)}}));
}

function assertDoesNotContainLogicalOrOperationTime(res) {
    assertDoesNotContainLogicalTime(res);
    assertDoesNotContainOperationTime(res);
}

function assertDoesNotContainLogicalTime(res) {
    assert.eq(res.$clusterTime, undefined);
}

function assertDoesNotContainOperationTime(res) {
    assert.eq(res.operationTime, undefined);
}

function assertContainsLogicalAndOperationTime(res, opts) {
    assertContainsLogicalTime(res, opts);
    assertContainsOperationTime(res, opts);
}

function assertContainsLogicalTime(res, opts) {
    assert.hasFields(res, ["$clusterTime"]);
    assert.hasFields(res.$clusterTime, ["clusterTime", "signature"]);
    assert.hasFields(res.$clusterTime.signature, ["hash", "keyId"]);

    if (opts.signed !== undefined) {
        // Signed cluster times have a keyId greater than 0.
        if (opts.signed) {
            assert(res.$clusterTime.signature.keyId > NumberLong(0));
        } else {
            assert.eq(res.$clusterTime.signature.keyId, NumberLong(0));
        }
    }

    if (opts.initialized !== undefined) {
        // Initialized operation times are greater than a null timestamp.
        if (opts.initialized) {
            assert.eq(bsonWoCompare(res.$clusterTime.clusterTime, Timestamp(0, 0)), 1);
        } else {
            assert.eq(bsonWoCompare(res.$clusterTime.clusterTime, Timestamp(0, 0)), 0);
        }
    }
}

function assertContainsOperationTime(res, opts) {
    assert.hasFields(res, ["operationTime"]);

    if (opts.initialized !== undefined) {
        // Initialized operation times are greater than a null timestamp.
        if (opts.initialized) {
            assert.eq(bsonWoCompare(res.operationTime, Timestamp(0, 0)), 1);
        } else {
            assert.eq(bsonWoCompare(res.operationTime, Timestamp(0, 0)), 0);
        }
    }
}

function supportsMajorityReadConcern() {
    const rst = new ReplSetTest({nodes: 1, nodeOptions: {enableMajorityReadConcern: ""}});
    if (!startSetIfSupportsReadMajority(rst)) {
        rst.stopSet();
        return false;
    }
    rst.stopSet();
    return true;
}