Skip to content

Commit

Permalink
Implement hover, completions and signature help.
Browse files Browse the repository at this point in the history 
This is a large commit that adds new infrastructure to use the Scala
presentation compiler for interactive features like completions and
"show type".

This commit implements several features together because we could have
used a simpler architecture if we for example only implemented hover
first. That architecture would then need to be redesigned as we
implemented more features. Instead, by implmenting several features
together we reach the final design faster.

Features
--------

The presentation compiler provides decent APIs to implement hover and
completions. We make a few customizations:

- signature help is implemented from scratch using a custom tree traverser
  to track the active argument tree, including named arguments.
- scope completions perform a workspace/symbol search for symbols that
  are not in scope.
- we use our own fuzzy string matcher so for example `uService<TAB>`
  matches `userDatabaseService`.
- Java and Scala docstrings are extracted from library dependency
  sources.
- we have a custom signature printer that implements several niceties:
  - fully qualified types are shortened so they are easier to read, take
  up less space.
  - Java parameter names are extracted from library source code to avoid
  method signatures with parameters named `x$1`. A lot of Java code
  (including the JDK) is not compiled with -parameter so the only way to
  recover the parameter names is from source code.
  - Scala parameter default values are extracted from source when
  possible, for example `Iterator.sliding(size: Int, step: Int = 1)`
  instead of `Iterator.sliding(size: Int, step: Int = {})`.

Performance
-----------

It costs around 150-250ms to start a new presentation compiler, which
happens every time a build target has finished compilation.

Benchmarks show that a warmed up presentation compiler responds
comfortably within 100ms even for large source files with 7k lines of
code. I suspect the performance is slower for macro-heavy code, but
I was nevertheless impressed by the performance in the cases I tried.

Build changes
-------------

The following projects have been added to the sbt build:
- `pc-interfaces` module that is a pure Java API enabling Metals
  to communicate with the 2.11/2.12 compiler via reflection.
- `pc` module that is cross-built against exact Scala compiler
  versions and implements the `pc-interfaces` Java APIs, support both
  Scala 2.11 and 2.12.
- internal `cross` module that is used for testing 2.11/2.12
  cross-built modules like `pc`.
- internal `mtest` module that is used for sharing testing
  infrastructure between 2.11 and 2.12.

The implementation for workspace/symbol has moved from the `metals`
project into the `pc` project to facilitate testing on 2.11.
  • Loading branch information
@olafurpg
olafurpg committed Mar 7, 2019
1 parent c0a1330 commit 80341b7
Show file tree
Hide file tree
Showing 112 changed files with 8,191 additions and 453 deletions.
2 changes: 1 addition & 1 deletion .jvmopts
View file
@@ -1,6 +1,6 @@
-Xss4m
-Xms1G
-Xmx4G
-Xmx5G
-XX:ReservedCodeCacheSize=1024m
-XX:+TieredCompilation
-XX:+CMSClassUnloadingEnabled
Expand Down
1 change: 1 addition & 0 deletions .scalafmt.conf
View file
Expand Up @@ -13,6 +13,7 @@ To fix this problem:

project.excludeFilters = [
"test-workspace"
"metals-bench/src/main/resources"
"tests/unit/src/test/resources"
"sbt-metals/src/sbt-test"
]
218 changes: 218 additions & 0 deletions NOTICE.md
View file
Expand Up @@ -242,3 +242,221 @@ LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
```

# License notice for Akka
Metals contains parts which are derived from
[the akka project](https://github.com/akka/akka). We
include the text of the original license below:

```
Apache License
Version 2.0, January 2004
http://www.apache.org/licenses/
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
1. Definitions.
"License" shall mean the terms and conditions for use, reproduction,
and distribution as defined by Sections 1 through 9 of this document.
"Licensor" shall mean the copyright owner or entity authorized by
the copyright owner that is granting the License.
"Legal Entity" shall mean the union of the acting entity and all
other entities that control, are controlled by, or are under common
control with that entity. For the purposes of this definition,
"control" means (i) the power, direct or indirect, to cause the
direction or management of such entity, whether by contract or
otherwise, or (ii) ownership of fifty percent (50%) or more of the
outstanding shares, or (iii) beneficial ownership of such entity.
"You" (or "Your") shall mean an individual or Legal Entity
exercising permissions granted by this License.
"Source" form shall mean the preferred form for making modifications,
including but not limited to software source code, documentation
source, and configuration files.
"Object" form shall mean any form resulting from mechanical
transformation or translation of a Source form, including but
not limited to compiled object code, generated documentation,
and conversions to other media types.
"Work" shall mean the work of authorship, whether in Source or
Object form, made available under the License, as indicated by a
copyright notice that is included in or attached to the work
(an example is provided in the Appendix below).
"Derivative Works" shall mean any work, whether in Source or Object
form, that is based on (or derived from) the Work and for which the
editorial revisions, annotations, elaborations, or other modifications
represent, as a whole, an original work of authorship. For the purposes
of this License, Derivative Works shall not include works that remain
separable from, or merely link (or bind by name) to the interfaces of,
the Work and Derivative Works thereof.
"Contribution" shall mean any work of authorship, including
the original version of the Work and any modifications or additions
to that Work or Derivative Works thereof, that is intentionally
submitted to Licensor for inclusion in the Work by the copyright owner
or by an individual or Legal Entity authorized to submit on behalf of
the copyright owner. For the purposes of this definition, "submitted"
means any form of electronic, verbal, or written communication sent
to the Licensor or its representatives, including but not limited to
communication on electronic mailing lists, source code control systems,
and issue tracking systems that are managed by, or on behalf of, the
Licensor for the purpose of discussing and improving the Work, but
excluding communication that is conspicuously marked or otherwise
designated in writing by the copyright owner as "Not a Contribution."
"Contributor" shall mean Licensor and any individual or Legal Entity
on behalf of whom a Contribution has been received by Licensor and
subsequently incorporated within the Work.
2. Grant of Copyright License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
copyright license to reproduce, prepare Derivative Works of,
publicly display, publicly perform, sublicense, and distribute the
Work and such Derivative Works in Source or Object form.
3. Grant of Patent License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
(except as stated in this section) patent license to make, have made,
use, offer to sell, sell, import, and otherwise transfer the Work,
where such license applies only to those patent claims licensable
by such Contributor that are necessarily infringed by their
Contribution(s) alone or by combination of their Contribution(s)
with the Work to which such Contribution(s) was submitted. If You
institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct
or contributory patent infringement, then any patent licenses
granted to You under this License for that Work shall terminate
as of the date such litigation is filed.
4. Redistribution. You may reproduce and distribute copies of the
Work or Derivative Works thereof in any medium, with or without
modifications, and in Source or Object form, provided that You
meet the following conditions:
(a) You must give any other recipients of the Work or
Derivative Works a copy of this License; and
(b) You must cause any modified files to carry prominent notices
stating that You changed the files; and
(c) You must retain, in the Source form of any Derivative Works
that You distribute, all copyright, patent, trademark, and
attribution notices from the Source form of the Work,
excluding those notices that do not pertain to any part of
the Derivative Works; and
(d) If the Work includes a "NOTICE" text file as part of its
distribution, then any Derivative Works that You distribute must
include a readable copy of the attribution notices contained
within such NOTICE file, excluding those notices that do not
pertain to any part of the Derivative Works, in at least one
of the following places: within a NOTICE text file distributed
as part of the Derivative Works; within the Source form or
documentation, if provided along with the Derivative Works; or,
within a display generated by the Derivative Works, if and
wherever such third-party notices normally appear. The contents
of the NOTICE file are for informational purposes only and
do not modify the License. You may add Your own attribution
notices within Derivative Works that You distribute, alongside
or as an addendum to the NOTICE text from the Work, provided
that such additional attribution notices cannot be construed
as modifying the License.
You may add Your own copyright statement to Your modifications and
may provide additional or different license terms and conditions
for use, reproduction, or distribution of Your modifications, or
for any such Derivative Works as a whole, provided Your use,
reproduction, and distribution of the Work otherwise complies with
the conditions stated in this License.
5. Submission of Contributions. Unless You explicitly state otherwise,
any Contribution intentionally submitted for inclusion in the Work
by You to the Licensor shall be under the terms and conditions of
this License, without any additional terms or conditions.
Notwithstanding the above, nothing herein shall supersede or modify
the terms of any separate license agreement you may have executed
with Licensor regarding such Contributions.
6. Trademarks. This License does not grant permission to use the trade
names, trademarks, service marks, or product names of the Licensor,
except as required for reasonable and customary use in describing the
origin of the Work and reproducing the content of the NOTICE file.
7. Disclaimer of Warranty. Unless required by applicable law or
agreed to in writing, Licensor provides the Work (and each
Contributor provides its Contributions) on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
implied, including, without limitation, any warranties or conditions
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
PARTICULAR PURPOSE. You are solely responsible for determining the
appropriateness of using or redistributing the Work and assume any
risks associated with Your exercise of permissions under this License.
8. Limitation of Liability. In no event and under no legal theory,
whether in tort (including negligence), contract, or otherwise,
unless required by applicable law (such as deliberate and grossly
negligent acts) or agreed to in writing, shall any Contributor be
liable to You for damages, including any direct, indirect, special,
incidental, or consequential damages of any character arising as a
result of this License or out of the use or inability to use the
Work (including but not limited to damages for loss of goodwill,
work stoppage, computer failure or malfunction, or any and all
other commercial damages or losses), even if such Contributor
has been advised of the possibility of such damages.
9. Accepting Warranty or Additional Liability. While redistributing
the Work or Derivative Works thereof, You may choose to offer,
and charge a fee for, acceptance of support, warranty, indemnity,
or other liability obligations and/or rights consistent with this
License. However, in accepting such obligations, You may act only
on Your own behalf and on Your sole responsibility, not on behalf
of any other Contributor, and only if You agree to indemnify,
defend, and hold each Contributor harmless for any liability
incurred by, or claims asserted against, such Contributor by reason
of your accepting any such warranty or additional liability.
END OF TERMS AND CONDITIONS
APPENDIX: How to apply the Apache License to your work.
To apply the Apache License to your work, attach the following
boilerplate notice, with the fields enclosed by brackets "[]"
replaced with your own identifying information. (Don't include
the brackets!) The text should be enclosed in the appropriate
comment syntax for the file format. We also recommend that a
file or class name and description of purpose be included on the
same "printed page" as the copyright notice for easier
identification within third-party archives.
Copyright [yyyy] [name of copyright owner]
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
http://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.
---------------
Licenses for dependency projects can be found here:
[http://akka.io/docs/akka/snapshot/project/licenses.html]
---------------
akka-protobuf contains the sources of Google protobuf 2.5.0 runtime support,
moved into the source package `akka.protobuf` so as to avoid version conflicts.
For license information see COPYING.protobuf
```
63 changes: 60 additions & 3 deletions build.sbt
View file
@@ -1,8 +1,9 @@
def localSnapshotVersion = "0.5.0-SNAPSHOT"
def isCI = System.getProperty("CI") != null
inThisBuild(
List(
version ~= { dynVer =>
if (sys.env.contains("CI")) dynVer
if (isCI) dynVer
else localSnapshotVersion // only for local publishng
},
scalaVersion := V.scala212,
Expand Down Expand Up @@ -82,6 +83,7 @@ inThisBuild(
)

cancelable.in(Global) := true
crossScalaVersions := Nil

addCommandAlias("scalafixAll", "all compile:scalafix test:scalafix")
addCommandAlias("scalafixCheck", "; scalafix --check ; test:scalafix --check")
Expand Down Expand Up @@ -111,8 +113,36 @@ lazy val V = new {

skip.in(publish) := true

lazy val interfaces = project
.in(file("pc/interfaces"))
.settings(
moduleName := "pc-interfaces",
autoScalaLibrary := false,
libraryDependencies ++= List(
"org.eclipse.lsp4j" % "org.eclipse.lsp4j" % "0.5.0"
),
crossVersion := CrossVersion.disabled
)
lazy val pc = project
.in(file("pc/core"))
.settings(
moduleName := "pc",
crossVersion := CrossVersion.full,
crossScalaVersions := List(V.scala212, V.scala211),
libraryDependencies ++= {
if (isCI) Nil
else List("com.lihaoyi" %% "pprint" % "0.5.3")
},
libraryDependencies ++= List(
"org.scala-lang" % "scala-compiler" % scalaVersion.value,
"org.scalameta" % "semanticdb-scalac-core" % V.scalameta cross CrossVersion.full
)
)
.dependsOn(interfaces, mtags)

lazy val mtags = project
.settings(
moduleName := "mtags",
crossScalaVersions := List(V.scala212, V.scala211),
libraryDependencies ++= List(
"com.thoughtworks.qdox" % "qdox" % "2.0-M9", // for java mtags
Expand Down Expand Up @@ -191,7 +221,7 @@ lazy val metals = project
"scala212" -> V.scala212
)
)
.dependsOn(mtags)
.dependsOn(pc, mtags)
.enablePlugins(BuildInfoPlugin)

lazy val `sbt-metals` = project
Expand Down Expand Up @@ -229,6 +259,7 @@ lazy val input = project
"org.scalameta" %% "scalameta" % V.scalameta,
"io.circe" %% "circe-derivation-annotations" % "0.9.0-M5"
),
scalacOptions += "-P:semanticdb:synthetics:on",
addCompilerPlugin(
"org.scalamacros" % "paradise" % "2.1.0" cross CrossVersion.full
)
Expand All @@ -240,6 +271,32 @@ lazy val testSettings: Seq[Def.Setting[_]] = List(
testFrameworks := List(new TestFramework("utest.runner.Framework"))
)

lazy val mtest = project
.in(file("tests/mtest"))
.settings(
skip.in(publish) := true,
crossScalaVersions := List(V.scala212, V.scala211),
libraryDependencies ++= List(
"com.geirsson" %% "coursier-small" % "1.3.3",
"org.scalameta" %% "testkit" % V.scalameta,
"com.lihaoyi" %% "utest" % "0.6.0"
),
buildInfoPackage := "tests",
buildInfoObject := "BuildInfoVersions",
buildInfoKeys := Seq[BuildInfoKey](
"scala211" -> V.scala211,
"scala212" -> V.scala212
)
)
.enablePlugins(BuildInfoPlugin)

lazy val cross = project
.in(file("tests/cross"))
.settings(
testSettings,
crossScalaVersions := V.supportedScalaVersions
)
.dependsOn(mtest, pc)
lazy val unit = project
.in(file("tests/unit"))
.settings(
Expand All @@ -262,7 +319,7 @@ lazy val unit = project
"testResourceDirectory" -> resourceDirectory.in(Test).value
)
)
.dependsOn(metals)
.dependsOn(mtest, metals, pc)
.enablePlugins(BuildInfoPlugin)
lazy val slow = project
.in(file("tests/slow"))
Expand Down
15 changes: 15 additions & 0 deletions metals-bench/readme.md
View file
Expand Up @@ -45,6 +45,21 @@ Date: 2018 October 8th, commit 59bda2ac81a497fa168677499bd1a9df60fec5ab
[info] WorkspaceFuzzBench.upper abcdefghijklmnopqrstabcdefghijkl ss 30 202.464 ± 1.423 ms/op
```

## textDocument/completions

First results show that loading a global instance of every request is too expensive.

Commit: 65a2baea48637e44dc619dce46a164dc0aa055f9
```
[info] Benchmark (completion) Mode Cnt Score Error Units
[info] CachedSearchAndCompilerCompletionBench.complete scopeOpen ss 30 20.760 ± 1.387 ms/op
[info] CachedSearchAndCompilerCompletionBench.complete scopeDeep ss 30 61.732 ± 13.112 ms/op
[info] CachedSearchAndCompilerCompletionBench.complete memberDeep ss 30 62.284 ± 64.132 ms/op
[info] CachedSearchCompletionBench.complete scopeOpen ss 30 156.566 ± 178.618 ms/op
[info] CachedSearchCompletionBench.complete scopeDeep ss 30 233.977 ± 222.032 ms/op
[info] CachedSearchCompletionBench.complete memberDeep ss 30 154.681 ± 198.653 ms/op
```

## Flamegraphs

Required steps before running.
Expand Down

0 comments on commit 80341b7

Please sign in to comment.