software.amazon.smithy.lsp.FileWatcherRegistrations Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of smithy-language-server Show documentation
Language Server Protocol implementation for Smithy
The newest version!
/*
 * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 * SPDX-License-Identifier: Apache-2.0
 */

package software.amazon.smithy.lsp;

import java.nio.file.Path;
import java.util.Collection;
import java.util.Collections;
import java.util.List;
import org.eclipse.lsp4j.DidChangeWatchedFilesRegistrationOptions;
import org.eclipse.lsp4j.FileSystemWatcher;
import org.eclipse.lsp4j.Registration;
import org.eclipse.lsp4j.Unregistration;
import org.eclipse.lsp4j.WatchKind;
import org.eclipse.lsp4j.jsonrpc.messages.Either;
import software.amazon.smithy.lsp.project.Project;

/**
 * Handles computing the {@link Registration}s and {@link Unregistration}s for
 * that tell the client which files and directories to watch for changes
 *
 * The server needs to know when files are added or removed from the project's
 * sources or imports. Instead of watching the client's file system, we tell the
 * client to send us notifications when these events occur, so we can reload the
 * project.
 *
 * Clients don't de-duplicate file watchers, so we have to unregister all
 * file watchers before sending a new list to watch, or keep track of them to make
 * more granular changes. The current behavior is to just unregister and re-register
 * everything, since these events should be rarer. But we can optimize it in the
 * future.
 */
final class FileWatcherRegistrations {
    private static final Integer WATCH_FILE_KIND = WatchKind.Delete | WatchKind.Create;
    private static final String WATCH_BUILD_FILES_ID = "WatchSmithyBuildFiles";
    private static final String WATCH_SMITHY_FILES_ID = "WatchSmithyFiles";
    private static final String WATCH_FILES_METHOD = "workspace/didChangeWatchedFiles";
    private static final List SMITHY_FILE_WATCHER_UNREGISTRATIONS = List.of(new Unregistration(
            WATCH_SMITHY_FILES_ID,
            WATCH_FILES_METHOD));
    private static final List BUILD_FILE_WATCHER_UNREGISTRATIONS = List.of(new Unregistration(
            WATCH_BUILD_FILES_ID,
            WATCH_FILES_METHOD));

    private FileWatcherRegistrations() {
    }

    /**
     * Creates registrations to tell the client to watch for new or deleted
     * Smithy files, specifically for files that are part of {@link Project}s.
     *
     * @param projects The projects to get registrations for
     * @return The registrations to watch for Smithy file changes across all projects
     */
    static List getSmithyFileWatcherRegistrations(Collection projects) {
        List smithyFileWatchers = projects.stream()
                .flatMap(project -> FilePatterns.getSmithyFileWatchPatterns(project).stream())
                .map(pattern -> new FileSystemWatcher(Either.forLeft(pattern), WATCH_FILE_KIND))
                .toList();

        return Collections.singletonList(new Registration(
                WATCH_SMITHY_FILES_ID,
                WATCH_FILES_METHOD,
                new DidChangeWatchedFilesRegistrationOptions(smithyFileWatchers)));
    }

    /**
     * @return The unregistrations to stop watching for Smithy file changes
     */
    static List getSmithyFileWatcherUnregistrations() {
        return SMITHY_FILE_WATCHER_UNREGISTRATIONS;
    }

    /**
     * Creates registrations to tell the client to watch for any build file
     * creations or deletions, across all workspaces.
     *
     * @param workspaceRoots The roots of the workspaces to get registrations for
     * @return The registrations to watch for build file changes across all workspaces
     */
    static List getBuildFileWatcherRegistrations(Collection workspaceRoots) {
        List watchers = workspaceRoots.stream()
                .map(FilePatterns::getWorkspaceBuildFilesWatchPattern)
                .map(pattern -> new FileSystemWatcher(Either.forLeft(pattern), WATCH_FILE_KIND))
                .toList();

        return Collections.singletonList(new Registration(
                WATCH_BUILD_FILES_ID,
                WATCH_FILES_METHOD,
                new DidChangeWatchedFilesRegistrationOptions(watchers)));
    }

    /**
     * @return The unregistrations to stop watching for build file changes
     */
    static List getBuildFileWatcherUnregistrations() {
        return BUILD_FILE_WATCHER_UNREGISTRATIONS;
    }
}