@muspellheim/shared 0.6.1 → 0.7.0

package/lib/long-polling-client.js

@@ -1,186 +0,0 @@
-// Copyright (c) 2023-2024 Falko Schumann. All rights reserved. MIT license.
-
-import { ConfigurableResponses } from './configurable-responses.js';
-import { MessageClient } from './message-client.js';
-import { OutputTracker } from './output-tracker.js';
-import { sleep } from './lang.js';
-
-const REQUEST_SENT_EVENT = 'request-sent';
-
-/**
- * A client handling long polling a HTTP request.
- *
- * @implements {MessageClient}
- */
-export class LongPollingClient extends MessageClient {
-  /**
-   * Creates a long polling client.
-   *
-   * @param {object} options
-   * @param {number} [options.wait=90000] The wait interval for a response.
-   * @param {number} [options.retry=1000] The retry interval after an error.
-   * @return {LongPollingClient} A new long polling client.
-   */
-  static create({ wait = 90000, retry = 1000 } = {}) {
-    return new LongPollingClient(
-      wait,
-      retry,
-      globalThis.fetch.bind(globalThis),
-    );
-  }
-
-  /**
-   * Creates a nulled long polling client.
-   *
-   * @param {object} options
-   * @return {LongPollingClient} A new nulled long polling client.
-   */
-  static createNull({
-    fetchResponse = {
-      status: 304,
-      statusText: 'Not Modified',
-      headers: undefined,
-      body: null,
-    },
-  } = {}) {
-    return new LongPollingClient(90000, 0, createFetchStub(fetchResponse));
-  }
-
-  #wait;
-  #retry;
-  #fetch;
-  #connected;
-  #aboutController;
-  #url;
-  #tag;
-
-  /**
-   * The constructor is for internal use. Use the factory methods instead.
-   *
-   * @see LongPollingClient.create
-   * @see LongPollingClient.createNull
-   */
-  constructor(
-    /** @type {number} */ wait,
-    /** @type {number} */ retry,
-    /** @type {fetch} */ fetchFunc,
-  ) {
-    super();
-    this.#wait = wait;
-    this.#retry = retry;
-    this.#fetch = fetchFunc;
-    this.#connected = false;
-    this.#aboutController = new AbortController();
-  }
-
-  /**
-   * @override
-   */
-  get isConnected() {
-    return this.#connected;
-  }
-
-  /**
-   * @override
-   */
-  get url() {
-    return this.#url;
-  }
-
-  /**
-   * @override
-   */
-  async connect(url) {
-    if (this.isConnected) {
-      throw new Error('Already connected.');
-    }
-
-    this.#url = url;
-    this.#startPolling();
-    this.dispatchEvent(new Event('open'));
-    await Promise.resolve();
-  }
-
-  /**
-   * Returns a tracker for requests sent.
-   *
-   * @return {OutputTracker} A new output tracker.
-   */
-  trackRequestSent() {
-    return OutputTracker.create(this, REQUEST_SENT_EVENT);
-  }
-
-  /**
-   * @override
-   */
-  async close() {
-    this.#aboutController.abort();
-    this.#connected = false;
-    await Promise.resolve();
-  }
-
-  async #startPolling() {
-    this.#connected = true;
-    while (this.isConnected) {
-      try {
-        const headers = { Prefer: `wait=${this.#wait / 1000}` };
-        if (this.#tag) {
-          headers['If-None-Match'] = this.#tag;
-        }
-        this.dispatchEvent(
-          new CustomEvent(REQUEST_SENT_EVENT, { detail: { headers } }),
-        );
-        const response = await this.#fetch(this.#url, {
-          headers,
-          signal: this.#aboutController.signal,
-        });
-        await this.#handleResponse(response);
-      } catch (error) {
-        // @ts-ignore NodeJS error code
-        if (error.name === 'AbortError') {
-          break;
-        } else {
-          await this.#handleError(error);
-        }
-      }
-    }
-  }
-
-  async #handleResponse(/** @type {Response} */ response) {
-    if (response.status === 304) {
-      return;
-    }
-
-    if (!response.ok) {
-      throw new Error(`HTTP error: ${response.status} ${response.statusText}`);
-    }
-
-    this.#tag = response.headers.get('ETag');
-    const message = await response.text();
-    this.dispatchEvent(new MessageEvent('message', { data: message }));
-  }
-
-  async #handleError(error) {
-    console.error(error);
-    this.dispatchEvent(new Event('error'));
-    await sleep(this.#retry);
-  }
-}
-
-function createFetchStub(response) {
-  const responses = ConfigurableResponses.create(response);
-  return async (_url, options) => {
-    await sleep(0);
-    return new Promise((resolve, reject) => {
-      options?.signal?.addEventListener('abort', () => reject());
-      const res = responses.next();
-      resolve(
-        new Response(res.body, {
-          status: res.status,
-          statusText: res.statusText,
-          headers: res.headers,
-        }),
-      );
-    });
-  };
-}

package/lib/message-client.js

@@ -1,68 +0,0 @@
-// Copyright (c) 2023-2024 Falko Schumann. All rights reserved. MIT license.
-
-/**
- * An interface for a streaming message client.
- *
- * Emits the following events:
- *
- * - open, {@link Event}
- * - message, {@link MessageEvent}
- * - error, {@link Event}
- *
- * It is used for wrappers around {@link EventSource} and {@link WebSocket},
- * also for long polling.
- *
- * @interface
- * @see SseClient
- * @see WebSocketClient
- * @see LongPollingClient
- */
-export class MessageClient extends EventTarget {
-  /**
-   * Returns whether the client is connected.
-   *
-   * @type {boolean}
-   * @readonly
-   */
-  get isConnected() {
-    throw new Error('Not implemented.');
-  }
-
-  /**
-   * Returns the server URL.
-   *
-   * @type {string}
-   * @readonly
-   */
-  get url() {
-    throw new Error('Not implemented.');
-  }
-
-  /**
-   * Connects to the server.
-   *
-   * @param {URL | string} url The server URL to connect to.
-   */
-  async connect(_url) {
-    await Promise.reject('Not implemented.');
-  }
-
-  /**
-   * Sends a message to the server.
-   *
-   * This is an optional method for streams with bidirectional communication.
-   *
-   * @param {string} message The message to send.
-   * @param {string} type The optional message type.
-   */
-  async send(_message, _type) {
-    await Promise.reject('Not implemented.');
-  }
-
-  /**
-   * Closes the connection.
-   */
-  async close() {
-    await Promise.reject('Not implemented.');
-  }
-}

package/lib/messages.js

@@ -1,68 +0,0 @@
-/**
- * Provides CQNS features.
- *
- * The Command Query Notification Separation principle is a software design
- * principle that separates the concerns of commands, queries, and
- * notifications.
- *
- * Message hierarchy:
- *
- * - Message
- *   - Incoming / outgoing
- *     - Request (outgoing) -> response (incoming)
- *       - Command -> command status
- *       - Query -> query result
- *     - Notification
- *       - Incoming: notification -> commands
- *       - Outgoing
- *   - Event (internal)
- *
- * @see https://ralfw.de/command-query-notification-separation-cqns/
- * @module
- */
-
-/**
- * The status returned by a command handler.
- */
-export class CommandStatus {
-  /**
-   * Creates a successful status.
-   */
-  static success() {
-    return new CommandStatus(true);
-  }
-
-  /**
-   * Creates a failed status.
-   *
-   * @param {string} errorMessage
-   */
-  static failure(errorMessage) {
-    return new CommandStatus(false, errorMessage);
-  }
-
-  /**
-   * Indicates whether the command was successful.
-   *
-   * @type {boolean}
-   */
-  isSuccess;
-
-  /**
-   * The error message if the command failed.
-   *
-   * @type {string}
-   */
-  errorMessage;
-
-  /**
-   * Creates a new instance of CommandStatus.
-   *
-   * @param {boolean} isSuccess Indicates whether the command was successful.
-   * @param {string} [errorMessage] The error message if the command failed.
-   */
-  constructor(isSuccess, errorMessage) {
-    this.isSuccess = isSuccess;
-    this.errorMessage = errorMessage;
-  }
-}

package/lib/metrics.js

@@ -1,120 +0,0 @@
-// Copyright (c) 2023-2024 Falko Schumann. All rights reserved. MIT license.
-
-/**
- * Defines a simple metrics library.
- *
- * Portated from
- * [Micrometer](https://docs.micrometer.io/micrometer/reference/overview.html).
- *
- * @module
- */
-
-import { Enum } from './lang.js';
-
-// TODO Create gauges (can increment and decrement)
-// TODO Create timers (total time, average time and count)
-// TODO Publish metrics to a server via HTTP
-// TODO Provide metrics for Prometheus
-
-export class MeterRegistry {
-  static create() {
-    return new MeterRegistry();
-  }
-
-  #meters = [];
-
-  get meters() {
-    return this.#meters;
-  }
-
-  counter(name, tags) {
-    const id = MeterId.create({ name, tags, type: MeterType.COUNTER });
-    /** @type {Counter} */ let meter = this.#meters.find((meter) =>
-      meter.id.equals(id),
-    );
-    if (!meter) {
-      meter = new Counter(id);
-      this.#meters.push(meter);
-    }
-
-    // TODO validate found meter is a counter
-    return meter;
-  }
-}
-
-export class Meter {
-  #id;
-
-  constructor(/** @type {MeterId} */ id) {
-    // TODO validate parameters are not null
-    this.#id = id;
-  }
-
-  get id() {
-    return this.#id;
-  }
-}
-
-export class Counter extends Meter {
-  #count = 0;
-
-  constructor(/** @type {MeterId} */ id) {
-    super(id);
-    // TODO validate type is counter
-  }
-
-  count() {
-    return this.#count;
-  }
-
-  increment(amount = 1) {
-    this.#count += amount;
-  }
-}
-
-export class MeterId {
-  static create({ name, tags = [], type }) {
-    return new MeterId(name, tags, type);
-  }
-
-  #name;
-  #tags;
-  #type;
-
-  constructor(
-    /** @type {string} */ name,
-    /** @type {string[]} */ tags,
-    /** @type {MeterType} */ type,
-  ) {
-    // TODO validate parameters are not null
-    this.#name = name;
-    this.#tags = Array.from(tags).sort();
-    this.#type = type;
-  }
-
-  get name() {
-    return this.#name;
-  }
-
-  get tags() {
-    return this.#tags;
-  }
-
-  get type() {
-    return this.#type;
-  }
-
-  equals(other) {
-    return (
-      this.name === other.name &&
-      this.tags.length === other.tags.length &&
-      this.tags.every((tag, index) => tag === other.tags[index])
-    );
-  }
-}
-
-export class MeterType extends Enum {
-  static COUNTER = new MeterType('COUNTER', 0);
-  static GAUGE = new MeterType('GAUGE', 1);
-  static TIMER = new MeterType('TIMER', 2);
-}

package/lib/node/actuator-controller.js

@@ -1,102 +0,0 @@
-// Copyright (c) 2023-2024 Falko Schumann. All rights reserved. MIT license.
-
-/**
- * @import * as express from 'express'
- *
- * @import { HealthContributorRegistry } from '../health.js'
- */
-
-import process from 'node:process';
-
-import * as handler from './handler.js';
-
-// TODO Remove dependency to express
-
-export class ActuatorController {
-  #services;
-  #healthContributorRegistry;
-
-  constructor(
-    services, // FIXME Services is not defined in library
-    /** @type {HealthContributorRegistry} */ healthContributorRegistry,
-    /** @type {express.Express} */ app,
-  ) {
-    this.#services = services;
-    this.#healthContributorRegistry = healthContributorRegistry;
-
-    app.get('/actuator', this.#getActuator.bind(this));
-    app.get('/actuator/info', this.#getActuatorInfo.bind(this));
-    app.get('/actuator/metrics', this.#getActuatorMetrics.bind(this));
-    app.get('/actuator/health', this.#getActuatorHealth.bind(this));
-    app.get(
-      '/actuator/prometheus',
-      handler.runSafe(this.#getMetrics.bind(this)),
-    );
-  }
-
-  #getActuator(
-    /** @type {express.Request} */ request,
-    /** @type {express.Response} */ response,
-  ) {
-    let requestedUrl =
-      request.protocol + '://' + request.get('host') + request.originalUrl;
-    if (!requestedUrl.endsWith('/')) {
-      requestedUrl += '/';
-    }
-    response.status(200).json({
-      _links: {
-        self: { href: requestedUrl },
-        info: { href: requestedUrl + 'info' },
-        metrics: { href: requestedUrl + 'metrics' },
-        health: { href: requestedUrl + 'health' },
-        prometheus: { href: requestedUrl + 'prometheus' },
-      },
-    });
-  }
-
-  #getActuatorInfo(
-    /** @type {express.Request} */ _request,
-    /** @type {express.Response} */ response,
-  ) {
-    const info = {};
-    info[process.env.npm_package_name] = {
-      version: process.env.npm_package_version,
-    };
-    response.status(200).json(info);
-  }
-
-  #getActuatorMetrics(
-    /** @type {express.Request} */ _request,
-    /** @type {express.Response} */ response,
-  ) {
-    response.status(200).json({
-      cpu: process.cpuUsage(),
-      mem: process.memoryUsage(),
-      uptime: process.uptime(),
-    });
-  }
-
-  #getActuatorHealth(
-    /** @type {express.Request} */ _request,
-    /** @type {express.Response} */ response,
-  ) {
-    const health = this.#healthContributorRegistry.health();
-    const status = health.status === 'UP' ? 200 : 503;
-    response.status(status).json(health);
-  }
-
-  async #getMetrics(
-    /** @type {express.Request} */ _request,
-    /** @type {express.Response} */ response,
-  ) {
-    // TODO count warnings and errors
-    // TODO create class MeterRegistry
-
-    const metrics = await this.#services.getMetrics();
-    const timestamp = new Date().getTime();
-    let body = `# TYPE talks_count gauge\ntalks_count ${metrics.talksCount} ${timestamp}\n\n`;
-    body += `# TYPE presenters_count gauge\npresenters_count ${metrics.presentersCount} ${timestamp}\n\n`;
-    body += `# TYPE comments_count gauge\ncomments_count ${metrics.commentsCount} ${timestamp}\n\n`;
-    handler.reply(response, { body });
-  }
-}