Discarded property on chrome.tabs.Tab and chrome.tabs.query()

chrome/browser/extensions/api/tabs/tabs_api_unittest.cc

 // Copyright 2016 The Chromium Authors. All rights reserved.
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
 #include "base/strings/utf_string_conversions.h"
+#include "chrome/browser/browser_process.h"
 #include "chrome/browser/extensions/api/tabs/tabs_api.h"
 #include "chrome/browser/extensions/extension_function_test_utils.h"
 #include "chrome/browser/extensions/extension_service_test_base.h"
 #include "chrome/browser/extensions/extension_tab_util.h"
+#include "chrome/browser/memory/tab_manager.h"
 #include "chrome/browser/ui/browser.h"
 #include "chrome/browser/ui/tabs/tab_strip_model.h"
 #include "chrome/test/base/test_browser_window.h"
 #include "content/public/browser/navigation_entry.h"
 #include "content/public/test/web_contents_tester.h"
 #include "extensions/common/extension_builder.h"
 #include "extensions/common/test_util.h"
 
+using memory::TabManager;
+using content::WebContents;
+
 namespace extensions {
 
+namespace utils = extension_function_test_utils;
+
 namespace {
 
 std::unique_ptr<base::ListValue> RunTabsQueryFunction(
     Browser* browser,
     const Extension* extension,
     const std::string& query_info) {
   scoped_refptr<TabsQueryFunction> function(new TabsQueryFunction());
   function->set_extension(extension);
   std::unique_ptr<base::Value> value(
       extension_function_test_utils::RunFunctionAndReturnSingleResult(
@@ skipping 172 matching lines @@
     int first_tab_id = -1;
     ASSERT_TRUE(first_tab_info->GetInteger("id", &first_tab_id));
     EXPECT_TRUE(ContainsValue(expected_tabs_ids, first_tab_id));
 
     int third_tab_id = -1;
     ASSERT_TRUE(third_tab_info->GetInteger("id", &third_tab_id));
     EXPECT_TRUE(ContainsValue(expected_tabs_ids, third_tab_id));
   }
 }
 
+TEST_F(TabsApiUnitTest, QueryDiscarded) {

[Devlin, 2016/07/11 16:32:28]

It doesn't look like this test has been formatted probably. Can you run git cl
format?

[Anderson Silva, 2016/07/11 19:47:51]

Done.

+  ASSERT_TRUE(g_browser_process && g_browser_process->GetTabManager());
+  memory::TabManager* tab_manager = g_browser_process->GetTabManager();
+
+  // Create three tabs.
+  content::OpenURLParams params_1(GURL(url::kAboutBlankURL),

[Devlin, 2016/07/11 16:32:28]

optional nit: I'd also probably just inline these, but I don't feel strongly.

[Anderson Silva, 2016/07/11 19:47:51]

Acknowledged.

+    content::Referrer(), NEW_BACKGROUND_TAB,
+    ui::PAGE_TRANSITION_LINK, false);
+  content::OpenURLParams params_2(GURL(url::kAboutBlankURL),
+    content::Referrer(), NEW_FOREGROUND_TAB,
+    ui::PAGE_TRANSITION_LINK, false);
+  content::WebContents* web_contents_a = browser()->OpenURL(params_1);
+  content::WebContents* web_contents_b = browser()->OpenURL(params_1);
+  browser()->OpenURL(params_2);
+
+  // Get non-discarded tabs.
+  {
+    const char* kQueryInfo = "[{\"discarded\": false}]";
+    scoped_refptr<TabsQueryFunction> function = new TabsQueryFunction();
+    function->set_extension(test_util::CreateEmptyExtension().get());
+    std::unique_ptr<base::ListValue> result(
+      utils::ToList(utils::RunFunctionAndReturnSingleResult(
+        function.get(), kQueryInfo, browser())));
+
+    EXPECT_EQ(3u, result.get()->GetSize());

[Devlin, 2016/07/11 16:32:28]

unique_ptr::operator-> forwards to the underlying ptr, so .get() is unnecessary.
(Goes for all of these.)

[Anderson Silva, 2016/07/11 19:47:51]

Done.

+  }
+
+  // Get discarded tabs.
+  {
+    const char* kQueryInfo = "[{\"discarded\": true}]";
+    scoped_refptr<TabsQueryFunction> function = new TabsQueryFunction();
+    function->set_extension(test_util::CreateEmptyExtension().get());
+    std::unique_ptr<base::ListValue> result(
+      utils::ToList(utils::RunFunctionAndReturnSingleResult(
+        function.get(), kQueryInfo, browser())));
+
+    EXPECT_EQ(0u, result.get()->GetSize());
+  }
+
+  // Discards one tab.
+  EXPECT_TRUE(
+    tab_manager->DiscardTabById(reinterpret_cast<int64_t>(web_contents_a)));
+
+  // Get non-discarded tabs after discarding one tab.
+  {
+    const char* kQueryInfo = "[{\"discarded\": false}]";
+    scoped_refptr<TabsQueryFunction> function = new TabsQueryFunction();
+    function->set_extension(test_util::CreateEmptyExtension().get());
+    std::unique_ptr<base::ListValue> result(
+      utils::ToList(utils::RunFunctionAndReturnSingleResult(
+        function.get(), kQueryInfo, browser())));
+
+    EXPECT_EQ(2u, result.get()->GetSize());

[Devlin, 2016/07/11 16:32:28]

It might be worth checking that the tabs you get are the correct ones.

[Anderson Silva, 2016/07/11 19:47:51]

Done.
Checked in 2 results.

+  }
+
+  // Get discarded tabs after discarding one tab.
+  {
+    const char* kQueryInfo = "[{\"discarded\": true}]";
+    scoped_refptr<TabsQueryFunction> function = new TabsQueryFunction();
+    function->set_extension(test_util::CreateEmptyExtension().get());
+    std::unique_ptr<base::ListValue> result(
+      utils::ToList(utils::RunFunctionAndReturnSingleResult(
+        function.get(), kQueryInfo, browser())));
+
+    EXPECT_EQ(1u, result.get()->GetSize());
+  }
+
+  // Discards the other created tab.
+  EXPECT_TRUE(
+    tab_manager->DiscardTabById(reinterpret_cast<int64_t>(web_contents_b)));
+
+  // Get non-discarded tabs after discarding two created tabs.
+  {
+    const char* kQueryInfo = "[{\"discarded\": false}]";
+    scoped_refptr<TabsQueryFunction> function = new TabsQueryFunction();
+    function->set_extension(test_util::CreateEmptyExtension().get());
+    std::unique_ptr<base::ListValue> result(
+      utils::ToList(utils::RunFunctionAndReturnSingleResult(
+        function.get(), kQueryInfo, browser())));
+
+    EXPECT_EQ(1u, result.get()->GetSize());
+  }
+
+  // Get discarded tabs after discarding two created tabs.
+  {
+    const char* kQueryInfo = "[{\"discarded\": true}]";
+    scoped_refptr<TabsQueryFunction> function = new TabsQueryFunction();
+    function->set_extension(test_util::CreateEmptyExtension().get());
+    std::unique_ptr<base::ListValue> result(
+      utils::ToList(utils::RunFunctionAndReturnSingleResult(
+        function.get(), kQueryInfo, browser())));
+
+    EXPECT_EQ(2u, result.get()->GetSize());
+  }
+
+  auto tsm = browser()->tab_strip_model();

[Devlin, 2016/07/11 16:32:28]

style guide says to avoid using abbreviation like this. Prefer
"tab_strip_model".  Also, it's not immediately clear what type of object is
returned from tab_strip_model() (ptr?  refptr?  ref?), so I think the auto here
reduces readability.

tl;dr: TabStripModel* tab_strip_model = browser()->tab_strip_model().

[Anderson Silva, 2016/07/11 19:47:51]

Done.

+  tsm->ActivateTabAt(0, false);
+
+  // Get non-discarded tabs after activating a discarded tab.
+  {
+    const char* kQueryInfo = "[{\"discarded\": false}]";
+    scoped_refptr<TabsQueryFunction> function = new TabsQueryFunction();
+    function->set_extension(test_util::CreateEmptyExtension().get());
+    std::unique_ptr<base::ListValue> result(
+      utils::ToList(utils::RunFunctionAndReturnSingleResult(
+        function.get(), kQueryInfo, browser())));
+
+    EXPECT_EQ(2u, result.get()->GetSize());
+  }
+
+  // Get discarded tabs after activating a discarded tab.
+  {
+    const char* kQueryInfo = "[{\"discarded\": true}]";
+    scoped_refptr<TabsQueryFunction> function = new TabsQueryFunction();
+    function->set_extension(test_util::CreateEmptyExtension().get());
+    std::unique_ptr<base::ListValue> result(
+      utils::ToList(utils::RunFunctionAndReturnSingleResult(
+        function.get(), kQueryInfo, browser())));
+
+    EXPECT_EQ(1u, result.get()->GetSize());
+  }
+
+  browser()->tab_strip_model()->CloseAllTabs();

[Devlin, 2016/07/11 16:32:28]

Is this necessary?

[Anderson Silva, 2016/07/11 19:47:51]

Yes. Otherwise we crash at tear down.

[Anderson Silva, 2016/07/11 19:50:52]

Yes. Because there's a check to make sure that TabStripModel is empty on tear
down.

+}
+
 }  // namespace extensions