chore: run examples and interop as part of main ci run (#1858)

Instead of installing deps for main, exmaples and multidim-interop,
add examples and multidim interop to main.yml so we only install
once and block releases if examples or interop fail.

Author: achingbrain

.github/workflows/examples.yml

@@ -9,7 +9,17 @@ on:
 
 jobs:
 
+  build:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v3
+    - uses: actions/setup-node@v3
+      with:
+        node-version: lts/*
+    - uses: ipfs/aegir/actions/cache-node-modules@master
+
   check:
+    needs: build
     runs-on: ubuntu-latest
     steps:
     - uses: actions/checkout@v3
@@ -21,12 +31,12 @@ jobs:
     - run: npm run --if-present dep-check
 
   test-node:
-    needs: check
+    needs: build
     runs-on: ${{ matrix.os }}
     strategy:
       matrix:
         os: [windows-latest, ubuntu-latest, macos-latest]
-        node: [16]
+        node: [lts/*]
       fail-fast: true
     steps:
       - uses: actions/checkout@v3
@@ -41,7 +51,7 @@ jobs:
           flags: node
 
   test-chrome:
-    needs: check
+    needs: build
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v3
@@ -56,7 +66,7 @@ jobs:
           flags: chrome
 
   test-chrome-webworker:
-    needs: check
+    needs: build
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v3
@@ -71,7 +81,7 @@ jobs:
           flags: chrome-webworker
 
   test-firefox:
-    needs: check
+    needs: build
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v3
@@ -86,7 +96,7 @@ jobs:
           flags: firefox
 
   test-firefox-webworker:
-    needs: check
+    needs: build
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v3
@@ -101,7 +111,7 @@ jobs:
           flags: firefox-webworker
 
   test-webkit:
-    needs: check
+    needs: build
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v3
@@ -117,7 +127,7 @@ jobs:
           flags: webkit
 
   test-electron-main:
-    needs: check
+    needs: build
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v3
@@ -132,7 +142,7 @@ jobs:
           flags: electron-main
 
   test-electron-renderer:
-    needs: check
+    needs: build
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v3
@@ -147,7 +157,7 @@ jobs:
           flags: electron-renderer
 
   test-interop:
-    needs: check
+    needs: build
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v3
@@ -157,6 +167,66 @@ jobs:
       - uses: ipfs/aegir/actions/cache-node-modules@master
       - run: npm run test:interop -- --bail
 
+  test-example:
+    needs: build
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        example: [
+          chat,
+          connection-encryption,
+          discovery-mechanisms,
+          echo,
+          libp2p-in-the-browser,
+          peer-and-content-routing,
+          pnet,
+          protocol-and-stream-muxing,
+          pubsub,
+          transports
+        ]
+      fail-fast: true
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-node@v3
+        with:
+          node-version: lts/*
+      - uses: ipfs/aegir/actions/cache-node-modules@master
+        with:
+          directories: |
+            ./examples/node_modules
+            ~/.cache
+          build: |
+            cd examples
+            npm i
+            npx playwright install
+          cache_name: cache-examples
+      - run: |
+          cd examples
+          npm run test -- ${{ matrix.example }}
+
+  multidim-interop:
+    needs: build
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: ipfs/aegir/actions/cache-node-modules@master
+      - name: Build images
+        run: (cd interop && make)
+      - name: Save package-lock.json as artifact
+        uses: actions/upload-artifact@v2
+        with:
+          name: package locks
+          path: |
+            package-lock.json
+            interop/package-lock.json
+      - uses: libp2p/test-plans/.github/actions/run-interop-ping-test@master
+        with:
+          test-filter: js-libp2p-head
+          extra-versions: ${{ github.workspace }}/interop/node-version.json ${{ github.workspace }}/interop/chromium-version.json ${{ github.workspace }}/interop/firefox-version.json
+          s3-cache-bucket: ${{ vars.S3_LIBP2P_BUILD_CACHE_BUCKET_NAME }}
+          s3-access-key-id: ${{ vars.S3_LIBP2P_BUILD_CACHE_AWS_ACCESS_KEY_ID }}
+          s3-secret-access-key: ${{ secrets.S3_LIBP2P_BUILD_CACHE_AWS_SECRET_ACCESS_KEY }}
+
   release:
     runs-on: ubuntu-latest
     needs: [
@@ -167,7 +237,9 @@ jobs:
       test-firefox-webworker,
       test-electron-main,
       test-electron-renderer,
-      test-interop
+      test-interop,
+      test-example,
+      multidim-interop
     ]
     if: github.event_name == 'push' && github.ref == 'refs/heads/master'
     steps:

.github/workflows/interop-test.yml

@@ -4,8 +4,8 @@ FROM mcr.microsoft.com/playwright
 
 COPY --from=node-js-libp2p-head /app/ /app/
 WORKDIR /app/interop
-RUN ./node_modules/.bin/playwright install
+RUN npx playwright install
 ARG BROWSER=chromium # Options: chromium, firefox, webkit
 ENV BROWSER=$BROWSER
 
-ENTRYPOINT npm test -- --build false --types false -t browser -- --browser $BROWSER
+ENTRYPOINT npm run test:interop:multidim -- --build false --types false -t browser -- --browser $BROWSER

.github/workflows/main.yml

@@ -4,12 +4,8 @@ WORKDIR /app
 COPY package.json .
 COPY ./node_modules ./node_modules
 COPY ./packages ./packages
+COPY ./interop ./interop
 
 WORKDIR /app/interop
-COPY ./interop/node_modules ./node_modules
-COPY ./interop/dist ./dist
-COPY ./interop/package.json .
-COPY ./interop/.aegir.js .
-COPY ./interop/relay.js .
 
-ENTRYPOINT [ "npm", "test", "--", "--build", "false", "--types", "false", "-t", "node" ]
+ENTRYPOINT [ "npm", "run", "test:interop:multidim", "--", "--build", "false", "--types", "false", "-t", "node" ]

interop/BrowserDockerfile

@@ -10,7 +10,7 @@
   "scripts": {
     "start": "node index.js",
     "build": "aegir build",
-    "test": "aegir test"
+    "test:interop:multidim": "aegir test"
   },
   "dependencies": {
     "@chainsafe/libp2p-noise": "^12.0.0",

interop/Dockerfile

@@ -45,6 +45,7 @@
     ]
   },
   "workspaces": [
-    "packages/*"
+    "packages/*",
+    "interop"
   ]
 }

interop/package.json

@@ -83,7 +83,7 @@
     "test:chrome-webworker": "aegir test -t webworker",
     "test:firefox": "aegir test -t browser -- --browser firefox",
     "test:firefox-webworker": "aegir test -t webworker -- --browser firefox",
-    "test:webkit": "bash -c '[ \"${CI}\" == \"true\" ] && playwright install-deps'; aegir test -t browser -- --browser webkit",
+    "test:webkit": "aegir test -t browser -- --browser webkit",
     "test:node": "aegir test -t node --cov",
     "test:electron-main": "aegir test -t electron-main",
     "generate": "protons ./src/keys/keys.proto"