@ibgib/node-gib 0.0.17 → 0.0.19

package/src/serve-gib/handlers/api/ibgib/ibgib.handler.mts

@@ -1,176 +0,0 @@
-/**
- * @module serve-gib/handlers/api/ibgib
- */
-
-import { extractErrorMsg } from '@ibgib/helper-gib/dist/helpers/utils-helper.mjs';
-import { getIbGibAddr } from '@ibgib/ts-gib/dist/helper.mjs';
-import { IbGib_V1 } from '@ibgib/ts-gib/dist/V1/types.mjs';
-
-import { GLOBAL_LOG_A_LOT } from '../../../constants.mjs';
-import { ServeGibHandlerWithMetaspaceBase } from '../../handler-base.mjs';
-import { RequestContext, ResponseResult, ServeGibHttpMethod } from '../../../types.mjs';
-import { validateAddressSegment } from '../../../path-helper.mjs';
-import { API_PATH_REGEXES } from '../../../path-constants.mjs';
-import {
-    DEFAULT_QUERY_PARAMS_GET_IBGIB, IbGibGetQueryParams, IbGibParams,
-    isKnownQueryParamsKey_IbGibGet, KNOWN_QUERY_PARAMS_IBGIB_GET
-} from './ibgib-handler-types.mjs';
-import { validateAndCoerceBooleanQueryParam } from '../../../serve-gib-helpers.mjs';
-
-export interface IbGibGraphResponseBody {
-    addr: string;
-    count: number;
-    graph: Record<string, IbGib_V1>;
-}
-
-const logalot = GLOBAL_LOG_A_LOT;
-
-/**
- * GET /api/ibgib/:domainAddr/:ibGibAddr
- */
-export class IbGibHandler extends ServeGibHandlerWithMetaspaceBase<IbGibParams, IbGibGetQueryParams> {
-    protected override lc: string = `[${IbGibHandler.name}]`;
-    protected override method: ServeGibHttpMethod = 'GET';
-    protected override regex = API_PATH_REGEXES.IBGIB_ADDR;
-
-    protected override async parseParamsImpl(reqCtx: RequestContext<IbGibParams, IbGibGetQueryParams>): Promise<IbGibParams | undefined> {
-        const lc = `${this.lc}[${this.parseParamsImpl.name}]`;
-        try {
-            if (logalot) { console.log(`${lc} starting...`); }
-            const match = reqCtx.pathname.match(this.regex);
-            if (!match) { throw new Error(`(UNEXPECTED) match falsy for regex? at this point, we have passed canHandleRoute, so this should parse correctly. (E: 8ce0810a3a88f420639bf8286df1d826)`); }
-            const domainIb = decodeURIComponent(match[1]);
-            const domainGib = decodeURIComponent(match[2]);
-            const domainAddr = getIbGibAddr({ ib: domainIb, gib: domainGib });
-            const ibGibIb = decodeURIComponent(match[3]);
-            const ibGibGib = decodeURIComponent(match[4]);
-            const ibGibAddr = getIbGibAddr({ ib: ibGibIb, gib: ibGibGib });
-            return {
-                ibGibIb, ibGibGib, ibGibAddr,
-                domainInfo: this.getDomainInfo({ domainAddr }),
-            };
-        } catch (error) {
-            console.error(`${lc} ${extractErrorMsg(error)}`);
-            throw error;
-        } finally {
-            if (logalot) { console.log(`${lc} complete.`); }
-        }
-    }
-
-    protected override async validateQueryParams({ queryParams }: { queryParams: any; }): Promise<string[]> {
-        const lc = `${this.lc}[${this.validateQueryParams.name}]`;
-        try {
-            if (logalot) { console.log(`${lc} starting...`); }
-
-            const errors: string[] = [];
-
-            // strict checking
-            const queryParamsKeys = Object.keys(queryParams);
-            const invalidKeys: string[] = queryParamsKeys.filter(x => !isKnownQueryParamsKey_IbGibGet(x));
-            if (invalidKeys.length > 0) {
-                throw new Error(`invalid query params keys: ${invalidKeys.join(', ')}. valid query params keys: ${KNOWN_QUERY_PARAMS_IBGIB_GET.join(', ')} (E: b7e8a9f2c1d34e56b89a01d4f2e7c326)`);
-            }
-
-            // Enforce that EVERY key must have a validation function mapping
-            type ValidationFn = () => Promise<void>;
-            const ValidationFns: Record<KNOWN_QUERY_PARAMS_IBGIB_GET, ValidationFn> = {
-                getLatest: async () => validateAndCoerceBooleanQueryParam(queryParams, 'getLatest', errors),
-                getGraph: async () => validateAndCoerceBooleanQueryParam(queryParams, 'getGraph', errors),
-                addrOnly: async () => validateAndCoerceBooleanQueryParam(queryParams, 'addrOnly', errors),
-            };
-
-            // execute all validation functions
-            for (const fn of Object.values(ValidationFns)) {
-                await fn();
-            }
-
-            return errors;
-
-        } catch (error) {
-            console.error(`${lc} ${extractErrorMsg(error)}`);
-            throw error;
-        } finally {
-            if (logalot) { console.log(`${lc} complete.`); }
-        }
-    }
-
-    protected async handleRouteImpl(reqCtx: RequestContext<IbGibParams, IbGibGetQueryParams>): Promise<ResponseResult | undefined> {
-        const lc = `${this.lc}[${this.handleRouteImpl.name}]`;
-        try {
-            if (logalot) { console.log(`${lc} starting... (I: 03d6a889b1f8af879c0f7158a3b3de26)`); }
-
-            if (logalot) { console.log(`${lc} starting... (I: 03d6a889b1f8af879c0f7158a3b3de26)`); }
-            if (!reqCtx.metaspace) { throw new Error(`(UNEXPECTED) metaspace falsy? we should have initialized it by now since this is a domain-dependent handler (E: 864661c668d2aa1918b7ee677a7d9c26)`); }
-
-            const { ibGibIb, ibGibGib } = reqCtx.params as IbGibParams;
-            if (!ibGibIb || !ibGibGib) { return undefined; }
-
-            // Reconstruct addr from params
-            const rawAddr = `${ibGibIb}^${ibGibGib}`;
-            if (!validateAddressSegment(rawAddr)) return this.error(400, 'Invalid address format');
-            const addr = rawAddr;
-
-            const queryParams = {
-                ...DEFAULT_QUERY_PARAMS_GET_IBGIB,
-                ...(reqCtx.queryParams ?? {}),
-            };
-
-            const { getLatest, getGraph, addrOnly } = queryParams;
-
-            const space = await reqCtx.metaspace.getLocalUserSpace({ lock: false });
-            if (!space) { throw new Error(`(UNEXPECTED) couldn't get default local user space? (E: ec6161ea3a08892ad8bfd1b7b0d79826)`); }
-
-            let addr_latest: string = addr;
-            if (getLatest) {
-                const latestAddr = await reqCtx.metaspace.getLatestAddr({ addr, space });
-                if (latestAddr) { addr_latest = latestAddr; }
-            }
-
-            // Lightweight tip-check: return only the resolved address.
-            // Client uses this to decide whether a full sync is necessary
-            // without incurring the cost of fetching the full ibgib or graph.
-            if (addrOnly && !getGraph) {
-                return this.ok({ addr: addr_latest, clientAddr: addr });
-            } /* <<<<< returns early */
-
-            if (getGraph) {
-                const resGraph = await reqCtx.metaspace.getDependencyGraph({
-                    ibGibAddr: addr_latest,
-                    space,
-                    live: getLatest,
-                });
-                const addrs = Object.keys(resGraph);
-                if (addrs.length > 0) {
-                    if (addrOnly) {
-                        // Return only the address list for delta negotiation (smart diff):
-                        // client compares these against what it already has to determine
-                        // the minimal set it needs to fetch.
-                        return this.ok({ addr: addr_latest, clientAddr: addr, addrs });
-                    } else {
-                        const responseBody: IbGibGraphResponseBody = {
-                            addr: addr_latest,
-                            count: addrs.length,
-                            graph: resGraph
-                        };
-                        return this.ok(responseBody);
-                    }
-                } else {
-                    return this.notFound(`Graph not found for ${addr_latest} (E: 89b259f13ae5e4f0d8287f6c0475a826)`);
-                }
-            } else {
-                const resGet = await reqCtx.metaspace.get({ space, addr: addr_latest });
-                if (resGet.success && resGet.ibGibs?.length === 1) {
-                    const ibGib = resGet.ibGibs[0];
-                    return this.ok(ibGib);
-                } else {
-                    return this.notFound(`IbGib not found for ${addr_latest} (E: 017621e0a8086832ff06cfc884b8c426)`);
-                }
-            }
-        } catch (error) {
-            if (logalot) { console.error(extractErrorMsg(error)) }
-            return this.error(500, extractErrorMsg(error));
-        } finally {
-            if (logalot) { console.log(`${lc} complete.`); }
-        }
-    }
-}