Skip to content
This repository was archived by the owner on Apr 3, 2024. It is now read-only.
This repository was archived by the owner on Apr 3, 2024. It is now read-only.

Error message is confusing when the breakpoint path matches multiple files #961

@Louis-Ye

Description

@Louis-Ye

Background

This issue is discovered upon the investigation for issue #932 . Basically, the cloud debugger agent uses a fuzzy search when determining which file should a user-provided breakpoint be set on. The user will see the error message "Could not determine the output file associated with the transpiled input file" when setting a breakpoint that can potentially match to multiple files. This error message is confusing as it does not lead to a way for the user to solve the problem.

Environment details

  • OS: Debian 5.10.26
  • Node.js version: v12.21.0
  • npm version: 7.5.2
  • @google-cloud/debug-agent version: 5.2.0

Steps to reproduce

  1. Deploy a cloud-debugger-enabled application with multiple files having the same name but in different directories.
  2. In the GCP debugger console, upload one of the above directory as the "local source", and set a breakpoint in that same-name file.

Proposal to solutions

A better error message would be to show the user all the matched candidate files so that the user can make another set-breakpoint request with a more specific path.

We should either:

  • show the matched candidate files in the error message directly,
  • or show matched candidates in the agent logs and prompt the user to search for the logs in the error message.

Metadata

Metadata

Assignees

No one assigned

    Labels

    api: clouddebuggerIssues related to the googleapis/cloud-debug-nodejs API.priority: p2Moderately-important priority. Fix may not be included in next release.type: bugError or flaw in code with unintended results or allowing sub-optimal usage patterns.

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions