Allow extending writeSecureFile with custom options (#113)

Author: sethvargo

dist/fs.d.ts

@@ -1,6 +1,6 @@
 /// <reference types="node" />
 /// <reference types="node" />
-import { PathLike } from 'fs';
+import { PathLike, ObjectEncodingOptions, Mode, OpenMode } from 'fs';
 /**
  * forceRemove forcibly removes a file or directory (recursively). If the file
  * or directory does not exist, it does nothing. This is functionally equivalent
@@ -25,10 +25,16 @@ export declare function isEmptyDir(dir: PathLike): Promise<boolean>;
  *
  * @param outputPath Path in which to create the secure file.
  * @param data Data to write to file.
+ * @param options additional options to pass to writeFile. The default options
+ * are permissions of 0640, write-exclusive, and flush-on-success.
  *
  * @returns Path to written file.
  */
-export declare function writeSecureFile<T extends PathLike>(outputPath: T, data: string | Buffer): Promise<T>;
+export declare function writeSecureFile<T extends PathLike>(outputPath: T, data: string | Buffer, options?: ObjectEncodingOptions & {
+    mode?: Mode;
+    flag?: OpenMode;
+    flush?: boolean;
+}): Promise<T>;
 /**
  * removeFile removes the file at the given path. If the file does not exist, it
  * does nothing.

dist/index.js

@@ -14,7 +14,7 @@
  * limitations under the License.
  */
 
-import { promises as fs, PathLike } from 'fs';
+import { promises as fs, PathLike, ObjectEncodingOptions, Mode, OpenMode } from 'fs';
 
 import { errorMessage, isNotFoundError } from './errors';
 
@@ -60,14 +60,22 @@ export async function isEmptyDir(dir: PathLike): Promise<boolean> {
  *
  * @param outputPath Path in which to create the secure file.
  * @param data Data to write to file.
+ * @param options additional options to pass to writeFile. The default options
+ * are permissions of 0640, write-exclusive, and flush-on-success.
  *
  * @returns Path to written file.
  */
 export async function writeSecureFile<T extends PathLike>(
   outputPath: T,
   data: string | Buffer,
+  options?: ObjectEncodingOptions & {
+    mode?: Mode;
+    flag?: OpenMode;
+    flush?: boolean;
+  },
 ): Promise<T> {
-  await fs.writeFile(outputPath, data, { mode: 0o640, flag: 'wx' });
+  const opts = Object.assign({}, { mode: 0o640, flag: 'wx', flush: true }, options);
+  await fs.writeFile(outputPath, data, opts);
   return outputPath;
 }
 

dist/index.js.map

@@ -33,7 +33,7 @@ export async function parseGcloudIgnore(pth: string): Promise<string[]> {
 
   let ignoreContents: string[] = [];
   try {
-    ignoreContents = (await fs.readFile(pth, { encoding: 'utf-8' }))
+    ignoreContents = (await fs.readFile(pth, { encoding: 'utf8' }))
       .toString()
       .split(/\r?\n/)
       .filter(shouldKeepIgnoreLine)
@@ -51,7 +51,7 @@ export async function parseGcloudIgnore(pth: string): Promise<string[]> {
       const includeName = line.substring(10).trim();
 
       const includePth = pathjoin(parentDir, includeName);
-      const subIgnoreContents = (await fs.readFile(includePth, { encoding: 'utf-8' }))
+      const subIgnoreContents = (await fs.readFile(includePth, { encoding: 'utf8' }))
         .toString()
         .split(/\r?\n/)
         .filter(shouldKeepIgnoreLine)

src/fs.ts

@@ -166,7 +166,7 @@ export function parseKVString(input: string): KVPair {
  */
 export function parseKVFile(filePath: string): KVPair {
   try {
-    const content = presence(readFileSync(filePath, 'utf-8'));
+    const content = presence(readFileSync(filePath, 'utf8'));
     if (!content || content.length < 1) {
       return {};
     }

src/ignore.ts

@@ -101,6 +101,28 @@ describe('fs', { concurrency: true }, async () => {
 
       const accessed = await fs.readFile(filepath, 'utf8');
       assert.deepStrictEqual(accessed, 'my data');
+
+      if (process.platform !== 'win32') {
+        const stats = await fs.stat(filepath);
+        assert.deepStrictEqual(stats.mode.toString(8), '100640');
+      }
+    });
+
+    await suite.test('writes a file with custom options', async () => {
+      const filepath = randomFilepath();
+      const result = await writeSecureFile(filepath, 'my data', {
+        mode: 0o600,
+        encoding: 'utf8',
+      });
+      assert.deepStrictEqual(filepath, result);
+
+      const accessed = await fs.readFile(filepath, 'utf8');
+      assert.deepStrictEqual(accessed, 'my data');
+
+      if (process.platform !== 'win32') {
+        const stats = await fs.stat(filepath);
+        assert.deepStrictEqual(stats.mode.toString(8), '100600');
+      }
     });
   });
 });