Merge pull request #190 from codacy/setup-edge-case

chore: Add logs and error handling CF-2239

Author: nedaKaighobadi

.codacy/codacy.yaml

@@ -6,5 +6,5 @@ tools:
     - eslint@9.38.0
     - lizard@1.17.31
     - pmd@6.55.0
-    - semgrep@1.78.0
-    - trivy@0.66.0
+    - semgrep@1.16.1
+    - trivy@0.69.2

media/scripts/setupScript.js

@@ -32,6 +32,7 @@
   let userInfo = null
   let organizationInfo = null
   let repositoryInfo = null
+  let orgError = null
   /**
    * Escapes HTML special characters to prevent XSS attacks.
    * @param {string | undefined | null} str - The string to escape
@@ -50,7 +51,7 @@
   /**
    * Safely sets cloud description with highlighted text using DOM methods.
    * @param {HTMLElement} element - The element to update
-   * @param {{type: 'organization' | 'repository' | 'user', params: {organization?: string, provider?: string, repository?: string, user?: string}}} context - The context to use
+   * @param {{type: 'organization' | 'repository' | 'user' | 'organizationNotFound', params: {organization?: string, provider?: string, repository?: string, user?: string}}} context - The context to use
    */
   function setCloudDescription(element, { type, params }) {
     element.textContent = ''
@@ -61,6 +62,11 @@
             <p class="loading-text">Connecting to Codacy...</p>
           </div>`
     switch (type) {
+      case 'organizationNotFound':
+        textNode.textContent = 'The organization you\'re trying to connect to is not found in Codacy. '
+        linkNode.textContent = `Check your available organizations`
+        linkNode.href = `https://app.codacy.com/organizations`
+        break
       case 'organization':
         if (!params.provider || !params.organization) {
           element.innerHTML = loadingHtml
@@ -134,7 +140,8 @@
         userInfo = message.userInfo
         organizationInfo = message.organizationInfo
         repositoryInfo = message.repositoryInfo
-        handleLoginStateChange(isLoggedIn, isOrgInCodacy, isRepoInCodacy, userInfo, organizationInfo, repositoryInfo)
+        orgError = message.orgError
+        handleLoginStateChange(isLoggedIn, isOrgInCodacy, isRepoInCodacy, userInfo, organizationInfo, repositoryInfo, orgError)
         break
       case 'mcpStatusChanged':
         isMCPInstalled = message.isMCPInstalled
@@ -236,6 +243,14 @@
     } = elements
     const { organizationName, organizationProvider, repositoryName, userName, billing } = connectionInfo
     switch (state) {
+      case 'organizationNotFound':
+        cloudIcon.src = iconUris.warning
+        addOrgButton.style.display = 'none'
+        addRepoButton.style.display = 'none'
+        noOrgDescription.style.display = 'none'
+        upgradeBox.style.display = 'none'
+        setCloudDescription(cloudDescription, { type: 'organizationNotFound', params: { } })
+        break
       case 'needsToAddOrganization':
         addOrgButton.style.display = 'inline-block'
         noOrgDescription.style.display = 'inline-block'
@@ -293,8 +308,9 @@
    * @param {Object|null} userInfo
    * @param {Object|null} organizationInfo
    * @param {Object|null} repositoryInfo
+   * @param {string|null} orgError
    */
-  function handleLoginStateChange(loggedIn, isOrgInCodacy, isRepoInCodacy, userInfo, organizationInfo, repositoryInfo) {
+  function handleLoginStateChange(loggedIn, isOrgInCodacy, isRepoInCodacy, userInfo, organizationInfo, repositoryInfo, orgError) {
     const upgradeBox = document.getElementById('upgrade-box')
     const upgradeButton = document.getElementById('upgrade-button')
     /** @type {HTMLImageElement | null} */
@@ -335,6 +351,9 @@
       } else {
         handleLoginOrgStates(elements, connectionInfo, 'needsToAddOrganization')
       }
+      if (orgError) {
+        handleLoginOrgStates(elements, connectionInfo, 'organizationNotFound')
+      }
     } else {
       showLoggedOutState(elements)
     }

package.json

@@ -194,6 +194,11 @@
         "contents": "We failed to connect this repository to Codacy. Please restart the IDE and try again.",
         "when": "Codacy:CodacyCloudStateContext == NoRepository"
       },
+      {
+        "view": "codacy:cloud-status",
+        "contents": "The organization you're trying to connect to is not found in Codacy. Please check the organization name and try again.",
+        "when": "Codacy:CodacyCloudStateContext == OrganizationNotFound"
+      },
       {
         "view": "codacy:cloud-status",
         "contents": "You are not part of this organization in Codacy.\n[Join organization](command:codacy.joinOrganization)",

src/common/utils.ts

@@ -16,7 +16,8 @@ export class CodacyError extends Error {
   }
 }
 
-export const handleError = (e: Error, showPopup: boolean = true): void => {
+export const handleError = (e: Error, showPopup: boolean = true, contextMessage?: string): void => {
+  const message = contextMessage ? `${contextMessage} - ` : ''
   const showErrorMessage = async (message: string) => {
     if (!showPopup) return
     const choice = await vscode.window.showErrorMessage(message, 'Show Logs')
@@ -31,21 +32,21 @@ export const handleError = (e: Error, showPopup: boolean = true): void => {
     if (err.body && err.body.message && err.body.actions) {
       const apiError = err.body as ApiError
       Logger.error(
-        `${err.statusText} - ${apiError.message} ${apiError.innerMessage ? `(${apiError.innerMessage})` : ''}`
+        `${message} ${err.statusText} - ${apiError.message} ${apiError.innerMessage ? `(${apiError.innerMessage})` : ''}`
       )
       showErrorMessage(apiError.message).catch(console.error)
     } else {
-      Logger.error(`${err.statusText} - ${err.message}`)
+      Logger.error(`${message} ${err.statusText} - ${err.message}`)
       showErrorMessage(err.message).catch(console.error)
     }
   } else if (e instanceof CodacyError) {
     const err = e as CodacyError
-    Logger.error(`${err.name} - ${err.message}`)
+    Logger.error(`${message} ${err.name} - ${err.message}`)
     if (err.innerException) Logger.debug(`Inner Exception: ${err.innerException.message}`, err.component)
     showErrorMessage(err.message).catch(console.error)
   } else {
     const err = e as Error
-    Logger.error(err.message)
+    Logger.error(`${message} ${err.message}`)
   }
 }