diff --git a/gatsby-config.js b/gatsby-config.js index 5814da953..1f79692c5 100644 --- a/gatsby-config.js +++ b/gatsby-config.js @@ -621,7 +621,7 @@ module.exports = { ], }, { - title: "Frameworks, libraries and bundling", + title: "Frameworks, Libraries and Bundling", path: "guides/develop/frameworks-libraries-bundling.md", }, { @@ -632,6 +632,10 @@ module.exports = { title: "Add-on iframe Context", path: "guides/develop/context.md", }, + { + title: "Cross-origin Isolation Handling", + path: "guides/develop/coi.md", + }, ], }, { diff --git a/package.json b/package.json index ff183dc2c..a887e9cce 100644 --- a/package.json +++ b/package.json @@ -12,7 +12,7 @@ "url": "https://github.com/icaraps" }, "dependencies": { - "@adobe/gatsby-theme-aio": "^4.14.4", + "@adobe/gatsby-theme-aio": "^4.14.14", "gatsby": "4.22.0", "react": "^17.0.2", "react-dom": "^17.0.2" diff --git a/src/pages/guides/develop/coi.md b/src/pages/guides/develop/coi.md new file mode 100644 index 000000000..c23984a88 --- /dev/null +++ b/src/pages/guides/develop/coi.md @@ -0,0 +1,143 @@ +# Cross-origin isolation handling + +How to ensure your add-ons work properly with the cross-origin isolation headers enforced by Adobe Express. + +## Overview + +Adobe Express will soon be enforcing cross-origin isolation on the associated domains (i.e., “new.express.adobe.com”) for Chromium-based browsers (including Chrome, Microsoft Edge, Opera, and others). This *may* impact your add-on due to stricter rules enforced by the browser. You’ll want to ensure that any add-ons you’ve developed or are developing now work in this new environment. + +Specifically, Adobe Express will be setting the following headers: + +- `Cross-Origin-Embedder-Policy: credentialless` +- `Cross-Origin-Opener-Policy: same-origin` +- `Cross-Origin-Resource-Policy: same-site` + +This change is being done to support Adobe Express’ use of certain browser capabilities requiring cross-origin isolation. + +## Impact + +This change may impact your add-on’s access to external resources, especially if it relies on iframes to display content or support payment flows. It could also impact `fetch` or image requests from external sources. In these cases, users may see missing content or be presented with silent failures if your add-on can’t load a remote resource. Since this results in a poor experience, developers must ensure that their add-ons work in the above environment. + +Please note that this change affects *all* add-ons, even those not published in the add-on marketplace (i.e., private and internally distributed add-ons). + +Currently, this change *only impacts* Chromium-based browsers (e.g., Chrome, Edge, Opera, etc.). Firefox and Safari browsers are currently exempt. If you've developed a an add-on with mobile support, this would apply to add-ons running on Android devices as well. + +## Types of failures + +Some failures will be more evident than others, but all will negatively impact the user experience of your add-on. + +- If a nested iframe fails to load, Chrome displays a very obvious error message inside the iframe indicating that the domain "refused to connect". +- If an image fails to load, you may notice missing images in your add-on’s user interface. You should also see failures in the Network section of the browser’s developer tools. +- If a network call fails due to JavaScript code, you should see warning and error messages in the browser’s developer tools. + +## Testing your add-on + +Until Adobe Express enables these headers by default, you must configure your local development environment to simulate these changes. + +### Apply local header overrides + +The developer tools in Chromium-based browsers on the desktop allow you to specify header overrides. Using this, you can simulate the headers that Adobe Express will enable to test whether your add-on has any problems in this environment. + + + +Mobile add-ons + +You cannot test this on mobile devices. You should test your add-on on a desktop web browser. Any issues you run into would also appear on mobile devices, and any fixes you apply would also apply to mobile users. + +To enable this environment yourself, perform the following steps: + +First, launch your browser’s developer tools and navigate to the "Network" tab, and then navigate to [Adobe Express](https://new.express.adobe.com) in the browser. Your network panel should fill up with a lot of network traffic, like this: + +![Network panel screenshot](./img/coi-test-1.png) + +To apply an override, right click on the entry for "new.express.adobe.com" and select **Override Headers**. + +![Override headers screenshot](./img/coi-test-2.png) + +Assuming you haven’t done this before, the developer tools will ask you to pick a folder on your local file system where these overrides are stored. the developer tools will ask you to pick a folder where these overrides are stored. This folder is on your local file system. The alert is easy to miss, since it doesn’t present as a dialog box, but rather a message near the top of your developer tool window. + +![Override storage folder screenshot](./img/coi-test-3.png) + +Click **Select Folder**. This will open your browser’s file picker. You’ll likely want to create a new folder for this step. You can put this anywhere you’d like. For example, in the following image we've selected the **Downloads** folder. + +![Override downloads folder screenshot](./img/coi-test-4.png) + +Depending on your operating system and location of the folder, the developer tools may need to request additional permissions in order to access the folder. If so, the message will again appear near the top of the developer tool window. + +![Allow access screenshot](./img/coi-test-5.png) + +Click **Allow**. This may prompt an operating system level permissions prompt. In that case, be sure to allow that as well: + +![OS permissions prompt screenshot](./img/coi-test-6.png) + +Once permissions have been granted, navigate to the **Sources** panel: + +![Sources panel screenshot](./img/coi-test-7.png) + +Next, click the **`>>`** icon and select **Overrides**: + +![Sources panel screenshot](./img/coi-test-8.png) + +Expand the entry you see there completely. You should see something like the following: + +![Sources panel screenshot](./img/coi-test-9.png) + +Click **Add override rule**: + +![Sources panel screenshot](./img/coi-test-10.png) + +Click on `header-name-1` and start entering the name of the first header -- in this case, `Cross-Origin-Embedder-Policy`. + +![Sources panel screenshot](./img/coi-test-11.png) + +Press TAB or click into the field that says "header value" and update it to the appropriate value -– in this case, `credentialless`. Once done, click the **+** icon to add the next header. + +![Credentialless header value](./img/coi-test-12.png) + +You’ll want to add headers until your overrides look like the following: + +![Final header values screenshot](./img/coi-test-13.png) + +At this point you can reload Adobe Express and proceed to test your add-on. Be sure to watch the network panel for errors that your add-on might encounter. + +### What to test in your add-on + +You should test flows in your add-on that involve the following: + +- **Purchase flows:** In particular, if you’re using an iframe to handle the purchase experience, you should also test an international purchase to ensure that any additional verification flows your payment provider requires also work. *Please note that if you handle purchases on a new tab, you should not need to worry about failures.* +- **Flows that load external domains in iframes:** For example, you may be using an iframe to generate a preview for the user or using an iframe to embed a video player. +- **Flows that display images and other content:** For example, if you’ve built an add-on that allows the user to add stickers and the stickers are served from your domain or another third party, you should verify that the images appear in the add-on’s user interface correctly. (If the content is bundled with your add-on you should already be covered.) +- **Flows that add content to the user’s document:** Make sure that users can successfully add images or other assets to the document if your add-on provides this functionality. This should only apply to assets loaded from your domain or an external domain. Generated assets or assets bundled with your add-on should not have any issues. + +If your add-on doesn’t access external content, make network calls, or use iframes to display content or payment flows, you should not be affected by this change. + +## Disabling overrides + +When you’re done testing, you’ll likely want to disable any header overrides in your browser’s developer tools. You can disable the overrides by unchecking **Enable Local Overrides** or by removing the header override directly. + +![Disable overrides screenshot](./img/coi-test-14.png) + +## Addressing issues found in your add-on + +Applying fixes to your add-on is generally straightforward, but does depend on the issue you’re seeing. + +### Fixing assets that fail to load + +If the asset is in an `` tag, you’ll want to set the `crossorigin` attribute. You can also set the `crossOrigin` property when using JavaScript. For examples, see the [MDN web documentation](https://developer.mozilla.org/en-US/docs/Web/API/HTMLImageElement/crossOrigin). + +### Fixing iframes or network calls that fail to load + +You’ll need to set the following headers on the endpoint you’re trying to load. If loading an iframe, you’ll likely need to ensure these headers apply to all assets that can be loaded by the iframe. + +- `Cross-Origin-Embedder-Policy: credentialless` +- `Cross-Origin-Resource-Policy: cross-origin` + +If the endpoint is managed by a third party, you may have more difficulty in addressing the issue. Some things you can do: + +- Check if the third party provider provides a mechanism to specify header overrides. +- Ask if the third party provider can set headers for you via their existing support channels. +- Create a proxy that you control to act as an intermediary. This has security and privacy implications since you need to ensure that the proxy is secure, doesn’t mix up or serve incorrect data, and doesn’t preserve user information for any longer than necessary to complete the transaction. + +## Review process impact + +All new add-ons published to the marketplace will be reviewed with these headers in place. If the reviewer finds a problem with your submission related to cross-origin isolation that impacts the usability of your add-on, the reviewer will reject your add-on. You can then use the above to address the issues before submitting again. diff --git a/src/pages/guides/develop/img/Cross-origin isolation for third-party add-on developers/images/image14.png b/src/pages/guides/develop/img/Cross-origin isolation for third-party add-on developers/images/image14.png new file mode 100644 index 000000000..55ab9d9b9 Binary files /dev/null and b/src/pages/guides/develop/img/Cross-origin isolation for third-party add-on developers/images/image14.png differ diff --git a/src/pages/guides/develop/img/coi-test-1.png b/src/pages/guides/develop/img/coi-test-1.png new file mode 100644 index 000000000..e266e7e20 Binary files /dev/null and b/src/pages/guides/develop/img/coi-test-1.png differ diff --git a/src/pages/guides/develop/img/coi-test-10.png b/src/pages/guides/develop/img/coi-test-10.png new file mode 100644 index 000000000..6607a51e8 Binary files /dev/null and b/src/pages/guides/develop/img/coi-test-10.png differ diff --git a/src/pages/guides/develop/img/coi-test-11.png b/src/pages/guides/develop/img/coi-test-11.png new file mode 100644 index 000000000..2e60010f2 Binary files /dev/null and b/src/pages/guides/develop/img/coi-test-11.png differ diff --git a/src/pages/guides/develop/img/coi-test-12.png b/src/pages/guides/develop/img/coi-test-12.png new file mode 100644 index 000000000..b9efde6e3 Binary files /dev/null and b/src/pages/guides/develop/img/coi-test-12.png differ diff --git a/src/pages/guides/develop/img/coi-test-13.png b/src/pages/guides/develop/img/coi-test-13.png new file mode 100644 index 000000000..136d6f6fd Binary files /dev/null and b/src/pages/guides/develop/img/coi-test-13.png differ diff --git a/src/pages/guides/develop/img/coi-test-14.png b/src/pages/guides/develop/img/coi-test-14.png new file mode 100644 index 000000000..a531073d9 Binary files /dev/null and b/src/pages/guides/develop/img/coi-test-14.png differ diff --git a/src/pages/guides/develop/img/coi-test-2.png b/src/pages/guides/develop/img/coi-test-2.png new file mode 100644 index 000000000..13ace59fd Binary files /dev/null and b/src/pages/guides/develop/img/coi-test-2.png differ diff --git a/src/pages/guides/develop/img/coi-test-3.png b/src/pages/guides/develop/img/coi-test-3.png new file mode 100644 index 000000000..eb4e86454 Binary files /dev/null and b/src/pages/guides/develop/img/coi-test-3.png differ diff --git a/src/pages/guides/develop/img/coi-test-4.png b/src/pages/guides/develop/img/coi-test-4.png new file mode 100644 index 000000000..27857fe24 Binary files /dev/null and b/src/pages/guides/develop/img/coi-test-4.png differ diff --git a/src/pages/guides/develop/img/coi-test-5.png b/src/pages/guides/develop/img/coi-test-5.png new file mode 100644 index 000000000..53c93c1ce Binary files /dev/null and b/src/pages/guides/develop/img/coi-test-5.png differ diff --git a/src/pages/guides/develop/img/coi-test-6.png b/src/pages/guides/develop/img/coi-test-6.png new file mode 100644 index 000000000..5d50bd255 Binary files /dev/null and b/src/pages/guides/develop/img/coi-test-6.png differ diff --git a/src/pages/guides/develop/img/coi-test-7.png b/src/pages/guides/develop/img/coi-test-7.png new file mode 100644 index 000000000..55ab9d9b9 Binary files /dev/null and b/src/pages/guides/develop/img/coi-test-7.png differ diff --git a/src/pages/guides/develop/img/coi-test-8.png b/src/pages/guides/develop/img/coi-test-8.png new file mode 100644 index 000000000..3e2cd3efe Binary files /dev/null and b/src/pages/guides/develop/img/coi-test-8.png differ diff --git a/src/pages/guides/develop/img/coi-test-9.png b/src/pages/guides/develop/img/coi-test-9.png new file mode 100644 index 000000000..2cc6e84a1 Binary files /dev/null and b/src/pages/guides/develop/img/coi-test-9.png differ diff --git a/src/pages/references/addonsdk/app-document.md b/src/pages/references/addonsdk/app-document.md index b9ac9aa96..6416c0f96 100644 --- a/src/pages/references/addonsdk/app-document.md +++ b/src/pages/references/addonsdk/app-document.md @@ -327,7 +327,7 @@ Refer to the [importing content use case](../../guides/develop/use_cases/content ### importPdf() -Adds a PDF to the current page. +Imports a PDF as a new Adobe Express document. @@ -382,7 +382,7 @@ async function importPdfFrom(url) { ### importPresentation() -Imports a presentation to the document. **Note:** Currently Express only supports PowerPoint presentations (`.pptx`). +Imports a presentation as a new Adobe Express document. **Note:** Currently Express only supports PowerPoint presentations. diff --git a/src/pages/references/changelog.md b/src/pages/references/changelog.md index c6c95da88..6ef882d00 100644 --- a/src/pages/references/changelog.md +++ b/src/pages/references/changelog.md @@ -21,6 +21,11 @@ contributors: # Changelog +## 2024-11-04 + +- Adds a new [Cross-origin Isolation Handling](../guides/develop/coi.md) page which describes an upcoming change to how Adobe Express enforces cross-origin isolation, and the impact it may have on current add-ons, as well as those currently in-development. +- Updates the descriptions for the [`importPdf()`](./addonsdk/app-document.md#importpdf) and [`importPresentation()`](./addonsdk/app-document.md#importpresentation) functions to clarify that when used, the associated PDF or presentation file will be imported as a new Adobe Express document. + ## 2024-10-08 - Adds a brand new version of the [UX Guidelines](../guides/design/ux_guidelines/introduction.md) for Adobe Express add-ons.