fix: Correctly set x-ms-original-url to the full original request URL (#286) (#314)

* Correctly preserving x-ms-original-url

* reverted changes

* Correctly serve static assets, but also correctly fallback to functions

* Refactored getResponse to return a boolean if it was succesfully handled

* Set the x-ms-original-url to equal the full request URL

* Added e2e test for verifying x-ms-original-url is set

Author: danielgary

cypress/integration/functions.js

@@ -16,6 +16,13 @@ context.only("/api", () => {
         expect(body).to.include("x-swa-custom");
       });
     });
+    it("Should correctly set x-ms-original-url to the full request url", () => {
+      const HEADER_URL = "http://0.0.0.0:1234/api/headers";
+      cy.request({ url: HEADER_URL, failOnStatusCode: false }).then((response) => {
+        expect(response.status).to.eq(200);
+        expect(response.body["x-ms-original-url"]).to.equal(HEADER_URL);
+      });
+    });
   });
 
   describe(`Accessing /api/status`, () => {
@@ -46,7 +53,7 @@ context.only("/api", () => {
 
       cy.request({ url: `http://0.0.0.0:1234/api/info`, failOnStatusCode: false }).then((response) => {
         expect(response.status).to.eq(200);
-        expect(response.body).to.eq('authorized');
+        expect(response.body).to.eq("authorized");
       });
     });
   });

src/msha/handlers/function.handler.ts

@@ -16,10 +16,10 @@ registerProcessExit(() => {
 
 function injectHeaders(req: http.ClientRequest, host: string) {
   logger.silly(`injecting headers to Functions request:`);
-
-  req.setHeader("x-ms-original-url", encodeURI(new URL(req.path!, host).toString()));
-  logger.silly(` - x-ms-original-url: ${chalk.yellow(req.getHeader("x-ms-original-url"))}`);
-
+  if (!req.getHeader("x-ms-original-url")) {
+    req.setHeader("x-ms-original-url", encodeURI(new URL(req.path!, host).toString()));
+    logger.silly(` - x-ms-original-url: ${chalk.yellow(req.getHeader("x-ms-original-url"))}`);
+  }
   // generate a fake correlation ID
   req.setHeader("x-ms-request-id", `SWA-CLI-${Math.random().toString(36).substring(2).toUpperCase()}`);
   logger.silly(` - x-ms-request-id: ${chalk.yellow(req.getHeader("x-ms-request-id"))}`);

src/msha/middlewares/request.middleware.ts

@@ -301,9 +301,7 @@ export async function requestMiddleware(
     return await handleAuthRequest(req, res, matchingRouteRule, userConfig);
   }
 
-  getResponse(req, res, matchingRouteRule, userConfig, isFunctionReq);
-
-  if (!isFunctionReq) {
+  if (!getResponse(req, res, matchingRouteRule, userConfig, isFunctionReq)) {
     logger.silly(` - url: ${chalk.yellow(req.url)}`);
     logger.silly(` - target: ${chalk.yellow(target)}`);
 

src/msha/middlewares/response.middleware.ts

@@ -19,32 +19,35 @@ export function getResponse(
   matchedRoute: SWAConfigFileRoute | undefined,
   userConfig: SWAConfigFile | undefined,
   isFunctionRequest: boolean
-) {
+): boolean {
   const statusCodeToServe = parseInt(`${matchedRoute?.statusCode}`, 10);
   const redirect = matchedRoute?.redirect;
   const rewrite = matchedRoute?.rewrite;
-
   logger.silly(`using userConfig`);
   logger.silly({ userConfig });
 
   if (redirect) {
     logger.silly(` - redirect rule detected. Exit`);
 
-    return applyRedirectResponse(req, res, matchedRoute);
+    applyRedirectResponse(req, res, matchedRoute);
+    return false;
   }
-
+  // We should always set the x-ms-original-url to be the full request URL.
+  req.headers["x-ms-original-url"] = new URL(req.url!, `http://${req.headers.host}`).href;
   if (rewrite) {
     req.url = rewrite;
   }
 
   if ([403, 401].includes(statusCodeToServe)) {
     logger.silly(` - ${statusCodeToServe} code detected. Exit`);
 
-    return handleErrorPage(req, res, statusCodeToServe, userConfig?.responseOverrides);
+    handleErrorPage(req, res, statusCodeToServe, userConfig?.responseOverrides);
+    return false;
   }
 
   if (isFunctionRequest) {
-    return handleFunctionRequest(req, res);
+    handleFunctionRequest(req, res);
+    return true;
   }
 
   const storageResult = getStorageContent(
@@ -60,12 +63,14 @@ export function getResponse(
   );
 
   if (storageResult.isFunctionFallbackRequest) {
-    return handleFunctionRequest(req, res);
+    req.url = userConfig?.navigationFallback.rewrite!;
+    handleFunctionRequest(req, res);
+    return true;
   }
-
   if (statusCodeToServe) {
     res.statusCode = statusCodeToServe;
   }
+  return false;
 }
 
 export function getStorageContent(