Skip to content

Apply handle pattern to info #376

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Mar 20, 2025
Merged
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
4 changes: 2 additions & 2 deletions src/commands/info/cmd-info.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ import colors from 'yoctocolors-cjs'

import { logger } from '@socketsecurity/registry/lib/logger'

import { getPackageInfo } from './get-package-info'
import { handlePackageInfo } from './handle-package-info'
import constants from '../../constants'
import { commonFlags, outputFlags, validationFlags } from '../../flags'
import { meowOrExit } from '../../utils/meow-with-subcommands'
Expand Down Expand Up @@ -77,7 +77,7 @@ async function run(
return
}

await getPackageInfo({
await handlePackageInfo({
commandName: `${parentName} ${config.commandName}`,
includeAllIssues: Boolean(all),
outputKind: json ? 'json' : markdown ? 'markdown' : 'print',
Expand Down
16 changes: 15 additions & 1 deletion src/commands/info/fetch-package-info.ts
Original file line number Diff line number Diff line change
@@ -1,14 +1,26 @@
import { PackageData } from './get-package-info'
import constants from '../../constants'
import { getSeverityCount } from '../../utils/alert/severity'
import { handleApiCall, handleUnsuccessfulApiResponse } from '../../utils/api'
import { getPublicToken, setupSdk } from '../../utils/sdk'

import type { PackageData } from './handle-package-info'

export async function fetchPackageInfo(
pkgName: string,
pkgVersion: string,
includeAllIssues: boolean
): Promise<void | PackageData> {
const socketSdk = await setupSdk(getPublicToken())

// Lazily access constants.spinner.
const { spinner } = constants

spinner.start(
pkgVersion === 'latest'
? `Looking up data for the latest version of ${pkgName}`
: `Looking up data for version ${pkgVersion} of ${pkgName}`
)

const result = await handleApiCall(
socketSdk.getIssuesByNPMPackage(pkgName, pkgVersion),
'looking up package'
Expand All @@ -18,6 +30,8 @@ export async function fetchPackageInfo(
'looking up package score'
)

spinner.successAndStop('Data fetched')

if (result.success === false) {
return handleUnsuccessfulApiResponse('getIssuesByNPMPackage', result)
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,7 @@ import process from 'node:process'
import { hasKeys } from '@socketsecurity/registry/lib/objects'

import { fetchPackageInfo } from './fetch-package-info'
import { logPackageInfo } from './log-package-info'
import constants from '../../constants'
import { outputPackageInfo } from './output-package-info'

import type { SocketSdkAlert } from '../../utils/alert/severity'
import type { SocketSdkReturnType } from '@socketsecurity/sdk'
Expand All @@ -15,7 +14,7 @@ export interface PackageData {
score: SocketSdkReturnType<'getScoreByNPMPackage'>['data']
}

export async function getPackageInfo({
export async function handlePackageInfo({
commandName,
includeAllIssues,
outputKind,
Expand All @@ -30,25 +29,14 @@ export async function getPackageInfo({
pkgVersion: string
strict: boolean
}) {
// Lazily access constants.spinner.
const { spinner } = constants

spinner.start(
pkgVersion === 'latest'
? `Looking up data for the latest version of ${pkgName}`
: `Looking up data for version ${pkgVersion} of ${pkgName}`
)

const packageData = await fetchPackageInfo(
pkgName,
pkgVersion,
includeAllIssues
)

spinner.successAndStop('Data fetched')

if (packageData) {
logPackageInfo(packageData, {
outputPackageInfo(packageData, {
name: commandName,
includeAllIssues,
outputKind,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,14 +5,14 @@ import constants from '@socketsecurity/registry/lib/constants'
import { logger } from '@socketsecurity/registry/lib/logger'
import { hasKeys } from '@socketsecurity/registry/lib/objects'

import { PackageData } from './get-package-info'
import { SEVERITY, formatSeverityCount } from '../../utils/alert/severity'
import { ColorOrMarkdown } from '../../utils/color-or-markdown'
import {
getSocketDevAlertUrl,
getSocketDevPackageOverviewUrl
} from '../../utils/socket-url'

import type { PackageData } from './handle-package-info'
import type { SocketSdkReturnType } from '@socketsecurity/sdk'

const { NPM } = constants
Expand All @@ -26,7 +26,7 @@ function formatScore(score: number): string {
return colors.red(`${score}`)
}

function logPackageIssuesDetails(
function outputPackageIssuesDetails(
packageData: SocketSdkReturnType<'getIssuesByNPMPackage'>['data'],
outputMarkdown: boolean
) {
Expand Down Expand Up @@ -65,7 +65,7 @@ function logPackageIssuesDetails(
}
}

export function logPackageInfo(
export function outputPackageInfo(
{ data, score, severityCount }: PackageData,
{
name,
Expand Down Expand Up @@ -112,7 +112,7 @@ export function logPackageInfo(
logger.log(
`Package has these issues: ${formatSeverityCount(severityCount)}\n`
)
logPackageIssuesDetails(data, outputKind === 'markdown')
outputPackageIssuesDetails(data, outputKind === 'markdown')
} else {
logger.log('Package has no issues')
}
Expand Down
Loading