com.palantir.atlasdb.transaction.impl.NoDuplicateWritesTransaction Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of atlasdb-client Show documentation
Palantir open source project
There is a newer version: 0.1193.0
/*
 * (c) Copyright 2018 Palantir Technologies Inc. All rights reserved.
 *
 * 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
 *
 *     http://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.
 */
package com.palantir.atlasdb.transaction.impl;

import com.github.benmanes.caffeine.cache.Caffeine;
import com.github.benmanes.caffeine.cache.LoadingCache;
import com.google.common.collect.ImmutableSet;
import com.google.common.io.BaseEncoding;
import com.palantir.atlasdb.keyvalue.api.Cell;
import com.palantir.atlasdb.keyvalue.api.TableReference;
import com.palantir.atlasdb.transaction.api.Transaction;
import com.palantir.logsafe.logger.SafeLogger;
import com.palantir.logsafe.logger.SafeLoggerFactory;
import com.palantir.util.AssertUtils;
import java.util.Arrays;
import java.util.Collections;
import java.util.HashMap;
import java.util.Map;
import java.util.Set;

/**
 * Disallows the same cell from being written twice with different values within
 * the same transaction. Multiple writes to same cell which write the same value
 * are allowed.
 */
public class NoDuplicateWritesTransaction extends ForwardingTransaction {
    private static final SafeLogger log = SafeLoggerFactory.get(NoDuplicateWritesTransaction.class);

    final Transaction delegate;
    final ImmutableSet noDoubleWritesTables;
    final LoadingCache> writes =
            Caffeine.newBuilder().build(input -> Collections.synchronizedMap(new HashMap<>()));

    public NoDuplicateWritesTransaction(Transaction delegate, Iterable noDoubleWritesTables) {
        this.delegate = delegate;
        this.noDoubleWritesTables = ImmutableSet.copyOf(noDoubleWritesTables);
    }

    @Override
    public Transaction delegate() {
        return delegate;
    }

    @Override
    public void put(TableReference tableRef, Map values) {
        validateWrites(tableRef, values);
        super.put(tableRef, values);
    }

    @Override
    public void delete(TableReference tableRef, Set keys) {
        // Map deletes into writes of zero-length byte arrays (this is in
        // accordance with the semantics of our transaction API).
        Map values = new HashMap<>();
        for (Cell c : keys) {
            values.put(c, new byte[0]);
        }
        validateWrites(tableRef, values);
        super.delete(tableRef, keys);
    }

    private void validateWrites(TableReference tableRef, Map values) {
        if (noDoubleWritesTables.contains(tableRef)) {
            Map table = writes.get(tableRef);
            for (Map.Entry value : values.entrySet()) {
                byte[] newValue = value.getValue();
                byte[] oldValue = table.get(value.getKey());
                if (oldValue != null && !Arrays.equals(oldValue, newValue)) {
                    AssertUtils.assertAndLog(
                            log,
                            false,
                            "table: " + tableRef
                                    + " cell was writen to twice: " + value.getKey()
                                    + " old value: "
                                    + BaseEncoding.base16().lowerCase().encode(oldValue)
                                    + " new value: "
                                    + BaseEncoding.base16().lowerCase().encode(newValue));
                    break;
                }
            }
        }
    }
}