package build.warp.tricorder

Get desktop application:
View/edit binary Protocol Buffers messages

A TricorderService is a repository and code analysis service created for a specific language ecosystem that will be started and managed from within Warp. It helps Warp understand how an ecosystem works.

• rpc EnsureReady (EnsureReadyRequest, EnsureReadyResponse)

  tricorder.proto:16

  Returns whether the service is ready to take further requests. Since we are initializing tricorder services from within warp as separate processes, we need a signal to tell us that it is indeed ready.

  message EnsureReadyRequest

  tricorder.proto:39

  (message has no fields)

  message EnsureReadyResponse

  tricorder.proto:40

  (message has no fields)

• rpc GenerateSignature (GenerateSignatureRequest, GenerateSignatureResponse)

  tricorder.proto:32

  Generates a Warp Signature for a given source and symbol. This is used during the Target Resolution phase, to understand how to build, test, or run a given target. The entirety of the repository is normally available to this rpc, but the signature is expected to correspond to a single path, be it a file or a directory. A list of dependencies will be provided to facilitate the analysis of code in case that paths to 3rd party dependencies are required. For example, in languages with preprocessors that require the inclusion of header files, this list of dependencies will include information about the paths where those header files may reside.

  message GenerateSignatureRequest

  tricorder.proto:42

  • string workspace_root = 1

    The root of the workspace that the Tricorder will be analyzing.

  • string file = 2

    The path to the file that this signature corresponds to. This path will be relative to the `workspace_root`.

  • repeated Dependency dependencies = 4

    A list of dependencies known to be required to generate a signature for this file.

  • optional TestMatcher test_matcher = 5

  • Goal goal = 6

  message GenerateSignatureResponse

  tricorder.proto:61

  • oneof response

    • GenerateSignatureSuccessResponse ok = 1

    • GenerateSignatureMissingDepsResponse missing_deps = 3

• rpc GetAst (GetAstRequest, GetAstResponse)

  tricorder.proto:34

  message GetAstRequest

  tricorder.proto:92

  • string file = 1

  • repeated Dependency dependencies = 3

  • optional TestMatcher test_matcher = 4

  • string workspace_root = 5

    The root of the workspace that the Tricorder will be analyzing.

  • Goal goal = 6

  message GetAstResponse

  tricorder.proto:103

  • oneof response

    • GetAstSuccessResponse ok = 1

    • GetAstMissingDepsResponse missing_deps = 3

• rpc PrepareDependency (PrepareDependencyRequest, PrepareDependencyResponse)

  tricorder.proto:36

  message PrepareDependencyRequest

  tricorder.proto:130

  • string package_root = 1

    The root directory where this package is located.

  • string url = 2

    The URL that this package was downloded from.

  • string package_name = 3

    The name of the dependency to preprae.

  message PrepareDependencyResponse

  tricorder.proto:141

  • repeated Signature signatures = 2

Used in: GetAstSuccessResponse

• string workspace_root = 1

• string file = 2

• string signature_name = 3

• string source_chunk = 4

• string ast = 5

Used in: GenerateSignatureResponse

• string workspace_root = 1

• string file = 2

• repeated Dependency dependencies = 4

  The dependencies that were provided for signature generation.

• repeated Requirement requirements = 5

  A non-empty collection of requirements. These specify new dependencies that are needed to generate the signature.

Used in: GenerateSignatureResponse

• string workspace_root = 1

  The root of the workspace that was analyzed.

• string file = 2

  The file that the signatures correspod to.

• repeated Signature signatures = 4

  A non-empty collection of signatures for this file.

Used in: GetAstResponse

• string file = 1

• repeated Dependency dependencies = 4

  repeated Requirement dependencies = 3;

• repeated Requirement requirements = 5

Used in: GetAstResponse

• repeated AstSubtree subtrees = 5