No singleton: ChannelContext, ChannelBuilder and channel cache (#2455)

* Fusionned ChannelBuilder and ChannelContext and channel cache * ChannelContext is not a singleton anymore. * libmambapy now holds singletons for ChannelContext etc. * formatting * Simplified libmambapy singleton handling. * formatting
mamba-org · May 17, 2023 · ea8249b · ea8249b
1 parent 2b7268b
commit ea8249b
Show file tree

Hide file tree

Showing 57 changed files with 768 additions and 542 deletions.
diff --git a/libmamba/CMakeLists.txt b/libmamba/CMakeLists.txt
@@ -208,7 +208,6 @@ set(LIBMAMBA_PUBLIC_HEADERS
     # Core API (low-level)
     ${LIBMAMBA_INCLUDE_DIR}/mamba/core/activation.hpp
     ${LIBMAMBA_INCLUDE_DIR}/mamba/core/channel.hpp
-    ${LIBMAMBA_INCLUDE_DIR}/mamba/core/channel_builder.hpp
     ${LIBMAMBA_INCLUDE_DIR}/mamba/core/palette.hpp
     ${LIBMAMBA_INCLUDE_DIR}/mamba/core/context.hpp
     ${LIBMAMBA_INCLUDE_DIR}/mamba/core/environment.hpp

diff --git a/libmamba/include/mamba/api/info.hpp b/libmamba/include/mamba/api/info.hpp
@@ -16,6 +16,8 @@
 
 namespace mamba
 {
+    class ChannelContext;
+
     void info();
 
     std::string version();
@@ -34,7 +36,7 @@ namespace mamba
 
     namespace detail
     {
-        void print_info();
+        void print_info(ChannelContext& channel_context);
     }
 }
 

diff --git a/libmamba/include/mamba/api/install.hpp b/libmamba/include/mamba/api/install.hpp
@@ -24,17 +24,25 @@
 
 namespace mamba
 {
+    class ChannelContext;
+
     void install();
 
     void install_specs(
+        ChannelContext& channel_context,
         const std::vector<std::string>& specs,
         bool create_env = false,
         int solver_flag = SOLVER_INSTALL,
         int is_retry = 0
     );
 
-    void install_explicit_specs(const std::vector<std::string>& specs, bool create_env = false);
+    void install_explicit_specs(
+        ChannelContext& channel_context,
+        const std::vector<std::string>& specs,
+        bool create_env = false
+    );
     void install_lockfile_specs(
+        ChannelContext& channel_context,
         const std::string& lockfile_specs,
         const std::vector<std::string>& categories,
         bool create_env = false
@@ -73,7 +81,7 @@ namespace mamba
         yaml_file_contents read_yaml_file(fs::u8path yaml_file);
 
         std::tuple<std::vector<PackageInfo>, std::vector<MatchSpec>>
-        parse_urls_to_package_info(const std::vector<std::string>& urls);
+        parse_urls_to_package_info(const std::vector<std::string>& urls, ChannelContext& channel_context);
 
         inline void to_json(nlohmann::json&, const other_pkg_mgr_spec&)
         {

diff --git a/libmamba/include/mamba/api/list.hpp b/libmamba/include/mamba/api/list.hpp
@@ -11,11 +11,13 @@
 
 namespace mamba
 {
+    class ChannelContext;
+
     void list(const std::string& regex);
 
     namespace detail
     {
-        void list_packages(std::string regex);
+        void list_packages(std::string regex, ChannelContext& channel_context);
 
         struct formatted_pkg;
 

diff --git a/libmamba/include/mamba/api/remove.hpp b/libmamba/include/mamba/api/remove.hpp
@@ -14,11 +14,18 @@
 
 namespace mamba
 {
+    class ChannelContext;
+
     void remove(int flags = MAMBA_REMOVE_PRUNE);
 
     namespace detail
     {
-        void remove_specs(const std::vector<std::string>& specs, bool prune, bool force);
+        void remove_specs(
+            ChannelContext& channel_context,
+            const std::vector<std::string>& specs,
+            bool prune,
+            bool force
+        );
     }
 }
 

diff --git a/libmamba/include/mamba/core/channel.hpp b/libmamba/include/mamba/core/channel.hpp
@@ -18,10 +18,18 @@
 
 namespace mamba
 {
+    class ChannelContext;
+
+    // Note: Channels can only be created using ChannelContext.
     class Channel
     {
     public:
 
+        Channel(const Channel&) = delete;
+        Channel& operator=(const Channel&) = delete;
+        Channel(Channel&&) noexcept = default;
+        Channel& operator=(Channel&&) noexcept = default;
+
         const std::string& scheme() const;
         const std::string& location() const;
         const std::string& name() const;
@@ -39,9 +47,15 @@ namespace mamba
         platform_urls(bool with_credential = true) const;
         std::vector<std::string> urls(bool with_credential = true) const;
 
+        ChannelContext& channel_context() const
+        {
+            return *m_channel_context;
+        }
+
     private:
 
         Channel(
+            ChannelContext& channel_context,
             const std::string& scheme,
             const std::string& location,
             const std::string& name,
@@ -60,17 +74,79 @@ namespace mamba
         std::optional<std::string> m_package_filename;
         mutable std::optional<std::string> m_canonical_name;
         mutable std::unique_ptr<validation::RepoChecker> p_repo_checker;
+        ChannelContext* m_channel_context = nullptr;
 
-        friend class ChannelBuilder;
+        friend class ChannelContext;
     };
 
     bool operator==(const Channel& lhs, const Channel& rhs);
     bool operator!=(const Channel& lhs, const Channel& rhs);
 
-    const Channel& make_channel(const std::string& value);
-    std::vector<const Channel*> get_channels(const std::vector<std::string>& channel_names);
 
-    void check_whitelist(const std::vector<std::string>& urls);
+    using ChannelCache = std::map<std::string, Channel>;
+
+    class ChannelContext
+    {
+    public:
+
+        using channel_list = std::vector<std::string>;
+        using channel_map = std::map<std::string, Channel>;
+        using multichannel_map = std::map<std::string, std::vector<std::string>>;
+
+        ChannelContext();
+        ~ChannelContext();
+
+        ChannelContext(const ChannelContext&) = delete;
+        ChannelContext& operator=(const ChannelContext&) = delete;
+        ChannelContext(ChannelContext&&) = delete;
+        ChannelContext& operator=(ChannelContext&&) = delete;
+
+        const Channel& make_channel(const std::string& value);
+        std::vector<const Channel*> get_channels(const std::vector<std::string>& channel_names);
+
+        void clear_cache();
+
+        void check_whitelist(const std::vector<std::string>& urls);
+
+        // internal
+        const Channel& get_channel_alias() const;
+        const channel_map& get_custom_channels() const;
+        const multichannel_map& get_custom_multichannels() const;
+
+        const channel_list& get_whitelist_channels() const;
+
+    private:
+
+        ChannelCache m_channel_cache;
+        Channel m_channel_alias;
+        channel_map m_custom_channels;
+        multichannel_map m_custom_multichannels;
+        channel_list m_whitelist_channels;
+
+        Channel build_channel_alias();
+        void init_custom_channels();
+
+
+        Channel make_simple_channel(
+            const Channel& channel_alias,
+            const std::string& channel_url,
+            const std::string& channel_name = "",
+            const std::string& multi_name = ""
+        );
+
+        const Channel& make_cached_channel(const std::string& value);
+
+        Channel from_url(const std::string& url);
+        Channel from_name(const std::string& name);
+        Channel from_value(const std::string& value);
+        Channel from_alias(
+            const std::string& scheme,
+            const std::string& location,
+            const std::optional<std::string>& auth = {},
+            const std::optional<std::string>& token = {}
+        );
+    };
+
 }  // namespace mamba
 
 #endif
diff --git a/libmamba/include/mamba/core/channel_builder.hpp b/libmamba/include/mamba/core/channel_builder.hpp
diff --git a/libmamba/include/mamba/core/env_lockfile.hpp b/libmamba/include/mamba/core/env_lockfile.hpp
@@ -21,6 +21,7 @@
 
 namespace mamba
 {
+    class ChannelContext;
 
     enum class file_parsing_error_code
     {
@@ -110,7 +111,7 @@ namespace mamba
     /// Read an environment lock YAML file and returns it's structured content or an error if
     /// failed.
     tl::expected<EnvironmentLockFile, mamba_error>
-    read_environment_lockfile(const fs::u8path& lockfile_location);
+    read_environment_lockfile(ChannelContext& channel_context, const fs::u8path& lockfile_location);
 
 
     /// Returns `true` if the filename matches names of files which should be interpreted as conda

diff --git a/libmamba/include/mamba/core/history.hpp b/libmamba/include/mamba/core/history.hpp
@@ -21,7 +21,7 @@ namespace mamba
     {
     public:
 
-        History(const fs::u8path& prefix);
+        History(const fs::u8path& prefix, ChannelContext& channel_context);
 
         struct ParseResult
         {
@@ -54,6 +54,7 @@ namespace mamba
 
         fs::u8path m_prefix;
         fs::u8path m_history_file_path;
+        ChannelContext& m_channel_context;
     };
 
 }  // namespace mamba

diff --git a/libmamba/include/mamba/core/match_spec.hpp b/libmamba/include/mamba/core/match_spec.hpp
@@ -14,15 +14,17 @@
 
 namespace mamba
 {
+    class ChannelContext;
+
     class MatchSpec
     {
     public:
 
         MatchSpec() = default;
-        // TODO make explicit
-        MatchSpec(std::string_view i_spec);
 
-        void parse();
+        MatchSpec(std::string_view i_spec, ChannelContext& channel_context);
+
+        void parse(ChannelContext& channel_context);
         std::string conda_build_form() const;
         std::string str() const;
 

diff --git a/libmamba/include/mamba/core/pinning.hpp b/libmamba/include/mamba/core/pinning.hpp
@@ -15,7 +15,7 @@
 
 namespace mamba
 {
-    std::string python_pin(const PrefixData& prefix_data, const std::vector<std::string>& specs);
+    std::string python_pin(PrefixData& prefix_data, const std::vector<std::string>& specs);
 
     std::vector<std::string> file_pins(const fs::u8path& file);
 }

diff --git a/libmamba/include/mamba/core/pool.hpp b/libmamba/include/mamba/core/pool.hpp
@@ -17,6 +17,7 @@
 namespace mamba
 {
     class MatchSpec;
+    class ChannelContext;
 
     namespace solv
     {
@@ -35,7 +36,7 @@ namespace mamba
     {
     public:
 
-        MPool();
+        MPool(ChannelContext& channel_context);
         ~MPool();
 
         void set_debuglevel();
@@ -57,6 +58,8 @@ namespace mamba
 
         void remove_repo(::Id repo_id, bool reuse_ids);
 
+        ChannelContext& channel_context() const;
+
     private:
 
         struct MPoolData;