Skip to content
This repository has been archived by the owner on Jul 9, 2021. It is now read-only.

Refactor out sol-cov, sol-profiler and sol-trace into their separate packages #1492

Merged

Conversation

LogvinovLeon
Copy link
Contributor

Description

Before that PR there was a @0x/sol-cov package with sol-trace and sol-profiler living as dirty hacks inside. From now on there are 4 packages:

  • @0x/sol-coverage
  • @0x/sol-trace
  • @0x/sol-profiler
  • @0x/sol-trace-based-tools-common (Maybe a better name)

All the old CHANGELOG entries live in the common. The new changelogs reference it.

Testing instructions

Types of changes

  • Breaking change (fix or feature that would cause existing functionality to change)

Checklist:

  • Prefix PR title with [WIP] if necessary.
  • Add tests to cover changes as needed.
  • Update documentation as needed.
  • Add new entries to the relevant CHANGELOG.jsons.

@LogvinovLeon LogvinovLeon changed the title Refactor out sol-cov, sol-profiler and sol-trace into their separate packages [WIP] Refactor out sol-cov, sol-profiler and sol-trace into their separate packages Jan 8, 2019
@LogvinovLeon LogvinovLeon force-pushed the feature/sol-cov-sol-profiler-sol-trace-divorce branch from e983cdd to 1c783d2 Compare January 8, 2019 13:17
@LogvinovLeon LogvinovLeon changed the title [WIP] Refactor out sol-cov, sol-profiler and sol-trace into their separate packages Refactor out sol-cov, sol-profiler and sol-trace into their separate packages Jan 8, 2019
@LogvinovLeon LogvinovLeon force-pushed the feature/sol-cov-sol-profiler-sol-trace-divorce branch 3 times, most recently from dfa12a0 to 05916aa Compare January 8, 2019 13:41
@LogvinovLeon LogvinovLeon force-pushed the feature/sol-cov-sol-profiler-sol-trace-divorce branch from e3e41e7 to 2c974b5 Compare January 8, 2019 13:48
@LogvinovLeon LogvinovLeon requested a review from feuGeneA as a code owner January 8, 2019 13:48
@coveralls
Copy link

coveralls commented Jan 8, 2019

Coverage Status

Coverage remained the same at 85.47% when pulling 7ae9e79 on feature/sol-cov-sol-profiler-sol-trace-divorce into 0ac36ce on development.

@LogvinovLeon LogvinovLeon force-pushed the feature/sol-cov-sol-profiler-sol-trace-divorce branch from 528e67e to 0324824 Compare January 8, 2019 16:03
package.json Outdated
@@ -62,6 +62,9 @@
"repoBranchBase": "development"
}
},
"resolutions": {
"graceful-fs": "4.1.15"
Copy link
Contributor

Choose a reason for hiding this comment

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

Why is this needed?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I ran into that issue on my machine gulpjs/gulp#2246

packages/monorepo-scripts/src/test_installation.ts Outdated Show resolved Hide resolved
packages/sol-coverage/CHANGELOG.json Outdated Show resolved Hide resolved
packages/sol-profiler/CHANGELOG.json Outdated Show resolved Hide resolved
packages/sol-trace-based-tools-common/CHANGELOG.json Outdated Show resolved Hide resolved
@@ -6,6 +6,11 @@ import * as _ from 'lodash';
import { EvmCallStack } from './types';
import { utils } from './utils';

/**
* Converts linear trace to a call stack by following calls and returns
* @param structLogs Linear trace
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
* @param structLogs Linear trace
* @param structLogs Linear trace

Copy link
Contributor Author

Choose a reason for hiding this comment

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

You've made no changes to the code

packages/sol-trace-based-tools-common/src/source_maps.ts Outdated Show resolved Hide resolved
packages/sol-trace/CHANGELOG.json Outdated Show resolved Hide resolved
packages/sol-trace/README.md Outdated Show resolved Hide resolved
@@ -1,17 +1,17 @@
Sol-cov uses transaction traces in order to figure out which lines of Solidity source code have been covered by your tests. In order for it to gather these traces, you must add the `CoverageSubprovider` to the [ProviderEngine](https://github.com/MetaMask/provider-engine) instance you use when running your Solidity tests. If you're unfamiliar with ProviderEngine, please read the [Web3 Provider explained](https://0x.org/wiki#Web3-Provider-Explained) wiki article.
Copy link
Contributor

Choose a reason for hiding this comment

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

Rename dir from sol_cov to sol_coverage

Copy link
Contributor Author

Choose a reason for hiding this comment

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

This file was removed. The new directory has the correct name.
Before we've had two. v1 and v2. Git decided (correctly) that v2 was moved and renamed and v1 just removed.

@LogvinovLeon LogvinovLeon force-pushed the feature/sol-cov-sol-profiler-sol-trace-divorce branch from 2fbc17b to 1bdffbf Compare January 10, 2019 10:55
@LogvinovLeon LogvinovLeon force-pushed the feature/sol-cov-sol-profiler-sol-trace-divorce branch from 1bdffbf to cee2954 Compare January 10, 2019 10:56
@LogvinovLeon LogvinovLeon merged commit 6c22594 into development Jan 10, 2019
@LogvinovLeon LogvinovLeon deleted the feature/sol-cov-sol-profiler-sol-trace-divorce branch January 10, 2019 13:35
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants