google-cloud-pubsub 2.22.0 → 3.2.0

data/lib/google/cloud/pubsub/service.rb

@@ -18,6 +18,8 @@ require "google/cloud/pubsub/credentials"
 require "google/cloud/pubsub/convert"
 require "google/cloud/pubsub/version"
 require "google/cloud/pubsub/v1"
+require "google/cloud/pubsub/admin_clients"
+require "google/cloud/pubsub/internal_logger"
 require "securerandom"
 
 module Google
@@ -39,20 +41,25 @@ module Google
 
         attr_reader :universe_domain
 
+        ##
+        # @private The InternalLogger object.
+        attr_reader :logger
+
         ##
         # Creates a new Service instance.
-        def initialize project, credentials, host: nil, timeout: nil, universe_domain: nil
+        def initialize project, credentials, host: nil, timeout: nil, universe_domain: nil, logger: nil
           @project = project
           @credentials = credentials
           @host = host
           @timeout = timeout
           @client_id = SecureRandom.uuid.freeze
           @universe_domain = universe_domain || ENV["GOOGLE_CLOUD_UNIVERSE_DOMAIN"] || "googleapis.com"
+          @logger = logger
         end
 
-        def subscriber
-          return mocked_subscriber if mocked_subscriber
-          @subscriber ||= V1::Subscriber::Client.new do |config|
+        def subscription_admin
+          return mocked_subscription_admin if mocked_subscription_admin
+          @subscription_admin ||= SubscriptionAdmin::Client.new do |config|
             config.credentials = credentials if credentials
             override_client_config_timeouts config if timeout
             config.endpoint = host if host
@@ -62,11 +69,11 @@ module Google
             config.metadata = { "google-cloud-resource-prefix": "projects/#{@project}" }
           end
         end
-        attr_accessor :mocked_subscriber
+        attr_accessor :mocked_subscription_admin
 
-        def publisher
-          return mocked_publisher if mocked_publisher
-          @publisher ||= V1::Publisher::Client.new do |config|
+        def topic_admin
+          return mocked_topic_admin if mocked_topic_admin
+          @topic_admin ||= TopicAdmin::Client.new do |config|
             config.credentials = credentials if credentials
             override_client_config_timeouts config if timeout
             config.endpoint = host if host
@@ -76,12 +83,12 @@ module Google
             config.metadata = { "google-cloud-resource-prefix": "projects/#{@project}" }
           end
         end
-        attr_accessor :mocked_publisher
+        attr_accessor :mocked_topic_admin
 
         def iam
           return mocked_iam if mocked_iam
           @iam ||= begin
-            iam = (@publisher || @subscriber || @schemas || subscriber).iam_policy_client
+            iam = (@topic_admin || @subscription_admin || @schemas || topic_admin).iam_policy_client
             iam.configure do |config|
               override_client_config_timeouts config if timeout
               config.lib_name = "gccl"
@@ -107,77 +114,6 @@ module Google
         end
         attr_accessor :mocked_schemas
 
-        ##
-        # Gets the configuration of a topic.
-        # Since the topic only has the name attribute,
-        # this method is only useful to check the existence of a topic.
-        # If other attributes are added in the future,
-        # they will be returned here.
-        def get_topic topic_name, options = {}
-          publisher.get_topic topic: topic_path(topic_name, options)
-        end
-
-        ##
-        # Lists matching topics.
-        def list_topics options = {}
-          paged_enum = publisher.list_topics project:    project_path(options),
-                                             page_size:  options[:max],
-                                             page_token: options[:token]
-
-          paged_enum.response
-        end
-
-        ##
-        # Creates the given topic with the given name.
-        def create_topic topic_name,
-                         labels: nil,
-                         kms_key_name: nil,
-                         persistence_regions: nil,
-                         schema_name: nil,
-                         message_encoding: nil,
-                         retention: nil,
-                         ingestion_data_source_settings: nil,
-                         options: {}
-          if persistence_regions
-            message_storage_policy = Google::Cloud::PubSub::V1::MessageStoragePolicy.new(
-              allowed_persistence_regions: Array(persistence_regions)
-            )
-          end
-
-          if schema_name || message_encoding
-            unless schema_name && message_encoding
-              raise ArgumentError, "Schema settings must include both schema_name and message_encoding."
-            end
-            schema_settings = Google::Cloud::PubSub::V1::SchemaSettings.new(
-              schema:   schema_path(schema_name),
-              encoding: message_encoding.to_s.upcase
-            )
-          end
-
-          publisher.create_topic \
-            name: topic_path(topic_name, options),
-            labels: labels,
-            kms_key_name: kms_key_name,
-            message_storage_policy: message_storage_policy,
-            schema_settings: schema_settings,
-            message_retention_duration: Convert.number_to_duration(retention),
-            ingestion_data_source_settings: ingestion_data_source_settings
-        end
-
-        def update_topic topic_obj, *fields
-          mask = Google::Protobuf::FieldMask.new paths: fields.map(&:to_s)
-          publisher.update_topic topic: topic_obj, update_mask: mask
-        end
-
-        ##
-        # Deletes the topic with the given name. All subscriptions to this topic
-        # are also deleted. Raises GRPC status code 5 if the topic does not
-        # exist. After a topic is deleted, a new topic may be created with the
-        # same name.
-        def delete_topic topic_name
-          publisher.delete_topic topic: topic_path(topic_name)
-        end
-
         ##
         # Adds one or more messages to the topic.
         # Raises GRPC status code 5 if the topic does not exist.
@@ -186,57 +122,11 @@ module Google
         def publish topic, messages, compress: false
           request = { topic: topic_path(topic), messages: messages }
           compress_options = ::Gapic::CallOptions.new metadata: { "grpc-internal-encoding-request": "gzip" }
-          compress ? (publisher.publish request, compress_options) : (publisher.publish request)
-        end
-
-        ##
-        # Gets the details of a subscription.
-        def get_subscription subscription_name, options = {}
-          subscriber.get_subscription subscription: subscription_path(subscription_name, options)
-        end
-
-        ##
-        # Lists matching subscriptions by project and topic.
-        def list_topics_subscriptions topic, options = {}
-          publisher.list_topic_subscriptions topic:      topic_path(topic, options),
-                                             page_size:  options[:max],
-                                             page_token: options[:token]
-        end
-
-        ##
-        # Lists matching subscriptions by project.
-        def list_subscriptions options = {}
-          paged_enum = subscriber.list_subscriptions project:    project_path(options),
-                                                     page_size:  options[:max],
-                                                     page_token: options[:token]
-
-          paged_enum.response
-        end
-
-        ##
-        # Creates a subscription on a given topic for a given subscriber.
-        def create_subscription topic, subscription_name, options = {}
-          updated_option = construct_create_subscription_options topic, subscription_name, options
-          subscriber.create_subscription(**updated_option)
-        end
-
-        def update_subscription subscription_obj, *fields
-          mask = Google::Protobuf::FieldMask.new paths: fields.map(&:to_s)
-          subscriber.update_subscription subscription: subscription_obj, update_mask: mask
-        end
-
-        ##
-        # Deletes an existing subscription. All pending messages in the subscription are immediately dropped.
-        def delete_subscription subscription
-          subscriber.delete_subscription subscription: subscription_path(subscription)
-        end
-
-        ##
-        # Detaches a subscription from its topic. All messages retained in the subscription are dropped. Subsequent
-        # `Pull` and `StreamingPull` requests will raise `FAILED_PRECONDITION`. If the subscription is a push
-        # subscription, pushes to the endpoint will stop.
-        def detach_subscription subscription
-          publisher.detach_subscription subscription: subscription_path(subscription)
+          if compress
+            (topic_admin.publish_internal request, compress_options)
+          else
+            (topic_admin.publish_internal request)
+          end
         end
 
         ##
@@ -245,233 +135,36 @@ module Google
           max_messages = options.fetch(:max, 100).to_i
           return_immediately = !(!options.fetch(:immediate, true))
 
-          subscriber.pull subscription:       subscription_path(subscription, options),
-                          max_messages:       max_messages,
-                          return_immediately: return_immediately
+          subscription_admin.pull_internal subscription: subscription_path(subscription, options),
+                                           max_messages: max_messages,
+                                           return_immediately: return_immediately
         end
 
         def streaming_pull request_enum, options = {}
-          subscriber.streaming_pull request_enum, options
+          subscription_admin.streaming_pull_internal request_enum, options
         end
 
         ##
         # Acknowledges receipt of a message.
         def acknowledge subscription, *ack_ids
-          subscriber.acknowledge subscription: subscription_path(subscription), ack_ids: ack_ids
-        end
-
-        ##
-        # Modifies the PushConfig for a specified subscription.
-        def modify_push_config subscription, endpoint, attributes
-          # Convert attributes to strings to match the protobuf definition
-          attributes = attributes.to_h { |k, v| [String(k), String(v)] }
-          push_config = Google::Cloud::PubSub::V1::PushConfig.new(
-            push_endpoint: endpoint,
-            attributes:    attributes
-          )
-
-          subscriber.modify_push_config subscription: subscription_path(subscription),
-                                        push_config:  push_config
+          logger.log_ack_nack ack_ids, "ack"
+          subscription_admin.acknowledge_internal subscription: subscription_path(subscription),
+                                                  ack_ids: ack_ids
         end
 
         ##
         # Modifies the ack deadline for a specific message.
         def modify_ack_deadline subscription, ids, deadline
-          subscriber.modify_ack_deadline subscription:         subscription_path(subscription),
-                                         ack_ids:              Array(ids),
-                                         ack_deadline_seconds: deadline
-        end
-
-        ##
-        # Lists snapshots by project.
-        def list_snapshots options = {}
-          paged_enum = subscriber.list_snapshots project:    project_path(options),
-                                                 page_size:  options[:max],
-                                                 page_token: options[:token]
-
-          paged_enum.response
-        end
-
-        ##
-        # Creates a snapshot on a given subscription.
-        def create_snapshot subscription, snapshot_name, labels: nil
-          subscriber.create_snapshot name:         snapshot_path(snapshot_name),
-                                     subscription: subscription_path(subscription),
-                                     labels:       labels
-        end
-
-        def update_snapshot snapshot_obj, *fields
-          mask = Google::Protobuf::FieldMask.new paths: fields.map(&:to_s)
-          subscriber.update_snapshot snapshot: snapshot_obj, update_mask: mask
-        end
-
-        ##
-        # Deletes an existing snapshot.
-        # All pending messages in the snapshot are immediately dropped.
-        def delete_snapshot snapshot
-          subscriber.delete_snapshot snapshot: snapshot_path(snapshot)
-        end
-
-        ##
-        # Adjusts the given subscription to a time or snapshot.
-        def seek subscription, time_or_snapshot
-          if a_time? time_or_snapshot
-            time = Convert.time_to_timestamp time_or_snapshot
-            subscriber.seek subscription: subscription, time: time
-          else
-            time_or_snapshot = time_or_snapshot.name if time_or_snapshot.is_a? Snapshot
-            subscriber.seek subscription: subscription_path(subscription),
-                            snapshot:     snapshot_path(time_or_snapshot)
+          if deadline.zero?
+            logger.log_ack_nack Array(ids), "nack"
           end
-        end
-
-        ##
-        # Lists schemas in the current (or given) project.
-        # @param view [String, Symbol, nil] Possible values:
-        #   * `BASIC` - Include the name and type of the schema, but not the definition.
-        #   * `FULL` - Include all Schema object fields.
-        #
-        def list_schemas view, options = {}
-          schema_view = Google::Cloud::PubSub::V1::SchemaView.const_get view.to_s.upcase
-          paged_enum = schemas.list_schemas parent:     project_path(options),
-                                            view:       schema_view,
-                                            page_size:  options[:max],
-                                            page_token: options[:token]
-
-          paged_enum.response
-        end
-
-        ##
-        # Lists all schema revisions for the named schema.
-        # @param name [String] The name of the schema to list revisions for.
-        # @param view [String, Symbol, nil] Possible values:
-        #   * `BASIC` - Include the name and type of the schema, but not the definition.
-        #   * `FULL` - Include all Schema object fields.
-        #
-        def list_schema_revisions name, view, page_size, page_token
-          schema_view = Google::Cloud::PubSub::V1::SchemaView.const_get view.to_s.upcase
-          schemas.list_schema_revisions name: name,
-                                        view: schema_view,
-                                        page_size: page_size,
-                                        page_token: page_token
-        end
-
-        ##
-        # Creates a schema in the current (or given) project.
-        def create_schema schema_id, type, definition, options = {}
-          schema = Google::Cloud::PubSub::V1::Schema.new(
-            type:       type,
-            definition: definition
-          )
-          schemas.create_schema parent:    project_path(options),
-                                schema:    schema,
-                                schema_id: schema_id
-        end
-
-        ##
-        # Gets the details of a schema.
-        # @param view [String, Symbol, nil] The set of fields to return in the response. Possible values:
-        #   * `BASIC` - Include the name and type of the schema, but not the definition.
-        #   * `FULL` - Include all Schema object fields.
-        #
-        def get_schema schema_name, view, options = {}
-          schema_view = Google::Cloud::PubSub::V1::SchemaView.const_get view.to_s.upcase
-          schemas.get_schema name: schema_path(schema_name, options),
-                             view: schema_view
-        end
-
-        ##
-        # Delete a schema.
-        def delete_schema schema_name
-          schemas.delete_schema name: schema_path(schema_name)
-        end
-
-        ##
-        # Commits a new schema revision to an existing schema.
-        #
-        # @param name [String] The name of the schema to revision.
-        # @param definition [String] The definition of the schema. This should
-        #   contain a string representing the full definition of the schema that
-        #   is a valid schema definition of the type specified in `type`. See
-        #   https://cloud.google.com/pubsub/docs/schemas for details.
-        # @param type [String, Symbol] The type of the schema. Required. Possible
-        #   values are case-insensitive and include:
-        #
-        #     * `PROTOCOL_BUFFER` - A Protocol Buffer schema definition.
-        #     * `AVRO` - An Avro schema definition.
-        #
-        # @return [Google::Cloud::PubSub::V1::Schema]
-        #
-        def commit_schema name, definition, type
-          schema = Google::Cloud::PubSub::V1::Schema.new(
-            name: name,
-            definition: definition,
-            type: type
-          )
-          schemas.commit_schema name: name, schema: schema
-        end
-
-        ##
-        # Validate the definition string intended for a schema.
-        def validate_schema type, definition, options = {}
-          schema = Google::Cloud::PubSub::V1::Schema.new(
-            type:       type,
-            definition: definition
-          )
-          schemas.validate_schema parent: project_path(options),
-                                  schema: schema
-        end
-
-        ##
-        # Validates a message against a schema.
-        #
-        # @param message_data [String] Message to validate against the provided `schema_spec`.
-        # @param message_encoding [Google::Cloud::PubSub::V1::Encoding] The encoding expected for messages.
-        # @param schema_name [String] Name of the schema against which to validate.
-        # @param project [String] Name of the project if not the default project.
-        # @param type [String] Ad-hoc schema type against which to validate.
-        # @param definition [String] Ad-hoc schema definition against which to validate.
-        #
-        def validate_message message_data, message_encoding, schema_name: nil, project: nil, type: nil, definition: nil
-          if type && definition
-            schema = Google::Cloud::PubSub::V1::Schema.new(
-              type:       type,
-              definition: definition
-            )
-          end
-          schemas.validate_message parent:   project_path(project: project),
-                                   name:     schema_path(schema_name),
-                                   schema:   schema,
-                                   message:  message_data,
-                                   encoding: message_encoding
+          subscription_admin.modify_ack_deadline_internal subscription: subscription_path(subscription),
+                                                          ack_ids: Array(ids),
+                                                          ack_deadline_seconds: deadline
         end
 
         # Helper methods
 
-        def get_topic_policy topic_name, options = {}
-          iam.get_iam_policy resource: topic_path(topic_name, options)
-        end
-
-        def set_topic_policy topic_name, new_policy, options = {}
-          iam.set_iam_policy resource: topic_path(topic_name, options), policy: new_policy
-        end
-
-        def test_topic_permissions topic_name, permissions, options = {}
-          iam.test_iam_permissions resource: topic_path(topic_name, options), permissions: permissions
-        end
-
-        def get_subscription_policy subscription_name, options = {}
-          iam.get_iam_policy resource: subscription_path(subscription_name, options)
-        end
-
-        def set_subscription_policy subscription_name, new_policy, options = {}
-          iam.set_iam_policy resource: subscription_path(subscription_name, options), policy: new_policy
-        end
-
-        def test_subscription_permissions subscription_name, permissions, options = {}
-          iam.test_iam_permissions resource: subscription_path(subscription_name, options), permissions: permissions
-        end
-
         def project_path options = {}
           project_name = options[:project] || project
           "projects/#{project_name}"
@@ -497,10 +190,6 @@ module Google
           "#{project_path options}/schemas/#{schema_name}"
         end
 
-        def inspect
-          "#<#{self.class.name} (#{@project})>"
-        end
-
         protected
 
         # Set the timeout in the client config.
@@ -515,48 +204,8 @@ module Google
           end
         end
 
-        def a_time? obj
-          return false unless obj.respond_to? :to_time
-          # Rails' String#to_time returns nil if the string doesn't parse.
-          return false if obj.to_time.nil?
-          true
-        end
-
-        def dead_letter_policy options
-          return nil unless options[:dead_letter_topic_name]
-          policy = Google::Cloud::PubSub::V1::DeadLetterPolicy.new dead_letter_topic: options[:dead_letter_topic_name]
-          if options[:dead_letter_max_delivery_attempts]
-            policy.max_delivery_attempts = options[:dead_letter_max_delivery_attempts]
-          end
-          policy
-        end
-
-        private
-
-        def construct_create_subscription_options topic, subscription_name, options
-          excess_options = [:deadline,
-                            :retention,
-                            :retain_acked,
-                            :message_ordering,
-                            :endpoint,
-                            :dead_letter_topic_name,
-                            :dead_letter_max_delivery_attempts,
-                            :dead_letter_topic]
-
-          new_options = options.filter { |k, v| !v.nil? && !excess_options.include?(k) }
-          new_options[:name] = subscription_path subscription_name, options
-          new_options[:topic] = topic_path topic
-          new_options[:message_retention_duration] = Convert.number_to_duration options[:retention]
-          new_options[:dead_letter_policy] = dead_letter_policy options
-          new_options[:ack_deadline_seconds] = options[:deadline]
-          new_options[:retain_acked_messages] = options[:retain_acked]
-          new_options[:enable_message_ordering] = options[:message_ordering]
-
-          new_options.compact
-        end
       end
     end
-
     Pubsub = PubSub unless const_defined? :Pubsub
   end
 end