fix: Return whole lines when looking up source code

[dividedmind]

This pull request includes several changes to improve the handling and testing of source code snippets in the buildContext and lookupSourceCode functions. The most important changes include modifying the lookupSourceCode function to return an object with content and location, updating the buildContext function to accommodate this change, and adding new unit tests for lookupSourceCode.

Improvements to lookupSourceCode function:

• packages/cli/src/rpc/explain/lookupSourceCode.ts: Modified lookupSourceCode to return an object with content and location instead of an array of strings. This change ensures that the returned snippet includes both the content and its precise location. [1] [2] [3]
• Make sure to read and return whole lines when looking up the source code. The location returned corresponds to real file location and the computed line extent.

Updates to buildContext function:

• packages/cli/src/rpc/explain/buildContext.ts: Updated buildContext to handle the new object returned by lookupSourceCode, ensuring that the codeSnippets array contains the correct content and location fields.

Unit tests:

• packages/cli/tests/unit/rpc/explain/buildContext.spec.ts: Updated existing tests to match the new return type of lookupSourceCode, ensuring that the location field includes line numbers. [1] [2]
• packages/cli/tests/unit/rpc/explain/lookupSourceCode.spec.ts: Added new unit tests for lookupSourceCode to verify that it returns the correct snippet object and handles non-existent lines appropriately.

[kgilpin]

It looks like a good change. My only comment is that since the PR description states that it's ensuring that complete lines are returned, it would be great to see a test case in which the line would have been split in the previous implementation, but is now handled correctly.

[dividedmind]

It looks like a good change. My only comment is that since the PR description states that it's ensuring that complete lines are returned, it would be great to see a test case in which the line would have been split in the previous implementation, but is now handled correctly.

Good point! It must have slipped my mind because there were no tests for the previous implementation.

[appland-release]

🎉 This PR is included in version @appland/appmap-v3.181.1 🎉

The release is available on:

• @appland/appmap-v3.181.1
• GitHub release
• @appland/appmap-v3.181.1

Your semantic-release bot 📦🚀