Sync main to forcerelay-test branch

.github/PULL_REQUEST_TEMPLATE.md

@@ -37,25 +37,14 @@ See also:
 **CI Switch**
 
 - [ ] Web3 Compatible Tests
-- [ ] OCT 1-5 And 12-15
-- [ ] OCT 6-10
-- [ ] OCT 11
-- [ ] OCT 16-19
+- [ ] OpenZeppelin tests
 - [ ] v3 Core Tests
 
 ### **CI Description**
 
-| CI Name                                   | Description                                                               |
-| ----------------------------------------- | ------------------------------------------------------------------------- |
-| *Web3 Compatible Test*                    | Test the Web3 compatibility of Axon                                       |
-| *v3 Core Test*                            | Run the compatibility tests provided by Uniswap V3                        |
-| *OCT 1-5 \| 6-10 \| 11 \| 12-15 \| 16-19* | Run the compatibility tests provided by OpenZeppelin                      |
-
-<!--
-#### Deprecated CIs
-- [ ] Chaos CI
-| *Chaos CI*                                | Test the liveness and robustness of Axon under terrible network condition |
-- [ ] Coverage Test
-| *Coverage Test*                           | Get the unit test coverage report                                         |
--->
+| CI Name                | Description                                                                                             |
+| ---------------------- | ------------------------------------------------------------------------------------------------------- |
+| *Web3 Compatible Test* | Test the Web3 compatibility of Axon                                                                     |
+| *v3 Core Test*         | Run the compatibility tests provided by Uniswap V3                                                      |
+| *OpenZeppelin tests*   | Run the compatibility tests provided by OpenZeppelin, including OCT 1-5 \| 6-10 \| 11 \| 12-15 \| 16-19 |
 </details>

.github/workflows/axon-start-with-short-genesis.yml → .github/workflows/axon-start-test.yml

@@ -32,7 +32,12 @@ jobs:
         restore-keys: |
           ${{ matrix.os }}-${{ runner.os }}-${{ runner.arch }}-cargo-build
     - name: Build Axon in the development profile
-      run: cargo build
+      run: |
+        # check for AVX2 support by inspecting `/proc/cpuinfo` or running `lscpu`
+        # related issue: https://github.com/axonweb3/axon/issues/1387
+        lscpu
+        # PORTABLE=1 USE_SSE=1 tell rocksdb to target AVX2
+        PORTABLE=1 USE_SSE=1 cargo build
 
     - name: Start a single Axon node
       env:
@@ -47,11 +52,9 @@ jobs:
           --config     devtools/chain/config.toml \
           | tee -a ${{ env.LOG_FILE }} &
 
-        sleep 10
-
         npx zx <<'EOF'
         import { waitXBlocksPassed } from './devtools/ci/scripts/helper.js'
-        await waitXBlocksPassed('http://127.0.0.1:8000', 2);
+        await retry(3, '6s', () => waitXBlocksPassed('http://127.0.0.1:8000', 2))
         EOF
       timeout-minutes: 1
 
@@ -87,7 +90,12 @@ jobs:
         restore-keys: |
           ${{ matrix.os }}-${{ runner.os }}-${{ runner.arch }}-cargo-build
     - name: Build Axon in the development profile
-      run: cargo build
+      run: |
+        # check for AVX2 support by inspecting `/proc/cpuinfo` or running `lscpu`
+        # related issue: https://github.com/axonweb3/axon/issues/1387
+        lscpu
+        # PORTABLE=1 USE_SSE=1 tell rocksdb to target AVX2
+        PORTABLE=1 USE_SSE=1 cargo build
 
     - name: Start multiple Axon nodes
       env:
@@ -112,12 +120,12 @@ jobs:
 
         npx zx <<'EOF'
         import { waitXBlocksPassed } from './devtools/ci/scripts/helper.js'
-        await Promise.all([
+        await retry(3, '6s', () => Promise.all([
           waitXBlocksPassed('http://127.0.0.1:8001', 4),
           waitXBlocksPassed('http://127.0.0.1:8002', 4),
           waitXBlocksPassed('http://127.0.0.1:8003', 4),
           waitXBlocksPassed('http://127.0.0.1:8004', 4),
-        ])
+        ]))
         EOF
       timeout-minutes: 1
 

.github/workflows/build_image_ghcr.yml

@@ -101,7 +101,7 @@ jobs:
     - name: Modify the Axon image of in devtools/chain/docker-compose.yml
       env:
         AXON_IMAGE: "${{ needs.build-amd64-image-to-ghcr.outputs.image_name }}:${{ needs.build-amd64-image-to-ghcr.outputs.image_tag }}"
-      uses: mikefarah/yq@v4.35.2
+      uses: mikefarah/yq@v4.40.3
       with:
         cmd: yq -i '.services.axon.image = "${{ env.AXON_IMAGE }}"' 'devtools/chain/docker-compose.yml'
 
@@ -122,6 +122,6 @@ jobs:
 
         npx zx <<'EOF'
         import { waitXBlocksPassed } from '../ci/scripts/helper.js'
-        await waitXBlocksPassed('http://127.0.0.1:8000', 2);
+        await retry(3, '6s', () => waitXBlocksPassed('http://127.0.0.1:8000', 2))
         EOF
       timeout-minutes: 2

.github/workflows/chaos.yml

@@ -26,7 +26,7 @@ jobs:
       - name: Event is dispatch
         if: contains(github.event_name, 'workflow_dispatch') &&
             github.repository_owner == 'axonweb3' && github.event.inputs.dispatch != 'regression'
-        uses: actions/github-script@v6
+        uses: actions/github-script@v7
         id: get_sha
         with:
           github-token: ${{ steps.generate_axon_bot_token.outputs.BOT_TOKEN }}
@@ -94,7 +94,7 @@ jobs:
           private_key: ${{ secrets.AXON_BOT_PRIVATE_KEY }}
       - if: contains(join(needs.*.result, ';'), 'failure') || contains(join(needs.*.result, ';'), 'cancelled')
         run: exit 1
-      - uses: actions/github-script@v6
+      - uses: actions/github-script@v7
         if: ${{ always() }}
         with:
           github-token: ${{ steps.generate_axon_bot_token.outputs.BOT_TOKEN }}

.github/workflows/copy_config_to_devops.yml

@@ -18,6 +18,7 @@ jobs:
         uses: actions/checkout@v4
         with:
           repository: axonweb3/axon-devops
+          ref: 32e274a1f14c065fe63d37f006ac1a3c4f70654f
           path: ${{ github.workspace}}/axon-devops
       - name: apply config toml config_toml.patch
         run: |

.github/workflows/coverage.yml

@@ -27,7 +27,7 @@ jobs:
       - name: Event is dispatch
         if: contains(github.event_name, 'workflow_dispatch') &&
             github.repository_owner == 'axonweb3'
-        uses: actions/github-script@v6
+        uses: actions/github-script@v7
         id: get_sha
         with:
           github-token: ${{ steps.generate_axon_bot_token.outputs.BOT_TOKEN }}
@@ -101,7 +101,7 @@ jobs:
           private_key: ${{ secrets.AXON_BOT_PRIVATE_KEY }}
       - if: contains(join(needs.*.result, ';'), 'failure') || contains(join(needs.*.result, ';'), 'cancelled')
         run: exit 1
-      - uses: actions/github-script@v6
+      - uses: actions/github-script@v7
         if: ${{ always() }}
         with:
           github-token: ${{ steps.generate_axon_bot_token.outputs.BOT_TOKEN }}

.github/workflows/e2e_test.yml

@@ -4,6 +4,7 @@ on:
   push:
   pull_request:
   merge_group:
+  workflow_dispatch:
 
 # Ensure that only a single job or workflow using the same concurrency group will run at a time.
 # see https://docs.github.com/en/actions/using-jobs/using-concurrency#example-only-cancel-in-progress-jobs-or-runs-for-the-current-workflow
@@ -38,16 +39,35 @@ jobs:
           restore-keys: |
             ${{ matrix.os }}-${{ runner.os }}-${{ runner.arch }}-cargo-build
 
-      - uses: lyricwulf/abc@v1
-        with:
-          # https://www.gnu.org/software/m4/
-          linux: m4
+      - name: Build Axon in the development profile
+        run: |
+          # check for AVX2 support by inspecting `/proc/cpuinfo` or running `lscpu`
+          lscpu
+          cargo build
+
+      - name: Start a single Axon node
+        env:
+          LOG_FILE: ${{ runner.temp }}/${{ matrix.os }}-single-axon-node.log
+        run: |
+          target/debug/axon --version | tee ${{ env.LOG_FILE }}
+          target/debug/axon init \
+            --config     devtools/chain/config.toml \
+            --chain-spec devtools/chain/specs/single_node/chain-spec.toml \
+            | tee -a ${{ env.LOG_FILE }}
+          target/debug/axon run \
+            --config     devtools/chain/config.toml \
+            | tee -a ${{ env.LOG_FILE }} &
+
+          npx zx <<'EOF'
+          import { waitXBlocksPassed } from './devtools/ci/scripts/helper.js'
+          await retry(3, '6s', () => waitXBlocksPassed('http://127.0.0.1:8000', 2))
+          EOF
+        timeout-minutes: 1
 
-      # TODO: use Node.js 18
       - name: Use Node.js 16
-        uses: actions/setup-node@v3
+        uses: actions/setup-node@v4
         with:
-          node-version: "16"
+          node-version: 16
       - name: Get yarn cache directory
         id: yarn-cache-dir
         run: echo "dir=$(yarn cache dir)" >> ${GITHUB_OUTPUT}
@@ -67,6 +87,17 @@ jobs:
             ${{ runner.os }}-node_modules-
 
       - name: E2E Tests Linting in tests/e2e
-        run: make e2e-test-lint
+        working-directory: tests/e2e
+        run: yarn && yarn lint
+
+      - name: Serve files in tests/e2e/src by http-server
+        working-directory: tests/e2e
+        run: echo '\n' | yarn http-server
+
       - name: E2E Tests in tests/e2e
-        run: make e2e-test-ci
+        working-directory: tests/e2e
+        run: |
+          npx zx <<'EOF'
+          await retry(3, expBackoff(), () => $`HEADLESS=new yarn test`)
+          EOF
+        timeout-minutes: 6

.github/workflows/entry_workflow.yml

@@ -32,7 +32,7 @@ jobs:
       - name: Dispatch CIs if the user does have correct permission
         if: contains('admin write', fromJson(steps.user_permission.outputs.data).permission)
         id: dispatch
-        uses: actions/github-script@v6
+        uses: actions/github-script@v7
         with:
           script: |
             const dispatch = {
@@ -48,124 +48,56 @@ jobs:
               .replace(/\\t/g, "\\\\t");
 
             // get pr comments body,not issue comments body
-            const pr =
-             await github.rest.pulls.get({
-               owner: context.repo.owner,
-               repo: context.repo.repo,
-               pull_number: context.issue.number,
+            const pr = await github.rest.pulls.get({
+              owner: context.repo.owner,
+              repo: context.repo.repo,
+              pull_number: context.issue.number,
             });
 
-            let check_list=`
+            let check_list = `
             \### CI test list:
             `;
 
-            // check Coverage Test exist or not
-            const coverage_match = pr.data.body.includes("[x] Coverage Test");
-            if (coverage_match) {
-             const resp =  await github.rest.actions.createWorkflowDispatch({
-              owner: context.repo.owner,
-              repo: context.repo.repo,
-              workflow_id: "coverage.yml",
-              ref: `main`,
-              inputs: {
-                dispatch: jsonDispatch,
-              }
+            const dispatchWorkflow = async (workflowId) => {
+              const resp = await github.rest.actions.createWorkflowDispatch({
+                owner: context.repo.owner,
+                repo: context.repo.repo,
+                workflow_id: workflowId,
+                ref: `main`,
+                inputs: {
+                  dispatch: jsonDispatch,
+                }
               });
+
               core.info(`${JSON.stringify(resp, null, 2)}`);
-              check_list=`${check_list}\n - Coverage Test`;
-              }
+              check_list = `${check_list}\n - ${workflowId}`;
+            };
 
-            // check OCT 1-5 And 12-15 exist or not
-            const OCT_match = pr.data.body.includes("[x] OCT 1-5 And 12-15");
+            // check if OpenZeppelin tests is required
+            const OCT_match = pr.data.body.includes("[x] OpenZeppelin tests");
             if (OCT_match) {
-             const resp =  await github.rest.actions.createWorkflowDispatch({
-              owner: context.repo.owner,
-              repo: context.repo.repo,
-              workflow_id: "openzeppelin_test_1_5_and_12_15.yml",
-              ref: `main`,
-              inputs: {
-                dispatch: jsonDispatch,
-              }
-              });
-              core.info(`${JSON.stringify(resp, null, 2)}`);
-              check_list=`${check_list}\n - OCT 1-5 And 12-15`;
-              }
-            // check OCT 6-10 exist or not
-            const OCT_6_match = pr.data.body.includes("[x] OCT 6-10");
-            if (OCT_6_match) {
-             const resp =  await github.rest.actions.createWorkflowDispatch({
-              owner: context.repo.owner,
-              repo: context.repo.repo,
-              workflow_id: "openzeppelin_test_6_10.yml",
-              ref: `main`,
-              inputs: {
-                dispatch: jsonDispatch,
-              }
-              });
-              core.info(`${JSON.stringify(resp, null, 2)}`);
-              check_list=`${check_list}\n - OCT 6-10`;
-              }
-            // check OCT 11 exist or not
-            const OCT_11_match = pr.data.body.includes("[x] OCT 11");
-            if (OCT_11_match) {
-             const resp =  await github.rest.actions.createWorkflowDispatch({
-              owner: context.repo.owner,
-              repo: context.repo.repo,
-              workflow_id: "openzeppelin_test_11.yml",
-              ref: `main`,
-              inputs: {
-                dispatch: jsonDispatch,
-              }
-              });
-              core.info(`${JSON.stringify(resp, null, 2)}`);
-              check_list=`${check_list}\n - OCT 11`;
-              }
-            // check OCT 16-19 exist or not
-            const OCT_16_match = pr.data.body.includes("[x] OCT 16-19");
-            if (OCT_16_match) {
-             const resp =  await github.rest.actions.createWorkflowDispatch({
-              owner: context.repo.owner,
-              repo: context.repo.repo,
-              workflow_id: "openzeppelin_test_16_19.yml",
-              ref: `main`,
-              inputs: {
-                dispatch: jsonDispatch,
-              }
-              });
-              core.info(`${JSON.stringify(resp, null, 2)}`);
-              check_list=`${check_list}\n - OCT 16-19`;
-              }
+              const workflowIds = [
+                "openzeppelin_test_1_5_and_12_15.yml",
+                "openzeppelin_test_6_10.yml",
+                "openzeppelin_test_11.yml",
+                "openzeppelin_test_16_19.yml",
+              ];
+              await Promise.all(workflowIds.map(dispatchWorkflow));
+            }
+
             // check v3 Core Tests exist or not
             const v3_match = pr.data.body.includes("[x] v3 Core Tests");
             if (v3_match) {
-             const resp =  await github.rest.actions.createWorkflowDispatch({
-              owner: context.repo.owner,
-              repo: context.repo.repo,
-              workflow_id: "v3_core_test.yml",
-              ref: `main`,
-              inputs: {
-                dispatch: jsonDispatch,
-              }
-              });
-              core.info(`${JSON.stringify(resp, null, 2)}`);
-              check_list=`${check_list}\n - v3 Core Tests`;
-              }
+              await dispatchWorkflow("v3_core_test.yml");
+            }
+
             // check Unit Tests exist or not
             const web3_match = pr.data.body.includes("[x] Web3 Compatible Tests");
             if (web3_match) {
-             const resp =  await github.rest.actions.createWorkflowDispatch({
-              owner: context.repo.owner,
-              repo: context.repo.repo,
-              workflow_id: "web3_compatible.yml",
-              ref: `main`,
-              inputs: {
-                dispatch: jsonDispatch,
-              }
-              });
-              core.info(`${JSON.stringify(resp, null, 2)}`);
-              check_list=`${check_list}\n - Web3 Compatible Tests`;
-              };
-              return check_list
+              await dispatchWorkflow("web3_compatible.yml");
+            };
+
+            return check_list
 
       - name: Escape check list
         id: escape_multiple_lines_test_inputs
@@ -179,7 +111,7 @@ jobs:
       - name: Post a coment about component information to PR
         if: contains('admin write', fromJson(steps.user_permission.outputs.data).permission)
         id: post_workflow_run_comment
-        uses: actions/github-script@v6
+        uses: actions/github-script@v7
         with:
           script: |
             console.log(`${{ steps.escape_multiple_lines_test_inputs.outputs.result }}`);