refactor(getos): move function from utils to getos only used there

Author: hasezoey

packages/mongodb-memory-server-core/src/util/__tests__/utils.test.ts

@@ -83,61 +83,6 @@ describe('utils', () => {
     });
   });
 
-  describe('tryReleaseFile', () => {
-    it('should return an Parsed Output', async () => {
-      expect.assertions(2);
-      const shouldOutput = 'HelloThere';
-      jest.spyOn(fspromises, 'readFile').mockResolvedValueOnce(shouldOutput);
-
-      await expect(
-        utils.tryReleaseFile('/some/path', (output) => {
-          expect(output).toEqual(shouldOutput);
-
-          return { hello: output } as any;
-        })
-      ).resolves.toEqual({ hello: shouldOutput });
-    });
-
-    it('should return "undefined" if "ENOENT"', async () => {
-      const retError = new Error();
-      // @ts-expect-error because there is no FSError, or an error with an "code" property - but still being used
-      retError.code = 'ENOENT';
-      jest.spyOn(fspromises, 'readFile').mockRejectedValueOnce(retError);
-
-      await expect(
-        utils.tryReleaseFile('/some/path', () => {
-          fail('This Function should never run');
-        })
-      ).resolves.toBeUndefined();
-    });
-
-    it('should return "undefined" if "EACCES"', async () => {
-      const retError = new Error();
-      // @ts-expect-error because there is no FSError, or an error with an "code" property - but still being used
-      retError.code = 'EACCES';
-      jest.spyOn(fspromises, 'readFile').mockRejectedValueOnce(retError);
-
-      await expect(
-        utils.tryReleaseFile('/some/path', () => {
-          fail('This Function should never run');
-        })
-      ).resolves.toBeUndefined();
-    });
-
-    it('should throw an error if error is not "ENOENT" or "EACCES"', async () => {
-      const retError = new Error();
-      // @ts-expect-error because there is no FSError, or an error with an "code" property - but still being used
-      retError.code = 'EPERM';
-      jest.spyOn(fspromises, 'readFile').mockRejectedValueOnce(retError);
-
-      await expect(
-        utils.tryReleaseFile('/some/path', () => {
-          fail('This Function should never run');
-        })
-      ).rejects.toThrow(retError);
-    });
-  });
-
   describe('getHost', () => {
     it('should correctly extract host & port', () => {
       expect(utils.getHost('mongodb://user:pass@localhost:port/authdb?queryoptions=1')).toEqual(

packages/mongodb-memory-server-core/src/util/getos/__tests__/getos.test.ts

@@ -1,4 +1,5 @@
 import * as getos from '../index';
+import { promises as fspromises } from 'fs';
 
 // This File will use example input, it should be formatted with multiple template strings
 
@@ -173,6 +174,61 @@ LOGO="distributor-logo-Tumbleweed"`;
     });
   });
 
+  describe('tryReleaseFile', () => {
+    it('should return an Parsed Output', async () => {
+      expect.assertions(2);
+      const shouldOutput = 'HelloThere';
+      jest.spyOn(fspromises, 'readFile').mockResolvedValueOnce(shouldOutput);
+
+      await expect(
+        getos.tryReleaseFile('/some/path', (output) => {
+          expect(output).toEqual(shouldOutput);
+
+          return { hello: output } as any;
+        })
+      ).resolves.toEqual({ hello: shouldOutput });
+    });
+
+    it('should return "undefined" if "ENOENT"', async () => {
+      const retError = new Error();
+      // @ts-expect-error because there is no FSError, or an error with an "code" property - but still being used
+      retError.code = 'ENOENT';
+      jest.spyOn(fspromises, 'readFile').mockRejectedValueOnce(retError);
+
+      await expect(
+        getos.tryReleaseFile('/some/path', () => {
+          fail('This Function should never run');
+        })
+      ).resolves.toBeUndefined();
+    });
+
+    it('should return "undefined" if "EACCES"', async () => {
+      const retError = new Error();
+      // @ts-expect-error because there is no FSError, or an error with an "code" property - but still being used
+      retError.code = 'EACCES';
+      jest.spyOn(fspromises, 'readFile').mockRejectedValueOnce(retError);
+
+      await expect(
+        getos.tryReleaseFile('/some/path', () => {
+          fail('This Function should never run');
+        })
+      ).resolves.toBeUndefined();
+    });
+
+    it('should throw an error if error is not "ENOENT" or "EACCES"', async () => {
+      const retError = new Error();
+      // @ts-expect-error because there is no FSError, or an error with an "code" property - but still being used
+      retError.code = 'EPERM';
+      jest.spyOn(fspromises, 'readFile').mockRejectedValueOnce(retError);
+
+      await expect(
+        getos.tryReleaseFile('/some/path', () => {
+          fail('This Function should never run');
+        })
+      ).rejects.toThrow(retError);
+    });
+  });
+
   describe('extra os tests', () => {
     it('should parse cachyos', () => {
       // output taken from https://github.com/typegoose/mongodb-memory-server/issues/947

packages/mongodb-memory-server-core/src/util/getos/index.ts

@@ -1,6 +1,7 @@
 import { platform } from 'os';
 import debug from 'debug';
-import { isNullOrUndefined, tryReleaseFile } from '../utils';
+import { errorWithCode, isNullOrUndefined } from '../utils';
+import { promises as fspromises } from 'fs';
 
 const log = debug('MongoMS:getos');
 
@@ -155,3 +156,27 @@ export function parseOS(input: string): LinuxOS {
     id_like: input.match(OSRegex.id_like)?.[1].toLocaleLowerCase().split(' '),
   };
 }
+
+/**
+ * Try to read a release file path and apply a parser to the output
+ * @param path The Path to read for an release file
+ * @param parser An function to parse the output of the file
+ */
+export async function tryReleaseFile(
+  path: string,
+  parser: (output: string) => LinuxOS | undefined
+): Promise<LinuxOS | undefined> {
+  try {
+    const output = await fspromises.readFile(path);
+
+    return parser(output.toString());
+  } catch (err) {
+    if (errorWithCode(err) && !['ENOENT', 'EACCES'].includes(err.code)) {
+      throw err;
+    }
+
+    log(`tryReleaseFile: "${path}" does not exist`);
+
+    return undefined;
+  }
+}

packages/mongodb-memory-server-core/src/util/utils.ts

@@ -2,7 +2,6 @@ import debug from 'debug';
 import { ChildProcess } from 'child_process';
 import { AutomaticAuth } from '../MongoMemoryServer';
 import { promises as fspromises, Stats, constants } from 'fs';
-import { LinuxOS } from './getos';
 import {
   AssertionFallbackError,
   BinaryNotFoundError,
@@ -219,30 +218,6 @@ export async function pathExists(path: string): Promise<boolean> {
   return !isNullOrUndefined(await statPath(path));
 }
 
-/**
- * Try to read an release file path and apply an parser to the output
- * @param path The Path to read for an release file
- * @param parser An function to parse the output of the file
- */
-export async function tryReleaseFile(
-  path: string,
-  parser: (output: string) => LinuxOS | undefined
-): Promise<LinuxOS | undefined> {
-  try {
-    const output = await fspromises.readFile(path);
-
-    return parser(output.toString());
-  } catch (err) {
-    if (errorWithCode(err) && !['ENOENT', 'EACCES'].includes(err.code)) {
-      throw err;
-    }
-
-    log(`tryReleaseFile: "${path}" does not exist`);
-
-    return undefined;
-  }
-}
-
 /**
  * Cleanup interface to provide easy to understand arguments for clean-up
  */