chores: update CI (#1421)

* update CI

* Delete syncToDevOps.yml

* update yaml

* allow package lock updates

* add package lock

* updates

* fixes for testing

* fix typo

* remove eslint

* updates to testing

* update yaml

* continue on error

* remove eslint

* fixing ci issues

Author: YoDaMa

.airtaprc.yml

@@ -1,13 +1,11 @@
-sauce_connect: true
+providers:
+  - airtap-system
+  - airtap-playwright
 ui: mocha-bdd
 browsers:
-  - name: chrome
+  - name: chromium
     version: latest
   - name: firefox
     version: latest
   - name: opera
     version: latest
-  - name: internet explorer
-    version: latest
-  - name: microsoftedge
-    version: latest

.github/workflows/mqttjs-test.yml

@@ -0,0 +1,42 @@
+name: MQTT.js Tests
+
+on:
+  workflow_dispatch:
+    inputs:
+      logLevel:
+        description: 'Debug Filter'     
+        required: true
+        default: 'mqttjs*'
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        node-version: [12.x, 14.x, 16.x]
+      fail-fast: false
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Use Node.js ${{ matrix.node-version }}
+      uses: actions/setup-node@v2
+      with:
+        node-version: ${{ matrix.node-version }}
+        cache: 'npm'
+    - run: npm ci
+    - name: Node Tests
+      run: npm run test:node
+      continue-on-error: true
+      env:
+        CI: true
+        DEBUG: "mqttjs"
+    - name: Test Typescript
+      run: npm run test:typescript
+      env:
+        CI: true
+        DEBUG: "mqttjs"
+

.github/workflows/nodejs.yml

@@ -15,7 +15,6 @@ coverage
 test/typescript/.idea/*
 test/typescript/*.js
 test/typescript/*.map
-package-lock.json
 # VS Code stuff
 **/typings/**
 **/.vscode/**

.github/workflows/syncToDevOps.yml

@@ -1 +0,0 @@
-package-lock = false

.gitignore

@@ -11,7 +11,7 @@ Individuals making significant and valuable contributions are given commit-acces
 There are a few basic ground-rules for contributors:
 
 1. **No `--force` pushes** or modifying the Git history in any way.
-1. **Non-master branches** ought to be used for ongoing work.
+1. **Non-main branches** ought to be used for ongoing work.
 1. **External API changes and significant modifications** ought to be subject to an **internal pull-request** to solicit feedback from other contributors.
 1. Internal pull-requests to solicit feedback are *encouraged* for any other non-trivial contribution but left to the discretion of the contributor.
 1. Contributors should attempt to adhere to the prevailing code-style.

.npmrc

@@ -6,10 +6,6 @@
 MQTT.js is a client library for the [MQTT](http://mqtt.org/) protocol, written
 in JavaScript for node.js and the browser.
 
-| :warning: WARNING          |
-|:---------------------------|
-| our default branch has been moved from *master* to *main*      |
-
 | :boom: MQTT.js vNext          |
 |:---------------------------|
 | Want to contribute to the next generation of **MQTT.js**? Join the discussion [here](https://github.com/mqttjs/MQTT.js/discussions/1324).       |

CONTRIBUTING.md

@@ -22,21 +22,20 @@
   "main": "mqtt.js",
   "types": "types/index.d.ts",
   "scripts": {
-    "test": "node_modules/.bin/nyc --reporter=lcov --reporter=text ./node_modules/mocha/bin/_mocha --exit",
     "pretest": "standard | snazzy",
-    "tslint": "tslint types/**/*.d.ts",
     "typescript-compile-test": "tsc -p test/typescript/tsconfig.json",
-    "typescript-compile-execute": "node test/typescript/*.js",
-    "typescript-test": "npm run typescript-compile-test && npm run typescript-compile-execute",
+    "typescript-compile-execute": "node test/typescript/broker-connect-subscribe-and-publish.js",
     "browser-build": "rimraf dist/ && mkdirp dist/ && browserify mqtt.js --standalone mqtt > dist/mqtt.js && uglifyjs dist/mqtt.js --compress --mangle --output dist/mqtt.min.js",
     "prepare": "npm run browser-build",
-    "browser-test": "airtap --server test/browser/server.js --local --open test/browser/test.js",
-    "sauce-test": "airtap --server test/browser/server.js -- test/browser/test.js",
-    "ci": "npm run tslint && npm run typescript-compile-test && npm run test && codecov"
+    "unit-test:node": "node_modules/.bin/nyc --reporter=lcov --reporter=text ./node_modules/mocha/bin/_mocha --exit",
+    "unit-test:browser": "airtap --server test/browser/server.js test/browser/test.js",
+    "test:node": "npm run unit-test:node && codecov",
+    "test:browser": "npm run browser-build && npm run unit-test:browser",
+    "test:typescript": "npm run typescript-compile-test && npm run typescript-compile-execute",
+    "test": "npm run test:node && npm run test:typescript"
   },
   "pre-commit": [
-    "pretest",
-    "tslint"
+    "pretest"
   ],
   "bin": {
     "mqtt_pub": "./bin/pub.js",
@@ -82,16 +81,18 @@
   },
   "devDependencies": {
     "@types/node": "^10.0.0",
+    "@types/tape": "^4.13.2",
     "@types/ws": "^7.4.7",
-    "aedes": "^0.42.5",
+    "aedes": "^0.46.2",
     "airtap": "^4.0.4",
     "browserify": "^16.5.0",
     "chai": "^4.2.0",
+    "chokidar": "^3.5.3",
     "codecov": "^3.0.4",
     "end-of-stream": "^1.4.1",
     "global": "^4.3.2",
     "mkdirp": "^0.5.1",
-    "mocha": "^9.1.3",
+    "mocha": "^9.2.0",
     "mqtt-connection": "^4.0.0",
     "nyc": "^15.0.1",
     "pre-commit": "^1.2.2",
@@ -100,23 +101,13 @@
     "sinon": "^9.0.0",
     "snazzy": "^9.0.0",
     "standard": "^16.0.4",
-    "tslint": "^5.11.0",
-    "tslint-config-standard": "^8.0.1",
-    "typescript": "^3.2.2",
+    "tape": "^5.5.2",
+    "typescript": "^4.5.5",
     "uglify-es": "^3.3.9"
   },
   "standard": {
     "env": [
       "mocha"
-    ],
-    "globals": [
-      "expect",
-      "test",
-      "describe",
-      "it",
-      "beforeEach",
-      "beforeAll",
-      "afterAll"
     ]
   }
 }

README.md

@@ -1,7 +1,7 @@
 'use strict'
 
+const test = require('tape')
 const mqtt = require('../../lib/connect')
-const xtend = require('xtend')
 const _URL = require('url')
 // eslint-disable-next-line
 const parsed = _URL.parse(document.URL)
@@ -10,85 +10,27 @@ const port = parsed.port || (isHttps ? 443 : 80)
 const host = parsed.hostname
 const protocol = isHttps ? 'wss' : 'ws'
 
-function clientTests (buildClient) {
-  let client
-
-  // eslint-disable-next-line
-  beforeEach(function () {
-    client = buildClient()
-    client.on('offline', function () {
-      console.log('client offline')
-    })
-    client.on('connect', function () {
-      console.log('client connect')
-    })
-    client.on('reconnect', function () {
-      console.log('client reconnect')
-    })
-  })
-
-  afterEach(function (done) {
-    client.once('close', function () {
-      done()
+const client = mqtt.connect({ protocolId: 'MQIsdp', protocolVersion: 3, protocol: protocol, port: port, host: host })
+client.on('offline', function () {
+  console.log('client offline')
+})
+client.on('connect', function () {
+  console.log('client connect')
+})
+client.on('reconnect', function () {
+  console.log('client reconnect')
+})
+
+test('MQTT.js browser test', function (t) {
+  t.plan(2)
+  client.on('connect', function () {
+    client.on('message', function (msg) {
+      t.equal(msg, 'Hello World!')
     })
-    client.end()
-  })
-
-  it('should connect', function (done) {
-    client.on('connect', function () {
-      done()
-    })
-  })
-
-  it('should publish and subscribe', function (done) {
     client.subscribe('hello', function () {
-      done()
-    }).publish('hello', 'world')
+    }).publish('hello', 'Hello World!')
   })
-}
-
-function suiteFactory (configName, opts) {
-  function setVersion (base) {
-    return xtend(base || {}, opts)
-  }
-
-  const suiteName = 'MqttClient(' + configName + '=' + JSON.stringify(opts) + ')'
-  describe(suiteName, function () {
-    this.timeout(10000)
-
-    describe('specifying nothing', function () {
-      clientTests(function () {
-        return mqtt.connect(setVersion())
-      })
-    })
-
-    if (parsed.hostname === 'localhost') {
-      describe('specifying a port', function () {
-        clientTests(function () {
-          return mqtt.connect(setVersion({ protocol: protocol, port: port }))
-        })
-      })
-    }
-
-    describe('specifying a port and host', function () {
-      clientTests(function () {
-        return mqtt.connect(setVersion({ protocol: protocol, port: port, host: host }))
-      })
-    })
-
-    describe('specifying a URL', function () {
-      clientTests(function () {
-        return mqtt.connect(protocol + '://' + host + ':' + port, setVersion())
-      })
-    })
-
-    describe('specifying a URL with a path', function () {
-      clientTests(function () {
-        return mqtt.connect(protocol + '://' + host + ':' + port + '/mqtt', setVersion())
-      })
-    })
+  client.once('close', function () {
+    t.true(true)
   })
-}
-
-suiteFactory('v3', { protocolId: 'MQIsdp', protocolVersion: 3 })
-suiteFactory('default', {})
+})

package-lock.json

@@ -1,4 +1,5 @@
 // relative path uses package.json {"types":"types/index.d.ts", ...}
+import test from 'tape'
 import {IClientOptions, Client, connect, IConnackPacket, UniqueMessageIdProvider} from '../..'
 const BROKER = 'test.mosquitto.org'
 
@@ -9,18 +10,24 @@ const TOPIC = 'typescript-test-' + Math.random().toString(16).substr(2)
 const opts: IClientOptions = {will: {topic: TOPIC, payload: PAYLOAD_WILL, qos: 0, retain: false},
                               messageIdProvider: new UniqueMessageIdProvider()}
 
-console.log(`connect(${JSON.stringify(BROKER)})`)
-const client:Client = connect(`mqtt://${BROKER}`, opts)
-
-client.subscribe({[TOPIC]: {qos: 2}}, (err, granted) => {
-    granted.forEach(({topic, qos}) => {
-        console.log(`subscribed to ${topic} with qos=${qos}`)
+test('client test', function (t) {
+    t.plan(1)
+    console.log(`connect(${JSON.stringify(BROKER)})`)
+    const client:Client = connect(`mqtt://${BROKER}`, opts)
+    client.subscribe({[TOPIC]: {qos: 2}}, (err, granted) => {
+        granted.forEach(({topic, qos}) => {
+            console.log(`subscribed to ${topic} with qos=${qos}`)
+        })
+        client.publish(TOPIC, PAYLOAD_QOS, {qos: 2})
+        client.publish(TOPIC, PAYLOAD_RETAIN, {retain: true})
+    }).on('message', (topic: string, payload: Buffer) => {
+        t.ok(payload)
+        console.log(`message from ${topic}: ${payload}`)
+        client.end(true, () => {
+            console.log('client closed')
+            t.end()
+        })
+    }).on('connect', (packet: IConnackPacket) => {
+        console.log('connected!', JSON.stringify(packet))
     })
-    client.publish(TOPIC, PAYLOAD_QOS, {qos: 2})
-    client.publish(TOPIC, PAYLOAD_RETAIN, {retain: true})
-}).on('message', (topic: string, payload: Buffer) => {
-    console.log(`message from ${topic}: ${payload}`)
-    client.end()
-}).on('connect', (packet: IConnackPacket) => {
-    console.log('connected!', JSON.stringify(packet))
 })

package.json

@@ -9,6 +9,7 @@
     "strictNullChecks": true,
     "noImplicitReturns": true,
     "noImplicitThis": true,
-    "sourceMap": true
+    "sourceMap": true,
+    "esModuleInterop": true
   }
 }