1 /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2; -*- */
2 /* This Source Code Form is subject to the terms of the Mozilla Public
3  * License, v. 2.0. If a copy of the MPL was not distributed with this
4  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
5 
6 // Test that the `JS::ubi::StackFrame`s we create from
7 // `mozilla::devtools::DeserializedStackFrame` instances look and behave as we
8 // would like.
9 
10 #include "DevTools.h"
11 #include "js/TypeDecls.h"
12 #include "mozilla/devtools/DeserializedNode.h"
13 
14 using testing::Field;
15 using testing::ReturnRef;
16 
17 // A mock DeserializedStackFrame for testing.
18 struct MockDeserializedStackFrame : public DeserializedStackFrame {
MockDeserializedStackFrameMockDeserializedStackFrame19   MockDeserializedStackFrame() : DeserializedStackFrame() {}
20 };
21 
22 DEF_TEST(DeserializedStackFrameUbiStackFrames, {
23   StackFrameId id = uint64_t(1) << 42;
24   uint32_t line = 1337;
25   uint32_t column = 9;  // 3 space tabs!?
26   const char16_t* source = u"my-javascript-file.js";
27   const char16_t* functionDisplayName = u"myFunctionName";
28 
29   MockDeserializedStackFrame mocked;
30   mocked.id = id;
31   mocked.line = line;
32   mocked.column = column;
33   mocked.source = source;
34   mocked.functionDisplayName = functionDisplayName;
35 
36   DeserializedStackFrame& deserialized = mocked;
37   JS::ubi::StackFrame ubiFrame(&deserialized);
38 
39   // Test the JS::ubi::StackFrame accessors.
40 
41   EXPECT_EQ(id, ubiFrame.identifier());
42   EXPECT_EQ(JS::ubi::StackFrame(), ubiFrame.parent());
43   EXPECT_EQ(line, ubiFrame.line());
44   EXPECT_EQ(column, ubiFrame.column());
45   EXPECT_EQ(JS::ubi::AtomOrTwoByteChars(source), ubiFrame.source());
46   EXPECT_EQ(JS::ubi::AtomOrTwoByteChars(functionDisplayName),
47             ubiFrame.functionDisplayName());
48   EXPECT_FALSE(ubiFrame.isSelfHosted(cx));
49   EXPECT_FALSE(ubiFrame.isSystem());
50 
51   JS::RootedObject savedFrame(cx);
52   EXPECT_TRUE(ubiFrame.constructSavedFrameStack(cx, &savedFrame));
53 
54   uint32_t frameLine;
55   ASSERT_EQ(JS::SavedFrameResult::Ok,
56             JS::GetSavedFrameLine(cx, savedFrame, &frameLine));
57   EXPECT_EQ(line, frameLine);
58 
59   uint32_t frameColumn;
60   ASSERT_EQ(JS::SavedFrameResult::Ok,
61             JS::GetSavedFrameColumn(cx, savedFrame, &frameColumn));
62   EXPECT_EQ(column, frameColumn);
63 
64   JS::RootedObject parent(cx);
65   ASSERT_EQ(JS::SavedFrameResult::Ok,
66             JS::GetSavedFrameParent(cx, savedFrame, &parent));
67   EXPECT_EQ(nullptr, parent);
68 
69   ASSERT_EQ(NS_strlen(source), 21U);
70   char16_t sourceBuf[21] = {};
71 
72   // Test when the length is shorter than the string length.
73   auto written = ubiFrame.source(RangedPtr<char16_t>(sourceBuf), 3);
74   EXPECT_EQ(written, 3U);
75   for (size_t i = 0; i < 3; i++) {
76     EXPECT_EQ(sourceBuf[i], source[i]);
77   }
78 
79   written = ubiFrame.source(RangedPtr<char16_t>(sourceBuf), 21);
80   EXPECT_EQ(written, 21U);
81   for (size_t i = 0; i < 21; i++) {
82     EXPECT_EQ(sourceBuf[i], source[i]);
83   }
84 
85   ASSERT_EQ(NS_strlen(functionDisplayName), 14U);
86   char16_t nameBuf[14] = {};
87 
88   written = ubiFrame.functionDisplayName(RangedPtr<char16_t>(nameBuf), 14);
89   EXPECT_EQ(written, 14U);
90   for (size_t i = 0; i < 14; i++) {
91     EXPECT_EQ(nameBuf[i], functionDisplayName[i]);
92   }
93 });
94