adservices/service-core/java/com/android/adservices/service/adselection/JsVersionHelper.java

/*
 * Copyright (C) 2023 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.service.adselection;

import android.annotation.IntDef;
import android.net.Uri;

import com.android.adservices.LoggerFactory;
import com.android.adservices.service.common.httpclient.AdServicesHttpClientRequest;
import com.android.internal.annotations.VisibleForTesting;

import com.google.common.collect.ImmutableList;
import com.google.common.collect.ImmutableMap;
import com.google.common.collect.ImmutableSet;

import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.util.List;
import java.util.Map;

/** Provides JS version related payload helper methods. */
public class JsVersionHelper {
    private static final LoggerFactory.Logger LOGGER = LoggerFactory.getFledgeLogger();

    @VisibleForTesting
    public static final String VERSION_HEADER_NAME_FORMAT = "X_FLEDGE_%s_VERSION";

    /** JS payload name. */
    @Retention(RetentionPolicy.SOURCE)
    @IntDef(
            prefix = "JS_PAYLOAD_TYPE_",
            value = {
                JS_PAYLOAD_TYPE_BUYER_BIDDING_LOGIC_JS,
            })
    public @interface JsPayloadType {}

    public static final int JS_PAYLOAD_TYPE_BUYER_BIDDING_LOGIC_JS = 1;

    @VisibleForTesting
    static final String JS_PAYLOAD_NAME_BUYER_BIDDING_LOGIC_JS = "BUYER_BIDDING_LOGIC";

    @VisibleForTesting
    static final ImmutableMap<Integer, String> JS_PAYLOAD_TYPE_HEADER_NAME_MAP =
            ImmutableMap.<Integer, String>builder()
                    .put(
                            JS_PAYLOAD_TYPE_BUYER_BIDDING_LOGIC_JS,
                            String.format(
                                    VERSION_HEADER_NAME_FORMAT,
                                    JS_PAYLOAD_NAME_BUYER_BIDDING_LOGIC_JS))
                    .build();

    /** Returns the URI with appended version query parameter. */
    public static AdServicesHttpClientRequest getRequestWithVersionHeader(
            Uri uri, @JsPayloadType int jsPayloadType, long version, boolean useCache) {
        return AdServicesHttpClientRequest.builder()
                .setUri(uri)
                .setRequestProperties(
                        ImmutableMap.of(
                                getVersionHeaderName(jsPayloadType), Long.toString(version)))
                .setUseCache(useCache)
                .setResponseHeaderKeys(ImmutableSet.of(getVersionHeaderName(jsPayloadType)))
                .build();
    }

    /** Returns a payload header contains the js version attribute. */
    public static ImmutableMap<String, List<String>> constructVersionHeader(
            @JsPayloadType int jsPayloadType, Map<String, String> requestProperties) {
        String versionHeaderName = getVersionHeaderName(jsPayloadType);
        String version = requestProperties.get(versionHeaderName);

        return ImmutableMap.of(getVersionHeaderName(jsPayloadType), ImmutableList.of(version));
    }

    @VisibleForTesting
    public static String getVersionHeaderName(@JsPayloadType int jsPayloadType) {
        return JS_PAYLOAD_TYPE_HEADER_NAME_MAP.get(jsPayloadType);
    }

    /** Returns the version extracted from a response header. */
    public static long getVersionFromHeader(
            @JsPayloadType int jsPayloadType, Map<String, List<String>> responseHeader) {
        if (responseHeader.containsKey(getVersionHeaderName(jsPayloadType))
                && responseHeader.get(getVersionHeaderName(jsPayloadType)).size() == 1) {
            try {
                return Long.parseLong(
                        responseHeader.get(getVersionHeaderName(jsPayloadType)).get(0));
            } catch (NumberFormatException numberFormatException) {
                LOGGER.w(
                        "Got malformed js version %s, fall back to -1",
                        responseHeader.get(getVersionHeaderName(jsPayloadType)).get(0));
            }
        }
        return -1;
    }
}