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.

Sign up for GitHub

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

Jump to bottom

Use jQuery.Deferred.getErrorHook in 3.7.0, deprecate jQuery.Deferred.getStackHook #5201

Closed
mgol opened this issue Feb 1, 2023 · 6 comments · Fixed by #5211
Closed

Use jQuery.Deferred.getErrorHook in 3.7.0, deprecate jQuery.Deferred.getStackHook #5201

mgol opened this issue Feb 1, 2023 · 6 comments · Fixed by #5211
Assignees
@mgol @AnuragMishraa
Labels
Ajax Blocker
Milestone
3.7.0

Comments

@mgol
Copy link
Member

mgol commented Feb 1, 2023

Description

See #5192 (comment) for context:

From @mgol: I wonder about the name of this argument [stack - add. mine]. The idea was to fill it in via https://github.com/dmethvin/jquery-deferred-reporter or something equivalent but that would hit the same issue with unmapped source maps for that additional stack. Should we assume that we should also pass a full error object here instead?

Since we should now encourage passing the whole error object and not just the stack trace, @dmethvin suggested deprecating jQuery.Deferred.getStackHook and using jQuery.Deferred.getErrorHook. Note that nothing prevents people from sending a stack trace to this new API as well, it's just that our recommendation for what's the best course of action changes.

Link to test case
@mgol mgol added this to the 3.7.0 milestone Feb 1, 2023
@mgol mgol self-assigned this Feb 1, 2023
@mgol mgol mentioned this issue Feb 1, 2023
Merged
3 tasks
@mgol
Copy link
Member Author

mgol commented Feb 13, 2023

API issue: jquery/api.jquery.com#1221

mgol added a commit to mgol/jquery that referenced this issue Feb 15, 2023
@mgol
Deferred: Rename getStackHook to getErrorHook
da4c55b 
Rename `jQuery.Deferred.getStackHook` to `jQuery.Deferred.getErrorHook`
to indicate passing an error instance is usually a better choice - it
works with source maps while a raw stack generally does not.

In jQuery `3.7.0`, we'll keep both names, marking the old one as
deprecated. In jQuery `4.0.0` we'll just keep the new one. This
change implements the `4.0.0` version.

Fixes jquerygh-5201
mgol added a commit to mgol/jquery that referenced this issue Feb 15, 2023
@mgol
Deferred: Rename getStackHook to getErrorHook
dc2f3cf 
Rename `jQuery.Deferred.getStackHook` to `jQuery.Deferred.getErrorHook`
to indicate passing an error instance is usually a better choice - it
works with source maps while a raw stack generally does not.

In jQuery `3.7.0`, we'll keep both names, marking the old one as
deprecated. In jQuery `4.0.0` we'll just keep the new one. This
change implements the `3.7.0` version.

Fixes jquerygh-5201
This was referenced Feb 15, 2023
Merged
Merged
mgol added a commit to mgol/jquery that referenced this issue Feb 15, 2023
@mgol
Deferred: Rename getStackHook to getErrorHook
8522221 
Rename `jQuery.Deferred.getStackHook` to `jQuery.Deferred.getErrorHook`
to indicate passing an error instance is usually a better choice - it
works with source maps while a raw stack generally does not.

In jQuery `3.7.0`, we'll keep both names, marking the old one as
deprecated. In jQuery `4.0.0` we'll just keep the new one. This
change implements the `3.7.0` version; PR jquerygh-5211 implements
the `4.0.0` one.

Fixes jquerygh-5201
Closes jquerygh-5212
Ref jquerygh-5211
mgol added a commit to mgol/jquery that referenced this issue Feb 15, 2023
@mgol
Deferred: Rename getStackHook to getErrorHook
e731d37 
Rename `jQuery.Deferred.getStackHook` to `jQuery.Deferred.getErrorHook`
to indicate passing an error instance is usually a better choice - it
works with source maps while a raw stack generally does not.

In jQuery `3.7.0`, we'll keep both names, marking the old one as
deprecated. In jQuery `4.0.0` we'll just keep the new one. This
change implements the `4.0.0` version; PR jquerygh-5212 implements
the `3.7.0` one.

Fixes jquerygh-5201
Closes jquerygh-5211
Ref jquerygh-5212
@mgol
Copy link
Member Author

mgol commented Feb 15, 2023

PRs:

@mgol mgol mentioned this issue Feb 21, 2023
Closed
@mgol
Copy link
Member Author

mgol commented Feb 21, 2023

Issues:

@AnuragMishraa
Copy link

Can I take this issue, I am interested to work on this.

There are two issues related to this change. One is in the jquery-migrate library and suggests filling and warning against the use of jQuery.Deferred.getStackHook.
The other issue is in the API documentation and proposes documenting jQuery.Deferred.getErrorHook and jQuery.Deferred.getStackHook.

@mgol
Copy link
Member Author

mgol commented Mar 2, 2023

@AnuragMishraa Sure, feel free to submit PRs. I assigned you to this issue in addition to me. I thought only people with write access to the repo can be assigned but it worked here. For some reason, I cannot do the same in the Migrate & API issue but we can track it here.

Let me know if you have any questions!

@mgol
Copy link
Member Author

mgol commented Mar 13, 2023

@AnuragMishraa are you still interested in working on this?

mgol added a commit to mgol/jquery that referenced this issue Mar 14, 2023
@mgol
Deferred: Rename getStackHook to getErrorHook
5afddad 
Rename `jQuery.Deferred.getStackHook` to `jQuery.Deferred.getErrorHook`
to indicate passing an error instance is usually a better choice - it
works with source maps while a raw stack generally does not.

In jQuery `3.7.0`, we'll keep both names, marking the old one as
deprecated. In jQuery `4.0.0` we'll just keep the new one. This
change implements the `4.0.0` version; PR jquerygh-5212 implements
the `3.7.0` one.

Fixes jquerygh-5201
Closes jquerygh-5211
Ref jquerygh-5212
mgol added a commit to mgol/jquery that referenced this issue Mar 14, 2023
@mgol
Deferred: Rename getStackHook to getErrorHook
bc19320 
Rename `jQuery.Deferred.getStackHook` to `jQuery.Deferred.getErrorHook`
to indicate passing an error instance is usually a better choice - it
works with source maps while a raw stack generally does not.

In jQuery `3.7.0`, we'll keep both names, marking the old one as
deprecated. In jQuery `4.0.0` we'll just keep the new one. This
change implements the `3.7.0` version; PR jquerygh-5211 implements
the `4.0.0` one.

Fixes jquerygh-5201
Closes jquerygh-5212
Ref jquerygh-5211
mgol added a commit that referenced this issue Mar 14, 2023
@mgol
Deferred: Rename getStackHook to getErrorHook
258ca1e 
Rename `jQuery.Deferred.getStackHook` to `jQuery.Deferred.getErrorHook`
to indicate passing an error instance is usually a better choice - it
works with source maps while a raw stack generally does not.

In jQuery `3.7.0`, we'll keep both names, marking the old one as
deprecated. In jQuery `4.0.0` we'll just keep the new one. This
change implements the `4.0.0` version; PR gh-5212 implements
the `3.7.0` one.

Fixes gh-5201
Closes gh-5211
Ref gh-5212
mgol added a commit that referenced this issue Mar 14, 2023
@mgol
Deferred: Rename getStackHook to getErrorHook (3.x version)
cca7118 
Rename `jQuery.Deferred.getStackHook` to `jQuery.Deferred.getErrorHook`
to indicate passing an error instance is usually a better choice - it
works with source maps while a raw stack generally does not.

In jQuery `3.7.0`, we'll keep both names, marking the old one as
deprecated. In jQuery `4.0.0` we'll just keep the new one. This
change implements the `3.7.0` version; PR gh-5211 implements
the `4.0.0` one.

Fixes gh-5201
Closes gh-5212
Ref gh-5211
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@mgol mgol

@AnuragMishraa AnuragMishraa

Labels
Ajax Blocker
Milestone
3.7.0
Development

Successfully merging a pull request may close this issue.

Deferred: Rename getStackHook to getErrorHook mgol/jquery
2 participants
@mgol @AnuragMishraa