@jd-data-limited/easy-fm 4.1.3 → 4.1.4

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jd-data-limited/easy-fm",
-  "version": "4.1.3",
+  "version": "4.1.4",
   "dependencies": {
     "@types/follow-redirects": "^1.14.4",
     "follow-redirects": "^1.15.5",

package/src/connection/FMHost.d.ts

@@ -11,6 +11,7 @@ export default class FMHost implements HostBase {
     readonly hostname: string;
     readonly timezoneOffsetFunc: (moment: Moment) => number;
     readonly verify: boolean;
+    readonly protocol: 'http:' | 'https:';
     _metadata: FMHostMetadata | null;
     constructor(_hostname: string, timezoneOffset?: (moment: Moment) => number, verify?: boolean);
     get metadata(): FMHostMetadata;

package/src/connection/FMHost.js

@@ -12,11 +12,13 @@ export default class FMHost {
     hostname;
     timezoneOffsetFunc;
     verify;
+    protocol;
     _metadata = null;
     constructor(_hostname, timezoneOffset = (moment) => 0 - (new Date()).getTimezoneOffset(), verify = true) {
         if (!(/^https?:\/\//).test(_hostname))
             throw new Error('hostname MUST begin with either http:// or https://');
-        this.hostname = _hostname;
+        this.protocol = _hostname.startsWith('https:') ? 'https:' : 'http:';
+        this.hostname = _hostname.split('//')[1];
         this.timezoneOffsetFunc = timezoneOffset;
         this.verify = verify;
     }
@@ -81,7 +83,7 @@ export default class FMHost {
     async getMetadata() {
         if (this._metadata)
             return this._metadata;
-        const _fetch = await fetch(`${this.hostname}/fmi/data/v2/productInfo`, {
+        const _fetch = await fetch(`${this.protocol}//${this.hostname}/fmi/data/v2/productInfo`, {
             method: 'GET'
         });
         const data = await _fetch.json();

package/src/connection/FMHost.ts

@@ -25,6 +25,7 @@ export default class FMHost implements HostBase {
     readonly hostname: string
     readonly timezoneOffsetFunc: (moment: Moment) => number
     readonly verify: boolean
+    readonly protocol: 'http:' | 'https:'
     _metadata: FMHostMetadata | null = null
 
     constructor (
@@ -33,7 +34,8 @@ export default class FMHost implements HostBase {
         verify = true
     ) {
         if (!(/^https?:\/\//).test(_hostname)) throw new Error('hostname MUST begin with either http:// or https://')
-        this.hostname = _hostname
+        this.protocol = _hostname.startsWith('https:') ? 'https:' : 'http:'
+        this.hostname = _hostname.split('//')[1]
         this.timezoneOffsetFunc = timezoneOffset
         this.verify = verify
     }
@@ -105,7 +107,7 @@ export default class FMHost implements HostBase {
     async getMetadata () {
         if (this._metadata) return this._metadata
 
-        const _fetch = await fetch(`${this.hostname}/fmi/data/v2/productInfo`, {
+        const _fetch = await fetch(`${this.protocol}//${this.hostname}/fmi/data/v2/productInfo`, {
             method: 'GET'
         })
         const data = await _fetch.json() as ApiResults<FMHostMetadata>

package/src/connection/HostBase.d.ts

@@ -2,6 +2,7 @@ import { type FMHostMetadata } from '../types.js';
 import { type Moment } from 'moment';
 export interface HostBase {
     readonly hostname: string;
+    readonly protocol: string;
     readonly timezoneOffsetFunc: (moment: Moment) => number;
     readonly verify: boolean;
     metadata: FMHostMetadata;

package/src/connection/HostBase.ts

@@ -7,6 +7,7 @@ import {type Moment} from 'moment'
 
 export interface HostBase {
     readonly hostname: string
+    readonly protocol: string
     readonly timezoneOffsetFunc: (moment: Moment) => number
     readonly verify: boolean
     metadata: FMHostMetadata

package/src/connection/database.d.ts

@@ -48,8 +48,8 @@ export declare class Database<T extends DatabaseStructure> extends EventEmitter
     _apiRequestRaw(url: URL | RequestInfo, options?: RequestInit & {
         headers?: Record<string, string>;
         useCookieJar?: boolean;
+        retries?: number;
     }, autoRelogin?: boolean): Promise<Response>;
-    private _generateCookieHeader;
     _apiRequestJSON<T = any>(url: URL | RequestInfo, options?: RequestInit & {
         headers?: Record<string, string>;
     }): Promise<ApiResults<T>>;

package/src/connection/database.js

@@ -6,7 +6,7 @@ import { generateAuthorizationHeaders } from './generateAuthorizationHeaders.js'
 import { FMError } from '../FMError.js';
 import { Layout } from '../layouts/layout.js';
 import fetch from 'node-fetch';
-// @ts-expect-error
+// @ts-expect-error - fetchWithCookies does not have available typescript types
 import fetchWithCookies, { CookieJar } from 'node-fetch-cookies';
 /**
  * Represents a database connection.
@@ -109,16 +109,25 @@ export class Database extends EventEmitter {
      * @returns {string} The endpoint URL.
      */
     get endpoint() {
-        return `${this.host.hostname}/fmi/data/v2/databases/${this.name}`;
+        return `${this.host.protocol}//${this.host.hostname}/fmi/data/v2/databases/${this.name}`;
     }
     async _apiRequestRaw(url, options = {}, autoRelogin = true) {
-        if (this.debug)
-            console.log(`EASYFM DEBUG: ${JSON.stringify(options)} ${url instanceof Request ? url.url : url}`);
-        if (this.token === '')
+        if (this.debug) {
+            console.log(`EASYFM DEBUG: ${JSON.stringify(options)} ${url instanceof URL
+                ? url.toString()
+                : typeof url === 'string' ? url : url.url}`);
+        }
+        const reqIsToDBHost = (url instanceof URL
+            ? url
+            : typeof url === 'string'
+                ? new URL(url)
+                : new URL(url.url)).hostname === this.host.hostname;
+        if (reqIsToDBHost && this.token === '')
             await this.login(true);
         if (!options.headers)
             options.headers = {};
-        options.headers.authorization = 'Bearer ' + this._token;
+        if (reqIsToDBHost)
+            options.headers.authorization = 'Bearer ' + this._token;
         // options.redirect = "manual"
         // options.headers.cookies = this._generateCookieHeader()
         // console.log(options.headers.cookies)
@@ -137,21 +146,21 @@ export class Database extends EventEmitter {
         // console.log(this.cookies, _fetch.status)
         // // console.log(this, this.cookies, url)
         // console.trace()
-        if (_fetch.status === 401 && autoRelogin) {
-            console.trace();
+        if (!_fetch.ok && (!options.retries || options.retries > 0)) {
+            if (this.debug) {
+                console.log(`EASYFM DEBUG: RE-ATTEMPTING REQUEST (${_fetch.status}) ${url instanceof URL
+                    ? url.toString()
+                    : typeof url === 'string' ? url : url.url}`);
+            }
+            return await this._apiRequestRaw(url, { ...options, retries: (options?.retries ?? 1) - 1 });
+        }
+        else if (_fetch.status === 401 && reqIsToDBHost && autoRelogin) {
             await this.login(true);
             return await this._apiRequestRaw(url, options, false);
         }
         else
             return _fetch;
     }
-    _generateCookieHeader() {
-        const out = [];
-        for (const key of Object.keys(this.cookies)) {
-            out.push(`${key}=${this.cookies[key]}`);
-        }
-        return out.join('; ');
-    }
     async _apiRequestJSON(url, options = {}) {
         if (!options.headers)
             options.headers = {};

package/src/connection/database.ts

@@ -13,7 +13,7 @@ import {type DatabaseBase} from './databaseBase.js'
 import {type ApiLayout, type ApiResults} from '../models/apiResults.js'
 import {type DatabaseStructure} from '../databaseStructure.js'
 import fetch, {type HeadersInit, type RequestInfo, type RequestInit, type Response} from 'node-fetch'
-// @ts-expect-error
+// @ts-expect-error - fetchWithCookies does not have available typescript types
 import fetchWithCookies, {CookieJar} from 'node-fetch-cookies'
 
 /**
@@ -45,7 +45,8 @@ export class Database<T extends DatabaseStructure> extends EventEmitter implemen
                 username: _data.username,
                 password: _data.password
             }
-        } else {
+        }
+        else {
             throw new Error('Not yet supported login method')
         }
     }
@@ -89,7 +90,8 @@ export class Database<T extends DatabaseStructure> extends EventEmitter implemen
         if (this.connection_details.credentials.method === 'token') {
             this._token = (this.connection_details.credentials).token
             return this.token
-        } else {
+        }
+        else {
             const url = new URL(`${this.endpoint}/sessions`)
             url.hostname = this.host.hostname
             const res = await fetch(url, {
@@ -106,7 +108,8 @@ export class Database<T extends DatabaseStructure> extends EventEmitter implemen
             if (res.status === 200) {
                 this._token = res.headers.get('x-fm-data-access-token') ?? ''
                 return this._token
-            } else {
+            }
+            else {
                 throw new FMError(
                     _res.messages[0].code as string | number,
                     _res.status as number,
@@ -126,18 +129,34 @@ export class Database<T extends DatabaseStructure> extends EventEmitter implemen
      * @returns {string} The endpoint URL.
      */
     get endpoint (): string {
-        return `${this.host.hostname}/fmi/data/v2/databases/${this.name}`
+        return `${this.host.protocol}//${this.host.hostname}/fmi/data/v2/databases/${this.name}`
     }
 
     async _apiRequestRaw (url: URL | RequestInfo, options: RequestInit & {
         headers?: Record<string, string>
         useCookieJar?: boolean
+        retries?: number
     } = {}, autoRelogin = true): Promise<Response> {
-        if (this.debug) console.log(`EASYFM DEBUG: ${JSON.stringify(options)} ${url instanceof Request ? url.url : url}`)
-        if (this.token === '') await this.login(true)
+        if (this.debug) {
+            console.log(
+                `EASYFM DEBUG: ${JSON.stringify(options)} ${
+                    url instanceof URL
+                        ? url.toString()
+                        : typeof url === 'string' ? url : url.url
+                }`
+            )
+        }
+        const reqIsToDBHost = (
+            url instanceof URL
+                ? url
+                : typeof url === 'string'
+                    ? new URL(url)
+                    : new URL(url.url)
+        ).hostname === this.host.hostname
+        if (reqIsToDBHost && this.token === '') await this.login(true)
 
         if (!options.headers) options.headers = {}
-        options.headers.authorization = 'Bearer ' + this._token
+        if (reqIsToDBHost) options.headers.authorization = 'Bearer ' + this._token
         // options.redirect = "manual"
         // options.headers.cookies = this._generateCookieHeader()
         // console.log(options.headers.cookies)
@@ -158,19 +177,21 @@ export class Database<T extends DatabaseStructure> extends EventEmitter implemen
         // console.log(this.cookies, _fetch.status)
         // // console.log(this, this.cookies, url)
         // console.trace()
-        if (_fetch.status === 401 && autoRelogin) {
-            console.trace()
+        if (!_fetch.ok && (!options.retries || options.retries > 0)) {
+            if (this.debug) {
+                console.log(`EASYFM DEBUG: RE-ATTEMPTING REQUEST (${_fetch.status}) ${
+                    url instanceof URL
+                        ? url.toString()
+                        : typeof url === 'string' ? url : url.url
+                }`)
+            }
+            return await this._apiRequestRaw(url, {...options, retries: (options?.retries ?? 1) - 1})
+        }
+        else if (_fetch.status === 401 && reqIsToDBHost && autoRelogin) {
             await this.login(true)
             return await this._apiRequestRaw(url, options, false)
-        } else return _fetch
-    }
-
-    private _generateCookieHeader () {
-        const out: string[] = []
-        for (const key of Object.keys(this.cookies)) {
-            out.push(`${key}=${this.cookies[key]}`)
         }
-        return out.join('; ')
+        else return _fetch
     }
 
     async _apiRequestJSON<T = any>(url: URL | RequestInfo, options: RequestInit & {

package/src/connection/requestHoldable.d.ts

@@ -0,0 +1,10 @@
+import { type RequestInfo, type RequestInit, Response } from 'node-fetch';
+export declare class RequestHoldableClass {
+    #private;
+    protected cookies: any;
+    _addNewFuncToQueue(func: () => Promise<void>): void;
+    protected _holdableFetch(url: URL | RequestInfo, options: RequestInit & {
+        headers?: Record<string, string>;
+    }): Promise<Response>;
+}
+export declare function RequestHoldable<PROPS extends any[], R = any>(originalMethod: (...p: PROPS) => Promise<R>, context: ClassMethodDecoratorContext<RequestHoldableClass>): (this: RequestHoldableClass, ...args: PROPS) => Promise<R>;

package/src/connection/requestHoldable.js

@@ -0,0 +1,44 @@
+/*
+ * Copyright (c) 2024. See LICENSE file for more information
+ */
+// @ts-expect-error - NO types module for this
+import fetchWithCookies, { CookieJar } from 'node-fetch-cookies';
+export class RequestHoldableClass {
+    #functionQueue = [];
+    #requestsAreBeingHeld = false;
+    cookies = new CookieJar();
+    _addNewFuncToQueue(func) {
+        this.#functionQueue.push(func);
+        if (this.#functionQueue.length === 1)
+            void this.#executeQueue();
+    }
+    async _holdableFetch(url, options) {
+        url.
+            if(!this.#requestsAreBeingHeld);
+        {
+            // eslint-disable-next-line @typescript-eslint/return-await
+            return await fetchWithCookies(this.cookies, url, options);
+        }
+    }
+    async #executeQueue() {
+        while (this.#functionQueue.length !== 0) {
+            try {
+                await this.#functionQueue[0]();
+            }
+            catch (e) {
+                console.error(e);
+            }
+            this.#functionQueue.shift();
+        }
+    }
+}
+export function RequestHoldable(originalMethod, context) {
+    // eslint-disable-next-line @typescript-eslint/promise-function-async
+    function replacementMethod(...args) {
+        return new Promise((resolve, reject) => {
+            // eslint-disable-next-line @typescript-eslint/promise-function-async
+            this._addNewFuncToQueue(() => originalMethod.call(this, ...args).then(resolve).catch(reject));
+        });
+    }
+    return replacementMethod;
+}

package/src/records/layoutRecord.js

@@ -50,6 +50,7 @@ export class LayoutRecord extends RecordBase {
                 method: 'POST',
                 body: JSON.stringify(data)
             });
+            console.log(res);
             if (!res.response) {
                 throw new FMError(res.messages[0].code, res.httpStatus, res);
             }

package/src/records/layoutRecord.ts

@@ -70,6 +70,7 @@ export class LayoutRecord<LAYOUT extends LayoutInterface> extends RecordBase<LAY
                 method: 'POST',
                 body: JSON.stringify(data)
             })
+            console.log(res)
 
             if (!res.response) {
                 throw new FMError(res.messages[0].code, res.httpStatus, res)