ntpclient 1.6.3 → 1.6.4

package/package.json

@@ -2,13 +2,13 @@
   "author": "Florian Imdahl <git@ffflorian.de>",
   "bin": "dist/cjs/cli.js",
   "dependencies": {
-    "commander": "12.0.0"
+    "commander": "12.1.0"
   },
   "description": "A TypeScript implementation of the NTP Client Protocol",
   "devDependencies": {
-    "rimraf": "5.0.5",
-    "typescript": "5.4.4",
-    "vitest": "1.4.0"
+    "rimraf": "5.0.7",
+    "typescript": "5.4.5",
+    "vitest": "1.6.0"
   },
   "engines": {
     "node": ">= 18.0"
@@ -20,8 +20,7 @@
     }
   },
   "files": [
-    "dist",
-    "src"
+    "dist"
   ],
   "license": "GPL-3.0",
   "main": "dist/cjs/index.js",
@@ -39,6 +38,6 @@
     "test": "vitest run"
   },
   "type": "module",
-  "version": "1.6.3",
-  "gitHead": "ca4256609abc0b2ce6b44c4d0691c250830e2993"
+  "version": "1.6.4",
+  "gitHead": "28c184f53a87d8eb082cc27c923ef7b352bbe875"
 }

package/dist/cjs/index.test.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/cjs/index.test.js

@@ -1,60 +0,0 @@
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
-/* eslint-disable no-magic-numbers */
-import { assert, expect, describe, test, beforeEach, vi, afterEach } from 'vitest';
-import { NTPClient } from './index.js';
-const SECOND_IN_MILLIS = 1000;
-const replyTimeout = 10 * SECOND_IN_MILLIS;
-describe('NTP', () => {
-    beforeEach(() => {
-        vi.mock('dgram', () => __awaiter(void 0, void 0, void 0, function* () {
-            const actual = (yield vi.importActual('dgram'));
-            const socket = actual.createSocket('udp4');
-            return Object.assign(Object.assign({}, actual), { send: () => {
-                    socket.emit('message', Buffer.from([
-                        0x1c, 0x02, 0x03, 0xe8, 0x00, 0x00, 0x02, 0x1a, 0x00, 0x00, 0x05, 0x12, 0xc0, 0x35, 0x67, 0x6c, 0xe9,
-                        0x03, 0x76, 0xff, 0xff, 0x97, 0x0f, 0x08, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0xe9, 0x03,
-                        0x78, 0x0f, 0xe9, 0xd6, 0x4e, 0x10, 0xe9, 0x03, 0x78, 0x0f, 0xea, 0x03, 0x93, 0xf5,
-                    ]));
-                } });
-        }));
-    });
-    afterEach(() => {
-        vi.resetAllMocks();
-    });
-    test('returns the current time', () => __awaiter(void 0, void 0, void 0, function* () {
-        const ntpClient = new NTPClient({
-            replyTimeout,
-        });
-        const data = yield ntpClient.getNetworkTime();
-        expect(data).toEqual(expect.any(Date));
-    }), replyTimeout);
-    test('works with another NTP server', () => __awaiter(void 0, void 0, void 0, function* () {
-        const ntpClient = new NTPClient({
-            replyTimeout,
-            server: '0.pool.ntp.org',
-        });
-        const data = yield ntpClient.getNetworkTime();
-        expect(data).toEqual(expect.any(Date));
-    }), replyTimeout);
-    test("doesn't work with an invalid NTP server", () => __awaiter(void 0, void 0, void 0, function* () {
-        try {
-            const ntpClient = new NTPClient({
-                replyTimeout: SECOND_IN_MILLIS,
-                server: 'google.com',
-            });
-            yield ntpClient.getNetworkTime();
-            assert.fail();
-        }
-        catch (error) {
-            expect(error.message).toContain('Timeout');
-        }
-    }));
-});

package/dist/esm/index.test.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/esm/index.test.js

@@ -1,51 +0,0 @@
-/* eslint-disable no-magic-numbers */
-import { assert, expect, describe, test, beforeEach, vi, afterEach } from 'vitest';
-import { NTPClient } from './index.js';
-const SECOND_IN_MILLIS = 1000;
-const replyTimeout = 10 * SECOND_IN_MILLIS;
-describe('NTP', () => {
-    beforeEach(() => {
-        vi.mock('dgram', async () => {
-            const actual = (await vi.importActual('dgram'));
-            const socket = actual.createSocket('udp4');
-            return Object.assign(Object.assign({}, actual), { send: () => {
-                    socket.emit('message', Buffer.from([
-                        0x1c, 0x02, 0x03, 0xe8, 0x00, 0x00, 0x02, 0x1a, 0x00, 0x00, 0x05, 0x12, 0xc0, 0x35, 0x67, 0x6c, 0xe9,
-                        0x03, 0x76, 0xff, 0xff, 0x97, 0x0f, 0x08, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0xe9, 0x03,
-                        0x78, 0x0f, 0xe9, 0xd6, 0x4e, 0x10, 0xe9, 0x03, 0x78, 0x0f, 0xea, 0x03, 0x93, 0xf5,
-                    ]));
-                } });
-        });
-    });
-    afterEach(() => {
-        vi.resetAllMocks();
-    });
-    test('returns the current time', async () => {
-        const ntpClient = new NTPClient({
-            replyTimeout,
-        });
-        const data = await ntpClient.getNetworkTime();
-        expect(data).toEqual(expect.any(Date));
-    }, replyTimeout);
-    test('works with another NTP server', async () => {
-        const ntpClient = new NTPClient({
-            replyTimeout,
-            server: '0.pool.ntp.org',
-        });
-        const data = await ntpClient.getNetworkTime();
-        expect(data).toEqual(expect.any(Date));
-    }, replyTimeout);
-    test("doesn't work with an invalid NTP server", async () => {
-        try {
-            const ntpClient = new NTPClient({
-                replyTimeout: SECOND_IN_MILLIS,
-                server: 'google.com',
-            });
-            await ntpClient.getNetworkTime();
-            assert.fail();
-        }
-        catch (error) {
-            expect(error.message).toContain('Timeout');
-        }
-    });
-});

package/src/cli.ts

@@ -1,42 +0,0 @@
-#!/usr/bin/env node
-
-import {program as commander} from 'commander';
-import {createRequire} from 'module';
-const require = createRequire(import.meta.url);
-
-import {NTPClient} from './index.js';
-
-interface PackageJson {
-  bin: Record<string, string>;
-  description: string;
-  version: string;
-}
-
-const {bin, description, version}: PackageJson = require('../package.json');
-
-commander
-  .name(Object.keys(bin)[0])
-  .version(version)
-  .description(description)
-  .option('-s, --server <host>', 'Specify a custom NTP server')
-  .option('-p, --port <number>', 'Specify a custom NTP port')
-  .option('-t, --timeout <number>', 'Specify the timeout in milliseconds')
-  .parse(process.argv);
-
-const commanderOptions = commander.opts();
-
-void (async () => {
-  try {
-    const date = await new NTPClient({
-      ...(commanderOptions.server && {server: commanderOptions.server}),
-      ...(commanderOptions.port && {port: commanderOptions.port}),
-      ...(commanderOptions.timeout && {replyTimeout: commanderOptions.timeout}),
-    }).getNetworkTime();
-
-    console.info(date.toString());
-    process.exit();
-  } catch (error) {
-    console.error(error);
-    process.exit(1);
-  }
-})();

package/src/index.test.ts

@@ -1,70 +0,0 @@
-/* eslint-disable no-magic-numbers */
-import {assert, expect, describe, test, beforeEach, vi, afterEach} from 'vitest';
-import {NTPClient} from './index.js';
-import type dgram from 'dgram';
-
-const SECOND_IN_MILLIS = 1000;
-const replyTimeout = 10 * SECOND_IN_MILLIS;
-
-describe('NTP', () => {
-  beforeEach(() => {
-    vi.mock('dgram', async () => {
-      const actual = (await vi.importActual('dgram')) as typeof dgram;
-      const socket = actual.createSocket('udp4');
-      return {
-        ...actual,
-        send: () => {
-          socket.emit(
-            'message',
-            Buffer.from([
-              0x1c, 0x02, 0x03, 0xe8, 0x00, 0x00, 0x02, 0x1a, 0x00, 0x00, 0x05, 0x12, 0xc0, 0x35, 0x67, 0x6c, 0xe9,
-              0x03, 0x76, 0xff, 0xff, 0x97, 0x0f, 0x08, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0xe9, 0x03,
-              0x78, 0x0f, 0xe9, 0xd6, 0x4e, 0x10, 0xe9, 0x03, 0x78, 0x0f, 0xea, 0x03, 0x93, 0xf5,
-            ])
-          );
-        },
-      };
-    });
-  });
-  afterEach(() => {
-    vi.resetAllMocks();
-  });
-
-  test(
-    'returns the current time',
-    async () => {
-      const ntpClient = new NTPClient({
-        replyTimeout,
-      });
-      const data = await ntpClient.getNetworkTime();
-      expect(data).toEqual(expect.any(Date));
-    },
-    replyTimeout
-  );
-
-  test(
-    'works with another NTP server',
-    async () => {
-      const ntpClient = new NTPClient({
-        replyTimeout,
-        server: '0.pool.ntp.org',
-      });
-      const data = await ntpClient.getNetworkTime();
-      expect(data).toEqual(expect.any(Date));
-    },
-    replyTimeout
-  );
-
-  test("doesn't work with an invalid NTP server", async () => {
-    try {
-      const ntpClient = new NTPClient({
-        replyTimeout: SECOND_IN_MILLIS,
-        server: 'google.com',
-      });
-      await ntpClient.getNetworkTime();
-      assert.fail();
-    } catch (error) {
-      expect((error as Error).message).toContain('Timeout');
-    }
-  });
-});

package/src/index.ts

@@ -1,126 +0,0 @@
-import * as dgram from 'dgram';
-
-const TEN_SECONDS_IN_MILLIS = 10_000;
-
-export interface NTPConfig {
-  /** Remote NTP Server port number */
-  port?: number;
-  /** Amount of acceptable time to await for a response from the remote server. */
-  replyTimeout?: number;
-  /** IP/Hostname of the remote NTP Server */
-  server?: string;
-}
-
-const defaultConfig: Required<NTPConfig> = {
-  port: 123,
-  replyTimeout: TEN_SECONDS_IN_MILLIS,
-  server: 'pool.ntp.org',
-};
-
-export class NTPClient {
-  private readonly config: Required<NTPConfig>;
-
-  constructor(server?: string, port?: number, timeout?: number);
-  constructor(config?: NTPConfig);
-  constructor(configOrServer?: string | NTPConfig, port?: number, replyTimeout?: number) {
-    this.config = defaultConfig;
-
-    if (typeof configOrServer === 'string') {
-      this.config.server = configOrServer;
-    } else {
-      this.config = {
-        ...this.config,
-        ...configOrServer,
-      };
-    }
-    if (port) {
-      this.config.port = port;
-    }
-    if (replyTimeout) {
-      this.config.replyTimeout = replyTimeout;
-    }
-  }
-
-  /** Fetches the current NTP Time from the given server and port. */
-  public getNetworkTime(ntpReplyTimeout?: number): Promise<Date> {
-    if (ntpReplyTimeout) {
-      this.config.replyTimeout = ntpReplyTimeout;
-    }
-
-    return new Promise((resolve, reject) => {
-      const client = dgram.createSocket('udp4');
-      const ntpData = Buffer.alloc(48);
-
-      // RFC 2030 -> LI = 0 (no warning, 2 bits), VN = 3 (IPv4 only, 3 bits), Mode = 3 (Client Mode, 3 bits) -> 1 byte
-      // -> rtol(LI, 6) ^ rotl(VN, 3) ^ rotl(Mode, 0)
-      // -> = 0x00 ^ 0x18 ^ 0x03
-      ntpData[0] = 0x1b;
-
-      const timeout = setTimeout(() => {
-        client.close();
-        reject(new Error('Timeout waiting for NTP response.'));
-        errorFired = true;
-      }, this.config.replyTimeout);
-
-      /*
-       * Some errors can happen before/after send() or cause send() to break.
-       * Some errors will also be given to send()
-       * NOTE: the error rejection is not generalised, as the client has to
-       * lose the connection also, apparently.
-       */
-      let errorFired = false;
-
-      client.on('error', err => {
-        if (errorFired) {
-          return;
-        }
-
-        errorFired = true;
-        clearTimeout(timeout);
-
-        return reject(err);
-      });
-
-      client.send(ntpData, 0, ntpData.length, this.config.port, this.config.server, err => {
-        if (err) {
-          if (errorFired) {
-            return;
-          }
-          clearTimeout(timeout);
-          errorFired = true;
-          client.close();
-          return reject(err);
-        }
-
-        client.once('message', msg => {
-          clearTimeout(timeout);
-          client.close();
-
-          // Offset to get to the "Transmit Timestamp" field (time at which the reply
-          // departed the server for the client, in 64-bit timestamp format.
-          const offsetTransmitTime = 40;
-          let intpart = 0;
-          let fractpart = 0;
-
-          // Get the seconds part
-          for (let index = 0; index <= 3; index++) {
-            intpart = 256 * intpart + msg[offsetTransmitTime + index];
-          }
-
-          // Get the seconds fraction
-          for (let index = 4; index <= 7; index++) {
-            fractpart = 256 * fractpart + msg[offsetTransmitTime + index];
-          }
-
-          const milliseconds = intpart * 1000 + (fractpart * 1000) / 0x100_000_000;
-
-          // **UTC** time
-          const date = new Date('Jan 01 1900 GMT');
-          date.setUTCMilliseconds(date.getUTCMilliseconds() + milliseconds);
-
-          return resolve(date);
-        });
-      });
-    });
-  }
-}