Merge pull request #20017 from github/upgrade-esm

Enforce and Move to Top Level require

Author: gracepark

lib/frontmatter.js

@@ -1,8 +1,12 @@
 const parse = require('./read-frontmatter')
-const layoutNames = Object.keys(require('./layouts')).concat([false])
+const semver = require('semver')
+const layouts = require('./layouts')
+
+const semverValidRange = semver.validRange
+const layoutNames = Object.keys(layouts).concat([false])
 const semverRange = {
   type: 'string',
-  conform: require('semver').validRange,
+  conform: semverValidRange,
   message: 'Must be a valid SemVer range'
 }
 const versionIds = Object.keys(require('./all-versions'))

lib/redirects/permalinks.js

@@ -1,6 +1,7 @@
 const path = require('path')
 const patterns = require('../patterns')
-const supportedVersions = new Set(Object.keys(require('../all-versions')))
+const allVersions = require('../all-versions')
+const supportedVersions = new Set(Object.keys(allVersions))
 const getOldPathsFromPermalink = require('./get-old-paths-from-permalink')
 const { getVersionStringFromPath } = require('../path-utils')
 const { getNewVersionedPath } = require('../old-versions-utils')

lib/rest/index.js

@@ -6,7 +6,7 @@ const operations = {}
 fs.readdirSync(schemasPath)
   .forEach(filename => {
     const key = filename.replace('.json', '')
-    const value = require(path.join(schemasPath, filename))
+    const value = JSON.parse(fs.readFileSync(path.join(schemasPath, filename)))
     operations[key] = value
   })
 const allVersions = require('../all-versions')

lib/webhooks/index.js

@@ -19,7 +19,7 @@ versions.forEach(version => {
       // payload file: /path/to/check_run.completed.payload.json
       // payload path: check_run.completed
       const payloadPath = path.basename(payloadFile).replace('.payload.json', '')
-      set(payloadsPerVersion, payloadPath, formatAsJsonCodeBlock(require(payloadFile)))
+      set(payloadsPerVersion, payloadPath, formatAsJsonCodeBlock(JSON.parse(fs.readFileSync(payloadFile))))
     })
 
   payloads[version] = payloadsPerVersion

middleware/contextualizers/graphql.js

@@ -1,3 +1,5 @@
+const fs = require('fs')
+const path = require('path')
 const previews = require('../../lib/graphql/static/previews')
 const upcomingChanges = require('../../lib/graphql/static/upcoming-changes')
 const changelog = require('../../lib/graphql/static/changelog')
@@ -23,7 +25,7 @@ module.exports = function graphqlContext (req, res, next) {
   const graphqlVersion = currentVersionObj.miscVersionName
 
   req.context.graphql = {
-    schemaForCurrentVersion: require(`../../lib/graphql/static/schema-${graphqlVersion}`),
+    schemaForCurrentVersion: JSON.parse(fs.readFileSync(path.join(process.cwd(), `lib/graphql/static/schema-${graphqlVersion}.json`))),
     previewsForCurrentVersion: previews[graphqlVersion],
     upcomingChangesForCurrentVersion: upcomingChanges[graphqlVersion],
     prerenderedObjectsForCurrentVersion: prerenderedObjects[graphqlVersion],

middleware/csrf.js

@@ -1,4 +1,6 @@
+const cookieSettings = require('../lib/cookie-settings')
+
 module.exports = require('csurf')({
-  cookie: require('../lib/cookie-settings'),
+  cookie: cookieSettings,
   ignoreMethods: ['GET', 'HEAD', 'OPTIONS']
 })

middleware/index.js

@@ -1,6 +1,26 @@
 const express = require('express')
 const instrument = require('../lib/instrument-middleware')
 const haltOnDroppedConnection = require('./halt-on-dropped-connection')
+const abort = require('./abort')
+const timeout = require('./timeout')
+const morgan = require('morgan')
+const datadog = require('./connect-datadog')
+const rateLimit = require('./rate-limit')
+const cors = require('./cors')
+const helmet = require('helmet')
+const csp = require('./csp')
+const cookieParser = require('./cookie-parser')
+const csrf = require('./csrf')
+const handleCsrfErrors = require('./handle-csrf-errors')
+const compression = require('compression')
+const disableCachingOnSafari = require('./disable-caching-on-safari')
+const setFastlySurrogateKey = require('./set-fastly-surrogate-key')
+const setFastlyCacheHeaders = require('./set-fastly-cache-headers')
+const catchBadAcceptLanguage = require('./catch-bad-accept-language')
+const reqUtils = require('./req-utils')
+const recordRedirect = require('./record-redirect')
+const connectSlashes = require('connect-slashes')
+const handleErrors = require('./handle-errors')
 
 const { NODE_ENV } = process.env
 const isDevelopment = NODE_ENV === 'development'
@@ -15,58 +35,57 @@ const asyncMiddleware = fn =>
 
 module.exports = function (app) {
   // *** Request connection management ***
-  if (!isTest) app.use(require('./timeout'))
-  app.use(require('./abort'))
+  if (!isTest) app.use(timeout)
+  app.use(abort)
 
   // *** Development tools ***
-  app.use(require('morgan')('dev', { skip: (req, res) => !isDevelopment }))
-  if (isDevelopment) app.use(require('./webpack'))
+  app.use(morgan('dev', { skip: (req, res) => !isDevelopment }))
 
   // *** Observability ***
   if (process.env.DD_API_KEY) {
-    app.use(require('./connect-datadog'))
+    app.use(datadog)
   }
 
   // *** Early exits ***
   // Don't use the proxy's IP, use the requester's for rate limiting
   // See https://expressjs.com/en/guide/behind-proxies.html
   app.set('trust proxy', 1)
-  app.use(require('./rate-limit'))
+  app.use(rateLimit)
   app.use(instrument('./handle-invalid-paths'))
   app.use(instrument('./handle-next-data-path'))
 
   // *** Security ***
-  app.use(require('./cors'))
-  app.use(require('helmet')({
+  app.use(cors)
+  app.use(helmet({
     // Override referrerPolicy to match the browser's default: "strict-origin-when-cross-origin".
     // Helmet now defaults to "no-referrer", which is a problem for our archived assets proxying.
     referrerPolicy: {
       policy: 'strict-origin-when-cross-origin'
     }
   }))
-  app.use(require('./csp')) // Must come after helmet
-  app.use(require('./cookie-parser')) // Must come before csrf
+  app.use(csp) // Must come after helmet
+  app.use(cookieParser) // Must come before csrf
   app.use(express.json()) // Must come before csrf
-  app.use(require('./csrf'))
-  app.use(require('./handle-csrf-errors')) // Must come before regular handle-errors
+  app.use(csrf)
+  app.use(handleCsrfErrors) // Must come before regular handle-errors
 
   // *** Headers ***
   app.set('etag', false) // We will manage our own ETags if desired
-  app.use(require('compression')())
-  app.use(require('./disable-caching-on-safari'))
-  app.use(require('./set-fastly-surrogate-key'))
-  app.use(require('./catch-bad-accept-language'))
+  app.use(compression())
+  app.use(disableCachingOnSafari)
+  app.use(setFastlySurrogateKey)
+  app.use(catchBadAcceptLanguage)
 
   // *** Config and context for redirects ***
-  app.use(require('./req-utils')) // Must come before record-redirect and events
-  app.use(require('./record-redirect'))
+  app.use(reqUtils) // Must come before record-redirect and events
+  app.use(recordRedirect)
   app.use(instrument('./detect-language')) // Must come before context, breadcrumbs, find-page, handle-errors, homepages
   app.use(asyncMiddleware(instrument('./context'))) // Must come before early-access-*, handle-redirects
   app.use(asyncMiddleware(instrument('./contextualizers/short-versions'))) // Support version shorthands
 
   // *** Redirects, 3xx responses ***
   // I ordered these by use frequency
-  app.use(require('connect-slashes')(false))
+  app.use(connectSlashes(false))
   app.use(instrument('./redirects/external'))
   app.use(instrument('./redirects/help-to-docs'))
   app.use(instrument('./redirects/language-code-redirects')) // Must come before contextualizers
@@ -132,7 +151,7 @@ module.exports = function (app) {
   app.use(asyncMiddleware(instrument('./is-next-request')))
 
   // *** Headers for pages only ***
-  app.use(require('./set-fastly-cache-headers'))
+  app.use(setFastlyCacheHeaders)
 
   // handle serving NextJS bundled code (/_next/*)
   if (process.env.FEATURE_NEXTJS) {
@@ -146,5 +165,5 @@ module.exports = function (app) {
   app.get('/*', asyncMiddleware(instrument('./render-page')))
 
   // *** Error handling, must go last ***
-  app.use(require('./handle-errors'))
+  app.use(handleErrors)
 }

middleware/search.js

@@ -1,6 +1,8 @@
 const express = require('express')
-const languages = new Set(Object.keys(require('../lib/languages')))
-const versions = new Set(Object.values(require('../lib/search/versions')))
+const libLanguages = require('../lib/languages')
+const searchVersions = require('../lib/search/versions')
+const languages = new Set(Object.keys(libLanguages))
+const versions = new Set(Object.values(searchVersions))
 const loadLunrResults = require('../lib/search/lunr-search')
 const loadAlgoliaResults = require('../lib/search/algolia-search')
 

middleware/webpack.js

@@ -57,8 +57,8 @@
     "lodash": "^4.17.21",
     "lunr": "^2.3.9",
     "lunr-languages": "^1.4.0",
-    "mdast-util-to-string": "^2.0.0",
     "mdast-util-from-markdown": "^0.8.5",
+    "mdast-util-to-string": "^2.0.0",
     "morgan": "^1.10.0",
     "next": "^11.0.0",
     "node-fetch": "^2.6.1",
@@ -175,7 +175,6 @@
     "url-template": "^2.0.8",
     "webpack": "^5.37.0",
     "webpack-cli": "^4.7.0",
-    "webpack-dev-middleware": "^4.2.0",
     "website-scraper": "^4.2.3"
   },
   "optionalDependencies": {

package-lock.json

@@ -63,7 +63,7 @@ async function main () {
   fs.writeFileSync(newDereferencedFile, newDereferenceContent)
   console.log(`Created ${newDereferencedFile}.`)
 
-  const dereferencedSchema = require(path.join(process.cwd(), newDereferencedFile))
+  const dereferencedSchema = JSON.parse(fs.readFileSync(path.join(process.cwd(), newDereferencedFile)))
 
   // Store all operations in an array of operation objects
   const operations = await getOperations(dereferencedSchema)

package.json

@@ -1,5 +1,7 @@
+const dotenv = require('dotenv')
+
 if (!process.env.GITHUB_TOKEN) {
-  require('dotenv').config()
+  dotenv.config()
 }
 
 // this module needs to work in development, production, and GitHub Actions

script/enterprise-server-releases/create-rest-files.js

@@ -3,8 +3,10 @@
 const fs = require('fs')
 const path = require('path')
 const walk = require('walk-sync')
-const slugger = new (require('github-slugger'))()
-const entities = new (require('html-entities').XmlEntities)()
+const GithubSlugger = require('github-slugger')
+const htmlEntities = require('html-entities')
+const slugger = new GithubSlugger()
+const entities = new htmlEntities.XmlEntities()
 const frontmatter = require('../lib/read-frontmatter')
 const { execSync } = require('child_process')
 const addRedirectToFrontmatter = require('./helpers/add-redirect-to-frontmatter')

script/helpers/github.js

@@ -1,5 +1,6 @@
 #!/usr/bin/env node
-
+const fs = require('fs')
+const path = require('path')
 const glob = require('glob')
 const program = require('commander')
 const getOperations = require('./utils/get-operations')
@@ -28,8 +29,7 @@ if (filesToCheck.length) {
 
 async function check (files) {
   console.log('Verifying OpenAPI files are valid with decorator')
-
-  const documents = files.map(filename => [filename, require(filename)])
+  const documents = files.map(filename => [filename, JSON.parse(fs.readFileSync(path.join(process.cwd(), filename)))])
 
   for (const [filename, schema] of documents) {
     try {

script/reconcile-filenames-with-ids.js

@@ -75,7 +75,7 @@ async function getDereferencedFiles () {
   // name of the `github/github` checkout. A CI test
   // checks the version and fails if it's not a semantic version.
   schemas.forEach(filename => {
-    const schema = require(path.join(dereferencedPath, filename))
+    const schema = JSON.parse(fs.readFileSync(path.join(dereferencedPath, filename)))
     schema.info.version = `${githubBranch} !!DEVELOPMENT MODE - DO NOT MERGE!!`
     fs.writeFileSync(path.join(dereferencedPath, filename), JSON.stringify(schema, null, 2))
   })
@@ -85,7 +85,7 @@ async function decorate () {
   console.log('\n🎄 Decorating the OpenAPI schema files in lib/rest/static/dereferenced.\n')
 
   const dereferencedSchemas = schemas.reduce((acc, filename) => {
-    const schema = require(path.join(dereferencedPath, filename))
+    const schema = JSON.parse(fs.readFileSync(path.join(dereferencedPath, filename)))
     const key = filename.replace('.deref.json', '')
     return { ...acc, [key]: schema }
   }, {})

script/rest/openapi-check.js

@@ -1,10 +1,12 @@
 const { get, flatten, isPlainObject } = require('lodash')
 const { sentenceCase } = require('change-case')
-const slugger = new (require('github-slugger'))()
+const GitHubSlugger = require('github-slugger')
+const slugger = new GitHubSlugger()
 const httpStatusCodes = require('http-status-code')
 const renderContent = require('../../../lib/render-content')
 const createCodeSamples = require('./create-code-samples')
 const Ajv = require('ajv')
+const operationSchema = require('./operation-schema')
 
 // titles that can't be derived by sentence-casing the ID
 const categoryTitles = { scim: 'SCIM' }
@@ -39,7 +41,7 @@ module.exports = class Operation {
   }
 
   get schema () {
-    return require('./operation-schema')
+    return operationSchema
   }
 
   async process () {

script/rest/update-files.js

@@ -6,13 +6,13 @@
 // It can also be run manually. For more info see [contributing/search.md](contributing/search.md)
 //
 // [end-readme]
-
+const searchSync = require('./search/sync')
 require('make-promises-safe')
 
 main()
 
 async function main () {
-  const sync = require('./search/sync')
+  const sync = searchSync
   const opts = {
     dryRun: 'DRY_RUN' in process.env,
     language: process.env.LANGUAGE,

script/rest/utils/operation.js

@@ -4,6 +4,9 @@ const throng = require('throng')
 const os = require('os')
 const portUsed = require('port-used')
 const prefixStreamWrite = require('./lib/prefix-stream-write')
+const libApp = require('./lib/app')
+const libWarmServer = require('./lib/warm-server')
+const http = require('http')
 
 // Intentionally require these for both cluster primary and workers
 require('./lib/check-node-version')
@@ -46,8 +49,8 @@ async function checkPortAvailability () {
 }
 
 async function startServer () {
-  const app = require('./lib/app')
-  const warmServer = require('./lib/warm-server')
+  const app = libApp
+  const warmServer = libWarmServer
 
   // If in a deployed environment...
   if (NODE_ENV === 'production') {
@@ -58,7 +61,7 @@ async function startServer () {
   }
 
   // Workaround for https://github.com/expressjs/express/issues/1101
-  const server = require('http').createServer(app)
+  const server = http.createServer(app)
   server
     .listen(port, () => console.log(`app running on http://localhost:${port}`))
     .on('error', () => server.close())

script/sync-search-indices.js

@@ -1,7 +1,10 @@
 /* global page, browser */
+const fs = require('fs')
+const path = require('path')
 const sleep = require('await-sleep')
 const { latest } = require('../../lib/enterprise-server-releases')
 const languages = require('../../lib/languages')
+const featureFlags = JSON.parse(fs.readFileSync(path.join(process.cwd(), '/feature-flags.json')))
 
 describe('homepage', () => {
   jest.setTimeout(60 * 1000)
@@ -329,7 +332,7 @@ describe('nextjs query param', () => {
   jest.setTimeout(60 * 1000)
 
   it('landing page renders through nextjs pipeline depending on FEATURE_NEXTJS value', async () => {
-    const flagVal = require('../../feature-flags.json').FEATURE_NEXTJS
+    const flagVal = featureFlags.FEATURE_NEXTJS
     await page.goto('http://localhost:4001/en/actions?nextjs=')
     const IS_NEXTJS_PAGE = await page.evaluate(() => window.IS_NEXTJS_PAGE)
     const nextWrapper = await page.$('#__next')