Merge pull request #494 from shapehq/include-file-content-in-error-message

Include debug info when failing to load remote spec

Author: ulrikandersen

src/app/api/remotes/[encodedRemoteConfig]/route.ts

@@ -55,7 +55,7 @@ export async function GET(_req: NextRequest, { params }: { params: Promise<Remot
     } else if (error.name === ErrorName.TIMEOUT) {
       return makeAPIErrorResponse(408, "The operation timed out.")
     } else if (error.name === ErrorName.NOT_JSON_OR_YAML) {
-      return makeAPIErrorResponse(400, "Url does not point to a JSON or YAML file.")
+      return makeAPIErrorResponse(400, error.message)
     } else if (error.name === ErrorName.URL_MAY_NOT_INCLUDE_BASIC_AITH) {
       return makeAPIErrorResponse(400, "Url may not include basic auth.")
     } else {

src/common/utils/fileUtils.ts

@@ -66,7 +66,7 @@ export function checkIfJsonOrYaml(fileText: string) {
     try {
         parseYaml(fileText) // will also parse JSON as it is a subset of YAML
     } catch {
-        const error = new Error("File is not JSON or YAML")
+        const error = new Error("File is not JSON or YAML. Content: " + fileText.slice(0, 1000));
         error.name = ErrorName.NOT_JSON_OR_YAML
         throw error
     }

src/features/projects/data/GitHubProjectDataSource.ts

@@ -242,7 +242,7 @@ export default class GitHubProjectDataSource implements IProjectDataSource {
         password: this.encryptionService.decrypt(projectConfigRemoteSpec.auth.encryptedPassword)
       }
     } catch (error) {
-      console.error(`Failed to decrypt remote specification auth for ${projectConfigRemoteSpec.url}. Perhaps a different public key was used?:`, error);
+      console.info(`Failed to decrypt remote specification auth for ${projectConfigRemoteSpec.name} (${projectConfigRemoteSpec.url}). Perhaps a different public key was used?:`, error);
       return undefined
     }
   }