Skip to content

Remove deprecated multi-project methods in Enterprise GeoIP downloader #130062

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

Merged
samxbr merged 4 commits into from
Jul 15, 2025
Merged

Remove deprecated multi-project methods in Enterprise GeoIP downloader #130062

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
eac6e2f
Remove deprecated multi-project methods in Enterprise GeoIP
samxbr Jun 26, 2025
50b4d06
Address commet
samxbr Jun 27, 2025
0ce4496
Merge branch 'main' into feature/multi-project/geoip-enterprise-downl…
samxbr Jun 28, 2025
5958cc9
Merge branch 'main' into feature/multi-project/geoip-enterprise-downl…
samxbr Jul 15, 2025
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
8 changes: 5 additions & 3 deletions .../internalClusterTest/java/org/elasticsearch/ingest/geoip/EnterpriseGeoIpDownloaderIT.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@
import org.elasticsearch.action.search.SearchResponse;
import org.elasticsearch.action.support.SubscribableListener;
import org.elasticsearch.action.support.master.AcknowledgedResponse;
import org.elasticsearch.cluster.metadata.ProjectId;
import org.elasticsearch.common.Strings;
import org.elasticsearch.common.settings.MockSecureSettings;
import org.elasticsearch.common.settings.Settings;
Expand Down Expand Up @@ -116,7 +117,7 @@ public void testEnterpriseDownloaderTask() throws Exception {
final String sourceField = "ip";
final String targetField = "ip-result";

startEnterpriseGeoIpDownloaderTask();
startEnterpriseGeoIpDownloaderTask(ProjectId.DEFAULT);
configureMaxmindDatabase(MAXMIND_DATABASE_TYPE);
configureIpinfoDatabase(IPINFO_DATABASE_TYPE);
waitAround();
Expand Down Expand Up @@ -171,9 +172,10 @@ private void deleteDatabaseConfiguration(String configurationName, ActionListene
);
}

private void startEnterpriseGeoIpDownloaderTask() {
private void startEnterpriseGeoIpDownloaderTask(ProjectId projectId) {
PersistentTasksService persistentTasksService = internalCluster().getInstance(PersistentTasksService.class);
persistentTasksService.sendStartRequest(
persistentTasksService.sendProjectStartRequest(
projectId,
ENTERPRISE_GEOIP_DOWNLOADER,
ENTERPRISE_GEOIP_DOWNLOADER,
new EnterpriseGeoIpTask.EnterpriseGeoIpTaskParams(),
Expand Down
17 changes: 13 additions & 4 deletions .../ingest-geoip/src/main/java/org/elasticsearch/ingest/geoip/EnterpriseGeoIpDownloader.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,10 +19,12 @@
import org.elasticsearch.action.support.PlainActionFuture;
import org.elasticsearch.client.internal.Client;
import org.elasticsearch.cluster.block.ClusterBlockLevel;
import org.elasticsearch.cluster.metadata.ProjectId;
import org.elasticsearch.cluster.service.ClusterService;
import org.elasticsearch.common.CheckedSupplier;
import org.elasticsearch.common.Strings;
import org.elasticsearch.common.hash.MessageDigests;
import org.elasticsearch.core.NotMultiProjectCapable;
import org.elasticsearch.core.TimeValue;
import org.elasticsearch.core.Tuple;
import org.elasticsearch.index.query.BoolQueryBuilder;
Expand Down Expand Up @@ -67,6 +69,7 @@
* Downloads are verified against MD5 checksum provided by the server
* Current state of all stored databases is stored in cluster state in persistent task state
*/
@NotMultiProjectCapable(description = "Enterprise GeoIP not available in serverless")
public class EnterpriseGeoIpDownloader extends AllocatedPersistentTask {

private static final Logger logger = LogManager.getLogger(EnterpriseGeoIpDownloader.class);
Expand Down Expand Up @@ -143,21 +146,27 @@ void setState(EnterpriseGeoIpTaskState state) {
// visible for testing
void updateDatabases() throws IOException {
var clusterState = clusterService.state();
var geoipIndex = clusterState.getMetadata().getProject().getIndicesLookup().get(EnterpriseGeoIpDownloader.DATABASES_INDEX);
var geoipIndex = clusterState.getMetadata()
Copy link
Contributor

@nielsbauman nielsbauman Jun 26, 2025

Choose a reason for hiding this comment

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

Could we maybe assign a local variable like this (i.e. move the annotation)

@NotMultiProjectCapable(description = "Enterprise GeoIP not available in serverless")
final var projectId = ProjectId.DEFAULT;

That makes it easier to understand/read why we're hardcoding the default project ID here as there is only one reference to the default project ID and it has the annotation directly above.

Copy link
Contributor Author

@samxbr samxbr Jun 27, 2025

Choose a reason for hiding this comment

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

Similar to EnterpriseGeoIpDownloaderTaskExecutor, there will likely be more changes needed than just the project ID (project ID is the easy one to spot). I can make a local variable on the project ID, I think it's better to also keep the class level annotation as a reminder to review the whole class again.

.getProject(ProjectId.DEFAULT)
.getIndicesLookup()
.get(EnterpriseGeoIpDownloader.DATABASES_INDEX);
if (geoipIndex != null) {
logger.trace("the geoip index [{}] exists", EnterpriseGeoIpDownloader.DATABASES_INDEX);
if (clusterState.getRoutingTable().index(geoipIndex.getWriteIndex()).allPrimaryShardsActive() == false) {
if (clusterState.routingTable(ProjectId.DEFAULT).index(geoipIndex.getWriteIndex()).allPrimaryShardsActive() == false) {
logger.debug("not updating databases because not all primary shards of [{}] index are active yet", DATABASES_INDEX);
return;
}
var blockException = clusterState.blocks().indexBlockedException(ClusterBlockLevel.WRITE, geoipIndex.getWriteIndex().getName());
var blockException = clusterState.blocks()
.indexBlockedException(ProjectId.DEFAULT, ClusterBlockLevel.WRITE, geoipIndex.getWriteIndex().getName());
if (blockException != null) {
throw blockException;
}
}

logger.trace("Updating databases");
IngestGeoIpMetadata geoIpMeta = clusterState.metadata().getProject().custom(IngestGeoIpMetadata.TYPE, IngestGeoIpMetadata.EMPTY);
IngestGeoIpMetadata geoIpMeta = clusterState.metadata()
.getProject(ProjectId.DEFAULT)
.custom(IngestGeoIpMetadata.TYPE, IngestGeoIpMetadata.EMPTY);

// if there are entries in the cs that aren't in the persistent task state,
// then download those (only)
Expand Down
2 changes: 2 additions & 0 deletions ...p/src/main/java/org/elasticsearch/ingest/geoip/EnterpriseGeoIpDownloaderTaskExecutor.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@
import org.elasticsearch.common.settings.SecureString;
import org.elasticsearch.common.settings.Setting;
import org.elasticsearch.common.settings.Settings;
import org.elasticsearch.core.NotMultiProjectCapable;
import org.elasticsearch.core.TimeValue;
import org.elasticsearch.ingest.EnterpriseGeoIpTask.EnterpriseGeoIpTaskParams;
import org.elasticsearch.ingest.IngestService;
Expand All @@ -47,6 +48,7 @@
import static org.elasticsearch.ingest.geoip.GeoIpDownloaderTaskExecutor.ENABLED_SETTING;
import static org.elasticsearch.ingest.geoip.GeoIpDownloaderTaskExecutor.POLL_INTERVAL_SETTING;

@NotMultiProjectCapable(description = "Enterprise GeoIP not available in serverless")
Copy link
Contributor

@nielsbauman nielsbauman Jun 26, 2025

Choose a reason for hiding this comment

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

I don't immediately see why we need this annotation here, am I missing something? Can you move it to the specific lines that need it?

Copy link
Contributor Author

@samxbr samxbr Jun 27, 2025

Choose a reason for hiding this comment

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

There are probably many lines that need this if we put it at line level, and some are unclear to me how it will work yet (for example the secure settings). The intention for this annotation at class level is that the whole class needs to be reviewed again on which specific lines needs to be changed when it become serverless available.

Copy link
Contributor Author

@samxbr samxbr Jun 27, 2025

Choose a reason for hiding this comment

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

I can update the description to make the intention clearer

public class EnterpriseGeoIpDownloaderTaskExecutor extends PersistentTasksExecutor<EnterpriseGeoIpTaskParams>
implements
ClusterStateListener {
Expand Down