Avoid non-autofixable ESLint errors in code generated around dbAuth (#…

…6061) * Exclude unused variable `userAttributes` from ESLint checks * Add all dependencies to dependency array of effect hook which validates the token * Fix typescript strict mode warning (implicit type any) on reset password page Adds to / completes #5491 * Update test fixture * Ensure all eslint `no-used-vars` ignores are compatible with JS Adds to / completes 3fe7dca * Update test snapshots * Update test fixture --------- Co-authored-by: Tobbe Lundberg <[email protected]> Co-authored-by: David Price <[email protected]>
redwoodjs · Apr 27, 2023 · a970fae · a970fae
1 parent 8ac2c1a
commit a970fae
Show file tree

Hide file tree

Showing 12 changed files with 29 additions and 27 deletions.
diff --git a/__fixtures__/test-project/web/src/pages/ResetPasswordPage/ResetPasswordPage.tsx b/__fixtures__/test-project/web/src/pages/ResetPasswordPage/ResetPasswordPage.tsx
@@ -35,7 +35,7 @@ const ResetPasswordPage = ({ resetToken }: { resetToken: string }) => {
       }
     }
     validateToken()
-  }, [])
+  }, [resetToken, validateResetToken])
 
   const passwordRef = useRef<HTMLInputElement>(null)
   useEffect(() => {

diff --git a/packages/auth-providers/firebase/setup/src/templates/api/lib/auth.ts.template b/packages/auth-providers/firebase/setup/src/templates/api/lib/auth.ts.template
@@ -2,7 +2,7 @@ import admin from 'firebase-admin'
 
 import { AuthenticationError } from '@redwoodjs/graphql-server'
 
-// eslint-disable-next-line @typescript-eslint/no-unused-vars
+// eslint-disable-next-line no-unused-vars, @typescript-eslint/no-unused-vars
 const adminApp = admin.initializeApp({
   projectId: process.env.FIREBASE_PROJECT_ID,
 })
@@ -25,9 +25,9 @@ const adminApp = admin.initializeApp({
  */
 export const getCurrentUser = async (
   decoded,
-  /* eslint-disable-next-line @typescript-eslint/no-unused-vars */
+  /* eslint-disable-next-line no-unused-vars, @typescript-eslint/no-unused-vars */
   { token, type },
-  /* eslint-disable-next-line @typescript-eslint/no-unused-vars */
+  /* eslint-disable-next-line no-unused-vars, @typescript-eslint/no-unused-vars */
   { event, context }
 ) => {
   return decoded

diff --git a/packages/auth-providers/supabase/setup/src/templates/api/lib/auth.ts.template b/packages/auth-providers/supabase/setup/src/templates/api/lib/auth.ts.template
@@ -29,9 +29,9 @@ type RedwoodUser = Record<string, unknown> & { roles?: string[] }
  */
 export const getCurrentUser = async (
   decoded,
-  /* eslint-disable-next-line @typescript-eslint/no-unused-vars */
+  /* eslint-disable-next-line no-unused-vars, @typescript-eslint/no-unused-vars */
   { token, type },
-  /* eslint-disable-next-line @typescript-eslint/no-unused-vars */
+  /* eslint-disable-next-line no-unused-vars, @typescript-eslint/no-unused-vars */
   { event, context }
 ): Promise<RedwoodUser> => {
   if (!decoded) {

diff --git a/packages/auth-providers/supertokens/setup/src/templates/api/lib/auth.ts.template b/packages/auth-providers/supertokens/setup/src/templates/api/lib/auth.ts.template
@@ -29,9 +29,9 @@ type RedwoodUser = Record<string, unknown> & { roles?: string[] }
  */
 export const getCurrentUser = async (
   decoded,
-  /* eslint-disable-next-line @typescript-eslint/no-unused-vars */
+  /* eslint-disable-next-line no-unused-vars, @typescript-eslint/no-unused-vars */
   { token, type },
-  /* eslint-disable-next-line @typescript-eslint/no-unused-vars */
+  /* eslint-disable-next-line no-unused-vars, @typescript-eslint/no-unused-vars */
   { event, context }
 ): Promise<RedwoodUser> => {
   if (!decoded) {

diff --git a/...-helpers/src/auth/__tests__/fixtures/dbAuthSetup/templates/api/functions/auth.ts.template b/...-helpers/src/auth/__tests__/fixtures/dbAuthSetup/templates/api/functions/auth.ts.template
@@ -107,6 +107,8 @@ export const handler = async (
     //
     // If this returns anything else, it will be returned by the
     // `signUp()` function in the form of: `{ message: 'String here' }`.
+
+    // eslint-disable-next-line no-unused-vars, @typescript-eslint/no-unused-vars
     handler: ({ username, hashedPassword, salt, userAttributes }) => {
       return db.user.create({
         data: {

diff --git a/...i-helpers/src/auth/__tests__/fixtures/supertokensSetup/templates/api/lib/auth.ts.template b/...i-helpers/src/auth/__tests__/fixtures/supertokensSetup/templates/api/lib/auth.ts.template
@@ -29,9 +29,9 @@ type RedwoodUser = Record<string, unknown> & { roles?: string[] }
  */
 export const getCurrentUser = async (
   decoded,
-  /* eslint-disable-next-line @typescript-eslint/no-unused-vars */
+  /* eslint-disable-next-line no-unused-vars, @typescript-eslint/no-unused-vars */
   { token, type },
-  /* eslint-disable-next-line @typescript-eslint/no-unused-vars */
+  /* eslint-disable-next-line no-unused-vars, @typescript-eslint/no-unused-vars */
   { event, context }
 ): Promise<RedwoodUser> => {
   if (!decoded) {

diff --git a/packages/cli/src/commands/generate/dbAuth/__tests__/__snapshots__/dbAuth.test.js.snap b/packages/cli/src/commands/generate/dbAuth/__tests__/__snapshots__/dbAuth.test.js.snap
@@ -278,7 +278,7 @@ const ResetPasswordPage = ({ resetToken }) => {
       }
     }
     validateToken()
-  }, [])
+  }, [resetToken, validateResetToken])
 
   const secretRef = useRef(null)
   useEffect(() => {
@@ -766,7 +766,7 @@ const ResetPasswordPage = ({ resetToken }) => {
       }
     }
     validateToken()
-  }, [])
+  }, [resetToken, validateResetToken])
 
   const secretRef = useRef(null)
   useEffect(() => {
@@ -1254,7 +1254,7 @@ const ResetPasswordPage = ({ resetToken }) => {
       }
     }
     validateToken()
-  }, [])
+  }, [resetToken, validateResetToken])
 
   const secretRef = useRef(null)
   useEffect(() => {
@@ -1742,7 +1742,7 @@ const ResetPasswordPage = ({ resetToken }) => {
       }
     }
     validateToken()
-  }, [])
+  }, [resetToken, validateResetToken])
 
   const secretRef = useRef(null)
   useEffect(() => {
@@ -2362,7 +2362,7 @@ const ResetPasswordPage = ({ resetToken }) => {
       }
     }
     validateToken()
-  }, [])
+  }, [resetToken, validateResetToken])
 
   const secretRef = useRef(null)
   useEffect(() => {
@@ -2850,7 +2850,7 @@ const ResetPasswordPage = ({ resetToken }) => {
       }
     }
     validateToken()
-  }, [])
+  }, [resetToken, validateResetToken])
 
   const secretRef = useRef(null)
   useEffect(() => {
@@ -3343,7 +3343,7 @@ const ResetPasswordPage = ({ resetToken }) => {
       }
     }
     validateToken()
-  }, [])
+  }, [resetToken, validateResetToken])
 
   const passwordRef = useRef(null)
   useEffect(() => {
@@ -3838,7 +3838,7 @@ const ResetPasswordPage = ({ resetToken }) => {
       }
     }
     validateToken()
-  }, [])
+  }, [resetToken, validateResetToken])
 
   const passwordRef = useRef(null)
   useEffect(() => {
@@ -4333,7 +4333,7 @@ const ResetPasswordPage = ({ resetToken }) => {
       }
     }
     validateToken()
-  }, [])
+  }, [resetToken, validateResetToken])
 
   const passwordRef = useRef(null)
   useEffect(() => {

diff --git a/packages/cli/src/commands/generate/dbAuth/templates/resetPassword.tsx.template b/packages/cli/src/commands/generate/dbAuth/templates/resetPassword.tsx.template
@@ -35,7 +35,7 @@ const ResetPasswordPage = ({ resetToken }: { resetToken: string }) => {
       }
     }
     validateToken()
-  }, [])
+  }, [resetToken, validateResetToken])
 
   const ${passwordCamelCase}Ref = useRef<HTMLInputElement>(null)
   useEffect(() => {

diff --git a/.../codemods/src/codemods/v4.2.x/updateClerkGetCurrentUser/__testfixtures__/default.input.js b/.../codemods/src/codemods/v4.2.x/updateClerkGetCurrentUser/__testfixtures__/default.input.js
@@ -17,9 +17,9 @@ import { logger } from 'src/lib/logger'
  */
 export const getCurrentUser = async (
   decoded,
-  /* eslint-disable-next-line @typescript-eslint/no-unused-vars */
+  /* eslint-disable-next-line no-unused-vars, @typescript-eslint/no-unused-vars */
   { token, type },
-  /* eslint-disable-next-line @typescript-eslint/no-unused-vars */
+  /* eslint-disable-next-line no-unused-vars, @typescript-eslint/no-unused-vars */
   { event, context }
 ) => {
   if (!decoded) {

diff --git a/...codemods/src/codemods/v4.2.x/updateClerkGetCurrentUser/__testfixtures__/default.output.js b/...codemods/src/codemods/v4.2.x/updateClerkGetCurrentUser/__testfixtures__/default.output.js
@@ -17,9 +17,9 @@ import { logger } from 'src/lib/logger'
  */
 export const getCurrentUser = async (
   decoded,
-  /* eslint-disable-next-line @typescript-eslint/no-unused-vars */
+  /* eslint-disable-next-line no-unused-vars, @typescript-eslint/no-unused-vars */
   { token, type },
-  /* eslint-disable-next-line @typescript-eslint/no-unused-vars */
+  /* eslint-disable-next-line no-unused-vars, @typescript-eslint/no-unused-vars */
   { event, context }
 ) => {
   if (!decoded) {

diff --git a/packages/graphql-server/src/functions/__tests__/fixtures/auth.ts b/packages/graphql-server/src/functions/__tests__/fixtures/auth.ts
@@ -34,9 +34,9 @@ type RedwoodUser = Record<string, unknown> & { roles?: string[] }
  */
 export const getCurrentUser = async (
   decoded,
-  /* eslint-disable-next-line @typescript-eslint/no-unused-vars */
+  /* eslint-disable-next-line no-unused-vars, @typescript-eslint/no-unused-vars */
   { token, type },
-  /* eslint-disable-next-line @typescript-eslint/no-unused-vars */
+  /* eslint-disable-next-line no-unused-vars, @typescript-eslint/no-unused-vars */
   req?: { event: APIGatewayEvent, context: Context }
 ): Promise<RedwoodUser | null> => {
   if (!decoded) {

diff --git a/packages/web/src/global.web-auto-imports.ts b/packages/web/src/global.web-auto-imports.ts
@@ -24,7 +24,7 @@ declare global {
 
   type GraphQLOperationVariables = Record<string, any>
 
-  /* eslint-disable @typescript-eslint/no-unused-vars */
+  /* eslint-disable no-unused-vars, @typescript-eslint/no-unused-vars */
   // Overridable graphQL hook return types
   interface QueryOperationResult<
     TData = any,