import {z} from 'zod' export type GetApiApiBuildsIdGradleBuildCachePerformanceOptions = {baseUrl?: string | undefined, DevelocityAccessKeyOrToken?: string | undefined, fetch?: typeof fetch | undefined}; export const gradleBuildCachePerformanceTaskExecutionEntry = z.object({taskPath: z.string(), taskType: z.string(), avoidanceOutcome: z.enum(["avoided_up_to_date", "avoided_from_local_cache", "avoided_from_remote_cache", "executed_cacheable", "executed_not_cacheable", "executed_unknown_cacheability", "avoided_unknown_reason", "lifecycle", "no-source", "skipped"]), duration: z.number().int(), fingerprintingDuration: z.number().int().nullable().optional(), avoidanceSavings: z.number().int().nullable().optional(), nonCacheabilityCategory: z.enum(["build_cache_not_enabled", "cache-if_condition_not_matched", "disabled_to_ensure_correctness", "do-not-cache-if_condition_matched", "multiple_outputs_declared", "no_outputs_declared", "non_cacheable_inputs", "non_cacheable_task_action", "non_cacheable_task_implementation", "non_cacheable_tree_output", "overlapping_outputs", "task_has_no_actions", "task_output_caching_not_enabled", "unknown"]).nullable().optional(), nonCacheabilityReason: z.string().nullable().optional(), skipReasonMessage: z.string().nullable().optional(), cacheArtifactSize: z.number().int().nullable().optional(), cacheArtifactRejectedReason: z.literal("artifact_size_too_large").nullable().optional(), cacheKey: z.string().nullable().optional(), hasFailed: z.boolean()}); export const gradleBuildCachePerformanceTaskExecution = z.array(gradleBuildCachePerformanceTaskExecutionEntry); export const gradleBuildCachePerformanceTaskFingerprintingSummary = z.object({count: z.number().int(), serialDuration: z.number().int()}).nullable(); export const gradleBuildCachePerformanceWorkUnitFingerprintingSummary = z.object({count: z.number().int(), serialDuration: z.number().int()}).nullable(); export const gradleBuildCachePerformanceAvoidanceSavingsSummary = z.object({total: z.number().int(), ratio: z.number(), upToDate: z.number().int(), localBuildCache: z.number().int(), remoteBuildCache: z.number().int()}); export const gradleBuildCachePerformanceTaskAvoidanceSavingsSummary = z.object({total: z.number().int(), ratio: z.number(), upToDate: z.number().int(), localBuildCache: z.number().int(), remoteBuildCache: z.number().int()}); export const gradleBuildCachePerformanceWorkUnitAvoidanceSavingsSummary = z.object({total: z.number().int(), ratio: z.number(), upToDate: z.number().int(), localBuildCache: z.number().int(), remoteBuildCache: z.number().int()}); export const gradleBuildCachePerformanceBuildCacheLocalInfo = z.object({isEnabled: z.boolean(), isPushEnabled: z.boolean().nullable().optional(), isDisabledDueToError: z.boolean().optional(), directory: z.string().nullable().optional()}); export const gradleBuildCachePerformanceBuildCacheRemoteInfo = z.object({type: z.string().nullable().optional(), className: z.string().nullable().optional(), isEnabled: z.boolean(), isPushEnabled: z.boolean().nullable().optional(), isDisabledDueToError: z.boolean().optional(), url: z.string().nullable().optional()}); export const gradleBuildCachePerformanceBuildCacheOverhead = z.object({uploading: z.number().int(), downloading: z.number().int(), packing: z.number().int(), unpacking: z.number().int()}); export const gradleBuildCachePerformanceBuildCaches = z.object({local: gradleBuildCachePerformanceBuildCacheLocalInfo, remote: gradleBuildCachePerformanceBuildCacheRemoteInfo, overhead: gradleBuildCachePerformanceBuildCacheOverhead}).nullable(); export const gradleBuildCachePerformance = z.object({id: z.string(), buildTime: z.number().int(), effectiveTaskExecutionTime: z.number().int(), effectiveWorkUnitExecutionTime: z.number().int(), serialTaskExecutionTime: z.number().int(), serialWorkUnitExecutionTime: z.number().int(), serializationFactor: z.number(), taskExecution: gradleBuildCachePerformanceTaskExecution, taskFingerprintingSummary: gradleBuildCachePerformanceTaskFingerprintingSummary.optional(), workUnitFingerprintingSummary: gradleBuildCachePerformanceWorkUnitFingerprintingSummary.optional(), avoidanceSavingsSummary: gradleBuildCachePerformanceAvoidanceSavingsSummary, taskAvoidanceSavingsSummary: gradleBuildCachePerformanceTaskAvoidanceSavingsSummary, workUnitAvoidanceSavingsSummary: gradleBuildCachePerformanceWorkUnitAvoidanceSavingsSummary, buildCaches: gradleBuildCachePerformanceBuildCaches.optional()}); export const validateResponse = async ( schema: { readonly '~standard': { readonly validate: (value: unknown) => ({ readonly value: Output; readonly issues?: undefined } | { readonly issues: ReadonlyArray<{ readonly message: string; readonly path?: ReadonlyArray | undefined }> }) | Promise<{ readonly value: Output; readonly issues?: undefined } | { readonly issues: ReadonlyArray<{ readonly message: string; readonly path?: ReadonlyArray | undefined }> }> } }, value: unknown ): Promise => { const result = await schema['~standard'].validate(value) if (result.issues !== undefined) { const detail = result.issues .map(({ message, path }) => path?.length ? `${path.map((segment) => String(typeof segment === 'object' ? segment.key : segment)).join('.')}: ${message}` : message ) .join('; ') throw new Error(`Response does not match the schema: ${detail}`, { cause: { issues: result.issues } }) } return result.value }; /** * Get the build cache performance of a Gradle build. * * GET /api/builds/{id}/gradle-build-cache-performance */ export const getApiApiBuildsIdGradleBuildCachePerformance = async (options?: GetApiApiBuildsIdGradleBuildCachePerformanceOptions) => { const {baseUrl = "https://develocity.example.com", fetch: fetchFn = fetch, DevelocityAccessKeyOrToken} = options ?? {} const query = new URLSearchParams() const headers = new Headers() headers.set('accept', "application/json") if (DevelocityAccessKeyOrToken !== undefined) headers.set('authorization', `Bearer ${DevelocityAccessKeyOrToken}`) const url = `${baseUrl.replace(/\/+$/, '')}/api/builds/${encodeURIComponent(String(args.id))}/gradle-build-cache-performance${query.size > 0 ? `?${query}` : ''}` const res = await fetchFn(url, {method: "GET", headers}) if (!res.ok) throw new Error(`Request failed with status ${res.status}`, {cause: {status: res.status, body: await res.text()}}) return validateResponse(gradleBuildCachePerformance, await res.json()) };