|
| 1 | +namespace ts.projectSystem { |
| 2 | + describe("tsserverProjectLoadingEvents:: ProjectLoadingStart and ProjectLoadingFinish events", () => { |
| 3 | + const projectRoot = "/user/username/projects"; |
| 4 | + const aTs: File = { |
| 5 | + path: `${projectRoot}/a/a.ts`, |
| 6 | + content: "export class A { }" |
| 7 | + }; |
| 8 | + const configA: File = { |
| 9 | + path: `${projectRoot}/a/tsconfig.json`, |
| 10 | + content: "{}" |
| 11 | + }; |
| 12 | + const bTsPath = `${projectRoot}/b/b.ts`; |
| 13 | + const configBPath = `${projectRoot}/b/tsconfig.json`; |
| 14 | + const files = [libFile, aTs, configA]; |
| 15 | + |
| 16 | + function verifyProjectLoadingStartAndFinish(createSession: (host: TestServerHost) => { |
| 17 | + session: TestSession; |
| 18 | + getNumberOfEvents: () => number; |
| 19 | + clearEvents: () => void; |
| 20 | + verifyProjectLoadEvents: (expected: [server.ProjectLoadingStartEvent, server.ProjectLoadingFinishEvent]) => void; |
| 21 | + }) { |
| 22 | + function createSessionToVerifyEvent(files: ReadonlyArray<File>) { |
| 23 | + const host = createServerHost(files); |
| 24 | + const originalReadFile = host.readFile; |
| 25 | + const { session, getNumberOfEvents, clearEvents, verifyProjectLoadEvents } = createSession(host); |
| 26 | + host.readFile = file => { |
| 27 | + if (file === configA.path || file === configBPath) { |
| 28 | + assert.equal(getNumberOfEvents(), 1, "Event for loading is sent before reading config file"); |
| 29 | + } |
| 30 | + return originalReadFile.call(host, file); |
| 31 | + }; |
| 32 | + const service = session.getProjectService(); |
| 33 | + return { host, session, verifyEvent, verifyEventWithOpenTs, service, getNumberOfEvents }; |
| 34 | + |
| 35 | + function verifyEvent(project: server.Project, reason: string) { |
| 36 | + verifyProjectLoadEvents([ |
| 37 | + { eventName: server.ProjectLoadingStartEvent, data: { project, reason } }, |
| 38 | + { eventName: server.ProjectLoadingFinishEvent, data: { project } } |
| 39 | + ]); |
| 40 | + clearEvents(); |
| 41 | + } |
| 42 | + |
| 43 | + function verifyEventWithOpenTs(file: File, configPath: string, configuredProjects: number) { |
| 44 | + openFilesForSession([file], session); |
| 45 | + checkNumberOfProjects(service, { configuredProjects }); |
| 46 | + const project = service.configuredProjects.get(configPath)!; |
| 47 | + assert.isDefined(project); |
| 48 | + verifyEvent(project, `Creating possible configured project for ${file.path} to open`); |
| 49 | + } |
| 50 | + } |
| 51 | + |
| 52 | + it("when project is created by open file", () => { |
| 53 | + const bTs: File = { |
| 54 | + path: bTsPath, |
| 55 | + content: "export class B {}" |
| 56 | + }; |
| 57 | + const configB: File = { |
| 58 | + path: configBPath, |
| 59 | + content: "{}" |
| 60 | + }; |
| 61 | + const { verifyEventWithOpenTs } = createSessionToVerifyEvent(files.concat(bTs, configB)); |
| 62 | + verifyEventWithOpenTs(aTs, configA.path, 1); |
| 63 | + verifyEventWithOpenTs(bTs, configB.path, 2); |
| 64 | + }); |
| 65 | + |
| 66 | + it("when change is detected in the config file", () => { |
| 67 | + const { host, verifyEvent, verifyEventWithOpenTs, service } = createSessionToVerifyEvent(files); |
| 68 | + verifyEventWithOpenTs(aTs, configA.path, 1); |
| 69 | + |
| 70 | + host.writeFile(configA.path, configA.content); |
| 71 | + host.checkTimeoutQueueLengthAndRun(2); |
| 72 | + const project = service.configuredProjects.get(configA.path)!; |
| 73 | + verifyEvent(project, `Change in config file detected`); |
| 74 | + }); |
| 75 | + |
| 76 | + it("when opening original location project", () => { |
| 77 | + const aDTs: File = { |
| 78 | + path: `${projectRoot}/a/a.d.ts`, |
| 79 | + content: `export declare class A { |
| 80 | +} |
| 81 | +//# sourceMappingURL=a.d.ts.map |
| 82 | +` |
| 83 | + }; |
| 84 | + const aDTsMap: File = { |
| 85 | + path: `${projectRoot}/a/a.d.ts.map`, |
| 86 | + content: `{"version":3,"file":"a.d.ts","sourceRoot":"","sources":["./a.ts"],"names":[],"mappings":"AAAA,qBAAa,CAAC;CAAI"}` |
| 87 | + }; |
| 88 | + const bTs: File = { |
| 89 | + path: bTsPath, |
| 90 | + content: `import {A} from "../a/a"; new A();` |
| 91 | + }; |
| 92 | + const configB: File = { |
| 93 | + path: configBPath, |
| 94 | + content: JSON.stringify({ |
| 95 | + references: [{ path: "../a" }] |
| 96 | + }) |
| 97 | + }; |
| 98 | + |
| 99 | + const { service, session, verifyEventWithOpenTs, verifyEvent } = createSessionToVerifyEvent(files.concat(aDTs, aDTsMap, bTs, configB)); |
| 100 | + verifyEventWithOpenTs(bTs, configB.path, 1); |
| 101 | + |
| 102 | + session.executeCommandSeq<protocol.ReferencesRequest>({ |
| 103 | + command: protocol.CommandTypes.References, |
| 104 | + arguments: { |
| 105 | + file: bTs.path, |
| 106 | + ...protocolLocationFromSubstring(bTs.content, "A()") |
| 107 | + } |
| 108 | + }); |
| 109 | + |
| 110 | + checkNumberOfProjects(service, { configuredProjects: 2 }); |
| 111 | + const project = service.configuredProjects.get(configA.path)!; |
| 112 | + assert.isDefined(project); |
| 113 | + verifyEvent(project, `Creating project for original file: ${aTs.path} for location: ${aDTs.path}`); |
| 114 | + }); |
| 115 | + |
| 116 | + describe("with external projects and config files ", () => { |
| 117 | + const projectFileName = `${projectRoot}/a/project.csproj`; |
| 118 | + |
| 119 | + function createSession(lazyConfiguredProjectsFromExternalProject: boolean) { |
| 120 | + const { session, service, verifyEvent: verifyEventWorker, getNumberOfEvents } = createSessionToVerifyEvent(files); |
| 121 | + service.setHostConfiguration({ preferences: { lazyConfiguredProjectsFromExternalProject } }); |
| 122 | + service.openExternalProject(<protocol.ExternalProject>{ |
| 123 | + projectFileName, |
| 124 | + rootFiles: toExternalFiles([aTs.path, configA.path]), |
| 125 | + options: {} |
| 126 | + }); |
| 127 | + checkNumberOfProjects(service, { configuredProjects: 1 }); |
| 128 | + return { session, service, verifyEvent, getNumberOfEvents }; |
| 129 | + |
| 130 | + function verifyEvent() { |
| 131 | + const projectA = service.configuredProjects.get(configA.path)!; |
| 132 | + assert.isDefined(projectA); |
| 133 | + verifyEventWorker(projectA, `Creating configured project in external project: ${projectFileName}`); |
| 134 | + } |
| 135 | + } |
| 136 | + |
| 137 | + it("when lazyConfiguredProjectsFromExternalProject is false", () => { |
| 138 | + const { verifyEvent } = createSession(/*lazyConfiguredProjectsFromExternalProject*/ false); |
| 139 | + verifyEvent(); |
| 140 | + }); |
| 141 | + |
| 142 | + it("when lazyConfiguredProjectsFromExternalProject is true and file is opened", () => { |
| 143 | + const { verifyEvent, getNumberOfEvents, session } = createSession(/*lazyConfiguredProjectsFromExternalProject*/ true); |
| 144 | + assert.equal(getNumberOfEvents(), 0); |
| 145 | + |
| 146 | + openFilesForSession([aTs], session); |
| 147 | + verifyEvent(); |
| 148 | + }); |
| 149 | + |
| 150 | + it("when lazyConfiguredProjectsFromExternalProject is disabled", () => { |
| 151 | + const { verifyEvent, getNumberOfEvents, service } = createSession(/*lazyConfiguredProjectsFromExternalProject*/ true); |
| 152 | + assert.equal(getNumberOfEvents(), 0); |
| 153 | + |
| 154 | + service.setHostConfiguration({ preferences: { lazyConfiguredProjectsFromExternalProject: false } }); |
| 155 | + verifyEvent(); |
| 156 | + }); |
| 157 | + }); |
| 158 | + } |
| 159 | + |
| 160 | + describe("when using event handler", () => { |
| 161 | + verifyProjectLoadingStartAndFinish(host => { |
| 162 | + const { session, events } = createSessionWithEventTracking<server.ProjectLoadingStartEvent | server.ProjectLoadingFinishEvent>(host, server.ProjectLoadingStartEvent, server.ProjectLoadingFinishEvent); |
| 163 | + return { |
| 164 | + session, |
| 165 | + getNumberOfEvents: () => events.length, |
| 166 | + clearEvents: () => events.length = 0, |
| 167 | + verifyProjectLoadEvents: expected => assert.deepEqual(events, expected) |
| 168 | + }; |
| 169 | + }); |
| 170 | + }); |
| 171 | + |
| 172 | + describe("when using default event handler", () => { |
| 173 | + verifyProjectLoadingStartAndFinish(host => { |
| 174 | + const { session, getEvents, clearEvents } = createSessionWithDefaultEventHandler<protocol.ProjectLoadingStartEvent | protocol.ProjectLoadingFinishEvent>(host, [server.ProjectLoadingStartEvent, server.ProjectLoadingFinishEvent]); |
| 175 | + return { |
| 176 | + session, |
| 177 | + getNumberOfEvents: () => getEvents().length, |
| 178 | + clearEvents, |
| 179 | + verifyProjectLoadEvents |
| 180 | + }; |
| 181 | + |
| 182 | + function verifyProjectLoadEvents(expected: [server.ProjectLoadingStartEvent, server.ProjectLoadingFinishEvent]) { |
| 183 | + const actual = getEvents().map(e => ({ eventName: e.event, data: e.body })); |
| 184 | + const mappedExpected = expected.map(e => { |
| 185 | + const { project, ...rest } = e.data; |
| 186 | + return { eventName: e.eventName, data: { projectName: project.getProjectName(), ...rest } }; |
| 187 | + }); |
| 188 | + assert.deepEqual(actual, mappedExpected); |
| 189 | + } |
| 190 | + }); |
| 191 | + }); |
| 192 | + }); |
| 193 | +} |
0 commit comments