#1134 Add possibility to automatically close popup window after som…

docs/oidc-client-ts.api.md

@@ -480,6 +480,7 @@ export interface OidcStandardClaims {
 export interface PopupWindowFeatures {
     // (undocumented)
     [k: string]: boolean | string | number | undefined;
+    closePopupWindowAfter?: number;
     // (undocumented)
     height?: number;
     // (undocumented)

src/UserManagerSettings.test.ts

@@ -53,6 +53,19 @@ describe("UserManagerSettings", () => {
             expect(subject.popupWindowFeatures).toEqual({ status: true });
         });
 
+        it("should set closePopupWindowAfter", () => {
+            // act
+            const closePopupWindowAfter = 100;
+            const subject = new UserManagerSettingsStore({
+                authority: "authority",
+                client_id: "client",
+                redirect_uri: "redirect",
+                popupWindowFeatures: { status: true, closePopupWindowAfter },
+            });
+
+            // assert
+            expect(subject.popupWindowFeatures).toEqual({ status: true, closePopupWindowAfter });
+        });
     });
 
     describe("popupWindowTarget", () => {

src/UserManagerSettings.ts

@@ -10,6 +10,7 @@ export const DefaultPopupWindowFeatures: PopupWindowFeatures = {
     location: false,
     toolbar: false,
     height: 640,
+    closePopupWindowAfter: 0,
 };
 export const DefaultPopupTarget = "_blank";
 const DefaultAccessTokenExpiringNotificationTimeInSeconds = 60;
@@ -28,7 +29,7 @@ export interface UserManagerSettings extends OidcClientSettings {
     /**
      * The features parameter to window.open for the popup signin window. By default, the popup is
      * placed centered in front of the window opener.
-     * (default: \{ location: false, menubar: false, height: 640 \})
+     * (default: \{ location: false, menubar: false, height: 640, closePopupWindowAfter: 0 \})
      */
     popupWindowFeatures?: PopupWindowFeatures;
     /** The target parameter to window.open for the popup signin window (default: "_blank") */

src/navigators/PopupWindow.test.ts

@@ -144,4 +144,32 @@ describe("PopupWindow", () => {
             keepOpen: false,
         }, window.location.origin);
     });
+
+    it("should close the window after closePopupWindowAfter is greater than 0", async () => {
+        const popupWindow = new PopupWindow({ popupWindowFeatures: { closePopupWindowAfter: 1 } });
+
+        const promise = popupWindow.navigate({ url: "http://sts/authorize?x=y", state: "someid" });
+
+        jest.runOnlyPendingTimers();
+        await expect(promise).rejects.toThrow("Popup blocked by user");
+        jest.runAllTimers();
+    });
+
+    it("shouldnt close the window after closePopupWindowAfter is equal to 0", async () => {
+        jest.spyOn(global, "setTimeout");
+
+        new PopupWindow({ popupWindowFeatures: { closePopupWindowAfter: 0 } });
+
+        jest.runOnlyPendingTimers();
+        expect(setTimeout).toHaveBeenCalledTimes(0);
+    });
+
+    it("shouldnt close the window after closePopupWindowAfter is less than 0", async () => {
+        jest.spyOn(global, "setTimeout");
+
+        new PopupWindow({ popupWindowFeatures: { closePopupWindowAfter: -120 } });
+
+        jest.runOnlyPendingTimers();
+        expect(setTimeout).toHaveBeenCalledTimes(0);
+    });
 });

src/navigators/PopupWindow.ts

@@ -31,6 +31,13 @@ export class PopupWindow extends AbstractChildWindow {
         super();
         const centeredPopup = PopupUtils.center({ ...DefaultPopupWindowFeatures, ...popupWindowFeatures });
         this._window = window.open(undefined, popupWindowTarget, PopupUtils.serialize(centeredPopup));
+        if (popupWindowFeatures?.closePopupWindowAfter && popupWindowFeatures?.closePopupWindowAfter > 0) {
+            setTimeout(() => { 
+                if (!this._window || typeof this._window.closed !== "boolean" || this._window.closed) {
+                    this._abort.raise(new Error("Popup blocked by user"));
+                }
+            }, popupWindowFeatures.closePopupWindowAfter);
+        }
     }
 
     public async navigate(params: NavigateParams): Promise<NavigateResponse> {

src/utils/PopupUtils.ts

@@ -14,6 +14,8 @@ export interface PopupWindowFeatures {
     status?: boolean | string;
     resizable?: boolean | string;
     scrollbars?: boolean | string;
+    /** Close popup window after time in milliseconds, by default it is 0. To enable this feature set value greater than 0 */
+    closePopupWindowAfter?: number;
 
     [k: string]: boolean | string | number | undefined;
 }