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

CORE-17437: State Manager Configuration Section #1277

Merged
merged 6 commits into from
Oct 9, 2023
Merged

CORE-17437: State Manager Configuration Section #1277

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
cc1563d
CORE-17437: State Manager Configuration Section
jujoramos Oct 5, 2023
8772b84
Review Feedback
jujoramos Oct 9, 2023
b797248
Trigger CI
jujoramos Oct 9, 2023
e3dc655
Revert directory rename (not supported by cli)
jujoramos Oct 9, 2023
e0e59a5
Trigger CI
jujoramos Oct 9, 2023
26b962f
Trigger CI
jujoramos Oct 9, 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
2 changes: 1 addition & 1 deletion data/config-schema/src/main/java/net/corda/schema/configuration/BootConfig.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ private BootConfig() {

public static final String BOOT_SECRETS = "secrets";

public static final String BOOT_STATE_MANAGER = "stateManager";
public static final String BOOT_STATE_MANAGER = StateManagerConfig.STATE_MANAGER;
public static final String BOOT_STATE_MANAGER_TYPE = BOOT_STATE_MANAGER + ".type";
public static final String BOOT_STATE_MANAGER_DB_USER = BOOT_STATE_MANAGER + ".database.user";
public static final String BOOT_STATE_MANAGER_DB_PASS = BOOT_STATE_MANAGER + ".database.pass";
Expand Down
1 change: 1 addition & 0 deletions data/config-schema/src/main/java/net/corda/schema/configuration/ConfigKeys.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ private ConfigKeys() {
public static final String FLOW_CONFIG = "corda.flow";
public static final String MESSAGING_CONFIG = "corda.messaging";
public static final String EXTERNAL_MESSAGING_CONFIG = "corda.externalMessaging";
public static final String STATE_MANAGER_CONFIG = "corda." + StateManagerConfig.STATE_MANAGER;
public static final String UTXO_LEDGER_CONFIG = "corda.ledger.utxo";
public static final String P2P_LINK_MANAGER_CONFIG = "corda.p2p.linkManager";
public static final String P2P_GATEWAY_CONFIG = "corda.p2p.gateway";
Expand Down
27 changes: 0 additions & 27 deletions data/config-schema/src/main/java/net/corda/schema/configuration/MessagingConfig.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -78,31 +78,4 @@ private Publisher() {
* producers to stay under this limit when publishing messages.
*/
public static final String MAX_ALLOWED_MSG_SIZE = "maxAllowedMessageSize";

/**
* State Manager Configuration for connecting to the underlying persistent storage.
*/
public static final class StateManager {
private StateManager() {
}

public static final String STATE_MANAGER = "stateManager";
public static final String TYPE = STATE_MANAGER + ".type";

// Database Values
public static final String DB_PROPERTIES = STATE_MANAGER + ".database";
public static final String JDBC_USER = DB_PROPERTIES + ".user";
public static final String JDBC_PASS = DB_PROPERTIES + ".pass";

public static final String JDBC_URL = DB_PROPERTIES + ".jdbc.url";
public static final String JDBC_DRIVER = DB_PROPERTIES + ".jdbc.driver";
public static final String JDBC_DRIVER_DIRECTORY = DB_PROPERTIES + ".jdbc.directory";
public static final String JDBC_PERSISTENCE_UNIT_NAME = DB_PROPERTIES + ".jdbc.persistenceUnitName";
jujoramos marked this conversation as resolved.
Show resolved Hide resolved
public static final String JDBC_POOL_MAX_SIZE = DB_PROPERTIES + ".pool.maxSize";
public static final String JDBC_POOL_MIN_SIZE = DB_PROPERTIES + ".pool.minSize";
public static final String JDBC_POOL_IDLE_TIMEOUT_SECONDS = DB_PROPERTIES + ".pool.idleTimeoutSeconds";
public static final String JDBC_POOL_MAX_LIFETIME_SECONDS = DB_PROPERTIES + ".pool.maxLifetimeSeconds";
public static final String JDBC_POOL_KEEP_ALIVE_TIME_SECONDS = DB_PROPERTIES + ".pool.keepAliveTimeSeconds";
public static final String JDBC_POOL_VALIDATION_TIMEOUT_SECONDS = DB_PROPERTIES + ".pool.validationTimeoutSeconds";
}
}
30 changes: 30 additions & 0 deletions data/config-schema/src/main/java/net/corda/schema/configuration/StateManagerConfig.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
package net.corda.schema.configuration;

/**
* Configuration keys to access public parts of the configuration under the {@code corda.stateManager} key.
*/
public final class StateManagerConfig {
private StateManagerConfig() {
}

public static final String STATE_MANAGER = "stateManager";

public static final String TYPE = "type";

// Database Configuration Values
public static final class Database {
public static final String DB_PROPERTIES = "database";
Copy link
Contributor

@conalsmith-r3 conalsmith-r3 Oct 9, 2023 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah that's better, so when users pass config to the stateManagerFactory.create() the configs don't need to be in a "stateManager" level 👍 (i.e. user can listen for changes to "ConfigKeys.STATE_MANAGER_CONFIG" key, and on this change, pass the config at config.getConfig(ConfigKeys.STATE_MANAGER_CONFIG)

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah: https://github.com/corda/corda-runtime-os/pull/4780/files#diff-0cbc84dd880a3bbc7bd717605c94972718d589a610ec6e7da73de771975944ecR43

public static final String JDBC_USER = DB_PROPERTIES + ".user";
public static final String JDBC_PASS = DB_PROPERTIES + ".pass";

public static final String JDBC_URL = DB_PROPERTIES + ".jdbc.url";
jujoramos marked this conversation as resolved.
Show resolved Hide resolved
public static final String JDBC_DRIVER = DB_PROPERTIES + ".jdbc.driver";
public static final String JDBC_DRIVER_DIRECTORY = DB_PROPERTIES + ".jdbc.directory";
public static final String JDBC_POOL_MAX_SIZE = DB_PROPERTIES + ".pool.maxSize";
public static final String JDBC_POOL_MIN_SIZE = DB_PROPERTIES + ".pool.minSize";
public static final String JDBC_POOL_IDLE_TIMEOUT_SECONDS = DB_PROPERTIES + ".pool.idleTimeoutSeconds";
public static final String JDBC_POOL_MAX_LIFETIME_SECONDS = DB_PROPERTIES + ".pool.maxLifetimeSeconds";
public static final String JDBC_POOL_KEEP_ALIVE_TIME_SECONDS = DB_PROPERTIES + ".pool.keepAliveTimeSeconds";
public static final String JDBC_POOL_VALIDATION_TIMEOUT_SECONDS = DB_PROPERTIES + ".pool.validationTimeoutSeconds";
}
}
31 changes: 0 additions & 31 deletions ...hema/src/main/resources/net/corda/schema/configuration/messaging/1.0/corda.messaging.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -109,37 +109,6 @@
"default": 972800,
"minimum": 512000,
"maximum": 8388608
},
"stateManager": {
"description": "Connection details for the underlying persistent storage used by the out of process State Manager.",
"type": "object",
"properties": {
"type": {
"description": "The type of state manager implementation.",
"enum": [
"DATABASE"
]
},
"additionalProperties": false
},
"$comment": "Polymorphic state manager storage connection configuration. The valid section depends on which state manager implementation is in use.",
"allOf": [
{
"if": {
"properties": { "type": { "const": "DATABASE" } },
"required": ["type"]
},
"then": {
"properties": {
"databaseProperties": {
"description": "Settings to connect to the state manager database.",
"$ref": "state-manager-db-properties.json"
}
},
"required": ["type","databaseProperties"]
}
}
]
}
},
"additionalProperties": false
Expand Down
44 changes: 44 additions & 0 deletions ...rc/main/resources/net/corda/schema/configuration/stateManager/1.0/corda.stateManager.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
{
"$schema": "https://json-schema.org/draft/2019-09/schema",
"$id": "https://corda.r3.com/net/corda/schema/configuration/stateManager/1.0/corda.stateManager.json",
"title": "Corda State Manager Configuration Schema",
"description": "Configuration schema for the State Manager section. This configures the interactions of the workers with the underlying persistent storage used by the out of process State Manager.",
"type": "object",
"properties": {
"type": {
"description": "The type of state manager implementation.",
"enum": [
"DATABASE"
]
},
"additionalProperties": false
},
"$comment": "Polymorphic state manager storage connection configuration. The valid section depends on which state manager implementation is in use.",
"allOf": [
{
"if": {
"properties": {
"type": {
"const": "DATABASE"
}
},
"required": [
"type"
]
},
"then": {
"properties": {
"databaseProperties": {
"description": "Settings to connect to the State Manager Database.",
"$ref": "stateManager-db-properties.json"
}
},
"required": [
"type",
"databaseProperties"
]
}
}
],
"additionalProperties": false
}
17 changes: 6 additions & 11 deletions ...ging/1.0/state-manager-db-properties.json → ...nager/1.0/stateManager-db-properties.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"$schema": "https://json-schema.org/draft/2019-09/schema",
"$id": "https://corda.r3.com/net/corda/schema/configuration/db/1.0/corda.db.json",
"$id": "https://corda.r3.com/net/corda/schema/configuration/stateManager/1.0/stateManager-db-properties.json",
"title": "State Manager Database Configuration Schema",
"description": "Configuration schema for the database section. Note that this configuration cannot be updated dynamically through the REST endpoint.",
"type": "object",
Expand All @@ -23,6 +23,11 @@
"type": "object",
"default": {},
"properties": {
"url": {
"description": "The JDBC URL.",
"type": "string",
"default": "jdbc:postgresql://state-manager-db:5432/state_manager"
},
"driver": {
"description": "The JDBC driver.",
"type": "string",
Expand All @@ -32,16 +37,6 @@
"description": "The directory that contains the JDBC drivers.",
"type": "string",
"default": "/opt/jdbc-driver"
},
"url": {
"description": "The JDBC URL.",
"type": "string",
"default": "jdbc:postgresql://state-manager-db:5432/state_manager"
},
"persistenceUnitName": {
"description": "The persistent unit name.",
"type": "string",
"default": "corda-state-manager"
}
},
"additionalProperties": false
Expand Down
4 changes: 3 additions & 1 deletion .../test/kotlin/net/corda/schema/configuration/provider/impl/SchemaProviderConfigImplTest.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ import net.corda.schema.configuration.ConfigKeys.RECONCILIATION_CONFIG
import net.corda.schema.configuration.ConfigKeys.REST_CONFIG
import net.corda.schema.configuration.ConfigKeys.SANDBOX_CONFIG
import net.corda.schema.configuration.ConfigKeys.SECRETS_CONFIG
import net.corda.schema.configuration.ConfigKeys.STATE_MANAGER_CONFIG
import net.corda.schema.configuration.ConfigKeys.UTXO_LEDGER_CONFIG
import net.corda.schema.configuration.provider.ConfigSchemaException
import net.corda.v5.base.versioning.Version
Expand Down Expand Up @@ -42,6 +43,7 @@ class SchemaProviderConfigImplTest {
SANDBOX_CONFIG,
RECONCILIATION_CONFIG,
MEMBERSHIP_CONFIG,
STATE_MANAGER_CONFIG
)
private val VERSIONS = listOf("1.0")

Expand Down Expand Up @@ -99,4 +101,4 @@ class SchemaProviderConfigImplTest {
provider.getSchemaFile(BAD_SCHEMA_FILE)
}
}
}
}
2 changes: 1 addition & 1 deletion gradle.properties
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ cordaProductVersion = 5.1.0
# NOTE: update this each time this module contains a breaking change
## NOTE: currently this is a top level revision, so all API versions will line up, but this could be moved to
## a per module property in which case module versions can change independently.
cordaApiRevision = 30
cordaApiRevision = 31

# Main
kotlinVersion = 1.8.21
Expand Down