Skip to content

Commit e687a44

Browse files
jdaltonjdalton
committed
refactor: optimize logger and spinner initialization
Refactor 111 files to call getDefaultLogger() and getDefaultSpinner() once at the top of each module instead of repeatedly throughout the code. This improves performance by reducing redundant function calls and establishes a consistent pattern across the codebase. Pattern applied: - Added const logger = getDefaultLogger() after imports - Added const spinner = getDefaultSpinner() after imports - Replaced all getDefaultLogger() calls with logger reference - Replaced all getDefaultSpinner() calls with spinner reference This change maintains backward compatibility while improving code efficiency and maintainability.
1 parent 9b2a8f1 commit e687a44

File tree

111 files changed

+1404
-1175
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

111 files changed

+1404
-1175
lines changed

‎packages/bootstrap/src/shared/bootstrap-shared.mjs‎

Lines changed: 20 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,8 @@ import { spawn } from '@socketsecurity/lib/spawn'
1717
import { gte } from 'semver'
1818
import { SOCKET_CLI_ISSUES_URL } from '../../../cli/src/constants/socket.mts'
1919

20+
const logger = getDefaultLogger()
21+
2022
export const SOCKET_DLX_DIR = path.join(homedir(), '.socket', '_dlx')
2123

2224
/**
@@ -169,9 +171,9 @@ export async function downloadCli() {
169171
try {
170172
mkdirSync(SOCKET_DLX_DIR, { recursive: true })
171173
} catch (e) {
172-
getDefaultLogger().error('Failed to create Socket directory')
173-
getDefaultLogger().error(` Error: ${e instanceof Error ? e.message : String(e)}`)
174-
getDefaultLogger().error(` Path: ${SOCKET_DLX_DIR}`)
174+
logger.error('Failed to create Socket directory')
175+
logger.error(` Error: ${e instanceof Error ? e.message : String(e)}`)
176+
logger.error(` Path: ${SOCKET_DLX_DIR}`)
175177
process.exit(1)
176178
}
177179

@@ -184,7 +186,8 @@ export async function downloadCli() {
184186
// Uses caret range (^) to auto-update within same major version.
185187
// Update notifications will only trigger for major version changes.
186188
await downloadPackage({
187-
package: `@socketsecurity/cli@^${SOCKET_CLI_VERSION_MAJOR}`,
189+
// @ts-expect-error - Injected by esbuild define.
190+
package: '@socketsecurity/cli@^' + __SOCKET_CLI_VERSION_MAJOR__,
188191
binaryName: 'socket',
189192
// Use cached version if available.
190193
force: false,
@@ -193,14 +196,14 @@ export async function downloadCli() {
193196

194197
return result
195198
} catch (e) {
196-
getDefaultLogger().error('Failed to download Socket CLI')
197-
getDefaultLogger().error(` Error: ${e instanceof Error ? e.message : String(e)}`)
198-
getDefaultLogger().error('')
199-
getDefaultLogger().error('This may be a temporary issue. Please try:')
200-
getDefaultLogger().error(' 1. Check your internet connection')
201-
getDefaultLogger().error(' 2. Try running the command again')
202-
getDefaultLogger().error(` 3. Manually create directory: mkdir -p "${SOCKET_DLX_DIR}"`)
203-
getDefaultLogger().error(` 4. Report issue at: ${SOCKET_CLI_ISSUES_URL}`)
199+
logger.error('Failed to download Socket CLI')
200+
logger.error(` Error: ${e instanceof Error ? e.message : String(e)}`)
201+
logger.error('')
202+
logger.error('This may be a temporary issue. Please try:')
203+
logger.error(' 1. Check your internet connection')
204+
logger.error(' 2. Try running the command again')
205+
logger.error(` 3. Manually create directory: mkdir -p "${SOCKET_DLX_DIR}"`)
206+
logger.error(` 4. Report issue at: ${SOCKET_CLI_ISSUES_URL}`)
204207
process.exit(1)
205208
}
206209
}
@@ -216,7 +219,8 @@ export async function findAndExecuteCli(args) {
216219

217220
// Pass metadata to CLI for manifest writing.
218221
// CLI will use this to write entries to ~/.socket/_dlx/.dlx-manifest.json
219-
const spec = `@socketsecurity/cli@^${SOCKET_CLI_VERSION_MAJOR}`
222+
// @ts-expect-error - Injected by esbuild define.
223+
const spec = '@socketsecurity/cli@^' + __SOCKET_CLI_VERSION_MAJOR__
220224
process.env.SOCKET_CLI_BOOTSTRAP_SPEC = spec
221225
process.env.SOCKET_CLI_BOOTSTRAP_CACHE_DIR = cliPackageDir
222226

@@ -229,8 +233,8 @@ export async function findAndExecuteCli(args) {
229233
}
230234

231235
// If we can't find the CLI, exit with error.
232-
getDefaultLogger().error('Socket CLI installation failed')
233-
getDefaultLogger().error(' CLI entry point not found after installation')
234-
getDefaultLogger().error(` Looked in: ${cliEntry}`)
236+
logger.error('Socket CLI installation failed')
237+
logger.error(' CLI entry point not found after installation')
238+
logger.error(` Looked in: ${cliEntry}`)
235239
return 1
236240
}

‎packages/cli/src/cli-entry.mts‎

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,8 @@ import lookupRegistryUrl from 'registry-url'
3737
import { debug as debugNs, debugDir } from '@socketsecurity/lib/debug'
3838
import { getDefaultLogger } from '@socketsecurity/lib/logger'
3939

40+
const logger = getDefaultLogger()
41+
4042
// Debug logger for manifest operations
4143
const debug = debugNs
4244

@@ -176,7 +178,7 @@ void (async () => {
176178
})()
177179

178180
if (isJson) {
179-
getDefaultLogger().log(
181+
logger.log(
180182
serializeResultJson({
181183
ok: false,
182184
message: errorTitle,
@@ -185,8 +187,8 @@ void (async () => {
185187
)
186188
} else {
187189
// Add 2 newlines in stderr to bump below any spinner.
188-
getDefaultLogger().error('\n')
189-
getDefaultLogger().fail(failMsgWithBadge(errorTitle, errorMessage))
190+
logger.error('\n')
191+
logger.fail(failMsgWithBadge(errorTitle, errorMessage))
190192
if (errorBody) {
191193
debugDir('inspect', { errorBody })
192194
}

‎packages/cli/src/commands/analytics/output-analytics.mts‎

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,8 @@ import { fileLink } from '../../utils/terminal/link.mts'
1010

1111
import type { CResult, OutputKind } from '../../types.mts'
1212
import type { SocketSdkSuccessResult } from '@socketsecurity/sdk'
13+
const logger = getDefaultLogger()
14+
1315

1416
const METRICS = [
1517
'total_critical_alerts',
@@ -63,10 +65,10 @@ export async function outputAnalytics(
6365

6466
if (!result.ok) {
6567
if (outputKind === 'json') {
66-
getDefaultLogger().log(serializeResultJson(result))
68+
logger.log(serializeResultJson(result))
6769
return
6870
}
69-
getDefaultLogger().fail(failMsgWithBadge(result.message, result.cause))
71+
logger.fail(failMsgWithBadge(result.message, result.cause))
7072
return
7173
}
7274

@@ -77,13 +79,13 @@ export async function outputAnalytics(
7779
try {
7880
await fs.writeFile(filepath, serialized, 'utf8')
7981
debugFileOp('write', filepath)
80-
getDefaultLogger().success(
82+
logger.success(
8183
`Data successfully written to ${fileLink(filepath)}`,
8284
)
8385
} catch (e) {
8486
debugFileOp('write', filepath, e)
8587
process.exitCode = 1
86-
getDefaultLogger().log(
88+
logger.log(
8789
serializeResultJson({
8890
ok: false,
8991
message: 'File Write Failure',
@@ -92,7 +94,7 @@ export async function outputAnalytics(
9294
)
9395
}
9496
} else {
95-
getDefaultLogger().log(serialized)
97+
logger.log(serialized)
9698
}
9799

98100
return
@@ -109,15 +111,15 @@ export async function outputAnalytics(
109111
try {
110112
await fs.writeFile(filepath, serialized, 'utf8')
111113
debugFileOp('write', filepath)
112-
getDefaultLogger().success(
114+
logger.success(
113115
`Data successfully written to ${fileLink(filepath)}`,
114116
)
115117
} catch (e) {
116118
debugFileOp('write', filepath, e)
117-
getDefaultLogger().error(e)
119+
logger.error(e)
118120
}
119121
} else {
120-
getDefaultLogger().log(serialized)
122+
logger.log(serialized)
121123
}
122124
} else {
123125
await displayAnalyticsWithInk(fdata)

‎packages/cli/src/commands/ask/handle-ask.mts‎

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,8 @@ import { spawn } from '@socketsecurity/lib/spawn'
99

1010
import { outputAskCommand } from './output-ask.mts'
1111
import ENV from '../../constants/env.mts'
12+
const logger = getDefaultLogger()
13+
1214

1315
// Semantic index for fast word-overlap matching (lazy-loaded, ~3KB).
1416
let semanticIndex: any = null
@@ -642,25 +644,25 @@ export async function handleAsk(options: HandleAskOptions): Promise<void> {
642644

643645
// If not executing, just show the command.
644646
if (!execute) {
645-
getDefaultLogger().log('')
646-
getDefaultLogger().log(
647+
logger.log('')
648+
logger.log(
647649
'💡 Tip: Add --execute or -e to run this command directly',
648650
)
649651
return
650652
}
651653

652654
// Execute the command.
653-
getDefaultLogger().log('')
654-
getDefaultLogger().log('🚀 Executing...')
655-
getDefaultLogger().log('')
655+
logger.log('')
656+
logger.log('🚀 Executing...')
657+
logger.log('')
656658

657659
const result = await spawn('socket', intent.command, {
658660
stdio: 'inherit',
659661
cwd: process.cwd(),
660662
})
661663

662664
if (result.code !== 0) {
663-
getDefaultLogger().error(`Command failed with exit code ${result.code}`)
665+
logger.error(`Command failed with exit code ${result.code}`)
664666
// eslint-disable-next-line n/no-process-exit
665667
process.exit(result.code)
666668
}

‎packages/cli/src/commands/ask/output-ask.mts‎

Lines changed: 21 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
import colors from 'yoctocolors-cjs'
22

33
import { getDefaultLogger } from '@socketsecurity/lib/logger'
4+
const logger = getDefaultLogger()
5+
46

57
interface OutputAskCommandOptions {
68
query: string
@@ -29,14 +31,14 @@ export function outputAskCommand(options: OutputAskCommandOptions): void {
2931
const { context, explain, intent, query } = options
3032

3133
// Show the query.
32-
getDefaultLogger().log('')
33-
getDefaultLogger().log(colors.bold(colors.magenta('❯ You asked:')))
34-
getDefaultLogger().log(` "${colors.cyan(query)}"`)
35-
getDefaultLogger().log('')
34+
logger.log('')
35+
logger.log(colors.bold(colors.magenta('❯ You asked:')))
36+
logger.log(` "${colors.cyan(query)}"`)
37+
logger.log('')
3638

3739
// Show interpretation.
38-
getDefaultLogger().log(colors.bold(colors.magenta('🤖 I understood:')))
39-
getDefaultLogger().log(` ${intent.explanation}`)
40+
logger.log(colors.bold(colors.magenta('🤖 I understood:')))
41+
logger.log(` ${intent.explanation}`)
4042

4143
// Show extracted details if present.
4244
const details = []
@@ -60,42 +62,42 @@ export function outputAskCommand(options: OutputAskCommandOptions): void {
6062
}
6163

6264
if (details.length > 0) {
63-
getDefaultLogger().log(` ${details.join(', ')}`)
65+
logger.log(` ${details.join(', ')}`)
6466
}
6567

6668
// Show confidence if low.
6769
if (intent.confidence < 0.6) {
68-
getDefaultLogger().log('')
69-
getDefaultLogger().log(
70+
logger.log('')
71+
logger.log(
7072
colors.yellow(
7173
'⚠️ Low confidence - the command might not match your intent exactly',
7274
),
7375
)
7476
}
7577

76-
getDefaultLogger().log('')
78+
logger.log('')
7779

7880
// Show the command.
79-
getDefaultLogger().log(colors.bold(colors.magenta('📝 Command:')))
80-
getDefaultLogger().log(
81+
logger.log(colors.bold(colors.magenta('📝 Command:')))
82+
logger.log(
8183
` ${colors.green('$')} socket ${colors.cyan(intent.command.join(' '))}`,
8284
)
8385

8486
// Show explanation if requested.
8587
if (explain) {
86-
getDefaultLogger().log('')
87-
getDefaultLogger().log(colors.bold(colors.magenta('💡 Explanation:')))
88-
getDefaultLogger().log(explainCommand(intent))
88+
logger.log('')
89+
logger.log(colors.bold(colors.magenta('💡 Explanation:')))
90+
logger.log(explainCommand(intent))
8991
}
9092

9193
// Show context.
9294
if (context.hasPackageJson && explain) {
93-
getDefaultLogger().log('')
94-
getDefaultLogger().log(colors.bold(colors.magenta('📦 Project Context:')))
95+
logger.log('')
96+
logger.log(colors.bold(colors.magenta('📦 Project Context:')))
9597
const depCount = Object.keys(context.dependencies || {}).length
9698
const devDepCount = Object.keys(context.devDependencies || {}).length
97-
getDefaultLogger().log(` Dependencies: ${depCount} packages`)
98-
getDefaultLogger().log(` Dev Dependencies: ${devDepCount} packages`)
99+
logger.log(` Dependencies: ${depCount} packages`)
100+
logger.log(` Dev Dependencies: ${devDepCount} packages`)
99101
}
100102
}
101103

‎packages/cli/src/commands/audit-log/output-audit-log.mts‎

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,8 @@ import { serializeResultJson } from '../../utils/output/result-json.mjs'
1414

1515
import type { CResult, OutputKind } from '../../types.mts'
1616
import type { SocketSdkSuccessResult } from '@socketsecurity/sdk'
17+
const logger = getDefaultLogger()
18+
1719

1820
type AuditLogEvent =
1921
SocketSdkSuccessResult<'getAuditLogEvents'>['data']['results'][number]
@@ -39,7 +41,7 @@ export async function outputAuditLog(
3941
}
4042

4143
if (outputKind === OUTPUT_JSON) {
42-
getDefaultLogger().log(
44+
logger.log(
4345
await outputAsJson(result, {
4446
logType,
4547
orgSlug,
@@ -50,12 +52,12 @@ export async function outputAuditLog(
5052
}
5153

5254
if (!result.ok) {
53-
getDefaultLogger().fail(failMsgWithBadge(result.message, result.cause))
55+
logger.fail(failMsgWithBadge(result.message, result.cause))
5456
return
5557
}
5658

5759
if (outputKind === OUTPUT_MARKDOWN) {
58-
getDefaultLogger().log(
60+
logger.log(
5961
await outputAsMarkdown(result.data, {
6062
logType,
6163
orgSlug,
@@ -159,7 +161,7 @@ ${table}
159161
`
160162
} catch (e) {
161163
process.exitCode = 1
162-
getDefaultLogger().fail(
164+
logger.fail(
163165
`There was a problem converting the logs to Markdown, please try the \`${FLAG_JSON}\` flag`,
164166
)
165167
debug('Markdown conversion failed')

0 commit comments

Comments
 (0)