Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix loading type definitions that rely on mutation #745

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,11 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).

## [Unreleased]

### Fixed

- Fixed a regression in 1.30.0 breaking type definitions files that rely on mutations like `Enum.Foo`
([#658](https://github.com/JohnnyMorganz/luau-lsp/issues/658))

## [1.32.3] - 2024-08-10

### Fixed
Expand Down
2 changes: 0 additions & 2 deletions src/LanguageServer.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -570,12 +570,10 @@ void LanguageServer::onInitialized([[maybe_unused]] const lsp::InitializedParams
// causing us to fall back to the global configuration. Sending the request for configuration
// first means we receive the user config before processing the first LSP events
client->sendTrace("initializing null workspace");
nullWorkspace->initialize();
nullWorkspace->setupWithConfiguration(client->globalConfig);
for (auto& folder : workspaceFolders)
{
client->sendTrace("initializing workspace: " + folder->rootUri.toString());
folder->initialize();
// Client does not support retrieving configuration information, so we just setup the workspaces with the default, global, configuration
if (!requestedConfiguration)
folder->setupWithConfiguration(client->globalConfig);
Expand Down
14 changes: 8 additions & 6 deletions src/Workspace.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -278,7 +278,7 @@ void WorkspaceFolder::indexFiles(const ClientConfiguration& config)
client->sendTrace("workspace: indexing all files COMPLETED");
}

void WorkspaceFolder::initialize()
void WorkspaceFolder::registerTypes()
{
client->sendTrace("workspace initialization: registering Luau globals");
Luau::registerBuiltinGlobals(frontend, frontend.globals, /* typeCheckForAutocomplete = */ false);
Expand All @@ -304,7 +304,8 @@ void WorkspaceFolder::initialize()

// Parse definitions file metadata
client->sendTrace("workspace initialization: parsing definitions file metadata");
if (auto metadata = types::parseDefinitionsFileMetadata(*definitionsContents))
auto metadata = types::parseDefinitionsFileMetadata(*definitionsContents);
if (!definitionsFileMetadata)
definitionsFileMetadata = metadata;
client->sendTrace("workspace initialization: parsing definitions file metadata COMPLETED", json(definitionsFileMetadata).dump());

Expand All @@ -313,6 +314,10 @@ void WorkspaceFolder::initialize()
types::registerDefinitions(frontend, frontend.globalsForAutocomplete, *definitionsContents, /* typeCheckForAutocomplete = */ true);
client->sendTrace("workspace initialization: registering types definition COMPLETED");

client->sendTrace("workspace: applying platform mutations on definitions");
platform->mutateRegisteredDefinitions(frontend.globals, metadata);
platform->mutateRegisteredDefinitions(frontend.globalsForAutocomplete, metadata);

auto uri = Uri::file(resolvedFilePath);

if (result.success)
Expand Down Expand Up @@ -357,10 +362,7 @@ void WorkspaceFolder::setupWithConfiguration(const ClientConfiguration& configur
platform = LSPPlatform::getPlatform(configuration, &fileResolver, this);
fileResolver.platform = platform.get();

client->sendTrace("workspace: applying platform mutations on definitions");

platform->mutateRegisteredDefinitions(frontend.globals, definitionsFileMetadata);
platform->mutateRegisteredDefinitions(frontend.globalsForAutocomplete, definitionsFileMetadata);
registerTypes();
voidedWarranties marked this conversation as resolved.
Show resolved Hide resolved
}

client->sendTrace("workspace: apply platform-specific configuration");
Expand Down
4 changes: 1 addition & 3 deletions src/include/LSP/Workspace.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -52,9 +52,6 @@ class WorkspaceFolder
fileResolver.rootUri = uri;
}

// Initialises the workspace folder
void initialize();

// Sets up the workspace folder after receiving configuration information
void setupWithConfiguration(const ClientConfiguration& configuration);

Expand Down Expand Up @@ -87,6 +84,7 @@ class WorkspaceFolder
const Luau::ModulePtr getModule(const Luau::ModuleName& moduleName, bool forAutocomplete = false) const;

private:
void registerTypes();
void endAutocompletion(const lsp::CompletionParams& params);
void suggestImports(const Luau::ModuleName& moduleName, const Luau::Position& position, const ClientConfiguration& config,
const TextDocument& textDocument, std::vector<lsp::CompletionItem>& result, bool completingTypeReferencePrefix = true);
Expand Down
2 changes: 0 additions & 2 deletions tests/Fixture.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -18,8 +18,6 @@ Fixture::Fixture()
workspace.fileResolver.defaultConfig.mode = Luau::Mode::Strict;
client->definitionsFiles.push_back("./tests/testdata/standard_definitions.d.luau");

workspace.initialize();

ClientConfiguration config;
config.sourcemap.enabled = false;
config.index.enabled = false;
Expand Down
Loading