feat: add support for restricting recoverable deleted files via patterns (#1390)

Co-authored-by: GitHub Action <action@github.com>

src/changedFilesOutput.ts

@@ -5,9 +5,8 @@ import {
   getAllChangeTypeFiles,
   getChangeTypeFiles
 } from './changedFiles'
-import {DiffResult} from './commitSha'
 import {Inputs} from './inputs'
-import {getFilteredChangedFiles, recoverDeletedFiles, setOutput} from './utils'
+import {getFilteredChangedFiles, setOutput} from './utils'
 
 const getOutputKey = (key: string, outputPrefix: string): string => {
   return outputPrefix ? `${outputPrefix}_${key}` : key
@@ -16,15 +15,11 @@ const getOutputKey = (key: string, outputPrefix: string): string => {
 export const setChangedFilesOutput = async ({
   allDiffFiles,
   inputs,
-  workingDirectory,
-  diffResult,
   filePatterns = [],
   outputPrefix = ''
 }: {
   allDiffFiles: ChangedFiles
   inputs: Inputs
-  workingDirectory: string
-  diffResult?: DiffResult
   filePatterns?: string[]
   outputPrefix?: string
 }): Promise<void> => {
@@ -34,15 +29,6 @@ export const setChangedFilesOutput = async ({
   })
   core.debug(`All filtered diff files: ${JSON.stringify(allFilteredDiffFiles)}`)
 
-  if (diffResult) {
-    await recoverDeletedFiles({
-      inputs,
-      workingDirectory,
-      deletedFiles: allFilteredDiffFiles[ChangeTypeEnum.Deleted],
-      sha: diffResult.previousSha
-    })
-  }
-
   const addedFiles = await getChangeTypeFiles({
     inputs,
     changedFiles: allFilteredDiffFiles,

src/inputs.ts

@@ -38,6 +38,10 @@ export type Inputs = {
   outputRenamedFilesAsDeletedAndAdded: boolean
   recoverDeletedFiles: boolean
   recoverDeletedFilesToDestination: string
+  recoverFiles: string
+  recoverFilesSeparator: string
+  recoverFilesIgnore: string
+  recoverFilesIgnoreSeparator: string
   token: string
   apiUrl: string
   skipInitialFetch: boolean
@@ -153,6 +157,21 @@ export const getInputs = (): Inputs => {
     'recover_deleted_files_to_destination',
     {required: false}
   )
+  const recoverFiles = core.getInput('recover_files', {required: false})
+  const recoverFilesSeparator = core.getInput('recover_files_separator', {
+    required: false,
+    trimWhitespace: false
+  })
+  const recoverFilesIgnore = core.getInput('recover_files_ignore', {
+    required: false
+  })
+  const recoverFilesIgnoreSeparator = core.getInput(
+    'recover_files_ignore_separator',
+    {
+      required: false,
+      trimWhitespace: false
+    }
+  )
   const token = core.getInput('token', {required: false})
   const apiUrl = core.getInput('api_url', {required: false})
   const skipInitialFetch = core.getBooleanInput('skip_initial_fetch', {
@@ -186,6 +205,10 @@ export const getInputs = (): Inputs => {
     sinceLastRemoteCommit,
     recoverDeletedFiles,
     recoverDeletedFilesToDestination,
+    recoverFiles,
+    recoverFilesSeparator,
+    recoverFilesIgnore,
+    recoverFilesIgnoreSeparator,
     includeAllOldNewRenamedFiles,
     oldNewSeparator,
     oldNewFilesSeparator,

src/main.ts

@@ -2,6 +2,8 @@ import * as core from '@actions/core'
 import * as github from '@actions/github'
 import path from 'path'
 import {
+  ChangedFiles,
+  ChangeTypeEnum,
   getAllDiffFiles,
   getChangedFilesFromGithubAPI,
   getRenamedFiles
@@ -16,16 +18,65 @@ import {Env, getEnv} from './env'
 import {getInputs, Inputs} from './inputs'
 import {
   getFilePatterns,
+  getRecoverFilePatterns,
   getSubmodulePath,
   getYamlFilePatterns,
   hasLocalGitDirectory,
   isRepoShallow,
+  recoverDeletedFiles,
   setOutput,
   submoduleExists,
   updateGitGlobalConfig,
   verifyMinimumGitVersion
 } from './utils'
 
+const changedFilesOutput = async ({
+  filePatterns,
+  allDiffFiles,
+  inputs,
+  yamlFilePatterns
+}: {
+  filePatterns: string[]
+  allDiffFiles: ChangedFiles
+  inputs: Inputs
+  yamlFilePatterns: Record<string, string[]>
+}): Promise<void> => {
+  if (filePatterns.length > 0) {
+    core.startGroup('changed-files-patterns')
+    await setChangedFilesOutput({
+      allDiffFiles,
+      filePatterns,
+      inputs
+    })
+    core.info('All Done!')
+    core.endGroup()
+  }
+
+  if (Object.keys(yamlFilePatterns).length > 0) {
+    for (const key of Object.keys(yamlFilePatterns)) {
+      core.startGroup(`changed-files-yaml-${key}`)
+      await setChangedFilesOutput({
+        allDiffFiles,
+        filePatterns: yamlFilePatterns[key],
+        outputPrefix: key,
+        inputs
+      })
+      core.info('All Done!')
+      core.endGroup()
+    }
+  }
+
+  if (filePatterns.length === 0 && Object.keys(yamlFilePatterns).length === 0) {
+    core.startGroup('changed-files-all')
+    await setChangedFilesOutput({
+      allDiffFiles,
+      inputs
+    })
+    core.info('All Done!')
+    core.endGroup()
+  }
+}
+
 const getChangedFilesFromLocalGit = async ({
   inputs,
   env,
@@ -125,47 +176,30 @@ const getChangedFilesFromLocalGit = async ({
   core.info('All Done!')
   core.endGroup()
 
-  if (filePatterns.length > 0) {
-    core.startGroup('changed-files-patterns')
-    await setChangedFilesOutput({
-      allDiffFiles,
-      filePatterns,
-      inputs,
-      workingDirectory,
-      diffResult
-    })
-    core.info('All Done!')
-    core.endGroup()
-  }
+  if (inputs.recoverDeletedFiles) {
+    let recoverPatterns = getRecoverFilePatterns({inputs})
 
-  if (Object.keys(yamlFilePatterns).length > 0) {
-    for (const key of Object.keys(yamlFilePatterns)) {
-      core.startGroup(`changed-files-yaml-${key}`)
-      await setChangedFilesOutput({
-        allDiffFiles,
-        filePatterns: yamlFilePatterns[key],
-        outputPrefix: key,
-        inputs,
-        workingDirectory,
-        diffResult
-      })
-      core.info('All Done!')
-      core.endGroup()
+    if (recoverPatterns.length > 0 && filePatterns.length > 0) {
+      core.info('No recover patterns found; defaulting to file patterns')
+      recoverPatterns = filePatterns
     }
-  }
 
-  if (filePatterns.length === 0 && Object.keys(yamlFilePatterns).length === 0) {
-    core.startGroup('changed-files-all')
-    await setChangedFilesOutput({
-      allDiffFiles,
+    await recoverDeletedFiles({
       inputs,
       workingDirectory,
-      diffResult
+      deletedFiles: allDiffFiles[ChangeTypeEnum.Deleted],
+      recoverPatterns,
+      sha: diffResult.previousSha
     })
-    core.info('All Done!')
-    core.endGroup()
   }
 
+  await changedFilesOutput({
+    filePatterns,
+    allDiffFiles,
+    inputs,
+    yamlFilePatterns
+  })
+
   if (inputs.includeAllOldNewRenamedFiles) {
     core.startGroup('changed-files-all-old-new-renamed-files')
     const allOldNewRenamedFiles = await getRenamedFiles({
@@ -193,12 +227,10 @@ const getChangedFilesFromLocalGit = async ({
 
 const getChangedFilesFromRESTAPI = async ({
   inputs,
-  workingDirectory,
   filePatterns,
   yamlFilePatterns
 }: {
   inputs: Inputs
-  workingDirectory: string
   filePatterns: string[]
   yamlFilePatterns: Record<string, string[]>
 }): Promise<void> => {
@@ -208,43 +240,12 @@ const getChangedFilesFromRESTAPI = async ({
   core.debug(`All diff files: ${JSON.stringify(allDiffFiles)}`)
   core.info('All Done!')
 
-  if (filePatterns.length > 0) {
-    core.startGroup('changed-files-patterns')
-    await setChangedFilesOutput({
-      allDiffFiles,
-      filePatterns,
-      inputs,
-      workingDirectory
-    })
-    core.info('All Done!')
-    core.endGroup()
-  }
-
-  if (Object.keys(yamlFilePatterns).length > 0) {
-    for (const key of Object.keys(yamlFilePatterns)) {
-      core.startGroup(`changed-files-yaml-${key}`)
-      await setChangedFilesOutput({
-        allDiffFiles,
-        filePatterns: yamlFilePatterns[key],
-        outputPrefix: key,
-        inputs,
-        workingDirectory
-      })
-      core.info('All Done!')
-      core.endGroup()
-    }
-  }
-
-  if (filePatterns.length === 0 && Object.keys(yamlFilePatterns).length === 0) {
-    core.startGroup('changed-files-all')
-    await setChangedFilesOutput({
-      allDiffFiles,
-      inputs,
-      workingDirectory
-    })
-    core.info('All Done!')
-    core.endGroup()
-  }
+  await changedFilesOutput({
+    filePatterns,
+    allDiffFiles,
+    inputs,
+    yamlFilePatterns
+  })
 }
 
 export async function run(): Promise<void> {
@@ -256,8 +257,7 @@ export async function run(): Promise<void> {
   const inputs = getInputs()
   core.debug(`Inputs: ${JSON.stringify(inputs, null, 2)}`)
 
-  const githubContext = github.context
-  core.debug(`Github Context: ${JSON.stringify(githubContext, null, 2)}`)
+  core.debug(`Github Context: ${JSON.stringify(github.context, null, 2)}`)
 
   const workingDirectory = path.resolve(
     env.GITHUB_WORKSPACE || process.cwd(),
@@ -306,7 +306,6 @@ export async function run(): Promise<void> {
     }
     await getChangedFilesFromRESTAPI({
       inputs,
-      workingDirectory,
       filePatterns,
       yamlFilePatterns
     })

src/utils.ts

@@ -1028,6 +1028,36 @@ export const getYamlFilePatterns = async ({
   return filePatterns
 }
 
+export const getRecoverFilePatterns = ({
+  inputs
+}: {
+  inputs: Inputs
+}): string[] => {
+  let filePatterns: string[] = inputs.recoverFiles.split(
+    inputs.recoverFilesSeparator
+  )
+
+  if (inputs.recoverFilesIgnore) {
+    const ignoreFilePatterns = inputs.recoverFilesIgnore.split(
+      inputs.recoverFilesSeparator
+    )
+
+    filePatterns = filePatterns.concat(
+      ignoreFilePatterns.map(p => {
+        if (p.startsWith('!')) {
+          return p
+        } else {
+          return `!${p}`
+        }
+      })
+    )
+  }
+
+  core.debug(`recover file patterns: ${filePatterns}`)
+
+  return filePatterns.filter(Boolean)
+}
+
 export const setOutput = async ({
   key,
   value,
@@ -1084,36 +1114,48 @@ export const recoverDeletedFiles = async ({
   inputs,
   workingDirectory,
   deletedFiles,
+  recoverPatterns,
   sha
 }: {
   inputs: Inputs
   workingDirectory: string
   deletedFiles: string[]
+  recoverPatterns: string[]
   sha: string
 }): Promise<void> => {
-  if (inputs.recoverDeletedFiles) {
-    for (const deletedFile of deletedFiles) {
-      let target = path.join(workingDirectory, deletedFile)
+  let recoverableDeletedFiles = deletedFiles
+  core.debug(`recoverable deleted files: ${recoverableDeletedFiles}`)
 
-      if (inputs.recoverDeletedFilesToDestination) {
-        target = path.join(
-          workingDirectory,
-          inputs.recoverDeletedFilesToDestination,
-          deletedFile
-        )
-      }
+  if (recoverPatterns.length > 0) {
+    recoverableDeletedFiles = mm(deletedFiles, recoverPatterns, {
+      dot: true,
+      windows: IS_WINDOWS,
+      noext: true
+    })
+    core.debug(`filtered recoverable deleted files: ${recoverableDeletedFiles}`)
+  }
 
-      const deletedFileContents = await getDeletedFileContents({
-        cwd: workingDirectory,
-        filePath: deletedFile,
-        sha
-      })
+  for (const deletedFile of recoverableDeletedFiles) {
+    let target = path.join(workingDirectory, deletedFile)
 
-      if (!(await exists(path.dirname(target)))) {
-        await fs.mkdir(path.dirname(target), {recursive: true})
-      }
-      await fs.writeFile(target, deletedFileContents)
+    if (inputs.recoverDeletedFilesToDestination) {
+      target = path.join(
+        workingDirectory,
+        inputs.recoverDeletedFilesToDestination,
+        deletedFile
+      )
     }
+
+    const deletedFileContents = await getDeletedFileContents({
+      cwd: workingDirectory,
+      filePath: deletedFile,
+      sha
+    })
+
+    if (!(await exists(path.dirname(target)))) {
+      await fs.mkdir(path.dirname(target), {recursive: true})
+    }
+    await fs.writeFile(target, deletedFileContents)
   }
 }