feat(http): Add redirected property to HttpResponse and HttpErrorResponse (#62675)

Add support for the Fetch API's redirected property in HttpResponse and HttpErrorResponse when using HttpClient with the withFetch provider.

The redirected property indicates whether the response was the result of an HTTP redirect, providing valuable information for security, debugging, and conditional logic.

PR Close #62675

Author: SkyZeroZx

goldens/public-api/common/http/index.api.md

@@ -2508,6 +2508,7 @@ export class HttpErrorResponse extends HttpResponseBase implements Error {
         status?: number;
         statusText?: string;
         url?: string;
+        redirected?: boolean;
     });
     // (undocumented)
     readonly error: any | null;
@@ -2931,6 +2932,7 @@ export class HttpResponse<T> extends HttpResponseBase {
         status?: number;
         statusText?: string;
         url?: string;
+        redirected?: boolean;
     });
     readonly body: T | null;
     // (undocumented)
@@ -2941,6 +2943,7 @@ export class HttpResponse<T> extends HttpResponseBase {
         status?: number;
         statusText?: string;
         url?: string;
+        redirected?: boolean;
     }): HttpResponse<T>;
     // (undocumented)
     clone<V>(update: {
@@ -2949,6 +2952,7 @@ export class HttpResponse<T> extends HttpResponseBase {
         status?: number;
         statusText?: string;
         url?: string;
+        redirected?: boolean;
     }): HttpResponse<V>;
     // (undocumented)
     readonly type: HttpEventType.Response;
@@ -2961,9 +2965,11 @@ export abstract class HttpResponseBase {
         status?: number;
         statusText?: string;
         url?: string;
+        redirected?: boolean;
     }, defaultStatus?: number, defaultStatusText?: string);
     readonly headers: HttpHeaders;
     readonly ok: boolean;
+    readonly redirected?: boolean;
     readonly status: number;
     readonly statusText: string;
     readonly type: HttpEventType.Response | HttpEventType.ResponseHeader;

packages/common/http/src/fetch.ts

@@ -271,6 +271,8 @@ export class FetchBackend implements HttpBackend {
     // asked for JSON data and the body cannot be parsed as such.
     const ok = status >= 200 && status < 300;
 
+    const redirected = response.redirected;
+
     if (ok) {
       observer.next(
         new HttpResponse({
@@ -279,6 +281,7 @@ export class FetchBackend implements HttpBackend {
           status,
           statusText,
           url,
+          redirected,
         }),
       );
 
@@ -293,6 +296,7 @@ export class FetchBackend implements HttpBackend {
           status,
           statusText,
           url,
+          redirected,
         }),
       );
     }

packages/common/http/src/response.ts

@@ -185,6 +185,13 @@ export abstract class HttpResponseBase {
    */
   readonly type!: HttpEventType.Response | HttpEventType.ResponseHeader;
 
+  /**
+   * Indicates whether the HTTP response was redirected during the request.
+   * This property is only available when using the Fetch API using `withFetch()`
+   * When using the default XHR Request this property will be `undefined`
+   */
+  readonly redirected?: boolean;
+
   /**
    * Super-constructor for all responses.
    *
@@ -197,6 +204,7 @@ export abstract class HttpResponseBase {
       status?: number;
       statusText?: string;
       url?: string;
+      redirected?: boolean;
     },
     defaultStatus: number = 200,
     defaultStatusText: string = 'OK',
@@ -207,6 +215,7 @@ export abstract class HttpResponseBase {
     this.status = init.status !== undefined ? init.status : defaultStatus;
     this.statusText = init.statusText || defaultStatusText;
     this.url = init.url || null;
+    this.redirected = init.redirected;
 
     // Cache the ok value to avoid defining a getter.
     this.ok = this.status >= 200 && this.status < 300;
@@ -244,7 +253,12 @@ export class HttpHeaderResponse extends HttpResponseBase {
    * given parameter hash.
    */
   clone(
-    update: {headers?: HttpHeaders; status?: number; statusText?: string; url?: string} = {},
+    update: {
+      headers?: HttpHeaders;
+      status?: number;
+      statusText?: string;
+      url?: string;
+    } = {},
   ): HttpHeaderResponse {
     // Perform a straightforward initialization of the new HttpHeaderResponse,
     // overriding the current parameters with new ones if given.
@@ -282,6 +296,7 @@ export class HttpResponse<T> extends HttpResponseBase {
       status?: number;
       statusText?: string;
       url?: string;
+      redirected?: boolean;
     } = {},
   ) {
     super(init);
@@ -296,13 +311,15 @@ export class HttpResponse<T> extends HttpResponseBase {
     status?: number;
     statusText?: string;
     url?: string;
+    redirected?: boolean;
   }): HttpResponse<T>;
   clone<V>(update: {
     body?: V | null;
     headers?: HttpHeaders;
     status?: number;
     statusText?: string;
     url?: string;
+    redirected?: boolean;
   }): HttpResponse<V>;
   clone(
     update: {
@@ -311,6 +328,7 @@ export class HttpResponse<T> extends HttpResponseBase {
       status?: number;
       statusText?: string;
       url?: string;
+      redirected?: boolean;
     } = {},
   ): HttpResponse<any> {
     return new HttpResponse<any>({
@@ -319,6 +337,7 @@ export class HttpResponse<T> extends HttpResponseBase {
       status: update.status !== undefined ? update.status : this.status,
       statusText: update.statusText || this.statusText,
       url: update.url || this.url || undefined,
+      redirected: update.redirected ?? this.redirected,
     });
   }
 }
@@ -352,6 +371,7 @@ export class HttpErrorResponse extends HttpResponseBase implements Error {
     status?: number;
     statusText?: string;
     url?: string;
+    redirected?: boolean;
   }) {
     // Initialize with a default status of 0 / Unknown Error.
     super(init, 0, 'Unknown Error');

packages/common/http/test/response_spec.ts

@@ -20,13 +20,15 @@ describe('HttpResponse', () => {
         status: HttpStatusCode.Created,
         statusText: 'Created',
         url: '/test',
+        redirected: true,
       });
       expect(resp.body).toBe('test body');
       expect(resp.headers instanceof HttpHeaders).toBeTruthy();
       expect(resp.headers.get('Test')).toBe('Test header');
       expect(resp.status).toBe(HttpStatusCode.Created);
       expect(resp.statusText).toBe('Created');
       expect(resp.url).toBe('/test');
+      expect(resp.redirected).toBe(true);
     });
     it('uses defaults if no args passed', () => {
       const resp = new HttpResponse({});
@@ -36,6 +38,7 @@ describe('HttpResponse', () => {
       expect(resp.body).toBeNull();
       expect(resp.ok).toBeTruthy();
       expect(resp.url).toBeNull();
+      expect(resp.redirected).toBeUndefined();
     });
     it('accepts a falsy body', () => {
       expect(new HttpResponse({body: false}).body).toEqual(false);
@@ -59,31 +62,36 @@ describe('HttpResponse', () => {
         status: HttpStatusCode.Created,
         statusText: 'created',
         url: '/test',
+        redirected: false,
       }).clone();
       expect(clone.body).toBe('test');
       expect(clone.status).toBe(HttpStatusCode.Created);
       expect(clone.statusText).toBe('created');
       expect(clone.url).toBe('/test');
       expect(clone.headers).not.toBeNull();
+      expect(clone.redirected).toBe(false);
     });
     it('overrides the original', () => {
       const orig = new HttpResponse({
         body: 'test',
         status: HttpStatusCode.Created,
         statusText: 'created',
         url: '/test',
+        redirected: true,
       });
       const clone = orig.clone({
         body: {data: 'test'},
         status: HttpStatusCode.Ok,
         statusText: 'Okay',
         url: '/bar',
+        redirected: false,
       });
       expect(clone.body).toEqual({data: 'test'});
       expect(clone.status).toBe(HttpStatusCode.Ok);
       expect(clone.statusText).toBe('Okay');
       expect(clone.url).toBe('/bar');
       expect(clone.headers).toBe(orig.headers);
+      expect(clone.redirected).toBe(false);
     });
   });
 });