components/webapps/browser/installable/installable_logging.h

// Copyright 2016 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#ifndef COMPONENTS_WEBAPPS_BROWSER_INSTALLABLE_INSTALLABLE_LOGGING_H_
#define COMPONENTS_WEBAPPS_BROWSER_INSTALLABLE_INSTALLABLE_LOGGING_H_

#include <string>

#include "third_party/blink/public/mojom/devtools/console_message.mojom-forward.h"

namespace content {
struct InstallabilityError;
class WebContents;
}  // namespace content

namespace webapps {

// These values are a central reference for installability errors. The
// InstallableManager will specify an InstallableStatusCode (or
// NO_ERROR_DETECTED) in its result. Clients may also add their own error codes,
// and utilise LogToConsole to write a message to the devtools console. This
// enum backs an UMA histogram, so it must be treated as append-only.
enum class InstallableStatusCode {
  NO_ERROR_DETECTED = 0,
  RENDERER_EXITING = 1,
  RENDERER_CANCELLED = 2,
  USER_NAVIGATED = 3,
  // NOT_IN_MAIN_FRAME = 4 (DEPRECATED),
  NOT_FROM_SECURE_ORIGIN = 5,
  NO_MANIFEST = 6,
  // The manifest failed to parse, the network failed, or the document is an
  // opaque origin.
  // Note: This was renamed from MANIFEST_EMPTY now that the document can return
  // a default manifest.
  MANIFEST_PARSING_OR_NETWORK_ERROR = 7,
  START_URL_NOT_VALID = 8,
  MANIFEST_MISSING_NAME_OR_SHORT_NAME = 9,
  MANIFEST_DISPLAY_NOT_SUPPORTED = 10,
  MANIFEST_MISSING_SUITABLE_ICON = 11,
  // NO_MATCHING_SERVICE_WORKER = 12 (DEPRECATED),
  NO_ACCEPTABLE_ICON = 13,
  CANNOT_DOWNLOAD_ICON = 14,
  NO_ICON_AVAILABLE = 15,
  PLATFORM_NOT_SUPPORTED_ON_ANDROID = 16,
  NO_ID_SPECIFIED = 17,
  IDS_DO_NOT_MATCH = 18,
  ALREADY_INSTALLED = 19,
  // INSUFFICIENT_ENGAGEMENT = 20 (DEPRECATED),
  PACKAGE_NAME_OR_START_URL_EMPTY = 21,
  PREVIOUSLY_BLOCKED = 22,
  PREVIOUSLY_IGNORED = 23,
  SHOWING_NATIVE_APP_BANNER = 24,
  SHOWING_WEB_APP_BANNER = 25,
  FAILED_TO_CREATE_BANNER = 26,
  URL_NOT_SUPPORTED_FOR_WEBAPK = 27,
  IN_INCOGNITO = 28,
  // NOT_OFFLINE_CAPABLE = 29 (DEPRECATED),
  WAITING_FOR_MANIFEST = 30,
  WAITING_FOR_INSTALLABLE_CHECK = 31,
  NO_GESTURE = 32,
  WAITING_FOR_NATIVE_DATA = 33,
  SHOWING_APP_INSTALLATION_DIALOG = 34,
  // NO_URL_FOR_SERVICE_WORKER = 35 (DEPRECATED),
  PREFER_RELATED_APPLICATIONS = 36,
  PREFER_RELATED_APPLICATIONS_SUPPORTED_ONLY_BETA_STABLE = 37,
  MANIFEST_URL_CHANGED = 38,
  MANIFEST_DISPLAY_OVERRIDE_NOT_SUPPORTED = 39,
  // WARN_NOT_OFFLINE_CAPABLE = 40 (DEPRECATED),
  PIPELINE_RESTARTED = 41,
  DATA_TIMED_OUT = 42,
  WEBAPK_INSTALL_FAILED = 43,
  // MANIFEST_URL_SCHEME_NOT_SUPPORTED_FOR_WEBAPK = 44 (DEPRECATED),
  // SERVICE_WORKER_NOT_REQUIRED = 45 (DEPRECATED),
  MAX_ERROR_CODE = WEBAPK_INSTALL_FAILED,
  kMaxValue = MAX_ERROR_CODE,
};

// Returns a user-readable description for |code|, or an empty string if |code|
// should not be exposed.
std::string GetErrorMessage(InstallableStatusCode code);
content::InstallabilityError GetInstallabilityError(InstallableStatusCode code);

// Logs a message associated with |code| to the devtools console attached to
// |web_contents|. Does nothing if |web_contents| is nullptr.
void LogToConsole(content::WebContents* web_contents,
                  InstallableStatusCode code,
                  blink::mojom::ConsoleMessageLevel level);

}  // namespace webapps

#endif  // COMPONENTS_WEBAPPS_BROWSER_INSTALLABLE_INSTALLABLE_LOGGING_H_