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

mman · 2024-06-17T21:24:01Z

New Issue Checklist

I am not disclosing a vulnerability.
I am not just asking a question.
I have searched through existing issues.
I can reproduce the issue with the latest versions of Parse Server and the Parse ObjC SDK.

Issue Description

Parse iOS / OSX SDK uses PFObject instances for basically everything. All subclasses of PFObject are represented in MongoDB/PostgreSQL as collections/tables with given names. Mapping of the PFObject subclasses and their names in MongoDB/PostreSQL need to be known to Parse SDK so that PFObject subclasses can be loaded/stored properly to the database.

Originally registration of all classes was needed to be done manually by invoking code like this after initialising the Parse SDK:

[PFInstallation registerSubclass];
[PFUser registerSublcass];
[PFSession registerSubclass];

Then came #967 that made things much simpler by scanning executable bundles (read frameworks) for all classes that are subclassing PFObject and registering them during SDK startup automatically.

The code is here:

Parse-SDK-iOS-OSX/Parse/Parse/Internal/Object/Subclassing/PFObjectSubclassingController.m

Lines 384 to 387 in c301262

    
           classNames = objc_copyClassNamesForImage(potentialPaths[i], &bundleClassCount); 
        
           if (bundleClassCount) { 
        
               break; 
        
           }

Building with Xcode 16 seems to break the functionality because objc_copyClassNamesForImage returns nothing.

More investigation is needed. I have not yet been able to see if this is a compiler option that needs to be toggled, or some new measure preventing apps from examining available runtime classes and their properties via Objective-C runtime reflection.

Steps to reproduce

Recompile your app with Xcode 16 and try to run against iOS 18. And see if that works for you.

It fails for me with unrelated error:

*** Terminating app due to uncaught exception 'NSInvalidArgumentException', reason: 'Invalid class name. Class names cannot start with an underscore.'

This is actually an exception coming from deep inside the Parse SDK where it tries to instantiate PFInstallation with collection name _Installation and failing because PFInstallation class was not registered.

Actual Outcome

Recompiling working code using Xcode 16 breaks the app.

Workaround

For the moment registering all required classes manually seems to work around the problem:

        Parse.initialize(
            with: ParseClientConfiguration() { config in
                
                config.applicationId = .apiAppIdString
                config.clientKey = .apiKeyString
                config.server = .apiURLString
                config.applicationGroupIdentifier = .appGroup
                config.networkRetryAttempts = 2

        })

        PFInstallation.registerSubclass()
        PFUser.registerSubclass()
        PFSession.registerSubclass()

Environment

Client

Parse ObjC SDK version: master

Server

Parse Server version: master

The text was updated successfully, but these errors were encountered:

parse-github-assistant · 2024-06-17T21:24:04Z

Thanks for opening this issue!

🚀 You can help us to fix this issue faster by opening a pull request with a failing test. See our Contribution Guide for how to make a pull request, or read our New Contributor's Guide if this is your first time contributing.

justasza · 2024-07-30T11:53:42Z

Im getting subclassing error with 4.1.1 version.
'The class PFPin must be registered with registerSubclass before using Parse.'
Could this be related?
Provided workaround would not work, because PFPin is internal.

rgomesbr · 2024-09-09T23:26:26Z

Same as @justasza here; running Xcode 16 RC — Version 16.0 (16A242)
"The class PFPin must be registered with registerSubclass before using Parse."

mtrezza · 2024-09-10T01:40:34Z

Bumping bounty given the impact of this issue. Anyone wants to take a look at this?

mapierce · 2024-09-18T10:10:32Z

Hey @mtrezza I believe my linked PR should solve the issue

mobinzk · 2024-09-19T18:37:47Z

Hey @mtrezza I believe my linked PR should solve the issue

I've tested your code and it did fix the issue for me. Looking forward to this get merged.

Satyam-Tripathi-89 · 2024-09-20T18:04:13Z

Please merge this PR asap.

Satyam-Tripathi-89 · 2024-09-21T02:38:39Z

The class PFPin must be registered with registerSubclass before using Parse.

I am getting this error. Is there any workaround for it?

dhoerl · 2024-09-25T13:24:57Z

A closed Issue had the information on how to get Xcode to run with the Parse Swift Package, but its not here in this thread.

Copying this from a closed Issue:
When adding Parse-SDK using Swift Package Manager use this commit d2b9580db7ce44d6d4d0f626d5e388901f81f5ed instead of the latest 4.1.1 version.

Also - you do not need any "registerSubClass()" statements - this commit is all you need.

mtrezza · 2024-09-25T22:56:08Z

The issue mentioned above is #1809 (comment).

toto · 2024-09-27T10:15:13Z

@dhoerl Note that this works for compiling for Simulator/Device in DEBUG it still breaks if SwiftUI Previews so something more is :/

dhoerl · 2024-09-27T12:03:46Z

I’m using it with Production and it’s fine.

KaitoKid · 2024-10-08T05:40:32Z

I've been able to verify that the commit hash mentioned by dhoerl does indeed work

mtrezza · 2024-10-08T10:40:13Z

Could someone try out #1811 whether it fixes the issue? Also for SwiftUI previews, @toto?

Using a commit hash won't help much in the long term. We have 2 PRs open in attempts to fix this:

fix: Automatic loading of PFObject subclasses not working on Xcode 16 #1808
fix: App crashes on launch and SwiftUI preview when built with Xcode 16 due to unregistered Parse subclasses #1811

Jaycyn · 2024-10-11T20:37:05Z

Just tried #1811 and it seems to work

I was able to remove all of the .registerSubclass() calls and the

The class PFPin must be registered with registerSubclass before using Parse

is not being thrown.

So the initialization called per the below code seems good.

override func viewDidLoad() {
    super.viewDidLoad()

    let parseConfig = ParseClientConfiguration {
        $0.applicationId = "parseApplicationId"
        $0.clientKey = "parseClientKey"
        $0.server = "http://somehost:1337/parse"
        $0.isLocalDatastoreEnabled = true
    }

    Parse.initialize(with: parseConfig)
}

XCode 16, macOS Sonoma.

mtrezza · 2024-10-12T07:47:31Z

Could @toto or someone else confirm that this also works for SwiftUI previews?

toto · 2024-10-13T14:21:25Z

@mtrezza I can confirm it #1811 also fixes the SwiftUI preview issue 👍

mtrezza · 2024-10-14T09:54:39Z

Great; I'll go ahead and merge

parseplatformorg · 2024-10-14T10:11:52Z

🎉 This change has been released in version 4.1.2

mtrezza added type:bug Impaired feature or lacking behavior that is likely assumed bounty:$20 Bounty applies for fixing this issue (Parse Bounty Program) labels Jun 20, 2024

mtrezza mentioned this issue Jun 28, 2024

Several files not found when including Parse using SPM on Xcode 16 #1793

Closed

mtrezza pinned this issue Jun 28, 2024

bmueller mentioned this issue Jul 13, 2024

fix: SPM build issues with Xcode 16 #1795

Merged

2 tasks

mtrezza added bounty:$50 Bounty applies for fixing this issue (Parse Bounty Program) and removed bounty:$20 Bounty applies for fixing this issue (Parse Bounty Program) labels Jul 26, 2024

mtrezza added bounty:$100 Bounty applies for fixing this issue (Parse Bounty Program) and removed bounty:$50 Bounty applies for fixing this issue (Parse Bounty Program) labels Sep 10, 2024

mapierce mentioned this issue Sep 17, 2024

fix: Automatic loading of PFObject subclasses not working on Xcode 16 #1808

Closed

2 tasks

dhoerl mentioned this issue Sep 23, 2024

Xcode 16 iOS 18 crashes on Parse initialization #1809

Closed

fysteven mentioned this issue Sep 25, 2024

fix: App crashes on launch and SwiftUI preview when built with Xcode 16 due to unregistered Parse subclasses #1811

Merged

4 tasks

mtrezza closed this as completed in #1811 Oct 14, 2024

parseplatformorg added the state:released Released as stable version label Oct 14, 2024

mtrezza unpinned this issue Oct 25, 2024

sjmckee mentioned this issue Nov 6, 2024

Automatic loading of PFObject subclasses does not work on Xcode 16 / iOS 18 parse-community/Parse-Swift#452

Open

4 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

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

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

mman commented Jun 17, 2024

parse-github-assistant bot commented Jun 17, 2024

justasza commented Jul 30, 2024

rgomesbr commented Sep 9, 2024

mtrezza commented Sep 10, 2024 •

edited

Loading

mapierce commented Sep 18, 2024

mobinzk commented Sep 19, 2024

Satyam-Tripathi-89 commented Sep 20, 2024

Satyam-Tripathi-89 commented Sep 21, 2024

dhoerl commented Sep 25, 2024

mtrezza commented Sep 25, 2024

toto commented Sep 27, 2024

dhoerl commented Sep 27, 2024

KaitoKid commented Oct 8, 2024

mtrezza commented Oct 8, 2024 •

edited

Loading

Jaycyn commented Oct 11, 2024 •

edited

Loading

mtrezza commented Oct 12, 2024 •

edited

Loading

toto commented Oct 13, 2024

mtrezza commented Oct 14, 2024

parseplatformorg commented Oct 14, 2024

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

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

Comments

mman commented Jun 17, 2024

New Issue Checklist

Issue Description

Steps to reproduce

Actual Outcome

Workaround

Environment

parse-github-assistant bot commented Jun 17, 2024

Thanks for opening this issue!

justasza commented Jul 30, 2024

rgomesbr commented Sep 9, 2024

mtrezza commented Sep 10, 2024 • edited Loading

mapierce commented Sep 18, 2024

mobinzk commented Sep 19, 2024

Satyam-Tripathi-89 commented Sep 20, 2024

Satyam-Tripathi-89 commented Sep 21, 2024

dhoerl commented Sep 25, 2024

mtrezza commented Sep 25, 2024

toto commented Sep 27, 2024

dhoerl commented Sep 27, 2024

KaitoKid commented Oct 8, 2024

mtrezza commented Oct 8, 2024 • edited Loading

Jaycyn commented Oct 11, 2024 • edited Loading

mtrezza commented Oct 12, 2024 • edited Loading

toto commented Oct 13, 2024

mtrezza commented Oct 14, 2024

parseplatformorg commented Oct 14, 2024

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

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

mtrezza commented Sep 10, 2024 •

edited

Loading

mtrezza commented Oct 8, 2024 •

edited

Loading

Jaycyn commented Oct 11, 2024 •

edited

Loading

mtrezza commented Oct 12, 2024 •

edited

Loading