fix: another pass of refactoring

env and blob commands

Co-authored-by: Thomas Lane <163203257+tlane25@users.noreply.github.com>
Co-authored-by: Thomas Lane <tlane25@users.noreply.github.com>

src/commands/blobs/blobs-delete.ts

@@ -1,12 +1,17 @@
 import { getStore } from '@netlify/blobs'
 
 import { chalk, error as printError, log } from '../../utils/command-helpers.js'
-import { blobDeletePrompts } from '../../utils/prompts/blob-delete-prompts.js'
+import { promptBlobDelete } from '../../utils/prompts/blob-delete-prompts.js'
 
 /**
  * The blobs:delete command
  */
 export const blobsDelete = async (storeName: string, key: string, _options: Record<string, unknown>, command: any) => {
+  // Prevents prompts from blocking scripted commands
+  if (command.scriptedCommand) {
+    _options.force = true
+  }
+
   const { api, siteInfo } = command.netlify
   const { force } = _options
 
@@ -18,7 +23,7 @@ export const blobsDelete = async (storeName: string, key: string, _options: Reco
   })
 
   if (force === undefined) {
-    await blobDeletePrompts(key, storeName)
+    await promptBlobDelete(key, storeName)
   }
 
   try {

src/commands/blobs/blobs-set.ts

@@ -20,9 +20,8 @@ export const blobsSet = async (
   options: Options,
   command: BaseCommand,
 ) => {
-
   // Prevents prompts from blocking scripted commands
-  if (command.scriptedCommand){
+  if (command.scriptedCommand) {
     options.force = true
   }
 

src/commands/env/env-clone.ts

@@ -56,9 +56,8 @@ const cloneEnvVars = async ({ api, force, siteFrom, siteTo }): Promise<boolean>
 }
 
 export const envClone = async (options: OptionValues, command: BaseCommand) => {
-
   // Prevents prompts from blocking scripted commands
-  if (command.scriptedCommand){
+  if (command.scriptedCommand) {
     options.force = true
   }
 

src/commands/env/env-set.ts

@@ -116,9 +116,8 @@ const setInEnvelope = async ({ api, context, force, key, scope, secret, siteInfo
 }
 
 export const envSet = async (key: string, value: string, options: OptionValues, command: BaseCommand) => {
-
   // Prevents prompts from blocking scripted commands
-  if (command.scriptedCommand){
+  if (command.scriptedCommand) {
     options.force = true
   }
 

src/commands/env/env-unset.ts

@@ -2,7 +2,7 @@ import { OptionValues } from 'commander'
 
 import { chalk, log, logJson, exit } from '../../utils/command-helpers.js'
 import { AVAILABLE_CONTEXTS, translateFromEnvelopeToMongo } from '../../utils/env/index.js'
-import { promptOverwriteEnvVariable } from '../../utils/prompts/unset-set-prompts.js'
+import { promptOverwriteEnvVariable } from '../../utils/prompts/env-unset-prompts.js'
 import BaseCommand from '../base-command.js'
 /**
  * Deletes a given key from the env of a site configured with Envelope
@@ -68,9 +68,8 @@ const unsetInEnvelope = async ({ api, context, force, key, siteInfo }) => {
 }
 
 export const envUnset = async (key: string, options: OptionValues, command: BaseCommand) => {
-
   // Prevents prompts from blocking scripted commands
-  if (command.scriptedCommand){
+  if (command.scriptedCommand) {
     options.force = true
   }
 

src/utils/prompts/blob-delete-prompts.ts

@@ -1,19 +1,17 @@
-import { chalk, log } from '../command-helpers.js'
+import { log } from '../command-helpers.js'
 
 import { confirmPrompt } from './confirm-prompt.js'
+import { destructiveCommandMessages } from './prompt-messages.js'
+
+export const promptBlobDelete = async (key: string, storeName: string): Promise<void> => {
+  const { overwriteNoticeMessage } = destructiveCommandMessages
+  const { generateWarningMessage, overwriteConfirmationMessage } = destructiveCommandMessages.blobDelete
+
+  const warningMessage = generateWarningMessage(key, storeName)
 
-const generateBlobWarningMessage = (key: string, storeName: string): void => {
   log()
-  log(
-    `${chalk.redBright('Warning')}: The following blob key ${chalk.cyan(key)} will be deleted from store ${chalk.cyan(
-      storeName,
-    )}:`,
-  )
+  log(warningMessage)
   log()
-  log(`${chalk.yellowBright('Notice')}: To overwrite without this warning, you can use the --force flag.`)
-}
-
-export const blobDeletePrompts = async (key: string, storeName: string): Promise<void> => {
-  generateBlobWarningMessage(key, storeName)
-  await confirmPrompt('Do you want to proceed with deleting the value at this key?')
+  log(overwriteNoticeMessage)
+  await confirmPrompt(overwriteConfirmationMessage)
 }

src/utils/prompts/confirm-prompt.ts

@@ -4,14 +4,14 @@ import { log, exit } from '../command-helpers.js'
 
 export const confirmPrompt = async (message: string): Promise<void> => {
   try {
-    const { wantsToSet } = await inquirer.prompt({
+    const { confirm } = await inquirer.prompt({
       type: 'confirm',
-      name: 'wantsToSet',
+      name: 'confirm',
       message,
       default: false,
     })
     log()
-    if (!wantsToSet) {
+    if (!confirm) {
       exit()
     }
   } catch (error) {

src/utils/prompts/env-clone-prompt.ts

@@ -26,7 +26,9 @@ export async function promptEnvCloneOverwrite(siteId: string, existingEnvVars: E
   log()
   log(noticeEnvVarsMessage)
   log()
-  existingEnvVarKeys.forEach(log)
+  existingEnvVarKeys.forEach((envVar) => {
+    log(envVar)
+  })
   log()
   log(overwriteNoticeMessage)
 

src/utils/prompts/prompt-messages.ts

@@ -1,5 +1,4 @@
 import { chalk } from '../command-helpers.js'
-import { EnvVar } from '../types.js'
 
 export const destructiveCommandMessages = {
   overwriteNoticeMessage: `${chalk.yellowBright(
@@ -12,6 +11,14 @@ export const destructiveCommandMessages = {
     overwriteConfirmationMessage: 'Do you want to proceed with overwriting this blob key existing value?',
   },
 
+  blobDelete: {
+    generateWarningMessage: (key: string, storeName: string) =>
+      `${chalk.redBright('Warning')}: The following blob key ${chalk.cyan(key)} will be deleted from store ${chalk.cyan(
+        storeName,
+      )}:`,
+    overwriteConfirmationMessage: 'Do you want to proceed with deleting the value at this key?',
+  },
+
   envSet: {
     generateWarningMessage: (variableName: string) =>
       `${chalk.redBright('Warning')}: The environment variable ${chalk.bgBlueBright(variableName)} already exists.`,

tests/integration/commands/blobs/blobs-delete.test.ts

@@ -8,6 +8,7 @@ import { describe, expect, test, vi, beforeEach } from 'vitest'
 import BaseCommand from '../../../../src/commands/base-command.js'
 import { createBlobsCommand } from '../../../../src/commands/blobs/blobs.js'
 import { log } from '../../../../src/utils/command-helpers.js'
+import { destructiveCommandMessages } from '../../../../src/utils/prompts/prompt-messages.js'
 import { Route } from '../../utils/mock-api-vitest.js'
 import { getEnvironmentVariables, withMockApi } from '../../utils/mock-api.js'
 
@@ -44,13 +45,10 @@ describe('blob:delete command', () => {
   const storeName = 'my-store'
   const key = 'my-key'
 
-  const warningMessage = `${chalk.redBright('Warning')}: The following blob key ${chalk.cyan(
-    key,
-  )} will be deleted from store ${chalk.cyan(storeName)}:`
+  const { overwriteNoticeMessage } = destructiveCommandMessages
+  const { generateWarningMessage, overwriteConfirmationMessage } = destructiveCommandMessages.blobDelete
 
-  const noticeMessage = `${chalk.yellowBright(
-    'Notice',
-  )}: To overwrite without this warning, you can use the --force flag.`
+  const warningMessage = generateWarningMessage(key, storeName)
 
   const successMessage = `${chalk.greenBright('Success')}: Blob ${chalk.yellow(key)} deleted from store ${chalk.yellow(
     storeName,
@@ -73,19 +71,19 @@ describe('blob:delete command', () => {
       const program = new BaseCommand('netlify')
       createBlobsCommand(program)
 
-      const promptSpy = vi.spyOn(inquirer, 'prompt').mockResolvedValue({ wantsToSet: true })
+      const promptSpy = vi.spyOn(inquirer, 'prompt').mockResolvedValue({ confirm: true })
 
       await program.parseAsync(['', '', 'blob:delete', storeName, key])
 
       expect(promptSpy).toHaveBeenCalledWith({
         type: 'confirm',
-        name: 'wantsToSet',
-        message: expect.stringContaining('Do you want to proceed with deleting the value at this key?'),
+        name: 'confirm',
+        message: expect.stringContaining(overwriteConfirmationMessage),
         default: false,
       })
 
       expect(log).toHaveBeenCalledWith(warningMessage)
-      expect(log).toHaveBeenCalledWith(noticeMessage)
+      expect(log).toHaveBeenCalledWith(overwriteNoticeMessage)
       expect(log).toHaveBeenCalledWith(successMessage)
     })
   })
@@ -103,7 +101,7 @@ describe('blob:delete command', () => {
       const program = new BaseCommand('netlify')
       createBlobsCommand(program)
 
-      const promptSpy = vi.spyOn(inquirer, 'prompt').mockResolvedValue({ wantsToSet: false })
+      const promptSpy = vi.spyOn(inquirer, 'prompt').mockResolvedValue({ confirm: false })
 
       try {
         await program.parseAsync(['', '', 'blob:delete', storeName, key])
@@ -114,13 +112,13 @@ describe('blob:delete command', () => {
 
       expect(promptSpy).toHaveBeenCalledWith({
         type: 'confirm',
-        name: 'wantsToSet',
-        message: expect.stringContaining('Do you want to proceed with deleting the value at this key?'),
+        name: 'confirm',
+        message: expect.stringContaining(overwriteConfirmationMessage),
         default: false,
       })
 
       expect(log).toHaveBeenCalledWith(warningMessage)
-      expect(log).toHaveBeenCalledWith(noticeMessage)
+      expect(log).toHaveBeenCalledWith(overwriteNoticeMessage)
       expect(log).not.toHaveBeenCalledWith(successMessage)
     })
   })
@@ -145,7 +143,7 @@ describe('blob:delete command', () => {
       expect(promptSpy).not.toHaveBeenCalled()
 
       expect(log).not.toHaveBeenCalledWith(warningMessage)
-      expect(log).not.toHaveBeenCalledWith(noticeMessage)
+      expect(log).not.toHaveBeenCalledWith(overwriteNoticeMessage)
       expect(log).toHaveBeenCalledWith(successMessage)
     })
   })
@@ -176,7 +174,7 @@ describe('blob:delete command', () => {
       expect(promptSpy).not.toHaveBeenCalled()
 
       expect(log).not.toHaveBeenCalledWith(warningMessage)
-      expect(log).not.toHaveBeenCalledWith(noticeMessage)
+      expect(log).not.toHaveBeenCalledWith(overwriteNoticeMessage)
       expect(log).not.toHaveBeenCalledWith(successMessage)
     })
   })

tests/integration/commands/blobs/blobs-set.test.ts

@@ -105,13 +105,13 @@ describe('blob:set command', () => {
       const program = new BaseCommand('netlify')
       createBlobsCommand(program)
 
-      const promptSpy = vi.spyOn(inquirer, 'prompt').mockResolvedValue({ wantsToSet: true })
+      const promptSpy = vi.spyOn(inquirer, 'prompt').mockResolvedValue({ confirm: true })
 
       await program.parseAsync(['', '', 'blob:set', storeName, key, newValue])
 
       expect(promptSpy).toHaveBeenCalledWith({
         type: 'confirm',
-        name: 'wantsToSet',
+        name: 'confirm',
         message: expect.stringContaining(overwriteConfirmationMessage),
         default: false,
       })
@@ -139,7 +139,7 @@ describe('blob:set command', () => {
       const program = new BaseCommand('netlify')
       createBlobsCommand(program)
 
-      const promptSpy = vi.spyOn(inquirer, 'prompt').mockResolvedValue({ wantsToSet: false })
+      const promptSpy = vi.spyOn(inquirer, 'prompt').mockResolvedValue({ confirm: false })
 
       try {
         await program.parseAsync(['', '', 'blob:set', storeName, key, newValue])
@@ -150,7 +150,7 @@ describe('blob:set command', () => {
 
       expect(promptSpy).toHaveBeenCalledWith({
         type: 'confirm',
-        name: 'wantsToSet',
+        name: 'confirm',
         message: expect.stringContaining(overwriteConfirmationMessage),
         default: false,
       })

tests/integration/commands/env/env-clone.test.ts

@@ -45,13 +45,13 @@ describe('env:clone command', () => {
         const program = new BaseCommand('netlify')
         createEnvCommand(program)
 
-        const promptSpy = vi.spyOn(inquirer, 'prompt').mockResolvedValue({ wantsToSet: true })
+        const promptSpy = vi.spyOn(inquirer, 'prompt').mockResolvedValue({ confirm: true })
 
         await program.parseAsync(['', '', 'env:clone', '-t', siteIdTwo])
 
         expect(promptSpy).toHaveBeenCalledWith({
           type: 'confirm',
-          name: 'wantsToSet',
+          name: 'confirm',
           message: expect.stringContaining(overwriteConfirmationMessage),
           default: false,
         })
@@ -96,7 +96,7 @@ describe('env:clone command', () => {
         const program = new BaseCommand('netlify')
         createEnvCommand(program)
 
-        const promptSpy = vi.spyOn(inquirer, 'prompt').mockResolvedValue({ wantsToSet: false })
+        const promptSpy = vi.spyOn(inquirer, 'prompt').mockResolvedValue({ confirm: false })
 
         try {
           await program.parseAsync(['', '', 'env:clone', '-t', siteIdTwo])