Edit

Source Code

Introduction

Each Debug Session contains the source code you wish to debug. Rookout allows you to easily load sources from your local file system or your git provider. When you integrate your source code into Rookout, it remains between your code repository and your local browser.

Rookout never sees nor has access to your source code. In fact, your code never reaches the Rookout servers.

Source Code Fetching

Git Providers

Rookout integrates directly to the cloud editions of the following Git Providers:

  1. Github
  2. BitBucket
  3. GitLab
  4. Azure DevOps

In addition, Rookout offers a desktop app for fetching source repositories from a local file system. This allows fetching source code from local editions of Git providers, as well as from Perforce.

Automatic Fetching

Rookout can connect to a repository and automatically fetch the source code for the selected instance.

To automatically fetch source code repositories from cloud-based Github, Bitbucket, or Gitlab, use the following environment variables while deploying rookout:

  1. ROOKOUT_COMMIT - String that indicates your git commit
  2. ROOKOUT_REMOTE_ORIGIN - String that indicates your git remote origin

Adding these variables means that the sources are loaded automatically every time this instance is selected.

As an example, the environment variables could be set as follows:

export ROOKOUT_REMOTE_ORIGIN=https://github.com/Rookout/tutorial-python
export ROOKOUT_COMMIT=3793853884cae77cc082961aa64cdb0ab93a0e35

Note that we are setting the commit to a specific revision or branch name that should match the revision of your code deployed in the environment you are debugging. Organizations often automate setting these parameters using their CI/CD process upon each deployment.

When these environment variables are set, in the Application Instances screen, you should see the Source origin and Revision fields set with the values you set:

  • Not sure what's your repository's remote origin? Just run the following command locally where you've cloned your repository: git config --get remote.origin.url

Now, when you choose to debug an application instance where these environments variables are set, Rookout attempts to fetch the source code so that you are immediately ready to start debugging. You should see the text "auto loaded" in parenthesis next to your repository when this happens successfully:

For teams that have BitBucket self-hosted / on-prem repositories, it is required to have the Rookout Desktop Application installed first. You must also have git or perforce command line tools installed on your machine.

To install the Rookout Desktop App, click on the + button in the debugger view, choose Local Filesystem, and then follow the steps to download and install the Rookout Desktop App.

Fo the on-prem git workflow, you can fine more details in this video:

Local FileSystem - Rookout Desktop App

If you are using a local git provider or any hosted git provider that is not listed, you can tell Rookout to fetch the source code files from your local filesystem.

To do that, please download and install Rookout Desktop App. See the following video to learn how:

Packaging Sources

Java

To make sure you are collecting data from the source line where you have set the breakpoint, please include your source files within your JAR/WAR/EAR library.

For more information, see this page.

JavaScript/TypeScript

If you are transpiling your JavaScript/TypeScript on the fly (using babel-node or a similar tool), Rookout will work out of the box.

If you are transpiling your JavaScript/TypeScript before execution (for instance in your CI/CD), you must include the source maps inline within the source files or as separate files (usually app.map.js) in your deployment.

For more information, see this page.

.Net

To make sure you are collecting data from the source line where you have set the breakpoint, include your source files within your library.

For more information, see this page.

← Instances SelectionLabels →