|
| 1 | +import {NodePath} from '@babel/core'; |
| 2 | +import * as t from '@babel/types'; |
| 3 | + |
| 4 | +import {CompilerError, EnvironmentConfig} from '..'; |
| 5 | +import {getOrInsertWith} from '../Utils/utils'; |
| 6 | +import {Environment} from '../HIR'; |
| 7 | +import {DEFAULT_EXPORT} from '../HIR/Environment'; |
| 8 | + |
| 9 | +export default function validateNoUntransformedReferences( |
| 10 | + path: NodePath<t.Program>, |
| 11 | + env: EnvironmentConfig, |
| 12 | + transformErrors: Array<{fn: NodePath<t.Node>; error: CompilerError}>, |
| 13 | +): void { |
| 14 | + function assertValidEffectImportReference( |
| 15 | + numArgs: number, |
| 16 | + paths: Array<NodePath<t.Node>>, |
| 17 | + ): void { |
| 18 | + for (const path of paths) { |
| 19 | + const parent = path.parentPath; |
| 20 | + if (parent != null && parent.isCallExpression()) { |
| 21 | + const args = parent.get('arguments'); |
| 22 | + /** |
| 23 | + * Only error on untransformed references of the form `useMyEffect(...)` |
| 24 | + * or `moduleNamespace.useMyEffect(...)`, with matching argument counts. |
| 25 | + * TODO: do we also want a mode to also hard error on non-call references? |
| 26 | + */ |
| 27 | + if (args.length === numArgs) { |
| 28 | + const maybeErrorDiagnostic = matchCompilerDiagnostic( |
| 29 | + path, |
| 30 | + transformErrors, |
| 31 | + ); |
| 32 | + /** |
| 33 | + * Note that we cannot easily check the type of the first argument here, |
| 34 | + * as it may have already been transformed by the compiler (and not |
| 35 | + * memoized). |
| 36 | + */ |
| 37 | + CompilerError.throwInvalidReact({ |
| 38 | + reason: |
| 39 | + '[InferEffectDependencies] Untransformed reference to compiler-required feature. ' + |
| 40 | + 'Either remove this call or ensure it is successfully transformed by the compiler', |
| 41 | + description: maybeErrorDiagnostic |
| 42 | + ? `(Bailout reason: ${maybeErrorDiagnostic})` |
| 43 | + : null, |
| 44 | + loc: parent.node.loc ?? null, |
| 45 | + }); |
| 46 | + } |
| 47 | + } |
| 48 | + } |
| 49 | + } |
| 50 | + |
| 51 | + function assertValidFireImportReference( |
| 52 | + paths: Array<NodePath<t.Node>>, |
| 53 | + ): void { |
| 54 | + if (paths.length > 0) { |
| 55 | + const maybeErrorDiagnostic = matchCompilerDiagnostic( |
| 56 | + paths[0], |
| 57 | + transformErrors, |
| 58 | + ); |
| 59 | + CompilerError.throwInvalidReact({ |
| 60 | + reason: |
| 61 | + '[Fire] Untransformed reference to compiler-required feature. ' + |
| 62 | + 'Either remove this `fire` call or ensure it is successfully transformed by the compiler', |
| 63 | + description: maybeErrorDiagnostic |
| 64 | + ? `(Bailout reason: ${maybeErrorDiagnostic})` |
| 65 | + : null, |
| 66 | + loc: paths[0].node.loc ?? null, |
| 67 | + }); |
| 68 | + } |
| 69 | + } |
| 70 | + |
| 71 | + const moduleLoadChecks = new Map< |
| 72 | + string, |
| 73 | + Map<string, CheckInvalidReferenceFn> |
| 74 | + >(); |
| 75 | + if (env.enableFire) { |
| 76 | + /** |
| 77 | + * Error on any untransformed references to `fire` (e.g. including non-call |
| 78 | + * expressions) |
| 79 | + */ |
| 80 | + for (const module of Environment.knownReactModules) { |
| 81 | + const react = getOrInsertWith(moduleLoadChecks, module, () => new Map()); |
| 82 | + react.set('fire', assertValidFireImportReference); |
| 83 | + } |
| 84 | + } |
| 85 | + if (env.inferEffectDependencies) { |
| 86 | + for (const { |
| 87 | + function: {source, importSpecifierName}, |
| 88 | + numRequiredArgs, |
| 89 | + } of env.inferEffectDependencies) { |
| 90 | + const module = getOrInsertWith(moduleLoadChecks, source, () => new Map()); |
| 91 | + module.set( |
| 92 | + importSpecifierName, |
| 93 | + assertValidEffectImportReference.bind(null, numRequiredArgs), |
| 94 | + ); |
| 95 | + } |
| 96 | + } |
| 97 | + if (moduleLoadChecks.size > 0) { |
| 98 | + transformProgram(path, moduleLoadChecks); |
| 99 | + } |
| 100 | +} |
| 101 | + |
| 102 | +type TraversalState = { |
| 103 | + shouldInvalidateScopes: boolean; |
| 104 | + program: NodePath<t.Program>; |
| 105 | +}; |
| 106 | +type CheckInvalidReferenceFn = (paths: Array<NodePath<t.Node>>) => void; |
| 107 | +function validateImportSpecifier( |
| 108 | + specifier: NodePath<t.ImportSpecifier>, |
| 109 | + importSpecifierChecks: Map<string, CheckInvalidReferenceFn>, |
| 110 | + state: TraversalState, |
| 111 | +): void { |
| 112 | + const imported = specifier.get('imported'); |
| 113 | + const specifierName: string = |
| 114 | + imported.node.type === 'Identifier' |
| 115 | + ? imported.node.name |
| 116 | + : imported.node.value; |
| 117 | + const checkFn = importSpecifierChecks.get(specifierName); |
| 118 | + if (checkFn == null) { |
| 119 | + return; |
| 120 | + } |
| 121 | + if (state.shouldInvalidateScopes) { |
| 122 | + state.shouldInvalidateScopes = false; |
| 123 | + state.program.scope.crawl(); |
| 124 | + } |
| 125 | + |
| 126 | + const local = specifier.get('local'); |
| 127 | + const binding = local.scope.getBinding(local.node.name); |
| 128 | + CompilerError.invariant(binding != null, { |
| 129 | + reason: 'Expected binding to be found for import specifier', |
| 130 | + loc: local.node.loc ?? null, |
| 131 | + }); |
| 132 | + checkFn(binding.referencePaths); |
| 133 | +} |
| 134 | + |
| 135 | +function validateNamespacedImport( |
| 136 | + specifier: NodePath<t.ImportNamespaceSpecifier | t.ImportDefaultSpecifier>, |
| 137 | + importSpecifierChecks: Map<string, CheckInvalidReferenceFn>, |
| 138 | + state: TraversalState, |
| 139 | +): void { |
| 140 | + if (state.shouldInvalidateScopes) { |
| 141 | + state.shouldInvalidateScopes = false; |
| 142 | + state.program.scope.crawl(); |
| 143 | + } |
| 144 | + const local = specifier.get('local'); |
| 145 | + const binding = local.scope.getBinding(local.node.name); |
| 146 | + const defaultCheckFn = importSpecifierChecks.get(DEFAULT_EXPORT); |
| 147 | + |
| 148 | + CompilerError.invariant(binding != null, { |
| 149 | + reason: 'Expected binding to be found for import specifier', |
| 150 | + loc: local.node.loc ?? null, |
| 151 | + }); |
| 152 | + const filteredReferences = new Map< |
| 153 | + CheckInvalidReferenceFn, |
| 154 | + Array<NodePath<t.Node>> |
| 155 | + >(); |
| 156 | + for (const reference of binding.referencePaths) { |
| 157 | + if (defaultCheckFn != null) { |
| 158 | + getOrInsertWith(filteredReferences, defaultCheckFn, () => []).push( |
| 159 | + reference, |
| 160 | + ); |
| 161 | + } |
| 162 | + const parent = reference.parentPath; |
| 163 | + if ( |
| 164 | + parent != null && |
| 165 | + parent.isMemberExpression() && |
| 166 | + parent.get('object') === reference |
| 167 | + ) { |
| 168 | + if (parent.node.computed || parent.node.property.type !== 'Identifier') { |
| 169 | + continue; |
| 170 | + } |
| 171 | + const checkFn = importSpecifierChecks.get(parent.node.property.name); |
| 172 | + if (checkFn != null) { |
| 173 | + getOrInsertWith(filteredReferences, checkFn, () => []).push(parent); |
| 174 | + } |
| 175 | + } |
| 176 | + } |
| 177 | + |
| 178 | + for (const [checkFn, references] of filteredReferences) { |
| 179 | + checkFn(references); |
| 180 | + } |
| 181 | +} |
| 182 | +function transformProgram( |
| 183 | + path: NodePath<t.Program>, |
| 184 | + moduleLoadChecks: Map<string, Map<string, CheckInvalidReferenceFn>>, |
| 185 | +): void { |
| 186 | + const traversalState = {shouldInvalidateScopes: true, program: path}; |
| 187 | + path.traverse({ |
| 188 | + ImportDeclaration(path: NodePath<t.ImportDeclaration>) { |
| 189 | + const importSpecifierChecks = moduleLoadChecks.get( |
| 190 | + path.node.source.value, |
| 191 | + ); |
| 192 | + if (importSpecifierChecks == null) { |
| 193 | + return; |
| 194 | + } |
| 195 | + const specifiers = path.get('specifiers'); |
| 196 | + for (const specifier of specifiers) { |
| 197 | + if (specifier.isImportSpecifier()) { |
| 198 | + validateImportSpecifier( |
| 199 | + specifier, |
| 200 | + importSpecifierChecks, |
| 201 | + traversalState, |
| 202 | + ); |
| 203 | + } else { |
| 204 | + validateNamespacedImport( |
| 205 | + specifier as NodePath< |
| 206 | + t.ImportNamespaceSpecifier | t.ImportDefaultSpecifier |
| 207 | + >, |
| 208 | + importSpecifierChecks, |
| 209 | + traversalState, |
| 210 | + ); |
| 211 | + } |
| 212 | + } |
| 213 | + }, |
| 214 | + }); |
| 215 | +} |
| 216 | + |
| 217 | +function matchCompilerDiagnostic( |
| 218 | + badReference: NodePath<t.Node>, |
| 219 | + transformErrors: Array<{fn: NodePath<t.Node>; error: CompilerError}>, |
| 220 | +): string | null { |
| 221 | + for (const {fn, error} of transformErrors) { |
| 222 | + if (fn.isAncestor(badReference)) { |
| 223 | + return error.toString(); |
| 224 | + } |
| 225 | + } |
| 226 | + return null; |
| 227 | +} |
0 commit comments