-
Notifications
You must be signed in to change notification settings - Fork 69
/
index.js
347 lines (316 loc) · 10.9 KB
/
index.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
const fs = require('node:fs')
const path = require('node:path')
const { getDefaultPaths } = require('lavamoat-core')
const jsonStringify = require('json-stable-stringify')
const { createModuleInspectorSpy } = require('./createModuleInspectorSpy.js')
const { createPackageDataStream } = require('./createPackageDataStream.js')
const createLavaPack = require('@lavamoat/lavapack')
const { createSesWorkaroundsTransform } = require('./sesTransforms')
const { loadCanonicalNameMap } = require('@lavamoat/aa')
const browserResolve = require('browser-resolve')
// these are the reccomended arguments for lavaMoat to work well with browserify
const reccomendedArgs = {
// this option helps with parsing global usage
insertGlobalVars: {
global: false,
},
// this option prevents creating unnecesary psuedo-dependencies
// where packages appear to rely on other packages because they
// are using each other for code deduplication
// this also breaks bify-package-factor and related tools
dedupe: false,
}
// primary export is the Browserify plugin
module.exports = plugin
module.exports.createLavamoatPacker = createLavamoatPacker
module.exports.loadPolicy = loadPolicyFromPluginOpts
module.exports.args = reccomendedArgs
function plugin(browserify, pluginOpts) {
// pluginOpts.policy is policy path
const configuration = getConfigurationFromPluginOpts(pluginOpts)
// setup the plugin in a re-bundle friendly way
browserify.on('reset', setupPlugin)
setupPlugin()
function setupPlugin() {
let canonicalNameMap
async function getCanonicalNameMap() {
// load canonical name map on first request
if (canonicalNameMap === undefined) {
canonicalNameMap = await loadCanonicalNameMap({
rootDir: configuration.projectRoot,
// need this in order to walk browser builtin deps
includeDevDeps: true,
resolve: browserResolve,
})
}
return canonicalNameMap
}
// some workarounds for SES strict parsing and evaluation
browserify.transform(createSesWorkaroundsTransform(), { global: true })
// inject package name into module data
browserify.pipeline.get('emit-deps').unshift(
createPackageDataStream({
getCanonicalNameMap,
})
)
// if writeAutoPolicy activated, insert hook
if (configuration.writeAutoPolicy) {
const policyOverride = loadPolicyFile({
filepath: configuration.policyPaths.override,
tolerateMissing: true,
})
validatePolicy(policyOverride)
browserify.pipeline.get('emit-deps').push(
createModuleInspectorSpy({
policyOverride,
// no builtins in the browser (yet!)
isBuiltin: () => false,
// should prepare debug info
includeDebugInfo: configuration.writeAutoPolicyDebug,
// write policy files to disk
onResult: (policy) => writeAutoPolicy(policy, configuration),
})
)
} else {
// when not generating policy files, announce policy files as build deps for watchify
// ref https://github.com/browserify/watchify#working-with-browserify-transforms
const primary = path.resolve(
configuration.projectRoot,
configuration.policyPaths.primary
)
const override = path.resolve(
configuration.projectRoot,
configuration.policyPaths.override
)
// wait until next tick to ensure file event subscribers have run
setTimeout(() => {
browserify.emit('file', primary)
browserify.emit('file', override)
})
}
// replace the standard browser-pack with our custom packer
browserify.pipeline
.get('pack')
.splice(0, 1, createLavamoatPacker(configuration))
}
}
function loadPolicyFromPluginOpts(pluginOpts = {}) {
const configuration = getConfigurationFromPluginOpts(pluginOpts)
return loadPolicy(configuration)
}
function getConfigurationFromPluginOpts(pluginOpts) {
const aliasMap = {
a: 'writeAutoPolicy',
autopolicy: 'writeAutoPolicy',
p: 'policy',
o: 'policyOverride',
override: 'policyOverride',
dp: 'writeAutoPolicyDebug',
debugpolicy: 'writeAutoPolicyDebug',
pr: 'includePrelude',
prelude: 'includePrelude',
pp: 'prunePolicy',
prunepolicy: 'prunePolicy',
d: 'debugMode',
debug: 'debugMode',
stats: 'statsMode',
pn: 'policyName',
r: 'projectRoot',
}
const nonAliasedOptions = [
'scuttleGlobalThis',
'scuttleGlobalThisExceptions',
'bundleWithPrecompiledModules',
'policyDebug',
'projectRoot',
]
const allowedKeys = new Set([
...nonAliasedOptions,
...Object.keys(aliasMap),
...Object.values(aliasMap),
'_', // Browserify adds this as the first option when running from the command line
])
const invalidKeys = Reflect.ownKeys(pluginOpts).filter(
(key) => !allowedKeys.has(key)
)
if (invalidKeys.length) {
throw new Error(`Lavamoat - Unrecognized options provided '${invalidKeys}'`)
}
// applying alias to pluginOpts
Object.entries(pluginOpts).forEach(([key, value]) => {
if (Object.keys(aliasMap).includes(key)) {
pluginOpts[aliasMap[key]] = value
}
})
if (!pluginOpts.policyName) {
pluginOpts.policyName = 'browserify'
}
if (!pluginOpts.projectRoot) {
pluginOpts.projectRoot = process.cwd()
}
if (pluginOpts.scuttleGlobalThisExceptions) {
console.warn(
'Lavamoat - "scuttleGlobalThisExceptions" is deprecated. Use "scuttleGlobalThis.exceptions" instead.'
)
if (pluginOpts.scuttleGlobalThis === true) {
pluginOpts.scuttleGlobalThis = { enabled: true }
}
pluginOpts.scuttleGlobalThis.exceptions =
pluginOpts.scuttleGlobalThis?.exceptions ||
pluginOpts.scuttleGlobalThisExceptions
}
const configuration = {
projectRoot: pluginOpts.projectRoot,
includePrelude:
'includePrelude' in pluginOpts
? Boolean(pluginOpts.includePrelude)
: true,
pruneConfig: Boolean(pluginOpts.prunePolicy),
debugMode: Boolean(pluginOpts.debugMode),
statsMode: Boolean(pluginOpts.statsMode),
scuttleGlobalThis: pluginOpts.scuttleGlobalThis,
writeAutoPolicy: Boolean(
pluginOpts.writeAutoPolicy || pluginOpts.writeAutoPolicyDebug
),
writeAutoPolicyDebug: Boolean(pluginOpts.writeAutoPolicyDebug),
bundleWithPrecompiledModules:
'bundleWithPrecompiledModules' in pluginOpts
? Boolean(pluginOpts.bundleWithPrecompiledModules)
: true,
actionOverrides: {},
}
// check for action overrides
if (typeof pluginOpts.writeAutoPolicy === 'function') {
configuration.actionOverrides.writeAutoPolicy = pluginOpts.writeAutoPolicy
}
if (typeof pluginOpts.policy === 'object') {
const policyFromPluginOpts = pluginOpts.policy
configuration.actionOverrides.loadPrimaryPolicy = () => policyFromPluginOpts
delete pluginOpts.policy
}
// prepare policy paths
configuration.policyPaths = getPolicyPaths(pluginOpts)
return configuration
}
function writeAutoPolicy(policy, configuration) {
// check for action override
if (configuration.actionOverrides.writeAutoPolicy) {
configuration.actionOverrides.writeAutoPolicy(policy)
return
}
// write policy-debug file
if (configuration.writeAutoPolicyDebug) {
fs.mkdirSync(path.dirname(configuration.policyPaths.debug), {
recursive: true,
})
fs.writeFileSync(
configuration.policyPaths.debug,
jsonStringify(policy, { space: 2 })
)
console.warn(
`LavaMoat wrote policy debug to "${configuration.policyPaths.debug}"`
)
// clean up debugInfo
delete policy.debugInfo
}
// if missing, write empty policy-override file
const policyOverridePath = configuration.policyPaths.override
if (!fs.existsSync(policyOverridePath)) {
const basicPolicy = { resources: {} }
fs.mkdirSync(path.dirname(policyOverridePath), { recursive: true })
fs.writeFileSync(
policyOverridePath,
jsonStringify(basicPolicy, { space: 2 })
)
console.warn(`LavaMoat Override Policy - wrote to "${policyOverridePath}"`)
}
// write policy file
const policyPath = configuration.policyPaths.primary
fs.mkdirSync(path.dirname(policyPath), { recursive: true })
fs.writeFileSync(policyPath, jsonStringify(policy, { space: 2 }))
console.warn(`LavaMoat Policy - wrote to "${policyPath}"`)
}
function loadPolicyFile({ filepath, tolerateMissing }) {
const exists = fs.existsSync(filepath)
if (!exists) {
if (tolerateMissing) {
return { resources: {} }
}
throw new Error(
`Lavamoat - Policy file not found at path: '${filepath}', use --writeAutoPolicy option to generate one`
)
}
const content = fs.readFileSync(filepath, 'utf8')
const policyFile = JSON.parse(content)
return policyFile
}
// TODO: dedupe. lavamoat-core has a "loadPolicy" method but its async
function loadPolicy(configuration) {
let policy
if (configuration.actionOverrides.loadPrimaryPolicy) {
policy = configuration.actionOverrides.loadPrimaryPolicy()
} else {
policy = loadPolicyFile({
filepath: configuration.policyPaths.primary,
tolerateMissing: configuration.writeAutoPolicy,
})
}
validatePolicy(policy)
return policy
}
function getPolicyPaths(pluginOpts) {
const { projectRoot, policy, policyOverride, policyDebug, policyName } =
pluginOpts
const defaultPaths = getDefaultPaths(policyName)
const { primary, override, debug } = defaultPaths
return {
primary: policy || path.resolve(projectRoot, primary),
override: policyOverride || path.resolve(projectRoot, override),
debug: policyDebug || path.resolve(projectRoot, debug),
}
}
function createLavamoatPacker(configuration = {}) {
const defaults = {
raw: true,
policy: loadPolicy(configuration),
}
const packOpts = Object.assign({}, defaults, configuration)
const customPack = createLavaPack(packOpts)
return customPack
}
function validatePolicy(policy) {
if (typeof policy !== 'object') {
throw new Error(
`LavaMoat - Expected policy to be an object, got "${typeof policy}"`
)
}
if (!Object.keys(policy).includes('resources')) {
throw new Error(
"LavaMoat - Expected label 'resources' for configuration key"
)
}
Object.entries(policy.resources).forEach(([, packageOpts]) => {
const packageOptions = Object.keys(packageOpts)
const packageEntries = Object.values(packageOpts)
const optionsWhitelist = ['globals', 'packages']
const valuesWhitelist = [true, 'write']
if (
!packageOptions.every((packageOpt) =>
optionsWhitelist.includes(packageOpt)
)
) {
throw new Error(
"LavaMoat - Unrecognized package options. Expected 'globals' or 'packages'"
)
}
packageEntries.forEach((entry) => {
Object.values(entry).forEach((value) => {
if (!valuesWhitelist.includes(value)) {
throw new Error(
"LavaMoat - Globals or packages endowments must be equal to 'true'"
)
}
})
})
})
}