on import link extensions make absolute urls relative #4877
Conversation
alfonso-noriega
force-pushed
the
admin-link-import-transform-url-to-relative
branch
7 times, most recently
from
1b3a211
to
ae2e639
Compare
![graphite-app[bot]](https://avatars.githubusercontent.com/in/158384?s=60&v=4){kind=small}
packages/app/src/cli/services/admin-link/extension-to-toml.test.ts
Outdated
Show resolved
Hide resolved
alfonso-noriega
force-pushed
the
admin-link-import-transform-url-to-relative
branch
2 times, most recently
from
b2d26db
to
bd01c9b
Compare
Coverage report
Show files with reduced coverage 🔻
Test suite run success1950 tests passing in 888 suites. Report generated by 🧪jest coverage report action from 68bf4b6 |
|
We detected some changes at packages/*/src and there are no updates in the .changeset. |
alfonso-noriega
force-pushed
the
admin-link-import-transform-url-to-relative
branch
from
bd01c9b
to
5297a9c
Compare
alfonso-noriega
force-pushed
the
admin-link-import-transform-url-to-relative
branch
8 times, most recently
from
2a816ca
to
83ee53c
Compare
|
/snapit |
|
🫰✨ Thanks @alfonso-noriega! Your snapshot has been published to npm. Test the snapshot by intalling your package globally: pnpm i -g @shopify/[email protected]
|
alfonso-noriega
force-pushed
the
admin-link-import-transform-url-to-relative
branch
from
83ee53c
to
68bf4b6
Compare
Unused dependencies (1)
Unused devDependencies (1)
Unused types (1)
|
| const linkPath = linkUrl.pathname.startsWith('/') ? linkUrl.pathname.substring(1) : linkUrl.pathname | ||
| const fullUrl = new URL(`app://${linkPath}`) | ||
| fullUrl.search = linkUrl.search | ||
| fullUrl.hash = linkUrl.hash | ||
| config.url = fullUrl.toString() |
There was a problem hiding this comment.
When linkUrl.pathname is / (e.g., in https://example.com?foo=bar), the current code will set linkPath to an empty string, but the query parameters and hash fragment won't be preserved in the final URL. To fix this edge case, modify the pathname check:
const linkPath = linkUrl.pathname === '/' ? '' : linkUrl.pathname.substring(1)This ensures query parameters and hash fragments are correctly preserved in URLs that point to the root path.
Spotted by Graphite Reviewer
Is this helpful? React 👍 or 👎 to let us know.
|
/snapit |
|
🫰✨ Thanks @alfonso-noriega! Your snapshot has been published to npm. Test the snapshot by intalling your package globally: pnpm i -g @shopify/[email protected]
|
WHY are these changes introduced?
The current process to create legacy link extensions in the partners dashboard enables to create non secure and external pointing absolute URLs for embedded apps. Those URLs are later on overwritten by core to point to the shop embedded app URL.
This behaviour fills the DB with incorrect URLs and the new CLI managed admin link extension is avoiding this pattern.
WHAT is this pull request doing?
To reduce friction on the partners migration, this code automatically ignores the domain of the embedded app legacy link extensions and transforms them into relative URLs.
How to test your changes?
From the CLI repo, checkout this branch.
Create a link extension in the partners dashboard with an absolute URL pointing to a random external domain (http://example.org/product).
In the CLI repo run the import extensions command:
pnpm shopify app import-extensions --path path-to-your-appSelect the admin links option
Check the the generated extension toml contains a url like
app://productI've considered possible cross-platform impacts (Mac, Linux, Windows)
I've considered possible documentation changes