SentryIntegrationPackageStorage.java

package io.sentry;

import io.sentry.protocol.SentryPackage;
import io.sentry.util.AutoClosableReentrantLock;
import io.sentry.util.Objects;
import java.util.Set;
import java.util.concurrent.CopyOnWriteArraySet;
import org.jetbrains.annotations.ApiStatus;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;
import org.jetbrains.annotations.TestOnly;

@ApiStatus.Internal
public final class SentryIntegrationPackageStorage {
  private static volatile @Nullable SentryIntegrationPackageStorage INSTANCE;
  private static final @NotNull AutoClosableReentrantLock staticLock =
      new AutoClosableReentrantLock();
  private static volatile @Nullable Boolean mixedVersionsDetected = null;
  private static final @NotNull AutoClosableReentrantLock mixedVersionsLock =
      new AutoClosableReentrantLock();

  public static @NotNull SentryIntegrationPackageStorage getInstance() {
    if (INSTANCE == null) {
      try (final @NotNull ISentryLifecycleToken ignored = staticLock.acquire()) {
        if (INSTANCE == null) {
          INSTANCE = new SentryIntegrationPackageStorage();
        }
      }
    }

    return INSTANCE;
  }

  /**
   * List of integrations that are enabled in the SDK. _Optional._
   *
   * <p>The list should have all enabled integrations, including default integrations. Default
   * integrations are included because different SDK releases may contain different default
   * integrations.
   */
  private final Set<String> integrations = new CopyOnWriteArraySet<>();

  /**
   * List of installed and loaded SDK packages. _Optional._
   *
   * <p>A list of packages that were installed as part of this SDK or the activated integrations.
   * Each package consists of a name in the format `source:identifier` and `version`. If the source
   * is a Git repository, the `source` should be `git`, the identifier should be a checkout link and
   * the version should be a Git reference (branch, tag or SHA).
   */
  private final Set<SentryPackage> packages = new CopyOnWriteArraySet<>();

  private SentryIntegrationPackageStorage() {}

  public void addIntegration(final @NotNull String integration) {
    Objects.requireNonNull(integration, "integration is required.");
    integrations.add(integration);
  }

  public @NotNull Set<String> getIntegrations() {
    return integrations;
  }

  public void addPackage(final @NotNull String name, final @NotNull String version) {
    Objects.requireNonNull(name, "name is required.");
    Objects.requireNonNull(version, "version is required.");

    SentryPackage newPackage = new SentryPackage(name, version);
    packages.add(newPackage);
    try (final @NotNull ISentryLifecycleToken ignored = mixedVersionsLock.acquire()) {
      mixedVersionsDetected = null;
    }
  }

  public @NotNull Set<SentryPackage> getPackages() {
    return packages;
  }

  public boolean checkForMixedVersions(final @NotNull ILogger logger) {
    final @Nullable Boolean mixedVersionsDetectedBefore = mixedVersionsDetected;
    if (mixedVersionsDetectedBefore != null) {
      return mixedVersionsDetectedBefore;
    }
    try (final @NotNull ISentryLifecycleToken ignored = mixedVersionsLock.acquire()) {
      final @NotNull String sdkVersion = BuildConfig.VERSION_NAME;
      boolean mixedVersionsDetectedThisCheck = false;

      for (SentryPackage pkg : packages) {
        if (pkg.getName().startsWith("maven:io.sentry:")
            && !sdkVersion.equalsIgnoreCase(pkg.getVersion())) {
          logger.log(
              SentryLevel.ERROR,
              "The Sentry SDK has been configured with mixed versions. Expected %s to match core SDK version %s but was %s",
              pkg.getName(),
              sdkVersion,
              pkg.getVersion());
          mixedVersionsDetectedThisCheck = true;
        }
      }

      if (mixedVersionsDetectedThisCheck) {
        logger.log(SentryLevel.ERROR, "^^^^^^^^^^^^^^^^^^^^^^^^^^^^");
        logger.log(SentryLevel.ERROR, "^^^^^^^^^^^^^^^^^^^^^^^^^^^^");
        logger.log(SentryLevel.ERROR, "^^^^^^^^^^^^^^^^^^^^^^^^^^^^");
        logger.log(SentryLevel.ERROR, "^^^^^^^^^^^^^^^^^^^^^^^^^^^^");
      }
      mixedVersionsDetected = mixedVersionsDetectedThisCheck;
      return mixedVersionsDetectedThisCheck;
    }
  }

  @TestOnly
  public void clearStorage() {
    integrations.clear();
    packages.clear();
  }
}