Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(datastore): Add DataBase Name Provider as optional parameter on DataStore plugin initializer #2808

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open

feat(datastore): Add DataBase Name Provider as optional parameter on DataStore plugin initializer #2808

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
3a5a358
added databaseName provider as optional parameter on DataStore plugin…
baldarama Mar 11, 2023
7e9dfca
updated changes to latest main branch
Mar 11, 2023
a30987b
Merge branch 'main-+-adding-DataStore-database-custom-naming' into ad…
Mar 11, 2023
a8afa66
Merge branch 'aws-amplify:main' into adding-DataStore-database-custom…
baldarama Jul 20, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 11 additions & 1 deletion AmplifyPlugins/DataStore/Sources/AWSDataStorePlugin/AWSDataStorePlugin.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,9 @@ final public class AWSDataStorePlugin: DataStoreCategoryPlugin {

/// The DataStore configuration
var configuration: InternalDatastoreConfiguration

/// The database name provider
let databaseNameProvider: DatabaseNameProvider?

var storageEngine: StorageEngineBehavior!

Expand All @@ -57,18 +60,21 @@ final public class AWSDataStorePlugin: DataStoreCategoryPlugin {

/// No-argument init that uses defaults for all providers
public init(modelRegistration: AmplifyModelRegistration,
configuration dataStoreConfiguration: DataStoreConfiguration = .default) {
configuration dataStoreConfiguration: DataStoreConfiguration = .default,
databaseNameProvider: DatabaseNameProvider? = nil) {
self.modelRegistration = modelRegistration
self.configuration = InternalDatastoreConfiguration(
isSyncEnabled: false,
validAPIPluginKey: "awsAPIPlugin",
validAuthPluginKey: "awsCognitoAuthPlugin",
pluginConfiguration: dataStoreConfiguration)
self.databaseNameProvider = databaseNameProvider

self.storageEngineBehaviorFactory =
StorageEngine.init(
isSyncEnabled:
dataStoreConfiguration:
databaseNameProvider:
validAPIPluginKey:
validAuthPluginKey:
modelRegistryVersion:
Expand All @@ -81,6 +87,7 @@ final public class AWSDataStorePlugin: DataStoreCategoryPlugin {
/// Internal initializer for testing
init(modelRegistration: AmplifyModelRegistration,
configuration dataStoreConfiguration: DataStoreConfiguration = .default,
databaseNameProvider: DatabaseNameProvider? = nil,
storageEngineBehaviorFactory: StorageEngineBehaviorFactory? = nil,
dataStorePublisher: ModelSubcriptionBehavior,
operationQueue: OperationQueue = OperationQueue(),
Expand All @@ -92,11 +99,13 @@ final public class AWSDataStorePlugin: DataStoreCategoryPlugin {
validAPIPluginKey: validAPIPluginKey,
validAuthPluginKey: validAuthPluginKey,
pluginConfiguration: dataStoreConfiguration)
self.databaseNameProvider = databaseNameProvider

self.storageEngineBehaviorFactory = storageEngineBehaviorFactory ??
StorageEngine.init(
isSyncEnabled:
dataStoreConfiguration:
databaseNameProvider:
validAPIPluginKey:
validAuthPluginKey:
modelRegistryVersion:
Expand Down Expand Up @@ -173,6 +182,7 @@ final public class AWSDataStorePlugin: DataStoreCategoryPlugin {
storageEngine = try storageEngineBehaviorFactory(
configuration.isSyncEnabled,
dataStoreConfiguration,
databaseNameProvider,
configuration.validAPIPluginKey,
configuration.validAuthPluginKey,
modelRegistration.version,
Expand Down
6 changes: 5 additions & 1 deletion AmplifyPlugins/DataStore/Sources/AWSDataStorePlugin/Storage/StorageEngine.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,11 +13,14 @@ import AWSPluginsCore
typealias StorageEngineBehaviorFactory =
(Bool,
DataStoreConfiguration,
DatabaseNameProvider?,
String,
String,
String,
UserDefaults) throws -> StorageEngineBehavior

public typealias DatabaseNameProvider = () -> String

// swiftlint:disable type_body_length
final class StorageEngine: StorageEngineBehavior {
// TODO: Make this private once we get a mutation flow that passes the type of mutation as needed
Expand Down Expand Up @@ -93,13 +96,14 @@ final class StorageEngine: StorageEngineBehavior {

convenience init(isSyncEnabled: Bool,
dataStoreConfiguration: DataStoreConfiguration,
databaseNameProvider: DatabaseNameProvider?,
validAPIPluginKey: String = "awsAPIPlugin",
validAuthPluginKey: String = "awsCognitoAuthPlugin",
modelRegistryVersion: String,
userDefault: UserDefaults = UserDefaults.standard) throws {

let key = kCFBundleNameKey as String
let databaseName = Bundle.main.object(forInfoDictionaryKey: key) as? String ?? "app"
let databaseName = databaseNameProvider?() ?? Bundle.main.object(forInfoDictionaryKey: key) as? String ?? "app"

let storageAdapter = try SQLiteStorageEngineAdapter(version: modelRegistryVersion, databaseName: databaseName)

Expand Down