chore: beef up isNonInitialPage and add tests

Parkreiner · Parkreiner · commit a08a14972626 · 2023-11-07T17:36:54.000Z
diff --git a/site/src/components/PaginationWidget/utils.test.ts b/site/src/components/PaginationWidget/utils.test.ts
@@ -1,6 +1,6 @@
-import { buildPagedList, getOffset } from "./utils";
+import { buildPagedList, getOffset, isNonInitialPage } from "./utils";
 
-describe("buildPagedList", () => {
+describe(buildPagedList.name, () => {
   it("has no placeholder entries when there are seven or fewer pages", () => {
     for (let i = 1; i <= 7; i++) {
       const expectedResult: number[] = [];
@@ -55,7 +55,7 @@ describe("buildPagedList", () => {
   });
 });
 
-describe("getOffset", () => {
+describe(getOffset.name, () => {
   it("returns 0 on page 1", () => {
     const page = 1;
     const limit = 10;
@@ -70,9 +70,37 @@ describe("getOffset", () => {
     }
   });
 
-  it("Returns offset based on the current page for all pages after 1", () => {
+  it("Returns offset based on the current page for all valid pages after 1", () => {
     expect(getOffset(2, 10)).toEqual(10);
     expect(getOffset(3, 10)).toEqual(20);
     expect(getOffset(4, 45)).toEqual(135);
   });
 });
+
+describe(isNonInitialPage.name, () => {
+  it("Should detect your page correctly if input is set and valid", () => {
+    const params1 = new URLSearchParams({ page: String(1) });
+    expect(isNonInitialPage(params1)).toBe(false);
+
+    const inputs = [2, 50, 500, 3722];
+
+    for (const input of inputs) {
+      const params = new URLSearchParams({ page: String(input) });
+      expect(isNonInitialPage(params)).toBe(true);
+    }
+  });
+
+  it("Should act as if you are on page 1 if input is set but invalid", () => {
+    const inputs = ["", Infinity, -Infinity, NaN, 3.74, -3];
+
+    for (const input of inputs) {
+      const params = new URLSearchParams({ page: String(input) });
+      expect(isNonInitialPage(params)).toBe(false);
+    }
+  });
+
+  it("Should act as if you are on page 1 if input does not exist", () => {
+    const params = new URLSearchParams();
+    expect(isNonInitialPage(params)).toBe(false);
+  });
+});
diff --git a/site/src/components/PaginationWidget/utils.ts b/site/src/components/PaginationWidget/utils.ts
@@ -64,8 +64,10 @@ export const getOffset = (page: number, limit: number): number => {
   return (pageToUse - 1) * limit;
 };
 
-export const nonInitialPage = (searchParams: URLSearchParams): boolean => {
+export const isNonInitialPage = (searchParams: URLSearchParams): boolean => {
   const page = searchParams.get("page");
-  const numberPage = page ? Number(page) : 1;
-  return numberPage > 1;
+  const conversion = Number(page);
+  const inputIsValid = Number.isInteger(conversion) && conversion >= 1;
+
+  return inputIsValid ? conversion > 1 : false;
 };
diff --git a/site/src/pages/AuditPage/AuditPage.tsx b/site/src/pages/AuditPage/AuditPage.tsx
@@ -1,6 +1,6 @@
 import {
   DEFAULT_RECORDS_PER_PAGE,
-  nonInitialPage,
+  isNonInitialPage,
 } from "components/PaginationWidget/utils";
 import { useFeatureVisibility } from "hooks/useFeatureVisibility";
 import { FC } from "react";
@@ -73,7 +73,7 @@ const AuditPage: FC = () => {
         page={pagination.page}
         limit={pagination.limit}
         onPageChange={pagination.goToPage}
-        isNonInitialPage={nonInitialPage(searchParamsResult[0])}
+        isNonInitialPage={isNonInitialPage(searchParamsResult[0])}
         isAuditLogVisible={isAuditLogVisible}
         error={error}
         filterProps={{
diff --git a/site/src/pages/UsersPage/UsersPage.tsx b/site/src/pages/UsersPage/UsersPage.tsx
@@ -28,7 +28,7 @@ import { prepareQuery } from "utils/filters";
 
 import { Helmet } from "react-helmet-async";
 import { DeleteDialog } from "components/Dialogs/DeleteDialog/DeleteDialog";
-import { nonInitialPage } from "components/PaginationWidget/utils";
+import { isNonInitialPage } from "components/PaginationWidget/utils";
 import { ConfirmDialog } from "components/Dialogs/ConfirmDialog/ConfirmDialog";
 import { ResetPasswordDialog } from "./ResetPasswordDialog";
 import { pageTitle } from "utils/page";
@@ -157,7 +157,7 @@ export const UsersPage: FC<{ children?: ReactNode }> = () => {
         isLoading={isLoading}
         canEditUsers={canEditUsers}
         canViewActivity={entitlements.features.audit_log.enabled}
-        isNonInitialPage={nonInitialPage(searchParams)}
+        isNonInitialPage={isNonInitialPage(searchParams)}
         actorID={me.id}
         filterProps={{
           filter: useFilterResult,
