Extract Core Data to ShareExtensionCore (#24275)

* Move Core Data entities to ShareExtensionCore

* Update how momd is loaded

Author: kean

Modules/Package.swift

@@ -87,7 +87,8 @@ let package = Package(
                 "WordPressShared",
                 .product(name: "CocoaLumberjackSwift", package: "CocoaLumberjack"),
                 .product(name: "WordPressKit", package: "WordPressKit-iOS"),
-            ]
+            ],
+            resources: [.process("Resources/Extensions.xcdatamodeld")]
         ),
         .target(
             name: "NotificationServiceExtensionCore",

WordPress/WordPressShareExtension/MediaUploadOperation.swift Modules/Sources/ShareExtensionCore/Data/MediaUploadOperation.swift

@@ -38,7 +38,7 @@ public class MediaUploadOperation: UploadOperation {
 extension MediaUploadOperation {
     /// Returns a RemoteMedia object based on this MediaUploadOperation
     ///
-    var remoteMedia: RemoteMedia {
+    public var remoteMedia: RemoteMedia {
         let remoteMedia = RemoteMedia()
         remoteMedia.mediaID = NSNumber(value: remoteMediaID)
         remoteMedia.mimeType = mimeType
@@ -60,7 +60,7 @@ extension MediaUploadOperation {
 extension MediaUploadOperation {
     /// Updates the local fields with the new values stored in a given RemoteMedia
     ///
-    func updateWithMedia(remote: RemoteMedia) {
+    public func updateWithMedia(remote: RemoteMedia) {
         if let mediaId = remote.mediaID?.int64Value {
             remoteMediaID = mediaId
         }

WordPress/WordPressShareExtension/PostUploadOperation.swift Modules/Sources/ShareExtensionCore/Data/PostUploadOperation.swift

@@ -38,7 +38,7 @@ public class PostUploadOperation: UploadOperation {
 extension PostUploadOperation {
     /// Returns a RemotePost object based on this PostUploadOperation
     ///
-    var remotePost: RemotePost {
+    public var remotePost: RemotePost {
         let remotePost = RemotePost()
         remotePost.postID = NSNumber(value: remotePostID)
         remotePost.content = postContent
@@ -58,7 +58,7 @@ extension PostUploadOperation {
 extension PostUploadOperation {
     /// Updates the local fields with the new values stored in a given RemotePost
     ///
-    func updateWithPost(remote: RemotePost) {
+    public func updateWithPost(remote: RemotePost) {
 
         if let postId = remote.postID?.int64Value {
             remotePostID = postId

WordPress/WordPressShareExtension/SharedCoreDataStack.swift Modules/Sources/ShareExtensionCore/Data/SharedCoreDataStack.swift

@@ -20,14 +20,23 @@ final class SharedPersistentContainer: NSPersistentContainer {
 extension SharedPersistentContainer: @unchecked Sendable {}
 #endif
 
-class SharedCoreDataStack {
+public final class SharedCoreDataStack {
 
     // MARK: - Private Properties
 
-    fileprivate let modelName: String
+    /// - warning: Has to be loaded exactly once per process.
+    nonisolated(unsafe) static let model: NSManagedObjectModel = {
+        guard let modelURL = Bundle.module.url(forResource: "Extensions", withExtension: "momd") else {
+            fatalError("Core Data model missing")
+        }
+        guard let model = NSManagedObjectModel(contentsOf: modelURL) else {
+            fatalError("failed to load model")
+        }
+        return model
+    }()
 
     fileprivate lazy var storeContainer: SharedPersistentContainer = {
-        let container = SharedPersistentContainer(name: self.modelName)
+        let container = SharedPersistentContainer(name: "SharedCoreDataStack", managedObjectModel: SharedCoreDataStack.model)
         container.loadPersistentStores { (storeDescription, error) in
             if let error = error as NSError? {
                 DDLogError("Error loading persistent stores: \(error), \(error.userInfo)")
@@ -40,34 +49,21 @@ class SharedCoreDataStack {
 
     /// Returns the managed context associated with the main queue
     ///
-    lazy var managedContext: NSManagedObjectContext = {
+    public lazy var managedContext: NSManagedObjectContext = {
         return self.storeContainer.viewContext
     }()
 
     // MARK: - Initializers
 
     /// Initialize the SharedPersistentContainer using the standard Extensions model.
     ///
-    convenience init() {
-        self.init(modelName: Constants.sharedModelName)
-    }
-
-    /// Initialize the core data stack with the given model name.
-    ///
-    /// This initializer is meant for testing. You probably want to use the convenience `init()` that uses the standard Extensions model
-    ///
-    /// - Parameters:
-    ///     - modelName: Name of the model to initialize the SharedPersistentContainer with.
-    ///
-    init(modelName: String) {
-        self.modelName = modelName
-    }
+    public init() {}
 
     // MARK: - Public Funcntions
 
     /// Commit unsaved changes (if any exist) using the main queue's managed context
     ///
-    func saveContext() {
+    public func saveContext() {
         guard managedContext.hasChanges else {
             return
         }
@@ -89,7 +85,7 @@ extension SharedCoreDataStack {
     /// - Parameter sessionID: the session ID
     /// - Returns: group ID or nil if session does not have an associated group
     ///
-    func fetchGroupID(for sessionID: String) -> String? {
+    public func fetchGroupID(for sessionID: String) -> String? {
         let request = NSFetchRequest<NSFetchRequestResult>(entityName: "UploadOperation")
         request.predicate = NSPredicate(format: "(backgroundSessionIdentifier == %@)", sessionID)
         request.fetchLimit = 1
@@ -104,7 +100,7 @@ extension SharedCoreDataStack {
     /// - Parameter objectID: Managed object ID string for a given post upload op
     /// - Returns: PostUploadOperation or nil
     ///
-    func fetchPostUploadOp(withObjectID objectID: String) -> PostUploadOperation? {
+    public func fetchPostUploadOp(withObjectID objectID: String) -> PostUploadOperation? {
         guard let storeCoordinator = managedContext.persistentStoreCoordinator,
             let url = URL(string: objectID),
             let managedObjectID = storeCoordinator.managedObjectID(forURIRepresentation: url) else {
@@ -119,7 +115,7 @@ extension SharedCoreDataStack {
     /// - Parameter postUploadOpObjectID: Managed object ID for a given post upload op
     /// - Returns: PostUploadOperation or nil
     ///
-    func fetchPostUploadOp(withObjectID postUploadOpObjectID: NSManagedObjectID) -> PostUploadOperation? {
+    public func fetchPostUploadOp(withObjectID postUploadOpObjectID: NSManagedObjectID) -> PostUploadOperation? {
         var postUploadOp: PostUploadOperation?
         do {
             postUploadOp = try managedContext.existingObject(with: postUploadOpObjectID) as? PostUploadOperation
@@ -136,7 +132,7 @@ extension SharedCoreDataStack {
     /// - Parameter groupID: group ID for a set of upload ops
     /// - Returns: post PostUploadOperation or nil
     ///
-    func fetchPostUploadOp(for groupID: String) -> PostUploadOperation? {
+    public func fetchPostUploadOp(for groupID: String) -> PostUploadOperation? {
         let request = NSFetchRequest<NSFetchRequestResult>(entityName: "PostUploadOperation")
         request.predicate = NSPredicate(format: "(groupID == %@)", groupID)
         request.fetchLimit = 1
@@ -151,7 +147,7 @@ extension SharedCoreDataStack {
     /// - Parameter groupID: group ID for a set of upload ops
     /// - Returns: An array of MediaUploadOperations or nil
     ///
-    func fetchMediaUploadOps(for groupID: String) -> [MediaUploadOperation]? {
+    public func fetchMediaUploadOps(for groupID: String) -> [MediaUploadOperation]? {
         let request = NSFetchRequest<NSFetchRequestResult>(entityName: "MediaUploadOperation")
         request.predicate = NSPredicate(format: "(groupID == %@)", groupID)
         guard let results = (try? managedContext.fetch(request)) as? [MediaUploadOperation] else {
@@ -168,7 +164,7 @@ extension SharedCoreDataStack {
     ///   - sessionID: background session ID
     /// - Returns: MediaUploadOperation or nil
     ///
-    func fetchMediaUploadOp(for fileName: String, with sessionID: String) -> MediaUploadOperation? {
+    public func fetchMediaUploadOp(for fileName: String, with sessionID: String) -> MediaUploadOperation? {
         guard let fileNameWithoutExtension = URL(string: fileName)?.deletingPathExtension().lastPathComponent else {
             return nil
         }
@@ -192,7 +188,7 @@ extension SharedCoreDataStack {
     ///   - sessionID: background session ID
     /// - Returns: An array of UploadOperations or nil
     ///
-    func fetchSessionUploadOps(for taskIdentifier: Int, with sessionID: String) -> [UploadOperation]? {
+    public func fetchSessionUploadOps(for taskIdentifier: Int, with sessionID: String) -> [UploadOperation]? {
         var uploadOps: [UploadOperation]?
         let request = NSFetchRequest<NSFetchRequestResult>(entityName: "UploadOperation")
         request.predicate = NSPredicate(format: "(backgroundSessionTaskID == %d AND backgroundSessionIdentifier == %@)", taskIdentifier, sessionID)
@@ -216,7 +212,7 @@ extension SharedCoreDataStack {
     ///   - status: New status
     ///   - uploadOpObjectID: Managed object ID for a given upload op
     ///
-    func updateStatus(_ status: UploadOperation.UploadStatus, forUploadOpWithObjectID uploadOpObjectID: NSManagedObjectID) {
+    public func updateStatus(_ status: UploadOperation.UploadStatus, forUploadOpWithObjectID uploadOpObjectID: NSManagedObjectID) {
         var uploadOp: UploadOperation?
         do {
             uploadOp = try managedContext.existingObject(with: uploadOpObjectID) as? UploadOperation
@@ -238,7 +234,7 @@ extension SharedCoreDataStack {
     ///   - status: New status
     /// - Returns: Managed object ID of newly saved media upload operation object
     ///
-    func saveMediaOperation(_ remoteMedia: RemoteMedia, sessionID: String, groupIdentifier: String, siteID: NSNumber, with status: UploadOperation.UploadStatus) -> NSManagedObjectID {
+    public func saveMediaOperation(_ remoteMedia: RemoteMedia, sessionID: String, groupIdentifier: String, siteID: NSNumber, with status: UploadOperation.UploadStatus) -> NSManagedObjectID {
         let mediaUploadOp = MediaUploadOperation(context: managedContext)
         mediaUploadOp.updateWithMedia(remote: remoteMedia)
         mediaUploadOp.backgroundSessionIdentifier = sessionID
@@ -262,7 +258,7 @@ extension SharedCoreDataStack {
     ///   - remoteMediaID: remote media ID
     ///   - remoteURL: remote media URL string
     ///
-    func updateMediaOperation(for fileName: String, with sessionID: String, remoteMediaID: Int64?, remoteURL: String?, width: Int32?, height: Int32?) {
+    public func updateMediaOperation(for fileName: String, with sessionID: String, remoteMediaID: Int64?, remoteURL: String?, width: Int32?, height: Int32?) {
         guard let mediaUploadOp = fetchMediaUploadOp(for: fileName, with: sessionID) else {
             DDLogError("Error loading UploadOperation Object with File Name: \(fileName)")
             return
@@ -289,7 +285,7 @@ extension SharedCoreDataStack {
     ///   - status: New status
     /// - Returns: Managed object ID of newly saved post upload operation object
     ///
-    func savePostOperation(_ remotePost: RemotePost, groupIdentifier: String, with status: UploadOperation.UploadStatus) -> NSManagedObjectID {
+    public func savePostOperation(_ remotePost: RemotePost, groupIdentifier: String, with status: UploadOperation.UploadStatus) -> NSManagedObjectID {
         let postUploadOp = PostUploadOperation(context: managedContext)
         postUploadOp.updateWithPost(remote: remotePost)
         postUploadOp.groupID = groupIdentifier
@@ -307,7 +303,7 @@ extension SharedCoreDataStack {
     ///   - remotePostID: New remote post ID
     ///   - postUploadOpObjectID: Managed object ID for a given post upload op
     ///
-    func updatePostOperation(with status: UploadOperation.UploadStatus, remotePostID: Int64, forPostUploadOpWithObjectID postUploadOpObjectID: NSManagedObjectID) {
+    public func updatePostOperation(with status: UploadOperation.UploadStatus, remotePostID: Int64, forPostUploadOpWithObjectID postUploadOpObjectID: NSManagedObjectID) {
         guard let postUploadOp = (try? managedContext.existingObject(with: postUploadOpObjectID)) as? PostUploadOperation else {
             DDLogError("Error loading PostUploadOperation Object with ID: \(postUploadOpObjectID)")
             return
@@ -323,7 +319,7 @@ extension SharedCoreDataStack {
     ///   - taskID: New background session task ID
     ///   - uploadOpObjectID: Managed object ID for a given upload op
     ///
-    func updateTaskID(_ taskID: NSNumber, forUploadOpWithObjectID uploadOpObjectID: NSManagedObjectID) {
+    public func updateTaskID(_ taskID: NSNumber, forUploadOpWithObjectID uploadOpObjectID: NSManagedObjectID) {
         var uploadOp: UploadOperation?
         do {
             uploadOp = try managedContext.existingObject(with: uploadOpObjectID) as? UploadOperation

WordPress/WordPressShareExtension/UploadOperation.swift Modules/Sources/ShareExtensionCore/Data/UploadOperation.swift

@@ -6,14 +6,15 @@ import WordPressKit
 public class UploadOperation: NSManagedObject {
     /// Curent status for this upload op
     ///
-    var currentStatus: UploadStatus {
+    public var currentStatus: UploadStatus {
         get {
             return UploadStatus(rawValue: Int(self.uploadStatus))!
         }
         set {
             self.uploadStatus = Int32(newValue.rawValue)
         }
     }
+
     @NSManaged private var uploadStatus: Int32
 
     /// ID which is unique to a group of upload operations within WPiOS (and its extensions)
@@ -42,7 +43,7 @@ public class UploadOperation: NSManagedObject {
 extension UploadOperation {
     /// Status types for a given upload operation
     ///
-    enum UploadStatus: Int {
+    public enum UploadStatus: Int {
         /// Upload has been queued, but not started
         ///
         case pending
@@ -61,10 +62,10 @@ extension UploadOperation {
 
         var stringValue: String {
             switch self {
-            case .pending:      return "Pending"
-            case .inProgress:   return "In Progress"
-            case .complete:     return "Complete"
-            case .error:        return "Error"
+            case .pending: "Pending"
+            case .inProgress: "In Progress"
+            case .complete: "Complete"
+            case .error: "Error"
             }
         }
     }

WordPress/WordPressShareExtension/EXTENSION_MIGRATIONS.md Modules/Sources/ShareExtensionCore/Resources/EXTENSION_MIGRATIONS.md

@@ -1,5 +1,5 @@
-
 import SwiftUI
+import DesignSystem
 import WidgetKit
 import WordPressUI