// Copyright 2014 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#include "components/viz/common/frame_sinks/begin_frame_args.h"

#include <string>

#include "base/test/gtest_util.h"
#include "build/build_config.h"
#include "components/viz/test/begin_frame_args_test.h"
#include "testing/gtest/include/gtest/gtest-spi.h"
#include "testing/gtest/include/gtest/gtest.h"

namespace viz {
namespace {

constexpr base::TimeDelta k1Usec = base::Microseconds(1);
constexpr base::TimeDelta k2Usec = base::Microseconds(2);
constexpr base::TimeDelta k3Usec = base::Microseconds(3);

TEST(BeginFrameArgsTest, Helpers) {
  // Quick create methods work
  BeginFrameArgs args0 =
      CreateBeginFrameArgsForTesting(BEGINFRAME_FROM_HERE, 0, 1);
  EXPECT_TRUE(args0.IsValid()) << args0;

  BeginFrameArgs args1 =
      CreateBeginFrameArgsForTesting(BEGINFRAME_FROM_HERE, 0, 1, 0, 0, -1);
  EXPECT_FALSE(args1.IsValid()) << args1;

  BeginFrameArgs args2 =
      CreateBeginFrameArgsForTesting(BEGINFRAME_FROM_HERE, 123, 10, 1, 2, 3);
  EXPECT_TRUE(args2.IsValid()) << args2;
  EXPECT_EQ(123u, args2.frame_id.source_id);
  EXPECT_EQ(10u, args2.frame_id.sequence_number);
  EXPECT_EQ(k1Usec, args2.frame_time.since_origin());
  EXPECT_EQ(k2Usec, args2.deadline.since_origin());
  EXPECT_EQ(k3Usec, args2.interval);
  EXPECT_EQ(BeginFrameArgs::NORMAL, args2.type);
  EXPECT_EQ(0u, args2.frames_throttled_since_last);

  BeginFrameArgs args4 = CreateBeginFrameArgsForTesting(
      BEGINFRAME_FROM_HERE, 234, 20, 1, 2, 3, BeginFrameArgs::MISSED);
  EXPECT_TRUE(args4.IsValid()) << args4;
  EXPECT_EQ(234u, args4.frame_id.source_id);
  EXPECT_EQ(20u, args4.frame_id.sequence_number);
  EXPECT_EQ(k1Usec, args4.frame_time.since_origin());
  EXPECT_EQ(k2Usec, args4.deadline.since_origin());
  EXPECT_EQ(k3Usec, args4.interval);
  EXPECT_EQ(BeginFrameArgs::MISSED, args4.type);
  EXPECT_EQ(0u, args4.frames_throttled_since_last);

  // operator==
  EXPECT_EQ(
      CreateBeginFrameArgsForTesting(BEGINFRAME_FROM_HERE, 123, 20, 4, 5, 6),
      CreateBeginFrameArgsForTesting(BEGINFRAME_FROM_HERE, 123, 20, 4, 5, 6));

  EXPECT_NONFATAL_FAILURE(
      EXPECT_EQ(CreateBeginFrameArgsForTesting(BEGINFRAME_FROM_HERE, 123, 30, 7,
                                               8, 9, BeginFrameArgs::MISSED),
                CreateBeginFrameArgsForTesting(BEGINFRAME_FROM_HERE, 123, 30, 7,
                                               8, 9)),
      "");

  EXPECT_NONFATAL_FAILURE(
      EXPECT_EQ(CreateBeginFrameArgsForTesting(BEGINFRAME_FROM_HERE, 123, 30, 4,
                                               5, 6),
                CreateBeginFrameArgsForTesting(BEGINFRAME_FROM_HERE, 123, 30, 7,
                                               8, 9)),
      "");

  EXPECT_NONFATAL_FAILURE(
      EXPECT_EQ(CreateBeginFrameArgsForTesting(BEGINFRAME_FROM_HERE, 123, 30, 7,
                                               8, 9),
                CreateBeginFrameArgsForTesting(BEGINFRAME_FROM_HERE, 123, 40, 7,
                                               8, 9)),
      "");

  EXPECT_NONFATAL_FAILURE(
      EXPECT_EQ(CreateBeginFrameArgsForTesting(BEGINFRAME_FROM_HERE, 123, 30, 7,
                                               8, 9),
                CreateBeginFrameArgsForTesting(BEGINFRAME_FROM_HERE, 234, 30, 7,
                                               8, 9)),
      "");

  // operator<<
  std::stringstream out1;
  out1 << args1;
  EXPECT_EQ("BeginFrameArgs(NORMAL, 0, 1, 0, 0, -1us, -1us (unthrottled), 0)",
            out1.str());
  std::stringstream out2;
  out2 << args2;
  EXPECT_EQ("BeginFrameArgs(NORMAL, 123, 10, 1, 2, 3us, 3us (unthrottled), 0)",
            out2.str());

  // PrintTo
  EXPECT_EQ(std::string("BeginFrameArgs(NORMAL, 0, 1, 0, 0, -1us, "
                        "-1us (unthrottled), 0)"),
            ::testing::PrintToString(args1));
  EXPECT_EQ(std::string("BeginFrameArgs(NORMAL, 123, 10, 1, 2, 3us, "
                        "3us (unthrottled), 0)"),
            ::testing::PrintToString(args2));
}

TEST(BeginFrameArgsTest, Create) {
  // BeginFrames are not valid by default
  BeginFrameArgs args1;
  EXPECT_FALSE(args1.IsValid()) << args1;
  EXPECT_TRUE(args1.on_critical_path);
  EXPECT_FALSE(args1.animate_only);

  BeginFrameArgs args2 = BeginFrameArgs::Create(
      BEGINFRAME_FROM_HERE, 123, 10, base::TimeTicks() + k1Usec,
      base::TimeTicks() + k2Usec, k3Usec, BeginFrameArgs::NORMAL);
  EXPECT_TRUE(args2.IsValid()) << args2;
  EXPECT_TRUE(args2.on_critical_path);
  EXPECT_FALSE(args2.animate_only);
  EXPECT_EQ(123u, args2.frame_id.source_id) << args2;
  EXPECT_EQ(10u, args2.frame_id.sequence_number) << args2;
  EXPECT_EQ(k1Usec, args2.frame_time.since_origin()) << args2;
  EXPECT_EQ(k2Usec, args2.deadline.since_origin()) << args2;
  EXPECT_EQ(k3Usec, args2.interval) << args2;
  EXPECT_EQ(BeginFrameArgs::NORMAL, args2.type) << args2;
  EXPECT_EQ(0u, args2.frames_throttled_since_last) << args2;
}

#ifndef NDEBUG
TEST(BeginFrameArgsTest, Location) {
  base::Location expected_location = BEGINFRAME_FROM_HERE;

  BeginFrameArgs args = CreateBeginFrameArgsForTesting(expected_location, 0, 1);
  EXPECT_EQ(expected_location.ToString(), args.created_from.ToString());
}
#endif

// TODO(crbug.com/477242770): Changing the system display refresh rate on macOS
// causes the unthrottled_interval state to go stale, which incorrectly trips
// the DCHECK enforced by this test. Re-enable once this is fixed.
#if BUILDFLAG(IS_MAC)
#define MAYBE_InvalidUnthrottledInterval DISABLED_InvalidUnthrottledInterval
#else
#define MAYBE_InvalidUnthrottledInterval InvalidUnthrottledInterval
#endif

TEST(BeginFrameArgsTest, MAYBE_InvalidUnthrottledInterval) {
#if DCHECK_IS_ON()
  EXPECT_DCHECK_DEATH(BeginFrameArgs::Create(
      BEGINFRAME_FROM_HERE, 0, BeginFrameArgs::kStartingFrameNumber,
      base::TimeTicks(), base::TimeTicks(), base::Milliseconds(16),
      BeginFrameArgs::NORMAL, base::Milliseconds(25)));
#endif
}

}  // namespace
}  // namespace viz