wxt-dev/wxt

`ctx.applyPatch`

Open

#1102 opened on Oct 22, 2024

View on GitHub
 (2 comments) (0 reactions) (0 assignees)TypeScript (9,861 stars) (511 forks)user submission
contribution welcomegood first issue

Description

Feature Request

Add a function that automatically patches all window functions in content scripts so any async callbacks are removed when context is invalidated.

Alternative is to pass the context around and call functions off that which can get quite annoying.

Is your feature request related to a bug?

N/A

Additional context

https://discord.com/channels/1212416027611365476/1297819470655520788/1297819470655520788

Contributor guide

Tech stack
typescript
Domain
frontenddeveloper experience
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
needs investigation
Prerequisites
TypeScriptWeb Extensions API
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
45
Research direction
Investigate how context invalidation is currently handled in wxt's content scripts. Look at the existing `ctx` object and any existing patching mechanisms. Review the linked Discord discussion for additional context. Then design a `ctx.applyPatch` function that automatically patches window functions (e.g., setTimeout, addEventListener) to remove async callbacks when the context is invalidated. Consider the alternative approach of passing context around and how this new function would simplify usage.