com.datastax.oss.driver.internal.core.metadata.DefaultMetadata Maven / Gradle / Ivy

/*
 * Copyright DataStax, 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
 *
 * 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.datastax.oss.driver.internal.core.metadata;

import com.datastax.oss.driver.api.core.CqlIdentifier;
import com.datastax.oss.driver.api.core.metadata.Metadata;
import com.datastax.oss.driver.api.core.metadata.Node;
import com.datastax.oss.driver.api.core.metadata.TokenMap;
import com.datastax.oss.driver.api.core.metadata.schema.KeyspaceMetadata;
import com.datastax.oss.driver.internal.core.context.InternalDriverContext;
import com.datastax.oss.driver.internal.core.metadata.token.DefaultTokenMap;
import com.datastax.oss.driver.internal.core.metadata.token.ReplicationStrategyFactory;
import com.datastax.oss.driver.internal.core.metadata.token.TokenFactory;
import com.datastax.oss.driver.internal.core.util.Loggers;
import com.datastax.oss.driver.internal.core.util.NanoTime;
import com.datastax.oss.driver.shaded.guava.common.collect.ImmutableMap;
import edu.umd.cs.findbugs.annotations.NonNull;
import edu.umd.cs.findbugs.annotations.Nullable;
import java.util.Collections;
import java.util.Map;
import java.util.Optional;
import java.util.UUID;
import net.jcip.annotations.Immutable;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

/**
 * This class is immutable, so that metadata changes are atomic for the client. Every mutation
 * operation must return a new instance, that will replace the existing one in {@link
 * MetadataManager}'s volatile field.
 */
@Immutable
public class DefaultMetadata implements Metadata {
  private static final Logger LOG = LoggerFactory.getLogger(DefaultMetadata.class);
  public static DefaultMetadata EMPTY =
      new DefaultMetadata(Collections.emptyMap(), Collections.emptyMap(), null, null);

  protected final Map nodes;
  protected final Map keyspaces;
  protected final TokenMap tokenMap;
  protected final String clusterName;

  protected DefaultMetadata(
      Map nodes,
      Map keyspaces,
      TokenMap tokenMap,
      String clusterName) {
    this.nodes = nodes;
    this.keyspaces = keyspaces;
    this.tokenMap = tokenMap;
    this.clusterName = clusterName;
  }

  @NonNull
  @Override
  public Map getNodes() {
    return nodes;
  }

  @NonNull
  @Override
  public Map getKeyspaces() {
    return keyspaces;
  }

  @NonNull
  @Override
  public Optional getTokenMap() {
    return Optional.ofNullable(tokenMap);
  }

  @NonNull
  @Override
  public Optional getClusterName() {
    return Optional.ofNullable(clusterName);
  }

  /**
   * Refreshes the current metadata with the given list of nodes.
   *
   * @param tokenMapEnabled whether to rebuild the token map or not; if this is {@code false} the
   *     current token map will be copied into the new metadata without being recomputed.
   * @param tokensChanged whether we observed a change of tokens for at least one node. This will
   *     require a full rebuild of the token map.
   * @param tokenFactory only needed for the initial refresh, afterwards the existing one in the
   *     token map is used.
   * @return the new metadata.
   */
  public DefaultMetadata withNodes(
      Map newNodes,
      boolean tokenMapEnabled,
      boolean tokensChanged,
      TokenFactory tokenFactory,
      InternalDriverContext context) {

    // Force a rebuild if at least one node has different tokens, or there are new or removed nodes.
    boolean forceFullRebuild = tokensChanged || !newNodes.equals(nodes);

    return new DefaultMetadata(
        ImmutableMap.copyOf(newNodes),
        this.keyspaces,
        rebuildTokenMap(
            newNodes, keyspaces, tokenMapEnabled, forceFullRebuild, tokenFactory, context),
        context.getChannelFactory().getClusterName());
  }

  public DefaultMetadata withSchema(
      Map newKeyspaces,
      boolean tokenMapEnabled,
      InternalDriverContext context) {
    return new DefaultMetadata(
        this.nodes,
        ImmutableMap.copyOf(newKeyspaces),
        rebuildTokenMap(nodes, newKeyspaces, tokenMapEnabled, false, null, context),
        context.getChannelFactory().getClusterName());
  }

  @Nullable
  protected TokenMap rebuildTokenMap(
      Map newNodes,
      Map newKeyspaces,
      boolean tokenMapEnabled,
      boolean forceFullRebuild,
      TokenFactory tokenFactory,
      InternalDriverContext context) {

    String logPrefix = context.getSessionName();
    ReplicationStrategyFactory replicationStrategyFactory = context.getReplicationStrategyFactory();

    if (!tokenMapEnabled) {
      LOG.debug("[{}] Token map is disabled, skipping", logPrefix);
      return this.tokenMap;
    }
    long start = System.nanoTime();
    try {
      DefaultTokenMap oldTokenMap = (DefaultTokenMap) this.tokenMap;
      if (oldTokenMap == null) {
        // Initial build, we need the token factory
        if (tokenFactory == null) {
          LOG.debug(
              "[{}] Building initial token map but the token factory is missing, skipping",
              logPrefix);
          return null;
        } else {
          LOG.debug("[{}] Building initial token map", logPrefix);
          return DefaultTokenMap.build(
              newNodes.values(),
              newKeyspaces.values(),
              tokenFactory,
              replicationStrategyFactory,
              logPrefix);
        }
      } else if (forceFullRebuild) {
        LOG.debug(
            "[{}] Updating token map but some nodes/tokens have changed, full rebuild", logPrefix);
        return DefaultTokenMap.build(
            newNodes.values(),
            newKeyspaces.values(),
            oldTokenMap.getTokenFactory(),
            replicationStrategyFactory,
            logPrefix);
      } else {
        LOG.debug("[{}] Refreshing token map (only schema has changed)", logPrefix);
        return oldTokenMap.refresh(
            newNodes.values(), newKeyspaces.values(), replicationStrategyFactory);
      }
    } catch (Throwable t) {
      Loggers.warnWithException(
          LOG,
          "[{}] Unexpected error while refreshing token map, keeping previous version",
          logPrefix,
          t);
      return this.tokenMap;
    } finally {
      LOG.debug("[{}] Rebuilding token map took {}", logPrefix, NanoTime.formatTimeSince(start));
    }
  }
}