Skip to content

Latest commit

 

History

History
319 lines (233 loc) · 14 KB

ENDPOINTS.md

File metadata and controls

319 lines (233 loc) · 14 KB

R*bert

Endpoints

Clone

POST /clone

Clones source from a Git repository to your local desktop.

Minimum required inputs:

  • uri - a remote Git repository, must be accessible via https protocol

Optional inputs are:

  • username - your Git repository provider account username
  • password - your Git repository provider account password
    • if you have a Github account, then this value should be set to a classic personal access token with full repo permissions.

Note: if you're working with a private repository you will be required to supply username and password values, as clone operation will be authenticated

Ingest

This endpoint is only available when spring.profiles.active includes advanced mode. When in advanced mode, you must ingest a repository before initiating a refactor request.

POST /ingest

Clones then ingests all files from a Git repository. Contents of each file along with appropriate metadata are stored in a Vector database.

Minimum required inputs:

  • uri - a remote Git repository, must be accessible via https protocol

Optional inputs are:

  • username - your Git repository provider account username
  • password - your Git repository provider account password
    • if you have a Github account, then this value should be set to a classic personal access token with full repo permissions.
  • commit - a commit hash, if not supplied the latest commit on origin/main is used
  • allowedExtensions - a set of allowed file extensions used for file path filtering purposes; when specified, only filePaths containing a file extension in the set of extensions will be considered

Note: if you're working with a private repository you will be required to supply username and password values, as clone operation will be authenticated

Search

This endpoint is only available when spring.profiles.active includes advanced mode. When in advanced mode, you must ingest a repository before initiating a search request.

POST /search

Conducts a similarity search for files whose contents that match the query. A GitResponse is returned.

Minimum required inputs:

  • uri - a remote Git repository, must be accessible via https protocol
  • discoveryPrompt - an articulation of what you would like to discover within the source

Example of discoveryPrompt:

Any occurrences of Lombok's Builder annotation?

Optional inputs are:

  • username - your Git repository provider account username
  • password - your Git repository provider account password
    • if you have a Github account, then this value should be set to a classic personal access token with full repo permissions.
  • commit - a commit hash, if not supplied the latest commit on origin/main is used
  • allowedExtensions - a set of allowed file extensions used for file path filtering purposes; when specified, only filePaths containing a file extension in the set of extensions will be considered

Sample interaction

http POST :8080/search uri=https://github.com/cf-toolsuite/cf-butler.git discoveryPrompt=$discoveryPrompt

Fetch

This endpoint is only available when spring.profiles.active includes advanced mode. When in advanced mode, you must ingest a repository before initiating a fetch request.

POST /fetch

Returns the contents of a single file.

Minimum required inputs:

  • uri - a remote Git repository, must be accessible via https protocol
  • filePaths - a set that contains one relative file path from the root of the repository

Optional inputs are:

  • username - your Git repository provider account username
  • password - your Git repository provider account password
    • if you have a Github account, then this value should be set to a classic personal access token with full repo permissions.
  • commit - a commit hash, if not supplied the latest commit on origin/main is used

Sample interaction

http POST :8080/fetch uri=https://github.com/cf-toolsuite/cf-butler.git filePaths:='["src/main/java/org/cftoolsuite/cfapp/domain/AppDetail.java"]'

Chat

This endpoint is only available when spring.profiles.active includes advanced mode. When in advanced mode, you must ingest a repository before initiating a chat request.

POST /chat

Converse with an AI chatbot that understands the source that has been ingested. Ask a question, get a response.

Sample interaction

❯ http POST :8080/chat \
  Content-Type:application/json \
  question="Are there any occurrences of the Lombok Builder annotation?"

Refactor

POST /refactor

Clones and refactors source

R*bert clones the remote repository, iterates over a set of file paths, and applies updates to each file based upon criteria in your prompt. It writes updates to a local branch, and if configured to do so, it will push those updates back to origin. Note: If the advanced Spring profile is not activated, then refactoring will not take into account dependencies or relationships within the set of file paths.

Minimum required inputs:

  • uri - a remote Git repository, must be accessible via https protocol
  • refactorPrompt - an articulation of what you would like to be able to refactor within the source

Optional inputs are:

  • base - the base branch of your repository where changes would eventually be pulled into; defaults to main
  • username - your Git repository provider account username
  • password - your Git repository provider account password
    • if you have a Github account, then this value should be set to a classic personal access token with full repo permissions.
  • commit - a commit hash, if not supplied the latest commit on origin/main is used
  • filePaths - either a set of relative file paths from the root of the repository or a set of package names
    • used to constrain the set of files under consideration for refactoring
    • not applicable when advanced Spring profile is activated
  • allowedExtensions - a set of allowed file extensions used for file path filtering purposes; when specified, only filePaths containing a file extension in the set of extensions will be considered
  • pushToRemoteEnabled - whether or not to git push updates on your local branch to remote; if you've set this value to true then you must also supply username and password values as push operation is authenticated
  • pullRequestEnabled - whether or not to file a pull request; if you've set this value to true then you must also supply username and password values as pull request operation is authenticated
  • discoveryPrompt - an articulation of what you would like to discover within the source as candidates for refactoring
    • only required to be specified when advanced Spring profile is activated

Example of discoveryPrompt:

Assume the role and expertise of a Java and Spring developer aware of all projects in the Spring ecosystem and other third-party dependencies. You are asked to discover all occurrences of Lombok annotations within the Java source repository. Return the list documents that have at least one occurrence.

Example of refactorPrompt:

Assume the role and expertise of a Java and Spring developer aware of all projects in the Spring ecosystem and other third-party dependencies. You are asked to remove Lombok annotations and replace with equivalent plain Java source. You are also asked to convert, where possible, Class to Record, but only if the Class was annotated with Lombok's @Builder annotation. In that case be sure to retain builder methods of the same signature as one would get with that annotation. Do not pollute Class to Record conversions with getter and setter methods.

Sample interaction

❯ http POST :8080/refactor uri=https://github.com/cf-toolsuite/cf-butler.git filePaths:='["org.cftoolsuite.cfapp.domain.accounting.application"]' refactorPrompt=$refactorPrompt

HTTP/1.1 200
Connection: keep-alive
Content-Type: application/json
Date: Thu, 29 Aug 2024 18:43:02 GMT
Keep-Alive: timeout=60
Transfer-Encoding: chunked

{
    "branch": "refactor-a3b21c59-a5c2-4d62-a720-097a328dc894",
    "impactedFileSet": [
        "src/main/java/org/cftoolsuite/cfapp/domain/accounting/application/AppUsageMonthly.java",
        "src/main/java/org/cftoolsuite/cfapp/domain/accounting/application/AppUsageYearly.java",
        "src/main/java/org/cftoolsuite/cfapp/domain/accounting/application/AppUsageReport.java"
    ],
    "pullRequestUrl": null,
    "uri": "https://github.com/cf-toolsuite/cf-butler.git"
}

Sample log output

11:40:01.323 [main] INFO  org.cftoolsuite.RobertApplication - Started RobertApplication in 2.62 seconds (process running for 2.888)
11:41:15.196 [tomcat-handler-0] INFO  o.a.c.c.C.[Tomcat].[localhost].[/] - Initializing Spring DispatcherServlet 'dispatcherServlet'
11:41:15.196 [tomcat-handler-0] INFO  o.s.web.servlet.DispatcherServlet - Initializing Servlet 'dispatcherServlet'
11:41:15.198 [tomcat-handler-0] INFO  o.s.web.servlet.DispatcherServlet - Completed initialization in 2 ms
11:42:51.285 [tomcat-handler-2] INFO  org.cftoolsuite.client.GitClient - Cloned Repository[/home/cphillipson/Documents/development/pivotal/cf/robert/tmp/cf-butler/.git]
11:42:51.287 [tomcat-handler-2] INFO  org.cftoolsuite.client.GitClient - Latest commit with id 6562b05bf171d482c303895ad5206e1fc7962cae was made Tue Aug 27 08:02:12 PDT 2024 on Upgrade bcprov-jdk18on to 1.78.1 by Chris Phillipson
11:42:51.289 [tomcat-handler-2] INFO  org.cftoolsuite.client.GitClient - -- Obtaining contents of src/main/java/org/cftoolsuite/cfapp/domain/accounting/application/AppUsageMonthly.java
11:42:51.289 [tomcat-handler-2] INFO  org.cftoolsuite.client.GitClient - -- Obtaining contents of src/main/java/org/cftoolsuite/cfapp/domain/accounting/application/AppUsageReport.java
11:42:51.289 [tomcat-handler-2] INFO  org.cftoolsuite.client.GitClient - -- Obtaining contents of src/main/java/org/cftoolsuite/cfapp/domain/accounting/application/AppUsageYearly.java
11:42:51.289 [tomcat-handler-2] INFO  o.c.s.SimpleSourceRefactoringService - Found 3 files to refactor.
11:42:56.290 [pool-5-thread-1] INFO  o.c.s.SimpleSourceRefactoringService - -- Attempting to refactor src/main/java/org/cftoolsuite/cfapp/domain/accounting/application/AppUsageMonthly.java
11:42:58.809 [pool-5-thread-1] INFO  o.c.s.SimpleSourceRefactoringService - -- Attempting to refactor src/main/java/org/cftoolsuite/cfapp/domain/accounting/application/AppUsageYearly.java
11:43:01.026 [pool-5-thread-1] INFO  o.c.s.SimpleSourceRefactoringService - -- Attempting to refactor src/main/java/org/cftoolsuite/cfapp/domain/accounting/application/AppUsageReport.java
11:43:02.898 [tomcat-handler-2] INFO  o.c.s.SimpleSourceRefactoringService - Refactoring completed on refactor-a3b21c59-a5c2-4d62-a720-097a328dc894.
11:43:02.899 [tomcat-handler-2] INFO  org.cftoolsuite.client.GitClient - Push to remote not enabled!
11:43:02.899 [tomcat-handler-2] INFO  o.c.client.GithubPullRequestClient - Pull request not enabled!

Sample git log

❯ cd tmp/cf-butler
❯ git --no-pager log --max-count=2

commit da12636481d5cc6b20f8b78e4220e71e93c9014b (HEAD -> refactor-a3b21c59-a5c2-4d62-a720-097a328dc894)
Author: Chris Phillipson <cphillipson@pivotal.io>
Date:   Thu Aug 29 11:43:02 2024 -0700

    Refactored by org.cftoolsuite.service.SimpleSourceRefactoringService on 2024-08-29 11:43:02

commit 6562b05bf171d482c303895ad5206e1fc7962cae (tag: 2024.08.27, origin/main, main)
Author: Chris Phillipson <cphillipson@pivotal.io>
Date:   Tue Aug 27 08:02:12 2024 -0700

    Upgrade bcprov-jdk18on to 1.78.1

Validating each refactor request

To validate what had been updated.

❯ cd tmp/cf-butler
❯ git show

Use the up and down arrow keys to scroll through changes. Type :q to exit.

or if you have a comparison tool like Beyond Compare installed, you could

❯ git config --global diff.tool bc
❯ git config --global difftool.bc.path /usr/bin/bcompare
❯ git config --global difftool.bc.trustExitCode true

then

❯ cd tmp/cf-butler
❯ git difftool --dir-diff refactor-{uuid} main

Replace {uuid} with the suffix of the refactored branch

Language extensions

GET /language-extensions

Returns a list of programming languages and associated file extensions used for file path filtering purposes (on refactor requests)

Sample interaction

❯ http :8080/language-extensions
HTTP/1.1 200
Connection: keep-alive
Content-Type: application/json
Date: Wed, 11 Sep 2024 23:47:23 GMT
Keep-Alive: timeout=60
Transfer-Encoding: chunked

[
    {
        "extensions": "go",
        "language": "Go"
    },
    {
        "extensions": "php,inc,class",
        "language": "PHP"
    },
    {
        "extensions": "java",
        "language": "Java"
    },
    {
        "extensions": "rs,rlib",
        "language": "Rust"
    },
    {
        "extensions": "cs,vb,config,nuget",
        "language": "Net"
    },
    {
        "extensions": "rb,rbx",
        "language": "Ruby"
    }
]