[MV3 Debug Extension] Clean up tests in preparation for supporting compiling to MV2 (#1964)

Author: elliette

dwds/test/puppeteer/extension_test.dart

@@ -277,7 +277,10 @@ void main() async {
           final devToolsTabTarget = await browser.waitForTarget(
               (target) => target.url.contains(devToolsUrlFragment));
           // There should be no warning notifications:
-          var chromeNotifications = await worker.evaluate(_getNotifications());
+          var chromeNotifications = await evaluate(
+            _getNotifications(),
+            worker: worker,
+          );
           expect(chromeNotifications, isEmpty);
           // Navigate back to Dart app:
           await navigateToPage(browser, url: appUrl, isNew: false);
@@ -286,7 +289,8 @@ void main() async {
           await clickOnExtensionIcon(worker);
           await workerEvalDelay();
           // There should now be a warning notificiation:
-          chromeNotifications = await worker.evaluate(_getNotifications());
+          chromeNotifications =
+              await evaluate(_getNotifications(), worker: worker);
           expect(chromeNotifications, isNotEmpty);
           // Close the Dart app and the associated Dart DevTools:
           await appTab.close();
@@ -705,15 +709,21 @@ Future<int> _getTabId(
   required Worker worker,
 }) async {
   final jsExpression = _tabIdForTabJs(url);
-  return (await worker.evaluate(jsExpression)) as int;
+  return (await evaluate(
+    jsExpression,
+    worker: worker,
+  )) as int;
 }
 
 Future<int?> _getWindowId(
   String url, {
   required Worker worker,
 }) async {
   final jsExpression = _windowIdForTabJs(url);
-  return (await worker.evaluate(jsExpression)) as int?;
+  return (await evaluate(
+    jsExpression,
+    worker: worker,
+  )) as int?;
 }
 
 Future<T> _fetchStorageObj<T>(
@@ -722,10 +732,13 @@ Future<T> _fetchStorageObj<T>(
   required Worker worker,
 }) async {
   final json = await retryFnAsync<String>(() async {
-    final storageObj = await worker.evaluate(_fetchStorageObjJs(
-      storageKey,
-      storageArea: storageArea,
-    ));
+    final storageObj = await evaluate(
+      _fetchStorageObjJs(
+        storageKey,
+        storageArea: storageArea,
+      ),
+      worker: worker,
+    );
     return storageObj[storageKey];
   });
   if (T == String) return json as T;

dwds/test/puppeteer/test_images/chromeDevTools_externalBuild.png

@@ -13,12 +13,12 @@ import '../fixtures/context.dart';
 import '../fixtures/utilities.dart';
 
 enum ConsoleSource {
-  worker,
   devTools,
+  worker,
 }
 
-final _workerLogs = [];
 final _devToolsLogs = [];
+final _workerLogs = [];
 
 Future<String> buildDebugExtension() async {
   final extensionDir = absolutePath(pathFromDwds: 'debug_extension_mv3');
@@ -65,7 +65,7 @@ Future<void> tearDownHelper({required Worker worker}) async {
   _logConsoleMsgsOnFailure();
   _workerLogs.clear();
   _devToolsLogs.clear();
-  await worker.evaluate(_clearStorageJs).catchError((_) {});
+  await _clearStorage(worker: worker);
 }
 
 Future<Worker> getServiceWorker(Browser browser) async {
@@ -77,7 +77,7 @@ Future<Worker> getServiceWorker(Browser browser) async {
     worker.url,
     onConsoleApiCalled: (type, jsHandles, _) {
       for (var handle in jsHandles) {
-        saveConsoleMsg(
+        _saveConsoleMsg(
             source: ConsoleSource.worker, type: '$type', msg: '$handle');
       }
     },
@@ -91,7 +91,7 @@ Future<Page> getChromeDevToolsPage(Browser browser) async {
   chromeDevToolsTarget.type = 'page';
   final chromeDevToolsPage = await chromeDevToolsTarget.page;
   chromeDevToolsPage.onConsole.listen((msg) {
-    saveConsoleMsg(
+    _saveConsoleMsg(
       source: ConsoleSource.devTools,
       type: '${msg.type}',
       msg: msg.text ?? '',
@@ -100,26 +100,12 @@ Future<Page> getChromeDevToolsPage(Browser browser) async {
   return chromeDevToolsPage;
 }
 
-void saveConsoleMsg({
-  required ConsoleSource source,
-  required String type,
-  required String msg,
-}) {
-  if (msg.isEmpty) return;
-  final consiseMsg = msg.startsWith('JSHandle:') ? msg.substring(9) : msg;
-  final formatted = 'console.$type: $consiseMsg';
-  switch (source) {
-    case ConsoleSource.worker:
-      _workerLogs.add(formatted);
-      break;
-    case ConsoleSource.devTools:
-      _devToolsLogs.add(formatted);
-      break;
-  }
+Future evaluate(String jsExpression, {required Worker worker}) async {
+  return worker.evaluate(jsExpression);
 }
 
 Future<void> clickOnExtensionIcon(Worker worker) async {
-  return worker.evaluate(_clickIconJs);
+  return evaluate(_clickIconJs, worker: worker);
 }
 
 // Note: The following delay is required to reduce flakiness. It makes
@@ -156,6 +142,24 @@ String getExtensionOrigin(Browser browser) {
   return '$chromeExtension//$extensionId';
 }
 
+void _saveConsoleMsg({
+  required ConsoleSource source,
+  required String type,
+  required String msg,
+}) {
+  if (msg.isEmpty) return;
+  final consiseMsg = msg.startsWith('JSHandle:') ? msg.substring(9) : msg;
+  final formatted = 'console.$type: $consiseMsg';
+  switch (source) {
+    case ConsoleSource.devTools:
+      _devToolsLogs.add(formatted);
+      break;
+    case ConsoleSource.worker:
+      _workerLogs.add(formatted);
+      break;
+  }
+}
+
 void _logConsoleMsgsOnFailure() {
   if (_workerLogs.isNotEmpty) {
     printOnFailure(['Service Worker logs:', ..._workerLogs].join('\n'));
@@ -174,6 +178,15 @@ Future<Page> _getPageForUrl(Browser browser, {required String url}) {
   return pageTarget.page;
 }
 
+Future<void> _clearStorage({
+  required Worker worker,
+}) async {
+  return evaluate(
+    _clearStorageJs,
+    worker: worker,
+  ).catchError((_) {});
+}
+
 final _clickIconJs = '''
   async () => {
     const activeTabs = await chrome.tabs.query({ active: true });