Skip to content

This issue was moved to a discussion.

You can continue the conversation there. Go to discussion →

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

[✨] Need destroy hook. #74

Closed
mhevery opened this issue Jul 21, 2023 · 1 comment
Closed

[✨] Need destroy hook. #74

mhevery opened this issue Jul 21, 2023 · 1 comment
Labels
[STAGE-2] incomplete implementation Remove this label when implementation is complete [STAGE-2] not fully covered by tests yet Remove this label when tests are verified to cover the implementation [STAGE-2] unresolved discussions left Remove this label when all critical discussions are resolved on the issue [STAGE-3] docs changes not added yet Remove this label when the necessary documentation for the feature / change is added [STAGE-3] missing 2 reviews for RFC PRs Remove this label when at least 2 core team members reviewed and approved the RFC implementation

Comments

@mhevery
Copy link

mhevery commented Jul 21, 2023

Is your feature request related to a problem?

Today you can call cleanup to release resources specific to the VM. But what if the component needs to notify a parent component that it is being returned? In such a case there is no hook which can survive resuming.

Example:

export default component$(() => {
  const list = useStore([1,2,3];
  return (
    <Parent>
    {list.map((item)=> <Child/>}
    </Parent>
  );
})

const CHILDREN = createContextId<Array<Signal<any>>>('children');
export const Parent = compont$(( )=> {
  const context = useStore([]);
  useContextProvider(CHILDREN, context);
  return <Slot/>;
});

export const Child = compont$(( )=> {
  const ref = useSignal();
  const context = useContext(CHILDREN);
  useTask$(({cleanup}) => {
    context.push(ref);
    cleanup({
      // PROBLEM HERE ❌ ❌ ❌ ❌ 
      // The issue is that the cleanup gets called during serialization
      // on the server, which releases the children from the parents.
      // What we want instead is to call "cleanup" when the component 
      //  is destroyed
      context.splice(context.indexOf(ref), 1);
    });
  });
  return <div ref={ref}><Slot/></div>;
});

The issue is that the cleanup gets called during serialization on the server, which releases the children from the parents. What we want instead is to call "cleanup" when the component is destroyed.
that

Describe the solution you'd like

Proposed solution

export const Child = compont$(( )=> {
  const ref = useSignal();
  const context = useContext(CHILDREN);

  // OPTION ONE
  useDestroyTask$(() => {
      context.splice(context.indexOf(ref), 1);
  });

  // OPTION TWO
  useTask$(({destroy$}) => {
      destroy$(() => {
        context.splice(context.indexOf(ref), 1);
      });
  });

  return <div ref={ref}><Slot/></div>;
});

Describe alternatives you've considered

HACK

export const Child = compont$(( )=> {
  const ref = useSignal();
  const context = useContext(CHILDREN);
  useTask$(() => {
    context.push(ref);
  });
  useVisibleTask$(({cleanup}) => {
    // HACK ❌ ❌ ❌ ❌ ❌ 
    cleanup({
      context.splice(context.indexOf(ref), 1);
    });
    },
    { strategy: 'document-idle' }
  );
  return <div ref={ref}><Slot/></div>;
});

Additional context

No response

@gioboa
Copy link
Member

gioboa commented Oct 14, 2024

We moved this issue to qwik-evolution repo to create a RFC discussion for this.
Here is our Qwik RFC process thanks.

@gioboa gioboa transferred this issue from QwikDev/qwik Oct 14, 2024
@github-project-automation github-project-automation bot moved this to In Progress (STAGE 2) in Qwik Evolution Oct 14, 2024
@github-actions github-actions bot added [STAGE-2] incomplete implementation Remove this label when implementation is complete [STAGE-2] not fully covered by tests yet Remove this label when tests are verified to cover the implementation [STAGE-2] unresolved discussions left Remove this label when all critical discussions are resolved on the issue [STAGE-3] docs changes not added yet Remove this label when the necessary documentation for the feature / change is added [STAGE-3] missing 2 reviews for RFC PRs Remove this label when at least 2 core team members reviewed and approved the RFC implementation labels Oct 14, 2024
@QwikDev QwikDev locked and limited conversation to collaborators Oct 14, 2024
@gioboa gioboa converted this issue into discussion #145 Oct 14, 2024
@github-project-automation github-project-automation bot moved this from In Progress (STAGE 2) to Released as Stable (STAGE 5) in Qwik Evolution Oct 14, 2024
@shairez shairez removed this from Qwik Evolution Oct 15, 2024

This issue was moved to a discussion.

You can continue the conversation there. Go to discussion →

Labels
[STAGE-2] incomplete implementation Remove this label when implementation is complete [STAGE-2] not fully covered by tests yet Remove this label when tests are verified to cover the implementation [STAGE-2] unresolved discussions left Remove this label when all critical discussions are resolved on the issue [STAGE-3] docs changes not added yet Remove this label when the necessary documentation for the feature / change is added [STAGE-3] missing 2 reviews for RFC PRs Remove this label when at least 2 core team members reviewed and approved the RFC implementation
Projects
None yet
Development

No branches or pull requests

2 participants