@chaosity/location-client 0.12.0 → 0.13.0

package/dist/server/LocationServiceConnector.js

@@ -1,10 +1,10 @@
 import debug from 'debug';
-import { TokenHold, holdFor } from '../auth/tokenHold.js';
+import { TokenHold, sendRetryingOnce } from '../auth/tokenHold.js';
 import { VerifyAddressCommand } from '../client/commands.js';
 import { LocationServiceException } from '../errors/LocationServiceException.js';
 import { resolveEndpoint } from '../transport/endpoints.js';
-import { isTokenRejected, noTokenAvailable } from '../transport/errors.js';
-import { requestJson } from '../transport/http.js';
+import { noTokenAvailable } from '../transport/errors.js';
+import { requestJson, startCall, withinCall } from '../transport/http.js';
 import { readAppConfigClaims } from '../utils/tokenClaims.js';
 import { resolveApiUrl, serverTokenSource } from './getClientConfig.js';
 const log = debug('location-client:connector');
@@ -134,7 +134,10 @@ export class LocationServiceConnector {
             return {
                 apiUrl: () => requireApiUrl(apiUrl),
                 get: async (forceRefresh) => {
-                    const result = await getToken(forceRefresh);
+                    // As the environment source below asks its provider (#63).
+                    const result = await getToken(forceRefresh, {
+                        cachedUntilExpiry: true,
+                    });
                     if (!result)
                         return undefined;
                     return typeof result === 'string' ? result : result.token;
@@ -156,7 +159,9 @@ export class LocationServiceConnector {
             // Already validated by serverTokenSource, which cannot resolve
             // credentials without it.
             apiUrl: () => env.apiUrl,
-            get: async (forceRefresh) => (await env.getToken(forceRefresh)).token,
+            // A throttled refresh keeps the cached token in use until its own exp
+            // (#63): this is a server dispatch, never a token handed to a browser.
+            get: async (forceRefresh) => (await env.getToken(forceRefresh, { cachedUntilExpiry: true })).token,
         };
     }
     /**
@@ -194,8 +199,11 @@ export class LocationServiceConnector {
         const source = this.source();
         const cmd = command;
         const url = `${source.apiUrl()}${resolveEndpoint(cmd)}`;
+        // The call's deadline starts here, before the token is waited for, so the
+        // caller's `overallTimeoutMs` and `signal` bound the whole call (#62).
+        const call = startCall(options);
         try {
-            return await this.dispatchWithRetry(source, url, cmd, options);
+            return await this.dispatchWithRetry(source, url, cmd, call);
         }
         catch (err) {
             throw explainMissingOrigin(err, this.effectiveOrigin(options));
@@ -213,63 +221,14 @@ export class LocationServiceConnector {
         return this.send(new VerifyAddressCommand({ PlaceId: placeId }), options);
     }
     async dispatchWithRetry(source, url, cmd, options) {
-        const token = await source.get();
+        // Raced against the caller's signal and deadline, not given them: the
+        // token fetch may be shared with other calls (#62).
+        const token = await withinCall(source.get(), options);
         if (!token)
             throw noTokenAvailable(NO_TOKEN_ADVICE);
-        // This token was refused a moment ago and nothing has replaced it: answer
-        // with that refusal rather than send it, and force the source, again (#38).
-        // A different token from the source ends the hold. When the refresh that
-        // followed said nothing about when to ask again, it is asked now — but the
-        // refused token is still not sent.
-        const held = this.refused.check(token);
-        if (held && !held.askAgain)
-            throw held.error;
-        let rejected = held?.error;
-        if (!held) {
-            try {
-                return await this.dispatch(url, token, cmd, options);
-            }
-            catch (err) {
-                if (!isTokenRejected(err))
-                    throw err;
-                rejected = err;
-            }
-        }
-        // One retry, and only when the replacement is genuinely a different token.
-        // That single comparison covers every source: a fixed `token` string, a
-        // caller `getToken` that ignores `forceRefresh`, and a cached token the API
-        // has revoked before its `exp` all hand back what we already sent — and
-        // re-sending it would be a second doomed request for the same answer.
-        let fresh;
-        try {
-            fresh = await source.get(true);
-        }
-        catch (refusal) {
-            // A suspended application's /auth/token refuses it as its data routes
-            // refuse its token. Without this, every send asked for another. A
-            // refusal that says nothing — a network fault — leaves the source to be
-            // asked again, but not the token sent.
-            if (holdFor(refusal) > 0)
-                this.refused.remember(refusal, token);
-            // Only when no hold stands: one already standing keeps its own end, so
-            // the refused token is tried again once per hold rather than never.
-            else if (!held)
-                this.refused.remember(rejected, token, { askAgain: true });
-            throw refusal;
-        }
-        if (!fresh || fresh === token) {
-            this.refused.remember(rejected, token);
-            throw rejected;
-        }
-        log('401 on a token the API no longer accepts — retrying once, refreshed');
-        try {
-            return await this.dispatch(url, fresh, cmd, options);
-        }
-        catch (again) {
-            if (isTokenRejected(again))
-                this.refused.remember(again, fresh);
-            throw again;
-        }
+        // Through `sendRetryingOnce`, like every 401 retry here (#38). The forced
+        // refresh is raced against the caller as the first ask was (#62).
+        return sendRetryingOnce(this.refused, token, (t) => this.dispatch(url, t, cmd, options), () => withinCall(source.get(true), options), () => log('401 on a token the API no longer accepts — retrying once, refreshed'));
     }
     dispatch(url, token, cmd, options) {
         // The caller's input goes out as the caller wrote it — nothing in the body

package/dist/server/getClientConfig.d.ts

@@ -1,4 +1,4 @@
-import type { TokenResponse } from '../auth/TokenProvider.js';
+import type { GetTokenOptions, TokenResponse } from '../auth/TokenProvider.js';
 import type { ClientConfig } from '../types/index.js';
 export interface ServerAuthConfig {
     apiUrl?: string;
@@ -60,8 +60,12 @@ export declare function resolveApiUrl(explicit?: string): string | undefined;
  */
 export interface ServerTokenSource {
     apiUrl: string;
-    /** Resolves with a token or rejects; it never resolves tokenless. */
-    getToken(forceRefresh?: boolean): Promise<TokenResponse & {
+    /**
+     * Resolves with a token or rejects; it never resolves tokenless. The options
+     * are `TokenProvider.getToken`'s: the connector asks for `cachedUntilExpiry`
+     * (#63), and `getClientConfig` never does.
+     */
+    getToken(forceRefresh?: boolean, options?: GetTokenOptions): Promise<TokenResponse & {
         token: string;
     }>;
 }

package/dist/server/getClientConfig.js

@@ -75,10 +75,10 @@ export function resolveApiUrl(explicit) {
  *
  * Two answers qualify. `/auth/token`'s own `Invalid credentials` is a secret
  * that matched nothing. The gateway's 401 (`UnauthorizedException`) is the
- * authorizer refusing the Basic pair before `/auth/token` runs, and it gives
- * the same answer for a wrong secret and for an application that is not
- * active, so the advice for it names both. `Application is not active`, and
- * every 403, is left as the API wrote it.
+ * authorizer refusing the Basic pair before `/auth/token` runs. An application
+ * that is not active is a 403 (`ApplicationNotActiveException`) on either
+ * path, whose sentence names its cause, and it is left as the API wrote it,
+ * like every 403.
  */
 function isCredentialsRefusal(error) {
     if (!(error instanceof LocationServiceException))
@@ -90,11 +90,8 @@ function isCredentialsRefusal(error) {
 }
 /** The API's words as a sentence, so the advice can follow them. */
 const sentence = (text) => (/[.!?]$/.test(text) ? text : `${text}.`);
-function credentialsAdvice(clientId, error) {
-    const check = `Check that LOCATION_CLIENT_ID ("${clientId}") and LOCATION_CLIENT_SECRET match your application in the developer portal`;
-    return error.code === 'UnauthorizedException'
-        ? `${check}, and that the application is active there.`
-        : `${check}.`;
+function credentialsAdvice(clientId) {
+    return `Check that LOCATION_CLIENT_ID ("${clientId}") and LOCATION_CLIENT_SECRET match your application in the developer portal.`;
 }
 export function serverTokenSource(config = {}) {
     log('[serverTokenSource] Starting with config:', {
@@ -130,11 +127,11 @@ export function serverTokenSource(config = {}) {
     const provider = getTokenProvider(apiUrl, clientId, clientSecret);
     return {
         apiUrl,
-        async getToken(forceRefresh = false) {
+        async getToken(forceRefresh = false, options) {
             log('[serverTokenSource] Fetching token (forceRefresh=%s)', forceRefresh);
             let result;
             try {
-                result = await provider.getToken(forceRefresh);
+                result = await provider.getToken(forceRefresh, options);
             }
             catch (error) {
                 // The API's code and sentence, passed through (#38). Every 401 and 403
@@ -144,7 +141,7 @@ export function serverTokenSource(config = {}) {
                 if (isCredentialsRefusal(error)) {
                     throw new LocationServiceException({
                         code: error.code,
-                        message: `${sentence(error.message)} ${credentialsAdvice(clientId, error)}`,
+                        message: `${sentence(error.message)} ${credentialsAdvice(clientId)}`,
                         statusCode: error.statusCode,
                         requestId: error.requestId,
                         details: error.details,

package/dist/server/index.d.ts

@@ -1,5 +1,5 @@
 export { TokenProvider } from '../auth/TokenProvider.js';
-export type { TokenProviderConfig, TokenResponse, } from '../auth/TokenProvider.js';
+export type { GetTokenOptions, TokenProviderConfig, TokenResponse, } from '../auth/TokenProvider.js';
 export { getClientConfig } from './getClientConfig.js';
 export type { ServerAuthConfig, ServerClientConfig } from './getClientConfig.js';
 export { LocationServiceConnector } from './LocationServiceConnector.js';

package/dist/transport/http.d.ts

@@ -38,6 +38,24 @@ export interface RequestOptions {
         maxAttempts?: number;
     };
 }
+/**
+ * A call's options once it has begun: `deadline` is when `overallTimeoutMs`
+ * runs out, fixed at the call's entry, so that a wait before the request — a
+ * token — spends the same budget the request then gets the rest of (#62).
+ */
+export interface CallOptions extends RequestOptions {
+    deadline: number;
+}
+/** Fix a call's deadline at its entry (#62). */
+export declare function startCall<T extends RequestOptions>(options?: T): T & CallOptions;
+/**
+ * Wait for `work` within the call: reject with `AbortedException` when the
+ * caller's signal aborts, and with `TimeoutException` when its deadline
+ * passes, whichever comes first (#62). `work` itself is left running, because
+ * it may be shared: one caller's abort must not fail another waiting on the
+ * same token fetch.
+ */
+export declare function withinCall<T>(work: Promise<T>, call: CallOptions): Promise<T>;
 /** Exponential backoff with FULL jitter, so retries never march in lockstep. */
 export declare function backoffMs(attempt: number, random?: () => number): number;
 /**

package/dist/transport/http.js

@@ -25,6 +25,40 @@ export const DEFAULT_OVERALL_TIMEOUT_MS = 30000;
 export const DEFAULT_MAX_ATTEMPTS = 3;
 const BACKOFF_BASE_MS = 250;
 const BACKOFF_CAP_MS = 4000;
+/** Fix a call's deadline at its entry (#62). */
+export function startCall(options = {}) {
+    return {
+        ...options,
+        deadline: Date.now() + (options.overallTimeoutMs ?? DEFAULT_OVERALL_TIMEOUT_MS),
+    };
+}
+/**
+ * Wait for `work` within the call: reject with `AbortedException` when the
+ * caller's signal aborts, and with `TimeoutException` when its deadline
+ * passes, whichever comes first (#62). `work` itself is left running, because
+ * it may be shared: one caller's abort must not fail another waiting on the
+ * same token fetch.
+ */
+export function withinCall(work, call) {
+    const { signal, deadline } = call;
+    const overallTimeoutMs = call.overallTimeoutMs ?? DEFAULT_OVERALL_TIMEOUT_MS;
+    if (signal?.aborted)
+        return Promise.reject(abortedException(signal));
+    const left = deadline - Date.now();
+    if (left <= 0)
+        return Promise.reject(overallTimeoutException(overallTimeoutMs));
+    return new Promise((resolve, reject) => {
+        const timer = setTimeout(() => finish(() => reject(overallTimeoutException(overallTimeoutMs))), left);
+        const onAbort = () => finish(() => reject(abortedException(signal)));
+        signal?.addEventListener('abort', onAbort, { once: true });
+        function finish(settle) {
+            clearTimeout(timer);
+            signal?.removeEventListener('abort', onAbort);
+            settle();
+        }
+        work.then((value) => finish(() => resolve(value)), (error) => finish(() => reject(error)));
+    });
+}
 /**
  * Combine the caller's signal with a per-attempt timeout.
  *
@@ -106,7 +140,9 @@ async function request(url, init, options, read) {
             details: { source: 'client' },
         });
     }
-    const deadline = Date.now() + overallTimeoutMs;
+    // A call that began before this request (#62) brings its own deadline, so
+    // the request has only what the wait before it left.
+    const deadline = options.deadline ?? Date.now() + overallTimeoutMs;
     let lastError;
     for (let attempt = 0; attempt < maxAttempts; attempt++) {
         // Checked before every attempt: a signal aborted during backoff must not fire one more.

package/dist/types/index.d.ts

@@ -1,3 +1,4 @@
+import type { VerifyAddressCommand, VerifyAddressResponse } from '../client/commands.js';
 /**
  * At least one of `token`, `getToken` or `refreshToken` must supply a token, or
  * `send` refuses locally with `InvalidCredentialsException` rather than putting
@@ -52,6 +53,30 @@ export interface ClientConfig {
 export interface GeoPlacesCommand {
     readonly input: object;
 }
+/**
+ * The part of an AWS SDK command that carries its output type: the request
+ * handler its `resolveMiddleware` builds resolves with `{ output }`. The SDK's
+ * own `send` reads the output from the command the same way.
+ */
+interface SdkCommandOutputs<O extends object = object> {
+    resolveMiddleware(...args: never[]): (...args: never[]) => Promise<{
+        output: O;
+    }>;
+}
+/**
+ * A command whose output `send` can name (#68): every SDK command, this
+ * package's narrowed Places commands among them, and `VerifyAddressCommand`.
+ */
+export type CommandWithOutput = SdkCommandOutputs | VerifyAddressCommand;
+/**
+ * What `send` resolves with for a command (#68): an SDK command's own
+ * `…CommandOutput`, and `VerifyAddressResponse` for `VerifyAddressCommand`,
+ * which is this package's and has no handler.
+ *
+ * @example
+ * type Out = CommandOutput<AutocompleteCommand> // AutocompleteCommandOutput
+ */
+export type CommandOutput<C extends CommandWithOutput> = C extends SdkCommandOutputs<infer O> ? O : VerifyAddressResponse;
 /**
  * Minimal interface for a MapLibre Map instance.
  * Using a structural type avoids hard coupling to a specific maplibre-gl version.
@@ -69,3 +94,4 @@ export interface MapLike {
     getLayoutProperty(layerId: string, name: string): unknown;
     setLayoutProperty(layerId: string, name: string, value: unknown): void;
 }
+export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@chaosity/location-client",
-  "version": "0.12.0",
+  "version": "0.13.0",
   "description": "Client library for Chaosity Location Service with AWS Location Service compatibility",
   "type": "module",
   "main": "dist/cjs/index.js",
@@ -58,8 +58,8 @@
     "url": "https://github.com/chaosity-io/location-service-client/issues"
   },
   "dependencies": {
-    "@aws-sdk/client-geo-places": "^3.0.0",
-    "@aws/amazon-location-utilities-datatypes": "^1.0.0",
+    "@aws-sdk/client-geo-places": "^3.1116.0",
+    "@aws/amazon-location-utilities-datatypes": "^1.2.4",
     "debug": "^4.4.3"
   },
   "peerDependencies": {