Skip to content

Commit 744a104

Browse files
jdaltonjdalton
committed
Cleanup constants
1 parent f184620 commit 744a104

2 files changed

Lines changed: 41 additions & 51 deletions

File tree

‎scripts/constants.js‎

Lines changed: 13 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -6,16 +6,13 @@ const registryConstants = require('@socketsecurity/registry/lib/constants')
66
const { envAsBoolean } = require('@socketsecurity/registry/lib/env')
77

88
const {
9-
NPM,
10-
NPX,
119
PACKAGE_JSON,
1210
PACKAGE_LOCK_JSON,
1311
SOCKET_SECURITY_SCOPE,
1412
kInternalsSymbol,
1513
[kInternalsSymbol]: { createConstantsObject }
1614
} = registryConstants
1715

18-
const WITH_SENTRY = 'with-sentry'
1916
const CLI = 'cli'
2017
const CONSTANTS = 'constants'
2118
const INLINED_CYCLONEDX_CDXGEN_VERSION = 'INLINED_CYCLONEDX_CDXGEN_VERSION'
@@ -28,7 +25,7 @@ const INLINED_SOCKET_CLI_TEST_DIST_BUILD = 'INLINED_SOCKET_CLI_TEST_DIST_BUILD'
2825
const INLINED_SOCKET_CLI_VERSION = 'INLINED_SOCKET_CLI_VERSION'
2926
const INLINED_SOCKET_CLI_VERSION_HASH = 'INLINED_SOCKET_CLI_VERSION_HASH'
3027
const INLINED_SYNP_VERSION = 'INLINED_SYNP_VERSION'
31-
const INSTRUMENT_WITH_SENTRY = `instrument-${WITH_SENTRY}`
28+
const INSTRUMENT_WITH_SENTRY = 'instrument-with-sentry'
3229
const MODULE_SYNC = 'module-sync'
3330
const REQUIRE = 'require'
3431
const ROLLUP_ENTRY_SUFFIX = '?commonjs-entry'
@@ -38,18 +35,19 @@ const SHADOW_NPM_INJECT = 'shadow-npm-inject'
3835
const SHADOW_NPM_PATHS = 'shadow-npm-paths'
3936
const SLASH_NODE_MODULES_SLASH = '/node_modules/'
4037
const SOCKET = 'socket'
41-
const SOCKET_CLI_BIN_NAME = SOCKET
42-
const SOCKET_CLI_BIN_NAME_ALIAS = CLI
43-
const SOCKET_CLI_SENTRY_BIN_NAME_ALIAS = `${SOCKET_CLI_BIN_NAME_ALIAS}-${WITH_SENTRY}`
44-
const SOCKET_CLI_LEGACY_PACKAGE_NAME = `${SOCKET_SECURITY_SCOPE}/${CLI}`
45-
const SOCKET_CLI_NPM_BIN_NAME = `${SOCKET}-${NPM}`
46-
const SOCKET_CLI_NPX_BIN_NAME = `${SOCKET}-${NPX}`
47-
const SOCKET_CLI_PACKAGE_NAME = SOCKET
48-
const SOCKET_CLI_SENTRY_BIN_NAME = `${SOCKET_CLI_BIN_NAME}-${WITH_SENTRY}`
49-
const SOCKET_CLI_SENTRY_NPM_BIN_NAME = `${SOCKET_CLI_NPM_BIN_NAME}-${WITH_SENTRY}`
50-
const SOCKET_CLI_SENTRY_NPX_BIN_NAME = `${SOCKET_CLI_NPX_BIN_NAME}-${WITH_SENTRY}`
51-
const SOCKET_CLI_SENTRY_PACKAGE_NAME = `${SOCKET_CLI_LEGACY_PACKAGE_NAME}-${WITH_SENTRY}`
38+
const SOCKET_CLI_BIN_NAME = 'socket'
39+
const SOCKET_CLI_BIN_NAME_ALIAS = 'cli'
40+
const SOCKET_CLI_SENTRY_BIN_NAME_ALIAS = 'cli-with-sentry'
41+
const SOCKET_CLI_LEGACY_PACKAGE_NAME = `${SOCKET_SECURITY_SCOPE}/cli`
42+
const SOCKET_CLI_NPM_BIN_NAME = 'socket-npm'
43+
const SOCKET_CLI_NPX_BIN_NAME = 'socket-npx'
44+
const SOCKET_CLI_PACKAGE_NAME = 'socket'
45+
const SOCKET_CLI_SENTRY_BIN_NAME = 'socket-with-sentry'
46+
const SOCKET_CLI_SENTRY_NPM_BIN_NAME = 'socket-npm-with-sentry'
47+
const SOCKET_CLI_SENTRY_NPX_BIN_NAME = 'socket-npx-with-sentry'
48+
const SOCKET_CLI_SENTRY_PACKAGE_NAME = `${SOCKET_SECURITY_SCOPE}/cli-with-sentry`
5249
const VENDOR = 'vendor'
50+
const WITH_SENTRY = 'with-sentry'
5351

5452
const LAZY_ENV = () => {
5553
const { env } = process

‎src/constants.ts‎

Lines changed: 28 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -63,8 +63,7 @@ type Constants = Remap<
6363
readonly ALERT_TYPE_MEDIUM_CVE: 'mediumCVE'
6464
readonly ALERT_TYPE_MILD_CVE: 'mildCVE'
6565
readonly ALERT_TYPE_SOCKET_UPGRADE_AVAILABLE: 'socketUpgradeAvailable'
66-
readonly API_V0_URL: 'https://api.socket.dev/v0'
67-
readonly BATCH_PURL_ENDPOINT: 'https://api.socket.dev/v0/purl?alerts=true&compact=true'
66+
readonly API_V0_URL: 'https://api.socket.dev/v0/'
6867
readonly BINARY_LOCK_EXT: '.lockb'
6968
readonly BUN: 'bun'
7069
readonly CLI: 'cli'
@@ -138,7 +137,7 @@ const ALERT_TYPE_CVE = 'cve'
138137
const ALERT_TYPE_MEDIUM_CVE = 'mediumCVE'
139138
const ALERT_TYPE_MILD_CVE = 'mildCVE'
140139
const ALERT_TYPE_SOCKET_UPGRADE_AVAILABLE = 'socketUpgradeAvailable'
141-
const API_V0_URL = 'https://api.socket.dev/v0'
140+
const API_V0_URL = 'https://api.socket.dev/v0/'
142141
const BINARY_LOCK_EXT = '.lockb'
143142
const BUN = 'bun'
144143
const CLI = 'cli'
@@ -160,38 +159,31 @@ const REQUIRE = 'require'
160159
const SHADOW_NPM_BIN = 'shadow-bin'
161160
const SHADOW_NPM_INJECT = 'shadow-npm-inject'
162161
const SHADOW_NPM_PATHS = 'shadow-npm-paths'
163-
const SOCKET_CLI_BIN_NAME = SOCKET
164-
const SOCKET_CLI_BIN_NAME_ALIAS = CLI
162+
const SOCKET_CLI_BIN_NAME = 'socket'
163+
const SOCKET_CLI_BIN_NAME_ALIAS = 'cli'
165164
const SOCKET_CLI_DEBUG = 'SOCKET_CLI_DEBUG'
166165
const SOCKET_CLI_FIX = 'SOCKET_CLI_FIX'
167166
const SOCKET_CLI_ISSUES_URL = 'https://github.com/SocketDev/socket-cli/issues'
168-
const SOCKET_CLI_LEGACY_PACKAGE_NAME = `${SOCKET_SECURITY_SCOPE}/${CLI}`
167+
const SOCKET_CLI_LEGACY_PACKAGE_NAME = `${SOCKET_SECURITY_SCOPE}/cli`
169168
const SOCKET_CLI_NO_API_TOKEN = 'SOCKET_CLI_NO_API_TOKEN'
170169
const SOCKET_CLI_OPTIMIZE = 'SOCKET_CLI_OPTIMIZE'
171-
const SOCKET_CLI_NPM_BIN_NAME = `${SOCKET}-${NPM}`
172-
const SOCKET_CLI_NPX_BIN_NAME = `${SOCKET}-${NPX}`
173-
const SOCKET_CLI_PACKAGE_NAME = SOCKET
170+
const SOCKET_CLI_NPM_BIN_NAME = 'socket-npm'
171+
const SOCKET_CLI_NPX_BIN_NAME = 'socket-npx'
172+
const SOCKET_CLI_PACKAGE_NAME = 'socket'
174173
const SOCKET_CLI_SAFE_WRAPPER = 'SOCKET_CLI_SAFE_WRAPPER'
175-
const SOCKET_CLI_SENTRY_BIN_NAME = `${SOCKET_CLI_BIN_NAME}-${WITH_SENTRY}`
176-
const SOCKET_CLI_SENTRY_BIN_NAME_ALIAS = `${SOCKET_CLI_BIN_NAME_ALIAS}-${WITH_SENTRY}`
177-
const SOCKET_CLI_SENTRY_NPM_BIN_NAME = `${SOCKET_CLI_NPM_BIN_NAME}-${WITH_SENTRY}`
178-
const SOCKET_CLI_SENTRY_NPX_BIN_NAME = `${SOCKET_CLI_NPX_BIN_NAME}-${WITH_SENTRY}`
179-
const SOCKET_CLI_SENTRY_PACKAGE_NAME = `${SOCKET_CLI_LEGACY_PACKAGE_NAME}-${WITH_SENTRY}`
174+
const SOCKET_CLI_SENTRY_BIN_NAME = 'socket-with-sentry'
175+
const SOCKET_CLI_SENTRY_BIN_NAME_ALIAS = 'cli-with-sentry'
176+
const SOCKET_CLI_SENTRY_NPM_BIN_NAME = 'socket-npm-with-sentry'
177+
const SOCKET_CLI_SENTRY_NPX_BIN_NAME = 'socket-npx-with-sentry'
178+
const SOCKET_CLI_SENTRY_PACKAGE_NAME = `${SOCKET_SECURITY_SCOPE}/cli-with-sentry`
180179
const VLT = 'vlt'
181180
const YARN = 'yarn'
182-
const YARN_BERRY = `${YARN}/berry`
183-
const YARN_CLASSIC = `${YARN}/classic`
184-
const YARN_LOCK = `${YARN}${LOCK_EXT}`
181+
const YARN_BERRY = 'yarn/berry'
182+
const YARN_CLASSIC = 'yarn/classic'
183+
const YARN_LOCK = 'yarn.lock'
185184

186185
let _Sentry: any
187186

188-
const LAZY_BATCH_PURL_ENDPOINT = () => {
189-
const query = new URLSearchParams()
190-
query.append('alerts', 'true')
191-
query.append('compact', 'true')
192-
return `${API_V0_URL}/purl?${query}`
193-
}
194-
195187
const LAZY_DIST_TYPE = () =>
196188
registryConstants.SUPPORTS_NODE_REQUIRE_MODULE ? MODULE_SYNC : REQUIRE
197189

@@ -204,20 +196,20 @@ const LAZY_ENV = () => {
204196
...registryConstants.ENV,
205197
// Inlined flag set to determine if this is the Legacy build.
206198
// The '@rollup/plugin-replace' will replace "process.env[INLINED_SOCKET_CLI_LEGACY_BUILD]".
207-
[INLINED_SOCKET_CLI_LEGACY_BUILD]:
208-
process.env[INLINED_SOCKET_CLI_LEGACY_BUILD],
199+
INLINED_SOCKET_CLI_LEGACY_BUILD:
200+
process.env['INLINED_SOCKET_CLI_LEGACY_BUILD'],
209201
// Inlined flag set to determine if this is a published build.
210202
// The '@rollup/plugin-replace' will replace "process.env[INLINED_SOCKET_CLI_PUBLISHED_BUILD]".
211-
[INLINED_SOCKET_CLI_PUBLISHED_BUILD]:
212-
process.env[INLINED_SOCKET_CLI_PUBLISHED_BUILD],
203+
INLINED_SOCKET_CLI_PUBLISHED_BUILD:
204+
process.env['INLINED_SOCKET_CLI_PUBLISHED_BUILD'],
213205
// Inlined flag set to determine if this is the Sentry build.
214206
// The '@rollup/plugin-replace' will replace "process.env[INLINED_SOCKET_CLI_SENTRY_BUILD]".
215-
[INLINED_SOCKET_CLI_SENTRY_BUILD]:
216-
process.env[INLINED_SOCKET_CLI_SENTRY_BUILD],
207+
INLINED_SOCKET_CLI_SENTRY_BUILD:
208+
process.env['INLINED_SOCKET_CLI_SENTRY_BUILD'],
217209
// Flag set to help debug Socket CLI.
218-
[SOCKET_CLI_DEBUG]: envAsBoolean(env[SOCKET_CLI_DEBUG]),
210+
SOCKET_CLI_DEBUG: envAsBoolean(env['SOCKET_CLI_DEBUG']),
219211
// Flag set to make the default API token `undefined`.
220-
[SOCKET_CLI_NO_API_TOKEN]: envAsBoolean(env[SOCKET_CLI_NO_API_TOKEN])
212+
SOCKET_CLI_NO_API_TOKEN: envAsBoolean(env['SOCKET_CLI_NO_API_TOKEN'])
221213
})
222214
}
223215

@@ -278,7 +270,7 @@ const lazyNmBinPath = () =>
278270
const lazyNodeHardenFlags = () =>
279271
// The '@rollup/plugin-replace' will replace "process.env[INLINED_SOCKET_CLI_SENTRY_BUILD]".
280272
// Lazily access constants.WIN32.
281-
process.env[INLINED_SOCKET_CLI_SENTRY_BUILD] || constants.WIN32
273+
process.env['INLINED_SOCKET_CLI_SENTRY_BUILD'] || constants.WIN32
282274
? []
283275
: // Harden Node security.
284276
// https://nodejs.org/en/learn/getting-started/security-best-practices
@@ -319,13 +311,12 @@ const constants = createConstantsObject(
319311
ALERT_TYPE_MILD_CVE,
320312
ALERT_TYPE_SOCKET_UPGRADE_AVAILABLE,
321313
API_V0_URL,
322-
// Lazily defined values are initialized as `undefined` to keep their key order.
323-
BATCH_PURL_ENDPOINT: undefined,
324314
BINARY_LOCK_EXT,
325315
BUN,
326316
CLI,
327317
CVE_ALERT_PROPS_FIRST_PATCHED_VERSION_IDENTIFIER,
328318
CVE_ALERT_PROPS_VULNERABLE_VERSION_RANGE,
319+
// Lazily defined values are initialized as `undefined` to keep their key order.
329320
DIST_TYPE: undefined,
330321
DRY_RUN_LABEL,
331322
DRY_RUN_BAIL_TEXT,
@@ -352,6 +343,8 @@ const constants = createConstantsObject(
352343
SOCKET_CLI_SENTRY_BIN_NAME_ALIAS,
353344
SOCKET_CLI_LEGACY_PACKAGE_NAME,
354345
SOCKET_CLI_NO_API_TOKEN,
346+
SOCKET_CLI_NPM_BIN_NAME,
347+
SOCKET_CLI_NPX_BIN_NAME,
355348
SOCKET_CLI_OPTIMIZE,
356349
SOCKET_CLI_PACKAGE_NAME,
357350
SOCKET_CLI_SAFE_WRAPPER,
@@ -383,7 +376,6 @@ const constants = createConstantsObject(
383376
},
384377
{
385378
getters: {
386-
BATCH_PURL_ENDPOINT: LAZY_BATCH_PURL_ENDPOINT,
387379
DIST_TYPE: LAZY_DIST_TYPE,
388380
ENV: LAZY_ENV,
389381
bashRcPath: lazyBashRcPath,

0 commit comments

Comments
 (0)