Merge pull request #161 from DhanaSekharM/gov-client-window-size

feat: export window size details header for HMRC

USAGE.md

@@ -59,3 +59,9 @@ const {headerValue, error} = getGovClientTimezoneHeader();
 import getGovClientLocalIPsHeader from 'user-data-for-fraud-prevention';
 const {headerValue, error} = await getGovClientLocalIPsHeader();
 ```
+
+* To get Gov-Client-Window-Size HMRC Fraud prevention header:
+```js
+import {getGovClientWindowSizeHeader} from 'user-data-for-fraud-prevention';
+const {headerValue, error} = getGovClientWindowSizeHeader();
+```

src/js/hmrc/mtdFraudPrevention.js

@@ -171,4 +171,17 @@ export const getGovClientLocalIPsHeader = async () => {
  } catch (error) {
  return { error };
  }
-}
+}
+
+/**
+ * Returns the value for Gov-Client-Window-Size HMRC Fraud prevention header.
+ */
+export const getGovClientWindowSizeHeader = () => {
+ try {
+ return { headerValue: getWindowSize() };
+ } catch (error) {
+ return { error };
+ }
+};
+
+

src/js/index.js

@@ -9,6 +9,7 @@ import {
  getGovClientDeviceID,
  getGovClientTimezoneHeader,
  getGovClientLocalIPsHeader,
+ getGovClientWindowSizeHeader
 } from "./hmrc/mtdFraudPrevention";
 
 exports.fraudPreventionHeadersEnum = fraudPreventionHeadersEnum;
@@ -22,4 +23,6 @@ exports.getGovClientTimezoneHeader = getGovClientTimezoneHeader;
 exports.getGovClientLocalIPsHeader = getGovClientLocalIPsHeader;
 exports.getScreenDetails = getScreenDetails;
 exports.getGovClientBrowserJSUserAgentHeader = getGovClientBrowserJSUserAgentHeader;
+
 exports.windowDetails = windowDetails;
+exports.getGovClientWindowSizeHeader = getGovClientWindowSizeHeader;

tests/unit/hmrc/mtdFraudPrevention.test.js

@@ -18,6 +18,7 @@ import {getGovClientBrowserPluginsHeader} from "../../../src/js/hmrc/mtdFraudPre
 import {getGovClientDeviceID} from "../../../src/js/hmrc/mtdFraudPrevention";
 import {getGovClientBrowserDoNotTrackHeader} from "../../../src/js/hmrc/mtdFraudPrevention";
 import {getGovClientTimezoneHeader} from "../../../src/js/hmrc/mtdFraudPrevention";
+import {getGovClientWindowSizeHeader} from "../../../src/js/hmrc/mtdFraudPrevention"
 
 describe("FraudPreventionHeaders", () => {
  resetDeviceIpString();
@@ -330,3 +331,44 @@ describe("getGovClientLocalIPsHeader", () => {
  deviceLocalIpMock.mockRestore();
  });
 });
+
+describe("getGovClientWindowSizeHeader", () => {
+ it("returns correct headerValue when there is no error", () => {
+ const windowSpy = jest
+ .spyOn(window, "window", "get")
+ .mockImplementation(() => ({
+ innerWidth: 100,
+ innerHeight: 100,
+ }));
+
+ const { headerValue } = getGovClientWindowSizeHeader();
+ expect(headerValue).toBe("width=100&height=100");
+ windowSpy.mockRestore();
+ });
+
+ it("returns error when there is an error in window width", () => {
+ const widthSpy = jest
+ .spyOn(browserInfoHelper, "getWindowWidth")
+ .mockImplementation(() => {
+ throw Error("Something went wrong.");
+ });
+ const { error } = getGovClientWindowSizeHeader();
+ expect(error).toEqual(Error("Something went wrong."));
+ widthSpy.mockRestore();
+ });
+
+ it("returns error when there is an error in window height", () => {
+ const heightSpy = jest
+ .spyOn(browserInfoHelper, "getWindowHeight")
+ .mockImplementation(() => {
+ throw Error("Something went wrong.");
+ });
+ const { error } = getGovClientWindowSizeHeader();
+ expect(error).toEqual(Error("Something went wrong."));
+ heightSpy.mockRestore();
+ });
+});
+
+
+
+