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

Fix resolve self priority #4704

Merged
Show file tree
Hide file tree
Changes from 2 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
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
changeKind: fix
packages:
- "@typespec/compiler"
---

Fix order of resolution from node_modules and parent package
31 changes: 14 additions & 17 deletions packages/compiler/src/module-resolver/module-resolver.ts
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ import {
InvalidPackageTargetError,
NoMatchingConditionsError,
} from "./esm/utils.js";
import { parseNodeModuleSpecifier } from "./utils.js";
import { NodeModuleSpecifier, parseNodeModuleSpecifier } from "./utils.js";

// Resolve algorithm of node https://nodejs.org/api/modules.html#modules_all_together

Expand Down Expand Up @@ -126,10 +126,6 @@ export async function resolveModule(
}
}

// Try to resolve package itself.
const self = await resolveSelf(specifier, absoluteStart);
if (self) return self;

// Try to resolve as a node_module package.
const module = await resolveAsNodeModule(specifier, absoluteStart);
if (module) return module;
Expand All @@ -154,19 +150,18 @@ export async function resolveModule(
}

/**
* Equivalent implementation to node LOAD_PACKAGE_SELF
* Resolve if the import is importing the current package.
* Try to import a package with that name in the current directory.
*/
async function resolveSelf(name: string, baseDir: string): Promise<ResolvedModule | undefined> {
for (const dir of listDirHierarchy(baseDir)) {
const pkgFile = resolvePath(dir, "package.json");
if (!(await isFile(host, pkgFile))) continue;
const pkg = await readPackage(host, pkgFile);
// Node Spec says that you shouldn't lookup past the first package.json. However we used to support that so keeping this.
if (pkg.name !== name) continue;
return loadPackage(dir, pkg);
}
return undefined;
async function resolveSelf(
{ packageName, subPath }: NodeModuleSpecifier,
dir: string,
): Promise<ResolvedModule | undefined> {
const pkgFile = resolvePath(dir, "package.json");
if (!(await isFile(host, pkgFile))) return undefined;
const pkg = await readPackage(host, pkgFile);
// Node Spec says that you shouldn't lookup past the first package.json. However we used to support that so keeping this.
if (pkg.name !== packageName) return undefined;
return loadPackage(dir, pkg, subPath);
}

/**
Expand All @@ -182,6 +177,8 @@ export async function resolveModule(
const dirs = listDirHierarchy(baseDir);

for (const dir of dirs) {
const self = await resolveSelf(module, dir);
if (self) return self;
const n = await loadPackageAtPath(
joinPaths(dir, "node_modules", module.packageName),
module.subPath,
Expand Down
27 changes: 27 additions & 0 deletions packages/compiler/test/module-resolver/module-resolver.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -399,4 +399,31 @@ describe("resolve self", () => {
mainFile: "/ws/proj/entry.js",
});
});

it("prioritize local node_modules over self from multiple parent up", async () => {
const { host } = mkFs({
"/ws/proj/package.json": JSON.stringify({ name: "@scope/proj", main: "entry.js" }),
"/ws/proj/entry.js": "",
"/ws/proj/nested/index.js": "",
"/ws/proj/node_modules/test-lib/package.json": JSON.stringify({ main: "entry.js" }),
"/ws/proj/node_modules/test-lib/entry.js": "",
"/ws/proj/node_modules/test-lib/nested/index.js": "",
// @scope/proj installed locally
"/ws/proj/node_modules/test-lib/node_modules/@scope/proj/package.json": JSON.stringify({
name: "@scope/proj",
main: "entry.js",
}),
"/ws/proj/node_modules/test-lib/node_modules/@scope/proj/entry.js": "",
});

const resolved = await resolveModule(host, "@scope/proj", {
baseDir: "/ws/proj/node_modules/test-lib/nested",
});
const path = "/ws/proj/node_modules/test-lib/node_modules/@scope/proj";
expect(resolved).toMatchObject({
type: "module",
path,
mainFile: `${path}/entry.js`,
});
});
});
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
// vite.config.ts
import react from "file:///Users/timotheeguerin/dev/azsdk/typespec/node_modules/.pnpm/@[email protected][email protected]_@[email protected][email protected]_/node_modules/@vitejs/plugin-react/dist/index.mjs";
import { readFileSync } from "fs";
import { dirname, resolve } from "path";
import { fileURLToPath } from "url";
import { defineConfig } from "file:///Users/timotheeguerin/dev/azsdk/typespec/node_modules/.pnpm/[email protected]_@[email protected][email protected]/node_modules/vite/dist/node/index.js";
import checker from "file:///Users/timotheeguerin/dev/azsdk/typespec/node_modules/.pnpm/[email protected][email protected][email protected][email protected][email protected]_vite@5._temklexzz7tp27mnl3wlzianvm/node_modules/vite-plugin-checker/dist/esm/main.js";
import dts from "file:///Users/timotheeguerin/dev/azsdk/typespec/node_modules/.pnpm/[email protected]_@[email protected][email protected][email protected][email protected]_@[email protected][email protected]_/node_modules/vite-plugin-dts/dist/index.mjs";
var __vite_injected_original_import_meta_url = "file:///Users/timotheeguerin/dev/azsdk/typespec/packages/react-components/vite.config.ts";
var __dirname = dirname(fileURLToPath(__vite_injected_original_import_meta_url));
var packageJson = JSON.parse(readFileSync(resolve(__dirname, "package.json")).toString());
var dependencies = Object.keys(packageJson.dependencies);
var externals = [...dependencies];
var vite_config_default = defineConfig({
build: {
target: "esnext",
minify: false,
chunkSizeWarningLimit: 3e3,
lib: {
entry: {
index: "src/index.ts"
},
formats: ["es"]
},
rollupOptions: {
external: externals
}
},
plugins: [
react({}),
dts({
logLevel: "silent"
// checker reports the errors
}),
checker({
// e.g. use TypeScript check
typescript: true
})
],
server: {
fs: {
strict: false
}
}
});
export {
vite_config_default as default
};
//# sourceMappingURL=data:application/json;base64,ewogICJ2ZXJzaW9uIjogMywKICAic291cmNlcyI6IFsidml0ZS5jb25maWcudHMiXSwKICAic291cmNlc0NvbnRlbnQiOiBbImNvbnN0IF9fdml0ZV9pbmplY3RlZF9vcmlnaW5hbF9kaXJuYW1lID0gXCIvVXNlcnMvdGltb3RoZWVndWVyaW4vZGV2L2F6c2RrL3R5cGVzcGVjL3BhY2thZ2VzL3JlYWN0LWNvbXBvbmVudHNcIjtjb25zdCBfX3ZpdGVfaW5qZWN0ZWRfb3JpZ2luYWxfZmlsZW5hbWUgPSBcIi9Vc2Vycy90aW1vdGhlZWd1ZXJpbi9kZXYvYXpzZGsvdHlwZXNwZWMvcGFja2FnZXMvcmVhY3QtY29tcG9uZW50cy92aXRlLmNvbmZpZy50c1wiO2NvbnN0IF9fdml0ZV9pbmplY3RlZF9vcmlnaW5hbF9pbXBvcnRfbWV0YV91cmwgPSBcImZpbGU6Ly8vVXNlcnMvdGltb3RoZWVndWVyaW4vZGV2L2F6c2RrL3R5cGVzcGVjL3BhY2thZ2VzL3JlYWN0LWNvbXBvbmVudHMvdml0ZS5jb25maWcudHNcIjtpbXBvcnQgcmVhY3QgZnJvbSBcIkB2aXRlanMvcGx1Z2luLXJlYWN0XCI7XG5pbXBvcnQgeyByZWFkRmlsZVN5bmMgfSBmcm9tIFwiZnNcIjtcbmltcG9ydCB7IGRpcm5hbWUsIHJlc29sdmUgfSBmcm9tIFwicGF0aFwiO1xuaW1wb3J0IHsgZmlsZVVSTFRvUGF0aCB9IGZyb20gXCJ1cmxcIjtcbmltcG9ydCB7IGRlZmluZUNvbmZpZyB9IGZyb20gXCJ2aXRlXCI7XG5pbXBvcnQgY2hlY2tlciBmcm9tIFwidml0ZS1wbHVnaW4tY2hlY2tlclwiO1xuaW1wb3J0IGR0cyBmcm9tIFwidml0ZS1wbHVnaW4tZHRzXCI7XG5cbmNvbnN0IF9fZGlybmFtZSA9IGRpcm5hbWUoZmlsZVVSTFRvUGF0aChpbXBvcnQubWV0YS51cmwpKTtcblxuY29uc3QgcGFja2FnZUpzb24gPSBKU09OLnBhcnNlKHJlYWRGaWxlU3luYyhyZXNvbHZlKF9fZGlybmFtZSwgXCJwYWNrYWdlLmpzb25cIikpLnRvU3RyaW5nKCkpO1xuY29uc3QgZGVwZW5kZW5jaWVzID0gT2JqZWN0LmtleXMocGFja2FnZUpzb24uZGVwZW5kZW5jaWVzKTtcbmNvbnN0IGV4dGVybmFscyA9IFsuLi5kZXBlbmRlbmNpZXNdO1xuXG5leHBvcnQgZGVmYXVsdCBkZWZpbmVDb25maWcoe1xuICBidWlsZDoge1xuICAgIHRhcmdldDogXCJlc25leHRcIixcbiAgICBtaW5pZnk6IGZhbHNlLFxuICAgIGNodW5rU2l6ZVdhcm5pbmdMaW1pdDogMzAwMCxcbiAgICBsaWI6IHtcbiAgICAgIGVudHJ5OiB7XG4gICAgICAgIGluZGV4OiBcInNyYy9pbmRleC50c1wiLFxuICAgICAgfSxcbiAgICAgIGZvcm1hdHM6IFtcImVzXCJdLFxuICAgIH0sXG5cbiAgICByb2xsdXBPcHRpb25zOiB7XG4gICAgICBleHRlcm5hbDogZXh0ZXJuYWxzLFxuICAgIH0sXG4gIH0sXG4gIHBsdWdpbnM6IFtcbiAgICByZWFjdCh7fSksXG4gICAgZHRzKHtcbiAgICAgIGxvZ0xldmVsOiBcInNpbGVudFwiLCAvLyBjaGVja2VyIHJlcG9ydHMgdGhlIGVycm9yc1xuICAgIH0pLFxuICAgIGNoZWNrZXIoe1xuICAgICAgLy8gZS5nLiB1c2UgVHlwZVNjcmlwdCBjaGVja1xuICAgICAgdHlwZXNjcmlwdDogdHJ1ZSxcbiAgICB9KSxcbiAgXSxcbiAgc2VydmVyOiB7XG4gICAgZnM6IHtcbiAgICAgIHN0cmljdDogZmFsc2UsXG4gICAgfSxcbiAgfSxcbn0pO1xuIl0sCiAgIm1hcHBpbmdzIjogIjtBQUF3WCxPQUFPLFdBQVc7QUFDMVksU0FBUyxvQkFBb0I7QUFDN0IsU0FBUyxTQUFTLGVBQWU7QUFDakMsU0FBUyxxQkFBcUI7QUFDOUIsU0FBUyxvQkFBb0I7QUFDN0IsT0FBTyxhQUFhO0FBQ3BCLE9BQU8sU0FBUztBQU40TixJQUFNLDJDQUEyQztBQVE3UixJQUFNLFlBQVksUUFBUSxjQUFjLHdDQUFlLENBQUM7QUFFeEQsSUFBTSxjQUFjLEtBQUssTUFBTSxhQUFhLFFBQVEsV0FBVyxjQUFjLENBQUMsRUFBRSxTQUFTLENBQUM7QUFDMUYsSUFBTSxlQUFlLE9BQU8sS0FBSyxZQUFZLFlBQVk7QUFDekQsSUFBTSxZQUFZLENBQUMsR0FBRyxZQUFZO0FBRWxDLElBQU8sc0JBQVEsYUFBYTtBQUFBLEVBQzFCLE9BQU87QUFBQSxJQUNMLFFBQVE7QUFBQSxJQUNSLFFBQVE7QUFBQSxJQUNSLHVCQUF1QjtBQUFBLElBQ3ZCLEtBQUs7QUFBQSxNQUNILE9BQU87QUFBQSxRQUNMLE9BQU87QUFBQSxNQUNUO0FBQUEsTUFDQSxTQUFTLENBQUMsSUFBSTtBQUFBLElBQ2hCO0FBQUEsSUFFQSxlQUFlO0FBQUEsTUFDYixVQUFVO0FBQUEsSUFDWjtBQUFBLEVBQ0Y7QUFBQSxFQUNBLFNBQVM7QUFBQSxJQUNQLE1BQU0sQ0FBQyxDQUFDO0FBQUEsSUFDUixJQUFJO0FBQUEsTUFDRixVQUFVO0FBQUE7QUFBQSxJQUNaLENBQUM7QUFBQSxJQUNELFFBQVE7QUFBQTtBQUFBLE1BRU4sWUFBWTtBQUFBLElBQ2QsQ0FBQztBQUFBLEVBQ0g7QUFBQSxFQUNBLFFBQVE7QUFBQSxJQUNOLElBQUk7QUFBQSxNQUNGLFFBQVE7QUFBQSxJQUNWO0FBQUEsRUFDRjtBQUNGLENBQUM7IiwKICAibmFtZXMiOiBbXQp9Cg==
Loading