MLSFallback.cpp

/* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/* vim: set ts=8 sts=2 et sw=2 tw=80: */
/* This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/. */

#include "MLSFallback.h"
#include "GeolocationPosition.h"
#include "nsComponentManagerUtils.h"
#include "nsIGeolocationProvider.h"
#include "nsServiceManagerUtils.h"
#include "mozilla/Logging.h"
#include "mozilla/glean/DomGeolocationMetrics.h"

extern mozilla::LazyLogModule gGeolocationLog;

NS_IMPL_ISUPPORTS(MLSFallback, nsITimerCallback, nsINamed)

MLSFallback::MLSFallback(uint32_t delay) : mDelayMs(delay) {}

MLSFallback::~MLSFallback() = default;

mozilla::glean::geolocation::FallbackLabel MapReasonToLabel(
    MLSFallback::FallbackReason aReason) {
  switch (aReason) {
    case MLSFallback::FallbackReason::Error:
      return mozilla::glean::geolocation::FallbackLabel::eOnError;
    case MLSFallback::FallbackReason::Timeout:
      return mozilla::glean::geolocation::FallbackLabel::eOnTimeout;
    default:
      MOZ_CRASH("Unexpected fallback reason");
      return mozilla::glean::geolocation::FallbackLabel::eOnError;
  }
}

nsresult MLSFallback::Startup(nsIGeolocationUpdate* aWatcher,
                              FallbackReason aReason) {
  if (mHandoffTimer || mMLSFallbackProvider) {
    return NS_OK;
  }

  mUpdateWatcher = aWatcher;

  // No need to schedule a timer callback if there is no startup delay.
  if (mDelayMs == 0) {
    mozilla::glean::geolocation::fallback.EnumGet(MapReasonToLabel(aReason))
        .Add();
    return CreateMLSFallbackProvider();
  }

  return NS_NewTimerWithCallback(getter_AddRefs(mHandoffTimer), this, mDelayMs,
                                 nsITimer::TYPE_ONE_SHOT);
}

nsresult MLSFallback::Shutdown(ShutdownReason aReason) {
  if (aReason == ShutdownReason::ProviderResponded) {
    mozilla::glean::geolocation::fallback
        .EnumGet(mozilla::glean::geolocation::FallbackLabel::eNone)
        .Add();
  }

  mUpdateWatcher = nullptr;

  if (mHandoffTimer) {
    mHandoffTimer->Cancel();
    mHandoffTimer = nullptr;
  }

  nsresult rv = NS_OK;
  if (mMLSFallbackProvider) {
    rv = mMLSFallbackProvider->Shutdown();
    mMLSFallbackProvider = nullptr;
  }
  return rv;
}

NS_IMETHODIMP
MLSFallback::Notify(nsITimer* aTimer) {
  mozilla::glean::geolocation::fallback
      .EnumGet(mozilla::glean::geolocation::FallbackLabel::eOnTimeout)
      .Add();
  return CreateMLSFallbackProvider();
}

NS_IMETHODIMP
MLSFallback::GetName(nsACString& aName) {
  aName.AssignLiteral("MLSFallback");
  return NS_OK;
}

nsresult MLSFallback::CreateMLSFallbackProvider() {
  if (mMLSFallbackProvider || !mUpdateWatcher) {
    return NS_OK;
  }

  MOZ_LOG(gGeolocationLog, mozilla::LogLevel::Debug,
          ("Falling back to NetworkLocationProvider"));

  nsresult rv;
  mMLSFallbackProvider =
      do_CreateInstance("@mozilla.org/geolocation/mls-provider;1", &rv);
  NS_ENSURE_SUCCESS(rv, rv);

  if (mMLSFallbackProvider) {
    rv = mMLSFallbackProvider->Startup();
    if (NS_SUCCEEDED(rv)) {
      MOZ_LOG(gGeolocationLog, mozilla::LogLevel::Debug,
              ("Successfully started up NetworkLocationProvider"));
      mMLSFallbackProvider->Watch(mUpdateWatcher);
    }
  }
  mUpdateWatcher = nullptr;
  return rv;
}