Skip to content
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

feat: add support for npm modules #454

Merged
merged 20 commits into from
Sep 6, 2023
Merged
Show file tree
Hide file tree
Changes from 19 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
1 change: 1 addition & 0 deletions .eslintrc.cjs
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ module.exports = {
complexity: 'off',
'import/extensions': 'off',
'max-lines': 'off',
'max-lines-per-function': 'off',
'max-statements': 'off',
'node/no-missing-import': 'off',
'no-magic-numbers': 'off',
Expand Down
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
*.swp
npm-debug.log
node_modules
!test/fixtures/**/node_modules
/core
.eslintcache
.npmrc
Expand Down
4 changes: 2 additions & 2 deletions deno/bundle.ts
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
import { writeStage2 } from './lib/stage2.ts'

const [payload] = Deno.args
const { basePath, destPath, externals, functions, importMapData } = JSON.parse(payload)
const { basePath, destPath, externals, functions, importMapData, vendorDirectory } = JSON.parse(payload)

await writeStage2({ basePath, destPath, externals, functions, importMapData })
await writeStage2({ basePath, destPath, externals, functions, importMapData, vendorDirectory })
25 changes: 21 additions & 4 deletions deno/lib/stage2.ts
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ import { build, LoadResponse } from 'https://deno.land/x/[email protected]/mod.ts'
import * as path from 'https://deno.land/[email protected]/path/mod.ts'

import type { InputFunction, WriteStage2Options } from '../../shared/stage2.ts'
import { importMapSpecifier, virtualRoot } from '../../shared/consts.ts'
import { importMapSpecifier, virtualRoot, virtualVendorRoot } from '../../shared/consts.ts'
import { LEGACY_PUBLIC_SPECIFIER, PUBLIC_SPECIFIER, STAGE2_SPECIFIER } from './consts.ts'
import { inlineModule, loadFromVirtualRoot, loadWithRetry } from './common.ts'

Expand Down Expand Up @@ -63,7 +63,13 @@ const getVirtualPath = (basePath: string, filePath: string) => {
return url
}

const stage2Loader = (basePath: string, functions: InputFunction[], externals: Set<string>, importMapData?: string) => {
const stage2Loader = (
basePath: string,
functions: InputFunction[],
externals: Set<string>,
importMapData: string | undefined,
vendorDirectory?: string,
) => {
return async (specifier: string): Promise<LoadResponse | undefined> => {
if (specifier === STAGE2_SPECIFIER) {
const stage2Entry = getStage2Entry(basePath, functions)
Expand Down Expand Up @@ -91,13 +97,24 @@ const stage2Loader = (basePath: string, functions: InputFunction[], externals: S
return loadFromVirtualRoot(specifier, virtualRoot, basePath)
}

if (vendorDirectory !== undefined && specifier.startsWith(virtualVendorRoot)) {
return loadFromVirtualRoot(specifier, virtualVendorRoot, vendorDirectory)
}

return await loadWithRetry(specifier)
}
}

const writeStage2 = async ({ basePath, destPath, externals, functions, importMapData }: WriteStage2Options) => {
const writeStage2 = async ({
basePath,
destPath,
externals,
functions,
importMapData,
vendorDirectory,
}: WriteStage2Options) => {
const importMapURL = importMapData ? importMapSpecifier : undefined
const loader = stage2Loader(basePath, functions, new Set(externals), importMapData)
const loader = stage2Loader(basePath, functions, new Set(externals), importMapData, vendorDirectory)
const bytes = await build([STAGE2_SPECIFIER], loader, importMapURL)
const directory = path.dirname(destPath)

Expand Down
31 changes: 30 additions & 1 deletion node/bundler.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -131,7 +131,7 @@ test('Prints a nice error message when user tries importing NPM module', async (
} catch (error) {
expect(error).toBeInstanceOf(BundleError)
expect((error as BundleError).message).toEqual(
`It seems like you're trying to import an npm module. This is only supported via CDNs like esm.sh. Have you tried 'import mod from "https://esm.sh/p-retry"'?`,
`It seems like you're trying to import an npm module. This is only supported via CDNs like esm.sh. Have you tried 'import mod from "https://esm.sh/parent-1"'?`,
)
} finally {
await cleanup()
Expand Down Expand Up @@ -446,3 +446,32 @@ test('Handles imports with the `node:` prefix', async () => {

await cleanup()
})

test('Loads npm modules from bare specifiers with and without the `npm:` prefix', async () => {
const { basePath, cleanup, distPath } = await useFixture('imports_npm_module')
const sourceDirectory = join(basePath, 'functions')
const declarations: Declaration[] = [
{
function: 'func1',
path: '/func1',
},
]
const vendorDirectory = await tmp.dir()

await bundle([sourceDirectory], distPath, declarations, {
basePath,
featureFlags: { edge_functions_npm_modules: true },
vendorDirectory: vendorDirectory.path,
})
const manifestFile = await readFile(resolve(distPath, 'manifest.json'), 'utf8')
const manifest = JSON.parse(manifestFile)
const bundlePath = join(distPath, manifest.bundles[0].asset)
const { func1 } = await runESZIP(bundlePath, vendorDirectory.path)

expect(func1).toBe(
`<parent-1><child-1>JavaScript</child-1></parent-1>, <parent-2><child-2><grandchild-1>APIs<cwd>${process.cwd()}</cwd></grandchild-1></child-2></parent-2>, <parent-3><child-2><grandchild-1>Markup<cwd>${process.cwd()}</cwd></grandchild-1></child-2></parent-3>`,
)

await cleanup()
await rm(vendorDirectory.path, { force: true, recursive: true })
})
58 changes: 48 additions & 10 deletions node/bundler.ts
Original file line number Diff line number Diff line change
Expand Up @@ -11,46 +11,50 @@ import type { Bundle } from './bundle.js'
import { FunctionConfig, getFunctionConfig } from './config.js'
import { Declaration, mergeDeclarations } from './declaration.js'
import { load as loadDeployConfig } from './deploy_config.js'
import { EdgeFunction } from './edge_function.js'
import { FeatureFlags, getFlags } from './feature_flags.js'
import { findFunctions } from './finder.js'
import { bundle as bundleESZIP } from './formats/eszip.js'
import { ImportMap } from './import_map.js'
import { getLogger, LogFunction } from './logger.js'
import { getLogger, LogFunction, Logger } from './logger.js'
import { writeManifest } from './manifest.js'
import { vendorNPMSpecifiers } from './npm_dependencies.js'
import { ensureLatestTypes } from './types.js'

interface BundleOptions {
export interface BundleOptions {
basePath?: string
bootstrapURL?: string
cacheDirectory?: string
configPath?: string
debug?: boolean
distImportMapPath?: string
featureFlags?: FeatureFlags
importMapPaths?: (string | undefined)[]
internalSrcFolder?: string
onAfterDownload?: OnAfterDownloadHook
onBeforeDownload?: OnBeforeDownloadHook
systemLogger?: LogFunction
internalSrcFolder?: string
bootstrapURL?: string
vendorDirectory?: string
}

const bundle = async (
export const bundle = async (
sourceDirectories: string[],
distDirectory: string,
tomlDeclarations: Declaration[] = [],
{
basePath: inputBasePath,
bootstrapURL = 'https://edge.netlify.com/bootstrap/index-combined.ts',
cacheDirectory,
configPath,
debug,
distImportMapPath,
featureFlags: inputFeatureFlags,
importMapPaths = [],
internalSrcFolder,
onAfterDownload,
onBeforeDownload,
systemLogger,
internalSrcFolder,
bootstrapURL = 'https://edge.netlify.com/bootstrap/index-combined.ts',
vendorDirectory,
}: BundleOptions = {},
) => {
const logger = getLogger(systemLogger, debug)
Expand Down Expand Up @@ -94,6 +98,11 @@ const bundle = async (
const userFunctions = userSourceDirectories.length === 0 ? [] : await findFunctions(userSourceDirectories)
const internalFunctions = internalSrcFolder ? await findFunctions([internalSrcFolder]) : []
const functions = [...internalFunctions, ...userFunctions]
const vendor = await safelyVendorNPMSpecifiers({ basePath, featureFlags, functions, logger, vendorDirectory })

if (vendor) {
importMap.add(vendor.importMap)
}

const functionBundle = await bundleESZIP({
basePath,
Expand All @@ -105,6 +114,7 @@ const bundle = async (
functions,
featureFlags,
importMap,
vendorDirectory: vendor?.directory,
})

// The final file name of the bundles contains a SHA256 hash of the contents,
Expand All @@ -117,7 +127,6 @@ const bundle = async (
const internalConfigPromises = internalFunctions.map(
async (func) => [func.name, await getFunctionConfig({ func, importMap, deno, log: logger, bootstrapURL })] as const,
)

const userConfigPromises = userFunctions.map(
async (func) => [func.name, await getFunctionConfig({ func, importMap, deno, log: logger, bootstrapURL })] as const,
)
Expand Down Expand Up @@ -153,6 +162,8 @@ const bundle = async (
layers: deployConfig.layers,
})

await vendor?.cleanup()

if (distImportMapPath) {
await importMap.writeToFile(distImportMapPath)
}
Expand Down Expand Up @@ -225,5 +236,32 @@ const createFunctionConfig = ({ internalFunctionsWithConfig, declarations }: Cre
}
}, {} as Record<string, FunctionConfig>)

export { bundle }
export type { BundleOptions }
interface VendorNPMOptions {
basePath: string
featureFlags: FeatureFlags
functions: EdgeFunction[]
logger: Logger
vendorDirectory: string | undefined
}

const safelyVendorNPMSpecifiers = async ({
basePath,
featureFlags,
functions,
logger,
vendorDirectory,
}: VendorNPMOptions) => {
if (!featureFlags.edge_functions_npm_modules) {
return
}

try {
return await vendorNPMSpecifiers(
basePath,
functions.map(({ path }) => path),
vendorDirectory,
)
} catch (error) {
logger.system(error)
}
}
1 change: 1 addition & 0 deletions node/feature_flags.ts
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
const defaultFlags = {
edge_functions_fail_unsupported_regex: false,
edge_functions_npm_modules: false,
}

type FeatureFlag = keyof typeof defaultFlags
Expand Down
17 changes: 11 additions & 6 deletions node/formats/eszip.ts
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
import { join } from 'path'
import { pathToFileURL } from 'url'

import { virtualRoot } from '../../shared/consts.js'
import { virtualRoot, virtualVendorRoot } from '../../shared/consts.js'
import type { WriteStage2Options } from '../../shared/stage2.js'
import { DenoBridge } from '../bridge.js'
import { Bundle, BundleFormat } from '../bundle.js'
Expand All @@ -23,6 +23,7 @@ interface BundleESZIPOptions {
featureFlags: FeatureFlags
functions: EdgeFunction[]
importMap: ImportMap
vendorDirectory?: string
}

const bundleESZIP = async ({
Expand All @@ -34,23 +35,27 @@ const bundleESZIP = async ({
externals,
functions,
importMap,
vendorDirectory,
}: BundleESZIPOptions): Promise<Bundle> => {
const extension = '.eszip'
const destPath = join(distDirectory, `${buildID}${extension}`)
const { bundler, importMap: bundlerImportMap } = getESZIPPaths()

// Transforming all paths under `basePath` to use the virtual root prefix.
const importMapPrefixes: Record<string, string> = {
[`${pathToFileURL(basePath)}/`]: virtualRoot,
}
const importMapData = importMap.getContents(importMapPrefixes)

if (vendorDirectory !== undefined) {
importMapPrefixes[`${pathToFileURL(vendorDirectory)}/`] = virtualVendorRoot
}

const { bundler, importMap: bundlerImportMap } = getESZIPPaths()
const importMapData = JSON.stringify(importMap.getContents(importMapPrefixes))
const payload: WriteStage2Options = {
basePath,
destPath,
externals,
functions,
importMapData: JSON.stringify(importMapData),
importMapData,
vendorDirectory,
}
const flags = ['--allow-all', '--no-config', `--import-map=${bundlerImportMap}`]

Expand Down
Loading