Skip to content

Don't filter results when opening a codecompletion session #171

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

Merged
merged 1 commit into from
Jan 18, 2022
Merged
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
101 changes: 56 additions & 45 deletions SourceKitStressTester/Sources/StressTester/SourceKitDocument.swift
Original file line number Diff line number Diff line change
Expand Up @@ -232,60 +232,71 @@ class SourceKitDocument {
return 0
}

func codeComplete(offset: Int, expectedResult: ExpectedResult?) throws -> (request: RequestInfo, response: SourceKitdResponse, instructions: Int, reusingASTContext: Bool) {
/// Build the codecomplete.open or codecomplete.close request.
/// The two requests share the exact same options except for the request name.
private func buildCompletionRequest(request: SourceKitdUID, offset: Int, extraOptions: [String: String]) -> SourceKitdRequest {
let location = converter!.location(for: AbsolutePosition(utf8Offset: offset))

/// Build the codecomplete.open or codecomplete.close request.
/// The two requests share the exact same options except for the request name.
func buildCompletionRequest(request: SourceKitdUID) -> SourceKitdRequest {
let request = SourceKitdRequest(uid: request)
request.addParameter(.key_SourceFile, value: args.forFile.path)
request.addParameter(.key_Name, value: args.forFile.path)
if let sourceState = sourceState {
request.addParameter(.key_SourceText, value: sourceState.source)
}
request.addParameter(.key_Offset, value: offset)
request.addParameter(.key_Line, value: location.line!)
request.addParameter(.key_Column, value: location.column!)
request.addCompilerArgs(args.sourcekitdArgs)

let completionOptions = request.addDictionaryParameter(.key_CodeCompleteOptions)
// Don't hide any results because otherwise checking if the expected result is contained will fail
completionOptions.add(.key_HideLowPriority, value: 0)
completionOptions.add(.key_HideByName, value: 0)
completionOptions.add(.key_HideUnderscores, value: 0)

// Set expected results to 200 to avoid inflating the time measurements by serialization time.
// To make sure that the expected result is in the results, filter by its base name.
completionOptions.add(.key_RequestLimit, value: 200)
if let expectedResult = expectedResult {
completionOptions.add(.key_FilterText, value: expectedResult.name.base)
}

for (option, value) in extraCodeCompleteOptions {
if let intValue = Int(value) {
completionOptions.add(SourceKitdUID(string: "key.codecomplete.\(option)"), value: intValue)
} else {
completionOptions.add(SourceKitdUID(string: "key.codecomplete.\(option)"), value: value)
}
let request = SourceKitdRequest(uid: request)
request.addParameter(.key_SourceFile, value: args.forFile.path)
request.addParameter(.key_Name, value: args.forFile.path)
if let sourceState = sourceState {
request.addParameter(.key_SourceText, value: sourceState.source)
}
request.addParameter(.key_Offset, value: offset)
request.addParameter(.key_Line, value: location.line!)
request.addParameter(.key_Column, value: location.column!)
request.addCompilerArgs(args.sourcekitdArgs)

let completionOptions = request.addDictionaryParameter(.key_CodeCompleteOptions)
// Don't hide any results because otherwise checking if the expected result is contained will fail
completionOptions.add(.key_HideLowPriority, value: 0)
completionOptions.add(.key_HideByName, value: 0)
completionOptions.add(.key_HideUnderscores, value: 0)

// Set expected results to 200 to avoid inflating the time measurements by serialization time.
// To make sure that the expected result is in the results, filter by its base name.
Comment on lines +257 to +258
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Comment is out of date

completionOptions.add(.key_RequestLimit, value: 200)

for (option, value) in extraOptions {
if let intValue = Int(value) {
completionOptions.add(SourceKitdUID(string: "key.codecomplete.\(option)"), value: intValue)
} else {
completionOptions.add(SourceKitdUID(string: "key.codecomplete.\(option)"), value: value)
}
return request
}
return request
}

let request = buildCompletionRequest(request: .request_CodeCompleteOpen)
let info = RequestInfo.codeCompleteOpen(document: documentInfo, offset: offset,
args: args.sourcekitdArgs)
let (response, instructions) = try sendWithTimeoutMeasuringInstructions(request, info: info) { response in
if let expectedResult = expectedResult {
try checkExpectedCompletionResult(expectedResult, in: response, info: info)
func codeComplete(offset: Int, expectedResult: ExpectedResult?) throws -> (request: RequestInfo, response: SourceKitdResponse, instructions: Int, reusingASTContext: Bool) {
var responseToReport: SourceKitdResponse
let openRequest = buildCompletionRequest(request: .request_CodeCompleteOpen, offset: offset, extraOptions: extraCodeCompleteOptions)
let openInfo = RequestInfo.codeCompleteOpen(document: documentInfo, offset: offset,
args: args.sourcekitdArgs)
let (openResponse, openInstructions) = try sendWithTimeoutMeasuringInstructions(openRequest, info: openInfo)

let reusingASTContext = openResponse.value.getBool(.key_ReusingASTContext)

if let expectedResult = expectedResult {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Will be interesting to see how much slower the extra request makes it.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would expect that the update should be pretty fast, but let’s see. I started a stress tester run via swiftlang/swift#37710.

var updateOptions = extraCodeCompleteOptions

updateOptions["filtertext"] = expectedResult.name.base

let updateRequest = buildCompletionRequest(request: .request_CodeCompleteUpdate, offset: offset, extraOptions: updateOptions)
let updateInfo = RequestInfo.codeCompleteOpen(document: documentInfo, offset: offset, args: args.sourcekitdArgs)
let updateResponse = try sendWithTimeout(updateRequest, info: updateInfo) { response in
try checkExpectedCompletionResult(expectedResult, in: response, info: openInfo)
}
responseToReport = updateResponse
} else {
responseToReport = openResponse
}
let reusingASTContext = response.value.getBool(.key_ReusingASTContext)

let closeSession = buildCompletionRequest(request: .request_CodeCompleteClose)
_ = try sendWithTimeout(closeSession, info: RequestInfo.codeCompleteClose(document: documentInfo, offset: offset))
let closeRequest = buildCompletionRequest(request: .request_CodeCompleteClose, offset: offset, extraOptions: extraCodeCompleteOptions)
let closeInfo = RequestInfo.codeCompleteClose(document: documentInfo, offset: offset)
_ = try sendWithTimeout(closeRequest, info: closeInfo)

return (info, response, instructions, reusingASTContext)
return (openInfo, responseToReport, openInstructions, reusingASTContext)
}

func typeContextInfo(offset: Int) throws -> (RequestInfo, SourceKitdResponse) {
Expand Down