[CB-1388] Add reset() to plugin API and fix callback collisions on all platforms

• Type: Bug
• Status: Closed
• Priority: Major
• Resolution: Fixed
• Affects Version/s: 2.0.0, 2.1.0, 2.2.0, 2.3.0, 2.4.0
• Fix Version/s: 2.8.0
• Component/s: cordova-bada (DEPRECATED), cordova-blackberry (DEPRECATED), cordova-js, cordova-qt (DEPRECATED), cordova-tizen (DEPRECATED), cordova-webos (DEPRECATED)
• Assignee: Braden Shepherdson
• Reporter: Braden Shepherdson
• Created: 07/Sep/12 14:08
• Updated: 27/Jun/14 19:16
• Resolved: 29/May/13 17:44

Description

There are three parts to this bug.

First, platform-specific: we should add a reset() function to the plugin API which is called on top-level navigation or refresh, so that plugins can know to cancel any long-running requests and reinitialize themselves. This won't be relevant to some platforms

Second, platform-independent: the callback IDs generated on the Javascript side should be randomized in some way to prevent collisions after navigation. Otherwise a request might get the ID "Service1", and before it has a chance to complete we navigate and a new request is made, also receiving "Service1". Then the first response comes back and the new Service1 callback is handed the old results.

Third, we should add a test for this to Mobile Spec, if possible. This is a tricky thing to reproduce reliably, unfortunately.

I'll tackle the second and third parts, and Android for the first part. It would be great if people who work on other platforms would add the reset() logic, or close the platform bugs if the platform is all-Javascript and fully reloaded on navigation.

Issue Links

• is related to: CB-1318 Cordova Callback Logic Not Implemented Correctly - Native Asynchronous Completion Can Call Wrong Logic in Javascript - Requires Non-recurring Unique ID as Outlined

Sub-Tasks

• Add reset() to plugin API on Android: Closed
• Add reset() to plugin API on iOS: Closed
• Add reset() to plugin API on Bada: Closed
• Add reset() to plugin API on Blackberry: Closed
• Add reset() to plugin API on Windows 8: Closed
• Add reset() to plugin API on WP7: Closed
• Add reset() (and other APIs) to Android Plugin documentation: Closed
• Add reset() to iOS Plugin documentation: Closed
• Add reset() (and other APIs) to BlackBerry Plugin documentation: Closed
• Add reset() (and other APIs) to Windows Phone Plugin documentation: Closed