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

adding constructor with optional comments indices args #674

Merged
merged 5 commits into from
Jun 10, 2024
Merged

adding constructor with optional comments indices args #674

Changes from 1 commit
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
38248a4
adding ctor with optional comments indices args
toepkerd-zz Jun 10, 2024
6a15e38
removing throws IOException declaration above new ctor
toepkerd-zz Jun 10, 2024
6dbc9f6
making reads and writes optional
toepkerd-zz Jun 10, 2024
939cbd4
quick comment change
toepkerd-zz Jun 10, 2024
25692f9
adding test for new ctor
toepkerd-zz Jun 10, 2024
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
28 changes: 24 additions & 4 deletions src/main/kotlin/org/opensearch/commons/alerting/model/DataSources.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ data class DataSources(
val alertsHistoryIndexPattern: String? = "<.opendistro-alerting-alert-history-{now/d}-1>", // AlertIndices.ALERT_HISTORY_INDEX_PATTERN

/** Configures a custom index alias to store comments associated with alerts.*/
val commentsIndex: String = ".opensearch-alerting-comments-history-write", // AlertIndices.COMMENTS_HISTORY_WRITE_INDEX
val commentsIndex: String? = ".opensearch-alerting-comments-history-write", // AlertIndices.COMMENTS_HISTORY_WRITE_INDEX

/** Configures a custom index pattern for commentsIndex alias.*/
val commentsIndexPattern: String? = "<.opensearch-alerting-comments-history-{now/d}-1>", // AlertIndices.COMMENTS_HISTORY_INDEX_PATTERN
Expand All @@ -56,9 +56,6 @@ data class DataSources(
require(alertsIndex.isNotEmpty()) {
"Alerts index cannot be empty"
}
require(commentsIndex.isNotEmpty()) {
"Comments index cannot be empty"
}
if (queryIndexMappingsByType.isNotEmpty()) {
require(queryIndex != ScheduledJob.DOC_LEVEL_QUERIES_INDEX) {
"Custom query index mappings are configurable only if a custom query index is configured too."
Expand Down Expand Up @@ -89,6 +86,29 @@ data class DataSources(
findingsEnabled = sin.readOptionalBoolean()
)

@Throws(IOException::class)
Copy link
Member

Choose a reason for hiding this comment

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

why are we expecting IoException?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

removing

constructor(
Copy link
Member

Choose a reason for hiding this comment

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

https://github.com/opensearch-project/common-utils/pull/674/files#diff-97cf101698aba14b5844f08b1d5be6fcf2752671b9d7510d1a566efbeec20793R83

comments index should be using readOptionalString(), writeOptionalString, null check in parsing etc.
plz incorporate

Copy link
Contributor Author

Choose a reason for hiding this comment

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

updating readOptional and writeOptional, parse adds an empty string placeholder for any comments that don't exist in the XContent, so leaving that be

queryIndex: String,
findingsIndex: String,
findingsIndexPattern: String?,
alertsIndex: String,
alertsHistoryIndex: String?,
alertsHistoryIndexPattern: String?,
queryIndexMappingsByType: Map<String, Map<String, String>>,
findingsEnabled: Boolean?
) : this(
queryIndex = queryIndex,
findingsIndex = findingsIndex,
findingsIndexPattern = findingsIndexPattern,
alertsIndex = alertsIndex,
alertsHistoryIndex = alertsHistoryIndex,
alertsHistoryIndexPattern = alertsHistoryIndexPattern,
commentsIndex = null,
commentsIndexPattern = null,
queryIndexMappingsByType = queryIndexMappingsByType,
findingsEnabled = findingsEnabled
)

@Suppress("UNCHECKED_CAST")
fun asTemplateArg(): Map<String, Any?> {
return mapOf(
Expand Down
Loading