[Bug] Triage existing linting issues (#1060)

Went through several linter issues and fixed most ## Changes - Went through and found areas of easy linter improvements and fixed them. - Went through and found areas referencing this ticket and either fixed them, or put them under the umbrella of the post-mvp linter issues. ## How to test this PR 1. Pull the branch for the sbl-frontend repo 2. Restart the stack as necessary 3. Check the github pipeline and make sure that linters are green 4. Run the e2e tests and verify no new failures --------- Co-authored-by: Copilot Autofix powered by AI <62310815+github-advanced-security[bot]@users.noreply.github.com>
cfpb · Dec 12, 2024 · 3f6eab3 · 3f6eab3
1 parent b84427e
commit 3f6eab3
Show file tree

Hide file tree

Showing 27 changed files with 67 additions and 126 deletions.
diff --git a/.eslintrc.json b/.eslintrc.json
@@ -26,6 +26,12 @@
     "plugin:prettier/recommended"
   ],
   "rules": {
+    "no-console": [
+      "error",
+      {
+        "allow": ["warn", "error"]
+      }
+    ],
     "react/jsx-props-no-spreading": "off",
     "no-dupe-else-if": "error",
     "no-promise-executor-return": "error",
@@ -110,6 +116,7 @@
     "react/no-unused-state": "off",
     "react/prefer-stateless-function": "off",
     "react/require-render-return": "off",
+    "react/require-default-props": "off",
     "react/sort-comp": "off",
     "react/state-in-constructor": "off",
     "react/static-property-placement": "off",
@@ -149,7 +156,7 @@
     ],
     "react/jsx-no-constructed-context-values": "error",
     "react/jsx-no-script-url": "error",
-    "react/jsx-no-useless-fragment": "error",
+    "react/jsx-no-useless-fragment": "off",
 
     "unicorn/filename-case": [
       "error",

diff --git a/e2e/utils/createDomainAssociation.ts b/e2e/utils/createDomainAssociation.ts
@@ -21,8 +21,6 @@ export default async function createDomainAssociation({
   try {
     await axios.request(optionsForDomainAssociation);
   } catch (error) {
-    // Part of evaluation for linter issues see: https://github.com/cfpb/sbl-frontend/issues/1039
-    // eslint-disable-next-line no-console
     console.error(
       'error when creating a domain/institution association :>>',
       error,

diff --git a/e2e/utils/createInstitution.ts b/e2e/utils/createInstitution.ts
@@ -50,8 +50,7 @@ export default async function createInstitution({
   try {
     await axios.request(options);
   } catch (error) {
-    // eslint-disable-next-line no-console
-    console.log('error when creating institutions :>>', error);
+    console.error('error when creating institutions :>>', error);
     throw error;
   }
 }
diff --git a/e2e/utils/createKeycloakUser.ts b/e2e/utils/createKeycloakUser.ts
@@ -4,9 +4,7 @@ import { config } from './authConstants';
 export class KeycloakService {
   private readonly kcAdminClient: KeycloakAdminClient;
 
-  // Part of evaluation for linter issues see: https://github.com/cfpb/sbl-frontend/issues/1039
-  // eslint-disable-next-line @typescript-eslint/explicit-member-accessibility
-  constructor() {
+  public constructor() {
     this.kcAdminClient = new KeycloakAdminClient({
       baseUrl: config.target,
       realmName: config.realm,
@@ -46,7 +44,6 @@ export default async function createKeycloakUser({
       grantType: config.cli.grantType,
     });
   } catch (error) {
-    // eslint-disable-next-line no-console
     console.error(
       'error when attempting to auth into keycloak admin :>>',
       error,
@@ -70,8 +67,7 @@ export default async function createKeycloakUser({
     });
     result = response?.id ?? '';
   } catch (error) {
-    // eslint-disable-next-line no-console
-    console.log('error when trying to create a user in keycloak :>>', error);
+    console.error('error when trying to create a user in keycloak :>>', error);
     throw error;
   }
   return result;

diff --git a/e2e/utils/deleteKeycloakUser.ts b/e2e/utils/deleteKeycloakUser.ts
@@ -27,7 +27,7 @@ export default async function deleteKeycloakUser({
 
   try {
     await kcAdminClient.users.del({
-      id: id,
+      id,
     });
   } catch (error) {
     // eslint-disable-next-line no-console

diff --git a/e2e/utils/getKeycloakToken.ts b/e2e/utils/getKeycloakToken.ts
@@ -14,16 +14,14 @@ export default async function getAdminKeycloakToken(): Promise<string> {
     data: encodedParameters,
   };
   try {
-    // Part of evaluation for linter issues see: https://github.com/cfpb/sbl-frontend/issues/1039
+    // Part of code cleanup for post-mvp see: https://github.com/cfpb/sbl-frontend/issues/717
     // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
     const { data } = await axios.request(optionsForGetAdminKeycloakToken);
-    // Part of evaluation for linter issues see: https://github.com/cfpb/sbl-frontend/issues/1039
+    // Part of code cleanup for post-mvp see: https://github.com/cfpb/sbl-frontend/issues/717
     // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access
     return data.access_token as string;
   } catch (error) {
-    // Part of evaluation for linter issues see: https://github.com/cfpb/sbl-frontend/issues/1039
-    // eslint-disable-next-line no-console
-    console.log(
+    console.error(
       'error when trying to fetch an admin token from keycloak :>>',
       error,
     );

diff --git a/e2e/utils/verifyDownloadableReport.ts b/e2e/utils/verifyDownloadableReport.ts
@@ -65,7 +65,6 @@ export async function verifyDownloadableReport({
         console.log(`Deleted the downloaded file: ${downloadFilePath}`);
       }
     } catch (error) {
-      // eslint-disable-next-line no-console
       console.error(
         `Failed to delete file: ${downloadFilePath}. Error: ${
           (error as Error).message

diff --git a/src/App.tsx b/src/App.tsx
@@ -1,4 +1,3 @@
-/* eslint-disable @typescript-eslint/no-misused-promises */
 import { useQuery } from '@tanstack/react-query';
 import { MarkdownText } from 'MarkdownTest';
 import { fetchUserProfile } from 'api/requests';
@@ -65,7 +64,6 @@ const TypesFinancialInstitutions = lazy(
   async () => import('pages/TypesFinancialInstitutions'),
 );
 const FilingCreate = lazy(
-  // @ts-expect-error Part of code cleanup for post-mvp see: https://github.com/cfpb/sbl-frontend/issues/717
   async () => import('pages/Filing/FilingApp/FilingCreate'),
 );
 
@@ -75,7 +73,6 @@ if (import.meta.env.DEV) {
   window.toggleRouting = toggleRouting;
   window.setIsRoutingEnabled = setIsRoutingEnabled;
 }
-// eslint-disable-next-line no-console
 if (!isRoutingEnabled) console.warn('Routing is disabled!');
 
 /**
@@ -116,7 +113,7 @@ export function NavItem({
   );
 }
 
-function BasicLayout(): Promise<void> | ReactElement {
+function BasicLayout(): ReactElement {
   const headerLinks = [...useHeaderAuthLinks()];
   const location = useLocation();
   const auth = useSblAuth();
@@ -140,7 +137,8 @@ function BasicLayout(): Promise<void> | ReactElement {
       errorMessage.includes("Session doesn't have required client") &&
       location.pathname !== '/'
     ) {
-      return auth.onLogout();
+      void auth.onLogout();
+      return <></>;
     }
   }
 
@@ -177,7 +175,7 @@ interface ProtectedRouteProperties {
   isAuthenticated: boolean;
   isLoading: boolean;
   onLogin: () => Promise<void>;
-  UserProfile: UserProfileType;
+  UserProfile: UserProfileType | undefined;
   children: JSX.Element;
 }
 
@@ -188,7 +186,7 @@ function ProtectedRoute({
   onLogin,
   UserProfile,
   children,
-}: ProtectedRouteProperties): JSX.Element | null {
+}: ProtectedRouteProperties): JSX.Element {
   const { pathname } = useLocation();
   const isProfileFormPath = pathname.includes('/profile/complete');
 
@@ -198,13 +196,17 @@ function ProtectedRoute({
 
   if (!isInitialAuthorizationLoading && !isAuthenticated) {
     void onLogin();
-    return null;
+    return <></>;
   }
 
   if (isAnyAuthorizationLoading) return <LoadingContent />;
 
+  if (!UserProfile) {
+    throw new Error('User Profile does not exist');
+  }
+
   const isUserAssociatedWithAnyInstitution =
-    UserProfile.institutions.length > 0;
+    (UserProfile?.institutions?.length ?? 0) > 0;
   if (!isUserAssociatedWithAnyInstitution && !isProfileFormPath)
     return <Navigate replace to='/profile/complete' />;
   if (isProfileFormPath && isUserAssociatedWithAnyInstitution)
@@ -240,19 +242,12 @@ export default function App(): ReactElement {
         <ScrollToTop />
         <Suspense fallback={<LoadingApp />}>
           <Routes>
-            <Route
-              path='/'
-              element={
-                // @ts-expect-error Part of evaluation for linter issues see: https://github.com/cfpb/sbl-frontend/issues/1039
-                <BasicLayout />
-              }
-            >
+            <Route path='/' element={<BasicLayout />}>
               <Route path='/' element={<FilingHome />} />
               {import.meta.env.DEV ? (
                 <Route
                   path='/markdown'
                   element={
-                    // @ts-expect-error Part of code cleanup for post-mvp see: https://github.com/cfpb/sbl-frontend/issues/717
                     <ProtectedRoute {...ProtectedRouteAuthorizations}>
                       <MarkdownText />
                     </ProtectedRoute>
@@ -262,7 +257,6 @@ export default function App(): ReactElement {
               <Route
                 path='/filing/:year/:lei/create'
                 element={
-                  // @ts-expect-error Part of code cleanup for post-mvp see: https://github.com/cfpb/sbl-frontend/issues/717
                   <ProtectedRoute {...ProtectedRouteAuthorizations}>
                     <InstitutionProtectedRoute>
                       <FilingCreate />
@@ -273,7 +267,6 @@ export default function App(): ReactElement {
               <Route
                 path='/filing/:year/:lei/upload'
                 element={
-                  // @ts-expect-error Part of code cleanup for post-mvp see: https://github.com/cfpb/sbl-frontend/issues/717
                   <ProtectedRoute {...ProtectedRouteAuthorizations}>
                     <InstitutionProtectedRoute>
                       <FilingProtectedRoute>
@@ -287,11 +280,10 @@ export default function App(): ReactElement {
                 '/filing/:year/:lei/errors',
                 '/filing/:year/:lei/errors/errors-syntax',
                 '/filing/:year/:lei/errors/errors-logic',
-              ].map((path, index) => (
+              ].map(path => (
                 <Route
                   path={path}
                   element={
-                    // @ts-expect-error Part of code cleanup for post-mvp see: https://github.com/cfpb/sbl-frontend/issues/717
                     <ProtectedRoute {...ProtectedRouteAuthorizations}>
                       <InstitutionProtectedRoute>
                         <FilingProtectedRoute>
@@ -300,14 +292,12 @@ export default function App(): ReactElement {
                       </InstitutionProtectedRoute>
                     </ProtectedRoute>
                   }
-                  // eslint-disable-next-line react/no-array-index-key
-                  key={index}
+                  key={`error-route${path.replaceAll(/[/:]+/gi, '-')}`}
                 />
               ))}
               <Route
                 path='/filing/:year/:lei/warnings'
                 element={
-                  // @ts-expect-error Part of code cleanup for post-mvp see: https://github.com/cfpb/sbl-frontend/issues/717
                   <ProtectedRoute {...ProtectedRouteAuthorizations}>
                     <InstitutionProtectedRoute>
                       <FilingProtectedRoute>
@@ -320,7 +310,6 @@ export default function App(): ReactElement {
               <Route
                 path='/filing/:year/:lei/details'
                 element={
-                  // @ts-expect-error Part of code cleanup for post-mvp see: https://github.com/cfpb/sbl-frontend/issues/717
                   <ProtectedRoute {...ProtectedRouteAuthorizations}>
                     <InstitutionProtectedRoute>
                       <FilingProtectedRoute>
@@ -333,7 +322,6 @@ export default function App(): ReactElement {
               <Route
                 path='/filing/:year/:lei/submit'
                 element={
-                  // @ts-expect-error Part of code cleanup for post-mvp see: https://github.com/cfpb/sbl-frontend/issues/717
                   <ProtectedRoute {...ProtectedRouteAuthorizations}>
                     <InstitutionProtectedRoute>
                       <FilingProtectedRoute>
@@ -346,7 +334,6 @@ export default function App(): ReactElement {
               <Route
                 path='/filing/:year/:lei/done'
                 element={
-                  // @ts-expect-error Part of code cleanup for post-mvp see: https://github.com/cfpb/sbl-frontend/issues/717
                   <ProtectedRoute {...ProtectedRouteAuthorizations}>
                     <InstitutionProtectedRoute>
                       <FilingProtectedRoute>
@@ -359,7 +346,6 @@ export default function App(): ReactElement {
               <Route
                 path='/filing'
                 element={
-                  // @ts-expect-error Part of code cleanup for post-mvp see: https://github.com/cfpb/sbl-frontend/issues/717
                   <ProtectedRoute {...ProtectedRouteAuthorizations}>
                     <FilingOverview />
                   </ProtectedRoute>
@@ -368,7 +354,6 @@ export default function App(): ReactElement {
               <Route
                 path='/landing'
                 element={
-                  // @ts-expect-error Part of code cleanup for post-mvp see: https://github.com/cfpb/sbl-frontend/issues/717
                   <ProtectedRoute {...ProtectedRouteAuthorizations}>
                     <AuthenticatedLanding />
                   </ProtectedRoute>
@@ -377,7 +362,6 @@ export default function App(): ReactElement {
               <Route
                 path='/institution/:lei'
                 element={
-                  // @ts-expect-error Part of code cleanup for post-mvp see: https://github.com/cfpb/sbl-frontend/issues/717
                   <ProtectedRoute {...ProtectedRouteAuthorizations}>
                     <InstitutionProtectedRoute>
                       <ViewInstitutionProfile />
@@ -388,7 +372,6 @@ export default function App(): ReactElement {
               <Route
                 path='/institution/:lei/update'
                 element={
-                  // @ts-expect-error Part of code cleanup for post-mvp see: https://github.com/cfpb/sbl-frontend/issues/717
                   <ProtectedRoute {...ProtectedRouteAuthorizations}>
                     <InstitutionProtectedRoute>
                       <UpdateFinancialProfile />
@@ -399,7 +382,6 @@ export default function App(): ReactElement {
               <Route
                 path='/profile/view'
                 element={
-                  // @ts-expect-error Part of code cleanup for post-mvp see: https://github.com/cfpb/sbl-frontend/issues/717
                   <ProtectedRoute {...ProtectedRouteAuthorizations}>
                     <ViewUserProfile />
                   </ProtectedRoute>
@@ -408,7 +390,6 @@ export default function App(): ReactElement {
               <Route
                 path='/profile/complete/no-associations'
                 element={
-                  // @ts-expect-error Part of code cleanup for post-mvp see: https://github.com/cfpb/sbl-frontend/issues/717
                   <ProtectedRoute {...ProtectedRouteAuthorizations}>
                     <main id='main'>
                       <CreateProfileFormNoAssoc />
@@ -419,7 +400,6 @@ export default function App(): ReactElement {
               <Route
                 path='/profile/complete/with-associations'
                 element={
-                  // @ts-expect-error Part of code cleanup for post-mvp see: https://github.com/cfpb/sbl-frontend/issues/717
                   <ProtectedRoute {...ProtectedRouteAuthorizations}>
                     <main id='main'>
                       <CreateProfileFormWAssoc />
@@ -430,7 +410,6 @@ export default function App(): ReactElement {
               <Route
                 path='/profile/complete'
                 element={
-                  // @ts-expect-error Part of code cleanup for post-mvp see: https://github.com/cfpb/sbl-frontend/issues/717
                   <ProtectedRoute {...ProtectedRouteAuthorizations}>
                     <ProfileForm />
                   </ProtectedRoute>
@@ -439,7 +418,6 @@ export default function App(): ReactElement {
               <Route
                 path='/update-financial-profile'
                 element={
-                  // @ts-expect-error Part of code cleanup for post-mvp see: https://github.com/cfpb/sbl-frontend/issues/717
                   <ProtectedRoute {...ProtectedRouteAuthorizations}>
                     <UpdateFinancialProfile />
                   </ProtectedRoute>
@@ -448,7 +426,6 @@ export default function App(): ReactElement {
               <Route
                 path='/institution/:lei/type'
                 element={
-                  // @ts-expect-error Part of code cleanup for post-mvp see: https://github.com/cfpb/sbl-frontend/issues/717
                   <ProtectedRoute {...ProtectedRouteAuthorizations}>
                     <InstitutionProtectedRoute>
                       <TypesFinancialInstitutions />
@@ -459,7 +436,6 @@ export default function App(): ReactElement {
               <Route
                 path='/institution/:lei/type/:year'
                 element={
-                  // @ts-expect-error Part of code cleanup for post-mvp see: https://github.com/cfpb/sbl-frontend/issues/717
                   <ProtectedRoute {...ProtectedRouteAuthorizations}>
                     <InstitutionProtectedRoute>
                       <TypesFinancialInstitutions />

diff --git a/src/api/requests/downloadValidationReport.ts b/src/api/requests/downloadValidationReport.ts
@@ -59,9 +59,7 @@ export const downloadValidationReport = async ({
       URL.revokeObjectURL(url);
     });
   } catch (error) {
-    // Part of code cleanup for post-mvp see: https://github.com/cfpb/sbl-frontend/issues/717
-    // eslint-disable-next-line no-console
-    console.log(error);
+    console.error(error);
   } finally {
     if (afterDownloadCallback) afterDownloadCallback();
   }

diff --git a/src/components/Link.utils.tsx b/src/components/Link.utils.tsx
@@ -40,7 +40,7 @@ export function IconExternalLink(): ReactElement {
   return (
     <>
       {' '}
-      {/* @ts-expect-error Part of evaluation for linter issues see: https://github.com/cfpb/sbl-frontend/issues/1039 */}
+      {/* @ts-expect-error Part of code cleanup for post-mvp see: https://github.com/cfpb/sbl-frontend/issues/717 */}
       <Icon name='external-link' className='link-icon-override-color' />
     </>
   );
-Original file line number
+Diff line change
@@ Expand Up / @@ -27,7 +27,7 @@ export default async function deleteKeycloakUser({ @@
       try {
         await kcAdminClient.users.del({
-          id: id,
+          id,
         });
       } catch (error) {
         // eslint-disable-next-line no-console
@@ Expand Down @@