@sitecore-jss/sitecore-jss-proxy 13.2.5-canary.1 → 13.2.5-canary.2

package/dist/index.js

@@ -55,7 +55,6 @@ var set_cookie_parser_1 = __importDefault(require("set-cookie-parser"));
 var http_status_codes_1 = __importDefault(require("http-status-codes"));
 var zlib_1 = __importDefault(require("zlib")); // node.js standard lib
 var util_1 = require("./util");
-// tslint:disable:max-line-length
 // For some reason, every other response returned by Sitecore contains the 'set-cookie' header with the SC_ANALYTICS_GLOBAL_COOKIE value as an empty string.
 // This effectively sets the cookie to empty on the client as well, so if a user were to close their browser
 // after one of these 'empty value' responses, they would not be tracked as a returning visitor after re-opening their browser.
@@ -83,7 +82,8 @@ function renderAppToResponse(proxyResponse, request, serverResponse, renderer, c
             return __awaiter(this, void 0, void 0, function () {
                 var responseString;
                 return __generator(this, function (_a) {
-                    if (proxyResponse.statusCode === http_status_codes_1.default.OK || proxyResponse.statusCode === http_status_codes_1.default.NOT_FOUND) {
+                    if (proxyResponse.statusCode === http_status_codes_1.default.OK ||
+                        proxyResponse.statusCode === http_status_codes_1.default.NOT_FOUND) {
                         responseString = void 0;
                         if (contentEncoding &&
                             (contentEncoding.indexOf('gzip') !== -1 || contentEncoding.indexOf('deflate') !== -1)) {
@@ -400,13 +400,26 @@ function isUrlIgnored(originalUrl, config, noDebug) {
     return false;
 }
 function handleProxyRequest(proxyReq, req, res, config, customOnProxyReq) {
+    var _a;
     // if a HEAD request, we still need to issue a GET so we can return accurate headers
-    // proxyReq defined as 'any' to allow us to mutate this
-    if (proxyReq.method === 'HEAD' && !isUrlIgnored(req.originalUrl, config, true)) {
-        if (config.debug) {
-            console.log('DEBUG: Rewriting HEAD request to GET to create accurate headers');
+    if (!isUrlIgnored(req.originalUrl, config, true)) {
+        // In case 'followRedirects' is enabled, and before the proxy was initialized we had set 'originalMethod'
+        // now we need to set req.method back to original one, since proxyReq is already initialized.
+        // See more info in 'preProxyHandler'
+        if (((_a = config.proxyOptions) === null || _a === void 0 ? void 0 : _a.followRedirects) && req.originalMethod === 'HEAD') {
+            req.method = req.originalMethod;
+            delete req.originalMethod;
+            if (config.debug) {
+                console.log('DEBUG: Rewriting HEAD request to GET to create accurate headers');
+            }
+        }
+        else if (proxyReq.method === 'HEAD') {
+            if (config.debug) {
+                console.log('DEBUG: Rewriting HEAD request to GET to create accurate headers');
+            }
+            // if a HEAD request, we still need to issue a GET so we can return accurate headers
+            proxyReq.method = 'GET';
         }
-        proxyReq.method = 'GET';
     }
     // invoke custom onProxyReq
     if (customOnProxyReq) {
@@ -428,10 +441,26 @@ function createOptions(renderer, config, parseRouteUrl) {
         console.log('DEBUG: Final proxy config', config);
     }
     var customOnProxyReq = (_a = config.proxyOptions) === null || _a === void 0 ? void 0 : _a.onProxyReq;
-    return __assign(__assign({}, config.proxyOptions), { target: config.apiHost, changeOrigin: true, ws: true, pathRewrite: function (reqPath, req) { return rewriteRequestPath(reqPath, req, config, parseRouteUrl); }, logLevel: config.debug ? 'debug' : 'info', onProxyReq: function (proxyReq, req, res) { return handleProxyRequest(proxyReq, req, res, config, customOnProxyReq); }, onProxyRes: function (proxyRes, req, res) { return handleProxyResponse(proxyRes, req, res, renderer, config); } });
+    return __assign(__assign({}, config.proxyOptions), { target: config.apiHost, changeOrigin: true, ws: true, pathRewrite: function (reqPath, req) { return rewriteRequestPath(reqPath, req, config, parseRouteUrl); }, logLevel: config.debug ? 'debug' : 'info', onProxyReq: function (proxyReq, req, res) {
+            return handleProxyRequest(proxyReq, req, res, config, customOnProxyReq);
+        }, onProxyRes: function (proxyRes, req, res) { return handleProxyResponse(proxyRes, req, res, renderer, config); } });
 }
 function scProxy(renderer, config, parseRouteUrl) {
     var options = createOptions(renderer, config, parseRouteUrl);
-    return http_proxy_middleware_1.default(options);
+    var preProxyHandler = function (req, _res, next) {
+        // When 'followRedirects' is enabled, 'onProxyReq' is executed after 'proxyReq' is initialized based on original 'req'
+        // and there are no public properties/methods to modify Redirectable 'proxyReq'.
+        // so, we need to set 'HEAD' req as 'GET' before the proxy is initialized.
+        // During the 'onProxyReq' event we will set 'req.method' back as 'HEAD'.
+        // if a HEAD request, we need to issue a GET so we can return accurate headers
+        if (req.method === 'HEAD' &&
+            options.followRedirects &&
+            !isUrlIgnored(req.originalUrl, config, true)) {
+            req.method = 'GET';
+            req.originalMethod = 'HEAD';
+        }
+        next();
+    };
+    return [preProxyHandler, http_proxy_middleware_1.default(options)];
 }
 exports.default = scProxy;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sitecore-jss/sitecore-jss-proxy",
-  "version": "13.2.5-canary.1",
+  "version": "13.2.5-canary.2",
   "description": "Proxy middleware for express.js server.",
   "main": "dist/index.js",
   "scripts": {
@@ -42,5 +42,5 @@
     "typescript": "^3.1.3"
   },
   "types": "types/index.d.ts",
-  "gitHead": "9a90cd19b4ee128d60d6664b2f2dbabdc9a5e77f"
+  "gitHead": "e55d15ad7d6b3498d9d1c285a7d3640cc2f9a5f3"
 }

package/types/index.d.ts

@@ -1,7 +1,11 @@
-/// <reference types="connect" />
+/// <reference types="node" />
+import { IncomingMessage } from 'http';
 import { AppRenderer } from './AppRenderer';
 import { ProxyConfig } from './ProxyConfig';
 import { RouteUrlParser } from './RouteUrlParser';
+export interface ProxyIncomingMessage extends IncomingMessage {
+    originalUrl: string;
+}
 export declare const removeEmptyAnalyticsCookie: (proxyResponse: any) => void;
 export declare function rewriteRequestPath(reqPath: string, req: any, config: ProxyConfig, parseRouteUrl?: RouteUrlParser): string;
-export default function scProxy(renderer: AppRenderer, config: ProxyConfig, parseRouteUrl: RouteUrlParser): import("connect").NextHandleFunction;
+export default function scProxy(renderer: AppRenderer, config: ProxyConfig, parseRouteUrl: RouteUrlParser): any[];