✨ silence_no_tokens_warning

Author: pboling

lib/oauth2.rb

@@ -28,6 +28,7 @@ module OAuth2
   OAUTH_DEBUG = ENV.fetch("OAUTH_DEBUG", "false").casecmp("true").zero?
   DEFAULT_CONFIG = SnakyHash::SymbolKeyed.new(
     silence_extra_tokens_warning: true,
+    silence_no_tokens_warning: true,
   )
   @config = DEFAULT_CONFIG.dup
   class << self

lib/oauth2/access_token.rb

@@ -31,6 +31,8 @@ class << self
       #   'access_token', 'id_token', 'token' (or their symbolic versions)
       # @note If multiple token keys are present, a warning will be issued unless
       #   OAuth2.config.silence_extra_tokens_warning is true
+      # @note If no token keys are present, a warning will be issued unless
+      #   OAuth2.config.silence_no_tokens_warning is true
       # @note For "soon-to-expire"/"clock-skew" functionality see the `:expires_latency` option.
       # @mote If snaky key conversion is being used, token_name needs to match the converted key.
       #
@@ -40,21 +42,17 @@ class << self
       def from_hash(client, hash)
         fresh = hash.dup
         # If token_name is present, then use that key name
-        if fresh.key?(:token_name)
-          key = fresh[:token_name]
-          if key.nil? || !fresh.key?(key)
-            warn(%[
-OAuth2::AccessToken#from_hash key mismatch.
-Custom token_name (#{key}) does match any keys (#{fresh.keys})
-You may need to set `snaky: false`. See inline documentation for more info.
-            ])
+        key =
+          if fresh.key?(:token_name)
+            no_tokens_warning(fresh, key)
+            fresh[:token_name]
+          else
+            # Otherwise, if one of the supported default keys is present, use whichever has precedence
+            supported_keys = TOKEN_KEY_LOOKUP & fresh.keys
+            t_key = supported_keys[0]
+            extra_tokens_warning(supported_keys, t_key)
+            t_key
           end
-        else
-          # Otherwise, if one of the supported default keys is present, use whichever has precedence
-          supported_keys = TOKEN_KEY_LOOKUP & fresh.keys
-          key = supported_keys[0]
-          extra_tokens_warning(supported_keys, key)
-        end
         token = fresh.delete(key) || ""
         new(client, token, fresh)
       end
@@ -77,6 +75,17 @@ def extra_tokens_warning(supported_keys, key)
 
         warn("OAuth2::AccessToken.from_hash: `hash` contained more than one 'token' key (#{supported_keys}); using #{key.inspect}.")
       end
+
+      def no_tokens_warning(hash, key)
+        return if OAuth2.config.silence_no_tokens_warning
+        return if key && hash.key?(key)
+
+        warn(%[
+OAuth2::AccessToken#from_hash key mismatch.
+Custom token_name (#{key}) is not found in (#{hash.keys})
+You may need to set `snaky: false`. See inline documentation for more info.
+        ])
+      end
     end
 
     # Initialize an AccessToken
@@ -117,7 +126,7 @@ def initialize(client, token, opts = {})
         if @client.options[:raise_errors]
           error = Error.new(opts)
           raise(error)
-        else
+        elsif !OAuth2.config.silence_no_tokens_warning
           warn("OAuth2::AccessToken has no token")
         end
       end

spec/oauth2/access_token_spec.rb

@@ -121,6 +121,37 @@
         expect(printed).to eq(msg)
       end
     end
+
+    context "with no token keys" do
+      subject(:printed) do
+        capture(:stderr) do
+          target
+        end
+      end
+
+      before do
+        @original_sntw = OAuth2.config.silence_no_tokens_warning
+        OAuth2.config.silence_no_tokens_warning = false
+      end
+
+      after do
+        OAuth2.config.silence_no_tokens_warning = @original_sntw
+      end
+
+      let(:hash) do
+        {
+          blather: "confusing bug here",
+          rather: token,
+        }
+      end
+
+      it "warns on STDERR and selects the correct key" do
+        msg = <<-MSG.lstrip
+            OAuth2::AccessToken.from_hash: `hash` contained more than one 'token' key ([:access_token, :id_token]); using :access_token.
+        MSG
+        block_is_expected.to raise_error(OAuth2::Error)
+      end
+    end
   end
 
   describe "#initialize" do
@@ -314,6 +345,15 @@ def assert_initialized_token(target)
                 end
               end
 
+              before do
+                @original_sntw = OAuth2.config.silence_no_tokens_warning
+                OAuth2.config.silence_no_tokens_warning = false
+              end
+
+              after do
+                OAuth2.config.silence_no_tokens_warning = @original_sntw
+              end
+
               it "warns on STDERR" do
                 msg = <<-MSG.lstrip
                   OAuth2::AccessToken has no token
@@ -343,6 +383,15 @@ def assert_initialized_token(target)
         context "when there is nil token" do
           let(:token) { nil }
 
+          before do
+            @original_sntw = OAuth2.config.silence_no_tokens_warning
+            OAuth2.config.silence_no_tokens_warning = false
+          end
+
+          after do
+            OAuth2.config.silence_no_tokens_warning = @original_sntw
+          end
+
           context "when there is no refresh_token" do
             it "does not raise on initialize" do
               block_is_expected.not_to raise_error

spec/oauth2_spec.rb

@@ -9,23 +9,30 @@
     subject(:configure) do
       described_class.configure do |config|
         config.silence_extra_tokens_warning = true
+        config.silence_no_tokens_warning = true
       end
     end
 
     before do
       described_class.configure do |config|
         config.silence_extra_tokens_warning = false
+        config.silence_no_tokens_warning = false
       end
     end
 
     after do
       described_class.configure do |config|
         config.silence_extra_tokens_warning = false
+        config.silence_no_tokens_warning = false
       end
     end
 
     it "can change setting of silence_extra_tokens_warning" do
       block_is_expected.to change(described_class.config, :silence_extra_tokens_warning).from(false).to(true)
     end
+
+    it "can change setting of silence_no_tokens_warning" do
+      block_is_expected.to change(described_class.config, :silence_no_tokens_warning).from(false).to(true)
+    end
   end
 end