Skip to content

Comments

feat(createSharedComposable)!: return only the sharedComposable on client side#4997

Merged
antfu merged 6 commits intovueuse:mainfrom
9romise:ssr-sharedComposable
Sep 16, 2025
Merged

feat(createSharedComposable)!: return only the sharedComposable on client side#4997
antfu merged 6 commits intovueuse:mainfrom
9romise:ssr-sharedComposable

Conversation

@9romise
Copy link
Member

@9romise 9romise commented Aug 29, 2025 •
edited
Loading

Before submitting the PR, please make sure you do the following

  • Read the Contributing Guidelines.
  • Read the Pull Request Guidelines.
  • Check that there isn't already a PR that solves the problem the same way to avoid creating a duplicate.
  • Provide a description in this PR that addresses what the PR is solving, or reference the issue that it solves (e.g. fixes #123).
  • Ideally, include relevant tests that fail without this PR but pass with it.
⚠️ Slowing down new functions

Warning: Slowing down new functions

As the VueUse audience continues to grow, we have been inundated with an overwhelming number of feature requests and pull requests. As a result, maintaining the project has become increasingly challenging and has stretched our capacity to its limits. As such, in the near future, we may need to slow down our acceptance of new features and prioritize the stability and quality of existing functions. Please note that new features for VueUse may not be accepted at this time. If you have any new ideas, we suggest that you first incorporate them into your own codebase, iterate on them to suit your needs, and assess their generalizability. If you strongly believe that your ideas are beneficial to the community, you may submit a pull request along with your use cases, and we would be happy to review and discuss them. Thank you for your understanding.

Description

This PR introduces packages/**/*.server.test.ts files dedicated to server-side testing, along with simple scripts and CI configurations.

Closes #4991

Additional context

@dosubot dosubot bot added size:M This PR changes 30-99 lines, ignoring generated files. enhancement New feature or request labels Aug 29, 2025
@pkg-pr-new
Copy link

pkg-pr-new bot commented Aug 29, 2025 •
edited
Loading

Open in StackBlitz

@vueuse/components

npm i https://pkg.pr.new/@vueuse/components@4997

@vueuse/core

npm i https://pkg.pr.new/@vueuse/core@4997

@vueuse/electron

npm i https://pkg.pr.new/@vueuse/electron@4997

@vueuse/firebase

npm i https://pkg.pr.new/@vueuse/firebase@4997

@vueuse/integrations

npm i https://pkg.pr.new/@vueuse/integrations@4997

@vueuse/math

npm i https://pkg.pr.new/@vueuse/math@4997

@vueuse/metadata

npm i https://pkg.pr.new/@vueuse/metadata@4997

@vueuse/nuxt

npm i https://pkg.pr.new/@vueuse/nuxt@4997

@vueuse/router

npm i https://pkg.pr.new/@vueuse/router@4997

@vueuse/rxjs

npm i https://pkg.pr.new/@vueuse/rxjs@4997

@vueuse/shared

npm i https://pkg.pr.new/@vueuse/shared@4997

commit: c73d3a6

antfu
antfu reviewed Sep 1, 2025
View reviewed changes
packages/shared/createSharedComposable/index.ts
*/
export function createSharedComposable<Fn extends AnyFn>(composable: Fn): SharedComposableReturn<Fn> {
if (!isClient)
return composable
Copy link
Member

@antfu antfu Sep 1, 2025

Choose a reason for hiding this comment

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

I am not sure if this is the most expected behavior. But at least we should mention this behavior in the docs. (also better consider this breaking to bring more awareness)

Copy link
Contributor

@Tofandel Tofandel Oct 22, 2025 •
edited
Loading

Choose a reason for hiding this comment

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

Couldn't we use getCurrentInstance if available and keep a Weakmap based on the root app of which instance is requesting the sharedComposable to avoid the cross request pollution while still preserving the desired behavior?

@9romise
Copy link
Member Author

9romise commented Sep 2, 2025

I believe createGlobalState would likely need this too.

Additionally, I noticed we already have an ssr-plugin in @vueuse/nuxt – should we handle this within that plugin?

@antfu antfu changed the title feat(createSharedComposable): return only the sharedComposable on client side feat(createSharedComposable)!: return only the sharedComposable on client side Sep 16, 2025
@antfu antfu enabled auto-merge September 16, 2025 14:18
@antfu antfu added this pull request to the merge queue Sep 16, 2025
@dosubot dosubot bot added the lgtm This PR has been approved by a maintainer label Sep 16, 2025
Merged via the queue into vueuse:main with commit 73aad31 Sep 16, 2025
10 checks passed
@9romise 9romise deleted the ssr-sharedComposable branch September 16, 2025 15:35
@romansp romansp mentioned this pull request Sep 19, 2025
Closed
7 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@antfu antfu antfu approved these changes

+1 more reviewer

@Tofandel Tofandel Tofandel left review comments

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

enhancement New feature or request lgtm This PR has been approved by a maintainer size:M This PR changes 30-99 lines, ignoring generated files.

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

createSharedComposable | SSR Handlers Support

3 participants

@9romise @Tofandel @antfu