Merge pull request #53 from disneystreaming/main-into-dss-2024-07

Pull upstream changes

Author: kubukoz

.github/workflows/ci.yml

@@ -10,9 +10,10 @@ on:
 jobs:
   build:
     strategy:
+      fail-fast: false
       matrix:
         java: [8, 11, 17]
-        os: [ubuntu-latest, windows-latest, macos-latest]
+        os: [ubuntu-latest, windows-latest, macos-13]
 
     runs-on: ${{ matrix.os }}
     name: Java ${{ matrix.java }} ${{ matrix.os }}

VERSION

@@ -1 +1 @@
-0.2.4
+0.3.0

build.gradle

@@ -156,21 +156,25 @@ publishing {
 
 
 dependencies {
-    implementation "org.eclipse.lsp4j:org.eclipse.lsp4j:0.14.0"
+    implementation "org.eclipse.lsp4j:org.eclipse.lsp4j:0.20.0"
     implementation "software.amazon.smithy:smithy-build:[smithyVersion, 2.0["
     implementation "software.amazon.smithy:smithy-cli:[smithyVersion, 2.0["
     implementation "software.amazon.smithy:smithy-model:[smithyVersion, 2.0["
-    implementation 'com.disneystreaming.smithy:smithytranslate-formatter-jvm-java-api:0.3.10'
+    implementation "software.amazon.smithy:smithy-syntax:[smithyVersion, 2.0["
 
-    // Use JUnit test framework
-    testImplementation "junit:junit:4.13"
+    testImplementation "org.junit.jupiter:junit-jupiter:5.10.0"
+    testImplementation "org.hamcrest:hamcrest:2.1"
+
+    testRuntimeOnly "org.junit.platform:junit-platform-launcher"
 }
 
 tasks.withType(Javadoc).all {
     options.addStringOption('Xdoclint:none', '-quiet')
 }
 
-tasks.withType(Test) {
+tasks.withType(Test).configureEach {
+    useJUnitPlatform()
+
     testLogging {
         events TestLogEvent.PASSED, TestLogEvent.SKIPPED, TestLogEvent.FAILED, TestLogEvent.STANDARD_OUT, TestLogEvent.STANDARD_ERROR
         exceptionFormat TestExceptionFormat.FULL
@@ -180,7 +184,8 @@ tasks.withType(Test) {
     }
 }
 
-task createProperties(dependsOn: processResources) {
+tasks.register('createProperties') {
+    dependsOn processResources
     doLast {
         new File("$buildDir/resources/main/version.properties").withWriter { w ->
             Properties p = new Properties()
@@ -196,13 +201,15 @@ classes {
 
 application {
     // Define the main class for the application.
-    mainClassName = "software.amazon.smithy.lsp.Main"
+    mainClass = "software.amazon.smithy.lsp.Main"
 }
 
 // ==== CheckStyle ====
 // https://docs.gradle.org/current/userguide/checkstyle_plugin.html
 apply plugin: "checkstyle"
-tasks["checkstyleTest"].enabled = false
+tasks.named("checkstyleTest") {
+    enabled = false
+}
 
 java {
     sourceCompatibility = JavaVersion.VERSION_1_8
@@ -213,6 +220,7 @@ jar {
     from (configurations.compileClasspath.collect { entry -> zipTree(entry) }) {
         exclude "about.html"
         exclude "META-INF/LICENSE"
+        exclude "META-INF/LICENSE.txt"
         exclude "META-INF/NOTICE"
         exclude "META-INF/MANIFEST.MF"
         exclude "META-INF/*.SF"

build.sc

@@ -8,11 +8,11 @@ object lsp extends MavenModule with PublishModule {
   def millSourcePath: os.Path = os.pwd
 
   def ivyDeps = Agg(
-    ivy"org.eclipse.lsp4j:org.eclipse.lsp4j:0.14.0",
-    ivy"software.amazon.smithy:smithy-model:1.45.0",
-    ivy"software.amazon.smithy:smithy-build:1.45.0",
-    ivy"software.amazon.smithy:smithy-cli:1.45.0",
-    ivy"com.disneystreaming.smithy:smithytranslate-formatter-jvm-java-api:0.3.10"
+    ivy"org.eclipse.lsp4j:org.eclipse.lsp4j:0.20.0",
+    ivy"software.amazon.smithy:smithy-build:1.46.0",
+    ivy"software.amazon.smithy:smithy-cli:1.46.0",
+    ivy"software.amazon.smithy:smithy-model:1.46.0",
+    ivy"software.amazon.smithy:smithy-syntax:1.46.0"
   )
 
   def publishVersion = T { gitVersion() }

config/checkstyle/checkstyle.xml

@@ -68,7 +68,7 @@
         <!-- Checks for Javadoc comments.                     -->
         <!-- See http://checkstyle.sf.net/config_javadoc.html -->
         <module name="JavadocMethod">
-            <property name="scope" value="public"/>
+            <property name="accessModifiers" value="public"/>
             <property name="allowMissingParamTags" value="true"/>
             <property name="allowMissingReturnTag" value="true"/>
             <property name="allowedAnnotations" value="Override, Test"/>

gradle.properties

@@ -1 +1 @@
-smithyVersion=1.45.0
+smithyVersion=1.46.0

gradle/wrapper/gradle-wrapper.jar

@@ -1,5 +1,7 @@
 distributionBase=GRADLE_USER_HOME
 distributionPath=wrapper/dists
-distributionUrl=https\://services.gradle.org/distributions/gradle-7.4.1-bin.zip
+distributionUrl=https\://services.gradle.org/distributions/gradle-8.9-bin.zip
+networkTimeout=10000
+validateDistributionUrl=true
 zipStoreBase=GRADLE_USER_HOME
 zipStorePath=wrapper/dists

gradle/wrapper/gradle-wrapper.properties

@@ -15,6 +15,8 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 #
+# SPDX-License-Identifier: Apache-2.0
+#
 
 ##############################################################################
 #
@@ -55,7 +57,7 @@
 #       Darwin, MinGW, and NonStop.
 #
 #   (3) This script is generated from the Groovy template
-#       https://github.com/gradle/gradle/blob/master/subprojects/plugins/src/main/resources/org/gradle/api/internal/plugins/unixStartScript.txt
+#       https://github.com/gradle/gradle/blob/HEAD/platforms/jvm/plugins-application/src/main/resources/org/gradle/api/internal/plugins/unixStartScript.txt
 #       within the Gradle project.
 #
 #       You can find Gradle at https://github.com/gradle/gradle/.
@@ -80,13 +82,12 @@ do
     esac
 done
 
-APP_HOME=$( cd "${APP_HOME:-./}" && pwd -P ) || exit
-
-APP_NAME="Gradle"
+# This is normally unused
+# shellcheck disable=SC2034
 APP_BASE_NAME=${0##*/}
-
-# 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"'
+# Discard cd standard output in case $CDPATH is set (https://github.com/gradle/gradle/issues/25036)
+APP_HOME=$( cd -P "${APP_HOME:-./}" > /dev/null && printf '%s
+' "$PWD" ) || exit
 
 # Use the maximum available, or set MAX_FD != -1 to use that value.
 MAX_FD=maximum
@@ -133,22 +134,29 @@ location of your Java installation."
     fi
 else
     JAVACMD=java
-    which java >/dev/null 2>&1 || die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH.
+    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
@@ -193,18 +201,28 @@ if "$cygwin" || "$msys" ; then
     done
 fi
 
-# Collect all arguments for the java command;
-#   * $DEFAULT_JVM_OPTS, $JAVA_OPTS, and $GRADLE_OPTS can contain fragments of
-#     shell script including quotes and variable substitutions, so put them in
-#     double quotes to make sure that they get re-expanded; and
-#   * put everything else in single quotes, so that it's not re-expanded.
+
+# 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.

gradlew

@@ -13,8 +13,10 @@
 @rem See the License for the specific language governing permissions and
 @rem limitations under the License.
 @rem
+@rem SPDX-License-Identifier: Apache-2.0
+@rem
 
-@if "%DEBUG%" == "" @echo off
+@if "%DEBUG%"=="" @echo off
 @rem ##########################################################################
 @rem
 @rem  Gradle startup script for Windows
@@ -25,7 +27,8 @@
 if "%OS%"=="Windows_NT" setlocal
 
 set DIRNAME=%~dp0
-if "%DIRNAME%" == "" set DIRNAME=.
+if "%DIRNAME%"=="" set DIRNAME=.
+@rem This is normally unused
 set APP_BASE_NAME=%~n0
 set APP_HOME=%DIRNAME%
 
@@ -40,13 +43,13 @@ if defined JAVA_HOME goto findJavaFromJavaHome
 
 set JAVA_EXE=java.exe
 %JAVA_EXE% -version >NUL 2>&1
-if "%ERRORLEVEL%" == "0" goto execute
+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.
+echo. 1>&2
+echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. 1>&2
+echo. 1>&2
+echo Please set the JAVA_HOME variable in your environment to match the 1>&2
+echo location of your Java installation. 1>&2
 
 goto fail
 
@@ -56,11 +59,11 @@ 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.
+echo. 1>&2
+echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME% 1>&2
+echo. 1>&2
+echo Please set the JAVA_HOME variable in your environment to match the 1>&2
+echo location of your Java installation. 1>&2
 
 goto fail
 
@@ -75,13 +78,15 @@ set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar
 
 :end
 @rem End local scope for the variables with windows NT shell
-if "%ERRORLEVEL%"=="0" goto mainEnd
+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!
-if  not "" == "%GRADLE_EXIT_CONSOLE%" exit 1
-exit /b 1
+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

gradlew.bat

@@ -0,0 +1,73 @@
+/*
+ * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+package software.amazon.smithy.lsp;
+
+import java.util.HashMap;
+import java.util.HashSet;
+import java.util.Map;
+import java.util.Set;
+import java.util.concurrent.CompletableFuture;
+import java.util.concurrent.ExecutionException;
+import java.util.logging.Logger;
+
+/**
+ * Tracks asynchronous lifecycle tasks and client-managed documents.
+ * Allows cancelling of an ongoing task if a new task needs to be started.
+ */
+final class DocumentLifecycleManager {
+    private static final Logger LOGGER = Logger.getLogger(DocumentLifecycleManager.class.getName());
+    private final Map<String, CompletableFuture<Void>> tasks = new HashMap<>();
+    private final Set<String> managedDocumentUris = new HashSet<>();
+
+    Set<String> managedDocuments() {
+        return managedDocumentUris;
+    }
+
+    boolean isManaged(String uri) {
+        return managedDocuments().contains(uri);
+    }
+
+    CompletableFuture<Void> getTask(String uri) {
+        return tasks.get(uri);
+    }
+
+    void cancelTask(String uri) {
+        if (tasks.containsKey(uri)) {
+            CompletableFuture<Void> task = tasks.get(uri);
+            if (!task.isDone()) {
+                task.cancel(true);
+                tasks.remove(uri);
+            }
+        }
+    }
+
+    void putTask(String uri, CompletableFuture<Void> future) {
+        tasks.put(uri, future);
+    }
+
+    void putOrComposeTask(String uri, CompletableFuture<Void> future) {
+        if (tasks.containsKey(uri)) {
+            tasks.computeIfPresent(uri, (k, v) -> v.thenCompose((unused) -> future));
+        } else {
+            tasks.put(uri, future);
+        }
+    }
+
+    void cancelAllTasks() {
+        for (CompletableFuture<Void> task : tasks.values()) {
+            task.cancel(true);
+        }
+        tasks.clear();
+    }
+
+    void waitForAllTasks() throws ExecutionException, InterruptedException {
+        for (CompletableFuture<Void> task : tasks.values()) {
+            if (!task.isDone()) {
+                task.get();
+            }
+        }
+    }
+}