Move `xcdatamodeld` into WordPressData #24166

mokagio · 2025-03-07T07:25:46Z

Note

As I try to move more model files, I keep pulling at the intricate dependencies that grew in the codebase.
I'll be leaving comments in the diff as starting point for code to extract in order to enable this PR.

Note

Work in Progress. So far:

Moved the xcdatamodeld folder into the module and updated the code that referenced its URL to read it from the module
Run the app and saw it crash because it could not load BloggingPrompt (apparently the first model to load at runtime). The error was with Fatal error: NSArray element failed to match the Swift Array Element type . Expected BloggingPrompt got NSManagedObject.
Moved BloggingPrompt to WordPressData
App still crashed with Fatal error: NSArray element failed to match the Swift Array Element type . Expected BloggingPrompt got NSManagedObject
The only way I found to fix this was to hardcode the module name in the BloggingPrompt definition in the Core Data schema GUI

I don't like this solution because it would require editing the schema for each model. Besides, the compiler (or whichever piece is involved in going from the schema to the binary) should be able to inject the correct module name without hardcoding.

Leaving this up as a draft so that others can look at it.

The next thing I'll try will be to move more of the components involved in making the Core Data fetch request, the NSManagedObjectContext in particular, and see if it gets the namespace resolution to work without hardcoding.

Fixes #

To test:

Regression Notes

Potential unintended areas of impact
What I did to test those areas of impact (or what existing automated tests I relied on)
What automated tests I added (or what prevented me from doing so)

PR submission checklist:

I have completed the Regression Notes.
I have considered adding unit tests for my changes.
I have considered adding accessibility improvements for my changes.
I have considered if this change warrants user-facing release notes and have added them to RELEASE-NOTES.txt if necessary.

Testing checklist:

dangermattic · 2025-03-07T07:26:23Z

	3 Warnings
⚠️	`Modules/Package.swift` was changed without updating its corresponding `Package.resolved`. Please resolve the Swift packages as appropriate to your project setup (e.g. in Xcode or by running `swift package resolve`).
⚠️	View files have been modified, but no screenshot or video is included in the pull request. Consider adding some for clarity.
⚠️	This PR is larger than 500 lines of changes. Please consider splitting it into smaller PRs for easier and faster reviews.

	1 Message
📖	This PR is still a Draft: some checks will be skipped.

Generated by 🚫 Danger

mokagio · 2025-03-07T07:28:30Z

Modules/Sources/WordPressData/WordPress.xcdatamodeld/WordPress 154.xcdatamodel/contents

-    <entity name="BloggingPrompt" representedClassName=".BloggingPrompt" syncable="YES">
+    <entity name="BloggingPrompt" representedClassName="WordPressData.BloggingPrompt" syncable="YES">


Before

After

mokagio · 2025-03-07T07:30:56Z

Modules/Sources/WordPressData/WordPressData.swift

+public let modelURL: URL = {
+    guard let url = Bundle.module.url(forResource: "WordPress", withExtension: "momd") else {
+        fatalError("Cannot find model file.")
+    }
+    return url
+}()
+
+public func urlForModel(name: String, in directory: String?) -> URL? {
+    let bundle = Bundle(for: TemporaryDummyClassToPickUpModule.self)
+    var url = bundle.url(forResource: name, withExtension: "mom", subdirectory: directory)
+
+    if url != nil {
+        return url
+    }
+
+    let momdPaths = bundle.paths(forResourcesOfType: "momd", inDirectory: directory)
+    momdPaths.forEach { (path) in
+        if url != nil {
+            return
+        }
+        url = bundle.url(forResource: name, withExtension: "mom", subdirectory: URL(fileURLWithPath: path).lastPathComponent)
+    }
+
+    return url
+}


These free functions should go into an object at some point.

It was just simpler to chuck them in here at this stage while I figure things out.

Also, I'd like to think there will be no need to have them public once all the types involved in setting up the Core Data stack have been moved.

wpmobilebot · 2025-03-07T07:39:09Z

📲 You can test the changes from this Pull Request in Jetpack Alpha by scanning the QR code below to install the corresponding build.

	App Name	Jetpack Alpha
	Configuration	Release-Alpha
	Build Number	pr24166-43bb76a
	Version	25.8
	Bundle ID	com.jetpack.alpha
	Commit	`43bb76a`
	App Center Build	jetpack-installable-builds #10655

Automatticians: You can use our internal self-serve MC tool to give yourself access to App Center if needed.

wpmobilebot · 2025-03-07T07:39:38Z

📲 You can test the changes from this Pull Request in WordPress Alpha by scanning the QR code below to install the corresponding build.

	App Name	WordPress Alpha
	Configuration	Release-Alpha
	Build Number	pr24166-43bb76a
	Version	25.8
	Bundle ID	org.wordpress.alpha
	Commit	`43bb76a`
	App Center Build	WPiOS - One-Offs #11624

Automatticians: You can use our internal self-serve MC tool to give yourself access to App Center if needed.

kean · 2025-03-07T15:15:15Z

Have you tried overriding an Objective-C class name for the managed objects written in Swift?

[@objc](BloggingPrompt)
class BloggingPrompt: NSManagedObject {

mokagio · 2025-03-10T21:12:01Z

Have you tried overriding an Objective-C class name for the managed objects written in Swift?
[@objc](BloggingPrompt)
class BloggingPrompt: NSManagedObject {

@kean yes I did try that. I removed it from the code pushed here because it did not make any difference

This is so the diff is neater next when moving it to WordPressShared

Turned out there needed to be move access control changes than those done in the previous commit...

We'll obviously have to deal with this at some point, but doing it while moving the files from the app targets to the new module is not the right time.

Swift-ier + Saves making `sharedInstance()` public when migrating

Not the best approach, but fine because the property is for testing only.

Currently unused, but we'll use them soon when moving more of the Objective-C models.

…odeld-to-wordpressdata

All those Swift files compile without importing UIKit because `SFHFKeychainUtils.h` did that for them and they got access to it via the bridging header. Next, we'll move SFHFKeychainUtils into the modules, and UIKit will no longer be available through it. Side note: UIKit should not have been available via SFHFKeychainUtils in the first place. On top of that, SFHFKeychainUtils does not need UIKit either.

We need it in a dedicated package because the Objective-C implementation does not use ARC. Therefore, we need to use the `-fno-objc-arc` compiler setting. But such a setting should be applied sparingly so instead of blanket using it in an existing Objective-C package like WordPressSharedObjC, we use it surgically just for this file.

This is to decouple the Objective-C implementation from knowing about components (i.e. `ContextManager`) in the Swift layer.

To much Objective-C code using logic implemented elsewhere in Swift for us to be able to move the files in two separate Objective-C- and Swift- only packages. Refer to #24166 as an experiment for this that shows the various build failure that even a partial attempt at moving some files results in.

mokagio · 2025-03-19T00:08:58Z

Closing in favor of #24242

To much Objective-C code using logic implemented elsewhere in Swift for us to be able to move the files in two separate Objective-C- and Swift- only packages. Refer to #24166 as an experiment for this that shows the various build failure that even a partial attempt at moving some files results in.

mokagio commented Mar 7, 2025

View reviewed changes

mokagio mentioned this pull request Mar 7, 2025

Move +classNameWithoutNamespaces to WordPressSharedObjC #24164

Merged

mokagio force-pushed the mokagio/share-classNameWithoutNamespaces branch from 81890b9 to 57a9e60 Compare March 7, 2025 20:56

Base automatically changed from mokagio/share-classNameWithoutNamespaces to trunk March 7, 2025 21:51

mokagio added 4 commits March 11, 2025 11:29

Extract definition for Bundle where DB lives

ce71dcd

App crashes – Move WordPress.xcdatamodeld to WordPressData

ea82feb

App crashes – Move BloggingPrompt to WordPressData

54d3150

Hardcode module name in BloggingPrompt model – Fixes the crash?!

e1eb0b3

mokagio force-pushed the mokagio/move-xcdatamodeld-to-wordpressdata branch from b94d69d to e1eb0b3 Compare March 11, 2025 00:42

mokagio added 2 commits March 11, 2025 11:53

Move NSManagedObject+Lookup to WordPressData

43bb76a

Add CocoaLumberjack to WordPressData as a dependency

038d840

mokagio mentioned this pull request Mar 11, 2025

Move AsyncOperation and AsyncBlockOperation to WordPressShared #24185

Merged

mokagio added 12 commits March 11, 2025 15:58

Make AsyncOperation and AsyncBlockOperation public

f592cc1

This is so the diff is neater next when moving it to WordPressShared

Move AsyncOperation and AsyncBlockOperation to WordPressShared

916a7c6

Turned out there needed to be move access control changes than those done in the previous commit...

Use Swift 5 in WordPressData to avoid having to support Sendable ATM

6cc4f5b

We'll obviously have to deal with this at some point, but doing it while moving the files from the app targets to the new module is not the right time.

WIP – Move ContextManager and all it needs to compile to WordPressData

3b54959

Swift 5 in WordPressData tests

029f0e0

Replace a couple of sharedInstance() calls to shared

78608b4

Swift-ier + Saves making `sharedInstance()` public when migrating

Fix overrideInstance testing property concurrency issue

f73d016

Not the best approach, but fine because the property is for testing only.

Make WordPressDataObj depend on CocoaLumberJack and WordPressShared

0753eea

Currently unused, but we'll use them soon when moving more of the Objective-C models.

WIP - Move various ObjC model - BUT NOTICE THE COMMENTED OUT CODE!!!

075560a

WIP - Move more files - Build is broken

48f0802

Make entityName() open to see if compilation error goes away...

7275ae3

Delete leftover versions of some of the files moved

b0517a3

mokagio force-pushed the mokagio/move-xcdatamodeld-to-wordpressdata branch from 58f69c3 to b0517a3 Compare March 11, 2025 10:07

mokagio mentioned this pull request Mar 12, 2025

Abstract ContextManager usages behind CoreDataStack #24191

Draft

mokagio added 8 commits March 12, 2025 14:53

Merge remote-tracking branch 'origin/trunk' into mokagio/move-xcdatam…

52fd530

…odeld-to-wordpressdata

Remove duplicated CoreDataStackMock class

b86a99c

Declare a sharedInstance in CoreDataStack

2f70b94

This is to decouple the Objective-C implementation from knowing about components (i.e. `ContextManager`) in the Swift layer.

Update .editorconfig to indent Swift with 4 spaces outside Xcode

53f2e19

Hack code in Blog.m to attempt compilation

71059b1

Move even more files — App still does not compile

2421b89

mokagio mentioned this pull request Mar 12, 2025

Convert WordPressData from Swift package to Xcode target #24194

Closed

mokagio closed this Mar 19, 2025

mokagio deleted the mokagio/move-xcdatamodeld-to-wordpressdata branch March 19, 2025 00:12

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Move `xcdatamodeld` into WordPressData #24166

Move `xcdatamodeld` into WordPressData #24166

mokagio commented Mar 7, 2025 •

edited

Loading

dangermattic commented Mar 7, 2025 •

edited

Loading

mokagio Mar 7, 2025

mokagio Mar 7, 2025

wpmobilebot commented Mar 7, 2025 •

edited

Loading

wpmobilebot commented Mar 7, 2025 •

edited

Loading

kean commented Mar 7, 2025

mokagio commented Mar 10, 2025

mokagio commented Mar 19, 2025

		<entity name="BloggingPrompt" representedClassName=".BloggingPrompt" syncable="YES">
		<entity name="BloggingPrompt" representedClassName="WordPressData.BloggingPrompt" syncable="YES">

Move xcdatamodeld into WordPressData #24166

Move xcdatamodeld into WordPressData #24166

Conversation

mokagio commented Mar 7, 2025 • edited Loading

Regression Notes

dangermattic commented Mar 7, 2025 • edited Loading

mokagio Mar 7, 2025

Choose a reason for hiding this comment

mokagio Mar 7, 2025

Choose a reason for hiding this comment

wpmobilebot commented Mar 7, 2025 • edited Loading

wpmobilebot commented Mar 7, 2025 • edited Loading

kean commented Mar 7, 2025

mokagio commented Mar 10, 2025

mokagio commented Mar 19, 2025

Move `xcdatamodeld` into WordPressData #24166

Move `xcdatamodeld` into WordPressData #24166

mokagio commented Mar 7, 2025 •

edited

Loading

dangermattic commented Mar 7, 2025 •

edited

Loading

wpmobilebot commented Mar 7, 2025 •

edited

Loading

wpmobilebot commented Mar 7, 2025 •

edited

Loading