Added automatic PFObject subclass registration. #967

richardjrossiii · 2016-07-11T20:39:53Z

Older discussion visible here: #5

This is a breaking change.

What's new

Currently, every PFObject subclass must be registered with parse before it is used. This can create some hard-to-track-down issues if you're not aware of this, and it isn't exactly the cleanest API.

In Objective-C/Swift, it is relatively easy to search at run-time for subclasses of PFObject, and have them register with parse automatically (in the case of dynamic libraries, even as soon as they load from their bundles).

This should prevent needing your app delegate to have lots of extra lines of code related to simply registering all of your PFObject subclasses.

What's breaking

If you had a subclass of PFObject, which implemented PFSubclassing, but intentionally did not register it with parse (or only conditionally registered it with parse), then you may run into errors printed to the console and a crash on start. The error message in the console should be concrete enough to help you track down the issue.
- If you would still like to use the old-style manual registration (not recommended), you can opt-out on specific subclasses by conforming to the new protocol PFSubclassingSkipAutomaticRegistration.
If you remove your calls to [MySubclass registerSubclass] in AppDelegate or similar, and MySubclass is located in a not-yet loaded dynamic library/framework, then until you manually load that library (by using a class/method/function inside it), your subclass will not be registered.
- Note that this, however, allows for a much better potential plugin model using the Parse SDK using dlopen & friends, if your application needs such a feature.

These breaking changes shouldn't effect 99% of our users, and workarounds should be fairly simple for those it will break for.

Fixes #963
Closes #964

nlutsenko · 2016-07-11T21:34:25Z

Parse/Internal/Object/Subclassing/PFObjectSubclassingController.m

+    // Skipping a bundle. Not entirely sure of the best solution to that here.
+    if (shouldSubscribe) {
+        @weakify(self);
+        [[NSNotificationCenter defaultCenter] addObserverForName:NSBundleDidLoadNotification


From offline discussion:
Store the registration token in the ivar, validate that it's nil here to avoid double subscribe as well as clean up the registration in dealloc.

nlutsenko · 2016-07-12T21:05:31Z

Looks great, can't wait to see this feature!
Feel free to merge after the tests pass.

nlutsenko · 2016-07-12T22:50:27Z

Parse/Internal/Object/Subclassing/PFObjectSubclassingController.m

+
+        // There are two different paths that we will need to check for the bundle, depending on the platform.
+        // - First, we need to check the raw executable path fom the bundle.
+        //   This should be valid for most frameworks on OS X.


Nit: Not OSX, macOS.

This will scan all loaded code bundles for classes which inherit from `PFObject`, and register them upon Parse initialization. Still have opt-in support for manual-only registration, though it shouldn't be necessary for most cases.

levigroker · 2016-07-21T22:42:33Z

We're seeing this crash which appears to be related, but we don't have subclasses of PFObjects, so I'm not sure where to look or what to do except downgrade to 1.13. Any suggestions would be appreciated.

#0. Crashed: com.parse.object.subclassing
0  libsystem_c.dylib              0x1804ecfb8 strnlen + 24
1  libsystem_c.dylib              0x1804ee1fc strncpy + 40
2  libsystem_c.dylib              0x1804ee1fc strncpy + 40
3  ------------                   0x1003ca2dc __61-[PFObjectSubclassingController _registerSubclassesInBundle:]_block_invoke (PFObjectSubclassingController.m:355)
4  libdispatch.dylib              0x18048d47c _dispatch_client_callout + 16
5  libdispatch.dylib              0x180498728 _dispatch_barrier_sync_f_invoke + 100
6  ------------                   0x1003ca214 -[PFObjectSubclassingController _registerSubclassesInBundle:] (PFObjectSubclassingController.m:394)
7  ------------                   0x1003c8ca8 __63-[PFObjectSubclassingController scanForUnregisteredSubclasses:]_block_invoke (PFObjectSubclassingController.m:131)
8  Foundation                     0x18132d4c8 -[__NSObserver _doit:] + 308
9  CoreFoundation                 0x1809e4dfc __CFNOTIFICATIONCENTER_IS_CALLING_OUT_TO_AN_OBSERVER__ + 20
10 CoreFoundation                 0x1809e461c _CFXRegistrationPost + 396
11 CoreFoundation                 0x1809e439c ___CFXNotificationPost_block_invoke + 60
12 CoreFoundation                 0x180a4d414 -[_CFXNotificationRegistrar find:object:observer:enumerator:] + 1532
13 CoreFoundation                 0x1809226c8 _CFXNotificationPost + 368
14 Foundation                     0x181386a9c -[NSBundle loadAndReturnError:] + 2164
15 UIAccessibility                0x18b2f4528 -[NSBundleAccessibility loadAndReturnError:] + 52
16 Foundation                     0x181397a28 -[NSBundle principalClass] + 56
17 UIAccessibility                0x18b2f5190 +[UIAccessibilityLoader loadActualAccessibilityBundle:didLoad:loadSubbundles:] + 100
18 UIAccessibility                0x18b2f5514 +[UIAccessibilityLoader _loadAXBundleForBundle:didLoad:forceLoad:loadSubbundles:] + 460
19 UIAccessibility                0x18b2f56f0 __54+[UIAccessibilityLoader _accessibilityLoadSubbundles:]_block_invoke_2 + 36
20 libdispatch.dylib              0x18048d4bc _dispatch_call_block_and_release + 24
21 libdispatch.dylib              0x18048d47c _dispatch_client_callout + 16
22 libdispatch.dylib              0x180492b84 _dispatch_main_queue_callback_4CF + 1844
23 CoreFoundation                 0x1809f8d50 __CFRUNLOOP_IS_SERVICING_THE_MAIN_DISPATCH_QUEUE__ + 12
24 CoreFoundation                 0x1809f6bb8 __CFRunLoopRun + 1628
25 CoreFoundation                 0x180920c50 CFRunLoopRunSpecific + 384
26 GraphicsServices               0x182208088 GSEventRunModal + 180
27 UIKit                          0x185c0a088 UIApplicationMain + 204
28 ------------                   0x1002b86b8 main (main.m:16)
29 libdispatch.dylib              0x1804be8b8 (Missing)

nlutsenko · 2016-07-21T23:01:23Z

This should be fixed as of 1.14.2. Please update the SDK and comment here if it helped or if you are still running into an issue here.

levigroker · 2016-07-21T23:03:43Z

Thanks @nlutsenko. I don't see 1.14.2 on cocoapods yet... I just see 1.14.1. Can cocoapods be updated to 1.14.2 please?

nlutsenko · 2016-07-21T23:05:33Z

Please run 'pod repo update' to make sure you have the latest specs locally.
1.14.2 was pushed to CocoaPods a while ago.

levigroker · 2016-07-21T23:09:28Z

I was looking on cocoapods.org, and saw only 1.14.1, but now I see 1.14.2, so -shrug-. Many thanks for being responsive.

levigroker · 2016-07-23T17:36:55Z

Well, with 1.14.2 we are still seeing an issue, but so far only against iOS 10.0.0:

Fatal Exception: NSInternalInconsistencyException
0  CoreFoundation                 0x18ccd36f8 __exceptionPreprocess
1  libobjc.A.dylib                0x18c2cc578 objc_exception_throw
2  CoreFoundation                 0x18ccd3640 -[NSException initWithCoder:]
3  ------------                   0x1004121d4 -[PFObjectSubclassingController _registerSubclassesInBundle:] (PFObjectSubclassingController.m:344)
4  ------------                   0x100410cc4 __63-[PFObjectSubclassingController scanForUnregisteredSubclasses:]_block_invoke (PFObjectSubclassingController.m:131)
5  Foundation                     0x18d6495fc -[__NSObserver _doit:]
6  CoreFoundation                 0x18cc6e740 __CFNOTIFICATIONCENTER_IS_CALLING_OUT_TO_AN_OBSERVER__
7  CoreFoundation                 0x18cc6de44 _CFXRegistrationPost
8  CoreFoundation                 0x18cc6dbc0 ___CFXNotificationPost_block_invoke
9  CoreFoundation                 0x18ccdc0cc -[_CFXNotificationRegistrar find:object:observer:enumerator:]
10 CoreFoundation                 0x18cbb1484 _CFXNotificationPost
11 Foundation                     0x18d6a1da4 -[NSBundle loadAndReturnError:]
12 UIAccessibility                0x19924c49c -[NSBundleAccessibility loadAndReturnError:]
13 UIAccessibility                0x19924dc54 +[UIAccessibilityLoader __loadActualAccessibilityBundle:didLoadCallback:loadSubbundles:]
14 UIAccessibility                0x19924d374 +[UIAccessibilityLoader _loadAXBundleForBundle:didLoadCallback:forceLoad:loadSubbundles:loadAllAccessibilityInfo:]
15 UIAccessibility                0x19924e6d8 __54+[UIAccessibilityLoader _accessibilityLoadSubbundles:]_block_invoke_2
16 libdispatch.dylib              0x18c71d7c4 _dispatch_call_block_and_release
17 libdispatch.dylib              0x18c71d784 _dispatch_client_callout
18 libdispatch.dylib              0x18c722330 _dispatch_main_queue_callback_4CF
19 CoreFoundation                 0x18cc820cc __CFRUNLOOP_IS_SERVICING_THE_MAIN_DISPATCH_QUEUE__
20 CoreFoundation                 0x18cc7fcb8 __CFRunLoopRun
21 CoreFoundation                 0x18cbaf8d8 CFRunLoopRunSpecific
22 GraphicsServices               0x18e5b6198 GSEventRunModal
23 UIKit                          0x192b597c8 -[UIApplication _run]
24 UIKit                          0x192b54534 UIApplicationMain
25 ------------                   0x1003006d4 main (main.m:16)
26 libdispatch.dylib              0x18c7505b8 (Missing)

nlutsenko · 2016-07-25T20:16:27Z

@levigroker, just tested on iOS 10 and it works just fine on both Simulator and Device.
Any chance you can create a new issue and attach a sample project (and specify run destination) on where this problem happens.
Also, would be very helpful to know the bundle for which it fails to extract the executablePath.

levigroker · 2016-08-02T22:36:08Z

@nlutsenko Thanks... unfortunately this is happening in production and we're not able to reproduce it locally either. Perhaps the NSInternalInconsistencyException could report the offending bundle?

@levigroker

This will help track down the issue should this assert arrise. See @levigroker’s comments in parse-community#967

levigroker · 2016-08-03T22:24:58Z

#1000

zadr · 2016-08-25T22:56:40Z

I'm seeing reports this crash as well, on iOS 9 and iOS 10, also without being able to reproduce locally.

* parseOriginal: (211 commits) Parse 1.14.2 ☁️ (parse-community#988) Fixed crash when an NSBundle without executable is loaded (parse-community#981) Parse 1.14.1 ☁️ (parse-community#977) Fix not automatically registered subclasses of built-in subclasses of PFObject. (parse-community#976) Parse 1.14.0 ☁️ (parse-community#973) Update xctoolchain to latest. Improve code coverage for PFFileState. Update Carthage dependencies. Update gem dependencies. Update PFObjectState.m (parse-community#922) Added automatic PFObject subclass registration. (parse-community#967) Fix non-faulted task when loading installationId from persistence group fails. (parse-community#970) Remove no longer required bitcode flag for iOS. Update Travis-CI configuration to use macOS name. Update Rakefile to use macOS instead of OSX. Update all gems to latest. Update xctoolchain to latest. Update all xcode configurations to latest. Update Carthage dependencies. Update starter projects to use configuration-based initialization API. (parse-community#957) ...

levigroker · 2016-11-07T16:48:45Z

We are still seeing this issue consistently. I've filed #1068

@levigroker

This will help track down the issue should this assert arrise. See @levigroker’s comments in #967

richardjrossiii added the GH Review: review-needed label Jul 11, 2016

richardjrossiii assigned nlutsenko Jul 11, 2016

ghost added the CLA Signed label Jul 11, 2016

nlutsenko reviewed Jul 11, 2016
View reviewed changes

nlutsenko added GH Review: needs-revision and removed GH Review: review-needed labels Jul 11, 2016

nlutsenko assigned richardjrossiii and unassigned nlutsenko Jul 11, 2016

richardjrossiii mentioned this pull request Jul 11, 2016

Added automatic PFObject subclass registration. #5

Closed

nlutsenko added this to the 1.14.0 milestone Jul 12, 2016

richardjrossiii force-pushed the richardross.subclassing.autoreg branch from 11111a0 to a491c1e Compare July 12, 2016 20:12

ghost added GH Review: review-needed and removed GH Review: needs-revision labels Jul 12, 2016

richardjrossiii assigned nlutsenko and unassigned richardjrossiii Jul 12, 2016

ghost added the CLA Signed label Jul 12, 2016

nlutsenko added GH Review: accepted and removed GH Review: review-needed labels Jul 12, 2016

nlutsenko assigned richardjrossiii and unassigned nlutsenko Jul 12, 2016

richardjrossiii force-pushed the richardross.subclassing.autoreg branch from a491c1e to 645b29e Compare July 12, 2016 22:40

nlutsenko reviewed Jul 12, 2016
View reviewed changes

Added automatic PFObject subclass registration.

e9a4e59

This will scan all loaded code bundles for classes which inherit from `PFObject`, and register them upon Parse initialization. Still have opt-in support for manual-only registration, though it shouldn't be necessary for most cases.

richardjrossiii force-pushed the richardross.subclassing.autoreg branch from 645b29e to e9a4e59 Compare July 12, 2016 22:55

richardjrossiii merged commit b5beb7c into master Jul 13, 2016

richardjrossiii deleted the richardross.subclassing.autoreg branch July 13, 2016 00:45

levigroker added a commit to levigroker/Parse-SDK-iOS-OSX that referenced this pull request Aug 3, 2016

Outputing offending bundle in assert message.

166646a

This will help track down the issue should this assert arrise. See @levigroker’s comments in parse-community#967

levigroker mentioned this pull request Aug 3, 2016

Outputing offending bundle in assert message. #1000

Merged

levigroker mentioned this pull request Nov 7, 2016

NSInternalInconsistencyException in PFObjectSubclassingController _registerSubclassesInBundle: #1068

Closed

flovilmart pushed a commit that referenced this pull request Jun 19, 2017

Outputing offending bundle in assert message. (#1000)

f575202

This will help track down the issue should this assert arrise. See @levigroker’s comments in #967

mman mentioned this pull request Jun 17, 2024

Automatic loading of PFObject subclasses does not work on Xcode 16 / iOS 18 #1792

Closed

4 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

Added automatic PFObject subclass registration. #967

Added automatic PFObject subclass registration. #967

Uh oh!

richardjrossiii commented Jul 11, 2016 •

edited by nlutsenko

Loading

Uh oh!

nlutsenko Jul 11, 2016

Uh oh!

nlutsenko commented Jul 12, 2016

Uh oh!

nlutsenko Jul 12, 2016

Uh oh!

levigroker commented Jul 21, 2016 •

edited

Loading

Uh oh!

nlutsenko commented Jul 21, 2016

Uh oh!

levigroker commented Jul 21, 2016

Uh oh!

nlutsenko commented Jul 21, 2016

Uh oh!

levigroker commented Jul 21, 2016 •

edited

Loading

Uh oh!

levigroker commented Jul 23, 2016

Uh oh!

nlutsenko commented Jul 25, 2016

Uh oh!

levigroker commented Aug 2, 2016

Uh oh!

levigroker commented Aug 3, 2016

Uh oh!

zadr commented Aug 25, 2016 •

edited

Loading

Uh oh!

levigroker commented Nov 7, 2016

Uh oh!

Uh oh!

Uh oh!

Added automatic PFObject subclass registration. #967

Added automatic PFObject subclass registration. #967

Uh oh!

Conversation

richardjrossiii commented Jul 11, 2016 • edited by nlutsenko Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

This is a breaking change.

What's new

What's breaking

Uh oh!

nlutsenko Jul 11, 2016

Choose a reason for hiding this comment

Uh oh!

nlutsenko commented Jul 12, 2016

Uh oh!

nlutsenko Jul 12, 2016

Choose a reason for hiding this comment

Uh oh!

levigroker commented Jul 21, 2016 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

nlutsenko commented Jul 21, 2016

Uh oh!

levigroker commented Jul 21, 2016

Uh oh!

nlutsenko commented Jul 21, 2016

Uh oh!

levigroker commented Jul 21, 2016 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

levigroker commented Jul 23, 2016

Uh oh!

nlutsenko commented Jul 25, 2016

Uh oh!

levigroker commented Aug 2, 2016

Uh oh!

levigroker commented Aug 3, 2016

Uh oh!

zadr commented Aug 25, 2016 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

levigroker commented Nov 7, 2016

Uh oh!

Uh oh!

richardjrossiii commented Jul 11, 2016 •

edited by nlutsenko

Loading

levigroker commented Jul 21, 2016 •

edited

Loading

levigroker commented Jul 21, 2016 •

edited

Loading

zadr commented Aug 25, 2016 •

edited

Loading