summaryrefslogtreecommitdiff
path: root/adservices/service-core/java/com/android/adservices/data/measurement/DatastoreManager.java
blob: a652f72641d7d3278bc6acbd4336df8c2c5d8f37 (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
/*
 * Copyright (C) 2022 The Android Open Source Project
 *
 * 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.android.adservices.data.measurement;

import com.android.adservices.LogUtil;
import com.android.internal.annotations.VisibleForTesting;

import java.util.Optional;

/**
 * Abstract class for Datastore management.
 */
public abstract class DatastoreManager {

    /**
     * Consumer interface for Dao operations.
     */
    @FunctionalInterface
    public interface ThrowingCheckedConsumer {
        /**
         * Performs the operation on {@link IMeasurementDao}.
         */
        void accept(IMeasurementDao measurementDao) throws DatastoreException;
    }

    /**
     * Function interface for Dao operations that returns {@link Output}.
     *
     * @param <Output> output type
     */
    @FunctionalInterface
    public interface ThrowingCheckedFunction<Output> {
        /**
         * Performs the operation on Dao.
         *
         * @return Output result of the operation
         */
        Output apply(IMeasurementDao measurementDao) throws DatastoreException;
    }

    /**
     * Creates a new transaction object for use in Dao.
     *
     * @return transaction
     */
    protected abstract ITransaction createNewTransaction();

    /**
     * Acquire an instance of Dao object for querying the datastore.
     *
     * @return Dao object.
     */
    @VisibleForTesting
    public abstract IMeasurementDao getMeasurementDao();

    /**
     * Runs the {@code execute} lambda in a transaction.
     *
     * @param execute lambda to be executed in a transaction
     * @param <T>     the class for result
     * @return Optional<T>, empty in case of an error, output otherwise
     */
    public final <T> Optional<T> runInTransactionWithResult(ThrowingCheckedFunction<T> execute) {
        IMeasurementDao measurementDao = getMeasurementDao();
        ITransaction transaction = createNewTransaction();
        if (transaction == null) {
            return Optional.empty();
        }
        measurementDao.setTransaction(transaction);
        transaction.begin();

        Optional<T> result;
        try {
            result = Optional.of(execute.apply(measurementDao));
        } catch (DatastoreException ex) {
            result = Optional.empty();
            LogUtil.e(ex, "DatastoreException thrown during transaction");
            transaction.rollback();
        } catch (Exception ex) {
            // Catch all exceptions for rollback
            LogUtil.e(ex, "Unhandled exception thrown during transaction");
            transaction.rollback();
            throw ex;
        } finally {
            transaction.end();
        }

        return result;
    }

    /**
     * Runs the {@code execute} lambda in a transaction.
     *
     * @param execute lambda to be executed in transaction
     * @return success true if execution succeeded, false otherwise
     */
    public final boolean runInTransaction(ThrowingCheckedConsumer execute) {
        return runInTransactionWithResult((measurementDao) -> {
            execute.accept(measurementDao);
            return true;
        }).orElse(false);
    }
}