File: install_web_app_action_performer.cc

package info (click to toggle)
chromium 139.0.7258.127-1
  • links: PTS, VCS
  • area: main
  • in suites:
  • size: 6,122,068 kB
  • sloc: cpp: 35,100,771; ansic: 7,163,530; javascript: 4,103,002; python: 1,436,920; asm: 946,517; xml: 746,709; pascal: 187,653; perl: 88,691; sh: 88,436; objc: 79,953; sql: 51,488; cs: 44,583; fortran: 24,137; makefile: 22,147; tcl: 15,277; php: 13,980; yacc: 8,984; ruby: 7,485; awk: 3,720; lisp: 3,096; lex: 1,327; ada: 727; jsp: 228; sed: 36
file content (153 lines) | stat: -rw-r--r-- 5,911 bytes parent folder | download | duplicates (6)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
// Copyright 2023 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#include "chrome/browser/ash/growth/install_web_app_action_performer.h"

#include "base/functional/bind.h"
#include "base/strings/utf_string_conversions.h"
#include "base/values.h"
#include "chrome/browser/profiles/profile_manager.h"
#include "chrome/browser/web_applications/mojom/user_display_mode.mojom.h"
#include "chrome/browser/web_applications/web_app_command_scheduler.h"
#include "chrome/browser/web_applications/web_app_constants.h"
#include "chrome/browser/web_applications/web_app_helpers.h"
#include "chrome/browser/web_applications/web_app_install_info.h"
#include "chrome/browser/web_applications/web_app_provider.h"
#include "chromeos/ash/components/growth/campaigns_logger.h"
#include "components/services/app_service/public/cpp/icon_info.h"
#include "components/webapps/browser/install_result_code.h"
#include "components/webapps/browser/installable/installable_metrics.h"
#include "components/webapps/common/web_app_id.h"

namespace {

inline constexpr char kLaunchInStandaloneWindow[] = "launchInStandaloneWindow";
inline constexpr char kAppTitle[] = "appTitle";
inline constexpr char kUrl[] = "url";
inline constexpr char kIconUrl[] = "iconPath";

std::unique_ptr<web_app::WebAppInstallInfo> GetAppInstallInfo(
    const base::Value::Dict& entry) {
  std::optional<bool> launch_in_standalone_window =
      entry.FindBool(kLaunchInStandaloneWindow);
  auto* app_title = entry.FindString(kAppTitle);
  auto* url = entry.FindString(kUrl);
  auto* icon_url = entry.FindString(kIconUrl);

  // Ensure that the required fields are present.
  if (!launch_in_standalone_window.has_value() || !app_title || !url) {
    return nullptr;
  }

  GURL url_parsed = GURL(*url);
  if (!url_parsed.is_valid()) {
    return nullptr;
  }

  // Campaigns don't specify a `manifest_id`, so each unique `start_url` will be
  // treated as a unique app.
  webapps::ManifestId manifest_id =
      web_app::GenerateManifestIdFromStartUrlOnly(url_parsed);
  auto info =
      std::make_unique<web_app::WebAppInstallInfo>(manifest_id, url_parsed);
  info->title = base::UTF8ToUTF16(*app_title);
  if (icon_url && GURL(*icon_url).is_valid()) {
    info->manifest_icons.push_back(apps::IconInfo(GURL(*icon_url), 32));
  }

  info->display_mode = launch_in_standalone_window.value()
                           ? blink::mojom::DisplayMode::kStandalone
                           : blink::mojom::DisplayMode::kBrowser;
  return info;
}

std::unique_ptr<web_app::WebAppInstallInfo>
ParseInstallWebAppActionPerformerParams(const base::Value::Dict* params) {
  if (!params) {
    CAMPAIGNS_LOG(ERROR) << "Empty parameter to InstallWebAction.";
    return nullptr;
  }

  return GetAppInstallInfo(*params);
}

void InstallWebAppResult(growth::ActionPerformer::Callback callback,
                         const std::string& app_id,
                         webapps::InstallResultCode code) {
  const std::array<webapps::InstallResultCode, 4> success_codes = {
      webapps::InstallResultCode::kSuccessNewInstall,
      webapps::InstallResultCode::kSuccessAlreadyInstalled,
      webapps::InstallResultCode::kSuccessOfflineOnlyInstall,
      webapps::InstallResultCode::kSuccessOfflineFallbackInstall};

  if (std::find(success_codes.begin(), success_codes.end(), code) !=
      success_codes.end()) {
    std::move(callback).Run(growth::ActionResult::kSuccess,
                            /* action_result_reason= */ std::nullopt);
    return;
  }

  // TODO(b/306023057): Record an UMA metric regarding why
  // we were not able to successfully record the app.
  std::move(callback).Run(
      growth::ActionResult::kFailure,
      growth::ActionResultReason::kWebAppInstallFailedOther);
}

void InstallWebAppImpl(web_app::WebAppProvider& provider,
                       std::unique_ptr<web_app::WebAppInstallInfo> web_app_info,
                       growth::ActionPerformer::Callback callback) {
  provider.scheduler().InstallFromInfoWithParams(
      std::move(web_app_info), /* overwrite_existing_manifest_fields= */ true,
      webapps::WebappInstallSource::EXTERNAL_DEFAULT,
      base::BindOnce(&InstallWebAppResult, std::move(callback)),
      web_app::WebAppInstallParams());
}

web_app::WebAppProvider* GetWebAppProvider() {
  auto* profile = ProfileManager::GetPrimaryUserProfile();
  return web_app::WebAppProvider::GetForWebApps(profile);
}

void TriggerWebAppInstall(std::unique_ptr<web_app::WebAppInstallInfo> info,
                          growth::ActionPerformer::Callback callback) {
  auto* provider = GetWebAppProvider();
  CHECK(provider);
  provider->on_registry_ready().Post(
      FROM_HERE, base::BindOnce(InstallWebAppImpl, std::ref(*provider),
                                std::move(info), std::move(callback)));
}

}  // namespace

InstallWebAppActionPerformer::InstallWebAppActionPerformer() = default;
InstallWebAppActionPerformer::~InstallWebAppActionPerformer() = default;

void InstallWebAppActionPerformer::Run(
    int campaign_id,
    std::optional<int> group_id,
    const base::Value::Dict* params,
    growth::ActionPerformer::Callback callback) {
  if (!GetWebAppProvider()) {
    std::move(callback).Run(
        growth::ActionResult::kFailure,
        growth::ActionResultReason::kWebAppProviderNotAvailable);
    return;
  }

  auto info = ParseInstallWebAppActionPerformerParams(params);
  if (!info) {
    // TODO(b/306023057): Record an UMA metric that parsing the params
    // has failed.
    std::move(callback).Run(growth::ActionResult::kFailure,
                            growth::ActionResultReason::kParsingActionFailed);
    return;
  }

  TriggerWebAppInstall(std::move(info), std::move(callback));
}

growth::ActionType InstallWebAppActionPerformer::ActionType() const {
  return growth::ActionType::kInstallWebApp;
}