|
| 1 | +namespace ts.projectSystem { |
| 2 | + describe("unittests:: tsserver:: with project references and error reporting", () => { |
| 3 | + const projectLocation = "/user/username/projects/myproject"; |
| 4 | + const dependecyLocation = `${projectLocation}/dependency`; |
| 5 | + const usageLocation = `${projectLocation}/usage`; |
| 6 | + const dependencyTs: File = { |
| 7 | + path: `${dependecyLocation}/fns.ts`, |
| 8 | + content: `export function fn1() { } |
| 9 | +export function fn2() { } |
| 10 | +// Introduce error for fnErr import in main |
| 11 | +// export function fnErr() { } |
| 12 | +// Error in dependency ts file |
| 13 | +export let x: string = 10;` |
| 14 | + }; |
| 15 | + const dependencyConfig: File = { |
| 16 | + path: `${dependecyLocation}/tsconfig.json`, |
| 17 | + content: JSON.stringify({ compilerOptions: { composite: true, declarationDir: "../decls" } }) |
| 18 | + }; |
| 19 | + const usageTs: File = { |
| 20 | + path: `${usageLocation}/usage.ts`, |
| 21 | + content: `import { |
| 22 | + fn1, |
| 23 | + fn2, |
| 24 | + fnErr |
| 25 | +} from '../decls/fns' |
| 26 | +fn1(); |
| 27 | +fn2(); |
| 28 | +fnErr(); |
| 29 | +` |
| 30 | + }; |
| 31 | + const usageConfig: File = { |
| 32 | + path: `${usageLocation}/tsconfig.json`, |
| 33 | + content: JSON.stringify({ |
| 34 | + references: [{ path: "../dependency" }] |
| 35 | + }) |
| 36 | + }; |
| 37 | + |
| 38 | + interface CheckErrorsInFile { |
| 39 | + session: TestSession; |
| 40 | + host: TestServerHost; |
| 41 | + expected: GetErrDiagnostics; |
| 42 | + expectedSequenceId?: number; |
| 43 | + } |
| 44 | + function checkErrorsInFile({ session, host, expected: { file, syntax, semantic, suggestion }, expectedSequenceId }: CheckErrorsInFile) { |
| 45 | + host.checkTimeoutQueueLengthAndRun(1); |
| 46 | + checkErrorMessage(session, "syntaxDiag", { file: file.path, diagnostics: syntax }); |
| 47 | + session.clearMessages(); |
| 48 | + |
| 49 | + host.runQueuedImmediateCallbacks(1); |
| 50 | + checkErrorMessage(session, "semanticDiag", { file: file.path, diagnostics: semantic }); |
| 51 | + session.clearMessages(); |
| 52 | + |
| 53 | + host.runQueuedImmediateCallbacks(1); |
| 54 | + checkErrorMessage(session, "suggestionDiag", { file: file.path, diagnostics: suggestion }); |
| 55 | + if (expectedSequenceId !== undefined) { |
| 56 | + checkCompleteEvent(session, 2, expectedSequenceId); |
| 57 | + } |
| 58 | + session.clearMessages(); |
| 59 | + } |
| 60 | + |
| 61 | + interface CheckAllErrors { |
| 62 | + session: TestSession; |
| 63 | + host: TestServerHost; |
| 64 | + expected: ReadonlyArray<GetErrDiagnostics>; |
| 65 | + expectedSequenceId: number; |
| 66 | + } |
| 67 | + function checkAllErrors({ session, host, expected, expectedSequenceId }: CheckAllErrors) { |
| 68 | + for (let i = 0; i < expected.length; i++) { |
| 69 | + checkErrorsInFile({ |
| 70 | + session, |
| 71 | + host, |
| 72 | + expected: expected[i], |
| 73 | + expectedSequenceId: i === expected.length - 1 ? expectedSequenceId : undefined |
| 74 | + }); |
| 75 | + } |
| 76 | + } |
| 77 | + |
| 78 | + function verifyErrorsUsingGeterr({ openFiles, expectedGetErr }: VerifyScenario) { |
| 79 | + it("verifies the errors in open file", () => { |
| 80 | + const host = createServerHost([dependencyTs, dependencyConfig, usageTs, usageConfig, libFile]); |
| 81 | + const session = createSession(host, { canUseEvents: true, }); |
| 82 | + openFilesForSession(openFiles(), session); |
| 83 | + |
| 84 | + session.clearMessages(); |
| 85 | + const expectedSequenceId = session.getNextSeq(); |
| 86 | + const expected = expectedGetErr(); |
| 87 | + session.executeCommandSeq<protocol.GeterrRequest>({ |
| 88 | + command: protocol.CommandTypes.Geterr, |
| 89 | + arguments: { |
| 90 | + delay: 0, |
| 91 | + files: expected.map(f => f.file.path) |
| 92 | + } |
| 93 | + }); |
| 94 | + |
| 95 | + checkAllErrors({ session, host, expected, expectedSequenceId }); |
| 96 | + }); |
| 97 | + } |
| 98 | + |
| 99 | + function verifyErrorsUsingGeterrForProject({ openFiles, expectedGetErrForProject }: VerifyScenario) { |
| 100 | + it("verifies the errors in projects", () => { |
| 101 | + const host = createServerHost([dependencyTs, dependencyConfig, usageTs, usageConfig, libFile]); |
| 102 | + const session = createSession(host, { canUseEvents: true, }); |
| 103 | + openFilesForSession(openFiles(), session); |
| 104 | + |
| 105 | + session.clearMessages(); |
| 106 | + for (const expected of expectedGetErrForProject()) { |
| 107 | + const expectedSequenceId = session.getNextSeq(); |
| 108 | + session.executeCommandSeq<protocol.GeterrForProjectRequest>({ |
| 109 | + command: protocol.CommandTypes.GeterrForProject, |
| 110 | + arguments: { |
| 111 | + delay: 0, |
| 112 | + file: expected.project |
| 113 | + } |
| 114 | + }); |
| 115 | + |
| 116 | + checkAllErrors({ session, host, expected: expected.errors, expectedSequenceId }); |
| 117 | + } |
| 118 | + }); |
| 119 | + } |
| 120 | + |
| 121 | + interface GetErrDiagnostics { |
| 122 | + file: File; |
| 123 | + syntax: protocol.Diagnostic[]; |
| 124 | + semantic: protocol.Diagnostic[]; |
| 125 | + suggestion: protocol.Diagnostic[]; |
| 126 | + } |
| 127 | + interface GetErrForProjectDiagnostics { |
| 128 | + project: string; |
| 129 | + errors: ReadonlyArray<GetErrDiagnostics>; |
| 130 | + } |
| 131 | + interface VerifyScenario { |
| 132 | + openFiles: () => ReadonlyArray<File>; |
| 133 | + expectedGetErr: () => ReadonlyArray<GetErrDiagnostics>; |
| 134 | + expectedGetErrForProject: () => ReadonlyArray<GetErrForProjectDiagnostics>; |
| 135 | + } |
| 136 | + function verifyScenario(scenario: VerifyScenario) { |
| 137 | + verifyErrorsUsingGeterr(scenario); |
| 138 | + verifyErrorsUsingGeterrForProject(scenario); |
| 139 | + } |
| 140 | + |
| 141 | + function emptyDiagnostics(file: File): GetErrDiagnostics { |
| 142 | + return { |
| 143 | + file, |
| 144 | + syntax: emptyArray, |
| 145 | + semantic: emptyArray, |
| 146 | + suggestion: emptyArray |
| 147 | + }; |
| 148 | + } |
| 149 | + |
| 150 | + function usageDiagnostics(): GetErrDiagnostics { |
| 151 | + return { |
| 152 | + file: usageTs, |
| 153 | + syntax: emptyArray, |
| 154 | + semantic: [ |
| 155 | + createDiagnostic( |
| 156 | + { line: 4, offset: 5 }, |
| 157 | + { line: 4, offset: 10 }, |
| 158 | + Diagnostics.Module_0_has_no_exported_member_1, |
| 159 | + [`"../dependency/fns"`, "fnErr"], |
| 160 | + "error", |
| 161 | + ) |
| 162 | + ], |
| 163 | + suggestion: emptyArray |
| 164 | + }; |
| 165 | + } |
| 166 | + |
| 167 | + function dependencyDiagnostics(): GetErrDiagnostics { |
| 168 | + return { |
| 169 | + file: dependencyTs, |
| 170 | + syntax: emptyArray, |
| 171 | + semantic: [ |
| 172 | + createDiagnostic( |
| 173 | + { line: 6, offset: 12 }, |
| 174 | + { line: 6, offset: 13 }, |
| 175 | + Diagnostics.Type_0_is_not_assignable_to_type_1, |
| 176 | + ["10", "string"], |
| 177 | + "error", |
| 178 | + ) |
| 179 | + ], |
| 180 | + suggestion: emptyArray |
| 181 | + }; |
| 182 | + } |
| 183 | + |
| 184 | + function usageProjectDiagnostics(): GetErrForProjectDiagnostics { |
| 185 | + return { |
| 186 | + project: usageTs.path, |
| 187 | + errors: [ |
| 188 | + usageDiagnostics(), |
| 189 | + emptyDiagnostics(dependencyTs) |
| 190 | + ] |
| 191 | + }; |
| 192 | + } |
| 193 | + |
| 194 | + function dependencyProjectDiagnostics(): GetErrForProjectDiagnostics { |
| 195 | + return { |
| 196 | + project: dependencyTs.path, |
| 197 | + errors: [ |
| 198 | + dependencyDiagnostics() |
| 199 | + ] |
| 200 | + }; |
| 201 | + } |
| 202 | + |
| 203 | + describe("when dependency project is not open", () => { |
| 204 | + verifyScenario({ |
| 205 | + openFiles: () => [usageTs], |
| 206 | + expectedGetErr: () => [ |
| 207 | + usageDiagnostics() |
| 208 | + ], |
| 209 | + expectedGetErrForProject: () => [ |
| 210 | + usageProjectDiagnostics(), |
| 211 | + { |
| 212 | + project: dependencyTs.path, |
| 213 | + errors: [ |
| 214 | + emptyDiagnostics(dependencyTs), |
| 215 | + usageDiagnostics() |
| 216 | + ] |
| 217 | + } |
| 218 | + ] |
| 219 | + }); |
| 220 | + }); |
| 221 | + |
| 222 | + describe("when the depedency file is open", () => { |
| 223 | + verifyScenario({ |
| 224 | + openFiles: () => [usageTs, dependencyTs], |
| 225 | + expectedGetErr: () => [ |
| 226 | + usageDiagnostics(), |
| 227 | + dependencyDiagnostics(), |
| 228 | + ], |
| 229 | + expectedGetErrForProject: () => [ |
| 230 | + usageProjectDiagnostics(), |
| 231 | + dependencyProjectDiagnostics() |
| 232 | + ] |
| 233 | + }); |
| 234 | + }); |
| 235 | + }); |
| 236 | +} |
0 commit comments