simplify os detection and logging

SonarSource · Apr 16, 2024 · 020d58d · 020d58d
1 parent ff7b7e7
commit 020d58d
Show file tree

Hide file tree

Showing 4 changed files with 9 additions and 55 deletions.
diff --git a/src/logging.ts b/src/logging.ts
@@ -40,12 +40,7 @@ let logLevel = DEFAULT_LOG_LEVEL;
 
 export function log(level: LogLevel, ...message: unknown[]) {
   if (logLevelValues[level] <= logLevelValues[logLevel]) {
-    const messageStr = message
-      .map(m => {
-        return typeof m === 'object' ? JSON.stringify(m) : m;
-      })
-      .join(' ');
-    console.log(`[${level}] Bootstrapper ${messageStr}`);
+    console.log(`[${level}] Bootstrapper:: `, ...message);
   }
 }
 

diff --git a/src/platform.ts b/src/platform.ts
@@ -27,26 +27,7 @@ export function getArch(): NodeJS.Architecture {
 }
 
 function isLinux(): boolean {
-  return /^linux/.test(process.platform);
-}
-
-function isSupportedLinux(): SupportedOS | false {
-  const linuxMapping: { [nodePlatform: string]: SupportedOS } = {
-    linux: isAlpineLinux() ? 'alpine' : 'linux',
-    openbsd: 'linux',
-    sunos: 'linux',
-    freebsd: 'linux',
-  };
-
-  return linuxMapping[process.platform] || false;
-}
-
-function isWindows(): boolean {
-  return /^win/.test(process.platform);
-}
-
-function isMac(): boolean {
-  return /^darwin/.test(process.platform);
+  return process.platform.startsWith('linux');
 }
 
 /**
@@ -66,27 +47,14 @@ function isAlpineLinux(): boolean {
       const fileContent = fs.readFileSync('/usr/lib/os-release');
       content = fileContent.toString();
     } catch (error) {
-      log(LogLevel.ERROR, 'Failed to read /etc/os-release or /usr/lib/os-release');
+      log(LogLevel.WARN, 'Failed to read /etc/os-release or /usr/lib/os-release');
     }
   }
   return !!content && (content.match(/^ID=([^\u001b\r\n]*)/m) || [])[1] === 'alpine';
 }
 
 function getSupportedOS(): SupportedOS {
-  if (isWindows()) {
-    return 'windows';
-  }
-
-  if (isMac()) {
-    return 'macos';
-  }
-
-  const supportedLinux = isSupportedLinux();
-  if (supportedLinux) {
-    return supportedLinux;
-  }
-
-  throw new Error(`Unsupported platform: ${process.platform}`);
+  return isAlpineLinux() ? 'alpine' : process.platform;
 }
 
 export function getPlatformInfo(): PlatformInfo {

diff --git a/src/types.ts b/src/types.ts
@@ -19,7 +19,7 @@
  */
 import { LogLevel } from './logging';
 
-export type SupportedOS = 'windows' | 'linux' | 'alpine' | 'macos' | 'aix';
+export type SupportedOS = NodeJS.Platform | 'alpine';
 
 export type PlatformInfo = {
   os: SupportedOS | null;

diff --git a/test/unit/platform.test.ts b/test/unit/platform.test.ts
@@ -23,15 +23,13 @@ import * as logging from '../../src/logging';
 import fs from 'fs';
 import sinon from 'sinon';
 
-// Mock the getPlatform function
-
 describe('getPlatformInfo', () => {
   it('detect macos', () => {
     const platformStub = sinon.stub(process, 'platform').value('darwin');
     const archStub = sinon.stub(process, 'arch').value('arm64');
 
     expect(platform.getPlatformInfo()).toEqual({
-      os: 'macos',
+      os: 'darwin',
       arch: 'arm64',
     });
 
@@ -44,20 +42,20 @@ describe('getPlatformInfo', () => {
     const archStub = sinon.stub(process, 'arch').value('x64');
 
     expect(platform.getPlatformInfo()).toEqual({
-      os: 'windows',
+      os: 'win32',
       arch: 'x64',
     });
 
     platformStub.restore();
     archStub.restore();
   });
 
-  it('detect supported linux', () => {
+  it('detect linux flavor', () => {
     const platformStub = sinon.stub(process, 'platform').value('openbsd');
     const archStub = sinon.stub(process, 'arch').value('x64');
 
     expect(platform.getPlatformInfo()).toEqual({
-      os: 'linux',
+      os: 'openbsd',
       arch: 'x64',
     });
 
@@ -118,11 +116,4 @@ describe('getPlatformInfo', () => {
     archStub.restore();
     logSpy.restore();
   });
-
-  it('throw if unsupported', () => {
-    const stub = sinon.stub(process, 'platform').value('android');
-
-    expect(() => platform.getPlatformInfo()).toThrow('Unsupported platform: android');
-    stub.restore();
-  });
 });