Skip to content

Commit

Permalink
convert project properties into interface for future expandibility
Browse files Browse the repository at this point in the history
  • Loading branch information
@alexyaang
alexyaang committed Jul 10, 2023
1 parent 01c18d9 commit ae8fc23
Show file tree
Hide file tree
Showing 2 changed files with 68 additions and 31 deletions.
59 changes: 35 additions & 24 deletions src/debugging/netSdk/NetSdkDebugHelper.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -19,11 +19,17 @@ import { quickPickProjectFileItem } from "../../utils/quickPickFile";
import { unresolveWorkspaceFolder } from "../../utils/resolveVariables";
import { DockerDebugContext, DockerDebugScaffoldContext, ResolvedDebugConfiguration } from "../DebugHelper";
import { DockerDebugConfiguration } from "../DockerDebugConfigurationProvider";
import { NetCoreDebugHelper, NetCoreDebugScaffoldingOptions } from "../netcore/NetCoreDebugHelper";
import { NetCoreDebugHelper, NetCoreDebugScaffoldingOptions, NetCoreProjectProperties } from "../netcore/NetCoreDebugHelper";

export interface NetSdkProjectProperties extends NetCoreProjectProperties {
containerWorkingDirectory: string;
isSdkContainerSupportEnabled: boolean;
containerName: string;
}

export class NetSdkDebugHelper extends NetCoreDebugHelper {

private projectInfo: string[] | undefined;
protected projectProperties: NetSdkProjectProperties | undefined;

public override async provideDebugConfigurations(context: DockerDebugScaffoldContext, options?: NetCoreDebugScaffoldingOptions): Promise<DockerDebugConfiguration[]> {
const configurations: DockerDebugConfiguration[] = [];
Expand Down Expand Up @@ -64,13 +70,13 @@ export class NetSdkDebugHelper extends NetCoreDebugHelper {
}

public async afterResolveDebugConfiguration(context: DockerDebugContext, debugConfiguration: DockerDebugConfiguration): Promise<void> {
const projectInfo = await this.getProjectInfo(debugConfiguration);
const projectInfo = await this.getProjectProperties(debugConfiguration);
const runDefinition: Omit<NetSdkRunTaskDefinition, "type"> = {
netCore: {
appProject: debugConfiguration?.netCore?.appProject || await this.inferProjPath(context.actionContext, context.folder),
},
dockerRun: {
containerName: projectInfo[5]
containerName: projectInfo.containerName
}
};

Expand All @@ -80,28 +86,24 @@ export class NetSdkDebugHelper extends NetCoreDebugHelper {
}

protected override async inferAppOutput(debugConfiguration: DockerDebugConfiguration): Promise<string> {
const projectInfo = await this.getProjectInfo(debugConfiguration);

if (projectInfo.length >= 5) { // if .NET has support for SDK Build
// fifth is whether .NET Web apps supports SDK Containers
if (projectInfo[4] === 'true') {
return await getDockerOSType() === 'windows' // fourth is output path
? path.win32.normalize(projectInfo[3])
: path.posix.normalize(projectInfo[3]);
} else {
throw new Error(l10n.t("Your current project configuration or .NET SDK version doesn't support SDK Container build. Please choose a compatible project or update .NET SDK."));
}
}
const projectInfo = await this.getProjectProperties(debugConfiguration);

throw new Error(l10n.t('Unable to determine assembly output path.'));
// fifth is whether .NET Web apps supports SDK Containers
if (projectInfo.isSdkContainerSupportEnabled) {
return await getDockerOSType() === 'windows' // fourth is output path
? path.win32.normalize(projectInfo.containerWorkingDirectory)
: path.posix.normalize(projectInfo.containerWorkingDirectory);
} else {
throw new Error(l10n.t("Your current project configuration or .NET SDK version doesn't support SDK Container build. Please choose a compatible project or update .NET SDK."));
}
}

protected override async loadExternalInfo(context: DockerDebugContext, debugConfiguration: DockerDebugConfiguration): Promise<{ configureSsl: boolean, containerName: string, platformOS: PlatformOS }> {
const associatedTask = context.runDefinition;
const projectInfo = await this.getProjectInfo(debugConfiguration);
const projectInfo = await this.getProjectProperties(debugConfiguration);
return {
configureSsl: !!(associatedTask?.netCore?.configureSsl),
containerName: getContainerNameWithTag(projectInfo[5], "dev"),
containerName: getContainerNameWithTag(projectInfo.containerName, "dev"),
platformOS: await getDockerOSType() === "windows" ? 'Windows' : 'Linux',
};
}
Expand All @@ -110,9 +112,9 @@ export class NetSdkDebugHelper extends NetCoreDebugHelper {
return appOutput;
}

private async getProjectInfo(debugConfiguration: DockerDebugConfiguration): Promise<string[]> {
if (this.projectInfo && this.projectInfo.length >= 6) {
return this.projectInfo;
protected override async getProjectProperties(debugConfiguration: DockerDebugConfiguration): Promise<NetSdkProjectProperties> {
if (this.projectProperties) {
return this.projectProperties;
}

const ridOS = await normalizeOsToRidOs();
Expand All @@ -125,8 +127,17 @@ export class NetSdkDebugHelper extends NetCoreDebugHelper {
throw new Error(l10n.t("Your current project configuration or .NET SDK version doesn't support SDK Container build. Please choose a compatible project or update .NET SDK."));
}

this.projectInfo = projectInfo;
return projectInfo;
const projectProperties: NetSdkProjectProperties = {
assemblyName: projectInfo[0],
targetFramework: projectInfo[1],
appOutput: projectInfo[2],
containerWorkingDirectory: projectInfo[3],
isSdkContainerSupportEnabled: projectInfo[4] === 'true',
containerName: projectInfo[5],
};

this.projectProperties = projectProperties;
return projectProperties;
}

/**
Expand Down
40 changes: 33 additions & 7 deletions src/debugging/netcore/NetCoreDebugHelper.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,16 @@ export interface NetCoreDebugScaffoldingOptions {
appProject?: string;
}

export interface NetCoreProjectProperties {
assemblyName: string;
targetFramework: string;
appOutput: string;
}

export class NetCoreDebugHelper implements DebugHelper {

protected projectProperties: NetCoreProjectProperties | undefined;

public async provideDebugConfigurations(context: DockerDebugScaffoldContext, options?: NetCoreDebugScaffoldingOptions): Promise<DockerDebugConfiguration[]> {
options = options || {};
options.appProject = options.appProject || await NetCoreTaskHelper.inferAppProject(context); // This method internally checks the user-defined input first
Expand Down Expand Up @@ -178,13 +187,8 @@ export class NetCoreDebugHelper implements DebugHelper {
}

protected async inferAppOutput(debugConfiguration: DockerDebugConfiguration): Promise<string> {
const projectInfo = await getNetCoreProjectInfo('GetProjectProperties', debugConfiguration.netCore?.appProject);

if (projectInfo.length < 3) {
throw new Error(l10n.t('Unable to determine assembly output path.'));
}

return projectInfo[2]; // First line is assembly name, second is target framework, third+ are output path(s)
const projectProperties = await this.getProjectProperties(debugConfiguration);
return projectProperties.appOutput;
}

protected inferAppContainerOutput(appOutput: string, platformOS: PlatformOS): string {
Expand All @@ -205,6 +209,28 @@ export class NetCoreDebugHelper implements DebugHelper {
};
}

protected async getProjectProperties(debugConfiguration: DockerDebugConfiguration): Promise<NetCoreProjectProperties> {
if (this.projectProperties) {
return this.projectProperties;
}

const projectInfo = await getNetCoreProjectInfo('GetProjectProperties', debugConfiguration.netCore?.appProject);

if (projectInfo.length < 3) {
throw new Error(l10n.t('Unable to determine assembly output path.'));
}

// First line is assembly name, second is target framework, third+ are output path(s)
const projectProperties: NetCoreProjectProperties = {
assemblyName: projectInfo[0],
targetFramework: projectInfo[1],
appOutput: projectInfo[2]
};

this.projectProperties = projectProperties;
return projectProperties;
}

private async acquireDebuggers(platformOS: PlatformOS): Promise<void> {
await window.withProgress(
{
Expand Down

0 comments on commit ae8fc23

Please sign in to comment.