Merge pull request #12 from taylorfinnell/dont-spam-error

Allow configuration to not raise on certain common errors

spec/hqtrivia/config_spec.cr

@@ -0,0 +1,23 @@
+require "../spec_helper"
+
+module HqTrivia
+  describe Config do
+    it "can configure" do
+      HqTrivia.config.supress_missing_type_attribute_json_errors.should eq(false)
+
+      HqTrivia.configure do |config|
+        config.supress_missing_type_attribute_json_errors = true
+      end
+
+      HqTrivia.config.supress_missing_type_attribute_json_errors.should eq(true)
+    ensure
+      HqTrivia.configure do |config|
+        config.supress_missing_type_attribute_json_errors = false
+      end
+    end
+
+    it "defaults to supress_missing_type_attribute_json_errors being false" do
+      HqTrivia.config.supress_missing_type_attribute_json_errors.should eq(false)
+    end
+  end
+end

spec/hqtrivia/model/raw_web_socket_message_spec.cr

@@ -0,0 +1,36 @@
+require "../../spec_helper"
+
+module HqTrivia::Model
+  describe RawWebSocketMessage do
+    it "raises if if type is missing in thhe json and supress_missing_type_attribute_json_errors is false" do
+      json = {"blah" => 1}.to_json
+
+      expect_raises(RawWebSocketMessage::JSONParseError, /Could not parse '{"blah":1}'/) do
+        RawWebSocketMessage.decode(json)
+      end
+    end
+
+    it "gives an unknown message if type is missing from json and supress_missing_type_attribute_json_errors is true" do
+      json = {"blah" => 1}.to_json
+
+      HqTrivia.configure do |config|
+        config.supress_missing_type_attribute_json_errors = true
+      end
+
+      msg = RawWebSocketMessage.decode(json)
+
+      msg.is_a?(Model::UnknownMessage).should eq(true)
+      msg.as(Model::UnknownMessage).json.should eq("{\"blah\":1}")
+    ensure
+      HqTrivia.configure do |config|
+        config.supress_missing_type_attribute_json_errors = false
+      end
+    end
+
+    it "errors on invalid json" do
+      expect_raises(RawWebSocketMessage::JSONParseError, /Could not parse '{a:}'/) do
+        msg = RawWebSocketMessage.decode("{a:}")
+      end
+    end
+  end
+end

src/hqtrivia.cr

@@ -8,6 +8,8 @@ module HqTrivia
   # :nodoc:
   @@AUTH = Auth.new
 
+  @@CONFIG = Config.new
+
   # HqTrivia logging instance
   def self.logger
     @@LOGGER
@@ -23,6 +25,14 @@ module HqTrivia
     @@AUTH
   end
 
+  def self.config
+    @@CONFIG
+  end
+
+  def self.configure
+    yield config
+  end
+
   # When an active `Show` is seen, it's yielded to the block
   def self.on_show(coordinator : Coordinator, blocking = true, &block : Model::Show ->)
     show_coordinator = ShowCoordinator.new(coordinator)

src/hqtrivia/config.cr

@@ -0,0 +1,8 @@
+module HqTrivia
+  class Config
+    property supress_missing_type_attribute_json_errors
+
+    def initialize(@supress_missing_type_attribute_json_errors = false)
+    end
+  end
+end

src/hqtrivia/model/raw_web_socket_message.cr

@@ -4,6 +4,9 @@ module HqTrivia
   module Model
     # A raw JSON message coming off the socket.
     class RawWebSocketMessage
+      class JSONParseError < Exception
+      end
+
       JSON.mapping({
         type: String,
       })
@@ -12,16 +15,23 @@ module HqTrivia
         begin
           decoded = {{@type}}.from_json({{json}})
           case decoded.type
-          {% for msg, index in Model::MessageTypes.constant("MESSAGE_LIST") %}
-          when {{msg}}
-            Model::{{msg.camelcase.id}}.from_json({{json}})
-          {% end %}
+            {% for msg, index in Model::MessageTypes.constant("MESSAGE_LIST") %}
+            when {{msg}}
+              Model::{{msg.camelcase.id}}.from_json({{json}})
+            {% end %}
           else
             Model::UnknownMessage.new({{json}}, Time.utc)
           end
         rescue jme : JSON::MappingError
-          HqTrivia.logger.error("Failed to parse json: #{{{json}}}")
-          raise jme
+          if jme.message =~ /Missing JSON attribute: type/
+            if !HqTrivia.config.supress_missing_type_attribute_json_errors
+              raise HqTrivia::Model::RawWebSocketMessage::JSONParseError.new("Could not parse '#{{{json}}}'")
+            end
+          end
+
+          Model::UnknownMessage.new({{json}}, Time.utc)
+        rescue jpe : JSON::ParseException
+          raise HqTrivia::Model::RawWebSocketMessage::JSONParseError.new("Could not parse '#{{{json}}}'")
         end
       end
     end