firebase-ios-sdk/FirebaseCore/Internal/Tests/Unit/HeartbeatsPayloadTests.swift

// Copyright 2021 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//      http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

import XCTest
@testable import FirebaseCoreInternal

class HeartbeatsPayloadTests: XCTestCase {
  func testPayloadCurrentVersion() throws {
    XCTAssertEqual(HeartbeatsPayload().version, 2)
  }

  func testEmptyPayload() throws {
    XCTAssertEqual(
      HeartbeatsPayload.emptyPayload,
      HeartbeatsPayload(userAgentPayloads: [])
    )
  }

  func testDateFormatterUses_yyyy_MM_dd_Format() throws {
    // Given
    let date = Date(timeIntervalSince1970: 1_635_739_200) // 2021-11-01
    // When
    let dateString = HeartbeatsPayload.dateFormatter.string(from: date)
    // Then
    XCTAssertEqual(dateString, "2021-11-01")
  }

  func testDateFormatterDoesNotUseWeekYear() throws {
    // Given
    // The "week year" of `2018-12-31` is 2019, so we want to ensure that such
    // dates are formatted using the "calendar year" (2018).
    let date = Date(timeIntervalSince1970: 1_546_275_600) // 2018-12-31
    // When
    let dateString = HeartbeatsPayload.dateFormatter.string(from: date)
    // Then
    XCTAssertEqual(dateString, "2018-12-31")
  }

  func testEncodeAndDecode() throws {
    // Given
    let heartbeatsPayload = HeartbeatsPayload(
      userAgentPayloads: [
        .init(agent: "agent_1", dates: [Date()]),
      ]
    )

    // When
    let encodedPayload = try JSONEncoder().encode(heartbeatsPayload)
    let decodedPayload = try JSONDecoder().decode(HeartbeatsPayload.self, from: encodedPayload)

    // Then
    XCTAssertEqual(decodedPayload, heartbeatsPayload)
  }

  func testGetHeaderValue() throws {
    // Given
    let date1 = Date(timeIntervalSince1970: 1_635_739_200) // 2021-11-01
    let date2 = date1.addingTimeInterval(60 * 60 * 24) // 2021-11-02
    let date3 = date2.addingTimeInterval(60 * 60 * 24) // 2021-11-03
    let date4 = date3.addingTimeInterval(60 * 60 * 24) // 2021-11-04
    let date5 = date4.addingTimeInterval(60 * 60 * 24) // 2021-11-05

    let heartbeatsPayload = HeartbeatsPayload(
      userAgentPayloads: [
        .init(agent: "agent_1", dates: [date1, date2]),
        .init(agent: "agent_2", dates: [date3, date4]),
        .init(agent: "agent_3", dates: [date5]),
      ]
    )

    // When
    let headerValue = heartbeatsPayload.headerValue()

    // Then
    try HeartbeatLoggingTestUtils.assertEqualPayloadStrings(
      headerValue,
      """
      {
        "version": 2,
        "heartbeats": [
          {
            "agent": "agent_1",
            "dates": ["2021-11-01", "2021-11-02"]
          },
          {
            "agent": "agent_2",
            "dates": ["2021-11-03", "2021-11-04"]
          },
          {
            "agent": "agent_3",
            "dates": ["2021-11-05"]
          }
        ]
      }
      """
    )
  }

  func testGetHeaderValue_WhenEmpty_ReturnsEmptyString() throws {
    // Given
    let heartbeatsPayload = HeartbeatsPayload.emptyPayload
    // When
    let headerValue = heartbeatsPayload.headerValue()
    // Then
    try HeartbeatLoggingTestUtils.assertEqualPayloadStrings(
      headerValue,
      """
      {
        "version": 2,
        "heartbeats": []
      }
      """
    )
  }
}