@arsedizioni/ars-utils 22.5.52 → 22.5.54

package/fesm2022/arsedizioni-ars-utils-evolution.common.mjs

@@ -2,13 +2,29 @@ import { HttpResponse, HttpClient } from '@angular/common/http';
 import * as i0 from '@angular/core';
 import { inject, signal, Service, DestroyRef } from '@angular/core';
 import { BroadcastService, SystemUtils } from '@arsedizioni/ars-utils/core';
-import { tap, catchError, throwError, EMPTY, of } from 'rxjs';
+import { retry, timer, throwError, tap, catchError, EMPTY, of } from 'rxjs';
 import { takeUntilDestroyed } from '@angular/core/rxjs-interop';
 import { catchError as catchError$1, map, finalize } from 'rxjs/operators';
 
 const EvolutionMessages = {
     // Error
     ERROR: '§evo-error',
+    /**
+     * The session is gone: a 401 on a request that was not a sign-in attempt.
+     * Emitted once per dead session by `evolutionAuthInterceptor`, which re-arms on the first
+     * good response. The twin of `ClipperMessages.ERROR_401`.
+     */
+    ERROR_401: '§evo-error-401',
+    /**
+     * The API is not answering: the interceptor has already sent the request three times over ten
+     * seconds and none of them got an answer carrying an `ApiResult` envelope. Emitted once per
+     * outage, however many requests were in flight, and re-armed on the first good response.
+     *
+     * Deliberately not an `ERROR`: a server being replaced is neither a failed operation to report
+     * in a dialog nor an expired session to sign out of, and the host application usually answers it
+     * with a banner that clears itself.
+     */
+    ERROR_UNAVAILABLE: '§evo-error-unavailable',
     SUCCESS: '§evo-success',
     SUCCESS_TOAST: '§evo-success-toast',
     // Login
@@ -492,8 +508,61 @@ var ERPPlace;
 class EvolutionComplianceContextInfo {
 }
 
+/**
+ * HTML text helpers with no dependencies of their own.
+ *
+ * Not exported from `public_api`: it is an internal detail of this entry point, the twin of the one
+ * in `clipper.common`. The two entry points are independent, so neither imports the other's copy.
+ */
+function escapeHtml(value) {
+    if (value === undefined || value === null)
+        return undefined;
+    return String(value)
+        .replaceAll('&', '&')
+        .replaceAll('<', '&lt;')
+        .replaceAll('>', '&gt;')
+        .replaceAll('"', '&quot;')
+        .replaceAll("'", "&#39;");
+}
+
 /** Minimum milliseconds between consecutive generic error broadcasts (debounce guard). */
 const ERROR_DEBOUNCE_MS = 5000;
+/** How many more times a request is sent when the API is not there. */
+const UNAVAILABLE_RETRIES = 2;
+/** How long to wait before each of those retries, in milliseconds. */
+const UNAVAILABLE_RETRY_DELAY = 5000;
+/** The statuses a server that is being replaced answers with, plus the one it cannot answer at all. */
+const UNAVAILABLE_STATUSES = [0, 500, 502, 503, 504];
+/**
+ * Returns whether the failure means the API is not there, rather than the request being wrong.
+ *
+ * The discriminator is the body, not the status. An error raised INSIDE the application arrives
+ * wrapped in the usual `ApiResult` envelope, so it has been seen, parsed and acted upon: replaying
+ * it would run whatever it already ran a second time. A server that is being replaced answers with
+ * IIS's own HTML, or with nothing at all — no envelope — and that request never reached any
+ * handler. Only the second kind is retried, which is what makes it safe to retry a POST.
+ * @param error - The raw HTTP error object.
+ * @returns True when the request is worth sending again.
+ */
+function isServiceUnavailable(error) {
+    if (!UNAVAILABLE_STATUSES.includes(parseInt(error?.status ?? '0')))
+        return false;
+    const body = error?.error;
+    const isApiEnvelope = !!body
+        && typeof body === 'object'
+        && !(body instanceof Blob)
+        && ('success' in body || 'problem' in body);
+    return !isApiEnvelope;
+}
+/**
+ * Returns whether the failure means the session is gone rather than the request being wrong.
+ * @param errorStatus - The numeric HTTP status code.
+ * @param url - The request URL.
+ * @returns True when the link to Evolution has to be dropped.
+ */
+function isSessionExpired(errorStatus, url) {
+    return errorStatus === 401 && !isAuthEndpoint(url);
+}
 /**
  * Returns whether the URL is an authentication endpoint, where a 401 is a normal outcome -- wrong
  * credentials, a rejected code, a refused passkey -- rather than an expired or invalid session.
@@ -521,8 +590,8 @@ function isAuthEndpoint(url) {
  *
  * `/session/status` runs unconditionally at every bootstrap, including for users who never linked
  * Evolution at all. When the API is unreachable, reporting that failure would show "Evolution non è
- * disponibile" to somebody who never asked Evolution for anything: the error is still rethrown for
- * the caller to observe, but nothing is broadcast.
+ * disponibile" to somebody who never asked Evolution for anything: the probe simply stays unanswered
+ * and the link state keeps whatever the stored hint says.
  * @param url - The request URL.
  * @returns True when the URL is the status probe.
  */
@@ -531,15 +600,23 @@ function isStatusProbe(url) {
 }
 /**
  * Resolves the user-facing message for a failed request.
+ *
+ * There is no branch for status 0 any more, nor for the 5xx family: a request that got no answer,
+ * or an answer with no `ApiResult` envelope, never reaches here — it is retried and then reported
+ * as `ERROR_UNAVAILABLE`. What is left is the failures the API itself described.
+ *
+ * Whatever the API sends is escaped before anything else happens to it. The dialog that shows this
+ * string binds it with `[innerHTML]` through a pipe that calls `bypassSecurityTrustHtml`, so an
+ * error message echoing back something a user had typed would be rendered as markup rather than
+ * read as text. The paragraph breaks in the default branch are applied AFTER the escape, which is
+ * exactly why they survive it and nothing else does.
  * @param error - The raw HTTP error object.
  * @param errorStatus - The numeric HTTP status code.
- * @returns A localised message, ready to be rendered as HTML.
+ * @returns A localised message, safe to render as HTML.
  */
 function resolveErrorMessage(error, errorStatus) {
-    const message = error?.error?.message ?? error?.message;
+    const message = escapeHtml(error?.error?.message ?? error?.message);
     switch (errorStatus) {
-        case 0:
-            return "In questo momento Evolution non è disponibile. Riprova tra qualche minuto.";
         case 401:
             // A 401 that reaches here comes from a sign-in attempt; anything else was classified as a
             // dead session before this function was called.
@@ -571,15 +648,29 @@ function resolveErrorMessage(error, errorStatus) {
  * failures used to arrive as `200 OK` with `success: false`, and a dead session had to be guessed
  * from a 405, a 410 or any 5xx. Now the status is the truth -- a 401 on an already-authenticated
  * request means the session is gone, a 403 means the permission is missing, a 5xx means the server
- * broke, and those are three different things that used to be one. `invalidateSession` is
- * therefore now, and only, a 401 outside the authentication endpoints.
+ * broke, and those are three different things that used to be one.
  *
- * `EvolutionServiceFlags.NotifySystemErrors` still governs one narrow case, and only that one: a
- * 5xx, i.e. a failure of the server rather than of the request. Without the flag it is swallowed,
- * as it always was in this library.
+ * A dead session is broadcast as `EvolutionMessages.ERROR_401`, for the host application to handle
+ * centrally; every other failure stays an `EvolutionMessages.ERROR` carrying a message. The two are
+ * separate because they call for opposite things: one drops the link, the other shows a dialog and
+ * leaves the user where they are. It used to be an `ERROR` flagged `invalidateSession`, with a
+ * message of its own; `invalidateSession` is now always false.
  *
- * Errors are re-thrown rather than swallowed: call sites rely on their `error` callback firing, and
- * on `finalize` clearing a busy dialog.
+ * Between them sits a third case, which is neither: the API is being replaced. A deployment answers
+ * with a 5xx that has no `ApiResult` envelope, or does not answer at all, for the few seconds the
+ * process takes to come back. That is not worth a dialog and not worth a redirect either, so the
+ * request is simply sent again — twice, five seconds apart — and only if the third attempt fails
+ * too does it become `EvolutionMessages.ERROR_UNAVAILABLE`, once per outage.
+ *
+ * `EvolutionServiceFlags.NotifySystemErrors` therefore now governs one narrower case: a 5xx that
+ * DOES carry an envelope, i.e. a server error the API itself described. Without the flag it is
+ * swallowed, as it always was in this library.
+ *
+ * Errors are consumed, not re-thrown, exactly as `clipperAuthInterceptor` does: every failure is
+ * reported on the bus, and a subscriber to a failing request simply completes without emitting. A
+ * caller that must know how a request ended reads `ApiResult.success`; a busy dialog is cleared by
+ * `finalize`, which runs on completion as it ran on error. An `error` callback no longer fires for
+ * an HTTP failure.
  *
  * Register it with `withInterceptors`:
  * @example
@@ -600,6 +691,11 @@ function evolutionAuthInterceptor(serviceUri, flags = EvolutionServiceFlags.None
      * several in-flight requests fail at once; re-armed on the next successful response.
      */
     let sessionExpiredNotified = false;
+    /**
+     * Whether the unavailable-API notification has already been sent. A deployment fails every
+     * request in flight, and one notification is enough. Re-armed on the next successful response.
+     */
+    let unavailableNotified = false;
     /**
      * Broadcasts a generic, user-facing error for an Evolution HTTP failure, debounced.
      * @param error - The raw error value thrown by the HTTP layer.
@@ -608,7 +704,7 @@ function evolutionAuthInterceptor(serviceUri, flags = EvolutionServiceFlags.None
      * @returns void
      */
     function notifyError(error, errorStatus, broadcastService) {
-        // A broken server is the one case the flag still governs.
+        // A 5xx the API described itself is the one case the flag still governs.
         if (errorStatus >= 500 && (flags & EvolutionServiceFlags.NotifySystemErrors) === 0)
             return;
         const now = Date.now();
@@ -643,10 +739,20 @@ function evolutionAuthInterceptor(serviceUri, flags = EvolutionServiceFlags.None
                 'X-Evo-Account': sessionStorage.getItem(EVOLUTION_ACTIVE_ACCOUNT_KEY) ?? ''
             }
         });
-        return next(authenticatedRequest).pipe(tap(event => {
-            // A response means the session is valid again: re-arm the expiry notifier.
+        return next(authenticatedRequest).pipe(
+        // An API that is being replaced is not an error to show, it is a wait: two more attempts,
+        // five seconds apart. Anything else is rethrown on the spot, so a request that genuinely
+        // failed still fails immediately.
+        retry({
+            count: UNAVAILABLE_RETRIES,
+            delay: error => isServiceUnavailable(error)
+                ? timer(UNAVAILABLE_RETRY_DELAY)
+                : throwError(() => error)
+        }), tap(event => {
+            // A response means the session is valid again, and the API is back: re-arm both notifiers.
             if (event instanceof HttpResponse) {
                 sessionExpiredNotified = false;
+                unavailableNotified = false;
             }
         }), catchError((error) => {
             // Which request this was is read from the request, not from `error.url`: a failure with no
@@ -655,27 +761,36 @@ function evolutionAuthInterceptor(serviceUri, flags = EvolutionServiceFlags.None
             // before the pipe was built.
             const errorStatus = parseInt(error?.status ?? '0');
             if (isStatusProbe(authenticatedRequest.url)) {
-                // The silent probe stays silent: its caller reads the outcome from the rethrown error,
-                // nobody else needs to hear about it.
+                // The silent probe stays silent: its caller reads the outcome from the stream, nobody
+                // else needs to hear about it.
             }
-            else if (errorStatus === 401 && !isAuthEndpoint(authenticatedRequest.url)) {
+            else if (isServiceUnavailable(error)) {
+                // Three attempts over ten seconds and the API is still not answering. There is nothing
+                // left to retry, so the host application is told once, however many requests were in
+                // flight. Reported whatever the flags say: `NotifySystemErrors` governs a 5xx the API
+                // described itself, and a server that never answered described nothing.
+                if (!unavailableNotified) {
+                    unavailableNotified = true;
+                    broadcastService.sendMessage(EvolutionMessages.ERROR_UNAVAILABLE);
+                }
+            }
+            else if (isSessionExpired(errorStatus, authenticatedRequest.url)) {
                 // Expired or invalidated session on an authenticated request. Notified once: several
                 // in-flight requests failing together is how a single expiry becomes a wall of dialogs.
                 if (!sessionExpiredNotified) {
                     sessionExpiredNotified = true;
-                    broadcastService.sendMessage(EvolutionMessages.ERROR, {
-                        invalidateSession: true,
-                        message: "La sessione di lavoro non è più valida.",
-                        title: "Errore in Evolution",
-                        errorStatus,
-                        service: serviceUri
-                    });
+                    broadcastService.sendMessage(EvolutionMessages.ERROR_401);
                 }
             }
             else {
+                // Any other failure, including a 401 from a sign-in attempt.
                 notifyError(error, errorStatus, broadcastService);
             }
-            return throwError(() => error);
+            // Consumed, not rethrown — as in `clipperAuthInterceptor`. The failure has been reported on
+            // the bus, and rethrowing it a second time only gave every subscriber its own chance to
+            // report it again: a wrong password used to end in two dialogs, the second one saying
+            // "Evolution non disponibile".
+            return EMPTY;
         }));
     };
 }
@@ -851,10 +966,10 @@ class CoreService {
         sessionStorage.removeItem('evolution_client_id');
         this.reset();
     }
-    static { this.ɵfac = i0.ɵɵngDeclareFactory({ minVersion: "12.0.0", version: "22.1.5", ngImport: i0, type: CoreService, deps: [], target: i0.ɵɵFactoryTarget.Service }); }
-    static { this.ɵprov = i0.ɵɵngDeclareService({ minVersion: "22.0.0", version: "22.1.5", ngImport: i0, type: CoreService }); }
+    static { this.ɵfac = i0.ɵɵngDeclareFactory({ minVersion: "12.0.0", version: "22.1.6", ngImport: i0, type: CoreService, deps: [], target: i0.ɵɵFactoryTarget.Service }); }
+    static { this.ɵprov = i0.ɵɵngDeclareService({ minVersion: "22.0.0", version: "22.1.6", ngImport: i0, type: CoreService }); }
 }
-i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "22.1.5", ngImport: i0, type: CoreService, decorators: [{
+i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "22.1.6", ngImport: i0, type: CoreService, decorators: [{
             type: Service
         }] });
 
@@ -996,7 +1111,10 @@ class LoginService {
         this.logout().subscribe(r => {
             if (!r.success) {
                 if (r.message) {
-                    this.broadcastService.sendMessage(EvolutionMessages.ERROR, { message: "<p>" + r.message + "</p><br><br><hr><p class='small'><i>Per eliminare la configurazione di Evolution accedere a:<br><b>menu > personalizza > collegamenti</b></i></p>" });
+                    this.broadcastService.sendMessage(EvolutionMessages.ERROR, 
+                    // The surrounding markup is ours; the server's message is escaped, because the dialog
+                    // renders this string as HTML.
+                    { message: "<p>" + escapeHtml(r.message) + "</p><br><br><hr><p class='small'><i>Per eliminare la configurazione di Evolution accedere a:<br><b>menu > personalizza > collegamenti</b></i></p>" });
                 }
             }
             else if ((this.core.flags & EvolutionServiceFlags.DisplayConnectionStateMessages) > 0) {
@@ -1219,10 +1337,10 @@ class LoginService {
             this.broadcastService.sendMessage(EvolutionMessages.LOGIN_COMPLETED);
         }
     }
-    static { this.ɵfac = i0.ɵɵngDeclareFactory({ minVersion: "12.0.0", version: "22.1.5", ngImport: i0, type: LoginService, deps: [], target: i0.ɵɵFactoryTarget.Service }); }
-    static { this.ɵprov = i0.ɵɵngDeclareService({ minVersion: "22.0.0", version: "22.1.5", ngImport: i0, type: LoginService }); }
+    static { this.ɵfac = i0.ɵɵngDeclareFactory({ minVersion: "12.0.0", version: "22.1.6", ngImport: i0, type: LoginService, deps: [], target: i0.ɵɵFactoryTarget.Service }); }
+    static { this.ɵprov = i0.ɵɵngDeclareService({ minVersion: "22.0.0", version: "22.1.6", ngImport: i0, type: LoginService }); }
 }
-i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "22.1.5", ngImport: i0, type: LoginService, decorators: [{
+i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "22.1.6", ngImport: i0, type: LoginService, decorators: [{
             type: Service
         }] });
 
@@ -1310,10 +1428,10 @@ class ComplianceService {
     addActivities(params) {
         return this.httpClient.post(this.core.serviceUri + '/compliance/activities/add', params);
     }
-    static { this.ɵfac = i0.ɵɵngDeclareFactory({ minVersion: "12.0.0", version: "22.1.5", ngImport: i0, type: ComplianceService, deps: [], target: i0.ɵɵFactoryTarget.Service }); }
-    static { this.ɵprov = i0.ɵɵngDeclareService({ minVersion: "22.0.0", version: "22.1.5", ngImport: i0, type: ComplianceService }); }
+    static { this.ɵfac = i0.ɵɵngDeclareFactory({ minVersion: "12.0.0", version: "22.1.6", ngImport: i0, type: ComplianceService, deps: [], target: i0.ɵɵFactoryTarget.Service }); }
+    static { this.ɵprov = i0.ɵɵngDeclareService({ minVersion: "22.0.0", version: "22.1.6", ngImport: i0, type: ComplianceService }); }
 }
-i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "22.1.5", ngImport: i0, type: ComplianceService, decorators: [{
+i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "22.1.6", ngImport: i0, type: ComplianceService, decorators: [{
             type: Service
         }] });
 
@@ -1383,10 +1501,10 @@ class AccountService {
     refreshLicence() {
         return this.httpClient.get(this.core.serviceUri + '/account/licenses/refresh/' + (this.core.user?.userId ?? -1));
     }
-    static { this.ɵfac = i0.ɵɵngDeclareFactory({ minVersion: "12.0.0", version: "22.1.5", ngImport: i0, type: AccountService, deps: [], target: i0.ɵɵFactoryTarget.Service }); }
-    static { this.ɵprov = i0.ɵɵngDeclareService({ minVersion: "22.0.0", version: "22.1.5", ngImport: i0, type: AccountService }); }
+    static { this.ɵfac = i0.ɵɵngDeclareFactory({ minVersion: "12.0.0", version: "22.1.6", ngImport: i0, type: AccountService, deps: [], target: i0.ɵɵFactoryTarget.Service }); }
+    static { this.ɵprov = i0.ɵɵngDeclareService({ minVersion: "22.0.0", version: "22.1.6", ngImport: i0, type: AccountService }); }
 }
-i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "22.1.5", ngImport: i0, type: AccountService, decorators: [{
+i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "22.1.6", ngImport: i0, type: AccountService, decorators: [{
             type: Service
         }] });
 
@@ -1460,10 +1578,10 @@ class EvolutionService {
      * @returns void
      */
     ping() { this.session.ping(); }
-    static { this.ɵfac = i0.ɵɵngDeclareFactory({ minVersion: "12.0.0", version: "22.1.5", ngImport: i0, type: EvolutionService, deps: [], target: i0.ɵɵFactoryTarget.Service }); }
-    static { this.ɵprov = i0.ɵɵngDeclareService({ minVersion: "22.0.0", version: "22.1.5", ngImport: i0, type: EvolutionService }); }
+    static { this.ɵfac = i0.ɵɵngDeclareFactory({ minVersion: "12.0.0", version: "22.1.6", ngImport: i0, type: EvolutionService, deps: [], target: i0.ɵɵFactoryTarget.Service }); }
+    static { this.ɵprov = i0.ɵɵngDeclareService({ minVersion: "22.0.0", version: "22.1.6", ngImport: i0, type: EvolutionService }); }
 }
-i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "22.1.5", ngImport: i0, type: EvolutionService, decorators: [{
+i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "22.1.6", ngImport: i0, type: EvolutionService, decorators: [{
             type: Service
         }] });