Merge branch 'main' into dependabot-preview-shutdown

Author: saritai

lib/redis-accessor.js

@@ -8,7 +8,13 @@ const { CI, NODE_ENV, REDIS_URL } = process.env
 const useRealRedis = !CI && NODE_ENV !== 'test' && !!REDIS_URL
 
 class RedisAccessor {
-  constructor ({ databaseNumber = 0, prefix = null, allowSetFailures = false, name = null } = {}) {
+  constructor ({
+    databaseNumber = 0,
+    prefix = null,
+    allowSetFailures = false,
+    allowGetFailures = false,
+    name = null
+  } = {}) {
     const redisClient = useRealRedis
       ? createRedisClient({
           url: REDIS_URL,
@@ -23,6 +29,9 @@ class RedisAccessor {
 
     // Allow for graceful failures if a Redis SET operation fails?
     this._allowSetFailures = allowSetFailures === true
+
+    // Allow for graceful failures if a Redis GET operation fails?
+    this._allowGetFailures = allowGetFailures === true
   }
 
   /** @private */
@@ -105,8 +114,24 @@ Error: ${err.message}`
 
   async get (key) {
     const getAsync = promisify(this._client.get).bind(this._client)
-    const value = await getAsync(this.prefix(key))
-    return value
+    const fullKey = this.prefix(key)
+
+    try {
+      const value = await getAsync(fullKey)
+      return value
+    } catch (err) {
+      const errorText = `Failed to get value from Redis.
+Key: ${fullKey}
+Error: ${err.message}`
+
+      if (this._allowGetFailures === true) {
+        // Allow for graceful failure
+        console.error(errorText)
+        return null
+      }
+
+      throw new Error(errorText)
+    }
   }
 }
 

middleware/render-page.js

@@ -17,6 +17,8 @@ const pageCache = new RedisAccessor({
   prefix: (HEROKU_RELEASE_VERSION ? HEROKU_RELEASE_VERSION + ':' : '') + 'rp',
   // Allow for graceful failures if a Redis SET operation fails
   allowSetFailures: true,
+  // Allow for graceful failures if a Redis GET operation fails
+  allowGetFailures: true,
   name: 'page-cache'
 })
 

script/rest/update-files.js

@@ -59,7 +59,7 @@ async function getDereferencedFiles () {
 
   console.log(`\n🏃‍♀️🏃🏃‍♀️Running \`bin/openapi bundle\` in branch '${githubBranch}' of your github/github checkout to generate the dereferenced OpenAPI schema files.\n`)
   try {
-    execSync(`${path.join(githubRepoDir, 'bin/openapi')} bundle -o ${tempDocsDir}`, { stdio: 'inherit' })
+    execSync(`${path.join(githubRepoDir, 'bin/openapi')} bundle -o ${tempDocsDir} --include_unpublished`, { stdio: 'inherit' })
   } catch (error) {
     console.error(error)
     console.log('🛑 Whoops! It looks like the `bin/openapi bundle` command failed to run in your `github/github` repository checkout. To troubleshoot, ensure that your OpenAPI schema YAML is formatted correctly. A CI test runs on your `github/github` PR that flags malformed YAML. You can check the PR diff view for comments left by the openapi CI test to find and fix any formatting errors.')

tests/meta/repository-references.js

@@ -57,7 +57,13 @@ describe('check for repository references', () => {
       'lib/excluded-links.js',
       'content/early-access',
       'data/early-access',
-      'data/release-notes' // These include links to internal issues in Liquid comments
+      'data/release-notes', // These include links to internal issues in Liquid comments.
+      '**/*.png', // Do not check images or font files.
+      '**/*.jpg', // We could just put all of assets/* here, but that would prevent any
+      '**/*.gif', // READMEs or other text-based files from being checked.
+      '**/*.pdf',
+      '**/*.ico',
+      '**/*.woff'
     ]
   })
 

tests/unit/redis-accessor.js

@@ -11,13 +11,25 @@ describe('RedisAccessor', () => {
 
   test('has expected instance properties', async () => {
     const instance = new RedisAccessor()
-    expect(Object.keys(instance).sort()).toEqual(['_allowSetFailures', '_client', '_prefix'])
+    expect(Object.keys(instance).sort()).toEqual(['_allowGetFailures', '_allowSetFailures', '_client', '_prefix'])
   })
 
   test('has expected static methods', async () => {
     expect(typeof RedisAccessor.translateSetArguments).toBe('function')
   })
 
+  describe('#_allowGetFailures property', () => {
+    test('defaults to false', async () => {
+      const instance = new RedisAccessor()
+      expect(instance._allowGetFailures).toBe(false)
+    })
+
+    test('is expected value', async () => {
+      const instance = new RedisAccessor({ allowGetFailures: true })
+      expect(instance._allowGetFailures).toBe(true)
+    })
+  })
+
   describe('#_allowSetFailures property', () => {
     test('defaults to false', async () => {
       const instance = new RedisAccessor()
@@ -299,5 +311,45 @@ Error: Redis ReplyError`
 
       expect(callbackSpy).toHaveBeenCalledWith(null, 'myValue')
     })
+
+    test('resolves to null if Redis replies with an error and `allowGetFailures` option is set to true', async () => {
+      // Temporarily override `console.error`
+      const consoleErrorSpy = jest.spyOn(console, 'error').mockImplementation()
+
+      const instance = new RedisAccessor({ prefix: 'myPrefix', allowGetFailures: true })
+      instance._client.get = jest.fn((...args) => args.pop()(new Error('Redis ReplyError')))
+
+      const result = await instance.get('myKey', 'myValue')
+
+      expect(result).toBe(null)
+      expect(consoleErrorSpy).toBeCalledWith(
+        `Failed to get value from Redis.
+Key: myPrefix:myKey
+Error: Redis ReplyError`
+      )
+
+      // Restore `console.error`
+      consoleErrorSpy.mockRestore()
+    })
+
+    test('rejects if Redis replies with an error and `allowGetFailures` option is not set to true', async () => {
+      // Temporarily override `console.error`
+      const consoleErrorSpy = jest.spyOn(console, 'error').mockImplementation()
+
+      const instance = new RedisAccessor({ prefix: 'myPrefix' })
+      instance._client.get = jest.fn((...args) => args.pop()(new Error('Redis ReplyError')))
+
+      await expect(instance.get('myKey')).rejects.toThrowError(
+        new Error(`Failed to get value from Redis.
+Key: myPrefix:myKey
+Error: Redis ReplyError`
+        )
+      )
+
+      expect(consoleErrorSpy).not.toBeCalled()
+
+      // Restore `console.error`
+      consoleErrorSpy.mockRestore()
+    })
   })
 })