From 54ac60d7aa2cf5d739b33ba90efac7bc7281b778 Mon Sep 17 00:00:00 2001
From: Andriy Redko <andriy.redko@aiven.io>
Date: Thu, 18 Apr 2024 15:10:58 -0400
Subject: [PATCH] Reconsider the breaking changes check policy to detect
 breaking changes against released versions

Signed-off-by: Andriy Redko <andriy.redko@aiven.io>
---
 CHANGELOG.md        |  1 +
 server/build.gradle | 47 ++++++++++++++++++++-------------------------
 2 files changed, 22 insertions(+), 26 deletions(-)

diff --git a/CHANGELOG.md b/CHANGELOG.md
index 5efcfee3d9d9d..6633397e4fc6a 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -45,6 +45,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 - Improve built-in secure transports support ([#12907](https://github.com/opensearch-project/OpenSearch/pull/12907))
 - Update links to documentation in rest-api-spec ([#13043](https://github.com/opensearch-project/OpenSearch/pull/13043))
 - Refactoring globMatch using simpleMatchWithNormalizedStrings from Regex ([#13104](https://github.com/opensearch-project/OpenSearch/pull/13104))
+- [BWC and API enforcement] Reconsider the breaking changes check policy to detect breaking changes against released versions ([#13292](https://github.com/opensearch-project/OpenSearch/pull/13292))
 
 ### Deprecated
 
diff --git a/server/build.gradle b/server/build.gradle
index a076a6bee36bf..3887ea1955372 100644
--- a/server/build.gradle
+++ b/server/build.gradle
@@ -173,6 +173,17 @@ tasks.named("testingConventions").configure {
     }
 }
 
+// Read the list from maven central.
+// Fetch the metadata and parse the xml into Version instances, pick the latest one
+def latestRelease = new URL('https://repo1.maven.org/maven2/org/opensearch/opensearch/maven-metadata.xml').openStream().withStream { s ->
+    new XmlParser().parse(s)
+       .versioning.versions.version
+       .collect { it.text() }.findAll { it ==~ /\d+\.\d+\.\d+/ }
+       .collect { org.opensearch.gradle.Version.fromString(it) }
+       .toSorted()
+       .last()
+}
+
 def generateModulesList = tasks.register("generateModulesList") {
     List<String> modules = project(':modules').subprojects.collect { it.name }
     File modulesFile = new File(buildDir, 'generated-resources/modules.txt')
@@ -382,7 +393,8 @@ tasks.named("sourcesJar").configure {
 
 /** Compares the current build against a snapshot build */
 tasks.register("japicmp", me.champeau.gradle.japicmp.JapicmpTask) {
-    oldClasspath.from(files("${buildDir}/snapshot/opensearch-${version}.jar"))
+    logger.info("Comparing public APIs from ${version} to ${latestRelease}")
+    oldClasspath.from(files("${buildDir}/latestRelease/opensearch-${latestRelease}.jar"))
     newClasspath.from(tasks.named('jar'))
     onlyModified = true
     failOnModification = true
@@ -390,50 +402,33 @@ tasks.register("japicmp", me.champeau.gradle.japicmp.JapicmpTask) {
     annotationIncludes = ['@org.opensearch.common.annotation.PublicApi', '@org.opensearch.common.annotation.DeprecatedApi']
     txtOutputFile = layout.buildDirectory.file("reports/java-compatibility/report.txt")
     htmlOutputFile = layout.buildDirectory.file("reports/java-compatibility/report.html")
-    dependsOn downloadSnapshot
+    dependsOn downloadLatestRelease
 }
 
 /** If the Java API Comparison task failed, print a hint if the change should be merged from its target branch */
 gradle.taskGraph.afterTask { Task task, TaskState state ->
     if (task.name == 'japicmp' && state.failure != null) {
-        def sha = getGitShaFromJar("${buildDir}/snapshot/opensearch-${version}.jar")
-        logger.info("Incompatiable java api from snapshot jar built off of commit ${sha}")
-
-        if (!inHistory(sha)) {
-          logger.warn('\u001B[33mPlease merge from the target branch and run this task again.\u001B[0m')
-        }
+        logger.info("Public APIs changes incompatiable with ${latestRelease} release have been detected")
     }
 }
 
-/** Downloads latest snapshot from maven repository */
-tasks.register("downloadSnapshot", Copy) {
-    def mavenSnapshotRepoUrl = "https://aws.oss.sonatype.org/content/repositories/snapshots/"
+/** Downloads latest released version from maven repository */
+tasks.register("downloadLatestRelease", Copy) {
     def groupId = "org.opensearch"
     def artifactId = "opensearch"
 
-    def repos = project.getRepositories();
-    MavenArtifactRepository opensearchRepo = repos.maven(repo -> {
-        repo.setName("opensearch-snapshots");
-        repo.setUrl(mavenSnapshotRepoUrl);
-    });
-
-    repos.exclusiveContent(exclusiveRepo -> {
-        exclusiveRepo.filter(descriptor -> descriptor.includeGroup(groupId));
-        exclusiveRepo.forRepositories(opensearchRepo);
-    });
-
     configurations {
-        snapshotArtifact {
+        latestReleaseArtifact {
             exclude group: 'org.apache.lucene'
         }
     }
 
     dependencies {
-        snapshotArtifact("${groupId}:${artifactId}:${version}:")
+        latestReleaseArtifact("${groupId}:${artifactId}:${latestRelease}:")
     }
 
-    from configurations.snapshotArtifact
-    into "$buildDir/snapshot"
+    from configurations.latestReleaseArtifact
+    into "$buildDir/latestRelease"
 }
 
 /** Check if the sha is in the current history */