refactor(http): Make sur to pass context & transferCache from httpResource to the underlying request.

JeanMeche · JeanMeche · commit b49389c1e949 · 2025-03-05T21:39:58.000+01:00
Prior to this change, both were accepted as argument but never passed to the client.
diff --git a/packages/common/http/src/resource.ts b/packages/common/http/src/resource.ts
@@ -279,6 +279,8 @@ function normalizeRequest(
       reportProgress: unwrappedRequest.reportProgress,
       withCredentials: unwrappedRequest.withCredentials,
       responseType,
+      context: unwrappedRequest.context,
+      transferCache: unwrappedRequest.transferCache,
     },
   );
 }
diff --git a/packages/common/http/test/resource_spec.ts b/packages/common/http/test/resource_spec.ts
@@ -8,7 +8,13 @@
 
 import {ApplicationRef, Injector, signal} from '@angular/core';
 import {TestBed} from '@angular/core/testing';
-import {HttpEventType, provideHttpClient, httpResource} from '@angular/common/http';
+import {
+  HttpEventType,
+  provideHttpClient,
+  httpResource,
+  HttpContext,
+  HttpContextToken,
+} from '@angular/common/http';
 import {HttpTestingController, provideHttpClientTesting} from '@angular/common/http/testing';
 
 describe('httpResource', () => {
@@ -145,6 +151,40 @@ describe('httpResource', () => {
     expect(res.value()).toEqual([]);
   });
 
+  it('should pass all request parameters', () => {
+    const backend = TestBed.inject(HttpTestingController);
+
+    const CTX_TOKEN = new HttpContextToken(() => 'value');
+    const res = httpResource(
+      () => ({
+        url: '/data',
+        params: {
+          'fast': 'yes',
+        },
+        responseType: 'text', // This one is not overwritten (and no excess property check from ts)
+        headers: {
+          'X-Tag': 'alpha,beta',
+        },
+        reportProgress: true,
+        context: new HttpContext().set(CTX_TOKEN, 'bar'),
+        withCredentials: true,
+        transferCache: {includeHeaders: ['Y-Tag']},
+      }),
+      {
+        injector: TestBed.inject(Injector),
+      },
+    );
+    TestBed.flushEffects();
+
+    const req = TestBed.inject(HttpTestingController).expectOne('/data?fast=yes');
+    expect(req.request.headers.get('X-Tag')).toEqual('alpha,beta');
+    expect(req.request.responseType).toEqual('json');
+    expect(req.request.withCredentials).toEqual(true);
+    expect(req.request.context.get(CTX_TOKEN)).toEqual('bar');
+    expect(req.request.reportProgress).toEqual(true);
+    expect(req.request.transferCache).toEqual({includeHeaders: ['Y-Tag']});
+  });
+
   it('should allow mapping data to an arbitrary type', async () => {
     const backend = TestBed.inject(HttpTestingController);
     const res = httpResource(

Original file line number	Diff line number	Diff line change
`@@ -279,6 +279,8 @@ function normalizeRequest(`
`279`	`279`	`reportProgress: unwrappedRequest.reportProgress,`
`280`	`280`	`withCredentials: unwrappedRequest.withCredentials,`
`281`	`281`	`responseType,`
	`282`	`+ context: unwrappedRequest.context,`
	`283`	`+ transferCache: unwrappedRequest.transferCache,`
`282`	`284`	`},`
`283`	`285`	`);`
`284`	`286`	`}`