fix: Improve compatibility with standard ethereum tooling #2649

konstantinabl · 2024-07-02T08:52:00Z

Description:

Currently, our validation process only checks the presence of fields returned by our API, without verifying the format of these fields. This can lead to inconsistencies and potential errors.

Changes introduced:

Adds separate CI workflow for API conformity
Pulls the openrpc.json from execution-apis repo in order to validate our response against it

Related issue(s):

Fixes #2108

github-actions · 2024-07-02T10:04:35Z

Tests

      3 files   197 suites 15s ⏱️
  993 tests   992 ✔️ 1 💤 0 ❌
1 006 runs 1 005 ✔️ 1 💤 0 ❌

Results for commit 583839f.

♻️ This comment has been updated with latest results.

github-actions · 2024-07-02T11:34:31Z

Acceptance Tests

  21 files 294 suites 33m 25s ⏱️
599 tests 586 ✔️ 4 💤   9 ❌
910 runs 894 ✔️ 4 💤 12 ❌

Results for commit 583839f.

♻️ This comment has been updated with latest results.

.github/workflows/conformity-workflow.yml

georgi-l95

LG, after this we can write some custom tests for the schema. aside from Jeromy comments, i think it looks okay. @Nana-EC has to modify the checks when this is approved in order to be merged.

packages/server/tests/acceptance/conformityTests.spec.ts

Signed-off-by: Konstantina Blazhukova <konstantina.blajukova@gmail.com>

…-apis Signed-off-by: Konstantina Blazhukova <konstantina.blajukova@gmail.com>

Signed-off-by: Konstantina Blazhukova <konstantina.blajukova@gmail.com>

…c; Adds file name in test header;Excludes dir from tests Signed-off-by: Konstantina Blazhukova <konstantina.blajukova@gmail.com>

Signed-off-by: Konstantina Blazhukova <konstantina.blajukova@gmail.com>

This reverts commit 38f712e. Signed-off-by: Konstantina Blazhukova <konstantina.blajukova@gmail.com>

Signed-off-by: Konstantina Blazhukova <konstantina.blajukova@gmail.com>

sonarcloud · 2024-08-09T13:37:12Z

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarCloud

codecov · 2024-08-09T15:22:28Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 84.11%. Comparing base (f55251e) to head (583839f).

Additional details and impacted files

@@             Coverage Diff             @@
##             main    #2649       +/-   ##
===========================================
+ Coverage   44.11%   84.11%   +40.00%     
===========================================
  Files          44       46        +2     
  Lines        3409     3457       +48     
  Branches      727      734        +7     
===========================================
+ Hits         1504     2908     +1404     
+ Misses       1651      326     -1325     
+ Partials      254      223       -31

Flag	Coverage Δ
relay	`79.80% <ø> (?)`
server	`81.56% <100.00%> (?)`
ws-server	`97.87% <ø> (?)`

Flags with carried forward coverage won't be shown. Click here to find out more.

Files	Coverage Δ
packages/server/src/validator/constants.ts	`100.00% <100.00%> (ø)`
packages/server/src/validator/methods.ts	`100.00% <ø> (ø)`
packages/server/src/validator/types.ts	`96.77% <100.00%> (+66.77%)`	⬆️

... and 34 files with indirect coverage changes

quiet-node

Great work! Just some suggestions and comments

quiet-node · 2024-08-12T16:29:33Z

packages/server/package.json

@@ -38,7 +38,7 @@
    "axios-retry": "^3.5.1",
    "chai": "^4.3.6",
    "ethers": "^6.7.0",
-    "execution-apis": "git://github.com/ethereum/execution-apis.git#584905270d8ad665718058060267061ecfd79ca5",
+    "execution-apis": "git://github.com/ethereum/execution-apis.git#7907424db935b93c2fe6a3c0faab943adebe8557",


just being curious, where did you get this updated number?

quiet-node · 2024-08-12T16:32:18Z

packages/server/tests/acceptance/conformityTests.spec.ts

@@ -5,6 +5,8 @@ const directoryPath = path.resolve(__dirname, '../../../../node_modules/executio
 const axios = require('axios');


This file is missing header license

/*- /*- * * Hedera JSON RPC Relay * * Copyright (C) 2022-2024 Hedera Hashgraph, LLC * ...

quiet-node · 2024-08-12T16:34:50Z

packages/server/tests/acceptance/conformityTests.spec.ts

@@ -5,6 +5,8 @@ const directoryPath = path.resolve(__dirname, '../../../../node_modules/executio
 const axios = require('axios');
 const openRpcData = require('../../../../docs/openrpc.json');
 require('dotenv').config();
+import Ajv from 'ajv';
+import addFormats from 'ajv-formats';


my editor says it cannot find this module, ajv-formats.

quiet-node · 2024-08-12T16:40:40Z

packages/server/tests/acceptance/conformityTests.spec.ts

@@ -5,6 +5,8 @@ const directoryPath = path.resolve(__dirname, '../../../../node_modules/executio
 const axios = require('axios');
 const openRpcData = require('../../../../docs/openrpc.json');
 require('dotenv').config();
+import Ajv from 'ajv';
+import addFormats from 'ajv-formats';
 import { signTransaction } from '../../../relay/tests/helpers';
 import { expect } from 'chai';
 let currentBlockHash;


Please clean up this session. I noticed that both import and require syntaxes are being used for importing dependencies. To conform to ES6 standards, please use import instead of require. Additionally, let's improve readability by adding some empty lines between the imports section and the variable declaration section.

konstantinabl linked an issue Jul 2, 2024 that may be closed by this pull request

Research: Improve compatility with standard Ethereum tooling #2108

Open

konstantinabl force-pushed the 2108-research-improve-compatility-with-standard-ethereum-tooling branch from fd097d9 to 1505dde Compare July 2, 2024 10:32

konstantinabl changed the title ~~Improve compatibility with standard ethereum tooling~~ fix: Improve compatibility with standard ethereum tooling Jul 2, 2024

konstantinabl force-pushed the 2108-research-improve-compatility-with-standard-ethereum-tooling branch from 1505dde to 0bb7a2f Compare July 2, 2024 10:43

konstantinabl force-pushed the 2108-research-improve-compatility-with-standard-ethereum-tooling branch 4 times, most recently from d10956d to 777a5d5 Compare July 3, 2024 14:59

konstantinabl added the enhancement New feature or request label Jul 5, 2024

konstantinabl marked this pull request as ready for review July 18, 2024 13:08

konstantinabl requested review from AlfredoG87, ebadiere, Nana-EC and a team as code owners July 18, 2024 13:08

konstantinabl requested review from matteriben and jeromy-cannon July 18, 2024 13:08

konstantinabl mentioned this pull request Jul 18, 2024

EPIC: Extend conformity tests #2721

Open

jeromy-cannon reviewed Jul 18, 2024

View reviewed changes

.github/workflows/conformity-workflow.yml Outdated Show resolved Hide resolved

jeromy-cannon reviewed Jul 18, 2024

View reviewed changes

.github/workflows/conformity-workflow.yml Outdated Show resolved Hide resolved

jeromy-cannon requested a review from rbarkerSL July 18, 2024 14:02

georgi-l95 assigned konstantinabl Jul 19, 2024

georgi-l95 reviewed Jul 19, 2024

View reviewed changes

victor-yanev requested changes Jul 19, 2024

View reviewed changes

konstantinabl mentioned this pull request Jul 19, 2024

Extend the format checking via openrpc.json #2728

Open

konstantinabl force-pushed the 2108-research-improve-compatility-with-standard-ethereum-tooling branch 2 times, most recently from ad4382d to 824ed40 Compare July 22, 2024 12:54

konstantinabl added 21 commits August 9, 2024 15:34

Adds needed packages for openrpc validation

8376bc2

Signed-off-by: Konstantina Blazhukova <konstantina.blajukova@gmail.com>

Tests CI

1648e93

Signed-off-by: Konstantina Blazhukova <konstantina.blajukova@gmail.com>

Adds step to rename files in conformity workflow

230e2a9

Signed-off-by: Konstantina Blazhukova <konstantina.blajukova@gmail.com>

Adds main changes to package-lock

192d21d

Signed-off-by: Konstantina Blazhukova <konstantina.blajukova@gmail.com>

Fixes error in other acceptance test related to openrpc from excution…

98ded96

…-apis Signed-off-by: Konstantina Blazhukova <konstantina.blajukova@gmail.com>

Update to latest commit

b4ad7b6

Signed-off-by: Konstantina Blazhukova <konstantina.blajukova@gmail.com>

Removes test code

ce4643a

Signed-off-by: Konstantina Blazhukova <konstantina.blajukova@gmail.com>

Addresses package lock conflict

b60b828

Signed-off-by: Konstantina Blazhukova <konstantina.blajukova@gmail.com>

Move file load from findSchema

ed21197

Signed-off-by: Konstantina Blazhukova <konstantina.blajukova@gmail.com>

Improves conformity workflo yml file

ae08cb6

Signed-off-by: Konstantina Blazhukova <konstantina.blajukova@gmail.com>

Adds better validation for storage slot

b2ed0c3

Signed-off-by: Konstantina Blazhukova <konstantina.blajukova@gmail.com>

improves workflow file

047cd87

Signed-off-by: Konstantina Blazhukova <konstantina.blajukova@gmail.com>

Ignores comments in test files from execution-api repo

2d375bc

Signed-off-by: Konstantina Blazhukova <konstantina.blajukova@gmail.com>

Removes uneccessary fields check, which is validate by ajv and openrp…

05217cd

…c; Adds file name in test header;Excludes dir from tests Signed-off-by: Konstantina Blazhukova <konstantina.blajukova@gmail.com>

Adds support to check response for valid error

3daed30

Signed-off-by: Konstantina Blazhukova <konstantina.blajukova@gmail.com>

Fixes storage slot fromat to be from 1 to 64 chars

a58f956

Signed-off-by: Konstantina Blazhukova <konstantina.blajukova@gmail.com>

Fixes failing unit tests

b3b9b63

Signed-off-by: Konstantina Blazhukova <konstantina.blajukova@gmail.com>

Revert "Updates local node version"

3b63ff3

This reverts commit 38f712e. Signed-off-by: Konstantina Blazhukova <konstantina.blajukova@gmail.com>

Fixes websocket3 test

6e6dd61

Signed-off-by: Konstantina Blazhukova <konstantina.blajukova@gmail.com>

Fixes package-lock

52bffd1

Signed-off-by: Konstantina Blazhukova <konstantina.blajukova@gmail.com>

Removes unneeded boolean

adb87ac

Signed-off-by: Konstantina Blazhukova <konstantina.blajukova@gmail.com>

konstantinabl force-pushed the 2108-research-improve-compatility-with-standard-ethereum-tooling branch from db30f68 to adb87ac Compare August 9, 2024 13:10

Fixes package-lock

583839f

Signed-off-by: Konstantina Blazhukova <konstantina.blajukova@gmail.com>

konstantinabl force-pushed the 2108-research-improve-compatility-with-standard-ethereum-tooling branch from de0a650 to 583839f Compare August 9, 2024 13:36

konstantinabl requested a review from jeromy-cannon August 12, 2024 14:09

quiet-node requested changes Aug 12, 2024

View reviewed changes

quiet-node modified the milestones: 0.53.0, 0.55.0 Aug 12, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix: Improve compatibility with standard ethereum tooling #2649

fix: Improve compatibility with standard ethereum tooling #2649

konstantinabl commented Jul 2, 2024 •

edited

Loading

github-actions bot commented Jul 2, 2024 •

edited

Loading

github-actions bot commented Jul 2, 2024 •

edited

Loading

georgi-l95 left a comment

sonarcloud bot commented Aug 9, 2024

codecov bot commented Aug 9, 2024

quiet-node left a comment

quiet-node Aug 12, 2024

quiet-node Aug 12, 2024

quiet-node Aug 12, 2024

quiet-node Aug 12, 2024

		@@ -5,6 +5,8 @@ const directoryPath = path.resolve(__dirname, '../../../../node_modules/executio
		const axios = require('axios');

fix: Improve compatibility with standard ethereum tooling #2649

Are you sure you want to change the base?

fix: Improve compatibility with standard ethereum tooling #2649

Conversation

konstantinabl commented Jul 2, 2024 • edited Loading

github-actions bot commented Jul 2, 2024 • edited Loading

Tests

github-actions bot commented Jul 2, 2024 • edited Loading

Acceptance Tests

georgi-l95 left a comment

Choose a reason for hiding this comment

sonarcloud bot commented Aug 9, 2024

Quality Gate passed

codecov bot commented Aug 9, 2024

Codecov Report

quiet-node left a comment

Choose a reason for hiding this comment

quiet-node Aug 12, 2024

Choose a reason for hiding this comment

quiet-node Aug 12, 2024

Choose a reason for hiding this comment

quiet-node Aug 12, 2024

Choose a reason for hiding this comment

quiet-node Aug 12, 2024

Choose a reason for hiding this comment

konstantinabl commented Jul 2, 2024 •

edited

Loading

github-actions bot commented Jul 2, 2024 •

edited

Loading

github-actions bot commented Jul 2, 2024 •

edited

Loading