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.

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

fix: service worker base path in dev mode #12577

Open
wants to merge 5 commits into
base: main
Choose a base branch
from

Conversation

TorstenDittmann
Copy link

@TorstenDittmann TorstenDittmann commented Aug 14, 2024

Using a service worker in dev mode was not respecting the configured base path and it was missing from the filesystem import.

This PR prepends the base path before the filesystem import.

In a case with the basepath of /console, http://localhost:3000/console/service-worker.js will resolve now to:

- import '/@fs/Users/torstendittmann/Documents/GitHub/appwrite/console/src/service-worker.ts';
+ import '/console/@fs/Users/torstendittmann/Documents/GitHub/appwrite/console/src/service-worker.ts';

I didn't find a good place to add a test though. I could add another packages/kit/test/apps/dev-only test suite with a base path, but I'd rather wait on some feedback if this is the right choice 👍🏻

Created a PoC of what the tests could look like => TorstenDittmann/kit@fix-service-worker-base-path...fix-service-worker-base-path-tests

More context to this issue can be found here => #12039


Please don't delete this checklist! Before submitting the PR, please make sure you do the following:

  • It's really useful if your PR references an issue where it is discussed ahead of time. In many cases, features are absent for a reason. For large changes, please create an RFC: https://github.com/sveltejs/rfcs
  • This message body should clearly illustrate what problems it solves.
  • Ideally, include a test that fails without this PR but passes with it.

Tests

  • Run the tests with pnpm test and lint the project with pnpm lint and pnpm check

Changesets

  • If your PR makes a change that should be noted in one or more packages' changelogs, generate a changeset by running pnpm changeset and following the prompts. Changesets that add features should be minor and those that fix bugs should be patch. Please prefix changeset messages with feat:, fix:, or chore:.

Edits

  • Please ensure that 'Allow edits from maintainers' is checked. PRs without this option may be closed.

Copy link

changeset-bot bot commented Aug 14, 2024

🦋 Changeset detected

Latest commit: 28294e3

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package
Name Type
@sveltejs/kit Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

@eltigerchino eltigerchino added the bug Something isn't working label Oct 9, 2024
@eltigerchino
Copy link
Member

Thanks for the PR! Is this test suite a good fit for your test?

test.describe('Service worker', () => {
I noticed it also has a test with a base path and a service worker.

@eltigerchino eltigerchino added service worker Stuff related to service workers and removed bug Something isn't working labels Oct 9, 2024
@TorstenDittmann
Copy link
Author

Thanks for the PR! Is this test suite a good fit for your test?

test.describe('Service worker', () => {

I noticed it also has a test with a base path and a service worker.

Hey, thank you for the review. Saw it a bit late :-) will go through it 👍🏻

@TorstenDittmann
Copy link
Author

Thanks for the PR! Is this test suite a good fit for your test?

test.describe('Service worker', () => {

I noticed it also has a test with a base path and a service worker.

The tests are skipped in dev mode 👍🏻 let me just add relevant test cases there 💪🏻

@TorstenDittmann
Copy link
Author

@eltigerchino added the tests and your comment 👍🏻

@eltigerchino
Copy link
Member

eltigerchino commented Oct 17, 2024

Thank you! I'll wait for another review before merging just to sanity check this.

@eltigerchino eltigerchino added the paths.base bugs relating to `config.kit.paths.base` label Oct 17, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
paths.base bugs relating to `config.kit.paths.base` service worker Stuff related to service workers
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants