gitlab-cloud-connector 0.2.1 → 0.2.3

data/config/unit_primitives/generate_code.yml

@@ -2,7 +2,6 @@
 name: generate_code
 description: Helps you write code more efficiently by generating code as you type.
 cut_off_date: 2024-02-15T00:00:00+00:00
-min_gitlab_version_for_free_access:
 min_gitlab_version: "16.8"
 unit_primitive_issue_url: https://gitlab.com/gitlab-org/gitlab/-/issues/497813
 introduced_by_url: https://gitlab.com/gitlab-org/cloud-connector/gitlab-cloud-connector/-/merge_requests/46
@@ -14,6 +13,3 @@ backend_services:
 add_ons:
   - duo_pro
   - duo_enterprise
-license_types:
-  - premium
-  - ultimate

data/config/unit_primitives/generate_commit_message.yml

@@ -2,16 +2,11 @@
 name: generate_commit_message
 description: Generate a Git commit message.
 cut_off_date: 2024-10-17T00:00:00+00:00
-min_gitlab_version_for_free_access: '17.2'
-min_gitlab_version: '17.2'
-unit_primitive_issue_url:
-introduced_by_url:
-documentation_url:
 group: group::code review
 feature_category: code_review_workflow
+documentation_url: https://docs.gitlab.com/ee/user/gitlab_duo/#merge-commit-message-generation
+introduced_by_url: https://gitlab.com/gitlab-org/customers-gitlab-com/-/merge_requests/10371
 backend_services:
   - ai_gateway
 add_ons:
   - duo_enterprise
-license_types:
-  - ultimate

data/config/unit_primitives/generate_cube_query.yml

@@ -0,0 +1,10 @@
+---
+name: generate_cube_query
+description: Convert plain text questions about event data in to a structured query in JSON format.
+cut_off_date: 2024-10-17T00:00:00+00:00
+group: group::platform insights
+feature_category: product_analytics_visualization
+backend_services:
+  - ai_gateway
+add_ons:
+  - duo_enterprise

data/config/unit_primitives/generate_issue_description.yml

@@ -2,14 +2,10 @@
 name: generate_issue_description
 description: Generate an issue description.
 cut_off_date: 2024-10-17T00:00:00+00:00
-unit_primitive_issue_url:
-introduced_by_url:
-documentation_url:
 group: group::project management
 feature_category: team_planning
+documentation_url: https://docs.gitlab.com/ee/user/gitlab_duo/#issue-description-generation
 backend_services:
   - ai_gateway
 add_ons:
   - duo_enterprise
-license_types:
-  - ultimate

data/config/unit_primitives/glab_ask_git_command.yml

@@ -2,16 +2,12 @@
 name: glab_ask_git_command
 description: Discover or recall git commands when and where you need them.
 cut_off_date: 2024-10-17T00:00:00+00:00
-min_gitlab_version_for_free_access: '17.2'
 min_gitlab_version: '17.2'
-unit_primitive_issue_url:
-introduced_by_url:
-documentation_url:
 group: group::code review
 feature_category: code_review_workflow
+documentation_url: https://docs.gitlab.com/ee/user/gitlab_duo/#gitlab-duo-for-the-cli
+introduced_by_url: https://gitlab.com/gitlab-org/customers-gitlab-com/-/merge_requests/10298
 backend_services:
   - ai_gateway
 add_ons:
   - duo_enterprise
-license_types:
-  - ultimate

data/config/unit_primitives/include_dependency_context.yml

@@ -2,14 +2,11 @@
 name: include_dependency_context
 description: Include dependency context in the prompt.
 cut_off_date: 2024-10-17T00:00:00+00:00
-unit_primitive_issue_url:
-introduced_by_url:
-documentation_url:
 group: group::duo_chat
 feature_category: duo_chat
+unit_primitive_issue_url: https://gitlab.com/gitlab-org/gitlab/-/issues/491740
+introduced_by_url: https://gitlab.com/gitlab-org/customers-gitlab-com/-/merge_requests/11140
 backend_services:
   - ai_gateway
 add_ons:
   - duo_enterprise
-license_types:
-  - ultimate

data/config/unit_primitives/include_file_context.yml

@@ -2,16 +2,11 @@
 name: include_file_context
 description: Include file context in the prompt.
 cut_off_date: 2024-10-17T00:00:00+00:00
-unit_primitive_issue_url:
-introduced_by_url:
-documentation_url:
 group: group::duo_chat
 feature_category: duo_chat
+introduced_by_url: https://gitlab.com/gitlab-org/gitlab/-/merge_requests/168327/
 backend_services:
   - ai_gateway
 add_ons:
   - duo_enterprise
   - duo_pro
-license_types:
-  - premium
-  - ultimate

data/config/unit_primitives/include_issue_context.yml

@@ -2,14 +2,10 @@
 name: include_issue_context
 description: Include issue context in the prompt.
 cut_off_date: 2024-10-17T00:00:00+00:00
-unit_primitive_issue_url:
-introduced_by_url:
-documentation_url:
 group: group::duo_chat
 feature_category: duo_chat
+introduced_by_url: https://gitlab.com/gitlab-org/gitlab/-/merge_requests/168327/
 backend_services:
   - ai_gateway
 add_ons:
   - duo_enterprise
-license_types:
-  - ultimate

data/config/unit_primitives/include_local_git_context.yml

@@ -0,0 +1,11 @@
+---
+name: include_local_git_context
+description: Include local git context (Git Diffs/Commits) in the prompt.
+cut_off_date: 2024-10-17T00:00:00+00:00
+group: group::duo_chat
+feature_category: duo_chat
+introduced_by_url: https://gitlab.com/gitlab-org/gitlab/-/merge_requests/172401
+backend_services:
+  - ai_gateway
+add_ons:
+  - duo_enterprise

data/config/unit_primitives/include_merge_request_context.yml

@@ -2,14 +2,10 @@
 name: include_merge_request_context
 description: Include merge request context in the prompt.
 cut_off_date: 2024-10-17T00:00:00+00:00
-unit_primitive_issue_url:
-introduced_by_url:
-documentation_url:
 group: group::duo_chat
 feature_category: duo_chat
+introduced_by_url: https://gitlab.com/gitlab-org/gitlab/-/merge_requests/168327/
 backend_services:
   - ai_gateway
 add_ons:
   - duo_enterprise
-license_types:
-  - ultimate

data/config/unit_primitives/include_snippet_context.yml

@@ -2,16 +2,11 @@
 name: include_snippet_context
 description: Include snippet context in the prompt.
 cut_off_date: 2024-10-17T00:00:00+00:00
-unit_primitive_issue_url:
-introduced_by_url:
-documentation_url:
 group: group::duo_chat
 feature_category: duo_chat
+introduced_by_url: https://gitlab.com/gitlab-org/gitlab/-/merge_requests/168327/
 backend_services:
   - ai_gateway
 add_ons:
   - duo_enterprise
   - duo_pro
-license_types:
-  - premium
-  - ultimate

data/config/unit_primitives/observability_all.yml

@@ -1,14 +1,7 @@
 ---
 name: observability_all
 description: Observability unit primitive.
-cut_off_date:
-unit_primitive_issue_url:
-introduced_by_url:
-documentation_url:
 group: group::platform insights
 feature_category: observability
 backend_services:
   - observability
-license_types:
-  - premium
-  - ultimate

data/config/unit_primitives/refactor_code.yml

@@ -2,16 +2,11 @@
 name: refactor_code
 description: Refactor the selected code.
 cut_off_date: 2024-10-17T00:00:00+00:00
-unit_primitive_issue_url:
-introduced_by_url:
-documentation_url:
 group: group::duo_chat
 feature_category: duo_chat
+documentation_url: https://docs.gitlab.com/ee/user/gitlab_duo/#refactor-code
 backend_services:
   - ai_gateway
 add_ons:
   - duo_enterprise
   - duo_pro
-license_types:
-  - premium
-  - ultimate

data/config/unit_primitives/resolve_vulnerability.yml

@@ -2,16 +2,11 @@
 name: resolve_vulnerability
 description: Write code that fixes the vulnerability.
 cut_off_date: 2024-10-17T00:00:00+00:00
-min_gitlab_version_for_free_access: '17.2'
-min_gitlab_version: '17.2'
-unit_primitive_issue_url:
-introduced_by_url:
-documentation_url:
 group: group::threat insights
 feature_category: vulnerability_management
+documentation_url: https://docs.gitlab.com/ee/user/gitlab_duo/#vulnerability-resolution
+introduced_by_url: https://gitlab.com/gitlab-org/customers-gitlab-com/-/merge_requests/10457
 backend_services:
   - ai_gateway
 add_ons:
   - duo_enterprise
-license_types:
-  - ultimate

data/config/unit_primitives/review_merge_request.yml

@@ -0,0 +1,11 @@
+---
+name: review_merge_request
+description: Review new hunk and old hunk of a merge request diff.
+cut_off_date: 2024-10-17T00:00:00+00:00
+group: group::code review
+feature_category: code_review_workflow
+documentation_url: https://docs.gitlab.com/ee/user/gitlab_duo/#code-review
+backend_services:
+  - ai_gateway
+add_ons:
+  - duo_enterprise

data/config/unit_primitives/security_scans.yml

@@ -1,13 +1,7 @@
 ---
 name: security_scans
 description: Used to check your source code for known vulnerabilities.
-cut_off_date:
-unit_primitive_issue_url:
-introduced_by_url:
-documentation_url:
 group: group::static analysis
 feature_category: static_application_security_testing
 backend_services:
   - security_gateway
-license_types:
-  - ultimate

data/config/unit_primitives/semantic_search_issue.yml

@@ -0,0 +1,9 @@
+---
+name: semantic_search_issue
+description: Perform semantic search on gitlab issues for a given query.
+group: group::global search
+feature_category: global_search
+backend_services:
+  - ai_gateway
+add_ons:
+  - duo_enterprise

data/config/unit_primitives/summarize_comments.yml

@@ -2,16 +2,9 @@
 name: summarize_comments
 description: Summarize comments of the issue or epic.
 cut_off_date: 2024-10-17T00:00:00+00:00
-min_gitlab_version_for_free_access: '17.2'
-min_gitlab_version: '17.2'
-unit_primitive_issue_url:
-introduced_by_url:
-documentation_url:
 group: group::project management
 feature_category: team_planning
 backend_services:
   - ai_gateway
 add_ons:
   - duo_enterprise
-license_types:
-  - ultimate

data/config/unit_primitives/summarize_issue_discussions.yml

@@ -0,0 +1,9 @@
+---
+name: summarize_issue_discussions
+description: Summarize discussions of the issue from the comments.
+group: group::code review
+feature_category: code_review_workflow
+backend_services:
+  - ai_gateway
+add_ons:
+  - duo_enterprise

data/config/unit_primitives/summarize_merge_request.yml

@@ -0,0 +1,11 @@
+---
+name: summarize_merge_request
+description: Summarize merge request from the comments.
+cut_off_date: 2024-10-17T00:00:00+00:00
+group: group::code review
+feature_category: code_review_workflow
+documentation_url: https://docs.gitlab.com/ee/user/gitlab_duo/#merge-request-summary
+backend_services:
+  - ai_gateway
+add_ons:
+  - duo_enterprise

data/config/unit_primitives/summarize_review.yml

@@ -2,14 +2,10 @@
 name: summarize_review
 description: Summarize open reviews in merge requests.
 cut_off_date: 2024-10-17T00:00:00+00:00
-unit_primitive_issue_url:
-introduced_by_url:
-documentation_url:
 group: group::code review
 feature_category: code_review_workflow
+documentation_url: https://docs.gitlab.com/ee/user/gitlab_duo/#code-review-summary
 backend_services:
   - ai_gateway
 add_ons:
   - duo_enterprise
-license_types:
-  - ultimate

data/config/unit_primitives/troubleshoot_job.yml

@@ -2,16 +2,11 @@
 name: troubleshoot_job
 description: Troubleshoot why a GitLab CI job failed and suggest a fix for it.
 cut_off_date: 2024-10-17T00:00:00+00:00
-min_gitlab_version_for_free_access: '17.2'
-min_gitlab_version: '17.2'
-unit_primitive_issue_url:
-introduced_by_url:
-documentation_url:
 group: group::pipeline execution
 feature_category: continuous_integration
+documentation_url: https://docs.gitlab.com/ee/user/gitlab_duo/#root-cause-analysis
+introduced_by_url: https://gitlab.com/gitlab-org/customers-gitlab-com/-/merge_requests/10457
 backend_services:
   - ai_gateway
 add_ons:
   - duo_enterprise
-license_types:
-  - ultimate

data/config/unit_primitives/write_tests.yml

@@ -2,9 +2,6 @@
 name: write_tests
 description: Write tests for the selected code.
 cut_off_date: 2024-10-17T00:00:00+00:00
-unit_primitive_issue_url:
-introduced_by_url:
-documentation_url:
 group: group::duo_chat
 feature_category: duo_chat
 backend_services:
@@ -12,6 +9,3 @@ backend_services:
 add_ons:
   - duo_pro
   - duo_enterprise
-license_types:
-  - premium
-  - ultimate

data/lib/cloud_connector.rb

@@ -5,6 +5,9 @@ require 'active_support/time'
 
 module Gitlab
   module CloudConnector
-    autoload(:JsonWebToken, 'gitlab/cloud_connector/json_web_token.rb')
+    autoload(:JsonWebToken, 'gitlab/cloud_connector/json_web_token')
+    autoload(:Configuration, 'gitlab/cloud_connector/configuration')
+    autoload(:DataModels, 'gitlab/cloud_connector/data_models')
+    autoload(:AvailableServicesGenerator, 'gitlab/cloud_connector/available_services_generator')
   end
 end

data/lib/gitlab/cloud_connector/available_services_generator.rb

@@ -0,0 +1,96 @@
+# frozen_string_literal: true
+
+require 'active_support/core_ext/enumerable'
+require 'active_support/core_ext/object/blank'
+
+module Gitlab
+  module CloudConnector
+    class AvailableServicesGenerator
+      GITLAB_REALMS = %w[gitlab-com self-managed].freeze
+      WRONG_GITLAB_REALM_MESSAGE = 'Wrong gitlab_realm. Please use one of the following: %s'
+      IGNORE_UNIT_PRIMITIVES = %w[
+        agent_quick_actions
+        ask_build
+        ask_commit
+        ask_epic
+        ask_issue
+        ask_merge_request
+        categorize_duo_chat_question
+        complete_code
+        documentation_search
+        duo_workflow_execute_workflow
+        duo_workflow_generate_token
+        explain_code
+        fix_code
+        generate_code
+        generate_issue_description
+        refactor_code
+        security_scans
+        semantic_search_issue
+        summarize_issue_discussions
+        summarize_merge_request
+        write_tests
+      ].freeze
+
+      def generate(gitlab_realm)
+        raise WRONG_GITLAB_REALM_MESSAGE % GITLAB_REALMS.join(', ') unless GITLAB_REALMS.include?(gitlab_realm)
+
+        {
+          'services' => generate_services_config(gitlab_realm)
+        }
+      end
+
+      private
+
+      def generate_services_config(gitlab_realm)
+        services_config = {}
+
+        DataModels::Service.each do |service|
+          next if service.gitlab_realm && !service.gitlab_realm&.include?(gitlab_realm)
+
+          service_config = generate_service_config(service.unit_primitives, service.basic_unit_primitive)
+          # Remove duo_pro for self_hosted_models
+          service_config['bundled_with'].delete('duo_pro') if service.name == 'self_hosted_models'
+
+          services_config[service.name] = service_config
+        end
+
+        # Generate a stand-alone service for each unit primitive (except the ones in the ignore list)
+        unit_primitives = DataModels::UnitPrimitive.reject { |up| IGNORE_UNIT_PRIMITIVES.include?(up.name) }
+        unit_primitives.each do |unit_primitive|
+          next if services_config[unit_primitive.name]
+
+          services_config[unit_primitive.name] = generate_service_config([unit_primitive])
+        end
+
+        services_config.sort.to_h
+      end
+
+      def generate_service_config(unit_primitives, basic_unit_primitive = nil)
+        sample_primitive = unit_primitives.find { |up| up.name == basic_unit_primitive } if basic_unit_primitive
+        sample_primitive ||= unit_primitives.first
+        backend_service = sample_primitive&.backend_services&.first
+
+        {
+          'backend' => backend_service&.jwt_aud,
+          'cut_off_date' => sample_primitive&.cut_off_date&.strftime('%Y-%m-%d %H:%M:%S UTC'),
+          'min_gitlab_version' => sample_primitive&.min_gitlab_version,
+          'min_gitlab_version_for_free_access' => sample_primitive&.min_gitlab_version_for_free_access,
+          'bundled_with' => generate_bundled_config(unit_primitives),
+          'license_types' => sample_primitive&.license_types&.map(&:name)
+        }.compact_blank
+      end
+
+      def generate_bundled_config(unit_primitives)
+        unit_primitives.each_with_object({}) do |primitive, bundled|
+          target_groups = primitive.add_ons.any? ? primitive.add_ons.map(&:name) : ['_irrelevant']
+          target_groups.each do |group_name|
+            group_name = group_name.to_s
+            bundled[group_name] ||= { 'unit_primitives' => [] }
+            bundled[group_name]['unit_primitives'] << primitive.name
+          end
+        end
+      end
+    end
+  end
+end

data/lib/gitlab/cloud_connector/configuration.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Gitlab
+  module CloudConnector
+    module Configuration
+      class << self
+        attr_writer :config_dir
+
+        def config_dir
+          @config_dir ||= File.expand_path("../../../config", __dir__).freeze
+        end
+
+        def configure
+          yield self if block_given?
+        end
+
+        def reset!
+          @config_dir = nil
+        end
+      end
+    end
+  end
+end

data/lib/gitlab/cloud_connector/data_model/associations.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module Gitlab
+  module CloudConnector
+    module DataModel
+      module Associations
+        module ClassMethods
+          # rubocop:disable Naming/PredicateName
+          def has_and_belongs_to_many(name)
+            define_method(name) do
+              instance_variable_get(:"@#{name}_association") ||
+                instance_variable_set(:"@#{name}_association", load_association_records(name))
+            end
+          end
+          # rubocop:enable Naming/PredicateName
+        end
+
+        def self.included(base)
+          base.extend ClassMethods
+        end
+
+        private
+
+        def load_association_records(association_name)
+          names = Array(self[association_name])
+          association_class = Gitlab::CloudConnector::DataModels.const_get(association_name.to_s.classify)
+          association_class.select { |record| names.include?(record.name.to_s) }
+        end
+      end
+    end
+  end
+end

data/lib/gitlab/cloud_connector/data_model/base.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+require_relative 'associations'
+require_relative 'data_loader'
+
+module Gitlab
+  module CloudConnector
+    module DataModel
+      class Base
+        include Associations
+        extend Enumerable
+
+        class << self
+          def model_name
+            name&.demodulize
+          end
+
+          def each(&block)
+            all.each(&block)
+          end
+
+          def find_by_name(name)
+            all.find { |record| record.name.to_sym == name }
+          end
+
+          def all
+            @all ||= data_loader.load!
+          end
+
+          private
+
+          def data_loader
+            @data_loader ||= DataLoader.new(self)
+          end
+        end
+
+        def initialize(**opts)
+          opts.each do |key, value|
+            instance_variable_set(:"@#{key}", value)
+          end
+        end
+
+        def [](name)
+          instance_variable_get(:"@#{name}")
+        end
+      end
+    end
+  end
+end

data/lib/gitlab/cloud_connector/data_model/data_loader.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require 'yaml'
+
+module Gitlab
+  module CloudConnector
+    module DataModel
+      class DataLoader
+        def initialize(model_class)
+          @model_class = model_class
+        end
+
+        def load!
+          Dir.glob(data_files_path).map { |file| load_model_from_file(file) }
+        end
+
+        private
+
+        attr_reader :model_class
+
+        def data_files_path
+          File.join(CloudConnector::Configuration.config_dir, model_class.model_name.tableize, '*.yml')
+        end
+
+        def load_model_from_file(file_path)
+          data = YAML.safe_load(
+            File.read(file_path),
+            permitted_classes: [Time],
+            symbolize_names: true
+          ).deep_symbolize_keys!
+
+          model_class.new(**data)
+        rescue StandardError => e
+          raise "Error loading file #{file_path}: #{e.message}"
+        end
+      end
+    end
+  end
+end

data/lib/gitlab/cloud_connector/data_models.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require_relative 'data_model/base'
+
+module Gitlab
+  module CloudConnector
+    module DataModels
+      class UnitPrimitive < DataModel::Base
+        has_and_belongs_to_many :backend_services
+        has_and_belongs_to_many :add_ons
+        has_and_belongs_to_many :license_types
+
+        attr_reader :cut_off_date, :deprecated_by_url, :deprecation_message, :description, :documentation_url,
+          :feature_category, :group, :introduced_by_url, :milestone, :min_gitlab_version,
+          :min_gitlab_version_for_free_access, :name, :unit_primitive_issue_url
+      end
+
+      class Service < DataModel::Base
+        has_and_belongs_to_many :unit_primitives
+
+        attr_reader :basic_unit_primitive, :description, :gitlab_realm, :name
+      end
+
+      class BackendService < DataModel::Base
+        attr_reader :description, :group, :jwt_aud, :name, :project_url
+      end
+
+      class LicenseType < DataModel::Base
+        attr_reader :description, :name
+      end
+
+      class AddOn < DataModel::Base
+        attr_reader :description, :name
+      end
+    end
+  end
+end

data/lib/gitlab/cloud_connector/version.rb

@@ -2,6 +2,6 @@
 
 module Gitlab
   module CloudConnector
-    VERSION = '0.2.1'
+    VERSION = '0.2.3'
   end
 end