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

Guard against Webkit's extraneous calls to xhr.onreadystatechange #633

Closed
wants to merge 1 commit into from

Conversation

@jsnuggle
Copy link
Contributor

@jsnuggle jsnuggle commented Nov 6, 2012

In certain cases Webkit will call the onreadystatechange method of a single XMLHttpRequest object multiple times indicating that it is ready (readyState == 4).

This results in Zepto's 'success' or 'error' methods being called multiple times for the same AJAX request.

This is documented in this thread:
http://stackoverflow.com/questions/12761255/can-xhr-trigger-onreadystatechange-multiple-times-with-readystate-done

with a jsfiddle here:
http://jsfiddle.net/44b3P/

and confirmed here:
http://osdir.com/ml/general/2012-10/msg12396.html

To reproduce in Zepto:

  1. visit http://jsfiddle.net/Rvk9j/1/ in Chrome (I'm using Chrome 22 for Mac)
  2. Open the debug console
  3. Click the 'Run' button
  4. When you reach the debugger statement, step forward (either click the Play button in Chrome's console or click F8) [1]

Expected: you should see 1 alert with the text 'error'

Actual: the alert with the text 'error' occurs 3 times

I'm working to find a way to reproduce this and submit upstream (at least to Chrome -- maybe to Webkit? -- We think it's a Webkit bug since we first observed this issue in Safari on iOS 6).

In the meantime this patch should resolve the issue in Zepto.

[1] While this is an awkward way to reproduce (clearly a debugger statement shouldn't be in production code) we've observed similar behavior in our production code where success functions are called multiple times for the same AJAX request -- usually when there's a lot going on on the page or the page hasn't completed loading.

The 'debugger' statement was the most reliable way I've seen to approximate these conditions and reproduce the behavior.

@mislav
Copy link
Collaborator

@mislav mislav commented Nov 7, 2012

I would be more motivated to accept a workaround for am obscure WebKit issue if it was filed in their issue tracker.

@jsnuggle
Copy link
Contributor Author

@jsnuggle jsnuggle commented Nov 7, 2012

I've filed a bug with Chorme based on the info I have:

http://code.google.com/p/chromium/issues/detail?id=159827

It references the Webkit reports I've found around the web.

Good luck with your project.

mislav added a commit that referenced this pull request Nov 13, 2012
The bug is present in Chrome 23.0.1271.64 and possibly iOS 6, and is
reproducible using the debugger but otherwise occurs randomly.

References #633

http://code.google.com/p/chromium/issues/detail?id=159827
@mislav
Copy link
Collaborator

@mislav mislav commented Nov 13, 2012

OK, I think I just seen the issue in the wild while using GitHub.com: an ajax callback got executed twice in jQuery.

Pulled your fix. Thanks!

@mislav mislav closed this Nov 13, 2012
@jsnuggle
Copy link
Contributor Author

@jsnuggle jsnuggle commented Nov 13, 2012

Great! Thanks a lot Mislav!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Linked issues

Successfully merging this pull request may close these issues.

None yet

2 participants