getappmap / getappmap/appmap-node

Try to match both original and compiled path when determining instrumentation eligibility

Open
#182 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
TypeScript
Stars
13
Forks
6
Avg merge
18h 23m
Merged PRs (30d)
8

Description

Currently, in the presence of source maps, only the original source path (with some exceptions) is matched with the package paths configured in appmap.yml.

This can be too restrictive; if trying to trace third-party code, for example, the user usually doesn't care about the original source directory structure but wants to be able to specify the compiled code path in appmap.yml and have it instrumented (even when there is a problem with handling the sourcemap or the map itself, cf. #181).

My intuition is trying to match BOTH the original and transpiled paths and instrumenting if either does match would be more robust and less surprising.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start in src/transform.ts at the source-map handling and path-matching exception linked in the issue, then review the related context in #181. Check how package paths from appmap.yml are compared with original and compiled paths. Done means instrumentation is eligible when either path matches, including when source-map handling is problematic.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
devtools
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
48/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.