Add more ProtoData checks and tests

Author: andrewheard

FirebaseVertexAI/Sources/Types/Internal/ProtoDate.swift

@@ -23,7 +23,8 @@ import Foundation
 /// - A year on its own, with zero month and day values
 /// - A year and month value, with a zero day, such as a credit card expiration date
 ///
-/// This represents a `google.type.Date`.
+/// This represents a
+/// [`google.type.Date`](https://cloud.google.com/vertex-ai/docs/reference/rest/Shared.Types/Date).
 struct ProtoDate {
   /// Year of the date.
   ///
@@ -60,8 +61,8 @@ struct ProtoDate {
     guard day != nil else {
       throw DateConversionError(message: "Missing a day: \(self)")
     }
-    guard let date = dateComponents.date else {
-      throw DateConversionError(message: "Date conversion failed: \(self)")
+    guard dateComponents.isValidDate, let date = dateComponents.date else {
+      throw DateConversionError(message: "Invalid date: \(self)")
     }
     return date
   }
@@ -93,7 +94,7 @@ extension ProtoDate: Decodable {
   init(from decoder: any Decoder) throws {
     let container = try decoder.container(keyedBy: CodingKeys.self)
     if let year = try container.decodeIfPresent(Int.self, forKey: .year), year != 0 {
-      guard year > 0 else {
+      guard year >= 1 && year <= 9999 else {
         throw DecodingError.dataCorrupted(
           .init(codingPath: [CodingKeys.year], debugDescription: "Invalid year: \(year)")
         )
@@ -104,7 +105,7 @@ extension ProtoDate: Decodable {
     }
 
     if let month = try container.decodeIfPresent(Int.self, forKey: .month), month != 0 {
-      guard month > 0 else {
+      guard month >= 1 && month <= 12 else {
         throw DecodingError.dataCorrupted(
           .init(codingPath: [CodingKeys.month], debugDescription: "Invalid month: \(month)")
         )
@@ -115,7 +116,7 @@ extension ProtoDate: Decodable {
     }
 
     if let day = try container.decodeIfPresent(Int.self, forKey: .day), day != 0 {
-      guard day > 0 else {
+      guard day >= 1 && day <= 31 else {
         throw DecodingError.dataCorrupted(
           .init(codingPath: [CodingKeys.day], debugDescription: "Invalid day: \(day)")
         )

FirebaseVertexAI/Tests/Unit/Types/ProtoDateTests.swift

@@ -132,6 +132,21 @@ final class ProtoDateTests: XCTestCase {
     XCTFail("Expected an error but none thrown.")
   }
 
+  func testProtoDate_invalidDate_asDate_throws() {
+    // Reminder: Only 30 days in November
+    let protoDate = ProtoDate(year: 2024, month: 11, day: 31)
+
+    do {
+      _ = try protoDate.asDate()
+    } catch let error as ProtoDate.DateConversionError {
+      XCTAssertTrue(error.localizedDescription.contains("Invalid date"))
+      return
+    } catch {
+      XCTFail("Expected \(ProtoDate.DateConversionError.self), got \(error).")
+    }
+    XCTFail("Expected an error but none thrown.")
+  }
+
   func testProtoDate_empty_asDate_throws() {
     let protoDate = ProtoDate(year: nil, month: nil, day: nil)
 
@@ -275,7 +290,12 @@ final class ProtoDateTests: XCTestCase {
 
     do {
       _ = try decoder.decode(ProtoDate.self, from: jsonData)
-    } catch DecodingError.dataCorrupted {
+    } catch let DecodingError.dataCorrupted(context) {
+      XCTAssertEqual(
+        context.codingPath as? [ProtoDate.CodingKeys],
+        [ProtoDate.CodingKeys.year, ProtoDate.CodingKeys.month, ProtoDate.CodingKeys.day]
+      )
+      XCTAssertTrue(context.debugDescription.contains("Invalid date"))
       return
     }
     XCTFail("Expected a DecodingError.")
@@ -287,7 +307,72 @@ final class ProtoDateTests: XCTestCase {
 
     do {
       _ = try decoder.decode(ProtoDate.self, from: jsonData)
-    } catch DecodingError.dataCorrupted {
+    } catch let DecodingError.dataCorrupted(context) {
+      XCTAssertEqual(
+        context.codingPath as? [ProtoDate.CodingKeys],
+        [ProtoDate.CodingKeys.year, ProtoDate.CodingKeys.month, ProtoDate.CodingKeys.day]
+      )
+      XCTAssertTrue(context.debugDescription.contains("Invalid date"))
+      return
+    }
+    XCTFail("Expected a DecodingError.")
+  }
+
+  func testDecodeProtoDate_invalidYear_throws() throws {
+    let json = """
+    {
+      "year" : -2024,
+      "month" : 12,
+      "day" : 31
+    }
+    """
+    let jsonData = try XCTUnwrap(json.data(using: .utf8))
+
+    do {
+      _ = try decoder.decode(ProtoDate.self, from: jsonData)
+    } catch let DecodingError.dataCorrupted(context) {
+      XCTAssertEqual(context.codingPath as? [ProtoDate.CodingKeys], [ProtoDate.CodingKeys.year])
+      XCTAssertTrue(context.debugDescription.contains("Invalid year"))
+      return
+    }
+    XCTFail("Expected a DecodingError.")
+  }
+
+  func testDecodeProtoDate_invalidMonth_throws() throws {
+    let json = """
+    {
+      "year" : 2024,
+      "month" : 13,
+      "day" : 31
+    }
+    """
+    let jsonData = try XCTUnwrap(json.data(using: .utf8))
+
+    do {
+      _ = try decoder.decode(ProtoDate.self, from: jsonData)
+    } catch let DecodingError.dataCorrupted(context) {
+      XCTAssertEqual(context.codingPath as? [ProtoDate.CodingKeys], [ProtoDate.CodingKeys.month])
+      XCTAssertTrue(context.debugDescription.contains("Invalid month"))
+      return
+    }
+    XCTFail("Expected a DecodingError.")
+  }
+
+  func testDecodeProtoDate_invalidDay_throws() throws {
+    let json = """
+    {
+      "year" : 2024,
+      "month" : 12,
+      "day" : 32
+    }
+    """
+    let jsonData = try XCTUnwrap(json.data(using: .utf8))
+
+    do {
+      _ = try decoder.decode(ProtoDate.self, from: jsonData)
+    } catch let DecodingError.dataCorrupted(context) {
+      XCTAssertEqual(context.codingPath as? [ProtoDate.CodingKeys], [ProtoDate.CodingKeys.day])
+      XCTAssertTrue(context.debugDescription.contains("Invalid day"))
       return
     }
     XCTFail("Expected a DecodingError.")