com.couchbase.client.core.classic.ClassicHelper Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of core-io Show documentation
The official Couchbase JVM Core IO Library
There is a newer version: 3.7.2
/*
 * Copyright 2023 Couchbase, Inc.
 *
 * 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
 *
 * https://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.couchbase.client.core.classic;

import com.couchbase.client.core.Core;
import com.couchbase.client.core.annotation.Stability;
import com.couchbase.client.core.api.kv.CoreAsyncResponse;
import com.couchbase.client.core.api.kv.CoreDurability;
import com.couchbase.client.core.api.kv.CoreMutationResult;
import com.couchbase.client.core.endpoint.http.CoreCommonOptions;
import com.couchbase.client.core.msg.CancellationReason;
import com.couchbase.client.core.msg.Request;
import com.couchbase.client.core.msg.Response;
import com.couchbase.client.core.msg.kv.KeyValueRequest;
import com.couchbase.client.core.service.kv.Observe;
import com.couchbase.client.core.service.kv.ObserveContext;

import java.util.concurrent.CompletableFuture;

@Stability.Internal
public class ClassicHelper {
  private ClassicHelper() {
    throw new AssertionError("not instantiable");
  }

  public static void setClientContext(Request request, CoreCommonOptions common) {
    request.context().clientContext(common.clientContext());
  }

  /**
   * Returns a new async response whose cancellation task calls {@link Request#cancel(CancellationReason)}.
   */
  public static  CoreAsyncResponse newAsyncResponse(
      Request request,
      CompletableFuture future
  ) {
    return new CoreAsyncResponse<>(
        future,
        () -> request.cancel(CancellationReason.STOPPED_LISTENING)
    );
  }

  /**
   * Helper method to wrap a mutation result to perform legacy durability requirements if needed.
   */
  public static  CompletableFuture maybeWrapWithLegacyDurability(
      CompletableFuture input,
      String key,
      CoreDurability durability,
      Core core,
      KeyValueRequest request
  ) {
    if (!durability.isLegacy()) {
      return input;
    }

    return input.thenCompose(result -> {
        final ObserveContext ctx = new ObserveContext(
            core.context(),
            durability.legacyPersistTo(),
            durability.legacyReplicateTo(),
            result.mutationToken(),
            result.cas(),
            request.collectionIdentifier(),
            key,
            false, // TODO this parameter became unused after JVMCBC-731 removed CAS-based observability. Clean it up!
            request.timeout(),
            request.requestSpan()
        );
        return Observe.poll(ctx).toFuture().thenApply(v -> result);
      });
  }
}