Stop user home path from being printed in migration script log

__tests__/spec/migrate.js

@@ -1,8 +1,11 @@
 /* eslint-env jest */
 
-const path = require('path')
 const fs = require('fs')
+const os = require('os')
+const path = require('path')
+
 const fse = require('fs-extra')
+
 const { spawn } = require('../../lib/exec')
 const { mkdtempSync } = require('../util')
 
@@ -137,4 +140,10 @@ describe('migrate test prototype', () => {
       '{% extends "govuk-prototype-kit/layouts/govuk-branded.html" %}' + '\n'
     )
   })
+
+  it('migrate.log does not contain user home directory', () => {
+    const migrateLog = fs.readFileSync(path.join(projectDirectory, 'migrate.log'), 'utf8')
+
+    expect(migrateLog).not.toContain(os.homedir())
+  })
 })

lib/migrator/fileHelpers.js

@@ -1,8 +1,10 @@
 const path = require('path')
-const { packageDir, projectDir } = require('../path-utils')
 const fs = require('fs').promises
+
 const fse = require('fs-extra')
-const { log } = require('./logger')
+
+const { packageDir, projectDir } = require('../path-utils')
+const { log, sanitisePaths } = require('./logger')
 
 const verboseLog = async function () {
   await log(...arguments)
@@ -102,7 +104,7 @@ const deleteDirectoryIfEmpty = async (partialPath) => {
 const copyFileFromStarter = async (starterPath, newPath) => {
   const src = path.join(packageDir, 'prototype-starter', starterPath)
   const dest = path.join(projectDir, newPath || starterPath)
-  await verboseLog(`Copying from [${path.relative(projectDir, src)}] to [${path.relative(projectDir, dest)}]`)
+  await verboseLog(`Copying from [${sanitisePaths(src)}] to [${sanitisePaths(dest)}]`)
   return fse.copy(src, dest)
     .then(successOutput)
     .catch(async e => {

lib/migrator/logger.js

@@ -1,4 +1,6 @@
+const os = require('os')
 const path = require('path')
+
 const { projectDir } = require('../path-utils')
 const fs = require('fs').promises
 
@@ -7,15 +9,19 @@ const packageVersion = require('../../package.json').version
 const migrateLogFilePath = path.join(projectDir, 'migrate.log')
 let migrateLogFileHandle
 
+function sanitisePaths (str) {
+  return str.replaceAll(os.homedir(), '~')
+}
+
 async function setup () {
   if (!migrateLogFileHandle) {
     migrateLogFileHandle = await fs.open(migrateLogFilePath, 'a')
 
     // log some information useful for debugging
     await module.exports.log(new Date().toISOString())
-    await module.exports.log('cwd: ' + process.cwd())
+    await module.exports.log('cwd: ' + sanitisePaths(process.cwd()))
     await module.exports.log(`package: govuk-prototype-kit@${packageVersion}`)
-    await module.exports.log('argv: ' + process.argv.join(' '))
+    await module.exports.log('argv: ' + sanitisePaths(process.argv.join(' ')))
   }
 }
 
@@ -31,6 +37,7 @@ async function log (message) {
 
 module.exports = {
   log,
+  sanitisePaths,
   setup,
   teardown
 }

lib/migrator/logger.test.js

@@ -0,0 +1,20 @@
+/* eslint-env jest */
+
+describe('sanitisePaths', () => {
+  const os = require('os')
+  const path = require('path')
+
+  const { sanitisePaths } = require('./logger')
+
+  it('replaces occurences of home directory with ~', () => {
+    expect(
+      sanitisePaths(path.join(os.homedir(), 'path', 'to', 'folder'))
+    ).toEqual(path.join('~', 'path', 'to', 'folder'))
+  })
+
+  it('replaces all occurences in a string', () => {
+    expect(
+      sanitisePaths(process.argv.join(' '))
+    ).not.toContain(os.homedir())
+  })
+})