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.

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
Show file tree
Hide file tree
Changes from all commits
Commits
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
Original file line number Diff line number Diff line change
Expand Up @@ -32,10 +32,10 @@ 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", // CommentsIndices.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
val commentsIndexPattern: String? = "<.opensearch-alerting-comments-history-{now/d}-1>", // CommentsIndices.COMMENTS_HISTORY_INDEX_PATTERN

/** Configures custom mappings by field type for query index.
* Custom query index mappings are configurable, only if a custom query index is configured too. */
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 All @@ -83,12 +80,34 @@ data class DataSources(
alertsIndex = sin.readString(),
alertsHistoryIndex = sin.readOptionalString(),
alertsHistoryIndexPattern = sin.readOptionalString(),
commentsIndex = sin.readString(),
commentsIndex = sin.readOptionalString(),
commentsIndexPattern = sin.readOptionalString(),
queryIndexMappingsByType = sin.readMap() as Map<String, Map<String, String>>,
findingsEnabled = sin.readOptionalBoolean()
)

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 Expand Up @@ -189,7 +208,7 @@ data class DataSources(
out.writeString(alertsIndex)
out.writeOptionalString(alertsHistoryIndex)
out.writeOptionalString(alertsHistoryIndexPattern)
out.writeString(commentsIndex)
out.writeOptionalString(commentsIndex)
out.writeOptionalString(commentsIndexPattern)
out.writeMap(queryIndexMappingsByType as Map<String, Any>)
out.writeOptionalBoolean(findingsEnabled)
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
package org.opensearch.commons.alerting.model

import org.junit.jupiter.api.Assertions
import org.junit.jupiter.api.Test
import org.opensearch.common.io.stream.BytesStreamOutput
import org.opensearch.core.common.io.stream.StreamInput

class DataSourcesTests {
@Test
fun `Test DataSources construction with no comments indices`() {
val dataSources = DataSources(
ScheduledJob.DOC_LEVEL_QUERIES_INDEX,
".opensearch-alerting-finding-history-write",
"<.opensearch-alerting-finding-history-{now/d}-1>",
".opendistro-alerting-alerts",
".opendistro-alerting-alert-history-write",
"<.opendistro-alerting-alert-history-{now/d}-1>",
mapOf(),
false
)
Assertions.assertNotNull(dataSources)

val out = BytesStreamOutput()
dataSources.writeTo(out)
val sin = StreamInput.wrap(out.bytes().toBytesRef().bytes)
val newDataSources = DataSources(sin)
Assertions.assertEquals(ScheduledJob.DOC_LEVEL_QUERIES_INDEX, newDataSources.queryIndex)
Assertions.assertEquals(".opensearch-alerting-finding-history-write", newDataSources.findingsIndex)
Assertions.assertEquals("<.opensearch-alerting-finding-history-{now/d}-1>", newDataSources.findingsIndexPattern)
Assertions.assertEquals(".opendistro-alerting-alerts", newDataSources.alertsIndex)
Assertions.assertEquals(".opendistro-alerting-alert-history-write", newDataSources.alertsHistoryIndex)
Assertions.assertEquals("<.opendistro-alerting-alert-history-{now/d}-1>", newDataSources.alertsHistoryIndexPattern)
Assertions.assertEquals(mapOf<String, Map<String, String>>(), newDataSources.queryIndexMappingsByType)
Assertions.assertEquals(false, newDataSources.findingsEnabled)
}
}
Loading