fix OS Utils Pc Session start method, should work for all OS

Signed-off-by: nkomonen-amazon <[email protected]>

Author: nkomonen-amazon

packages/core/src/shared/utilities/osUtils.ts

@@ -4,10 +4,7 @@
  */
 
 import globals from '../extensionGlobals'
-import { fs } from '../fs/fs'
-import { tempDirPath } from '../filesystemUtilities'
-import path from 'path'
-import { getExtensionId } from '../extensionUtilities'
+import * as os from 'os'
 
 /**
  * Checks if the current OS session is new.
@@ -18,44 +15,24 @@ import { getExtensionId } from '../extensionUtilities'
  * Use this function to perform one-time initialization tasks that should only happen
  * once per OS session, regardless of how many extension instances are running.
  */
-export async function isNewOsSession(tmpDir = tempDirPath) {
-    switch (process.platform) {
-        case 'win32': {
-            // Windows does not have an ephemeral /tmp/ folder that deletes on shutdown, while unix-like os's do.
-            // So in Windows we calculate the start time and see if it changed from the previous known start time.
-
-            const lastStartTime = globals.globalState.tryGet('lastOsStartTime', Number)
-            // uptime() returns seconds, convert to ms
-            const currentOsStartTime = Date.now() - process.uptime() * 1000
-
-            if (lastStartTime === undefined) {
-                await globals.globalState.update('lastOsStartTime', currentOsStartTime)
-                return true
-            }
-
-            // If the current start time is later than the last, it means we are in a new session
-            // But remove a few seconds to account for a small delay between getting the current time and
-            // actually comparing it.
-            if (currentOsStartTime - 2000 > lastStartTime) {
-                await globals.globalState.update('lastOsStartTime', currentOsStartTime)
-                return true
-            }
-
-            return false
-        }
-        default: {
-            // Store a file in /tmp/ that acts as a flag. The OS automatically deletes on system shutdown.
-            const unixNewSessionPath = path.join(tmpDir, `sessionStart-${getExtensionId()}`)
-
-            if (await fs.exists(unixNewSessionPath)) {
-                return false
-            }
+export async function isNewOsSession(now = () => globals.clock.Date.now(), uptime = () => os.uptime()) {
+    // Windows does not have an ephemeral /tmp/ folder that deletes on shutdown, while unix-like os's do.
+    // So in Windows we calculate the start time and see if it changed from the previous known start time.
+    const lastStartTime = globals.globalState.tryGet('lastOsStartTime', Number)
+    // uptime() returns seconds, convert to ms
+    const currentOsStartTime = now() - uptime() * 1000 * 60
+
+    if (lastStartTime === undefined) {
+        await globals.globalState.update('lastOsStartTime', currentOsStartTime)
+        return true
+    }
 
-            await fs.writeFile(
-                unixNewSessionPath,
-                `This file is autogenerated by the VS Code extension: ${getExtensionId()}`
-            )
-            return true
-        }
+    // If the current start time is later than the last, it means we are in a new session since they should be the same value.
+    // But to account for small differences in how the current time is calculate, we add in a 5 second buffer.
+    if (currentOsStartTime - 1000 * 5 > lastStartTime) {
+        await globals.globalState.update('lastOsStartTime', currentOsStartTime)
+        return true
     }
+
+    return false
 }

packages/core/src/test/shared/utilities/osUtils.test.ts

@@ -5,27 +5,49 @@
 
 import assert from 'assert'
 import { isNewOsSession } from '../../../shared/utilities/osUtils'
-import { fs } from '../../../shared'
-import { isWin } from '../../../shared/vscode/env'
-import { TestFolder } from '../../testUtil'
+import { InstalledClock } from '@sinonjs/fake-timers'
+import { createSandbox, SinonSandbox } from 'sinon'
 
 describe('isNewOsSession', () => {
-    if (!isWin()) {
-        it('unix-like: returns true when expected', async () => {
-            const tmpDir = (await TestFolder.create()).path
-
-            // On a new session the first caller will get true
-            assert.strictEqual(await isNewOsSession(tmpDir), true)
-            // Subsequent callers will get false
-            assert.strictEqual(await isNewOsSession(tmpDir), false)
-
-            // Mimic a fresh restart (/tmp/ folder is deleted)
-            const files = await fs.readdir(tmpDir)
-            await Promise.all(files.map(async (file) => await fs.delete(`${tmpDir}/${file[0]}`)))
-
-            // Since the tmp/ folder was cleared it is considered a new session
-            assert.strictEqual(await isNewOsSession(tmpDir), true)
-            assert.strictEqual(await isNewOsSession(tmpDir), false)
-        })
-    }
+    let clock: InstalledClock | undefined
+    let sandbox: SinonSandbox
+
+    beforeEach(function () {
+        sandbox = createSandbox()
+    })
+
+    afterEach(function () {
+        clock?.uninstall()
+        sandbox.restore()
+    })
+
+    it('unix-like: returns true when expected', async () => {
+        const uptimeStub = sandbox.stub()
+        const now = sandbox.stub()
+        // We started our computer at 2 minutes since epoch (time - pc uptime)
+        // and the comptuer has been on for 1 minute. So the OS started 1 minute since epoch.
+        now.returns(60_000 + 60_000)
+        uptimeStub.returns(1)
+
+        // On a brand new session the first caller will get true
+        assert.strictEqual(await isNewOsSession(now, uptimeStub), true)
+        // Subsequent callers will get false
+        assert.strictEqual(await isNewOsSession(now, uptimeStub), false)
+
+        // Start a computer session 10 minutes from epoch
+        uptimeStub.returns(0)
+        now.returns(60_000 * 10)
+        assert.strictEqual(await isNewOsSession(now, uptimeStub), true)
+        // Anything that is within a 5 second threshold of the last session time, is considered the same session
+        now.returns(60_000 * 10 + 5000)
+        assert.strictEqual(await isNewOsSession(now, uptimeStub), false)
+        now.returns(60_000 * 10 + 5000 + 1)
+        assert.strictEqual(await isNewOsSession(now, uptimeStub), true)
+
+        // A non-zero uptime
+        uptimeStub.returns(5) // The computer has been running for 5 minutes already, so the start time is relative to this.
+        now.returns(60_000 * 10 + 5000 + 60_000 * 10) // 5 minutes since last session
+        // Nothing changes since the diff between uptime and the last start has not changed
+        assert.strictEqual(await isNewOsSession(now, uptimeStub), true)
+    })
 })