chrome/browser/web_applications/web_app_registry_update.h

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

#ifndef CHROME_BROWSER_WEB_APPLICATIONS_WEB_APP_REGISTRY_UPDATE_H_
#define CHROME_BROWSER_WEB_APPLICATIONS_WEB_APP_REGISTRY_UPDATE_H_

#include <memory>
#include <vector>

#include "base/functional/callback.h"
#include "base/memory/raw_ptr.h"
#include "base/types/pass_key.h"
#include "components/webapps/common/web_app_id.h"

namespace web_app {

class WebApp;
class WebAppRegistrar;
class WebAppSyncBridge;

// A raw registry update data.
struct RegistryUpdateData {
  RegistryUpdateData();
  RegistryUpdateData(const RegistryUpdateData&) = delete;
  RegistryUpdateData& operator=(const RegistryUpdateData&) = delete;
  ~RegistryUpdateData();

  using Apps = std::vector<std::unique_ptr<WebApp>>;
  Apps apps_to_create;
  Apps apps_to_update;

  std::vector<webapps::AppId> apps_to_delete;

  bool IsEmpty() const;

};

// An explicit writable "view" for the registry. Any write operations must be
// batched as a part of WebAppRegistryUpdate object. Effectively
// WebAppRegistryUpdate is a part of WebAppSyncBridge class.
class WebAppRegistryUpdate {
 public:
  WebAppRegistryUpdate(const WebAppRegistrar* registrar,
                       base::PassKey<WebAppSyncBridge>);
  WebAppRegistryUpdate(const WebAppRegistryUpdate&) = delete;
  WebAppRegistryUpdate& operator=(const WebAppRegistryUpdate&) = delete;
  ~WebAppRegistryUpdate();

  // DO NOT USE THIS TO INSTALL A WEB APP IN TESTS.
  // Please use web_app_install_test_utils.h or web_app_browsertest_util.h.
  // TODO(https://crbug.com/411126942): Add a passkey or make this private so
  // only system internals can call this.
  void CreateApp(std::unique_ptr<WebApp> web_app);
  // Delete registered app.
  void DeleteApp(const webapps::AppId& app_id);
  // Acquire a mutable existing app to set new field values.
  WebApp* UpdateApp(const webapps::AppId& app_id);

  std::unique_ptr<RegistryUpdateData> TakeUpdateData(
      base::PassKey<WebAppSyncBridge> pass_key);

 private:
  std::unique_ptr<RegistryUpdateData> update_data_;
  const raw_ptr<const WebAppRegistrar> registrar_;
};

// A convenience utility class to use RAII for `WebAppSyncBridge::BeginUpdate`
// and `WebAppSyncBridge::CommitUpdate` calls.
class [[nodiscard]] ScopedRegistryUpdate {
 public:
  ScopedRegistryUpdate(
      base::PassKey<WebAppSyncBridge>,
      std::unique_ptr<WebAppRegistryUpdate> update,
      base::OnceCallback<void(std::unique_ptr<WebAppRegistryUpdate>)>
          commit_update);
  ScopedRegistryUpdate(ScopedRegistryUpdate&&) noexcept;
  ScopedRegistryUpdate(const ScopedRegistryUpdate&) = delete;
  ScopedRegistryUpdate& operator=(const ScopedRegistryUpdate&) = delete;
  ~ScopedRegistryUpdate();

  WebAppRegistryUpdate* operator->() { return update_.get(); }

 private:
  std::unique_ptr<WebAppRegistryUpdate> update_;
  base::OnceCallback<void(std::unique_ptr<WebAppRegistryUpdate>)>
      commit_update_;
};

}  // namespace web_app

#endif  // CHROME_BROWSER_WEB_APPLICATIONS_WEB_APP_REGISTRY_UPDATE_H_