chrome/browser/permissions/prediction_service/prediction_model_handler_provider.h

// Copyright 2022 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_PERMISSIONS_PREDICTION_SERVICE_PREDICTION_MODEL_HANDLER_PROVIDER_H_
#define CHROME_BROWSER_PERMISSIONS_PREDICTION_SERVICE_PREDICTION_MODEL_HANDLER_PROVIDER_H_

#include <memory>

#include "base/scoped_observation.h"
#include "components/keyed_service/core/keyed_service.h"
#include "components/optimization_guide/core/delivery/optimization_guide_model_provider.h"
#include "components/optimization_guide/machine_learning_tflite_buildflags.h"
#include "components/passage_embeddings/passage_embeddings_types.h"
#include "components/permissions/request_type.h"

class OptimizationGuideKeyedService;

namespace permissions {

class PredictionModelHandler;
class PermissionsAiv1Handler;
class PermissionsAiv3Handler;
class PermissionsAiv4Handler;

class PredictionModelHandlerProvider
    : public KeyedService,
      public passage_embeddings::EmbedderMetadataObserver {
 public:
  explicit PredictionModelHandlerProvider(
      OptimizationGuideKeyedService* optimization_guide,
      passage_embeddings::EmbedderMetadataProvider* embedder_metadata_provider,
      passage_embeddings::Embedder* passage_embedder);
  ~PredictionModelHandlerProvider() override;
  PredictionModelHandlerProvider(const PredictionModelHandlerProvider&) =
      delete;
  PredictionModelHandlerProvider& operator=(
      const PredictionModelHandlerProvider&) = delete;

  PermissionsAiv1Handler* GetPermissionsAiv1Handler();

#if BUILDFLAG(BUILD_WITH_TFLITE_LIB)

  static bool IsAiv4ModelAvailable();
  PredictionModelHandler* GetPredictionModelHandler(RequestType request_type);
  PermissionsAiv3Handler* GetPermissionsAiv3Handler(RequestType request_type);
  PermissionsAiv4Handler* GetPermissionsAiv4Handler(RequestType request_type);
  passage_embeddings::Embedder* GetPassageEmbedder();
  bool IsPassageEmbedderReady() const;

  void set_permissions_aiv3_handler_for_testing(
      RequestType request_type,
      std::unique_ptr<PermissionsAiv3Handler> handler);
  void set_permissions_aiv4_handler_for_testing(
      RequestType request_type,
      std::unique_ptr<PermissionsAiv4Handler> handler);
  void set_passage_embedder_for_testing(
      passage_embeddings::Embedder* passage_embedder_);
#endif  // BUILDFLAG(BUILD_WITH_TFLITE_LIB)

 private:
  // EmbedderMetadataObserver:
  void EmbedderMetadataUpdated(
      passage_embeddings::EmbedderMetadata metadata) override;

  std::unique_ptr<PermissionsAiv1Handler> permissions_aiv1_handler_;
#if BUILDFLAG(BUILD_WITH_TFLITE_LIB)
  std::unique_ptr<PredictionModelHandler>
      notification_prediction_model_handler_;
  std::unique_ptr<PredictionModelHandler> geolocation_prediction_model_handler_;
  std::unique_ptr<PermissionsAiv3Handler> notification_aiv3_handler_;
  std::unique_ptr<PermissionsAiv3Handler> geolocation_aiv3_handler_;
  std::unique_ptr<PermissionsAiv4Handler> notification_aiv4_handler_;
  std::unique_ptr<PermissionsAiv4Handler> geolocation_aiv4_handler_;
  // This embedder is required to preprocess the inner_text to create the
  // embeddings we use for the AIv4 tflite model as input.
  raw_ptr<passage_embeddings::Embedder> passage_embedder_;

  // True if the passage embedder model is ready to be used. This is a
  // dependency for the AIv4 permission prediction model, which requires text
  // embeddings as input. This value is updated via the
  // EmbedderMetadataObserver interface.
  bool is_passage_embedder_ready_ = false;
  base::ScopedObservation<passage_embeddings::EmbedderMetadataProvider,
                          passage_embeddings::EmbedderMetadataObserver>
      embedder_metadata_observation_{this};
#endif  // BUILDFLAG(BUILD_WITH_TFLITE_LIB)
};
}  // namespace permissions
#endif  // CHROME_BROWSER_PERMISSIONS_PREDICTION_SERVICE_PREDICTION_MODEL_HANDLER_PROVIDER_H_