lerna build

[evgeniuz]

Fixes #107

[CLAassistant]

All committers have signed the CLA.

[evgeniuz]

Added very rough lerna build, still lots to do, but packages are split and building. Instructions are:

yarn install
lerna bootstrap
lerna run build:ts
node package/ethql/dist/index.js

Things still to do (non-complete list):

• move tests into packages and ensure they're working
• move package lifecycle scripts into packages
• move dependencies into packages
• fix docker build
• fix circle CI
• update README

[evgeniuz]

Implemented lerna build in the best way possible (I hope 😃):

• It uses new TypeScript feature (build mode and project references), this allows to run complete build and watching across all packages at once (also replaced nodemon with tsc-watch, as it's much simpler wrapper around tsc and more suitable to work in build mode).
• It uses "global" tsconfig.json which is not used for actual build, but used for jest. This allows to run one instance of jest to execute all tests across packages (including watch mode and coverage mode).

This combination allows running tests or dev/debug build in watch mode for easier development and is producing loosely coupled dist folders for distribution.

Instruction:

yarn install
lerna bootstrap
...
# it's not required to build before running dev or test
yarn build:ts
yarn dev
yarn test
etc.

Things I still plan to do:

• fix docker build
• fix circle CI
• update README with new setup instructions

Except for these things it's ready for some review (just to confirm that approach taken is good one).

[evgeniuz]

Fixed docker build, but not sure what's with circleCI.

[evgeniuz]

Technically everything should be complete, but CircleCI tests are timing out for some reason (work locally and don't take too much time). Cannot troubleshoot this as output is truncated.

[evgeniuz]

Cause for failure was that it was requesting too many workers and correspondingly allocating too much memory. Fixed by limiting workers to 2.

[raulk]

@evgeniuz thanks for the submission! I fixed the jest configuration to honor the worker limitation (not sure where this came from), and updated all versions. Could you please integrate these changes on your branch?

[raulk]

A few initial comments.

[raulk]

Why was this needed?

[evgeniuz]

This interface is extended in every service but had no "empty" definition. This caused problem compiling @ethql/base as there is just one service and it's not imported anywhere in itself (it's imported in ethql package, but since we need to be able to build @ethql/base in isolation, this is not relevant here).

[evgeniuz]

To add: this empty definition makes sense here as it should be object where keys are services, and without any services defined it would be an empty object (that later can be extended).

[raulk]

👍

[raulk]

It's incorrect to import compiled javascript from a Typescript file.

[evgeniuz]

I think it’s correct way to approach this: if you intend to publish all packages on NPM, there will be no TS sources in packages, only compiled files. So if we refer to TS files, these imports will be unresolved when installed from NPM.

No types information is lost, as all those compiled files always have accompanying .d.ts with them.

Ideally, base package should export single index.ts file that will contain all other exports in it to remove paths and just import @ethql/base everywhere, but I think this should be done after this PR is integrated.

[evgeniuz]

And tsc build mode intended to work with this approach: it checks if referenced compiled import is present and if not present it builds it from TS.

[raulk]

Not sure I get this?

[evgeniuz]

This change has similar cause to EthqlServiceDefinitions change. plugin: EthqlPluginFactory has references to both ens service and web3 service, but those are not imported at this point, so TS complains that there are no web3 EthqlServiceDefinition defined. So we need to import this file here. Basically, we need to import file that defines service if we depend on it.

[evgeniuz]

@raulk Rebased on top of recent master changes.

[evgeniuz]

Are there any changes I need to implement here?

[raulk]

I pushed a commit a few days ago performing some further refactor, but didn't have time to comment on it. Here it goes:

• Teased out the core plugin from the base module. This was pretty traumatic because it required quite a bit of disentanglement, but the result is much cleaner.
• Extracted the web3 typings to a module of its own.
• Added main and typings fields in package.json files, and added index.ts files where they were missing, making importing more idiomatic.

[raulk]

Just pushed a few more commits to rationalise the build commands; hopefully it'll now pass on CI. I also fixed the Dockerfile.