Web3 utils full test coverage for types #2084

joshstevens19 · 2018-11-30T11:22:32Z

I have gone through the utils repo and got the dtslint within all the typings. We have full test coverage on all of the types now (look at `test.ts file, it's to big so you have to expand it ha ha).

I have added this in the npm test step as well which will run before jest. We have everything nearly strongly typed so if you could supply me with the interface of the last few objects below we can have a fully supported ts for web3-utils :)

_jsonInterfaceMethodToString - json parameter ?
_flattenTypes - puts parameter ?

Have a look through - this is going to be the foundations for all testing of all types in all packages.

Oh and i spotted some docs incorrect while doing it so i corrected that as well.

Cheers

packages/web3-utils/package.json

packages/web3-utils/types/test.ts

packages/web3-utils/types/tsconfig.json

packages/web3-utils/types/tslint.json

joshstevens19 · 2018-12-01T09:23:30Z

Abstracted everything out into single tests.. much cleaner 👍

joshstevens19 · 2018-12-02T08:07:27Z

@nivida it be good to strongly type these last 2 objects before we merge in

_jsonInterfaceMethodToString - json parameter ?
_flattenTypes - puts parameter ?

Can you let me know what object you expect for those?

nivida · 2018-12-02T08:10:33Z

@joshstevens19
flattenTypes could be removed this method will no longer be used.
_jsonInterfaceMethodToString: This method get an ABI item json object.

joshstevens19 · 2018-12-02T08:30:29Z

can i remove the method for _flattenTypes as well while at it then so they are both in sync ?

Ok will add AbiItem in here for now - will be moved out later in a more generic place once defined.

nivida · 2018-12-02T08:32:48Z

@joshstevens19
FYI: The ABIItemModel I've created is the wrong object for here. But I think you mean the right one the JSON object we know from the generated ABI.

Yes you can remove this method thanks!

joshstevens19 · 2018-12-02T08:33:43Z

_flattenTypes is used in _jsonInterfaceMethodToString at the current time though?

nivida · 2018-12-02T08:35:08Z

Ou sorry. Yes, then this is the last place this method is used.

joshstevens19 · 2018-12-02T08:36:27Z

ok i will remove the export so we do not need it in the types 👍

packages/web3-utils/types/index.d.ts

packages/web3-utils/README.md

packages/web3-utils/types/tests/ascii-to-hex-tests.ts

packages/web3-utils/types/tests/bytes-to-hex-tests.ts

packages/web3-utils/types/tests/from-ascii-tests.ts

packages/web3-utils/types/tests/ascii-to-hex-tests.ts

packages/web3-utils/types/tests/json-interface-method-to-string-tests.ts

packages/web3-utils/types/tslint.json

nivida · 2018-12-03T03:56:28Z

Don't forget to resolve the package.json conflicts. :-)

…a array

…s not private

…d later on

joshstevens19 · 2018-12-03T10:23:07Z

everything should be resolved now 👍

nivida · 2018-12-03T10:24:34Z

Great! Thanks Josh!
I will have a look at it in Switzerland I'll take off from Dubai in the next 10min.

packages/web3-utils/README.md

packages/web3-utils/package.json

packages/web3-utils/types/tests/ascii-to-hex-tests.ts

packages/web3-utils/types/tests/get-unit-value-tests.ts

packages/web3-utils/types/tests/hex-to-ascii-tests.ts

joshstevens19 · 2018-12-03T10:49:06Z

wow all your comments i fixed but i rebased and it must of killed all of these grrrrrrr i will sort again when i get a second 👍

joshstevens19 · 2018-12-03T12:40:18Z

@nivida so i have fixed those comments again - bloody git! had to do some git black magic to find it .. should be good now 😄

nivida · 2018-12-04T20:20:45Z

I'll test it tomorrow and when all tests run as expected I'll merge it.
Thanks 👍

nivida suggested changes Nov 30, 2018

View reviewed changes

nivida mentioned this pull request Dec 1, 2018

docs(README): fix type definition package name #1934

Closed

nivida added the Enhancement Includes improvements or optimizations label Dec 1, 2018

nivida suggested changes Dec 2, 2018

View reviewed changes

packages/web3-utils/types/index.d.ts Outdated Show resolved Hide resolved

joshstevens19 changed the title ~~Web3 utils full test coverage~~ Web3 utils full test coverage for types Dec 2, 2018

nivida suggested changes Dec 3, 2018

View reviewed changes

joshstevens19 added 15 commits December 3, 2018 10:15

added correct parameter types to docs for sha3

c5d1f87

added new ts dependencies + added dtslint

cba0105

Removed types into folder and resolve some issues flagged

7dc253d

new package-lock.json

97de83c

full type tests

0cf3eda

tsconfig.json

c89e469

tslint.json

06fa6f1

indent imports

83ae913

add a trailing line on tslint.json

5bd17f0

move key dev dependencies in the root

5da963f

moved ts + bn into root but kept dtslint

73c35ff

deleted huge test file to split in single files

b2969f9

remove comments

7a9d77a

added some more rules for our test files

bd75fa1

asciiToHex tests

b58a0fc

joshstevens19 added 20 commits December 3, 2018 10:19

utf8ToHex tests

ef10019

Rename paths to web3-utils to match real life

f63e9c2

_jsonInterfaceMethodToString now returns AbiItem

a3b0dad

new tests for _jsonInterfaceMethodToString with new AbiItem

d947f66

_flattenTypes does not need export as its only used in this file now

14ca4ba

remove unneeded _flattenTypes tests

1101979

renamed AbiItem > ABIItem

cc158ff

remove s on input as they are a single object and only inputs if …

aa53e0f

…a array

remove _fireError as not used anymore

fe02d6a

remove _fireError tests

373f8c0

remove _fireError types

1f8d770

Add extra tests for some types

6020bb9

_jsonInterfaceMethodToString > jsonInterfaceMethodToString as it'…

42ec981

…s not private

update package.json to include types/index.d.ts

b752ce6

Make sure @file is correct in test files`

0888f8b

Update README.md

e308d68

add ABIType enum

8a4155d

created ABIType

1c86fde

move generic stuff to the bottom to highlight it will need to be move…

1821c67

…d later on

fix merge conflicts

1f68134

nivida suggested changes Dec 3, 2018

View reviewed changes

Fix PR comments v2 :)

6768764

nivida merged commit b6ec6cb into web3:ethereumProvider Dec 6, 2018

joshstevens19 mentioned this pull request Dec 9, 2018

Add TypeScript typings for all packages #2085

Closed

4 tasks

joshstevens19 mentioned this pull request Sep 16, 2019

Proposal to stabilize Web3 1.x #3070

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Web3 utils full test coverage for types #2084

Web3 utils full test coverage for types #2084

joshstevens19 commented Nov 30, 2018

joshstevens19 commented Dec 1, 2018

joshstevens19 commented Dec 2, 2018 •

edited

Loading

nivida commented Dec 2, 2018

joshstevens19 commented Dec 2, 2018

nivida commented Dec 2, 2018 •

edited

Loading

joshstevens19 commented Dec 2, 2018

nivida commented Dec 2, 2018

joshstevens19 commented Dec 2, 2018

nivida commented Dec 3, 2018

joshstevens19 commented Dec 3, 2018

nivida commented Dec 3, 2018

joshstevens19 commented Dec 3, 2018

joshstevens19 commented Dec 3, 2018

nivida commented Dec 4, 2018

Web3 utils full test coverage for types #2084

Web3 utils full test coverage for types #2084

Conversation

joshstevens19 commented Nov 30, 2018

joshstevens19 commented Dec 1, 2018

joshstevens19 commented Dec 2, 2018 • edited Loading

nivida commented Dec 2, 2018

joshstevens19 commented Dec 2, 2018

nivida commented Dec 2, 2018 • edited Loading

joshstevens19 commented Dec 2, 2018

nivida commented Dec 2, 2018

joshstevens19 commented Dec 2, 2018

nivida commented Dec 3, 2018

joshstevens19 commented Dec 3, 2018

nivida commented Dec 3, 2018

joshstevens19 commented Dec 3, 2018

joshstevens19 commented Dec 3, 2018

nivida commented Dec 4, 2018

joshstevens19 commented Dec 2, 2018 •

edited

Loading

nivida commented Dec 2, 2018 •

edited

Loading