Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

runtime.getURL fixes #35136

Merged
merged 3 commits into from
Aug 5, 2024
Merged

runtime.getURL fixes #35136

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
7ba43d5
runtime.getURL fixes
rebloor Jul 26, 2024
8b8fb5e
Feedback update
rebloor Aug 1, 2024
9aea26d
Merge branch 'main' into runtime.getURL-fixes
rebloor Aug 1, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion files/en-us/mozilla/add-ons/webextensions/api/runtime/geturl/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ browser.runtime.getURL(

### Return value

`string`. The fully-qualified URL to the resource.
`string`. The fully-qualified URL to the resource. For example, `moz-extension://e15cdd35-f9b7-4786-a39d-7d801bd2709e/help/open-in-container.html`.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's drop this example. It is not obvious from just this description how the URL is derived from the input.

Furthermore, the code example below already offers a comment showing the format of the return value in Firefox specifically.

Suggested change
`string`. The fully-qualified URL to the resource. For example, `moz-extension://e15cdd35-f9b7-4786-a39d-7d801bd2709e/help/open-in-container.html`.
`string`. The fully-qualified URL to the resource within the extension.


## Browser compatibility

Expand Down
2 changes: 2 additions & 0 deletions files/en-us/mozilla/firefox/releases/130/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,8 @@ This article provides information about the changes in Firefox 130 that affect d

## Changes for add-on developers

- {{WebExtAPIRef("runtime.getURL")}} (and the deprecated {{WebExtAPIRef("extension.getURL")}}) have been updated to prefix the supplied path string with the extension's `moz-extension:` origin (in line with the behavior of Chrome). In addition, {{WebExtAPIRef("runtime.getURL")}} no longer strips `/.`, `./`, and `../.` strings from the input URL ([Firefox bug 1795082](https://bugzil.la/1795082)).
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The description here does not highlight the difference in comparison with the previous implementation.

A better description is to write that the extension origin is now always prepended to the path, without further normalization. Previously, when an absolute URL was provided instead of a relatively URL, that absolute URL was returned. "Without further normalization" captures changes like "/../" and "/./"


### Removals

### Other
Expand Down