carrick 0.3.107 → 0.3.109

package/sidecar/dist/src/types.d.ts

@@ -206,6 +206,22 @@ export interface HealthRequest extends BaseRequest {
 export interface ShutdownRequest extends BaseRequest {
     action: 'shutdown';
 }
+/**
+ * List the root files the init'd project's program was built from, in order
+ * (carrick#2027).
+ */
+export interface ListProgramFilesRequest extends BaseRequest {
+    action: 'list_program_files';
+}
+/**
+ * Add files to the programs that type them, in the given order
+ * (carrick#2027).
+ */
+export interface AddProgramFilesRequest extends BaseRequest {
+    action: 'add_program_files';
+    /** Absolute paths, or relative to the init'd root. */
+    files: string[];
+}
 /**
  * Request to resolve type definitions from a v2 capture stub package.
  * Returns both the original declaration and the compiler-expanded form for
@@ -461,7 +477,7 @@ export interface ListLibrarySurfaceRequest extends BaseRequest {
 /**
  * Union type for all possible sidecar requests
  */
-export type SidecarRequest = RetypeCheckRequest | VerifyClientSemanticsRequest | VerifyLibraryClaimsRequest | ListLibrarySurfaceRequest | InitRequest | BundleRequest | CaptureV2Request | CheckV2Request | InferRequest | ResolveDefinitionsRequest | HealthRequest | ShutdownRequest;
+export type SidecarRequest = RetypeCheckRequest | VerifyClientSemanticsRequest | VerifyLibraryClaimsRequest | ListLibrarySurfaceRequest | InitRequest | BundleRequest | CaptureV2Request | CheckV2Request | InferRequest | ResolveDefinitionsRequest | HealthRequest | ShutdownRequest | ListProgramFilesRequest | AddProgramFilesRequest;
 /**
  * Request for a specific symbol to be bundled
  */
@@ -542,9 +558,77 @@ export interface BundleResponse extends BaseResponse {
 export interface InferResponse extends BaseResponse {
     /** Successfully inferred types */
     inferred_types?: InferredType[];
+    /** How long the requests took, and which were slowest (carrick#1985) */
+    infer_timing?: InferTiming;
     /** General errors */
     errors?: string[];
 }
+/**
+ * How long one request of an `infer` batch took (carrick#1985).
+ *
+ * It names the request and measures its answer. It never holds the answer:
+ * the type a request printed is here as a length only.
+ */
+export interface InferSlotTiming {
+    /** The alias the request carried, when it carried one */
+    alias?: string;
+    /** The file the request named, as it named it */
+    file_path: string;
+    /** The line the request named */
+    line_number: number;
+    /** The kind of inference the request asked for */
+    infer_kind: InferKind;
+    /**
+     * Wall time, in milliseconds, from the batch taking the request up to it
+     * keeping the request's answer or its error.
+     */
+    ms: number;
+    /**
+     * Of `ms`, the time in the compiler call that computes the type: a
+     * function's `getReturnType()`, a parameter's `getType()`. It is told
+     * apart for `signature_return` and `function_param`, and is 0 for the
+     * other kinds, whose time in the compiler stays in `ms` alone.
+     */
+    type_ms: number;
+    /**
+     * Of `ms`, the time in the inferrer's print of a type to text. Truncation
+     * is off, so a type is printed at its whole length. For
+     * `signature_return` and `function_param` this is every print the request
+     * makes; the other kinds also print through the structural expander, and
+     * that time stays in `ms` alone.
+     */
+    print_ms: number;
+    /** Characters in the `type_string` the request printed; 0 when it printed none */
+    printed_length: number;
+    /**
+     * No earlier request named this file to the project that answered. Such a
+     * request does the work the file's later ones reuse: the index of the
+     * file's functions, and every type the checker resolves on the way that it
+     * had not resolved before.
+     */
+    first_in_file: boolean;
+}
+/**
+ * The timing of the requests of one `infer` batch (carrick#1985).
+ */
+export interface InferTiming {
+    /** Requests the batch was done with: answered, refused, skipped or failed */
+    slots: number;
+    /** Their wall times, added up, in milliseconds */
+    slots_ms: number;
+    /** Of `slots_ms`, the time computing types (each request's `type_ms`) */
+    type_ms: number;
+    /** Of `slots_ms`, the time printing types (each request's `print_ms`) */
+    print_ms: number;
+    /** How many of them were the first asked of their file */
+    first_in_file_slots: number;
+    /** The wall times of those, added up, in milliseconds */
+    first_in_file_ms: number;
+    /** The slowest requests, slowest first: `SLOWEST_SLOTS` of them at most */
+    slowest: InferSlotTiming[];
+    /** The request that printed the longest type; absent when none printed one */
+    longest_printed?: InferSlotTiming;
+}
 /**
  * Response for resolve_definitions action
  */
@@ -577,6 +661,22 @@ export interface HealthResponse extends BaseResponse {
 export interface ShutdownResponse extends BaseResponse {
     status: 'success';
 }
+/**
+ * Response for list_program_files action
+ */
+export interface ListProgramFilesResponse extends BaseResponse {
+    /** The program's root files, as absolute paths, in order. */
+    files?: string[];
+    errors?: string[];
+}
+/**
+ * Response for add_program_files action
+ */
+export interface AddProgramFilesResponse extends BaseResponse {
+    /** How many of the given files were added. */
+    added?: number;
+    errors?: string[];
+}
 /**
  * Error response
  */
@@ -717,7 +817,7 @@ export interface ListLibrarySurfaceResponse extends BaseResponse {
 /**
  * Union type for all possible sidecar responses
  */
-export type SidecarResponse = RetypeCheckResponse | VerifyClientSemanticsResponse | VerifyLibraryClaimsResponse | ListLibrarySurfaceResponse | InitResponse | BundleResponse | CaptureV2Response | CheckV2Response | InferResponse | ResolveDefinitionsResponse | HealthResponse | ShutdownResponse | ErrorResponse;
+export type SidecarResponse = RetypeCheckResponse | VerifyClientSemanticsResponse | VerifyLibraryClaimsResponse | ListLibrarySurfaceResponse | InitResponse | BundleResponse | CaptureV2Response | CheckV2Response | InferResponse | ResolveDefinitionsResponse | HealthResponse | ShutdownResponse | ListProgramFilesResponse | AddProgramFilesResponse | ErrorResponse;
 /**
  * An entry in the type manifest
  */
@@ -934,6 +1034,8 @@ export interface InferResult {
     success: boolean;
     /** Successfully inferred types */
     inferred_types?: InferredType[];
+    /** How long each request took, summed up (carrick#1985) */
+    timing: InferTiming;
     /** General error messages */
     errors?: string[];
 }