RNGP - Create DependencyUtil to support with dep version configuration (

facebook#35027)

Summary:
Pull Request resolved: facebook#35027

This is part of a series of tasks to make the React Native Gradle Plugin (RNGP) variant-aware.

Here I'm extending preparing classes to handle the Dependency versions and pre-configure the repositories as we wish.

Changelog:
[Internal] [Changed] - RNGP - Create DependencyUtil to support with dep version configuration

Reviewed By: cipolleschi

Differential Revision: D40512101

fbshipit-source-id: 05867a4c3fd341373669ea72d950ec4ee78a158d

packages/react-native-gradle-plugin/src/main/kotlin/com/facebook/react/utils/DependencyUtils.kt

@@ -0,0 +1,53 @@
+/*
+ * Copyright (c) Meta Platforms, Inc. and affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+
+package com.facebook.react.utils
+
+import java.io.File
+import java.net.URI
+import java.util.*
+import org.gradle.api.Project
+import org.gradle.api.artifacts.repositories.MavenArtifactRepository
+
+internal object DependencyUtils {
+
+  fun configureRepositories(project: Project, reactNativeDir: File) {
+    with(project) {
+      if (hasProperty("REACT_NATIVE_MAVEN_LOCAL_REPO")) {
+        mavenRepoFromUrl("file://${property("REACT_NATIVE_MAVEN_LOCAL_REPO")}")
+      }
+      // We add the snapshot for users on nightlies.
+      mavenRepoFromUrl("https://oss.sonatype.org/content/repositories/snapshots/")
+      repositories.mavenCentral()
+      // All of React Native (JS, Obj-C sources, Android binaries) is installed from npm
+      mavenRepoFromUrl("file://${reactNativeDir}/android")
+      // Android JSC is installed from npm
+      mavenRepoFromUrl("file://${reactNativeDir}/../jsc-android/dist")
+      repositories.google()
+      mavenRepoFromUrl("https://www.jitpack.io")
+    }
+  }
+
+  fun configureDependencies(project: Project, versionString: String) {
+    if (versionString.isBlank()) return
+    project.configurations.all { configuration ->
+      configuration.resolutionStrategy.force(
+          "com.facebook.react:react-native:${versionString}",
+          "com.facebook.react:hermes-engine:${versionString}",
+      )
+    }
+  }
+
+  fun readVersionString(propertiesFile: File): String {
+    val reactAndroidProperties = Properties()
+    propertiesFile.inputStream().use { reactAndroidProperties.load(it) }
+    return reactAndroidProperties["VERSION_NAME"] as? String ?: ""
+  }
+
+  fun Project.mavenRepoFromUrl(url: String): MavenArtifactRepository =
+      project.repositories.maven { it.url = URI.create(url) }
+}

packages/react-native-gradle-plugin/src/test/kotlin/com/facebook/react/utils/DependencyUtilsTest.kt

@@ -0,0 +1,239 @@
+/*
+ * Copyright (c) Meta Platforms, Inc. and affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+
+package com.facebook.react.utils
+
+import com.facebook.react.tests.createProject
+import com.facebook.react.utils.DependencyUtils.configureDependencies
+import com.facebook.react.utils.DependencyUtils.configureRepositories
+import com.facebook.react.utils.DependencyUtils.mavenRepoFromUrl
+import com.facebook.react.utils.DependencyUtils.readVersionString
+import java.net.URI
+import org.gradle.api.artifacts.repositories.MavenArtifactRepository
+import org.junit.Assert.*
+import org.junit.Rule
+import org.junit.Test
+import org.junit.rules.TemporaryFolder
+
+class DependencyUtilsTest {
+
+  @get:Rule val tempFolder = TemporaryFolder()
+
+  @Test
+  fun configureRepositories_withProjectPropertySet_configuresMavenLocalCorrectly() {
+    val localMaven = tempFolder.newFolder("m2")
+    val localMavenURI = URI.create("file://$localMaven/")
+    val project = createProject()
+    project.extensions.extraProperties.set("REACT_NATIVE_MAVEN_LOCAL_REPO", localMaven)
+
+    configureRepositories(project, tempFolder.root)
+
+    assertNotNull(
+        project.repositories.firstOrNull {
+          it is MavenArtifactRepository && it.url == localMavenURI
+        })
+  }
+
+  @Test
+  fun configureRepositories_containsSnapshotRepo() {
+    val repositoryURI = URI.create("https://oss.sonatype.org/content/repositories/snapshots/")
+    val project = createProject()
+
+    configureRepositories(project, tempFolder.root)
+
+    assertNotNull(
+        project.repositories.firstOrNull {
+          it is MavenArtifactRepository && it.url == repositoryURI
+        })
+  }
+
+  @Test
+  fun configureRepositories_containsReactNativeNpmLocalMavenRepo() {
+    val projectFolder = tempFolder.newFolder()
+    val reactNativeDir = tempFolder.newFolder("react-native")
+    val repositoryURI = URI.create("file://${reactNativeDir}/android")
+    val project = createProject(projectFolder)
+
+    configureRepositories(project, reactNativeDir)
+
+    assertNotNull(
+        project.repositories.firstOrNull {
+          it is MavenArtifactRepository && it.url == repositoryURI
+        })
+  }
+
+  @Test
+  fun configureRepositories_containsJscLocalMavenRepo() {
+    val projectFolder = tempFolder.newFolder()
+    val reactNativeDir = tempFolder.newFolder("react-native")
+    val jscAndroidDir = tempFolder.newFolder("jsc-android")
+    val repositoryURI = URI.create("file://${jscAndroidDir}/dist")
+    val project = createProject(projectFolder)
+
+    configureRepositories(project, reactNativeDir)
+
+    assertNotNull(
+        project.repositories.firstOrNull {
+          it is MavenArtifactRepository && it.url == repositoryURI
+        })
+  }
+
+  @Test
+  fun configureRepositories_containsMavenCentral() {
+    val repositoryURI = URI.create("https://repo.maven.apache.org/maven2/")
+    val project = createProject()
+
+    configureRepositories(project, tempFolder.root)
+
+    assertNotNull(
+        project.repositories.firstOrNull {
+          it is MavenArtifactRepository && it.url == repositoryURI
+        })
+  }
+
+  @Test
+  fun configureRepositories_containsGoogleRepo() {
+    val repositoryURI = URI.create("https://dl.google.com/dl/android/maven2/")
+    val project = createProject()
+
+    configureRepositories(project, tempFolder.root)
+
+    assertNotNull(
+        project.repositories.firstOrNull {
+          it is MavenArtifactRepository && it.url == repositoryURI
+        })
+  }
+
+  @Test
+  fun configureRepositories_containsJitPack() {
+    val repositoryURI = URI.create("https://www.jitpack.io")
+    val project = createProject()
+
+    configureRepositories(project, tempFolder.root)
+
+    assertNotNull(
+        project.repositories.firstOrNull {
+          it is MavenArtifactRepository && it.url == repositoryURI
+        })
+  }
+
+  @Test
+  fun configureRepositories_withProjectPropertySet_hasHigherPriorityThanMavenCentral() {
+    val localMaven = tempFolder.newFolder("m2")
+    val localMavenURI = URI.create("file://$localMaven/")
+    val mavenCentralURI = URI.create("https://repo.maven.apache.org/maven2/")
+    val project = createProject()
+    project.extensions.extraProperties.set("REACT_NATIVE_MAVEN_LOCAL_REPO", localMaven)
+
+    configureRepositories(project, tempFolder.root)
+
+    val indexOfLocalRepo =
+        project.repositories.indexOfFirst {
+          it is MavenArtifactRepository && it.url == localMavenURI
+        }
+    val indexOfMavenCentral =
+        project.repositories.indexOfFirst {
+          it is MavenArtifactRepository && it.url == mavenCentralURI
+        }
+    assertTrue(indexOfLocalRepo < indexOfMavenCentral)
+  }
+
+  @Test
+  fun configureRepositories_snapshotRepoHasHigherPriorityThanMavenCentral() {
+    val repositoryURI = URI.create("https://oss.sonatype.org/content/repositories/snapshots/")
+    val mavenCentralURI = URI.create("https://repo.maven.apache.org/maven2/")
+    val project = createProject()
+
+    configureRepositories(project, tempFolder.root)
+
+    val indexOfSnapshotRepo =
+        project.repositories.indexOfFirst {
+          it is MavenArtifactRepository && it.url == repositoryURI
+        }
+    val indexOfMavenCentral =
+        project.repositories.indexOfFirst {
+          it is MavenArtifactRepository && it.url == mavenCentralURI
+        }
+    assertTrue(indexOfSnapshotRepo < indexOfMavenCentral)
+  }
+
+  @Test
+  fun configureDependencies_withEmptyVersion_doesNothing() {
+    val project = createProject()
+
+    configureDependencies(project, "")
+
+    assertTrue(project.configurations.first().resolutionStrategy.forcedModules.isEmpty())
+  }
+
+  @Test
+  fun configureDependencies_withVersionString_appliesResolutionStrategy() {
+    val project = createProject()
+
+    configureDependencies(project, "1.2.3")
+
+    val forcedModules = project.configurations.first().resolutionStrategy.forcedModules
+    assertTrue(forcedModules.any { it.toString() == "com.facebook.react:react-native:1.2.3" })
+    assertTrue(forcedModules.any { it.toString() == "com.facebook.react:hermes-engine:1.2.3" })
+  }
+
+  @Test
+  fun readVersionString_withCorrectVersionString_returnsIt() {
+    val propertiesFile =
+        tempFolder.newFile("gradle.properties").apply {
+          writeText(
+              """
+        VERSION_NAME=1000.0.0
+        ANOTHER_PROPERTY=true
+      """
+                  .trimIndent())
+        }
+
+    val versionString = readVersionString(propertiesFile)
+
+    assertEquals("1000.0.0", versionString)
+  }
+
+  @Test
+  fun readVersionString_withMissingVersionString_returnsEmpty() {
+    val propertiesFile =
+        tempFolder.newFile("gradle.properties").apply {
+          writeText(
+              """
+        ANOTHER_PROPERTY=true
+      """
+                  .trimIndent())
+        }
+
+    val versionString = readVersionString(propertiesFile)
+    assertEquals("", versionString)
+  }
+
+  @Test
+  fun readVersionString_withEmptyVersionString_returnsEmpty() {
+    val propertiesFile =
+        tempFolder.newFile("gradle.properties").apply {
+          writeText(
+              """
+        VERSION_NAME=
+        ANOTHER_PROPERTY=true
+      """
+                  .trimIndent())
+        }
+
+    val versionString = readVersionString(propertiesFile)
+    assertEquals("", versionString)
+  }
+
+  @Test
+  fun mavenRepoFromUrl_worksCorrectly() {
+    val process = createProject()
+    val mavenRepo = process.mavenRepoFromUrl("https://hello.world")
+
+    assertEquals(URI.create("https://hello.world"), mavenRepo.url)
+  }
+}