Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
42 changes: 40 additions & 2 deletions packages/cli-kit/src/public/node/os.test.ts
Original file line number Diff line number Diff line change
@@ -1,7 +1,45 @@
import {platformAndArch} from './os.js'
import {describe, test, expect, vi} from 'vitest'
import {platformAndArch, username} from './os.js'
import {describe, test, expect, vi, beforeEach, afterEach} from 'vitest'
import {userInfo} from 'os'

vi.mock('node:process')
vi.mock('os', async (importOriginal) => {
const original: any = await importOriginal()
return {
...original,
userInfo: vi.fn(),
}
})

describe('username', () => {
beforeEach(() => {
vi.mocked(userInfo).mockReturnValue({
username: 'test-user',
uid: 1,
gid: 1,
shell: 'sh',
homedir: '/home/test-user',
})
})

afterEach(() => {
vi.unstubAllEnvs()
})

test('returns the username and memoizes it', async () => {
// Given
vi.stubEnv('SUDO_USER', 'test-user')

// When
const result1 = await username()
const result2 = await username()

// Then
expect(result1).toBe('test-user')
expect(result2).toBe('test-user')
expect(username()).toBe(username())
})
})

describe('platformAndArch', () => {
test("returns the right architecture when it's x64", () => {
Expand Down
15 changes: 14 additions & 1 deletion packages/cli-kit/src/public/node/os.ts
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,24 @@ import {userInfo as osUserInfo} from 'os'
// This code has been vendored from https://github.com/sindresorhus/username
// because adding it as a transtive dependency causes conflicts with other
// packages that haven't been yet migrated to the latest version.

/**
* Memoized value for the username.
*/
let memoizedUsername: Promise<string | null> | undefined

/**
* @param platform - The platform to get the username for. Defaults to the current platform.
* @returns The username of the current user.
*/
export async function username(platform: typeof process.platform = process.platform): Promise<string | null> {
export function username(platform: typeof process.platform = process.platform): Promise<string | null> {
if (platform === process.platform) {
return (memoizedUsername ??= getUsername(platform))
}
return getUsername(platform)
}

async function getUsername(platform: typeof process.platform): Promise<string | null> {
outputDebug(outputContent`Obtaining user name...`)
const environmentVariable = getEnvironmentVariable()
if (environmentVariable) {
Expand Down
Loading