Merge branch 'main' into ske-dep-api

Author: Sarah Edwards

.eslintrc.js

@@ -13,7 +13,7 @@ module.exports = {
     babelOptions: { configFile: './.babelrc' },
     sourceType: 'module',
   },
-  ignorePatterns: ['tmp/*', '!/.*', '/.next/', 'script/bookmarklets/*', 'lib/sigsci.js'],
+  ignorePatterns: ['tmp/*', '!/.*', '/.next/', 'script/bookmarklets/*'],
   rules: {
     'import/no-extraneous-dependencies': ['error', { packageDir: '.' }],
   },

.github/actions-scripts/content-changes-table-comment.js

@@ -20,6 +20,11 @@ if (!APP_URL) {
   throw new Error(`APP_URL environment variable not set`)
 }
 
+// the max size of the comment (in bytes)
+// the action we use to post the comment caps out at about 144kb
+// see docs-engineering#1849 for more info
+const MAX_COMMENT_SIZE = 125000
+
 const PROD_URL = 'https://docs.github.com'
 const octokit = github.getOctokit(GITHUB_TOKEN)
 
@@ -39,78 +44,117 @@ const pathPrefix = 'content/'
 const articleFiles = files.filter(
   ({ filename }) => filename.startsWith(pathPrefix) && !filename.endsWith('/index.md')
 )
-for (const file of articleFiles) {
-  const sourceUrl = file.blob_url
-  const fileName = file.filename.slice(pathPrefix.length)
-  const fileUrl = fileName.slice(0, fileName.lastIndexOf('.'))
-
-  // get the file contents and decode them
-  // this script is called from the main branch, so we need the API call to get the contents from the branch, instead
-  const fileContents = await getContents(
-    context.repo.owner,
-    context.payload.repository.name,
-    context.payload.pull_request.head.sha,
-    file.filename
-  )
-
-  // parse the frontmatter
-  const { data } = parse(fileContents)
-
-  let contentCell = ''
-  let previewCell = ''
-  let prodCell = ''
-
-  if (file.status === 'added') contentCell = `New file: `
-  contentCell += `[\`${fileName}\`](${sourceUrl})`
-
-  try {
-    // the try/catch is needed because getApplicableVersions() returns either [] or throws an error when it can't parse the versions frontmatter
-    // try/catch can be removed if docs-engineering#1821 is resolved
-    // i.e. for feature based versioning, like ghae: 'issue-6337'
-    const fileVersions = getApplicableVersions(data.versions)
-
-    for (const plan in allVersionShortnames) {
-      // plan is the shortName (i.e., fpt)
-      // allVersionShortNames[plan] is the planName (i.e., free-pro-team)
-
-      // walk by the plan names since we generate links differently for most plans
-      const versions = fileVersions.filter((fileVersion) =>
-        fileVersion.includes(allVersionShortnames[plan])
-      )
-
-      if (versions.length === 1) {
-        // for fpt, ghec, and ghae
 
-        if (versions.toString() === nonEnterpriseDefaultVersion) {
-          // omit version from fpt url
-
-          previewCell += `[${plan}](${APP_URL}/${fileUrl})<br>`
-          prodCell += `[${plan}](${PROD_URL}/${fileUrl})<br>`
-        } else {
-          // for non-versioned releases (ghae, ghec) use full url
+const lines = await Promise.all(
+  articleFiles.map(async (file) => {
+    const sourceUrl = file.blob_url
+    const fileName = file.filename.slice(pathPrefix.length)
+    const fileUrl = fileName.slice(0, fileName.lastIndexOf('.'))
+
+    // get the file contents and decode them
+    // this script is called from the main branch, so we need the API call to get the contents from the branch, instead
+    const fileContents = await getContents(
+      context.repo.owner,
+      context.payload.repository.name,
+      // Can't get its content if it no longer exists.
+      // Meaning, you'd get a 404 on the `getContents()` utility function.
+      // So, to be able to get necessary meta data about what it *was*,
+      // if it was removed, fall back to the 'base'.
+      file.status === 'removed'
+        ? context.payload.pull_request.base.sha
+        : context.payload.pull_request.head.sha,
+      file.filename
+    )
 
-          previewCell += `[${plan}](${APP_URL}/${versions}/${fileUrl})<br>`
-          prodCell += `[${plan}](${PROD_URL}/${versions}/${fileUrl})<br>`
+    // parse the frontmatter
+    const { data } = parse(fileContents)
+
+    let contentCell = ''
+    let previewCell = ''
+    let prodCell = ''
+
+    if (file.status === 'added') contentCell = 'New file: '
+    else if (file.status === 'removed') contentCell = 'Removed: '
+    contentCell += `[\`${fileName}\`](${sourceUrl})`
+
+    try {
+      // the try/catch is needed because getApplicableVersions() returns either [] or throws an error when it can't parse the versions frontmatter
+      // try/catch can be removed if docs-engineering#1821 is resolved
+      // i.e. for feature based versioning, like ghae: 'issue-6337'
+      const fileVersions = getApplicableVersions(data.versions)
+
+      for (const plan in allVersionShortnames) {
+        // plan is the shortName (i.e., fpt)
+        // allVersionShortNames[plan] is the planName (i.e., free-pro-team)
+
+        // walk by the plan names since we generate links differently for most plans
+        const versions = fileVersions.filter((fileVersion) =>
+          fileVersion.includes(allVersionShortnames[plan])
+        )
+
+        if (versions.length === 1) {
+          // for fpt, ghec, and ghae
+
+          if (versions.toString() === nonEnterpriseDefaultVersion) {
+            // omit version from fpt url
+
+            previewCell += `[${plan}](${APP_URL}/${fileUrl})<br>`
+            prodCell += `[${plan}](${PROD_URL}/${fileUrl})<br>`
+          } else {
+            // for non-versioned releases (ghae, ghec) use full url
+
+            previewCell += `[${plan}](${APP_URL}/${versions}/${fileUrl})<br>`
+            prodCell += `[${plan}](${PROD_URL}/${versions}/${fileUrl})<br>`
+          }
+        } else if (versions.length) {
+          // for ghes releases, link each version
+
+          previewCell += `${plan}@ `
+          prodCell += `${plan}@ `
+
+          versions.forEach((version) => {
+            previewCell += `[${version.split('@')[1]}](${APP_URL}/${version}/${fileUrl}) `
+            prodCell += `[${version.split('@')[1]}](${PROD_URL}/${version}/${fileUrl}) `
+          })
+          previewCell += '<br>'
+          prodCell += '<br>'
         }
-      } else if (versions.length) {
-        // for ghes releases, link each version
-
-        previewCell += `${plan}@ `
-        prodCell += `${plan}@ `
-
-        versions.forEach((version) => {
-          previewCell += `[${version.split('@')[1]}](${APP_URL}/${version}/${fileUrl}) `
-          prodCell += `[${version.split('@')[1]}](${PROD_URL}/${version}/${fileUrl}) `
-        })
-        previewCell += '<br>'
-        prodCell += '<br>'
       }
+    } catch (e) {
+      console.error(
+        `Version information for ${file.filename} couldn't be determined from its frontmatter.`
+      )
     }
-  } catch (e) {
-    console.error(
-      `Version information for ${file.filename} couldn't be determined from its frontmatter.`
-    )
+    let note = ''
+    if (file.status === 'removed') {
+      note = 'removed'
+      // If the file was removed, the `previewCell` no longer makes sense
+      // since it was based on looking at the base sha.
+      previewCell = 'n/a'
+    }
+
+    return `| ${contentCell} | ${previewCell} | ${prodCell} | ${note} |`
+  })
+)
+
+// this section limits the size of the comment
+const cappedLines = []
+let underMax = true
+
+lines.reduce((previous, current, index, array) => {
+  if (underMax) {
+    if (previous + current.length > MAX_COMMENT_SIZE) {
+      underMax = false
+      cappedLines.push('**Note** There are more changes in this PR than we can show.')
+      return previous
+    }
+
+    cappedLines.push(array[index])
+    return previous + current.length
   }
-  markdownTable += `| ${contentCell} | ${previewCell} | ${prodCell} | |\n`
-}
+  return previous
+}, markdownTable.length)
+
+markdownTable += cappedLines.join('\n')
+
 setOutput('changesTable', markdownTable)

.github/actions-scripts/enable-automerge.js

@@ -17,7 +17,7 @@ async function main() {
   const github = getOctokit(token)
   const pull = await github.rest.pulls.get({
     owner: org,
-    repo: repo,
+    repo,
     pull_number: parseInt(prNumber),
   })
 

.github/actions-scripts/fr-add-docs-reviewers-requests.js

@@ -191,16 +191,16 @@ async function run() {
 
     await graphql(updateProjectNextItemMutation, {
       project: projectID,
-      statusID: statusID,
+      statusID,
       statusValueID: readyForReviewID,
-      datePostedID: datePostedID,
-      reviewDueDateID: reviewDueDateID,
-      contributorTypeID: contributorTypeID,
-      contributorType: contributorType,
-      sizeTypeID: sizeTypeID,
+      datePostedID,
+      reviewDueDateID,
+      contributorTypeID,
+      contributorType,
+      sizeTypeID,
       sizeType: '', // Although we aren't populating size, we are passing the variable so that we can use the shared mutation function
-      featureID: featureID,
-      authorID: authorID,
+      featureID,
+      authorID,
       headers: {
         authorization: `token ${process.env.TOKEN}`,
         'GraphQL-Features': 'projects_next_graphql',

.github/actions-scripts/msft-create-translation-batch-pr.js

@@ -0,0 +1,142 @@
+#!/usr/bin/env node
+
+import fs from 'fs'
+import github from '@actions/github'
+
+const OPTIONS = Object.fromEntries(
+  ['BASE', 'BODY_FILE', 'GITHUB_TOKEN', 'HEAD', 'LANGUAGE', 'TITLE', 'GITHUB_REPOSITORY'].map(
+    (envVarName) => {
+      const envVarValue = process.env[envVarName]
+      if (!envVarValue) {
+        throw new Error(`You must supply a ${envVarName} environment variable`)
+      }
+      return [envVarName, envVarValue]
+    }
+  )
+)
+
+if (!process.env.GITHUB_REPOSITORY) {
+  throw new Error('GITHUB_REPOSITORY environment variable not set')
+}
+
+const RETRY_STATUSES = [
+  422, // Retry the operation if the PR already exists
+  502, // Retry the operation if the API responds with a `502 Bad Gateway` error.
+]
+const RETRY_ATTEMPTS = 3
+const {
+  // One of the default environment variables provided by Actions.
+  GITHUB_REPOSITORY,
+
+  // These are passed in from the step in the workflow file.
+  TITLE,
+  BASE,
+  HEAD,
+  LANGUAGE,
+  BODY_FILE,
+  GITHUB_TOKEN,
+} = OPTIONS
+const [OWNER, REPO] = GITHUB_REPOSITORY.split('/')
+
+const octokit = github.getOctokit(GITHUB_TOKEN)
+
+/**
+ * @param {object} config Configuration options for finding the PR.
+ * @returns {Promise<number | undefined>} The PR number.
+ */
+async function findPullRequestNumber(config) {
+  // Get a list of PRs and see if one already exists.
+  const { data: listOfPullRequests } = await octokit.rest.pulls.list({
+    owner: config.owner,
+    repo: config.repo,
+    head: `${config.owner}:${config.head}`,
+  })
+
+  return listOfPullRequests[0]?.number
+}
+
+/**
+ * When this file was first created, we only introduced support for creating a pull request for some translation batch.
+ * However, some of our first workflow runs failed during the pull request creation due to a timeout error.
+ * There have been cases where, despite the timeout error, the pull request gets created _anyway_.
+ * To accommodate this reality, we created this function to look for an existing pull request before a new one is created.
+ * Although the "find" check is redundant in the first "cycle", it's designed this way to recursively call the function again via its retry mechanism should that be necessary.
+ *
+ * @param {object} config Configuration options for creating the pull request.
+ * @returns {Promise<number>} The PR number.
+ */
+async function findOrCreatePullRequest(config) {
+  const found = await findPullRequestNumber(config)
+
+  if (found) {
+    return found
+  }
+
+  try {
+    const { data: pullRequest } = await octokit.rest.pulls.create({
+      owner: config.owner,
+      repo: config.repo,
+      base: config.base,
+      head: config.head,
+      title: config.title,
+      body: config.body,
+      draft: false,
+    })
+
+    return pullRequest.number
+  } catch (error) {
+    if (!error.response || !config.retryCount) {
+      throw error
+    }
+
+    if (!config.retryStatuses.includes(error.response.status)) {
+      throw error
+    }
+
+    console.error(`Error creating pull request: ${error.message}`)
+    console.warn(`Retrying in 5 seconds...`)
+    await new Promise((resolve) => setTimeout(resolve, 5000))
+
+    config.retryCount -= 1
+
+    return findOrCreatePullRequest(config)
+  }
+}
+
+/**
+ * @param {object} config Configuration options for labeling the PR
+ * @returns {Promise<undefined>}
+ */
+// async function labelPullRequest(config) {
+//   await octokit.rest.issues.update({
+//     owner: config.owner,
+//     repo: config.repo,
+//     issue_number: config.issue_number,
+//     labels: config.labels,
+//   })
+// }
+
+async function main() {
+  const options = {
+    title: TITLE,
+    base: BASE,
+    head: HEAD,
+    body: fs.readFileSync(BODY_FILE, 'utf8'),
+    labels: ['translation-batch', `translation-batch-${LANGUAGE}`],
+    owner: OWNER,
+    repo: REPO,
+    retryStatuses: RETRY_STATUSES,
+    retryCount: RETRY_ATTEMPTS,
+  }
+
+  options.issue_number = await findOrCreatePullRequest(options)
+  const pr = `${GITHUB_REPOSITORY}#${options.issue_number}`
+  console.log(`Created PR ${pr}`)
+
+  // metadata parameters aren't currently available in `github.rest.pulls.create`,
+  // but they are in `github.rest.issues.update`.
+  // await labelPullRequest(options)
+  // console.log(`Updated ${pr} with these labels: ${options.labels.join(', ')}`)
+}
+
+main()