#7378: Fix page editor detection

src/__mocks__/@/utils/expectContext.ts

@@ -17,3 +17,5 @@
 
 export function expectContext() {}
 export function forbidContext() {}
+
+export { isPageEditor } from "../../../utils/expectContext";

src/background/executor.ts

@@ -68,8 +68,8 @@ async function safelyRunBrick(
     }
 
     // This must follow the tab existence checks or else it returns false even if the tab simply doesn't exist
-    if (!(await canAccessTab(tabId))) {
-      throw new BusinessError("PixieBrix doesn't have access to the tab");
+    if (!(await canAccessTab({ tabId, frameId }))) {
+      throw new BusinessError("PixieBrix doesn't have access to the page");
     }
 
     throw error;

src/contrib/google/sheets/core/useCurrentOrigin.test.ts

@@ -57,14 +57,6 @@ describe("useCurrentOrigin", () => {
     expect(result.current).toBe("chrome-extension://abcxyz/");
   });
 
-  test("if devtools page, should return devtools origin", async () => {
-    setContext("devToolsPage");
-    const { result } = renderHook(() => useCurrentOrigin());
-    // Wait for origin to load (async state)
-    await waitForEffect();
-    expect(result.current).toBe(DEVTOOLS_ORIGIN);
-  });
-
   test("if page editor page, should return devtools origin", async () => {
     setContext("extension");
     location = {

src/contrib/google/sheets/core/useCurrentOrigin.ts

@@ -15,10 +15,11 @@
  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 
-import { isDevToolsPage, isOptionsPage } from "webext-detect-page";
+import { isOptionsPage } from "webext-detect-page";
 import { useEffect } from "react";
 import notify from "@/utils/notify";
 import useAsyncState from "@/hooks/useAsyncState";
+import { isPageEditor } from "@/utils/expectContext";
 
 /**
  * Get the current origin for where code is running. Used to set the origin on the
@@ -40,14 +41,7 @@ function useCurrentOrigin(): string | null {
       return browser.runtime.getURL("");
     }
 
-    if (
-      // Checks location.pathname against the 'devtools_page' value in manifest.json
-      // This won't match for dev tools panels created by the devtool
-      // page (i.e. the Page Editor)
-      isDevToolsPage() ||
-      // Check for the page editor pagePath in the location pathname
-      location.pathname === "/pageEditor.html"
-    ) {
+    if (isPageEditor()) {
       return "devtools://devtools";
     }
 

src/contrib/uipath/LocalProcessOptions.tsx

@@ -42,7 +42,7 @@ const LocalProcessOptions: React.FunctionComponent<BlockOptionProps> = ({
 }) => {
   // Crash the React tree, because it's a programming error to use this configuration outside the dev tools
   expectContext(
-    "devTools",
+    "pageEditor",
     "useLocalRobot only works in the Page Editor due to its `thisTab` usage",
   );
 

src/pageEditor/hooks/useCurrentUrl.ts

@@ -52,7 +52,7 @@ const startWatching = once(async () => {
 });
 
 export default function useCurrentUrl(): string {
-  expectContext("devTools");
+  expectContext("pageEditor");
 
   const [url, setUrl] = useState(tabUrl);
 

src/pageEditor/utils.ts

@@ -48,7 +48,7 @@ import { CustomFormRenderer } from "@/bricks/renderers/customForm";
 import MapValues from "@/bricks/transformers/controlFlow/MapValues";
 
 export async function getCurrentURL(): Promise<string> {
-  expectContext("devTools");
+  expectContext("pageEditor");
 
   const tab = await browser.tabs.get(chrome.devtools.inspectedWindow.tabId);
   return tab.url;

src/telemetry/BackgroundLogger.ts

@@ -17,13 +17,13 @@
 
 import { type Logger, type MessageContext } from "@/types/loggerTypes";
 import { type JsonObject } from "type-fest";
-import { isBackground, isDevToolsPage } from "webext-detect-page";
+import { isBackground } from "webext-detect-page";
 import {
   notifyContextInvalidated,
   wasContextInvalidated,
 } from "@/errors/contextInvalidated";
 import { recordLog } from "@/background/messenger/api";
-import { expectContext } from "@/utils/expectContext";
+import { expectContext, isPageEditor } from "@/utils/expectContext";
 import reportError from "@/telemetry/reportError";
 
 /**
@@ -73,7 +73,7 @@ class BackgroundLogger implements Logger {
   }
 
   async error(error: unknown, data: JsonObject): Promise<void> {
-    if (wasContextInvalidated() && !isBackground() && !isDevToolsPage()) {
+    if (wasContextInvalidated() && !isBackground() && !isPageEditor()) {
       void notifyContextInvalidated();
     }
 

src/testUtils/detectPageMock.ts

@@ -35,10 +35,6 @@ export function isOptionsPage() {
   return _context === "options";
 }
 
-export function isDevToolsPage() {
-  return _context === "devToolsPage";
-}
-
 export function isBackground() {
   return _context === "background";
 }

src/utils/expectContext.ts

@@ -20,13 +20,16 @@ import {
   isContentScript,
   isExtensionContext,
   isWebPage,
-  contextNames,
 } from "webext-detect-page";
 
 function isBrowserSidebar(): boolean {
   return isExtensionContext() && location.pathname === "/sidebar.html";
 }
 
+export function isPageEditor(): boolean {
+  return location.pathname === "/pageEditor.html";
+}
+
 /**
  * Accepts 'This is my error' | new Error('This is my error') | Error;
  * The constructor would be used to create a custom error with the default message
@@ -48,18 +51,15 @@ function createError(
   return new errorOrCtor(defaultMessage);
 }
 
-// eslint-disable-next-line local-rules/persistBackgroundData -- Static
-const contexts = [...contextNames, "sidebar"] as const;
-
 // eslint-disable-next-line local-rules/persistBackgroundData -- Functions
-const contextMap = new Map<(typeof contexts)[number], () => boolean>([
-  ["web", isWebPage],
-  ["extension", isExtensionContext],
-  ["background", isBackground],
-  ["contentScript", isContentScript],
-  ["sidebar", isBrowserSidebar],
-  ["devTools", () => "devtools" in chrome],
-]);
+const contextMap = {
+  web: isWebPage,
+  extension: isExtensionContext,
+  background: isBackground,
+  pageEditor: isPageEditor,
+  contentScript: isContentScript,
+  sidebar: isBrowserSidebar,
+} as const;
 
 /**
  * @example expectContext('extension')
@@ -68,10 +68,10 @@ const contextMap = new Map<(typeof contexts)[number], () => boolean>([
  * @example expectContext('extension', new Error('Wrong context and this is my custom error'))
  */
 export function expectContext(
-  context: (typeof contexts)[number],
+  context: keyof typeof contextMap,
   error?: ErrorBaseType,
 ): void {
-  const isContext = contextMap.get(context);
+  const isContext = contextMap[context];
   if (!isContext) {
     throw new TypeError(`Context "${context}" not found`);
   }
@@ -91,10 +91,10 @@ export function expectContext(
  * @example forbidContext('extension', new Error('Wrong context and this is my custom error'))
  */
 export function forbidContext(
-  context: (typeof contexts)[number],
+  context: keyof typeof contextMap,
   error?: ErrorBaseType,
 ): void {
-  const isContext = contextMap.get(context);
+  const isContext = contextMap[context];
   if (!isContext) {
     throw new TypeError(`Context "${context}" not found`);
   }