diff --git a/.gitignore b/.gitignore index ed0c106fcfc9d4..c70694eaaddf55 100644 --- a/.gitignore +++ b/.gitignore @@ -25,6 +25,7 @@ project.xcworkspace # Gradle /build/ /packages/react-native-gradle-plugin/build/ +/packages/standalone-gradle-plugins/build/ /packages/rn-tester/build /packages/rn-tester/android/app/.cxx/ /packages/rn-tester/android/app/build/ diff --git a/packages/standalone-gradle-plugins/build.gradle.kts b/packages/standalone-gradle-plugins/build.gradle.kts new file mode 100644 index 00000000000000..2bcc5d56cf1050 --- /dev/null +++ b/packages/standalone-gradle-plugins/build.gradle.kts @@ -0,0 +1,50 @@ +/* + * 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. + */ + +group = "com.facebook.react" + +plugins { + // kotlin-dsl implies embedded Kotlin and is recommended for Kotlin Gradle plugins + // https://docs.gradle.org/current/userguide/kotlin_dsl.html#sec:kotlin-dsl_plugin + `kotlin-dsl` + `maven-publish` + id("com.gradle.plugin-publish") version "1.2.1" +} + +repositories { + // Use Maven Central for resolving dependencies. + mavenCentral() +} + +dependencies { + // Use the Kotlin JUnit 5 integration. + testImplementation("org.jetbrains.kotlin:kotlin-test-junit5") + + implementation(gradleApi()) + testRuntimeOnly("org.junit.platform:junit-platform-launcher") +} + +gradlePlugin { + website = "https://reactnative.dev" + vcsUrl = "https://github.com/facebook/react-native" + plugins { + create("nodeJsResolver") { + id = "com.facebook.react.nodejsresolver" + version = "0.1.0-alpha-0" + displayName = "Node.js resolver plugin used by React Native" + description = + "A Gradle Plugin for correctly resolving node_modules paths from your build/settings.gradle" + tags.set(listOf("react", "node", "nodejs", "node_modules", "resolver", "resolution")) + implementationClass = "com.facebook.react.nodejsresolver.NodeJsResolverGradlePlugin" + } + } +} + +tasks.named("test") { + // Use JUnit Jupiter for unit tests. + useJUnitPlatform() +} diff --git a/packages/standalone-gradle-plugins/gradle/libs.versions.toml b/packages/standalone-gradle-plugins/gradle/libs.versions.toml new file mode 100644 index 00000000000000..e69de29bb2d1d6 diff --git a/packages/standalone-gradle-plugins/gradle/wrapper/gradle-wrapper.jar b/packages/standalone-gradle-plugins/gradle/wrapper/gradle-wrapper.jar new file mode 100644 index 00000000000000..d64cd4917707c1 Binary files /dev/null and b/packages/standalone-gradle-plugins/gradle/wrapper/gradle-wrapper.jar differ diff --git a/packages/standalone-gradle-plugins/gradle/wrapper/gradle-wrapper.properties b/packages/standalone-gradle-plugins/gradle/wrapper/gradle-wrapper.properties new file mode 100644 index 00000000000000..e6aba2515d5428 --- /dev/null +++ b/packages/standalone-gradle-plugins/gradle/wrapper/gradle-wrapper.properties @@ -0,0 +1,7 @@ +distributionBase=GRADLE_USER_HOME +distributionPath=wrapper/dists +distributionUrl=https\://services.gradle.org/distributions/gradle-8.5-all.zip +networkTimeout=10000 +validateDistributionUrl=true +zipStoreBase=GRADLE_USER_HOME +zipStorePath=wrapper/dists diff --git a/packages/standalone-gradle-plugins/gradlew b/packages/standalone-gradle-plugins/gradlew new file mode 100755 index 00000000000000..1aa94a42690741 --- /dev/null +++ b/packages/standalone-gradle-plugins/gradlew @@ -0,0 +1,249 @@ +#!/bin/sh + +# +# Copyright © 2015-2021 the original authors. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# https://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# + +############################################################################## +# +# Gradle start up script for POSIX generated by Gradle. +# +# Important for running: +# +# (1) You need a POSIX-compliant shell to run this script. If your /bin/sh is +# noncompliant, but you have some other compliant shell such as ksh or +# bash, then to run this script, type that shell name before the whole +# command line, like: +# +# ksh Gradle +# +# Busybox and similar reduced shells will NOT work, because this script +# requires all of these POSIX shell features: +# * functions; +# * expansions «$var», «${var}», «${var:-default}», «${var+SET}», +# «${var#prefix}», «${var%suffix}», and «$( cmd )»; +# * compound commands having a testable exit status, especially «case»; +# * various built-in commands including «command», «set», and «ulimit». +# +# Important for patching: +# +# (2) This script targets any POSIX shell, so it avoids extensions provided +# by Bash, Ksh, etc; in particular arrays are avoided. +# +# The "traditional" practice of packing multiple parameters into a +# space-separated string is a well documented source of bugs and security +# problems, so this is (mostly) avoided, by progressively accumulating +# options in "$@", and eventually passing that to Java. +# +# Where the inherited environment variables (DEFAULT_JVM_OPTS, JAVA_OPTS, +# and GRADLE_OPTS) rely on word-splitting, this is performed explicitly; +# see the in-line comments for details. +# +# There are tweaks for specific operating systems such as AIX, CygWin, +# Darwin, MinGW, and NonStop. +# +# (3) This script is generated from the Groovy template +# https://github.com/gradle/gradle/blob/HEAD/subprojects/plugins/src/main/resources/org/gradle/api/internal/plugins/unixStartScript.txt +# within the Gradle project. +# +# You can find Gradle at https://github.com/gradle/gradle/. +# +############################################################################## + +# Attempt to set APP_HOME + +# Resolve links: $0 may be a link +app_path=$0 + +# Need this for daisy-chained symlinks. +while + APP_HOME=${app_path%"${app_path##*/}"} # leaves a trailing /; empty if no leading path + [ -h "$app_path" ] +do + ls=$( ls -ld "$app_path" ) + link=${ls#*' -> '} + case $link in #( + /*) app_path=$link ;; #( + *) app_path=$APP_HOME$link ;; + esac +done + +# This is normally unused +# shellcheck disable=SC2034 +APP_BASE_NAME=${0##*/} +# Discard cd standard output in case $CDPATH is set (https://github.com/gradle/gradle/issues/25036) +APP_HOME=$( cd "${APP_HOME:-./}" > /dev/null && pwd -P ) || exit + +# Use the maximum available, or set MAX_FD != -1 to use that value. +MAX_FD=maximum + +warn () { + echo "$*" +} >&2 + +die () { + echo + echo "$*" + echo + exit 1 +} >&2 + +# OS specific support (must be 'true' or 'false'). +cygwin=false +msys=false +darwin=false +nonstop=false +case "$( uname )" in #( + CYGWIN* ) cygwin=true ;; #( + Darwin* ) darwin=true ;; #( + MSYS* | MINGW* ) msys=true ;; #( + NONSTOP* ) nonstop=true ;; +esac + +CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar + + +# Determine the Java command to use to start the JVM. +if [ -n "$JAVA_HOME" ] ; then + if [ -x "$JAVA_HOME/jre/sh/java" ] ; then + # IBM's JDK on AIX uses strange locations for the executables + JAVACMD=$JAVA_HOME/jre/sh/java + else + JAVACMD=$JAVA_HOME/bin/java + fi + if [ ! -x "$JAVACMD" ] ; then + die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME + +Please set the JAVA_HOME variable in your environment to match the +location of your Java installation." + fi +else + JAVACMD=java + if ! command -v java >/dev/null 2>&1 + then + die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. + +Please set the JAVA_HOME variable in your environment to match the +location of your Java installation." + fi +fi + +# Increase the maximum file descriptors if we can. +if ! "$cygwin" && ! "$darwin" && ! "$nonstop" ; then + case $MAX_FD in #( + max*) + # In POSIX sh, ulimit -H is undefined. That's why the result is checked to see if it worked. + # shellcheck disable=SC2039,SC3045 + MAX_FD=$( ulimit -H -n ) || + warn "Could not query maximum file descriptor limit" + esac + case $MAX_FD in #( + '' | soft) :;; #( + *) + # In POSIX sh, ulimit -n is undefined. That's why the result is checked to see if it worked. + # shellcheck disable=SC2039,SC3045 + ulimit -n "$MAX_FD" || + warn "Could not set maximum file descriptor limit to $MAX_FD" + esac +fi + +# Collect all arguments for the java command, stacking in reverse order: +# * args from the command line +# * the main class name +# * -classpath +# * -D...appname settings +# * --module-path (only if needed) +# * DEFAULT_JVM_OPTS, JAVA_OPTS, and GRADLE_OPTS environment variables. + +# For Cygwin or MSYS, switch paths to Windows format before running java +if "$cygwin" || "$msys" ; then + APP_HOME=$( cygpath --path --mixed "$APP_HOME" ) + CLASSPATH=$( cygpath --path --mixed "$CLASSPATH" ) + + JAVACMD=$( cygpath --unix "$JAVACMD" ) + + # Now convert the arguments - kludge to limit ourselves to /bin/sh + for arg do + if + case $arg in #( + -*) false ;; # don't mess with options #( + /?*) t=${arg#/} t=/${t%%/*} # looks like a POSIX filepath + [ -e "$t" ] ;; #( + *) false ;; + esac + then + arg=$( cygpath --path --ignore --mixed "$arg" ) + fi + # Roll the args list around exactly as many times as the number of + # args, so each arg winds up back in the position where it started, but + # possibly modified. + # + # NB: a `for` loop captures its iteration list before it begins, so + # changing the positional parameters here affects neither the number of + # iterations, nor the values presented in `arg`. + shift # remove old arg + set -- "$@" "$arg" # push replacement arg + done +fi + + +# Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. +DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"' + +# Collect all arguments for the java command: +# * DEFAULT_JVM_OPTS, JAVA_OPTS, JAVA_OPTS, and optsEnvironmentVar are not allowed to contain shell fragments, +# and any embedded shellness will be escaped. +# * For example: A user cannot expect ${Hostname} to be expanded, as it is an environment variable and will be +# treated as '${Hostname}' itself on the command line. + +set -- \ + "-Dorg.gradle.appname=$APP_BASE_NAME" \ + -classpath "$CLASSPATH" \ + org.gradle.wrapper.GradleWrapperMain \ + "$@" + +# Stop when "xargs" is not available. +if ! command -v xargs >/dev/null 2>&1 +then + die "xargs is not available" +fi + +# Use "xargs" to parse quoted args. +# +# With -n1 it outputs one arg per line, with the quotes and backslashes removed. +# +# In Bash we could simply go: +# +# readarray ARGS < <( xargs -n1 <<<"$var" ) && +# set -- "${ARGS[@]}" "$@" +# +# but POSIX shell has neither arrays nor command substitution, so instead we +# post-process each arg (as a line of input to sed) to backslash-escape any +# character that might be a shell metacharacter, then use eval to reverse +# that process (while maintaining the separation between arguments), and wrap +# the whole thing up as a single "set" statement. +# +# This will of course break if any of these variables contains a newline or +# an unmatched quote. +# + +eval "set -- $( + printf '%s\n' "$DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS" | + xargs -n1 | + sed ' s~[^-[:alnum:]+,./:=@_]~\\&~g; ' | + tr '\n' ' ' + )" '"$@"' + +exec "$JAVACMD" "$@" diff --git a/packages/standalone-gradle-plugins/gradlew.bat b/packages/standalone-gradle-plugins/gradlew.bat new file mode 100644 index 00000000000000..6689b85beecde6 --- /dev/null +++ b/packages/standalone-gradle-plugins/gradlew.bat @@ -0,0 +1,92 @@ +@rem +@rem Copyright 2015 the original author or authors. +@rem +@rem Licensed under the Apache License, Version 2.0 (the "License"); +@rem you may not use this file except in compliance with the License. +@rem You may obtain a copy of the License at +@rem +@rem https://www.apache.org/licenses/LICENSE-2.0 +@rem +@rem Unless required by applicable law or agreed to in writing, software +@rem distributed under the License is distributed on an "AS IS" BASIS, +@rem WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +@rem See the License for the specific language governing permissions and +@rem limitations under the License. +@rem + +@if "%DEBUG%"=="" @echo off +@rem ########################################################################## +@rem +@rem Gradle startup script for Windows +@rem +@rem ########################################################################## + +@rem Set local scope for the variables with windows NT shell +if "%OS%"=="Windows_NT" setlocal + +set DIRNAME=%~dp0 +if "%DIRNAME%"=="" set DIRNAME=. +@rem This is normally unused +set APP_BASE_NAME=%~n0 +set APP_HOME=%DIRNAME% + +@rem Resolve any "." and ".." in APP_HOME to make it shorter. +for %%i in ("%APP_HOME%") do set APP_HOME=%%~fi + +@rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. +set DEFAULT_JVM_OPTS="-Xmx64m" "-Xms64m" + +@rem Find java.exe +if defined JAVA_HOME goto findJavaFromJavaHome + +set JAVA_EXE=java.exe +%JAVA_EXE% -version >NUL 2>&1 +if %ERRORLEVEL% equ 0 goto execute + +echo. +echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. +echo. +echo Please set the JAVA_HOME variable in your environment to match the +echo location of your Java installation. + +goto fail + +:findJavaFromJavaHome +set JAVA_HOME=%JAVA_HOME:"=% +set JAVA_EXE=%JAVA_HOME%/bin/java.exe + +if exist "%JAVA_EXE%" goto execute + +echo. +echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME% +echo. +echo Please set the JAVA_HOME variable in your environment to match the +echo location of your Java installation. + +goto fail + +:execute +@rem Setup the command line + +set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar + + +@rem Execute Gradle +"%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %* + +:end +@rem End local scope for the variables with windows NT shell +if %ERRORLEVEL% equ 0 goto mainEnd + +:fail +rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of +rem the _cmd.exe /c_ return code! +set EXIT_CODE=%ERRORLEVEL% +if %EXIT_CODE% equ 0 set EXIT_CODE=1 +if not ""=="%GRADLE_EXIT_CONSOLE%" exit %EXIT_CODE% +exit /b %EXIT_CODE% + +:mainEnd +if "%OS%"=="Windows_NT" endlocal + +:omega diff --git a/packages/standalone-gradle-plugins/settings.gradle.kts b/packages/standalone-gradle-plugins/settings.gradle.kts new file mode 100644 index 00000000000000..5251ceaf59a4d7 --- /dev/null +++ b/packages/standalone-gradle-plugins/settings.gradle.kts @@ -0,0 +1,10 @@ +/* + * 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. + */ + +rootProject.name = "standalone-gradle-plugins" + +include("plugin") diff --git a/packages/standalone-gradle-plugins/src/main/kotlin/com/facebook/react/nodejsresolver/NodeJsResolverGradlePlugin.kt b/packages/standalone-gradle-plugins/src/main/kotlin/com/facebook/react/nodejsresolver/NodeJsResolverGradlePlugin.kt new file mode 100644 index 00000000000000..1e702a6d162852 --- /dev/null +++ b/packages/standalone-gradle-plugins/src/main/kotlin/com/facebook/react/nodejsresolver/NodeJsResolverGradlePlugin.kt @@ -0,0 +1,63 @@ +/* + * 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.nodejsresolver + +import groovy.lang.Closure +import java.io.File +import org.gradle.api.GradleException +import org.gradle.api.Plugin +import org.gradle.api.Project +import org.gradle.api.initialization.Settings +import org.gradle.api.plugins.ExtensionAware +import org.gradle.api.plugins.PluginAware + +class NodeJsResolverGradlePlugin : Plugin { + private tailrec fun resolvePackage(packageName: String, startDir: File): File { + val candidate = File(startDir, "node_modules/$packageName") + if (candidate.exists()) { + return candidate.canonicalFile + } + + val parentDir = startDir.parentFile + if (parentDir == null || startDir.canonicalPath == parentDir.canonicalPath) { + throw GradleException( + "Failed to find the package '$packageName'. Ensure you have installed node_modules.") + } + return resolvePackage(packageName, parentDir) + } + + override fun apply(target: PluginAware) { + if (target !is ExtensionAware) { + throw IllegalStateException( + "Unsupported plugin target: ${target.javaClass.name} is not ExtensionAware") + } + + val rootProjectDir = + when (target) { + is Settings -> target.rootProject.projectDir + is Project -> target.rootProject.projectDir + else -> + throw IllegalStateException( + "Unsupported plugin target: ${target.javaClass.name} is not Project or Settings") + } + + // For convenience and brevity from Groovy scripts, expose a global 'resolveNodePackage' + // closure via extensions.extraProperties + val resolveNodeJsPackageClosure = + object : Closure(this) { + fun doCall(packageName: String): File { + return resolvePackage(packageName, rootProjectDir) + } + + fun doCall(packageName: String, startDir: File): File { + return resolvePackage(packageName, startDir) + } + } + target.extensions.extraProperties["resolveNodeJsPackage"] = resolveNodeJsPackageClosure + } +} diff --git a/packages/standalone-gradle-plugins/src/test/kotlin/com/facebook/react/nodejsresolver/NodeJsResolverGradlePluginTest.kt b/packages/standalone-gradle-plugins/src/test/kotlin/com/facebook/react/nodejsresolver/NodeJsResolverGradlePluginTest.kt new file mode 100644 index 00000000000000..203ba6db80bc91 --- /dev/null +++ b/packages/standalone-gradle-plugins/src/test/kotlin/com/facebook/react/nodejsresolver/NodeJsResolverGradlePluginTest.kt @@ -0,0 +1,72 @@ +/* + * 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.nodejsresolver + +import groovy.lang.Closure +import java.io.File +import kotlin.test.Test +import kotlin.test.assertEquals +import kotlin.test.assertNotNull +import org.gradle.api.GradleException +import org.gradle.testfixtures.ProjectBuilder +import org.junit.jupiter.api.BeforeEach +import org.junit.jupiter.api.assertThrows + +class NodeJsResolverGradlePluginTest { + private lateinit var projectDir: File + private lateinit var resolveNodeJsPackage: Closure<*> + + @BeforeEach + fun setup() { + val resource = this::class.java.classLoader.getResource("package.json") + assertNotNull(resource) + projectDir = File(resource.toURI()).parentFile + val project = ProjectBuilder.builder().withProjectDir(projectDir).build() + project.plugins.apply("com.facebook.react.nodejsresolver") + assert(project.extensions.extraProperties.has("resolveNodeJsPackage")) + resolveNodeJsPackage = + project.extensions.extraProperties.get("resolveNodeJsPackage") as Closure<*> + } + + @Test + fun `resolves top-level packages as expected, with one argument`() { + assertEquals(resolveNodeJsPackage.call("foo"), File(projectDir, "node_modules/foo")) + assertEquals(resolveNodeJsPackage.call("bar"), File(projectDir, "node_modules/bar")) + } + + @Test + fun `does not resolve an isolated package from the top level`() { + val exception = assertThrows { resolveNodeJsPackage.call("baz") } + assertEquals( + exception.message, + "Failed to find the package 'baz'. Ensure you have installed node_modules.") + } + + @Test + fun `can resolve foo's isolated dependencies when starting from foo`() { + val fooDir = resolveNodeJsPackage.call("foo") + assertEquals( + resolveNodeJsPackage.call("baz", fooDir), + File(projectDir, "node_modules/foo/node_modules/baz")) + } + + @Test + fun `prefers closer bar to hosted bar when starting from foo`() { + val fooDir = resolveNodeJsPackage.call("foo") + assertEquals( + resolveNodeJsPackage.call("bar", fooDir), + File(projectDir, "node_modules/foo/node_modules/bar")) + } + + @Test + fun `can resolve a hoisted dependency starting from foo or root`() { + val fooDir = resolveNodeJsPackage.call("foo") + assertEquals(resolveNodeJsPackage.call("quux"), File(projectDir, "node_modules/quux")) + assertEquals(resolveNodeJsPackage.call("quux", fooDir), File(projectDir, "node_modules/quux")) + } +} diff --git a/packages/standalone-gradle-plugins/src/test/resources/package.json b/packages/standalone-gradle-plugins/src/test/resources/package.json new file mode 100644 index 00000000000000..c44aedb015e0ac --- /dev/null +++ b/packages/standalone-gradle-plugins/src/test/resources/package.json @@ -0,0 +1,3 @@ +{ + "name": "project" +}