10000 Cherry-pick PR #34906 into release-3.7 (#35006) · microsoft/TypeScript@4d5f30d · GitHub
[go: up one dir, main page]
Skip to content

Commit 4d5f30d

Browse files
TypeScript Botsheetalkamat
TypeScript Bot
authored and
sheetalkamat
committed
Cherry-pick PR #34906 into release-3.7 (#35006)
Component commits: dfa4bc0 Use empty object for invalid package json contents instead of undefined Fixes #34726 4d035ba Behave as if package json doesnt exist in case of invalid json in package json
1 parent a22ad16 commit 4d5f30d

File tree

6 files changed

+116
-9
lines changed

6 files changed

+116
-9
lines changed

‎src/server/packageJsonCache.ts

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ namespace ts.server {
99
}
1010

1111
export function createPackageJsonCache(project: Project): PackageJsonCache {
12-
const packageJsons = createMap<PackageJsonInfo>();
12+
const packageJsons = createMap<PackageJsonInfo | false>();
1313
const directoriesWithoutPackageJson = createMap<true>();
1414
return {
1515
addOrUpdate,
@@ -18,7 +18,7 @@ namespace ts.server {
1818
directoriesWithoutPackageJson.set(getDirectoryPath(fileName), true);
1919
},
2020
getInDirectory: directory => {
21-
return packageJsons.get(combinePaths(directory, "package.json"));
21+
return packageJsons.get(combinePaths(directory, "package.json")) || undefined;
2222
},
2323
directoryHasPackageJson,
2424
searchDirectoryAndAncestors: directory => {
@@ -39,7 +39,7 @@ namespace ts.server {
3939

4040
function addOrUpdate(fileName: Path) {
4141
const packageJsonInfo = createPackageJsonInfo(fileName, project);
42-
if (packageJsonInfo) {
42+
if (packageJsonInfo !== undefined) {
4343
packageJsons.set(fileName, packageJsonInfo);
4444
directoriesWithoutPackageJson.delete(getDirectoryPath(fileName));
4545
}

‎src/server/project.ts

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1471,7 +1471,8 @@ namespace ts.server {
14711471
case Ternary.True:
14721472
const packageJsonFileName = combinePaths(directory, "package.json");
14731473
watchPackageJsonFile(packageJsonFileName);
1474-
result.push(Debug.assertDefined(packageJsonCache.getInDirectory(directory)));
1474+
const info = packageJsonCache.getInDirectory(directory);
1475+
if (info) result.push(info);
14751476
}
14761477
if (rootPath && rootPath === toPath(directory)) {
14771478
return true;

‎src/services/utilities.ts

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2210,19 +2210,18 @@ namespace ts {
22102210
return packageJsons;
22112211
}
22122212

2213-
export function createPackageJsonInfo(fileName: string, host: LanguageServiceHost): PackageJsonInfo | undefined {
2213+
export function createPackageJsonInfo(fileName: string, host: LanguageServiceHost): PackageJsonInfo | false | undefined {
22142214
if (!host.readFile) {
22152215
return undefined;
22162216
}
22172217

22182218
type PackageJsonRaw = Record<typeof dependencyKeys[number], Record<string, string> | undefined>;
22192219
const dependencyKeys = ["dependencies", "devDependencies", "optionalDependencies", "peerDependencies"] as const;
22202220
const stringContent = host.readFile(fileName);
2221-
const content = stringContent && tryParseJson(stringContent) as PackageJsonRaw;
2222-
if (!content) {
2223-
return undefined;
2224-
}
2221+
if (!stringContent) return undefined;
22252222

2223+
const content = tryParseJson(stringContent) as PackageJsonRaw;
2224+
if (!content) return false;
22262225
const info: Pick<PackageJsonInfo, typeof dependencyKeys[number]> = {};
22272226
for (const key of dependencyKeys) {
22282227
const dependencies = content[key];

‎src/testRunner/unittests/tsserver/packageJsonInfo.ts

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -71,6 +71,23 @@ namespace ts.projectSystem {
7171
assert.lengthOf(project.getPackageJsonsVisibleToFile("/a.ts" as Path), 1);
7272
assert.lengthOf(project.getPackageJsonsVisibleToFile("/src/b.ts" as Path), 2);
7373
});
74+
75+
it("handles errors in json parsing of package.json", () => {
76+
const packageJsonContent = `{ "mod" }`;
77+
const { project, host } = setup([tsConfig, { path: packageJson.path, content: packageJsonContent }]);
78+
project.getPackageJsonsVisibleToFile("/src/whatever/blah.ts" as Path);
79+
const packageJsonInfo = project.packageJsonCache.getInDirectory("/" as Path)!;
80+
assert.isUndefined(packageJsonInfo);
81+
82+
host.writeFile F438 (packageJson.path, packageJson.content);
83+
project.getPackageJsonsVisibleToFile("/src/whatever/blah.ts" as Path);
84+
const packageJsonInfo2 = project.packageJsonCache.getInDirectory("/" as Path)!;
85+
assert.ok(packageJsonInfo2);
86+
assert.ok(packageJsonInfo2.dependencies);
87+
assert.ok(packageJsonInfo2.devDependencies);
88+
assert.ok(packageJsonInfo2.peerDependencies);
89+
assert.ok(packageJsonInfo2.optionalDependencies);
90+
});
7491
});
7592

7693
function setup(files: readonly File[] = [tsConfig, packageJson]) {

‎tests/cases/fourslash/completionsImport_filteredByInvalidPackageJson_direct.ts

Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
/// <reference path="fourslash.ts" />
2+
3+
//@noEmit: true
4+
5+
//@Filename: /package.json
6+
////{
7+
//// "mod"
8+
//// "dependencies": {
9+
//// "react": "*"
10+
//// }
11+
////}
12+
13+
//@Filename: /node_modules/react/index.d.ts
14+
////export declare var React: any;
15+
16+
//@Filename: /node_modules/react/package.json
17+
////{
18+
//// "name": "react",
19+
//// "types": "./index.d.ts"
20+
////}
21+
22+
//@Filename: /node_modules/fake-react/index.d.ts
23+
////export declare var ReactFake: any;
24+
25+
//@Filename: /node_modules/fake-react/package.json
26+
////{
27+
//// "name": "fake-react",
28+
//// "types": "./index.d.ts"
29+
////}
30+
31+
//@Filename: /src/index.ts
32+
////const x = Re/**/
33+
34+
verify.completions({
35+
marker: test.marker(""),
36+
isNewIdentifierLocation: true,
37+
includes: [{
38+
name: "React",
39+
hasAction: true,
40+
source: "/node_modules/react/index",
41+
sortText: completion.SortText.AutoImportSuggestions
42+
},
43+
{
44+
name: "ReactFake",
45+
hasAction: true,
46+
source: "/node_modules/fake-react/index",
47+
sortText: completion.SortText.AutoImportSuggestions
48+
}
49+
],
50+
preferences: {
51+
includeCompletionsForModuleExports: true
52+
}
53+
});

‎tests/cases/fourslash/server/importSuggestionsCache_invalidPackageJson.ts

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
/// <reference path="../fourslash.ts" />
2+
3+
// @Filename: /jsconfig.json
4+
////{
5+
//// "compilerOptions": {
6+
//// "module": "commonjs",
7+
//// },
8+
////}
9+
10+
// @Filename: /node_modules/@types/node/index.d.ts
11+
////declare module 'fs' {
12+
//// export function readFile(): void;
13+
////}
14+
////declare module 'util' {
15+
//// export function promisify(): void;
16+
////}
17+
18+
// @Filename: /package.json
19+
////{ "mod" }
20+
21+
// @Filename: /a.js
22+
////
23+
////readF/**/
24+
25+
goTo.marker("");
26+
verify.completions({
27+
includes: {
28+
name: "readFile",
29+
source: "fs",
30+
hasAction: true,
31+
sortText: completion.SortText.AutoImportSuggestions,
32+
},
33+
preferences: {
34+
includeCompletionsForModuleExports: true,
35+
includeInsertTextCompletions: true,
36+
},
37+
});

0 commit comments

Comments
 (0)
0