Prompt Security's extension integration #784

guy-ps · 2024-03-07T14:06:25Z

By submitting a PR to this repository, you agree to the terms within the Checkmarx Code of Conduct. Please see the contributing guidelines for how to create and submit a high-quality PR for this repo.

Description

In this PR, I added the functionality that will allow this vscode extension and Prompt Security's functionally in the browser extension communicate.

The process:

The vscode extension creates a local express server that awaits API calls from the browser extension
Listens to text selection events and saves the last 25
The browser extension calls the local server if code is sent as part of the prompt
If the code matches a selected section the vscode extension returns the code and the file
The browser extension shows a pop up message

Things left to do:

Create a checkbox to activate Prompt Security's part of the extension
Consume the local server's port number dynamically

References

Include supporting link to GitHub Issue/PR number

Testing

The Prompt security vscode extension was tested in house

I've been having issues with the as-cli-javascript-wrapper package, so I wasn't able to test it post integration.

Checklist

I have added documentation for new/changed functionality in this PR (if applicable).
[?] All active GitHub checks for tests, formatting, and security are passing
The correct base branch is being used

Because it threw an error for the"any type in lastSelectedCodeSections declaration, I made an interface

One class for now, maybe we'll split it

Followup on Lior's comments

src/extension.ts

Added a private registerPromptListener method that takes in the port number as input, and builds the local server

Relocated most of the functionality into the class, and left the registerPromptListener alongside the constructor and the deactivation in the extension.ts

src/utils/listener/promptSecurity.ts

OrShamirCM

Can you add unit test please?

Co-authored-by: Or Shamir Checkmarx <[email protected]>

Added try/catch for the registerPromptListener function Added checks for null in lines 53 and 83 Refactored the code to have some functions fit unit testing architecture , and wrote some unit tests

src/utils/listener/promptSecurity.ts

Added try/catch to every method

guy-ps added 5 commits March 6, 2024 18:18

prompt listener

263a360

SelectionBuffer

af598da

Because it threw an error for the"any type in lastSelectedCodeSections declaration, I made an interface

PromptListener

dd54d52

One class for now, maybe we'll split it

minor changes

f885c2c

Followup on Lior's comments

comments

db404d8

pedrompflopes requested review from a team, sshay77 and helderfvieira and removed request for a team March 7, 2024 14:06

OrShamirCM reviewed Mar 7, 2024

View reviewed changes

src/extension.ts Outdated Show resolved Hide resolved

tiagobcx self-requested a review March 7, 2024 15:32

guy-ps added 6 commits March 7, 2024 18:12

registerPromptListener

550df05

Added a private registerPromptListener method that takes in the port number as input, and builds the local server

Refactor promptListener

93386f6

Relocated most of the functionality into the class, and left the registerPromptListener alongside the constructor and the deactivation in the extension.ts

register context

2354948

cleaning up

7d18ed2

cleaning up

a4c7a9f

adding express to package.json

cb25df2

guy-ps requested a review from OrShamirCM March 12, 2024 17:40

Merge branch 'main' into main

1beb4d9