feat!: esm only build

.eslintrc.js → .eslintrc.cjs

@@ -2,7 +2,7 @@ module.exports = {
   extends: ['plugin:@typescript-eslint/recommended', 'prettier', 'plugin:prettier/recommended'],
   parserOptions: {
     sourceType: 'module',
-    ecmaVersion: 2018,
+    ecmaVersion: 2020,
     project: './tsconfig.test.json',
   },
   env: {
@@ -89,6 +89,7 @@ module.exports = {
     ],
     'require-await': 'off',
     '@typescript-eslint/promise-function-async': 'error',
+    // '@typescript-eslint/explicit-function-return-type': 'error',
     '@typescript-eslint/require-await': 'off',
     '@typescript-eslint/no-non-null-assertion': 'off',
     '@typescript-eslint/no-unused-vars': 'off',

.github/workflows/tests.yaml

@@ -52,20 +52,22 @@ jobs:
         if: steps.cache-npm.outputs.cache-hit != 'true'
         run: npm ci
 
-      # Start Bee Factory environment
       - name: Start Bee Factory environment
         if:  matrix.node-version != '18.x'
         run: npm run bee -- --verbose --detach
 
-      # Start Bee Factory environment for Node 18
-      - name: Start Bee Factory environment for Node 18
+      - name: Run unit and integration tests for node
+        if: matrix.node-version != '18.x'
+        run: npm run test:node -- --detectOpenHandles
+
+      - name: Node 18 specific Bee Factory and tests run
         if:  matrix.node-version == '18.x'
         env:
-          NODE_OPTIONS: '--no-experimental-fetch'
-        run: npm run bee -- --verbose --detach
+          NODE_OPTIONS: '--no-experimental-fetch --experimental-vm-modules'
+        run: |
+          npm run bee -- --verbose --detach
+          npm run test:node -- --detectOpenHandles
 
-      - name: Run unit and integration tests for node
-        run: npm run test:node -- --detectOpenHandles
 
       - name: Debug workflow if failed
         if: failure()

README.md

@@ -123,7 +123,15 @@ There are also browser tests by Puppeteer, which also provide integrity testing.
 npm run test:browser
 ```
 The test HTML file which Puppeteer uses is the [test/testpage/testpage.html](test/testpage/testpage.html).
-To open and manually test BeeJS with developer console, it is necessary to build the library first with `npm run compile:browser` (running the browser tests `npm run test:browser` also builds the library).
+To open and manually test BeeJS with developer console, it is necessary to build the library first with `npm run build:browser` (running the browser tests `npm run test:browser` also builds the library).
+
+#### Node 18
+
+In order to run tests on Node 18 you have to disable the experimental Node's Udici/Fetch implementation. Use the `NODE_OPTIONS` env. variable like this:
+
+```shell
+$ export NODE_OPTIONS='--experimental-vm-modules --no-experimental-fetch'
+```
 
 ### Compile code
 

jest-puppeteer.config.cjs

@@ -0,0 +1,8 @@
+module.exports = {
+  launch: {
+    headless: !(process.env.TEST_HEADLESS === 'false'),
+    devtools: process.env.TEST_DEVTOOLS === 'true',
+    args: ['--allow-file-access-from-files'],
+    dumpio: true, // Forwards browser console into test console for easier debugging
+  },
+}

jest.config.mjs

@@ -0,0 +1,62 @@
+/*
+ * For a detailed explanation regarding each configuration property and type check, visit:
+ * https://jestjs.io/docs/en/configuration.html
+ */
+
+export default async () => {
+  return {
+    // Indicates whether the coverage information should be collected while executing the test
+    // collectCoverage: false,
+
+    // This will setup the prerequisites for the tests to run
+    globalSetup: './test/jest/postage-setup.js',
+    setupFiles: ['./test/jest/tests-setup.js'],
+
+    // The directory where Jest should output its coverage files
+    coverageDirectory: 'coverage',
+
+    // Custom sequencer that priorities running unit tests before integration tests
+    testSequencer: './test/jest/test-type-sequencer.js',
+
+    // An array of regexp pattern strings used to skip coverage collection
+    coveragePathIgnorePatterns: ['/node_modules/'],
+
+    extensionsToTreatAsEsm: ['.ts'],
+
+    transform: {
+      '.ts': './test/jest/test-transformer.js',
+    },
+    // Run tests from one or more projects
+    projects: [
+      {
+        displayName: 'node:unit',
+        globalSetup: '',
+        testRegex: 'test/unit/((?!\\.browser).)*\\.spec\\.ts',
+        extensionsToTreatAsEsm: ['.ts'],
+        setupFiles: ['./test/jest/tests-setup.js'],
+        transform: {
+          '.ts': './test/jest/test-transformer.js',
+        },
+      },
+      {
+        displayName: 'dom:integration',
+        testRegex: 'test/integration/.*\\.browser\\.spec\\.ts',
+        preset: 'jest-puppeteer',
+        extensionsToTreatAsEsm: ['.ts'],
+        setupFiles: ['./test/jest/tests-setup.js'],
+        transform: {
+          '.ts': './test/jest/test-transformer.js',
+        },
+      },
+      {
+        displayName: 'node:integration',
+        testRegex: 'test/integration/((?!\\.browser).)*\\.spec\\.ts',
+        extensionsToTreatAsEsm: ['.ts'],
+        setupFiles: ['./test/jest/tests-setup.js'],
+        transform: {
+          '.ts': './test/jest/test-transformer.js',
+        },
+      },
+    ],
+  }
+}