wcc-contentful 0.3.0 → 1.0.0.pre.rc2

data/lib/wcc/contentful/simple_client.rb

@@ -2,6 +2,7 @@
 
 require_relative 'simple_client/response'
 require_relative 'simple_client/management'
+require_relative 'instrumentation'
 
 module WCC::Contentful
   # The SimpleClient accesses the Contentful CDN to get JSON responses,
@@ -16,11 +17,13 @@ module WCC::Contentful
   # `get`.  This method returns a WCC::Contentful::SimpleClient::Response
   # that handles paging automatically.
   #
-  # The SimpleClient by default uses 'http' to perform the gets, but any HTTP
-  # client can be injected by passing a proc as the `adapter:` option.
+  # The SimpleClient by default uses 'faraday' to perform the gets, but any HTTP
+  # client adapter be injected by passing the `connection:` option.
   #
   # @api Client
   class SimpleClient
+    include WCC::Contentful::Instrumentation
+
     attr_reader :api_url
     attr_reader :space
 
@@ -30,21 +33,27 @@ module WCC::Contentful
     # @param [String] space The Space ID to access
     # @param [String] access_token A Contentful Access Token to be sent in the Authorization header
     # @param [Hash] options The remaining optional parameters, defined below
-    # @option options [Symbol, Object] adapter The Adapter to use to make requests.
+    # @option options [Symbol, Object] connection The Faraday connection to use to make requests.
     #   Auto-discovered based on what gems are installed if this is not provided.
     # @option options [String] default_locale The locale query param to set by default.
     # @option options [String] environment The contentful environment to access. Defaults to 'master'.
     # @option options [Boolean] no_follow_redirects If true, do not follow 300 level redirects.
+    # @option options [Number] rate_limit_wait_timeout The maximum time to block the thread waiting
+    #   on a rate limit response.  By default will wait for one 429 and then fail on the second 429.
     def initialize(api_url:, space:, access_token:, **options)
       @api_url = URI.join(api_url, '/spaces/', space + '/')
       @space = space
       @access_token = access_token
 
-      @adapter = SimpleClient.load_adapter(options[:adapter])
+      @adapter = SimpleClient.load_adapter(options[:connection])
 
       @options = options
+      @_instrumentation = @options[:instrumentation]
       @query_defaults = {}
       @query_defaults[:locale] = @options[:default_locale] if @options[:default_locale]
+      # default 1.5 so that we retry one time then fail if still rate limited
+      # https://www.contentful.com/developers/docs/references/content-preview-api/#/introduction/api-rate-limits
+      @rate_limit_wait_timeout = @options[:rate_limit_wait_timeout] || 1.5
 
       return unless options[:environment].present?
 
@@ -57,13 +66,17 @@ module WCC::Contentful
     def get(path, query = {})
       url = URI.join(@api_url, path)
 
+      resp =
+        _instrument 'get_http', url: url, query: query do
+          get_http(url, query)
+        end
       Response.new(self,
         { url: url, query: query },
-        get_http(url, query))
+        resp)
     end
 
     ADAPTERS = {
-      http: ['http', '> 1.0', '< 3.0'],
+      faraday: ['faraday', '>= 0.9'],
       typhoeus: ['typhoeus', '~> 1.0']
     }.freeze
 
@@ -80,16 +93,19 @@ module WCC::Contentful
         end
         raise ArgumentError, 'Unable to load adapter!  Please install one of '\
           "#{ADAPTERS.values.map(&:join).join(',')}"
-      when :http
-        require_relative 'simple_client/http_adapter'
-        HttpAdapter.new
+      when :faraday
+        require 'faraday'
+        ::Faraday.new do |faraday|
+          faraday.response :logger, (Rails.logger if defined?(Rails)), { headers: false, bodies: false }
+          faraday.adapter :net_http
+        end
       when :typhoeus
         require_relative 'simple_client/typhoeus_adapter'
         TyphoeusAdapter.new
       else
-        unless adapter.respond_to?(:call)
+        unless adapter.respond_to?(:get)
           raise ArgumentError, "Adapter #{adapter} is not invokeable!  Please "\
-            "pass a proc or use one of #{ADAPTERS.keys}"
+            "pass use one of #{ADAPTERS.keys} or create a Faraday-compatible adapter"
         end
         adapter
       end
@@ -97,7 +113,12 @@ module WCC::Contentful
 
     private
 
-    def get_http(url, query, headers = {}, proxy = {})
+    def _instrumentation_event_prefix
+      # Unify all CDN, Management, Preview notifications under same namespace
+      '.simpleclient.contentful.wcc'
+    end
+
+    def get_http(url, query, headers = {})
       headers = {
         Authorization: "Bearer #{@access_token}"
       }.merge(headers || {})
@@ -105,12 +126,28 @@ module WCC::Contentful
       q = @query_defaults.dup
       q = q.merge(query) if query
 
-      resp = @adapter.call(url, q, headers, proxy)
+      start = Process.clock_gettime(Process::CLOCK_MONOTONIC)
+      loop do
+        resp = @adapter.get(url, q, headers)
+
+        if [301, 302, 307].include?(resp.status) && !@options[:no_follow_redirects]
+          url = resp.headers['Location']
+          next
+        end
+
+        if resp.status == 429 &&
+            reset = resp.headers['X-Contentful-RateLimit-Reset'].presence
+          reset = reset.to_f
+          _instrument 'rate_limit', start: start, reset: reset, timeout: @rate_limit_wait_timeout
+          now = Process.clock_gettime(Process::CLOCK_MONOTONIC)
+          if (now - start) + reset < @rate_limit_wait_timeout
+            sleep(reset)
+            next
+          end
+        end
 
-      if [301, 302, 307].include?(resp.code) && !@options[:no_follow_redirects]
-        resp = get_http(resp.headers['location'], nil, headers, proxy)
+        return resp
       end
-      resp
     end
 
     # The CDN SimpleClient accesses 'https://cdn.contentful.com' to get raw
@@ -135,31 +172,46 @@ module WCC::Contentful
 
       # Gets an entry by ID
       def entry(key, query = {})
-        resp = get("entries/#{key}", query)
+        resp =
+          _instrument 'entries', id: key, type: 'Entry', query: query do
+            get("entries/#{key}", query)
+          end
         resp.assert_ok!
       end
 
       # Queries entries with optional query parameters
       def entries(query = {})
-        resp = get('entries', query)
+        resp =
+          _instrument 'entries', type: 'Entry', query: query do
+            get('entries', query)
+          end
         resp.assert_ok!
       end
 
       # Gets an asset by ID
       def asset(key, query = {})
-        resp = get("assets/#{key}", query)
+        resp =
+          _instrument 'entries', type: 'Asset', id: key, query: query do
+            get("assets/#{key}", query)
+          end
         resp.assert_ok!
       end
 
       # Queries assets with optional query parameters
       def assets(query = {})
-        resp = get('assets', query)
+        resp =
+          _instrument 'entries', type: 'Asset', query: query do
+            get('assets', query)
+          end
         resp.assert_ok!
       end
 
       # Queries content types with optional query parameters
       def content_types(query = {})
-        resp = get('content_types', query)
+        resp =
+          _instrument 'content_types', query: query do
+            get('content_types', query)
+          end
         resp.assert_ok!
       end
 
@@ -177,7 +229,11 @@ module WCC::Contentful
             { initial: true }
           end
         query = query.merge(sync_token)
-        resp = SyncResponse.new(get('sync', query))
+        resp =
+          _instrument 'sync', sync_token: sync_token, query: query do
+            get('sync', query)
+          end
+        resp = SyncResponse.new(resp)
         resp.assert_ok!
       end
     end
@@ -186,10 +242,10 @@ module WCC::Contentful
     class Preview < Cdn
       def initialize(space:, preview_token:, **options)
         super(
-          api_url: options[:api_url] || 'https://preview.contentful.com/',
+          **options,
+          api_url: options[:preview_api_url] || 'https://preview.contentful.com/',
           space: space,
-          access_token: preview_token,
-          **options
+          access_token: preview_token
         )
       end
 

data/lib/wcc/contentful/simple_client/management.rb

@@ -4,10 +4,10 @@
 class WCC::Contentful::SimpleClient::Management < WCC::Contentful::SimpleClient
   def initialize(space:, management_token:, **options)
     super(
-      api_url: options[:api_url] || 'https://api.contentful.com',
+      **options,
+      api_url: options[:management_api_url] || 'https://api.contentful.com',
       space: space,
       access_token: management_token,
-      **options
     )
 
     @post_adapter = @adapter if @adapter.respond_to?(:post)
@@ -19,12 +19,34 @@ class WCC::Contentful::SimpleClient::Management < WCC::Contentful::SimpleClient
   end
 
   def content_types(**query)
-    resp = get('content_types', query)
+    resp =
+      _instrument 'content_types', query: query do
+        get('content_types', query)
+      end
+    resp.assert_ok!
+  end
+
+  def content_type(key, query = {})
+    resp =
+      _instrument 'content_types', content_type: key, query: query do
+        get("content_types/#{key}", query)
+      end
+    resp.assert_ok!
+  end
+
+  def editor_interface(content_type_id, query = {})
+    resp =
+      _instrument 'editor_interfaces', content_type: content_type_id, query: query do
+        get("content_types/#{content_type_id}/editor_interface", query)
+      end
     resp.assert_ok!
   end
 
   def webhook_definitions(**query)
-    resp = get("/spaces/#{space}/webhook_definitions", query)
+    resp =
+      _instrument 'webhook_definitions', query: query do
+        get("/spaces/#{space}/webhook_definitions", query)
+      end
     resp.assert_ok!
   end
 
@@ -51,30 +73,41 @@ class WCC::Contentful::SimpleClient::Management < WCC::Contentful::SimpleClient
   #   ]
   # }
   def post_webhook_definition(webhook)
-    resp = post("/spaces/#{space}/webhook_definitions", webhook)
+    resp =
+      _instrument 'post.webhook_definitions' do
+        post("/spaces/#{space}/webhook_definitions", webhook)
+      end
     resp.assert_ok!
   end
 
   def post(path, body)
     url = URI.join(@api_url, path)
 
+    resp =
+      _instrument 'post_http', url: url do
+        post_http(url, body)
+      end
+
     Response.new(self,
       { url: url, body: body },
-      post_http(url, body))
+      resp)
   end
 
   private
 
-  def post_http(url, body, headers = {}, proxy = {})
+  def post_http(url, body, headers = {})
     headers = {
       Authorization: "Bearer #{@access_token}",
       'Content-Type' => 'application/vnd.contentful.management.v1+json'
     }.merge(headers || {})
 
-    resp = @post_adapter.post(url, body, headers, proxy)
+    body = body.to_json unless body.is_a? String
+    resp = @post_adapter.post(url, body, headers)
 
-    if [301, 302, 307].include?(resp.code) && !@options[:no_follow_redirects]
-      resp = get_http(resp.headers['location'], nil, headers, proxy)
+    if [301, 302, 307].include?(resp.status) && !@options[:no_follow_redirects]
+      resp = get_http(resp.headers['location'], nil, headers)
+    elsif resp.status == 308 && !@options[:no_follow_redirects]
+      resp = post_http(resp.headers['location'], body, headers)
     end
     resp
   end

data/lib/wcc/contentful/simple_client/response.rb

@@ -1,12 +1,17 @@
 # frozen_string_literal: true
 
+require_relative '../instrumentation'
+
 class WCC::Contentful::SimpleClient
   class Response
+    include ::WCC::Contentful::Instrumentation
+
     attr_reader :raw_response
     attr_reader :client
     attr_reader :request
 
-    delegate :code, to: :raw_response
+    delegate :status, to: :raw_response
+    alias_method :code, :status
     delegate :headers, to: :raw_response
 
     def body
@@ -19,25 +24,41 @@ class WCC::Contentful::SimpleClient
     alias_method :to_json, :raw
 
     def error_message
-      raw.dig('message') || "#{code}: #{raw_response.message}"
+      parsed_message =
+        begin
+          raw.dig('message')
+        rescue JSON::ParserError
+          nil
+        end
+      parsed_message || "#{code}: #{raw_response.body}"
+    end
+
+    def skip
+      raw['skip']
+    end
+
+    def total
+      raw['total']
     end
 
     def next_page?
       return unless raw.key? 'items'
 
-      raw['items'].length + raw['skip'] < raw['total']
+      page_items.length + skip < total
     end
 
     def next_page
       return unless next_page?
-
-      @next_page ||= @client.get(
-        @request[:url],
-        (@request[:query] || {}).merge({
-          skip: raw['items'].length + raw['skip']
-        })
-      )
-      @next_page.assert_ok!
+      return @next_page if @next_page
+
+      query = (@request[:query] || {}).merge({
+        skip: page_items.length + skip
+      })
+      np =
+        _instrument 'page', url: @request[:url], query: query do
+          @client.get(@request[:url], query)
+        end
+      @next_page = np.assert_ok!
     end
 
     def initialize(client, request, raw_response)
@@ -48,13 +69,13 @@ class WCC::Contentful::SimpleClient
     end
 
     def assert_ok!
-      return self if code >= 200 && code < 300
+      return self if status >= 200 && status < 300
 
-      raise ApiError[code], self
+      raise ApiError[status], self
     end
 
     def each_page(&block)
-      raise ArgumentError, 'Not a collection response' unless raw['items']
+      raise ArgumentError, 'Not a collection response' unless page_items
 
       ret =
         Enumerator.new do |y|
@@ -75,19 +96,21 @@ class WCC::Contentful::SimpleClient
     end
 
     def items
-      each_page.flat_map do |page|
-        page.raw['items']
-      end
+      each_page.flat_map(&:page_items)
+    end
+
+    def page_items
+      raw['items']
     end
 
     def count
-      raw['total']
+      total
     end
 
     def first
-      raise ArgumentError, 'Not a collection response' unless raw['items']
+      raise ArgumentError, 'Not a collection response' unless page_items
 
-      raw['items'].first
+      page_items.first
     end
 
     def includes
@@ -115,7 +138,13 @@ class WCC::Contentful::SimpleClient
     def next_page
       return unless next_page?
 
-      @next_page ||= SyncResponse.new(@client.get(raw['nextPageUrl']))
+      url = raw['nextPageUrl']
+      next_page =
+        _instrument 'page', url: url do
+          @client.get(url)
+        end
+
+      @next_page ||= SyncResponse.new(next_page)
       @next_page.assert_ok!
     end
 
@@ -129,7 +158,7 @@ class WCC::Contentful::SimpleClient
     end
 
     def each_page
-      raise ArgumentError, 'Not a collection response' unless raw['items']
+      raise ArgumentError, 'Not a collection response' unless page_items
 
       ret =
         Enumerator.new do |y|
@@ -168,6 +197,10 @@ class WCC::Contentful::SimpleClient
       case code
       when 404
         NotFoundError
+      when 401
+        UnauthorizedError
+      when 429
+        RateLimitError
       else
         ApiError
       end
@@ -181,4 +214,10 @@ class WCC::Contentful::SimpleClient
 
   class NotFoundError < ApiError
   end
+
+  class UnauthorizedError < ApiError
+  end
+
+  class RateLimitError < ApiError
+  end
 end