Merge branch 'main' into missing=timeouts

Author: davidkyle

.backportrc.json

@@ -0,0 +1,6 @@
+{
+  "repoOwner": "elastic",
+  "repoName": "elasticsearch-specification",
+  "targetBranchChoices": ["9.1", "9.0", "8.19", "8.18"],
+  "fork": false
+}

.buildkite/kibana.sh

@@ -0,0 +1,52 @@
+#!/usr/bin/env bash
+
+set -euo pipefail
+
+# Since we're into the current repo, move to the top-level
+cd ..
+
+echo "--- Install dependencies"
+lsb_release -a
+apt-get update -y
+apt-get install -y unzip
+
+echo "--- Clone elasticsearch-js"
+git clone -v -- [email protected]:elastic/elasticsearch-js.git
+
+echo "--- Clone elastic-client-generator-js"
+git clone -v -- [email protected]:elastic/elastic-client-generator-js.git
+mkdir elastic-client-generator-js/output
+
+echo "--- Clone Kibana"
+git clone -v --reference /usr/local/git-references/git-github.1485827954.workers.dev-elastic-kibana-git -- [email protected]:elastic/kibana.git
+pushd kibana
+
+echo "--- Install Node.js and Yarn"
+curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.40.1/install.sh | bash
+set +e # https://github.com/nvm-sh/nvm/issues/3117
+export NVM_DIR="$([ -z "${XDG_CONFIG_HOME-}" ] && printf %s "${HOME}/.nvm" || printf %s "${XDG_CONFIG_HOME}/nvm")"
+[ -s "$NVM_DIR/nvm.sh" ] && \. "$NVM_DIR/nvm.sh" # This loads nvm
+set -e
+
+nvm install
+nvm use
+npm install --global yarn
+popd
+
+echo "--- Install elasticsearch-js"
+pushd elasticsearch-js
+npm install
+node .buildkite/make.mjs --task codegen main
+npm run build
+npm pack
+popd
+
+pushd kibana
+yarn add ../elasticsearch-js/elastic-elasticsearch-*.tgz
+
+echo "--- Bootstrap Kibana"
+git --no-pager diff
+yarn kbn bootstrap --allow-root
+
+echo "--- Check types"
+node scripts/type_check.js

.buildkite/kibana.yml

@@ -0,0 +1,8 @@
+agents:
+  memory: "24G"
+  cpu: "4"
+  ephemeralStorage: 15Gi
+
+steps:
+  - label: "Run Kibana type checks"
+    command: .buildkite/kibana.sh

.gitattributes

@@ -234,5 +234,6 @@ dist/*            binary
 
 output/** linguist-generated=true
 output/schema/validation-errors.json linguist-generated=false
+compiler-rs/compiler-wasm-lib/pkg/* linguist-generated=true
 
 ####################################################################################################

.github/PULL_REQUEST_TEMPLATE.md

@@ -1,18 +1 @@
-<!--
-
-Hello there!
-
-Thank you for opening a pull request!
-Please make sure to follow the steps below when opening a pr:
-
-- Sign the CLA https://www.elastic.co/contributor-agreement/
-- Tag the relative issue (if any) and give a brief explanation on what your changes are doing
-- If you did a spec change, remember to generate again the outputs, you can do it by running `make contrib`
-- Add the appropriate backport labels. If you need to backport a breaking change (e.g. changing the structure of a type or changing the type/optionality of a field), please follow these rules:
-  - If the API is unusable without the change -> every supported version
-  - If the API is usable, but fix is on the response side -> every supported version
-  - If the API is usable, but fix is on the request side -> no backport, unless the API is _partially_ usable and the fix unlocks a missing feature that has no workaround
-
-Happy coding!
-
--->
+<!-- Hello there! Thank you for opening a pull request. See CONTRIBUTING.md for instructions. -->

.github/download-artifacts/index.js

@@ -17,23 +17,23 @@
  * under the License.
  */
 
-'use strict'
-
-const core = require('@actions/core')
-const { join } = require('path')
-const minimist = require('minimist')
-const stream = require('stream')
-const { promisify } = require('util')
-const { createWriteStream, promises } = require('fs')
-const rimraf = require('rimraf')
-const fetch = require('node-fetch')
-const crossZip = require('cross-zip')
+import core from '@actions/core'
+import { join, dirname } from 'path'
+import { fileURLToPath } from 'url'
+import minimist from 'minimist'
+import stream from 'stream'
+import { promisify } from 'util'
+import { createWriteStream, promises } from 'fs'
+import { rimraf } from 'rimraf'
+import fetch from 'node-fetch'
+import crossZip from 'cross-zip'
 
 const { mkdir, rename, readdir, unlink } = promises
 const pipeline = promisify(stream.pipeline)
 const unzip = promisify(crossZip.unzip)
-const rm = promisify(rimraf)
 
+const __filename = fileURLToPath(import.meta.url)
+const __dirname = dirname(__filename)
 const esFolder = join(__dirname, '..', '..', 'artifacts')
 const zipFolder = join(esFolder, 'artifacts.zip')
 const downloadedSpec = join(esFolder, 'rest-api-spec', 'api')
@@ -57,8 +57,8 @@ async function downloadArtifacts (opts) {
   core.info(`Resolved artifact URL for ${resolved.commit_url}`)
 
   core.info('Cleanup')
-  await rm(esFolder)
-  await rm(specFolder)
+  await rimraf(esFolder)
+  await rimraf(specFolder)
   await mkdir(esFolder, { recursive: true })
   await mkdir(specFolder, { recursive: true })
 
@@ -74,7 +74,7 @@ async function downloadArtifacts (opts) {
   await unzip(zipFolder, esFolder)
 
   core.info('Cleanup')
-  await rm(zipFolder)
+  await rimraf(zipFolder)
 
   core.info('Moving files')
   const files = await readdir(downloadedSpec)

.github/download-artifacts/package.json

@@ -2,6 +2,7 @@
   "name": "download-artifacts",
   "version": "1.0.0",
   "description": "",
+  "type": "module",
   "main": "index.js",
   "scripts": {
     "test": "echo \"Error: no test specified\" && exit 1"
@@ -13,7 +14,7 @@
     "@actions/core": "^1.6.0",
     "cross-zip": "^4.0.0",
     "minimist": "^1.2.5",
-    "node-fetch": "^2.6.7",
-    "rimraf": "^3.0.2"
+    "node-fetch": "^3",
+    "rimraf": "^6"
   }
 }

.github/validate-pr/index.js

@@ -26,7 +26,8 @@ import assert from 'assert'
 import * as core from '@actions/core'
 import { copyFile } from 'fs/promises'
 import * as github from '@actions/github'
-import specification from '../../output/schema/schema.json' assert { type: 'json' }
+import specification from '../../output/schema/schema.json' with { type: 'json' }
+import baselineValidation from '../../../clients-flight-recorder/recordings/types-validation/types-validation.json' with { type: 'json' }
 import { run as getReport } from '../../../clients-flight-recorder/scripts/types-validator/index.js'
 import {
   getNamespace,
@@ -81,68 +82,85 @@ async function run() {
   const specFiles = files.filter(
     (file) => file.includes('specification') && !file.includes('compiler/test')
   )
-  const table = []
+  const reports = new Map()
 
   cd(tsValidationPath)
 
+  // Collect all APIs to validate
+  const apisToValidate = new Set()
+
   for (const file of specFiles) {
     if (file.startsWith('specification/_types')) continue
     if (file.startsWith('specification/_spec_utils')) continue
     if (file.startsWith('specification/_doc_ids')) continue
     if (file.startsWith('specification/_json_spec')) continue
-    if (file === 'specification/tsconfig.json') continue
+    if (file.startsWith('specification/node_modules')) continue
+    if (file.endsWith('tsconfig.json')) continue
+    if (file.endsWith('eslint.config.js')) continue
+    if (file.endsWith('package.json')) continue
+    if (file.endsWith('package-lock.json')) continue
+    if (file.endsWith('.md')) continue
     if (getApi(file).endsWith('_types')) {
       const apis = specification.endpoints
         .filter(endpoint => endpoint.name.split('.').filter(s => !privateNames.includes(s))[0] === getApi(file).split('.')[0])
         .map(endpoint => endpoint.name)
       for (const api of apis) {
-        const report = await getReport({
-          api,
-          'generate-report': false,
-          request: true,
-          response: true,
-          ci: false,
-          verbose: false
-        })
-        table.push(buildTableLine(api, report))
+        apisToValidate.add(api)
       }
     } else {
-      const report = await getReport({
-        api: getApi(file),
-        'generate-report': false,
-        request: true,
-        response: true,
-        ci: false,
-        verbose: false
-      })
-      table.push(buildTableLine(getApi(file), report))
+      const api = getApi(file)
+      apisToValidate.add(api)
+    }
+  }
+
+  // Call getReport once with all APIs
+  if (apisToValidate.size > 0) {
+    const allApis = Array.from(apisToValidate).join(',')
+    const report = await getReport({
+      api: allApis,
+      'generate-report': false,
+      request: true,
+      response: true,
+      ci: false,
+      verbose: false
+    })
+
+    // Extract individual API reports from the combined result
+    for (const api of apisToValidate) {
+      const namespace = getNamespace(api)
+      if (report.has(namespace)) {
+        const namespaceReport = report.get(namespace).find(r => r.api === getName(api))
+        if (namespaceReport) {
+          reports.set(api, namespaceReport)
+        }
+      }
     }
   }
 
   cd(path.join(__dirname, '..', '..'))
 
-  table.sort((a, b) => {
-    if (a < b) return -1
-    if (a > b) return 1
-    return 0
-  })
+  // Compare current reports with baseline and find changes
+  const changedApis = []
+  for (const [apiName, report] of reports) {
+    const baselineReport = findBaselineReport(apiName, baselineValidation)
+    if (baselineReport && hasChanges(baselineReport, report, apiName)) {
+      changedApis.push({ api: apiName, baseline: baselineReport, current: report })
+    }
+  }
+  changedApis.sort((a, b) => a.api.localeCompare(b.api))
 
-  if (table.length > 0) {
-    let comment = `Following you can find the validation results for the API${table.length === 1 ? '' : 's'} you have changed.\n\n`
+  let comment = `Following you can find the validation changes against the target branch for the API${changedApis.length === 1 ? '' : 's'}.\n\n`
+  if (changedApis.length > 0) {
     comment += '| API | Status | Request | Response |\n'
     comment += '| --- | --- | --- | --- |\n'
-    for (const line of [...new Set(table)]) {
-      comment += line
+    for (const change of changedApis) {
+      comment += buildDiffTableLine(change)
     }
-    comment += `\nYou can validate ${table.length === 1 ? 'this' : 'these'} API${table.length === 1 ? '' : 's'} yourself by using the ${tick}make validate${tick} target.\n`
-
-    await octokit.rest.issues.createComment({
-      owner: 'elastic',
-      repo: 'elasticsearch-specification',
-      issue_number: context.payload.pull_request.number,
-      body: comment
-    })
+  } else {
+    comment += '**No changes detected**.\n'
   }
+  comment += `\nYou can validate ${changedApis.length === 1 ? 'this' : 'these'} API${changedApis.length === 1 ? '' : 's'} yourself by using the ${tick}make validate${tick} target.\n`
+  core.setOutput('comment_body', comment)
 
   core.info('Done!')
 }
@@ -151,35 +169,65 @@ function getApi (file) {
   return file.split('/').slice(1, 3).filter(s => !privateNames.includes(s)).filter(Boolean).join('.')
 }
 
-function buildTableLine (api, report) {
-  const apiReport = report.get(getNamespace(api)).find(r => r.api === getName(api))
-  return `| ${tick}${api}${tick} | ${generateStatus(apiReport)} | ${generateRequest(apiReport)} | ${generateResponse(apiReport)} |\n`
+function findBaselineReport(apiName, baselineValidation) {
+  const [namespace, method] = apiName.split('.')
+
+  if (!baselineValidation.namespaces[namespace]) {
+    return null
+  }
+
+  return baselineValidation.namespaces[namespace].apis.find(api => api.api === method)
 }
 
-function generateStatus (report) {
-  if (!report.diagnostics.hasRequestType || !report.diagnostics.hasResponseType) {
+function hasChanges(baselineReport, report) {
+  if (!report) return false
+
+  return baselineReport.status !== report.status ||
+         baselineReport.passingRequest !== report.passingRequest ||
+         baselineReport.passingResponse !== report.passingResponse
+}
+
+function buildDiffTableLine(change) {
+  const { api, baseline, current } = change
+
+  const status = generateStatus(current.status)
+  const request = generateRequest(current)
+  const response = generateResponse(current)
+
+  const baselineStatus = generateStatus(baseline.status)
+  const baselineRequest = generateRequest(baseline)
+  const baselineResponse = generateResponse(baseline)
+
+  const statusDiff = status !== baselineStatus ? `${baselineStatus} → ${status}` : status
+  const requestDiff = request !== baselineRequest ? `${baselineRequest} → ${request}` : request
+  const responseDiff = response !== baselineResponse ? `${baselineResponse} → ${response}` : response
+
+  return `| ${tick}${api}${tick} | ${statusDiff} | ${requestDiff} | ${responseDiff} |\n`
+}
+
+
+function generateStatus (status) {
+  if (status === 'missing_types' || status === 'missing_request_type' || status === 'missing_response_type') {
     return ':orange_circle:'
   }
-  if (report.totalRequest <= 0 || report.totalResponse <= 0) {
+  if (status === 'missing_test') {
     return ':white_circle:'
   }
-  if (report.diagnostics.request.length === 0 && report.diagnostics.response.length === 0) {
+  if (status === 'passing') {
     return ':green_circle:'
   }
   return ':red_circle:'
 }
 
 function generateRequest (r) {
-  if (r.totalRequest === -1) return 'Missing recording'
-  if (!r.diagnostics.hasRequestType) return 'Missing type'
-  if (r.totalRequest === 0) return 'Missing test'
+  if (r.status === 'missing_test') return 'Missing test'
+  if (r.status === 'missing_types' || r.status == 'missing_request_type') return 'Missing type'
   return `${r.passingRequest}/${r.totalRequest}`
 }
 
 function generateResponse (r) {
-  if (r.totalResponse === -1) return 'Missing recording'
-  if (!r.diagnostics.hasResponseType) return 'Missing type'
-  if (r.totalResponse === 0) return 'Missing test'
+  if (r.status === 'missing_test') return 'Missing test'
+  if (r.status === 'missing_types' || r.status == 'missing_response_type') return 'Missing type'
   return `${r.passingResponse}/${r.totalResponse}`
 }
 

.github/validate-pr/package.json

@@ -13,6 +13,6 @@
   "dependencies": {
     "@actions/core": "^1.6.0",
     "@actions/github": "^5.0.0",
-    "zx": "^4.3.0"
+    "zx": "^8"
   }
 }