Truffle support #393

antico5 · 2023-02-14T14:14:40Z

General
- Identify projects that have truffle.js or truffle-config.js
- Config file should be loadable (no errors) for validation to work. Same as hardhat
Config
- Solc version (semver format supported. i.e. ^0.8.0
- Contracts directory
Import resolution
- Absolute path
- Relative path
- Truffle direct imports (i.e. truffle/console.sol)
- Local node modules contracts
- Global node modules contracts

Closes #45

codecov-commenter · 2023-02-14T14:19:35Z

Codecov Report

❗ No coverage uploaded for pull request base (development@1dd334e). Click here to learn what that means.
The diff coverage is n/a.

❗ Current head 4917f2d differs from pull request most recent head ed29af5. Consider uploading reports for the commit ed29af5 to get more accurate results

📣 This organization is not using Codecov’s GitHub App Integration. We recommend you install it so Codecov can continue to function properly for your repositories. Learn more

@@              Coverage Diff               @@
##             development     #393   +/-   ##
==============================================
  Coverage               ?   54.28%           
==============================================
  Files                  ?      183           
  Lines                  ?     4681           
  Branches               ?      767           
==============================================
  Hits                   ?     2541           
  Misses                 ?     1905           
  Partials               ?      235

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

kanej · 2023-03-13T14:07:24Z

I have been running through the truffle getting started guide:

https://trufflesuite.com/docs/truffle/quickstart/

After unboxing metacoin, I have a working project that I open with the extension:

truffle unbox metacoin [PATH/TO/DIRECTORY]

On opening the ./test/TestMetaCoin.sol file I get red squiggly on direct truffle imports:

Specifically:

antico5 · 2023-03-15T11:10:55Z

@kanej the truffle/Assert.sol import should be working. Can you verify that the contract is being identified as a truffle project from within the extension? also if there's anything wrong in the logs. The way it's resolved is by looking into either a local or global installation of truffle. For the DeployedAddresses.sol import, it won't work because it's a source generated dynamically by truffle. But truffle console, asserts, etc imports it should work.

kanej · 2023-04-13T12:08:35Z

@kanej the truffle/Assert.sol import should be working. Can you verify that the contract is being identified as a truffle project from within the extension? also if there's anything wrong in the logs. The way it's resolved is by looking into either a local or global installation of truffle. For the DeployedAddresses.sol import, it won't work because it's a source generated dynamically by truffle. But truffle console, asserts, etc imports it should work.

What do you think of suppressing an error on the import of truffle/DeployedAddresses.sol?

antico5 · 2023-04-13T12:25:53Z

@kanej the truffle/Assert.sol import should be working. Can you verify that the contract is being identified as a truffle project from within the extension? also if there's anything wrong in the logs. The way it's resolved is by looking into either a local or global installation of truffle. For the DeployedAddresses.sol import, it won't work because it's a source generated dynamically by truffle. But truffle console, asserts, etc imports it should work.

What do you think of suppressing an error on the import of truffle/DeployedAddresses.sol?

I think it works. We can add more to that list if we discover there are other imports of this kind.

antico5 · 2023-04-13T12:58:59Z

@kanej the truffle/Assert.sol import should be working. Can you verify that the contract is being identified as a truffle project from within the extension? also if there's anything wrong in the logs. The way it's resolved is by looking into either a local or global installation of truffle. For the DeployedAddresses.sol import, it won't work because it's a source generated dynamically by truffle. But truffle console, asserts, etc imports it should work.

What do you think of suppressing an error on the import of truffle/DeployedAddresses.sol?

I tried this and actually found out that it doesn't quite work. I tried 2 options: 1st, suppressing the error, and 2nd, injecting a source with empty content for DeployedAddresses.sol. In the first case, all validation is lost because solc doesn't return other errors if there are import errors present, and in the 2nd case, the import line is not erroring but the usages e.g. DeployedAddresses.MetaCoin() will error because there's no such identifier.

server/src/frameworks/Truffle/TruffleProject.ts

kanej · 2023-04-13T14:11:47Z

@antico5 is there an approach to resolving the truffle contracts under node modules as part of the truffle project?

The particular problem I am thinking of is from a truffle solidity test, jumping into the assert sol file via import "truffle/Assert.sol";, the file shows up as having project none, which I think leads to the imports not resolving.

server/src/frameworks/Projectless/ProjectlessProject.ts

kanej · 2023-04-14T10:35:31Z

server/src/frameworks/Truffle/TruffleProject.ts

+    return "Truffle";
+  }
+
+  public async initialize(): Promise<void> {


Do we trigger a reinitialization on each config change?

Yes, that logic is on the onWatchedFilesChanges method of this class.

I pushed a change to get to the comparison check on onWatchedFilesChanges as the uri had file:// as a prefix.

Is there a better way of doing that comparison with inbuilt vscode functions?

You could use URI.parse(<uri>).fsPath. The import is import { URI } from "vscode-uri";

antico5 · 2023-04-14T19:40:55Z

@antico5 is there an approach to resolving the truffle contracts under node modules as part of the truffle project?

The particular problem I am thinking of is from a truffle solidity test, jumping into the assert sol file via import "truffle/Assert.sol";, the file shows up as having project none, which I think leads to the imports not resolving.

We could easily associate files under node_modules to the truffle project, although that wouldn't work if truffle is being used as a global package. For the global package, I don't know how we could associate them with a single project, since many open projects could be using the global module.

kanej · 2023-04-17T08:47:41Z

@antico5 is there an approach to resolving the truffle contracts under node modules as part of the truffle project?
The particular problem I am thinking of is from a truffle solidity test, jumping into the assert sol file via import "truffle/Assert.sol";, the file shows up as having project none, which I think leads to the imports not resolving.

We could easily associate files under node_modules to the truffle project, although that wouldn't work if truffle is being used as a global package. For the global package, I don't know how we could associate them with a single project, since many open projects could be using the global module.

Lets take that approach. I think we can assume that a global install is less common and just deal with local node_modules.

antico5 · 2023-04-17T12:42:05Z

@antico5 is there an approach to resolving the truffle contracts under node modules as part of the truffle project?
The particular problem I am thinking of is from a truffle solidity test, jumping into the assert sol file via import "truffle/Assert.sol";, the file shows up as having project none, which I think leads to the imports not resolving.

We could easily associate files under node_modules to the truffle project, although that wouldn't work if truffle is being used as a global package. For the global package, I don't know how we could associate them with a single project, since many open projects could be using the global module.

Lets take that approach. I think we can assume that a global install is less common and just deal with local node_modules.

Done!

kanej

I have tested on the latest getting started guide for truffle and we are providing a significantly improved experience.

We should hold off on merging until we have a release schedule (and consideration of docs)

* feat: server document formatting provider * tests for server document formatting * truffle adapter scaffolding * wip import resolution * support node modules imports * truffle validation * read truffle config * reinitialize truffle project on config change * read globalNodeModulesPath only on initialization * change crawlDependencies to use Set for visited nodes * tests for truffle project * update TruffleProject#fileBelongs * add support for DeployedAddresses.sol * feat: base DeployedAddresses off of build dir * test: add failed initialization for truffle * fix: reinitialize on change to truffle config * claim contracts under node_modules on truffle project * use vscode-uri to get path from uri --------- Co-authored-by: John Kane <john@kanej.me>

antico5 requested a review from kanej February 14, 2023 14:14

github-actions bot added the status:triaging label Feb 14, 2023

antico5 force-pushed the truffle_support branch from 50dba43 to 80d9497 Compare February 14, 2023 14:46

kanej removed the status:triaging label Feb 14, 2023

kanej force-pushed the development branch from 421914d to d34fe2e Compare February 23, 2023 12:57

antico5 force-pushed the truffle_support branch from 80d9497 to cd151c2 Compare March 2, 2023 14:43

antico5 mentioned this pull request Mar 7, 2023

WIP - Ape framework support #419

Closed

antico5 force-pushed the development branch from 87a9af7 to a340d1f Compare March 9, 2023 12:32

antico5 force-pushed the truffle_support branch from cd151c2 to 116b4d7 Compare March 9, 2023 17:17

antico5 force-pushed the development branch from 391baa4 to 3b181f9 Compare March 20, 2023 12:49

kanej force-pushed the truffle_support branch from 116b4d7 to b00c0ee Compare April 13, 2023 11:03

kanej reviewed Apr 13, 2023

View reviewed changes

server/src/frameworks/Truffle/TruffleProject.ts Outdated Show resolved Hide resolved

kanej reviewed Apr 14, 2023

View reviewed changes

server/src/frameworks/Projectless/ProjectlessProject.ts Show resolved Hide resolved

kanej reviewed Apr 14, 2023

View reviewed changes

kanej approved these changes Apr 17, 2023

View reviewed changes

kanej force-pushed the development branch from 2877a93 to 2b5e758 Compare April 19, 2023 13:06

antico5 added 4 commits April 19, 2023 13:40

feat: server document formatting provider

07ae577

tests for server document formatting

aba4a0d

truffle adapter scaffolding

cbfef35

wip import resolution

8bbdeda

antico5 and others added 14 commits April 19, 2023 13:40

support node modules imports

8cf896b

truffle validation

f9c6aff

read truffle config

bad9375

reinitialize truffle project on config change

a41cd08

read globalNodeModulesPath only on initialization

1888064

change crawlDependencies to use Set for visited nodes

df74445

tests for truffle project

a520ca8

update TruffleProject#fileBelongs

c936fab

add support for DeployedAddresses.sol

25d9810

feat: base DeployedAddresses off of build dir

7a2d52e

test: add failed initialization for truffle

b28fbee

fix: reinitialize on change to truffle config

8025837

claim contracts under node_modules on truffle project

429a03b

use vscode-uri to get path from uri

3b1a965

antico5 force-pushed the truffle_support branch from 0b72a0b to 3b1a965 Compare April 19, 2023 16:51

antico5 merged commit c42fa62 into development Apr 19, 2023

antico5 deleted the truffle_support branch April 19, 2023 16:52

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Truffle support #393

Truffle support #393

antico5 commented Feb 14, 2023

codecov-commenter commented Feb 14, 2023 •

edited

Loading

kanej commented Mar 13, 2023

antico5 commented Mar 15, 2023

kanej commented Apr 13, 2023

antico5 commented Apr 13, 2023

antico5 commented Apr 13, 2023

kanej commented Apr 13, 2023 •

edited

Loading

kanej Apr 14, 2023

antico5 Apr 14, 2023

kanej Apr 14, 2023

antico5 Apr 14, 2023

antico5 commented Apr 14, 2023

kanej commented Apr 17, 2023

antico5 commented Apr 17, 2023

kanej left a comment

Truffle support #393

Truffle support #393

Conversation

antico5 commented Feb 14, 2023

codecov-commenter commented Feb 14, 2023 • edited Loading

Codecov Report

kanej commented Mar 13, 2023

antico5 commented Mar 15, 2023

kanej commented Apr 13, 2023

antico5 commented Apr 13, 2023

antico5 commented Apr 13, 2023

kanej commented Apr 13, 2023 • edited Loading

kanej Apr 14, 2023

Choose a reason for hiding this comment

antico5 Apr 14, 2023

Choose a reason for hiding this comment

kanej Apr 14, 2023

Choose a reason for hiding this comment

antico5 Apr 14, 2023

Choose a reason for hiding this comment

antico5 commented Apr 14, 2023

kanej commented Apr 17, 2023

antico5 commented Apr 17, 2023

kanej left a comment

Choose a reason for hiding this comment

codecov-commenter commented Feb 14, 2023 •

edited

Loading

kanej commented Apr 13, 2023 •

edited

Loading