Repository X-Ray

Repository X-Ray automatically enriches:

• Code generation requests for GitLab Duo Code Suggestions by providing additional context about a project’s dependencies to improve the accuracy and relevance of code recommendations.
• Requests to refactor code, fix code, and write tests.

To do this, Repository X-Ray gives the code assistant more insight into the project’s codebase and dependencies by:

• Searching for dependency manager configuration files (for example, Gemfile.lock, package.json, go.mod).
• Extracting a list of libraries from their content.
• Providing the extracted list as additional context to be used by GitLab Duo Code Suggestions in code generation, refactor code, fix code, and write test requests.

By understanding the libraries and other dependencies in use, Repository X-Ray helps the code assistant tailor suggestions to match the coding patterns, styles, and technologies used in the project. This results in code suggestions that integrate more seamlessly and follow best practices for the given stack.

How Repository X-Ray works

When you push a new commit to your project’s default branch, Repository X-Ray triggers a background job. This job scans and parses the applicable configuration files in your repository.

Typically, only one scanning job runs at a time in each project. If a second scan is triggered while a scan is already in progress, that second scan waits until the first scan is complete before executing. This could result in a small delay before the latest configuration file data is parsed and updated in the database.

When a code generation request is made, a maximum of 300 libraries from the parsed data is included in the prompt as additional context.

Enable Repository X-Ray

The Repository X-Ray service is automatically enabled if your project has access to GitLab Duo Code Suggestions.

Supported languages and dependency managers

The Repository X-Ray searches a maximum of two directory levels from the repository’s root. For example, it supports Gemfile.lock, api/Gemfile.lock, or api/client/Gemfile.lock, but not api/v1/client/Gemfile.lock. For each language, only the first matching dependency manager is processed. Where available, lock files take precedence over their non-lock file counterparts.

Footnotes:

1. For Python Pip, all configuration files matching the *requirements*.txt glob pattern are processed.

Enable Repository X-Ray in your CI pipeline (deprecated)

Prerequisites:

• You must have access to GitLab Duo Code Suggestions in the project.
• GitLab Runner must be set up and enabled for the project, because Repository X-Ray runs analysis pipelines using GitLab runners.

To enable Repository X-Ray, add the following definition job to the project’s .gitlab-ci.yml.

xray:
  stage: build
  image: registry.gitlab.com/gitlab-org/code-creation/repository-x-ray:latest
  allow_failure: true
  rules:
    - if: $CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH
  variables:
    OUTPUT_DIR: reports
  script:
    - x-ray-scan -p "$CI_PROJECT_DIR" -o "$OUTPUT_DIR"
  artifacts:
    reports:
      repository_xray: "$OUTPUT_DIR/*/*.json"

• The $OUTPUT_DIR environment variable defines the:
  • Output directory for reports.
  • Path that artifacts are uploaded from.
• The added rules restrict the job to the default branch only. Restricting the job this way ensures development changes do not impact the baseline X-Ray data used for production Code Suggestions.

After the initial x-ray job completes and uploads the repository analysis reports, no further action is required. Repository X-Ray automatically enriches all code generation requests from that point forward.

The X-Ray data for your project updates each time a CI/CD pipeline containing the xray job is run. To learn more about pipeline configuration and triggers, see the pipelines documentation.

Supported languages and package managers

Troubleshooting

401: Unauthorized when running Repository X-Ray

When running Repository X-Ray, you might get an error that states 401: Unauthorized.

A Duo Pro add-on is linked to a group when you buy that add-on. To solve the error, ensure that your current project is part of a group with the Duo Pro add-on.

This link can be either of the following:

• Direct, that is, the project is in a group that has the Duo Pro add-on.
• Indirect, for example, the parent group of the current project’s group has the Duo Pro add-on.