fix: Throw error when plugin added post-configure (#1150)

haverchuck · Noyes · web-flow · commit 24dbf33f4d64 · 2021-04-13T08:34:21.000-07:00
Co-authored-by: Noyes &lt;dnnoyes@f8ffc25e9e15.ant.amazon.com&gt;
diff --git a/Amplify/Categories/API/AmplifyAPICategory+APICategory.swift b/Amplify/Categories/API/AmplifyAPICategory+APICategory.swift
@@ -19,6 +19,15 @@ extension AmplifyAPICategory: APICategory {
             throw error
         }
 
+        guard !isConfigured else {
+            let pluginDescription = String(describing: plugin)
+            let error = ConfigurationError.amplifyAlreadyConfigured(
+                "\(pluginDescription) cannot be added after `Amplify.configure()`.",
+                "Do not add plugins after calling `Amplify.configure()`."
+            )
+            throw error
+        }
+
         plugins[plugin.key] = plugin
     }
 
diff --git a/Amplify/Categories/Analytics/AnalyticsCategory.swift b/Amplify/Categories/Analytics/AnalyticsCategory.swift
@@ -58,6 +58,15 @@ final public class AnalyticsCategory: Category {
             throw error
         }
 
+        guard !isConfigured else {
+            let pluginDescription = String(describing: plugin)
+            let error = ConfigurationError.amplifyAlreadyConfigured(
+                "\(pluginDescription) cannot be added after `Amplify.configure()`.",
+                "Do not add plugins after calling `Amplify.configure()`."
+            )
+            throw error
+        }
+
         plugins[plugin.key] = plugin
     }
 
diff --git a/Amplify/Categories/Auth/AuthCategory.swift b/Amplify/Categories/Auth/AuthCategory.swift
@@ -56,6 +56,15 @@ final public class AuthCategory: Category {
             throw error
         }
 
+        guard !isConfigured else {
+            let pluginDescription = String(describing: plugin)
+            let error = ConfigurationError.amplifyAlreadyConfigured(
+                "\(pluginDescription) cannot be added after `Amplify.configure()`.",
+                "Do not add plugins after calling `Amplify.configure()`."
+            )
+            throw error
+        }
+
         plugins[plugin.key] = plugin
     }
 
diff --git a/Amplify/Categories/DataStore/DataStoreCategory.swift b/Amplify/Categories/DataStore/DataStoreCategory.swift
@@ -59,6 +59,15 @@ final public class DataStoreCategory: Category {
             throw error
         }
 
+        guard !isConfigured else {
+            let pluginDescription = String(describing: plugin)
+            let error = ConfigurationError.amplifyAlreadyConfigured(
+                "\(pluginDescription) cannot be added after `Amplify.configure()`.",
+                "Do not add plugins after calling `Amplify.configure()`."
+            )
+            throw error
+        }
+
         plugins[plugin.key] = plugin
     }
 
diff --git a/Amplify/Categories/Predictions/PredictionsCategory.swift b/Amplify/Categories/Predictions/PredictionsCategory.swift
@@ -56,6 +56,15 @@ final public class PredictionsCategory: Category {
             throw error
         }
 
+        guard !isConfigured else {
+            let pluginDescription = String(describing: plugin)
+            let error = ConfigurationError.amplifyAlreadyConfigured(
+                "\(pluginDescription) cannot be added after `Amplify.configure()`.",
+                "Do not add plugins after calling `Amplify.configure()`."
+            )
+            throw error
+        }
+
         plugins[plugin.key] = plugin
     }
 
diff --git a/Amplify/Categories/Storage/StorageCategory.swift b/Amplify/Categories/Storage/StorageCategory.swift
@@ -57,6 +57,15 @@ final public class StorageCategory: Category {
             throw error
         }
 
+        guard !isConfigured else {
+            let pluginDescription = String(describing: plugin)
+            let error = ConfigurationError.amplifyAlreadyConfigured(
+                "\(pluginDescription) cannot be added after `Amplify.configure()`.",
+                "Do not add plugins after calling `Amplify.configure()`."
+            )
+            throw error
+        }
+
         plugins[plugin.key] = plugin
     }
 
diff --git a/AmplifyTests/CategoryTests/API/APICategoryConfigurationTests.swift b/AmplifyTests/CategoryTests/API/APICategoryConfigurationTests.swift
@@ -349,4 +349,34 @@ class APICategoryConfigurationTests: XCTestCase {
 
         waitForExpectations(timeout: 0.1)
     }
+
+    /// Test if adding a plugin after configuration throws an error
+    ///
+    /// - Given: Amplify is configured
+    /// - When:
+    ///    - Add  is called for API category
+    /// - Then:
+    ///    - Should throw an exception
+    ///
+    func testAddAfterConfigureThrowsError() throws {
+        let plugin = MockAPICategoryPlugin()
+        try Amplify.add(plugin: plugin)
+
+        let config = APICategoryConfiguration(
+            plugins: ["MockAPICategoryPlugin": true]
+        )
+
+        let amplifyConfig = AmplifyConfiguration(api: config)
+
+        try Amplify.configure(amplifyConfig)
+
+        XCTAssertThrowsError(try Amplify.add(plugin: plugin),
+                             "configure() an already configured plugin should throw") { error in
+                                guard case ConfigurationError.amplifyAlreadyConfigured = error else {
+                                    XCTFail("Expected ConfigurationError.amplifyAlreadyConfigured")
+                                    return
+                                }
+        }
+
+    }
 }
diff --git a/AmplifyTests/CategoryTests/Analytics/AnalyticsCategoryConfigurationTests.swift b/AmplifyTests/CategoryTests/Analytics/AnalyticsCategoryConfigurationTests.swift
@@ -293,4 +293,33 @@ class AnalyticsCategoryConfigurationTests: XCTestCase {
         waitForExpectations(timeout: 0.1)
     }
 
+    /// Test if adding a plugin after configuration throws an error
+    ///
+    /// - Given: Amplify is configured
+    /// - When:
+    ///    - Add  is called for Analytics category
+    /// - Then:
+    ///    - Should throw an exception
+    ///
+    func testAddAfterConfigureThrowsError() throws {
+        let plugin = MockAnalyticsCategoryPlugin()
+        try Amplify.add(plugin: plugin)
+
+        let config = AnalyticsCategoryConfiguration(
+            plugins: ["MockAnalyticsCategoryPlugin": true]
+        )
+
+        let amplifyConfig = AmplifyConfiguration(analytics: config)
+
+        try Amplify.configure(amplifyConfig)
+
+        XCTAssertThrowsError(try Amplify.add(plugin: plugin),
+                             "configure() an already configured plugin should throw") { error in
+                                guard case ConfigurationError.amplifyAlreadyConfigured = error else {
+                                    XCTFail("Expected ConfigurationError.amplifyAlreadyConfigured")
+                                    return
+                                }
+        }
+
+    }
 }
diff --git a/AmplifyTests/CategoryTests/Auth/AuthCategoryConfigurationTests.swift b/AmplifyTests/CategoryTests/Auth/AuthCategoryConfigurationTests.swift
@@ -406,4 +406,34 @@ class AuthCategoryConfigurationTests: XCTestCase {
             XCTAssertNotNil(error as? AuthError)
         }
     }
+
+    /// Test if adding a plugin after configuration throws an error
+    ///
+    /// - Given: Amplify is configured
+    /// - When:
+    ///    - Add  is called for Auth category
+    /// - Then:
+    ///    - Should throw an exception
+    ///
+    func testAddAfterConfigureThrowsError() throws {
+        let plugin = MockAuthCategoryPlugin()
+        try Amplify.add(plugin: plugin)
+
+        let config = AuthCategoryConfiguration(
+            plugins: ["MockAuthCategoryPlugin": true]
+        )
+
+        let amplifyConfig = AmplifyConfiguration(auth: config)
+
+        try Amplify.configure(amplifyConfig)
+
+        XCTAssertThrowsError(try Amplify.add(plugin: plugin),
+                             "configure() an already configured plugin should throw") { error in
+                                guard case ConfigurationError.amplifyAlreadyConfigured = error else {
+                                    XCTFail("Expected ConfigurationError.amplifyAlreadyConfigured")
+                                    return
+                                }
+        }
+
+    }
 }
diff --git a/AmplifyTests/CategoryTests/DataStore/DataStoreCategoryConfigurationTests.swift b/AmplifyTests/CategoryTests/DataStore/DataStoreCategoryConfigurationTests.swift
@@ -312,4 +312,33 @@ class DataStoreCategoryConfigurationTests: XCTestCase {
         waitForExpectations(timeout: 0.1)
     }
 
+    /// Test if adding a plugin after configuration throws an error
+    ///
+    /// - Given: Amplify is configured
+    /// - When:
+    ///    - Add  is called for Datastore category
+    /// - Then:
+    ///    - Should throw an exception
+    ///
+    func testAddAfterConfigureThrowsError() throws {
+        let plugin = MockDataStoreCategoryPlugin()
+        try Amplify.add(plugin: plugin)
+
+        let config = DataStoreCategoryConfiguration(
+            plugins: ["MockDataStoreCategoryPlugin": true]
+        )
+
+        let amplifyConfig = AmplifyConfiguration(dataStore: config)
+
+        try Amplify.configure(amplifyConfig)
+
+        XCTAssertThrowsError(try Amplify.add(plugin: plugin),
+                             "configure() an already configured plugin should throw") { error in
+                                guard case ConfigurationError.amplifyAlreadyConfigured = error else {
+                                    XCTFail("Expected ConfigurationError.amplifyAlreadyConfigured")
+                                    return
+                                }
+        }
+
+    }
 }
diff --git a/AmplifyTests/CategoryTests/Predictions/PredictionsCategoryConfigurationTests.swift b/AmplifyTests/CategoryTests/Predictions/PredictionsCategoryConfigurationTests.swift
@@ -405,4 +405,33 @@ class PredictionsCategoryConfigurationTests: XCTestCase {
         waitForExpectations(timeout: 0.1)
     }
 
+    /// Test if adding a plugin after configuration throws an error
+    ///
+    /// - Given: Amplify is configured
+    /// - When:
+    ///    - Add  is called for Predictions category
+    /// - Then:
+    ///    - Should throw an exception
+    ///
+    func testAddAfterConfigureThrowsError() throws {
+        let plugin = MockPredictionsCategoryPlugin()
+        try Amplify.add(plugin: plugin)
+
+        let config = PredictionsCategoryConfiguration(
+            plugins: ["MockPredictionsCategoryPlugin": true]
+        )
+
+        let amplifyConfig = AmplifyConfiguration(predictions: config)
+
+        try Amplify.configure(amplifyConfig)
+
+        XCTAssertThrowsError(try Amplify.add(plugin: plugin),
+                             "configure() an already configured plugin should throw") { error in
+                                guard case ConfigurationError.amplifyAlreadyConfigured = error else {
+                                    XCTFail("Expected ConfigurationError.amplifyAlreadyConfigured")
+                                    return
+                                }
+        }
+
+    }
 }
diff --git a/AmplifyTests/CategoryTests/Storage/StorageCategoryConfigurationTests.swift b/AmplifyTests/CategoryTests/Storage/StorageCategoryConfigurationTests.swift
@@ -294,4 +294,33 @@ class StorageCategoryConfigurationTests: XCTestCase {
         waitForExpectations(timeout: 0.1)
     }
 
+    /// Test if adding a plugin after configuration throws an error
+    ///
+    /// - Given: Amplify is configured
+    /// - When:
+    ///    - Add  is called for Storage category
+    /// - Then:
+    ///    - Should throw an exception
+    ///
+    func testAddAfterConfigureThrowsError() throws {
+        let plugin = MockStorageCategoryPlugin()
+        try Amplify.add(plugin: plugin)
+
+        let config = StorageCategoryConfiguration(
+            plugins: ["MockStorageCategoryPlugin": true]
+        )
+
+        let amplifyConfig = AmplifyConfiguration(storage: config)
+
+        try Amplify.configure(amplifyConfig)
+
+        XCTAssertThrowsError(try Amplify.add(plugin: plugin),
+                             "configure() an already configured plugin should throw") { error in
+                                guard case ConfigurationError.amplifyAlreadyConfigured = error else {
+                                    XCTFail("Expected ConfigurationError.amplifyAlreadyConfigured")
+                                    return
+                                }
+        }
+
+    }
 }

Original file line number	Diff line number	Diff line change
`@@ -19,6 +19,15 @@ extension AmplifyAPICategory: APICategory {`
`19`	`19`	`throw error`
`20`	`20`	`}`
`21`	`21`
	`22`	`+ guard !isConfigured else {`
	`23`	`+ let pluginDescription = String(describing: plugin)`
	`24`	`+ let error = ConfigurationError.amplifyAlreadyConfigured(`
	`25`	+ "\(pluginDescription) cannot be added after `Amplify.configure()`.",
	`26`	+ "Do not add plugins after calling `Amplify.configure()`."
	`27`	`+ )`
	`28`	`+ throw error`
	`29`	`+ }`
	`30`	`+`
`22`	`31`	`plugins[plugin.key] = plugin`
`23`	`32`	`}`
`24`	`33`
Original file line number	Diff line number	Diff line change
`@@ -58,6 +58,15 @@ final public class AnalyticsCategory: Category {`
`58`	`58`	`throw error`
`59`	`59`	`}`
`60`	`60`
	`61`	`+ guard !isConfigured else {`
	`62`	`+ let pluginDescription = String(describing: plugin)`
	`63`	`+ let error = ConfigurationError.amplifyAlreadyConfigured(`
	`64`	+ "\(pluginDescription) cannot be added after `Amplify.configure()`.",
	`65`	+ "Do not add plugins after calling `Amplify.configure()`."
	`66`	`+ )`
	`67`	`+ throw error`
	`68`	`+ }`
	`69`	`+`
`61`	`70`	`plugins[plugin.key] = plugin`
`62`	`71`	`}`
`63`	`72`
Original file line number	Diff line number	Diff line change
`@@ -56,6 +56,15 @@ final public class AuthCategory: Category {`
`56`	`56`	`throw error`
`57`	`57`	`}`
`58`	`58`
	`59`	`+ guard !isConfigured else {`
	`60`	`+ let pluginDescription = String(describing: plugin)`
	`61`	`+ let error = ConfigurationError.amplifyAlreadyConfigured(`
	`62`	+ "\(pluginDescription) cannot be added after `Amplify.configure()`.",
	`63`	+ "Do not add plugins after calling `Amplify.configure()`."
	`64`	`+ )`
	`65`	`+ throw error`
	`66`	`+ }`
	`67`	`+`
`59`	`68`	`plugins[plugin.key] = plugin`
`60`	`69`	`}`
`61`	`70`
Original file line number	Diff line number	Diff line change
`@@ -59,6 +59,15 @@ final public class DataStoreCategory: Category {`
`59`	`59`	`throw error`
`60`	`60`	`}`
`61`	`61`
	`62`	`+ guard !isConfigured else {`
	`63`	`+ let pluginDescription = String(describing: plugin)`
	`64`	`+ let error = ConfigurationError.amplifyAlreadyConfigured(`
	`65`	+ "\(pluginDescription) cannot be added after `Amplify.configure()`.",
	`66`	+ "Do not add plugins after calling `Amplify.configure()`."
	`67`	`+ )`
	`68`	`+ throw error`
	`69`	`+ }`
	`70`	`+`
`62`	`71`	`plugins[plugin.key] = plugin`
`63`	`72`	`}`
`64`	`73`
Original file line number	Diff line number	Diff line change
`@@ -56,6 +56,15 @@ final public class PredictionsCategory: Category {`
`56`	`56`	`throw error`
`57`	`57`	`}`
`58`	`58`
	`59`	`+ guard !isConfigured else {`
	`60`	`+ let pluginDescription = String(describing: plugin)`
	`61`	`+ let error = ConfigurationError.amplifyAlreadyConfigured(`
	`62`	+ "\(pluginDescription) cannot be added after `Amplify.configure()`.",
	`63`	+ "Do not add plugins after calling `Amplify.configure()`."
	`64`	`+ )`
	`65`	`+ throw error`
	`66`	`+ }`
	`67`	`+`
`59`	`68`	`plugins[plugin.key] = plugin`
`60`	`69`	`}`
`61`	`70`
Original file line number	Diff line number	Diff line change
`@@ -57,6 +57,15 @@ final public class StorageCategory: Category {`
`57`	`57`	`throw error`
`58`	`58`	`}`
`59`	`59`
	`60`	`+ guard !isConfigured else {`
	`61`	`+ let pluginDescription = String(describing: plugin)`
	`62`	`+ let error = ConfigurationError.amplifyAlreadyConfigured(`
	`63`	+ "\(pluginDescription) cannot be added after `Amplify.configure()`.",
	`64`	+ "Do not add plugins after calling `Amplify.configure()`."
	`65`	`+ )`
	`66`	`+ throw error`
	`67`	`+ }`
	`68`	`+`
`60`	`69`	`plugins[plugin.key] = plugin`
`61`	`70`	`}`
`62`	`71`