feat: 🎸 workspace api refactoring, update project api

agroupp · agroupp · commit 50aab94e521c · 2023-03-01T09:40:26.000+02:00
diff --git a/apps/cli-daemon/src/app/workspace/dto/index.ts b/apps/cli-daemon/src/app/workspace/dto/index.ts
@@ -1 +1,3 @@
 export * from './workspace-connect.dto';
+export * from './update-project.dto';
+export * from './project.dto';
diff --git a/apps/cli-daemon/src/app/workspace/dto/project.dto.ts b/apps/cli-daemon/src/app/workspace/dto/project.dto.ts
@@ -0,0 +1,17 @@
+import { Project } from '@angular-cli-gui/shared/data';
+import { JsonValue } from '@angular-devkit/core';
+import { ProjectDefinition } from '@angular-devkit/core/src/workspace';
+
+export class ProjectDto implements Project {
+  root: string;
+  prefix?: string;
+  sourceRoot?: string;
+  extensions: Record<string, JsonValue | undefined>;
+
+  constructor(projectDefinition: ProjectDefinition) {
+    this.root = projectDefinition.root;
+    this.prefix = projectDefinition.prefix;
+    this.sourceRoot = projectDefinition.sourceRoot;
+    this.extensions = projectDefinition.extensions;
+  }
+}
diff --git a/apps/cli-daemon/src/app/workspace/dto/update-project.dto.ts b/apps/cli-daemon/src/app/workspace/dto/update-project.dto.ts
@@ -0,0 +1,19 @@
+import { IUpdateProjectDto } from '@angular-cli-gui/shared/data';
+import { JsonValue } from '@angular-devkit/core';
+import { IsOptional, IsString } from 'class-validator';
+
+export class UpdateProjectDto implements IUpdateProjectDto {
+  @IsString()
+  @IsOptional()
+  root?: string;
+
+  @IsString()
+  @IsOptional()
+  prefix?: string;
+
+  @IsString()
+  @IsOptional()
+  sourceRoot?: string;
+
+  extensions?: Record<string, JsonValue | undefined>;
+}
diff --git a/apps/cli-daemon/src/app/workspace/workspace.controller.ts b/apps/cli-daemon/src/app/workspace/workspace.controller.ts
@@ -1,15 +1,12 @@
-import {
-  ProjectDefinition,
-  TargetDefinition,
-} from '@angular-devkit/core/src/workspace';
+import { TargetDefinition } from '@angular-devkit/core/src/workspace';
 import {
   Body,
   Controller,
   Get,
   InternalServerErrorException,
   Logger,
-  NotFoundException,
   Param,
+  Patch,
   Post,
 } from '@nestjs/common';
 
@@ -18,7 +15,7 @@ import { GeneratorsService } from '../generators/generators.service';
 import { CREATE_WORKSPACE_COMMAND } from '../ng-commands';
 import { SessionService } from '../session/session.service';
 
-import { WorkspaceConnectDto } from './dto';
+import { ProjectDto, UpdateProjectDto, WorkspaceConnectDto } from './dto';
 import { WorkspaceCreateDto } from './dto/workspace-create.dto';
 import { WorkspaceService } from './workspace.service';
 
@@ -34,9 +31,7 @@ export class WorkspaceController {
 
   @Post('connect')
   async connect(@Body() body: WorkspaceConnectDto): Promise<void> {
-    const path = body.path;
-    await this.workspaceService.readWorkspace(path);
-    this.sessionService.setCwd(path);
+    await this.workspaceService.connect(body.path);
   }
 
   @Post('create')
@@ -60,68 +55,45 @@ export class WorkspaceController {
     return { path: this.sessionService.cwd };
   }
 
-  @Get()
+  @Get('project-names')
   getWorkspaceProjectNames(): Promise<string[]> {
     return this.workspaceService.readWorkspaceProjectNames();
   }
 
-  @Get(':projectName')
+  @Get('project/:projectName')
   async getProject(
     @Param('projectName') projectName: string
-  ): Promise<ProjectDefinition> {
-    let project: ProjectDefinition | undefined;
-
-    try {
-      project = await this.workspaceService.readWorkspaceProject(projectName);
-    } catch (err) {
-      this.logger.error(err);
-
-      throw new InternalServerErrorException();
-    }
-
-    if (!project) {
-      throw new NotFoundException();
-    }
+  ): Promise<ProjectDto> {
+    return this.workspaceService.readWorkspaceProject(projectName);
+  }
 
-    return project;
+  @Patch('project/:projectName')
+  async updateProject(
+    @Param('projectName') projectName: string,
+    @Body() updateProjectDto: UpdateProjectDto
+  ): Promise<ProjectDto> {
+    return await this.workspaceService.updateWorkspaceProject(
+      projectName,
+      updateProjectDto
+    );
   }
 
-  @Get(':projectName/target-names')
+  @Get('project/:projectName/target-names')
   getProjectTargetNames(
     @Param('projectName') projectName: string
   ): Promise<string[]> {
-    try {
-      return this.workspaceService.readWorkspaceProjectTargetNames(projectName);
-    } catch (err) {
-      this.logger.error(err);
-
-      throw new InternalServerErrorException();
-    }
+    return this.workspaceService.readWorkspaceProjectTargetNames(projectName);
   }
 
-  @Get(':projectName/target/:targetName')
+  @Get('project/:projectName/target/:targetName')
   async getProjectTarget(
     @Param('projectName') projectName: string,
     @Param('targetName') targetName: string
   ): Promise<TargetDefinition> {
-    let target: TargetDefinition | undefined;
-
-    try {
-      target = await this.workspaceService.readWorkspaceProjectTarget(
-        projectName,
-        targetName
-      );
-    } catch (err) {
-      this.logger.error(err);
-
-      throw new InternalServerErrorException();
-    }
-
-    if (!target) {
-      throw new NotFoundException();
-    }
-
-    return target;
+    return await this.workspaceService.readWorkspaceProjectTarget(
+      projectName,
+      targetName
+    );
   }
 
   private ngNewArgsFromDto({ name, options }: WorkspaceCreateDto): string[] {
diff --git a/apps/cli-daemon/src/app/workspace/workspace.service.ts b/apps/cli-daemon/src/app/workspace/workspace.service.ts
@@ -2,12 +2,14 @@ import { NodeJsSyncHost } from '@angular-devkit/core/node';
 import {
   createWorkspaceHost,
   readWorkspace as devKitReadWorkspace,
+  writeWorkspace as devKitWriteWorkspace,
   ProjectDefinition,
   TargetDefinition,
   WorkspaceDefinition,
 } from '@angular-devkit/core/src/workspace';
 import {
   BadRequestException,
+  HttpException,
   Injectable,
   InternalServerErrorException,
   Logger,
@@ -16,73 +18,143 @@ import {
 
 import { SessionService } from '../session/session.service';
 
+import { ProjectDto, UpdateProjectDto } from './dto';
 import {
   ANGULAR_WORKSPACE_NOT_FOUND_EXCEPTION,
   BAD_PATH_EXCEPTION,
   NOT_ANGULAR_WORKSPACE_EXCEPTION,
 } from './entities';
 
-export const ng = 'npx ng new';
+const ANGULAR_JSON = '/angular.json';
 
 @Injectable()
 export class WorkspaceService {
   private readonly logger = new Logger(WorkspaceService.name);
-  readonly ng = ng;
+  private readonly nodeJsSyncHost = new NodeJsSyncHost();
+
   constructor(private sessionService: SessionService) {}
 
-  async readWorkspace(path: string): Promise<WorkspaceDefinition> {
+  async isAngularWorkspace(path: string): Promise<boolean> {
     try {
-      return (
-        await devKitReadWorkspace(
-          path,
-          createWorkspaceHost(new NodeJsSyncHost())
-        )
-      ).workspace;
+      return !!(await devKitReadWorkspace(
+        path,
+        createWorkspaceHost(this.nodeJsSyncHost)
+      ));
+    } catch {
+      return false;
+    }
+  }
+
+  async connect(path: string): Promise<void> {
+    try {
+      await devKitReadWorkspace(path, createWorkspaceHost(this.nodeJsSyncHost));
+      this.sessionService.setCwd(path);
       // eslint-disable-next-line @typescript-eslint/no-explicit-any
     } catch (err: any) {
-      const errorMessage = err['message'];
-      switch (errorMessage) {
-        case BAD_PATH_EXCEPTION:
-          throw new BadRequestException(BAD_PATH_EXCEPTION);
-        case NOT_ANGULAR_WORKSPACE_EXCEPTION:
-          throw new NotFoundException(ANGULAR_WORKSPACE_NOT_FOUND_EXCEPTION);
-        default:
-          this.logger.error(errorMessage);
-          throw new InternalServerErrorException(err);
-      }
+      throw this.handleReadWorkspaceException(err);
     }
   }
 
   async readWorkspaceProjectNames(): Promise<string[]> {
-    const workspace = await this.readWorkspace(this.sessionService.cwd);
+    const workspaceDefinition = await this.readWorkspaceDefinition();
 
-    return Array.from(workspace.projects.keys());
+    return Array.from(workspaceDefinition.projects.keys());
   }
 
-  async readWorkspaceProject(
-    name: string
-  ): Promise<ProjectDefinition | undefined> {
-    const workspace = await this.readWorkspace(this.sessionService.cwd);
+  async readWorkspaceProject(name: string): Promise<ProjectDto> {
+    return new ProjectDto(await this.readProjectDefinition(name));
+  }
+
+  async updateWorkspaceProject(
+    name: string,
+    updateProjectDto: UpdateProjectDto
+  ): Promise<ProjectDto> {
+    const workspaceDefinition = await this.readWorkspaceDefinition();
+    const projectDefinition = workspaceDefinition.projects.get(name);
+
+    if (!projectDefinition) {
+      throw new NotFoundException(`Project ${name} not found`);
+    }
+
+    Object.assign(projectDefinition, updateProjectDto);
+    await this.writeWorkspace(workspaceDefinition);
 
-    return workspace?.projects?.get(name);
+    return this.readWorkspaceProject(name);
   }
 
   async readWorkspaceProjectTargetNames(name: string): Promise<string[]> {
-    const project = await this.readWorkspaceProject(name);
+    const projectDefinition = await this.readProjectDefinition(name);
 
-    if (!project?.targets?.size) {
+    if (!projectDefinition?.targets?.size) {
       return [];
     }
 
-    return Array.from(project.targets.keys());
+    return Array.from(projectDefinition.targets.keys());
   }
 
   async readWorkspaceProjectTarget(
     projectName: string,
     targetName: string
-  ): Promise<TargetDefinition | undefined> {
-    const project = await this.readWorkspaceProject(projectName);
+  ): Promise<TargetDefinition> {
+    const projectDefinition = await this.readProjectDefinition(projectName);
+    const targetDefinition = projectDefinition.targets.get(targetName);
+
+    if (!targetDefinition) {
+      throw new NotFoundException(`Target ${targetName} not found`);
+    }
+
+    return targetDefinition;
+  }
 
-    return project?.targets.get(targetName);
+  private async readWorkspaceDefinition(): Promise<WorkspaceDefinition> {
+    try {
+      return (
+        await devKitReadWorkspace(
+          this.sessionService.cwd,
+          createWorkspaceHost(this.nodeJsSyncHost)
+        )
+      ).workspace;
+      // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    } catch (err: any) {
+      throw this.handleReadWorkspaceException(err);
+    }
+  }
+
+  private async writeWorkspace(
+    workspaceDefinition: WorkspaceDefinition
+  ): Promise<void> {
+    await devKitWriteWorkspace(
+      workspaceDefinition,
+      createWorkspaceHost(this.nodeJsSyncHost),
+      `${this.sessionService.cwd}${ANGULAR_JSON}`
+    );
+  }
+
+  private async readProjectDefinition(
+    name: string
+  ): Promise<ProjectDefinition> {
+    const workspaceDefinition = await this.readWorkspaceDefinition();
+    const projectDefinition = workspaceDefinition.projects.get(name);
+
+    if (!projectDefinition) {
+      throw new NotFoundException(`Project ${name} not found`);
+    }
+
+    return projectDefinition;
+  }
+
+  private handleReadWorkspaceException(err: {
+    message: string;
+  }): HttpException {
+    const errorMessage = err['message'];
+    switch (errorMessage) {
+      case BAD_PATH_EXCEPTION:
+        return new BadRequestException(BAD_PATH_EXCEPTION);
+      case NOT_ANGULAR_WORKSPACE_EXCEPTION:
+        return new NotFoundException(ANGULAR_WORKSPACE_NOT_FOUND_EXCEPTION);
+      default:
+        this.logger.error(errorMessage);
+        return new InternalServerErrorException(err);
+    }
   }
 }
diff --git a/libs/shared/data/src/index.ts b/libs/shared/data/src/index.ts
@@ -2,3 +2,4 @@ export * from './lib/exec-result.interface';
 export * from './lib/generate-component-args.interface';
 export * from './lib/directory.interface';
 export * from './lib/local-storage-keys.consts';
+export * from './lib/workspace';
diff --git a/libs/shared/data/src/lib/workspace/index.ts b/libs/shared/data/src/lib/workspace/index.ts
@@ -0,0 +1,3 @@
+export * from './update-project.dto';
+export * from './project';
+export * from './target';
diff --git a/libs/shared/data/src/lib/workspace/project.ts b/libs/shared/data/src/lib/workspace/project.ts
@@ -0,0 +1,8 @@
+import { JsonValue } from '@angular-devkit/core';
+
+export interface Project {
+  root: string;
+  prefix?: string;
+  sourceRoot?: string;
+  extensions: Record<string, JsonValue | undefined>;
+}
diff --git a/libs/shared/data/src/lib/workspace/target.ts b/libs/shared/data/src/lib/workspace/target.ts
@@ -0,0 +1,11 @@
+import { JsonValue } from '@angular-devkit/core';
+
+export interface Target {
+  options?: Record<string, JsonValue | undefined>;
+  configurations?: Record<
+    string,
+    Record<string, JsonValue | undefined> | undefined
+  >;
+  defaultConfiguration?: string;
+  builder: string;
+}
diff --git a/libs/shared/data/src/lib/workspace/update-project.dto.ts b/libs/shared/data/src/lib/workspace/update-project.dto.ts
@@ -0,0 +1,5 @@
+export interface IUpdateProjectDto {
+  root?: string;
+  prefix?: string;
+  sourceRoot?: string;
+}

Original file line number	Diff line number	Diff line change
`@@ -1 +1,3 @@`
`1`	`1`	`export * from './workspace-connect.dto';`
	`2`	`+export * from './update-project.dto';`
	`3`	`+export * from './project.dto';`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+export * from './update-project.dto';`
	`2`	`+export * from './project';`
	`3`	`+export * from './target';`