/
parseForPolicy.js
406 lines (385 loc) · 11.8 KB
/
parseForPolicy.js
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
const path = require('node:path')
const { promises: fs } = require('node:fs')
const { builtinModules } = require('node:module')
const resolve = require('resolve')
const bindings = require('bindings')
const gypBuild = require('node-gyp-build')
const { codeFrameColumns } = require('@babel/code-frame')
const { default: highlight } = require('@babel/highlight')
const {
loadCanonicalNameMap,
getPackageNameForModulePath,
} = require('@lavamoat/aa')
const {
parseForPolicy: coreParseForConfig,
createModuleInspector,
LavamoatModuleRecord,
} = require('lavamoat-core')
const {
parse,
inspectImports,
codeSampleFromAstNode,
} = require('lavamoat-tofu')
const { checkForResolutionOverride } = require('./resolutions')
// file extension omitted can be omitted, eg https://npmfs.com/package/yargs/17.0.1/yargs
const commonjsExtensions = ['', '.js', '.cjs']
const resolutionOmittedExtensions = ['.js', '.json']
/**
* Allow use of `node:` prefixed builtins.
*/
const builtinPackages = [
...builtinModules,
...builtinModules.map((id) => `node:${id}`),
]
// approximate polyfill for node builtin
const createRequire = (url) => {
return {
resolve: (requestedName) => {
const basedir = path.dirname(url.pathname)
const result = resolve.sync(requestedName, {
basedir,
extensions: resolutionOmittedExtensions,
})
// check for missing builtin modules (e.g. 'worker_threads' in node v10)
// the "resolve" package resolves as "worker_threads" even if missing
const resultMatchesRequest = requestedName === result
if (resultMatchesRequest) {
const isBuiltinModule = builtinPackages.includes(result)
const looksLikeAPath = requestedName.includes('/')
if (!looksLikeAPath && !isBuiltinModule) {
const errMsg = `Cannot find module '${requestedName}' from '${basedir}'`
const err = new Error(errMsg)
err.code = 'MODULE_NOT_FOUND'
throw err
}
}
// return resolved path
return result
},
}
}
module.exports = {
parseForPolicy,
makeResolveHook,
makeImportHook,
resolutionOmittedExtensions,
}
/**
* @typedef ParseForPolicyOpts
* @property {string} projectRoot
* @property {string} entryId
* @property {import('lavamoat-core').LavaMoatPolicy} policyOverride
* @property {string} rootPackageName
* @property {(requestedName: string, specifier: string) => boolean} shouldResolve
* @property {includeDebugInfo} boolean
*/
/**
*
* @param {ParseForPolicyOpts} opts
* @returns {Promise<import('lavamoat-core').LavaMoatPolicy>}
*/
async function parseForPolicy({
projectRoot,
entryId,
policyOverride = {},
rootPackageName,
shouldResolve,
includeDebugInfo,
...args
}) {
const isBuiltin = (id) => builtinPackages.includes(id)
const { resolutions } = policyOverride
const canonicalNameMap = await loadCanonicalNameMap({
rootDir: projectRoot,
includeDevDeps: true,
})
const resolveHook = makeResolveHook({
projectRoot,
resolutions,
rootPackageName,
canonicalNameMap,
})
const importHook = makeImportHook({
rootPackageName,
shouldResolve,
isBuiltin,
resolveHook,
canonicalNameMap,
})
const moduleSpecifier = resolveHook(
entryId,
path.join(projectRoot, 'package.json')
)
const inspector = createModuleInspector({ isBuiltin, includeDebugInfo })
// rich warning output
inspector.on('compat-warning', displayRichCompatWarning)
return coreParseForConfig({
moduleSpecifier,
importHook,
isBuiltin,
inspector,
policyOverride,
...args,
})
}
function makeResolveHook({ projectRoot, resolutions = {}, canonicalNameMap }) {
return (requestedName, referrer) => {
const parentPackageName = getPackageNameForModulePath(
canonicalNameMap,
referrer
)
// handle resolution overrides
const result = checkForResolutionOverride(
resolutions,
parentPackageName,
requestedName
)
if (result) {
// if path is a relative path, it should be relative to the projectRoot
if (path.isAbsolute(result)) {
requestedName = result
} else {
requestedName = path.resolve(projectRoot, result)
}
}
// utilize node's internal resolution algo
const { resolve } = createRequire(new URL(`file://${referrer}`))
/* eslint-disable no-useless-catch */
let resolved
try {
resolved = resolve(requestedName)
} catch (err) {
if (err.code === 'MODULE_NOT_FOUND') {
console.warn(
`lavamoat - unable to resolve "${requestedName}" from "${referrer}"`
)
}
// return "null" to mean failed to resolve
return null
}
return resolved
}
}
function makeImportHook({
isBuiltin,
resolveHook,
shouldResolve = () => true,
canonicalNameMap,
policyOverride,
}) {
return async (specifier) => {
// see if its a builtin
if (isBuiltin(specifier)) {
return makeBuiltinModuleRecord(specifier)
}
// assume specifier is filename
const filename = specifier
const extension = path.extname(filename)
const packageName = getPackageNameForModulePath(canonicalNameMap, filename)
if (commonjsExtensions.includes(extension)) {
return makeJsModuleRecord(specifier, filename, packageName)
}
if (extension === '.node') {
return makeNativeModuleRecord(specifier, filename, packageName)
}
if (extension === '.json') {
return makeJsonModuleRecord(specifier, filename, packageName)
}
throw new Error(
`lavamoat-node/makeImportHook - unknown module file extension "${extension}" in filename "${filename}"`
)
}
function makeBuiltinModuleRecord(specifier) {
return new LavamoatModuleRecord({
type: 'builtin',
specifier,
file: `builtin/${specifier}`,
packageName: specifier,
// special module initializer that directly accesses node's require
moduleInitializer: (moduleExportsWrapper) => {
moduleExportsWrapper.exports = require(specifier)
},
})
}
function makeNativeModuleRecord(specifier, filename, packageName) {
return new LavamoatModuleRecord({
type: 'native',
specifier,
file: filename,
packageName,
// special module initializer that directly accesses node's require
moduleInitializer: (moduleExportsWrapper) => {
moduleExportsWrapper.exports = require(specifier)
},
})
}
async function makeJsModuleRecord(specifier, filename, packageName) {
// load src
const content = await fs.readFile(filename, 'utf8')
// parse
const ast = parseModule(content, specifier)
// get imports
const { cjsImports } = inspectImports(ast, null, false)
// build import map
const importMap = Object.fromEntries(
cjsImports.map((requestedName) => {
let depValue
if (shouldResolve(requestedName, specifier)) {
try {
depValue = resolveHook(requestedName, specifier)
} catch (err) {
// graceful failure
console.warn(
`lavamoat-node/makeImportHandler - could not resolve "${requestedName}" from "${specifier}"`
)
depValue = null
}
} else {
// resolving is skipped so put in a dummy value
depValue = null
}
return [requestedName, depValue]
})
)
// add policyOverride additions to import map (policy gen only)
const policyOverrideImports = Object.keys(
policyOverride?.resources?.[packageName]?.packages ?? {}
)
await Promise.all(
policyOverrideImports.map(async (packageName) => {
// skip if there is already an entry for the name
if (packageName in importMap[packageName]) {
return
}
// resolve and add package main in override
const packageRoot = getMapKeyForValue(canonicalNameMap, packageName)
const packageJson = JSON.parse(
await fs.readFile(path.join(packageRoot, 'package.json'), 'utf8')
)
const main = packageJson.main ?? 'index.js'
const mainPath = path.resolve(packageRoot, main)
importMap[packageName] = mainPath
})
)
// heuristics for detecting common dynamically imported native modules
// important for generating a working config for apps with native modules
if (importMap.bindings) {
// detect native modules using "bindings" package
try {
const packageDir = bindings.getRoot(filename)
const nativeModulePath = bindings({
path: true,
module_root: packageDir,
})
importMap[nativeModulePath] = nativeModulePath
} catch (err) {
// ignore resolution failures
if (!err.message.includes('Could not locate the bindings file')) {
throw err
}
}
}
if (importMap['node-gyp-build']) {
// detect native modules using "node-gyp-build" package
try {
const packageDir = bindings.getRoot(filename)
const nativeModulePath = gypBuild.path(packageDir)
importMap[nativeModulePath] = nativeModulePath
} catch (err) {
// ignore resolution failures
if (!err.message.includes('No native build was found')) {
throw err
}
}
}
return new LavamoatModuleRecord({
type: 'js',
specifier,
file: filename,
packageName,
content,
importMap,
ast,
})
}
async function makeJsonModuleRecord(specifier, filename, packageName) {
// load src
const rawContent = await fs.readFile(filename, 'utf8')
// validate json
JSON.parse(rawContent)
// wrap as commonjs module
const cjsContent = `module.exports=${rawContent}`
return new LavamoatModuleRecord({
type: 'js',
specifier,
file: filename,
packageName,
content: cjsContent,
})
}
}
function parseModule(moduleSrc, filename = '<unknown file>') {
let ast
try {
// transformFromAstAsync
ast = parse(moduleSrc, {
// esm support
sourceType: 'unambiguous',
// someone must have been doing this
allowReturnOutsideFunction: true,
// plugins: [
// '@babel/plugin-transform-literals',
// // '@babel/plugin-transform-reserved-words',
// // '@babel/plugin-proposal-class-properties',
// ]
errorRecovery: true,
})
} catch (err) {
const newErr = new Error(`Failed to parse file "${filename}": ${err.stack}`)
newErr.file = filename
newErr.prevErr = err
throw newErr
}
return ast
}
function displayRichCompatWarning({ moduleRecord, compatWarnings }) {
const { packageName, file } = moduleRecord
const { primordialMutations, strictModeViolations, dynamicRequires } =
compatWarnings
console.warn(
`⚠️ Potentially Incompatible code detected in package "${packageName}" file "${file}":`
)
const highlightedCode = highlight(moduleRecord.content)
logWarnings('primordial mutation', primordialMutations)
logWarnings('dynamic require', dynamicRequires)
logErrors('strict mode violation', strictModeViolations)
function logWarnings(message, sites) {
sites.forEach(({ node }) => {
const { npmfs } = codeSampleFromAstNode(node, moduleRecord)
if (npmfs) {
console.warn(` link: ${npmfs}`)
}
const output = codeFrameColumns(highlightedCode, node.loc, { message })
console.warn(output)
})
}
function logErrors(category, sites) {
sites.forEach(({ loc, error }) => {
const range = { start: loc }
const { npmfs } = codeSampleFromAstNode({ loc: range }, moduleRecord)
if (npmfs) {
console.warn(` link: ${npmfs}`)
}
const message = `${category}: ${error.message}`
const output = codeFrameColumns(highlightedCode, range, { message })
console.warn(output)
})
}
}
function getMapKeyForValue(map, searchValue) {
for (let [key, value] of map.entries()) {
if (value === searchValue) {
return key
}
}
}