iAP transport disconnect cleanup #1248

NicoleYarroch · 2019-04-24T19:14:31Z

Fixes #1239, #1261, #1263, #1268

This PR is ready for review.

Risk

This PR makes minor API changes.

Testing Plan

Unit Tests

Added test cases for SDLIAPDataSession class
Added test cases for SDLIAPControlSession class
Fixed test cases in the SDLIAPTransport class

Smoke Testing

Smoked tested multisession protocol (data session only) by connecting/disconnecting USB cord.
Smoked tested multisession protocol (data session only) by switching between USB and BT transports.
Smoked tested control session + data session by connecting/disconnecting USB cord.
Smoked tested control session + data session by switching between USB and BT transports.

Summary

Fixed accessory not being registered after the USB cord was pulled during the retry delay.
Fixed switching between transports after a control session was established not working.
Separated the data session and control session logic into their own classes.
Fixed a session setup race condition if a stream errors when accessory disconnects. This was an issue when switching between BT and USB transports.

Changelog

Breaking Changes

none

Bug Fixes

Fixed accessory not being registered after the USB cord was pulled during the retry delay.

Tasks Remaining:

Smoke testing

CLA

I have signed the CLA

* Separated out control session logic in SDLIAPTransport into the SDLIAPControlSession class * Added test cases for the SDLIAPControlSession class

Fixed switching transports between USB and BT not working if a control session was opened before the data session.

joeljfischer · 2019-05-03T14:58:22Z

@NicoleYarroch This has some merge conflicts

SmartDeviceLink/SDLIAPControlSession.h

SmartDeviceLink/SDLIAPTransport.m

SmartDeviceLink/SDLIAPControlSession.h

SmartDeviceLinkTests/TransportSpecs/iAP/SDLIAPControlSessionSpec.m

* fixed test cases

* Fixed test cases

Added more SDL logs for debugging start session timeouts

…onnect_cleanup

Example Apps/Example ObjC/ProxyManager.m

joeljfischer · 2019-05-30T20:35:10Z

SmartDeviceLink/SDLIAPControlSession.m

+
+    __weak typeof(self) weakSelf = self;
+    void (^elapsedBlock)(void) = ^{
+        __strong typeof(weakSelf) strongSelf = weakSelf;


The protocolIndexTimer should call a selector, not a block. The contents of the block should be moved to a selector, and the index timer updated to call the selector.

Do you know why the SDLTimer class exists? There is no documentation for that class?

It was originally created to make creating and managing an NSTimer's lifecycle easier. It may not be necessary anymore.

I think changing/removing the SDLTimer should be a separate PR as the library has had issues with the timer crashing the app in the past. Any changes would need to be extensively smoked tested.

That's very true

SmartDeviceLink/SDLIAPControlSession.m

SmartDeviceLink/SDLIAPDataSession.m

SmartDeviceLink/SDLIAPTransport.m

Refactored the stream errored on write in data session class

Fixed SDL log spelling Co-Authored-By: Joel Fischer <joeljfischer@gmail.com>

Refactored the create session methods in iAPTransport class

…' of https://github.com/smartdevicelink/sdl_ios into bugfix/issue_1239_iAPTransport_class_disconnect_cleanup # Conflicts: # SmartDeviceLink/SDLIAPTransport.m

NicoleYarroch added 17 commits April 16, 2019 17:02

Separated control session logic in SDLIAPTransport

1810336

* Separated out control session logic in SDLIAPTransport into the SDLIAPControlSession class * Added test cases for the SDLIAPControlSession class

Separated data session logic in SDLIAPTransport

db35421

Fixed control/data sessions not reconnecting

ad88685

Added documentation to SDLIAPTransport class

0c493c0

Fixed broken BT/USB transport switch check

c26231c

Fixed test cases for SDLIAPControlSession class

e06733f

Fixed protocol timer constant

f77bd71

Refactoring SDLIAPTransport code

87247ba

Renamed connectionID from accessoryID

c678c24

Fixed SDLIAPTransport test cases

4adb933

Added documentation to SDLIAPTransport

f0ba35d

Fixed handler formatting in SDLIAPTransport classes

dc68fbb

Added SDLIAPDataSession test cases

c90704d

Finished up SDLIAPDataSession test cases

bd0058e

Refactored session init in SDLIAPTransport

d39b773

Added documentation to SDLIAPTransport handlers

73c7aee

Fixed USB/BT not working if control session opened

d523cea

Fixed switching transports between USB and BT not working if a control session was opened before the data session.

NicoleYarroch self-assigned this Apr 24, 2019

NicoleYarroch added the bug A defect in the library label Apr 24, 2019

Keep background task alive

b930586

NicoleYarroch changed the title ~~WIP: iAP transport disconnect cleanup~~ iAP transport disconnect cleanup Apr 25, 2019

NicoleYarroch changed the base branch from master to develop April 25, 2019 20:37

NicoleYarroch requested a review from joeljfischer April 25, 2019 20:37

NicoleYarroch added this to In progress in v6.3 via automation Apr 25, 2019

NicoleYarroch moved this from In progress to Review in progress in v6.3 Apr 25, 2019

joeljfischer suggested changes May 3, 2019

View reviewed changes

NicoleYarroch mentioned this pull request May 9, 2019

IAPTransport class stops observing accessory notifications incorrectly #1239

Closed

NicoleYarroch added 2 commits May 13, 2019 14:55

Added delegate for control session

3815bfe

* fixed test cases

Added delegate for data session

70d0658

* Fixed test cases

NicoleYarroch added 9 commits May 29, 2019 11:27

Renamed data session connected delegate method

237d52a

Renamed data session delegate data received method

6c4bf0d

Examples apps restarted if the manager still exists

71b807f

Fixed spelling, SDL logs

0047bf7

Added more SDL logs

2e12a55

Added more SDL logs for debugging start session timeouts

Cleaned up the data session’s write to output stream

580320b

Merge branch 'develop' into bugfix/issue_1239_iAPTransport_class_disc…

6950fd9

…onnect_cleanup

Added SDL log for debugging output stream writes

3779a2b

Cleaned up the IAP classes private methods

6e83a56

joeljfischer suggested changes May 31, 2019

View reviewed changes

NicoleYarroch and others added 10 commits May 31, 2019 11:26

Refactored example app starting manager methods

ff55c38

Renamed control session timeout timer methods

f8534bd

Refactored stream errored on write in data session

8b68e7b

Refactored the stream errored on write in data session class

Update SmartDeviceLink/SDLIAPTransport.m

12ee2a0

Fixed SDL log spelling Co-Authored-By: Joel Fischer <joeljfischer@gmail.com>

Refactored the create session methods

9961a28

Refactored the create session methods in iAPTransport class

Renamed transportDisconnected var

bde8a7d

Merge branch 'bugfix/issue_1239_iAPTransport_class_disconnect_cleanup…

74c5aba

…' of https://github.com/smartdevicelink/sdl_ios into bugfix/issue_1239_iAPTransport_class_disconnect_cleanup # Conflicts: # SmartDeviceLink/SDLIAPTransport.m

Fixed compile error

335ca76

Removed unused var

e31c41e

Refactored protocol string check

fc10172

joeljfischer approved these changes Jun 4, 2019

View reviewed changes

v6.3 automation moved this from Review in progress to Reviewer approved Jun 4, 2019

joeljfischer merged commit e16e360 into develop Jun 4, 2019

v6.3 automation moved this from Reviewer approved to Done Jun 4, 2019

joeljfischer deleted the bugfix/issue_1239_iAPTransport_class_disconnect_cleanup branch June 4, 2019 18:57

This was referenced Jun 5, 2019

Example apps crash if the stop method is called when the lifecycle manager errors #1268

Closed

iAP Bluetooth Connectivity Drops #1261

Closed

There is a session setup race condition if the data stream errors during shutdown #1263

Closed

This was referenced Jun 19, 2019

SDLStreamingMediaManager is not stopped after transport disconnect #1310

Closed

EAAccessory event is not notified after SDLIAPTransport dealloc #1311

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

iAP transport disconnect cleanup #1248

iAP transport disconnect cleanup #1248

NicoleYarroch commented Apr 24, 2019 •

edited by theresalech

joeljfischer commented May 3, 2019

joeljfischer May 30, 2019

NicoleYarroch Jun 4, 2019

joeljfischer Jun 4, 2019

NicoleYarroch Jun 4, 2019

joeljfischer Jun 4, 2019

iAP transport disconnect cleanup #1248

iAP transport disconnect cleanup #1248

Conversation

NicoleYarroch commented Apr 24, 2019 • edited by theresalech

Risk

Testing Plan

Unit Tests

Smoke Testing

Summary

Changelog

Breaking Changes

Bug Fixes

Tasks Remaining:

CLA

joeljfischer commented May 3, 2019

joeljfischer May 30, 2019

Choose a reason for hiding this comment

NicoleYarroch Jun 4, 2019

Choose a reason for hiding this comment

joeljfischer Jun 4, 2019

Choose a reason for hiding this comment

NicoleYarroch Jun 4, 2019

Choose a reason for hiding this comment

joeljfischer Jun 4, 2019

Choose a reason for hiding this comment

NicoleYarroch commented Apr 24, 2019 •

edited by theresalech