Skip to content

Commit

Permalink
feat: Merge getBuild and getProject requests (#1152)
Browse files Browse the repository at this point in the history
  • Loading branch information
CsCherrYY authored Feb 17, 2022
1 parent de52542 commit a1bcd41
Show file tree
Hide file tree
Showing 25 changed files with 298 additions and 383 deletions.
27 changes: 27 additions & 0 deletions ThirdPartyNotices.txt
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@ are grateful to these developers for their contribution to open source.
14. grpc (https://github.com/grpc/grpc-java)
15. version-compare (https://github.com/G00fY2/version-compare)
16. slf4j-simple (http://www.slf4j.org/)
17. await-lock (https://github.com/ide/await-lock)

fs-extra NOTICES BEGIN HERE
=============================
Expand Down Expand Up @@ -2463,3 +2464,29 @@ OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
=========================================
END OF slf4j-simple NOTICES AND INFORMATION

await-lock NOTICES BEGIN HERE
=============================
The MIT License (MIT)

Copyright (c) 2015-present James Ide

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
=========================================
END OF await-lock NOTICES AND INFORMATION
5 changes: 5 additions & 0 deletions extension/package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 1 addition & 0 deletions extension/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -897,6 +897,7 @@
"webpack-cli": "^4.9.2"
},
"dependencies": {
"await-lock": "^2.1.0",
"fs-extra": "^10.0.0",
"get-port": "^5.1.1",
"minimatch": "^3.0.5",
Expand Down
33 changes: 12 additions & 21 deletions extension/src/Extension.ts
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
import * as vscode from "vscode";
import * as path from "path";
import { logger, LogVerbosity, Logger } from "./logger";
import { Api } from "./api";
import { GradleClient } from "./client";
Expand Down Expand Up @@ -28,9 +27,8 @@ import { FileWatcher } from "./util/FileWatcher";
import { DependencyTreeItem } from "./views/gradleTasks/DependencyTreeItem";
import { GRADLE_DEPENDENCY_REVEAL } from "./views/gradleTasks/DependencyUtils";
import { GradleDependencyProvider } from "./dependencies/GradleDependencyProvider";
import { isLanguageServerStarted, startLanguageServer, syncLanguageServer } from "./languageServer/languageServer";
import { isLanguageServerStarted, startLanguageServer } from "./languageServer/languageServer";
import { DefaultProjectsTreeDataProvider } from "./views/defaultProject/DefaultProjectsTreeDataProvider";
import { GradleProjectContentProvider } from "./projectContent/GradleProjectContentProvider";
import {
CompletionKinds,
Context,
Expand All @@ -41,6 +39,7 @@ import {
VSCODE_TRIGGER_COMPLETION,
} from "./constant";
import { instrumentOperation, sendInfo } from "vscode-extension-telemetry-wrapper";
import { GradleBuildContentProvider } from "./client/GradleBuildContentProvider";

export class Extension {
private readonly client: GradleClient;
Expand All @@ -49,7 +48,7 @@ export class Extension {
private readonly recentTasksStore: RecentTasksStore;
private readonly taskTerminalsStore: TaskTerminalsStore;
private readonly rootProjectsStore: RootProjectsStore;
private readonly gradleProjectContentProvider: GradleProjectContentProvider;
private readonly gradleBuildContentProvider: GradleBuildContentProvider;
private readonly gradleTaskProvider: GradleTaskProvider;
private readonly gradleDependencyProvider: GradleDependencyProvider;
private readonly taskProvider: vscode.Disposable;
Expand Down Expand Up @@ -95,9 +94,13 @@ export class Extension {
this.recentTasksStore = new RecentTasksStore();
this.taskTerminalsStore = new TaskTerminalsStore();
this.rootProjectsStore = new RootProjectsStore();
this.gradleProjectContentProvider = new GradleProjectContentProvider(this.client);
this.gradleTaskProvider = new GradleTaskProvider(this.rootProjectsStore, this.client);
this.gradleDependencyProvider = new GradleDependencyProvider(this.gradleProjectContentProvider);
this.gradleBuildContentProvider = new GradleBuildContentProvider(this.client);
this.gradleTaskProvider = new GradleTaskProvider(
this.rootProjectsStore,
this.client,
this.gradleBuildContentProvider
);
this.gradleDependencyProvider = new GradleDependencyProvider(this.gradleBuildContentProvider);
this.taskProvider = vscode.tasks.registerTaskProvider("gradle", this.gradleTaskProvider);
this.icons = new Icons(context);

Expand Down Expand Up @@ -165,7 +168,7 @@ export class Extension {
this.context,
this.pinnedTasksStore,
this.gradleTaskProvider,
this.gradleProjectContentProvider,
this.gradleBuildContentProvider,
this.gradleTasksTreeDataProvider,
this.pinnedTasksTreeDataProvider,
this.recentTasksTreeDataProvider,
Expand Down Expand Up @@ -213,7 +216,7 @@ export class Extension {
);

void this.activate();
void startLanguageServer(this.context, this.gradleProjectContentProvider);
void startLanguageServer(this.context, this.gradleBuildContentProvider, this.rootProjectsStore);
void vscode.commands.executeCommand("setContext", "allowParallelRun", getAllowParallelRun());
void vscode.commands.executeCommand("setContext", Context.ACTIVATION_CONTEXT_KEY, true);
}
Expand Down Expand Up @@ -293,13 +296,11 @@ export class Extension {
instrumentOperation(GRADLE_BUILD_FILE_CHANGE, async (_operationId: string, uri: vscode.Uri) => {
logger.info("Build file changed:", uri.fsPath);
await this.refresh();
void this.syncBuildFile(uri);
})
);
this.buildFileWatcher.onDidOpen(
instrumentOperation(GRADLE_BUILD_FILE_OPEN, async (_operationId: string, uri: vscode.Uri) => {
logger.info("Build file opened:", uri.fsPath);
void this.syncBuildFile(uri);
})
);
this.gradleWrapperWatcher.onDidChange(
Expand All @@ -313,16 +314,6 @@ export class Extension {
);
}

private async syncBuildFile(uri: vscode.Uri): Promise<void> {
const fsPath = uri.fsPath;
const dirName = path.dirname(fsPath);
const baseName = path.basename(dirName);
const projectContent = await this.gradleProjectContentProvider.getProjectContent(dirName, baseName);
if (projectContent) {
await syncLanguageServer(dirName, projectContent);
}
}

private async restartServer(): Promise<void> {
if (this.server.isReady()) {
await this.client.cancelBuilds();
Expand Down
4 changes: 0 additions & 4 deletions extension/src/client/CancellationKeys.ts
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,3 @@ export function getRunBuildCancellationKey(rootProjectFolder: string, args: Read
export function getRunTaskCommandCancellationKey(rootProjectFolder: string, taskName: string): string {
return "runTask" + rootProjectFolder + taskName;
}

export function getProjectsCancellationKey(projectDir: string): string {
return "getProjects" + projectDir;
}
43 changes: 43 additions & 0 deletions extension/src/client/GradleBuildContentProvider.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
// Copyright (c) Microsoft Corporation. All rights reserved.
// Licensed under the MIT license.

import AwaitLock from "await-lock";
import { GradleClient } from ".";
import { syncGradleBuild } from "../languageServer/languageServer";
import { GradleBuild } from "../proto/gradle_pb";
import { RootProject } from "../rootProject";
import { getGradleConfig } from "../util/config";

const lock = new AwaitLock();

export class GradleBuildContentProvider {
private cachedBuild: Map<string, GradleBuild> = new Map();

constructor(private readonly client: GradleClient) {}

public async getGradleBuild(rootProject: RootProject): Promise<GradleBuild | undefined> {
await lock.acquireAsync();
try {
const projectPath = rootProject.getProjectUri().fsPath;
if (this.cachedBuild.has(projectPath)) {
return this.cachedBuild.get(projectPath);
}
const gradleBuild = await this.client.getBuild(rootProject, getGradleConfig());
if (gradleBuild) {
await syncGradleBuild(gradleBuild);
this.cachedBuild.set(projectPath, gradleBuild);
}
return gradleBuild;
} finally {
lock.release();
}
}

public refresh(): void {
this.cachedBuild.clear();
}

public getCachedBuild(): Map<string, GradleBuild> {
return this.cachedBuild;
}
}
85 changes: 5 additions & 80 deletions extension/src/client/GradleClient.ts
Original file line number Diff line number Diff line change
Expand Up @@ -22,10 +22,6 @@ import {
CancelBuildReply,
CancelBuildsRequest,
CancelBuildsReply,
GetProjectsRequest,
CancelProjectsRequest,
CancelProjectsReply,
GetProjectsReply,
} from "../proto/gradle_pb";

import { GradleClient as GrpcClient } from "../proto/gradle_grpc_pb";
Expand All @@ -35,7 +31,7 @@ import { ProgressHandler } from "../progress";
import { removeCancellingTask, restartQueuedTask } from "../tasks/taskUtil";
import { COMMAND_REFRESH_DAEMON_STATUS, COMMAND_SHOW_LOGS, COMMAND_CANCEL_BUILD } from "../commands";
import { RootProject } from "../rootProject/RootProject";
import { getBuildCancellationKey, getProjectsCancellationKey } from "./CancellationKeys";
import { getBuildCancellationKey } from "./CancellationKeys";
import { EventWaiter } from "../util/EventWaiter";
import { getGradleConfig, getJavaDebugCleanOutput } from "../util/config";
import { setDefault, unsetDefault } from "../views/defaultProject/DefaultProjectUtils";
Expand Down Expand Up @@ -125,7 +121,7 @@ export class GradleClient implements vscode.Disposable {
rootProject: RootProject,
gradleConfig: GradleConfig,
showOutputColors = false
): Promise<GradleBuild | void> {
): Promise<GradleBuild | undefined> {
await this.waitForConnect();
this.statusBarItem.hide();
return vscode.window.withProgress(
Expand All @@ -151,7 +147,7 @@ export class GradleClient implements vscode.Disposable {
const getBuildStream = this.grpcClient!.getBuild(request);
try {
return await new Promise((resolve, reject) => {
let build: GradleBuild | void = undefined;
let build: GradleBuild | undefined;
getBuildStream
.on("data", async (getBuildReply: GetBuildReply) => {
switch (getBuildReply.getKindCase()) {
Expand All @@ -166,7 +162,6 @@ export class GradleClient implements vscode.Disposable {
);
break;
case Output.OutputType.STDERR:
void setDefault();
stdErrLoggerStream.write(
getBuildReply.getOutput()!.getOutputBytes_asU8()
);
Expand Down Expand Up @@ -210,6 +205,7 @@ export class GradleClient implements vscode.Disposable {
.on("end", () => resolve(build));
});
} catch (err) {
void setDefault();
logger.error(
`Error getting build for ${rootProject.getProjectUri().fsPath}: ${err.details || err.message}`
);
Expand All @@ -219,52 +215,7 @@ export class GradleClient implements vscode.Disposable {
} finally {
process.nextTick(() => vscode.commands.executeCommand(COMMAND_REFRESH_DAEMON_STATUS));
}
}
);
}

public async getProjects(
projectDir: string,
gradleConfig: GradleConfig,
projectName: string
): Promise<GetProjectsReply | undefined> {
await this.waitForConnect();
return vscode.window.withProgress(
{
location: vscode.ProgressLocation.Window,
title: "Gradle",
cancellable: true,
},
async (progress: vscode.Progress<{ message?: string }>, token: vscode.CancellationToken) => {
progress.report({
message: `Getting Projects for ${projectName}`,
});
const request = new GetProjectsRequest();
request.setProjectDir(projectDir);
request.setGradleConfig(gradleConfig);
const cancellationKey = getProjectsCancellationKey(projectDir);
request.setCancellationKey(cancellationKey);
token.onCancellationRequested(() => this.cancelProjects(cancellationKey));
try {
return await new Promise((resolve, reject) => {
this.grpcClient!.getProjects(
request,
(err: grpc.ServiceError | null, getProjectsReply: GetProjectsReply | undefined) => {
if (err) {
reject(err);
} else {
resolve(getProjectsReply);
}
}
);
});
} catch (err) {
logger.error(`Error getting dependencies for ${projectDir}: ${err.details || err.message}`);
this.statusBarItem.command = COMMAND_SHOW_LOGS;
this.statusBarItem.text = "$(warning) Gradle: Get Dependencies Error";
this.statusBarItem.show();
return undefined;
}
return undefined;
}
);
}
Expand Down Expand Up @@ -406,32 +357,6 @@ export class GradleClient implements vscode.Disposable {
}
}

public async cancelProjects(cancellationKey: string): Promise<void> {
await this.waitForConnect();
this.statusBarItem.hide();
const request = new CancelProjectsRequest();
request.setCancellationKey(cancellationKey);
try {
const reply: CancelProjectsReply | undefined = await new Promise((resolve, reject) => {
this.grpcClient!.cancelProjects(
request,
(err: grpc.ServiceError | null, cancelProjectsReply: CancelProjectsReply | undefined) => {
if (err) {
reject(err);
} else {
resolve(cancelProjectsReply);
}
}
);
});
if (reply) {
logger.info("Cancel Projects:", reply.getMessage());
}
} catch (err) {
logger.error("Error cancelling Projects:", err.details || err.message);
}
}

public async getDaemonsStatus(
projectFolder: string,
cancelToken: vscode.CancellationToken
Expand Down
40 changes: 40 additions & 0 deletions extension/src/client/utils.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
// Copyright (c) Microsoft Corporation. All rights reserved.
// Licensed under the MIT license.

import * as vscode from "vscode";
import { GradleBuild, GradleProject } from "../proto/gradle_pb";
import { RootProject } from "../rootProject";
import { RootProjectsStore } from "../stores";

export function findGradleProjectFromBuild(projectPath: string, gradleBuild: GradleBuild): GradleProject | undefined {
const rootProject = gradleBuild.getProject();
if (!rootProject || !rootProject.getIsRoot()) {
return undefined;
}
return findGradleProject(projectPath, rootProject);
}

function findGradleProject(projectPath: string, project: GradleProject): GradleProject | undefined {
if (vscode.Uri.file(project.getProjectpath()).fsPath === projectPath) {
return project;
}
for (const subProject of project.getProjectsList()) {
const result = findGradleProject(projectPath, subProject);
if (result) {
return result;
}
}
return undefined;
}

export async function findRootProject(
rootProjectStore: RootProjectsStore,
projectPath: string
): Promise<RootProject | undefined> {
for (const rootProject of await rootProjectStore.getProjectRoots()) {
if (projectPath.startsWith(rootProject.getProjectUri().fsPath)) {
return rootProject;
}
}
return undefined;
}
Loading

0 comments on commit a1bcd41

Please sign in to comment.