fix: createItem not serializing Nothings correctly (#81)

Author: jmartinez-sb

rollbar-cli/rollbar-cli.cabal

@@ -68,4 +68,5 @@ test-suite spec
   build-depends:
       base >=4.13 && <5
     , rollbar-cli
+    , bytestring >=0.10 && <1
   default-language: Haskell2010

rollbar-client/rollbar-client.cabal

@@ -99,4 +99,5 @@ test-suite spec
     , text
     , unordered-containers
     , yaml
+    , bytestring >=0.10 && <1
   default-language: Haskell2010

rollbar-client/src/Rollbar/Client/Item.hs

@@ -97,15 +97,15 @@ instance ToJSON Item where
     let dataFields =
           [ "environment" .= itemEnvironment
           , "body" .= itemBody
-          , "level" .= itemLevel
-          , "platform" .= itemPlatform
-          , "language" .= itemLanguage
-          , "framework" .= itemFramework
-          , "request" .= itemRequest
-          , "server" .= itemServer
           , "notifier" .= itemNotifier
           ] ++ catMaybes
-          [ ("custom" .=) <$> custom
+          [  ("level" .=) <$> itemLevel
+           , ("platform" .=) <$> itemPlatform
+           , ("language" .=) <$> itemLanguage
+           , ("framework" .=) <$> itemFramework
+           , ("request" .=) <$> itemRequest
+           , ("server" .=) <$> itemServer
+           , ("custom" .=) <$> custom
            , ("fingerprint" .=) <$> fingerprint
            , ("title" .=) <$> title
            , ("uuid" .=) <$> uuid

rollbar-client/test/Rollbar/ClientSpec.hs

@@ -11,7 +11,9 @@ import qualified Data.Aeson.KeyMap as KM
 
 import Control.Monad.Reader
 import Data.Aeson
-import Data.Text
+import qualified Data.ByteString.Lazy as DBL
+import Data.Text.Encoding
+import Data.Text as T
 import Data.Yaml.Config
 import Rollbar.Client
 import Test.Hspec
@@ -143,3 +145,28 @@ spec = do
           reportDeploy deploy
 
         deployId `shouldSatisfy` (> 0)
+
+  describe "ToJSON Item" $ do
+    context "when serializing to JSON" $ do
+      let item = Item
+            { itemEnvironment = Environment "test"
+            , itemBody = Body { bodyPayload = PayloadMessage (Message "Test" mempty) }
+            , itemLevel = Just LevelInfo
+            , itemPlatform = Just "haskell"
+            , itemLanguage = Just "Haskell"
+            , itemFramework = Just "GHC"
+            , itemRequest = Nothing
+            , itemServer = Nothing
+            , custom = Just mempty
+            , title = Nothing
+            , uuid = Just "12345"
+            , fingerprint = Nothing
+            , itemNotifier = Notifier "rollbar-client" "1.1.0"
+            }
+          jsonItem = decodeUtf8 $ DBL.toStrict $ encode item
+
+      it "omits fields if they are Nothing values" $
+        T.unpack jsonItem `shouldNotContain` "\"server\""
+
+      it "includes fields if they are Just values" $ 
+        T.unpack jsonItem `shouldContain` "\"platform\":\"haskell\""

rollbar-wai/package.yaml

@@ -48,7 +48,7 @@ library:
     - text >= 1.2 && < 2.1
     - unordered-containers >= 0.2 && < 1
     - wai >= 3.2 && < 4
-    - wai-extra >= 3.0 && < 4
+    - wai-extra < 3.1.17         # TODO: update breaks yesod-core, see https://github.com/yesodweb/yesod/issues/1854
 
 executables:
   wai-example:

rollbar-wai/rollbar-wai.cabal

@@ -54,7 +54,7 @@ library
     , text >=1.2 && <2.1
     , unordered-containers >=0.2 && <1
     , wai >=3.2 && <4
-    , wai-extra >=3.0 && <4
+    , wai-extra >=3.0 && < 3.1.17 -- TODO: update breaks yesod-core, see https://github.com/yesodweb/yesod/issues/1854
   default-language: Haskell2010
 
 executable wai-example
@@ -101,4 +101,5 @@ test-suite spec
     , unordered-containers
     , wai
     , warp >=3.3 && <4
+    , bytestring >=0.10 && <1
   default-language: Haskell2010

rollbar-yesod/rollbar-yesod.cabal

@@ -91,4 +91,5 @@ test-suite spec
     , wai
     , yesod-core
     , yesod-test >=1.6 && <2
+    , bytestring >=0.10 && <1
   default-language: Haskell2010