Migrate to node 18 and ESM

Author: Immanuel Pelzer

.eslintrc.js .eslintrc.cjs

@@ -29,3 +29,6 @@ results.xml
 
 # npm packages
 *.tgz
+
+# tests
+coverage

.gitignore

@@ -1,4 +1,4 @@
-image: node:14.19-alpine
+image: node:18.12-alpine
 
 include:
   # See template for docs
@@ -21,7 +21,7 @@ services:
 
 # Overwrite the template test job, so we can wait for rabbitmq to be running
 # Moving this to the tests did not work as expected and tests kept still failing
-test-node14-19:
+test:
   stage: test
   script:
   # Wait for RabbitMQ to be running
@@ -37,31 +37,6 @@ test-node14-19:
     reports:
       junit: results.xml
 
-test-node16-14:
-  image: node:16.14-alpine
-  stage: test
-  script:
-  # Wait for RabbitMQ to be running
-  - while ! nc -z localhost 15692 ; do sleep 1 ; done
-  - npm i
-  - npm run test
-
-test-node18-12:
-  image: node:18.12-alpine
-  stage: test
-  script:
-  # Wait for RabbitMQ to be running
-  - while ! nc -z localhost 15692 ; do sleep 1 ; done
-  - npm i
-  - npm run test
-
-test-pact:
-  image: node:14.19
-  stage: test
-  script:
-  - npm i
-  - npm run test-pact
-
 audit:
   stage: test
   script:

.gitlab-ci.yml

@@ -4,6 +4,12 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+# [5.0.0] - 2022-11-15
+
+## Breaking changes
+
+- Updates the module to ESM. Only ESM is supported now.
+
 # [4.2.1] - 2022-11-04
 
 - Fix issues with Taube overwriting critical Prometheus metrics (e.g. `up`)

CHANGELOG.md

@@ -32,7 +32,7 @@ This repository does not publish npm packages **yet**.
 One service acts as a `Server` providing data and another as a `Client` requesting data.
 
 ```javascript
-const taube = require('@cloud/taube')
+import taube from '@cloud/taube'
 taube.http.init()
 
 const server = new taube.Server({})
@@ -52,7 +52,7 @@ server.get(
 Any Client can now request data:
 
 ```javascript
-const taube = require('@cloud/taube')
+import taube from '@cloud/taube'
 
 const client = new taube.Client({
   uri: 'http://scooter'
@@ -70,7 +70,7 @@ The `Client` and `Server` components mimic the standard way of sending and routi
 `Client` component is a wrapper around [got](https://github.com/sindresorhus/got) that exposes different http methods to send a request.
 
 ```javascript
-const taube = require('@cloud/taube')
+import taube from '@cloud/taube'
 
 const client = new taube.Client({
   uri: 'http://scooter'
@@ -122,7 +122,7 @@ client.get(`/?page=2`, { query: { type: 'UNU2' }})
 The `Server` component require HTTP to be intialized. Add `taube.http.init()`.
 
 ```javascript
-const taube = require('@cloud/taube')
+import taube from '@cloud/taube'
 taube.http.init()
 
 const server = new taube.Server({})
@@ -244,7 +244,7 @@ const response = await client.paginate('/scooters', { page: 3, limit: 10 })
 The `Server` component require HTTP to be intialized. Add `taube.http.init()`.
 
 ```javascript
-const taube = require('@cloud/taube')
+import taube from '@cloud/taube'
 taube.http.init()
 
 const responder = new taube.Responder({
@@ -267,7 +267,7 @@ responder.on('get user', async({ prop1, prop2 }) => {
 ### Requesters
 
 ```javascript
-const taube = require('@cloud/taube')
+import taube from '@cloud/taube'
 
 // Creating the requester needs to be one of the first things in your application
 // Assuming that a Responder with the given key is set up on the given uri
@@ -301,7 +301,6 @@ The `url` option needs to include `http` or `https` without a `/` at the end.
 | Variable           | Default          | Description
 | ------------------ |:----------------:| ---
 | TAUBE_HTTP_PORT    | 4321             | Port of http server
-| TAUBE_DEBUG   | undefined        | Adds debugging information to Taube responses. See tests for usage. This does change responses and is only designed for development.
 | TAUBE_UNIT_TESTS   | undefined        | If set all requesters default their uri to <http://localhost>
 | TAUBE_RETRIES | 3 | Number of retries any Requester does before giving up. 3 is maximum value as retry duration would be over timeout.
 | TAUBE_JSON_SIZE_LIMIT |500kb | Size limit for JSON file
@@ -311,15 +310,15 @@ The `url` option needs to include `http` or `https` without a `/` at the end.
 @infrastructure/observability can be used to get readiness/liveness checks and signal handling for the taube http server.
 
 ```javascript
-const observability = require('@infrastructure/observability')
+import observability from '@infrastructure/observability'
 
 observability.monitoring.observeServer(taube.http.server, taube.http.app)
 ```
 
 In order to gracefully handle Signal Handling and add liveness/readyness checks for AMQP, the following code can be used
 
 ```javascript
-const observability = require('@infrastructure/observability')
+import observability from '@infrastructure/observability'
 
 observability.monitoring.addOnSignalHook(taube.shutdown)
 ```
@@ -548,7 +547,7 @@ And there are two ways of throwing a taube error instance.
 #### Throwing an error using constructor name
 
 ```javascript
-const { Errors } = require('@cloud/taube')
+import { Errors } from '@cloud/taube'
 
 // joi/celebrate validation error
 if(VALIDATION_FAILURE) {
@@ -561,7 +560,7 @@ if(VALIDATION_FAILURE) {
 #### Throwing an error using statusCode
 
 ```javascript
-const { Errors } = require('@cloud/taube')
+import { Errors } from '@cloud/taube'
 
 // your code
 if(!scooter) {
@@ -660,6 +659,8 @@ A few tests need to run before any other. These tests are prefixed by 0.X. Do no
 
 ## Migrate from cote
 
+You will have to install taube at version 2. `npm install @cloud/taube@2` to follow this part.
+
 Version 0.X is designed to have a clear migration path to remove cote. Taube 0.X is a drop in replacement for cote. Without configuration it functions as a wrapper to cote and keeps using cote for communication. It also sets up http Responders, which means the service using Taube can be targeted by Taube Requesters.
 
 There is 3 modes you can run taube in while migrating from cote to taube.
@@ -728,8 +729,8 @@ Remove this function call to migrate to v4.
 
 This will be required for most Services. Add it after requiring taube in your index.js:
 
-```
-const taube = require('@cloud/taube')
+```js
+import taube from '@cloud/taube'
 taube.http.init() // This was added
 ```
 

README.md

@@ -1,4 +1,4 @@
-const { Client } = require('../../lib')
+import { Client } from '../../lib/index.js'
 
 const client = new Client({
   uri: 'http://localhost', // uri of the server, e.g. http://scooter

examples/Client_Server/client.js

@@ -1,5 +1,4 @@
-const taube = require('../../lib')
-const { Server, Joi } = require('../../lib')
+import taube, { Server, Joi } from '../../lib/index.js'
 
 const server = new Server({})
 taube.http.init()

examples/Client_Server/server.js

@@ -1,4 +1,4 @@
-const { Errors } = require('../../lib')
+import { Errors } from '../../lib/index.js'
 
 function getScooter(vin) {
   if (!vin) {

examples/Errors/badrequest.js

@@ -1,4 +1,4 @@
-const { Errors } = require('../../lib')
+import { Errors } from '../../lib/index.js'
 
 function getScooter(vin) {
   if (!vin) {

examples/Errors/notfound-statuscode.js

@@ -1,4 +1,4 @@
-const { Errors } = require('../../lib')
+import { Errors } from '../../lib/index.js'
 
 function getScooter() {
   throw new Errors.NotFound('vin not found', { details: 'vin abcde not found' })

examples/Errors/notfound.js

@@ -1,4 +1,4 @@
-const taube = require('../../lib')
+import taube from '../../lib/index.js'
 
 async function main() {
   taube.init()

examples/Publisher_Subscriber/index.js

@@ -1,4 +1,4 @@
-const taube = require('../../lib')
+import taube from '../../lib/index.js'
 
 async function main() {
   taube.init()

examples/Queue_Worker/queue-worker.js

@@ -1,4 +1,4 @@
-const taube = require('../../lib')
+import taube from '../../lib/index.js'
 
 const userRequester = new taube.Requester({
   key: 'users', // Key of responder from server2-responder.js

examples/Requester_Responder/server1-requester.js

@@ -1,4 +1,4 @@
-const taube = require('../../lib')
+import taube from '../../lib/index.js'
 
 taube.http.init()
 const userResponder = new taube.Responder({ key: 'users' })

examples/Requester_Responder/server2-responder.js

@@ -1,5 +1,5 @@
-const observability = require('@infrastructure/observability')
-const taube = require('@cloud/taube')
+import observability from '@infrastructure/observability'
+import taube from '@cloud/taube'
 
 taube.http.init()
 

examples/Setup/index.js

@@ -1,4 +1,4 @@
-const taube = require('../../lib')
+import taube from '../../lib/index.js'
 
 taube.http.init()
 

examples/Sockend/responder.js

@@ -1,8 +1,10 @@
-const express = require('express')
-const http = require('http')
+import express from 'express'
+import http from 'http'
+
 // eslint-disable-next-line import/no-extraneous-dependencies
-const ioServer = require('socket.io')
-const taube = require('../../lib')
+import ioServer from 'socket.io'
+
+import taube from '../../lib/index.js'
 
 // Setup the underlying socket.io server
 const port = 6000

examples/Sockend/sockend.js

@@ -1,8 +1,8 @@
-const taube = require('../../lib')
+import taube from '../../lib/index.js'
 
-taube.http.init()
+import service from './service.js'
 
-const service = require('./service')
+taube.http.init()
 
 const client = new taube.Client({ uri: 'http://scooter' })
 const server = new taube.Server({})

examples/pagination/Client_Server.js

@@ -1,6 +1,7 @@
-const mongoose = require('mongoose')
+import mongoose from 'mongoose'
+
 // https://github.com/aravindnc/mongoose-paginate-v2
-const mongoosePaginate = require('mongoose-paginate-v2')
+import mongoosePaginate from 'mongoose-paginate-v2'
 
 const scooterSchema = new mongoose.Schema({
   vin: { type: String },
@@ -45,6 +46,6 @@ const getPaginatedScooters = async(query = { page: 1, limit: 20 /** service limi
   return paginatedData
 }
 
-module.exports = {
+export default {
   getPaginatedScooters,
 }

examples/pagination/service.js

@@ -1,7 +1,8 @@
-const amqp = require('amqp-connection-manager')
-const debug = require('debug')('taube-amqp')
+import amqp, { AmqpConnectionManagerClass } from 'amqp-connection-manager'
+import debugFactory from 'debug'
+import config from './config/index.js'
 
-const config = require('./config')
+const debug = debugFactory('taube-amqp')
 
 const connections = {}
 let channels = []
@@ -33,7 +34,7 @@ async function connection(uri, options = {}) {
   errorHandler = options.errorHandler || defaultErrorHandler
 
   debug('AMQP connecting to ', uri)
-  const manager = new amqp.AmqpConnectionManagerClass(uri, options)
+  const manager = new AmqpConnectionManagerClass(uri, options)
   connections[uri] = manager.connect({ timeout: config.amqp.initialConnectionTimeout })
     .then(() => {
       debug('AMQP connected to ', uri)
@@ -93,7 +94,7 @@ function getChannels() {
   return channels
 }
 
-module.exports = {
+export default {
   amqp,
   connection,
   shutdown,

lib/amqp.js

@@ -1,11 +1,12 @@
 /* eslint-disable no-underscore-dangle */
-const got = require('got')
+import got from 'got'
 
-const config = require('../config')
-const pkg = require('../../package.json')
+import fs from 'node:fs'
+import config from '../config/index.js'
+import uriHelper from '../helpers/uri.js'
+import { convertToTaubeError } from './errors.js'
 
-const uriHelper = require('../helpers/uri')
-const Errors = require('./errors')
+const pkg = JSON.parse(fs.readFileSync('package.json'))
 
 const retry = {
   limit: config.got.retries,
@@ -51,7 +52,7 @@ class Client {
       })
       return response.body
     } catch (error) {
-      throw Errors.convertToTaubeError(error)
+      throw convertToTaubeError(error)
     }
   }
 
@@ -66,7 +67,7 @@ class Client {
       })
       return response.body
     } catch (error) {
-      throw Errors.convertToTaubeError(error)
+      throw convertToTaubeError(error)
     }
   }
 
@@ -83,7 +84,7 @@ class Client {
 
       return response.body
     } catch (error) {
-      throw Errors.convertToTaubeError(error)
+      throw convertToTaubeError(error)
     }
   }
 
@@ -100,7 +101,7 @@ class Client {
 
       return response.body
     } catch (error) {
-      throw Errors.convertToTaubeError(error)
+      throw convertToTaubeError(error)
     }
   }
 
@@ -116,9 +117,9 @@ class Client {
 
       return response.body
     } catch (error) {
-      throw Errors.convertToTaubeError(error)
+      throw convertToTaubeError(error)
     }
   }
 }
 
-module.exports = Client
+export default Client