feat: Feat adding build project api and auth #111
Conversation
…t model and project packages
…d update input types
|
Caution Review failedThe pull request is closed. Warning There were issues while running some tools. Please review the errors and either fix the tool’s configuration or disable the tool if it’s a critical failure. 🔧 ESLint
backend/src/build-system/context.tsOops! Something went wrong! :( ESLint: 8.57.1 ESLint couldn't find the plugin "eslint-plugin-prettier". (The package "eslint-plugin-prettier" was not found when loaded as a Node module from the directory "/backend".) It's likely that the plugin isn't installed correctly. Try reinstalling by running the following: The plugin "eslint-plugin-prettier" was referenced from the config file in "backend/.eslintrc.js". If you still can't figure out the problem, please stop by https://eslint.org/chat/help to chat with the team. WalkthroughThis pull request implements multiple changes across the backend and frontend. In the build system, the Changes
Sequence Diagram(s)sequenceDiagram
participant C as Client
participant G as GraphQL API
participant R as ProjectsResolver
participant S as ProjectService
participant DB as Database
C->>G: Send createProject Mutation with CreateProjectInput
G->>R: Forward createProject(createProjectInput)
R->>S: Invoke createProject(input, userId)
S->>DB: Transform input & persist Project and related packages
S-->>R: Return created Project (with projectUUID)
R-->>G: Respond with Project details
G-->>C: Return created Project result
sequenceDiagram
participant C as Client
participant G as GraphQL API
participant R as ProjectsResolver
participant S as ProjectService
participant DB as Database
C->>G: Send isValidateProject Query with IsValidProjectInput
G->>R: Forward isValidateProject(isValidProjectInput)
R->>S: Invoke isValidProject(userId, input)
S->>DB: Check Project existence & ownership
S-->>R: Return validation result (true/false)
R-->>G: Respond with validation status
G-->>C: Return Boolean result
Possibly related PRs
Suggested labels
Suggested reviewers
Poem
📜 Recent review detailsConfiguration used: CodeRabbit UI 📒 Files selected for processing (1)
✨ Finishing Touches
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 12
🔭 Outside diff range comments (2)
backend/src/common/model-provider/openai-model-provider.ts (1)
12-12: Local dependency reference missing in package.json
- The
package.jsonfile doesn't listcodefox-commonas a dependency (or devDependency).- A local directory named
codefox-commonexists, confirming that the module is local but isn't linked in the package manifest.- To resolve the pipeline issue, add
"codefox-common": "file:codefox-common"(or the appropriate relative path) to the dependencies section of yourpackage.json.🔗 Analysis chain
Fix missing dependency.
The pipeline is failing due to a missing
codefox-commonmodule. This dependency needs to be added to the project's package.json.Let's verify if this is a local or published package:
🏁 Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Description: Check if codefox-common is a local package or needs to be published # Check if package.json exists in the repository if [ -f package.json ]; then echo "Found package.json" # Check dependencies and devDependencies for codefox-common jq '.dependencies["codefox-common"] // .devDependencies["codefox-common"] // "Not found"' package.json fi # Search for codefox-common directory fd -t d "codefox-common$"Length of output: 233
🧰 Tools
🪛 GitHub Actions: Run tests and upload coverage
[error] 12-12: Cannot find module 'codefox-common' or its corresponding type declarations.
backend/src/project/dto/project.input.ts (1)
4-19: Enhance the deprecation notice.The deprecation comment should provide more context about:
- Why the upsert functionality is no longer needed
- What developers should use instead (e.g., CreateProjectInput)
- When this class will be removed
Also, the
pathfield is missing the@Fielddecorator./** - * @deprecated We don't need project upsert + * @deprecated This class is deprecated as project creation and updates are now handled separately. + * Use CreateProjectInput for creating new projects. + * This will be removed in the next major version. */ @InputType() export class UpsertProjectInput { @Field() projectName: string; + @Field() path: string;
🧹 Nitpick comments (15)
backend/src/common/model-provider/openai-model-provider.ts (1)
13-90: Improve singleton implementation to prevent race conditions.The current singleton implementation could lead to race conditions in a concurrent environment. Consider using a more robust singleton pattern.
export class OpenAIModelProvider implements IModelProvider { - private static instance: OpenAIModelProvider; + private static instance: OpenAIModelProvider | null = null; + private static instanceLock = false; // ... other properties public static getInstance(): OpenAIModelProvider { - if (!OpenAIModelProvider.instance) { - OpenAIModelProvider.instance = new OpenAIModelProvider(); + if (OpenAIModelProvider.instance === null) { + if (OpenAIModelProvider.instanceLock) { + throw new Error('Instance creation in progress'); + } + OpenAIModelProvider.instanceLock = true; + try { + OpenAIModelProvider.instance = new OpenAIModelProvider(); + } finally { + OpenAIModelProvider.instanceLock = false; + } } return OpenAIModelProvider.instance; }backend/src/project/project-packages.model.ts (1)
21-22: Check cascading options for many-to-many relationships.When using
@ManyToMany, confirm that cascading and eager/lazy loading options are properly set to meet your use case. For example,cascade: truecan automatically persist related packages when persisting projects.backend/src/guard/project.guard.ts (6)
6-6: Use consistent logging levels.Importing
Loggeris fine. Confirm that you’re using consistent logging levels (e.g.,debug,log,warn,error) for a clean trace, and avoid exposing sensitive data in logs.
27-29: Ensure the user object is fully validated.Calling
await this.validateToken(request)is good. Consider verifying user properties (e.g., active status, roles) if needed for more granular authorization controls.
41-44: Attach user object torequestcarefully.Storing the user in
request.useris standard practice. Just verify that subsequent resolvers can handle a possibly undefined user if something fails upstream.
46-59: Expand token validation for expiration checks.
validateTokenverifies the token but does not explicitly handle token expiration or refresh logic. If you rely on short-lived tokens, ensure you handle expired tokens appropriately.
61-72: Simplify repeated property lookups.
extractProjectIdentifierchecks multiple argument paths. Consider a more concise approach, e.g., scanning an array of likely properties and returning the first match.- if (args.projectId) return args.projectId; - if (args.input?.projectId) return args.input.projectId; - ... + const candidateIds = [ + args.projectId, + args.input?.projectId, + args.isValidProject?.projectId, + args.projectPath, + args.input?.projectPath, + args.isValidProject?.projectPath, + ]; + return candidateIds.find(Boolean);
74-99: Avoid repeated fetch attempts for project ownership checks.
validateProjectOwnershipfetches the project each time. Performance is usually fine for a single check, but if called in multiple places, caching or retrieving from context might be more efficient. Also, consider using transactions if you extend ownership checks to multiple entities.backend/src/project/project.service.ts (1)
127-173: Refine package updating logic for concurrency.
transformInputToProjectPackagesupdates versions if they differ. In concurrent scenarios, you may risk race conditions. Consider using optimistic locking or a transaction if multiple users can modify packages simultaneously.backend/src/project/dto/project.input.ts (3)
21-34: Add validation decorators for required fields.Consider adding class-validator decorators to ensure data integrity:
@InputType() export class CreateProjectInput { @Field(() => String, { nullable: true }) + @IsOptional() + @IsString() projectName?: string; @Field() + @IsNotEmpty() + @IsString() description: string; @Field(() => [ProjectPackage]) + @IsNotEmpty() + @ValidateNested({ each: true }) + @Type(() => ProjectPackage) packages: ProjectPackage[]; @Field(() => String, { nullable: true }) + @IsOptional() + @IsString() databaseType?: string; }Don't forget to import the necessary decorators:
import { IsNotEmpty, IsOptional, IsString, ValidateNested } from 'class-validator'; import { Type } from 'class-transformer';
36-43: Add validation decorators with semantic version validation.Consider adding class-validator decorators with semantic version validation:
@InputType() export class ProjectPackage { @Field() + @IsNotEmpty() + @IsString() name: string; @Field() + @IsNotEmpty() + @Matches(/^(\d+\.)?(\d+\.)?(\*|\d+)$/, { + message: 'Version must be a valid semantic version (e.g., 1.0.0)', + }) version: string; }Don't forget to import the necessary decorators:
import { IsNotEmpty, IsString, Matches } from 'class-validator';
45-52: Improve class name and add validation decorators.
- The class name should follow the verb-noun convention. Consider renaming to
ValidateProjectInput.- Add validation decorators for the fields:
@InputType() -export class IsValidProjectInput { +export class ValidateProjectInput { @Field(() => ID) + @IsNotEmpty() + @IsUUID() projectId: string; @Field(() => String, { nullable: true }) + @IsOptional() + @IsString() projectPath: string; }Don't forget to import the necessary decorators:
import { IsNotEmpty, IsOptional, IsString, IsUUID } from 'class-validator';backend/src/project/project.resolver.ts (1)
44-50: Improve method and parameter naming.
- The method name should follow the verb-noun convention
- The input parameter name should match the type name
@Query(() => Boolean) - async isValidateProject( + async validateProject( @GetUserIdFromToken() userId: number, - @Args('isValidProject') input: IsValidProjectInput, + @Args('validateProjectInput') input: IsValidProjectInput, ): Promise<boolean> { return this.projectsService.isValidProject(userId, input); }backend/src/build-system/types.ts (2)
33-33: Add JSDoc documentation for the packages field.Consider adding documentation to explain the purpose and usage of the packages field:
+ /** + * List of project packages required for the build sequence. + * These packages will be installed during the build process. + */ packages: BuildProjectPackage[];
35-38: Add JSDoc documentation for the BuildProjectPackage interface.Consider adding documentation to explain the purpose and structure of the interface:
+/** + * Represents a package required for the build sequence. + * This interface defines the structure of package information + * used during the build process. + */ export interface BuildProjectPackage { + /** The name of the package */ name: string; + /** The version of the package in semantic version format */ version: string; }
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (13)
backend/src/build-system/__tests__/mock/MockBuilderContext.ts(1 hunks)backend/src/build-system/context.ts(3 hunks)backend/src/build-system/types.ts(1 hunks)backend/src/common/model-provider/openai-model-provider.ts(3 hunks)backend/src/common/model-provider/types.ts(1 hunks)backend/src/guard/project.guard.ts(3 hunks)backend/src/project/build-system-utils.ts(1 hunks)backend/src/project/dto/project.input.ts(2 hunks)backend/src/project/project-packages.model.ts(2 hunks)backend/src/project/project.model.ts(3 hunks)backend/src/project/project.resolver.ts(3 hunks)backend/src/project/project.service.ts(3 hunks)frontend/src/graphql/schema.gql(4 hunks)
🧰 Additional context used
🪛 GitHub Actions: Run tests and upload coverage
backend/src/common/model-provider/openai-model-provider.ts
[error] 12-12: Cannot find module 'codefox-common' or its corresponding type declarations.
🔇 Additional comments (20)
backend/src/build-system/context.ts (3)
100-100: LGTM!The logger initialization with fallback to sequence.id is a good defensive programming practice.
109-111: LGTM!The refactoring of project UUID generation into a separate variable improves code readability.
314-314: Verify the impact of the execute method's return type change.The change from
Promise<void>toPromise<string>is a breaking change that could affect consumers of this API.Let's verify the usage of this method in the codebase:
Also applies to: 371-371
✅ Verification successful
The execute() method's new Promise return type is safely handled by its consumers.
- In
project/service.ts, the returned string is captured and used as the project path.- Test mocks in
__tests__/mock/MockBuilderContext.tshave been updated to return a string.- Other calls, such as in
__tests__/fullstack-gen.spec.tsand__tests__/utils.ts, simply await the result, which is acceptable in TypeScript even if the caller does not use the value.🏁 Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Description: Find all calls to the execute method to ensure they handle the returned string. rg -A 5 'execute\(\)' --type tsLength of output: 2004
backend/src/common/model-provider/types.ts (1)
23-24: LGTM! Good documentation of the default model behavior.The change to make the model optional is well documented with the comment explaining the fallback behavior.
backend/src/project/project-packages.model.ts (2)
3-3: Confirm the need for a join table.Now that
ManyToManyis being imported, ensure you properly configure a join table on at least one side of the many-to-many relationship. Consider using@JoinTable()on the owning side so TypeORM can manage the associations.
17-20: Validate the necessity of a non-null version.A
versionfield can be beneficial for package version control, but ensure it meets your business logic. If there's a possibility of an undefined version, consider making it nullable or providing a default value.backend/src/guard/project.guard.ts (3)
15-16: Good practice for dedicated class-based logger.Defining a private logger with
new Logger('ProjectGuard')is a standard approach. Ensure that logs are not overly verbose in production environments.
25-26: Watch out for large GraphQL argument payloads.Extracting
argsdirectly is acceptable. In high-traffic or large-payload scenarios, ensure that you handle or limit the request body size if needed for performance or security.
38-39: Good approach to ownership checks.You’re explicitly calling
validateProjectOwnership(projectIdentifier, user.userId). This ensures only the project’s owner can proceed. Keep it up.backend/src/project/project.service.ts (4)
6-9: Check for query builder usage.You introduced new imports like
Logger,In, and updated injection forRepository. This is a good approach for simpler queries. If you need more complex logic, consider TypeORM’s QueryBuilder for advanced filtering or indexing.
12-20: Imports for new Input DTOs look consistent.Adding
CreateProjectInput,IsValidProjectInput, andProjectPackageis fine. Double-check that the DTO fields align precisely with your database schema and relationships.
27-29: Singleton pattern forOpenAIModelProvider.Using
OpenAIModelProvider.getInstance()is good if you want a single instance. Ensure thread safety if you run your NestJS application at scale; singletons may need concurrency considerations.
205-236: Return errors or booleans consistently.
isValidProjectreturnsfalsefor not found or mismatch scenarios, but aNotFoundExceptionfor other methods. Ensure consistent patterns. If you want a simple check, returningfalseis fine; otherwise, be uniform with exceptions to keep the codebase consistent.backend/src/project/project.model.ts (3)
28-28: LGTM! Improved field naming.The rename from
pathtoprojectPathmakes the field's purpose more explicit.
43-53: LGTM! Well-structured join table configuration.The join table configuration follows best practices:
- Clear table naming convention
- Explicit column mappings
- Proper reference definitions
39-42: Verify database migration for relationship change.The relationship change from
@OneToManyto@ManyToManyis a breaking change that requires careful migration planning.Please ensure that:
- A database migration script is included
- Existing data is properly handled during migration
- The change is documented in the changelog
Run this script to check for migration files:
frontend/src/graphql/schema.gql (4)
56-59: LGTM!The input type is well-structured with appropriate field requirements.
115-115: LGTM!The field rename from
pathtoprojectPathimproves clarity and specificity.
120-123: LGTM!The input type follows standard package management practices with appropriate required fields.
132-132: LGTM!Adding the required
versionfield improves version tracking capabilities.
| execute(): Promise<string> { | ||
| return Promise.resolve(''); // Mock a resolved promise for execution |
There was a problem hiding this comment.
Return value should match parent class implementation.
The mock implementation should return a valid project UUID to match the parent class behavior, instead of an empty string.
Apply this diff to align with the parent class:
- execute(): Promise<string> {
- return Promise.resolve(''); // Mock a resolved promise for execution
+ execute(): Promise<string> {
+ return Promise.resolve(this.getGlobalContext('projectUUID') || ''); // Return the project UUID from global context📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| execute(): Promise<string> { | |
| return Promise.resolve(''); // Mock a resolved promise for execution | |
| execute(): Promise<string> { | |
| return Promise.resolve(this.getGlobalContext('projectUUID') || ''); // Return the project UUID from global context |
| @@ -16,6 +16,7 @@ export class OpenAIModelProvider implements IModelProvider { | |||
| private readonly logger = new Logger('OpenAIModelProvider'); | |||
| private queues: Map<string, PQueue> = new Map(); | |||
| private configLoader: ConfigLoader; | |||
| private defaultModel: string; | |||
There was a problem hiding this comment.
Initialize defaultModel to avoid potential undefined access.
The defaultModel property should be initialized with a default value to prevent potential undefined access.
- private defaultModel: string;
+ private defaultModel: string = '';📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| private defaultModel: string; | |
| private defaultModel: string = ''; |
| @@ -87,7 +91,7 @@ | |||
|
|
|||
| async chatSync(input: ChatInput): Promise<string> { | |||
| try { | |||
| const queue = this.getQueueForModel(input.model); | |||
| const queue = this.getQueueForModel(input.model ?? this.defaultModel); | |||
There was a problem hiding this comment.
Add null check for defaultModel in chatSync.
The chatSync method should verify that defaultModel is available before using it.
- const queue = this.getQueueForModel(input.model ?? this.defaultModel);
+ if (!input.model && !this.defaultModel) {
+ throw new Error('No model specified and no default model configured');
+ }
+ const queue = this.getQueueForModel(input.model ?? this.defaultModel);📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| const queue = this.getQueueForModel(input.model ?? this.defaultModel); | |
| if (!input.model && !this.defaultModel) { | |
| throw new Error('No model specified and no default model configured'); | |
| } | |
| const queue = this.getQueueForModel(input.model ?? this.defaultModel); |
| if (model.default) { | ||
| this.defaultModel = model.model; | ||
| } |
There was a problem hiding this comment.
Add error handling for missing default model configuration.
The code assumes at least one model will be marked as default. Add error handling to ensure a default model is always available.
+ private hasDefaultModel = false;
private initializeQueues(): void {
const chatModels = this.configLoader.getAllChatModelConfigs();
for (const model of chatModels) {
if (model.default) {
this.defaultModel = model.model;
+ this.hasDefaultModel = true;
}
if (!model.endpoint || !model.token) continue;
// ... rest of the code
}
+ if (!this.hasDefaultModel) {
+ this.logger.error('No default model configured');
+ throw new Error('No default model configured in model provider');
+ }
}📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| if (model.default) { | |
| this.defaultModel = model.model; | |
| } | |
| class OpenaiModelProvider { | |
| // ... other class members | |
| private hasDefaultModel = false; | |
| private initializeQueues(): void { | |
| const chatModels = this.configLoader.getAllChatModelConfigs(); | |
| for (const model of chatModels) { | |
| if (model.default) { | |
| this.defaultModel = model.model; | |
| this.hasDefaultModel = true; | |
| } | |
| if (!model.endpoint || !model.token) continue; | |
| // ... rest of the code | |
| } | |
| if (!this.hasDefaultModel) { | |
| this.logger.error('No default model configured'); | |
| throw new Error('No default model configured in model provider'); | |
| } | |
| } | |
| // ... other methods | |
| } |
| // Extract project identifier from arguments | ||
| const projectIdentifier = this.extractProjectIdentifier(args); | ||
|
|
||
| if (!projectIdentifier) { | ||
| this.logger.debug('No project identifier found in request'); | ||
| return true; // Skip check if no project identifier is found | ||
| } |
There was a problem hiding this comment.
Potential bypass if project identifier is missing.
When no project identifier is found, the guard immediately returns true, which effectively skips ownership checks. Confirm that this is intentional. Otherwise, you might introduce a security gap that allows requests without a project ID to pass.
if (!projectIdentifier) {
- return true; // Skip check
+ throw new UnauthorizedException('Missing project identifier');
}📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| // Extract project identifier from arguments | |
| const projectIdentifier = this.extractProjectIdentifier(args); | |
| if (!projectIdentifier) { | |
| this.logger.debug('No project identifier found in request'); | |
| return true; // Skip check if no project identifier is found | |
| } | |
| // Extract project identifier from arguments | |
| const projectIdentifier = this.extractProjectIdentifier(args); | |
| if (!projectIdentifier) { | |
| this.logger.debug('No project identifier found in request'); | |
| throw new UnauthorizedException('Missing project identifier'); | |
| } |
| input CreateProjectInput { | ||
| databaseType: String | ||
| description: String! | ||
| packages: [ProjectPackage!]! | ||
| projectName: String | ||
| } |
There was a problem hiding this comment.
🛠️ Refactor suggestion
Make projectName a required field.
The projectName field should be required as it's essential for project identification and management.
Apply this diff to make projectName required:
input CreateProjectInput {
databaseType: String
description: String!
packages: [ProjectPackage!]!
- projectName: String
+ projectName: String!
}📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| input CreateProjectInput { | |
| databaseType: String | |
| description: String! | |
| packages: [ProjectPackage!]! | |
| projectName: String | |
| } | |
| input CreateProjectInput { | |
| databaseType: String | |
| description: String! | |
| packages: [ProjectPackage!]! | |
| projectName: String! | |
| } |
| @@ -80,15 +92,13 @@ | |||
| type Mutation { | |||
| clearChatHistory(chatId: String!): Boolean! | |||
| createChat(newChatInput: NewChatInput!): Chat! | |||
| createPorject(createProjectInput: CreateProjectInput!): Project! | |||
There was a problem hiding this comment.
Fix typo in mutation name.
The mutation name contains a typo: "createPorject" should be "createProject".
Apply this diff to fix the typo:
- createPorject(createProjectInput: CreateProjectInput!): Project!
+ createProject(createProjectInput: CreateProjectInput!): Project!📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| createPorject(createProjectInput: CreateProjectInput!): Project! | |
| createProject(createProjectInput: CreateProjectInput!): Project! |
| @@ -126,6 +141,7 @@ | |||
| getProjectDetails(projectId: String!): Project! | |||
| getUserChats: [Chat!] | |||
| getUserProjects: [Project!]! | |||
| isValidateProject(isValidProject: IsValidProjectInput!): Boolean! | |||
There was a problem hiding this comment.
🛠️ Refactor suggestion
Fix query name to follow naming conventions.
The query name "isValidateProject" is grammatically incorrect. Consider using either "isValidProject" or "validateProject" based on the intended behavior.
Apply one of these diffs based on the intended behavior:
- isValidateProject(isValidProject: IsValidProjectInput!): Boolean!
+ isValidProject(isValidProject: IsValidProjectInput!): Boolean!OR
- isValidateProject(isValidProject: IsValidProjectInput!): Boolean!
+ validateProject(isValidProject: IsValidProjectInput!): Boolean!📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| isValidateProject(isValidProject: IsValidProjectInput!): Boolean! | |
| isValidProject(isValidProject: IsValidProjectInput!): Boolean! |
| export function generateProjectNamePrompt(description: string): string { | ||
| return `You are a project name generator. Based on the following project description, generate a concise, memorable, and meaningful project name. | ||
|
|
||
| Input Description: ${description} | ||
|
|
||
| Requirements for the project name: | ||
| 1. Must be 1-3 words maximum | ||
| 2. Should be clear and professional | ||
| 3. Avoid generic terms like "project" or "system" | ||
| 4. Use camelCase or kebab-case format | ||
| 5. Should reflect the core functionality or purpose | ||
| 6. Must be unique and memorable | ||
| 7. Should be easy to pronounce | ||
| 8. Avoid acronyms unless they're very intuitive | ||
|
|
||
| Please respond ONLY with the project name, without any explanation or additional text. | ||
|
|
||
| Example inputs and outputs: | ||
| Description: "A task management system with real-time collaboration features" | ||
| Output: taskFlow | ||
|
|
||
| Description: "An AI-powered document analysis and extraction system" | ||
| Output: docMind | ||
|
|
||
| Description: "A microservice-based e-commerce platform with advanced inventory management" | ||
| Output: tradeCore`; | ||
| } |
There was a problem hiding this comment.
🛠️ Refactor suggestion
Add input validation.
The function should validate the input description to ensure it's not empty or too long.
Apply this diff:
export function generateProjectNamePrompt(description: string): string {
+ if (!description?.trim()) {
+ throw new Error('Description is required');
+ }
+ if (description.length > 500) {
+ throw new Error('Description is too long. Maximum length is 500 characters');
+ }
+
return `You are a project name generator. Based on the following project description, generate a concise, memorable, and meaningful project name.📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| export function generateProjectNamePrompt(description: string): string { | |
| return `You are a project name generator. Based on the following project description, generate a concise, memorable, and meaningful project name. | |
| Input Description: ${description} | |
| Requirements for the project name: | |
| 1. Must be 1-3 words maximum | |
| 2. Should be clear and professional | |
| 3. Avoid generic terms like "project" or "system" | |
| 4. Use camelCase or kebab-case format | |
| 5. Should reflect the core functionality or purpose | |
| 6. Must be unique and memorable | |
| 7. Should be easy to pronounce | |
| 8. Avoid acronyms unless they're very intuitive | |
| Please respond ONLY with the project name, without any explanation or additional text. | |
| Example inputs and outputs: | |
| Description: "A task management system with real-time collaboration features" | |
| Output: taskFlow | |
| Description: "An AI-powered document analysis and extraction system" | |
| Output: docMind | |
| Description: "A microservice-based e-commerce platform with advanced inventory management" | |
| Output: tradeCore`; | |
| } | |
| export function generateProjectNamePrompt(description: string): string { | |
| if (!description?.trim()) { | |
| throw new Error('Description is required'); | |
| } | |
| if (description.length > 500) { | |
| throw new Error('Description is too long. Maximum length is 500 characters'); | |
| } | |
| return `You are a project name generator. Based on the following project description, generate a concise, memorable, and meaningful project name. | |
| Input Description: ${description} | |
| Requirements for the project name: | |
| 1. Must be 1-3 words maximum | |
| 2. Should be clear and professional | |
| 3. Avoid generic terms like "project" or "system" | |
| 4. Use camelCase or kebab-case format | |
| 5. Should reflect the core functionality or purpose | |
| 6. Must be unique and memorable | |
| 7. Should be easy to pronounce | |
| 8. Avoid acronyms unless they're very intuitive | |
| Please respond ONLY with the project name, without any explanation or additional text. | |
| Example inputs and outputs: | |
| Description: "A task management system with real-time collaboration features" | |
| Output: taskFlow | |
| Description: "An AI-powered document analysis and extraction system" | |
| Output: docMind | |
| Description: "A microservice-based e-commerce platform with advanced inventory management" | |
| Output: tradeCore`; | |
| } |
| export function buildProjectSequenceByProject( | ||
| input: CreateProjectInput, | ||
| ): BuildSequence { | ||
| const sequence: BuildSequence = { | ||
| id: uuidv4(), | ||
| version: '1.0.0', | ||
| name: input.projectName, | ||
| description: input.description, | ||
| databaseType: input.databaseType, | ||
| packages: input.packages, | ||
| nodes: [ | ||
| { | ||
| handler: ProjectInitHandler, | ||
| name: 'Project Folders Setup', | ||
| }, | ||
| { | ||
| handler: PRDHandler, | ||
| name: 'Project Requirements Document Node', | ||
| }, | ||
| { | ||
| handler: UXSMDHandler, | ||
| name: 'UX Sitemap Document Node', | ||
| }, | ||
| { | ||
| handler: UXSMSHandler, | ||
| name: 'UX Sitemap Structure Node', | ||
| }, | ||
| { | ||
| handler: UXDMDHandler, | ||
| name: 'UX DataMap Document Node', | ||
| }, | ||
| { | ||
| handler: DBRequirementHandler, | ||
| name: 'Database Requirements Node', | ||
| }, | ||
| { | ||
| handler: FileStructureHandler, | ||
| name: 'File Structure Generation', | ||
| options: { | ||
| projectPart: 'frontend', | ||
| }, | ||
| }, | ||
| { | ||
| handler: UXSMSPageByPageHandler, | ||
| name: 'Level 2 UX Sitemap Structure Node details', | ||
| }, | ||
| { | ||
| handler: DBSchemaHandler, | ||
| name: 'Database Schemas Node', | ||
| }, | ||
| { | ||
| handler: FileFAHandler, | ||
| name: 'File Arch', | ||
| }, | ||
| { | ||
| handler: BackendRequirementHandler, | ||
| name: 'Backend Requirements Node', | ||
| }, | ||
| { | ||
| handler: BackendCodeHandler, | ||
| name: 'Backend Code Generator Node', | ||
| }, | ||
| { | ||
| handler: BackendFileReviewHandler, | ||
| name: 'Backend File Review Node', | ||
| }, | ||
| { | ||
| handler: FrontendCodeHandler, | ||
| name: 'Frontend Code Generator Node', | ||
| }, | ||
| ], | ||
| }; | ||
| return sequence; | ||
| } |
There was a problem hiding this comment.
🛠️ Refactor suggestion
Add error handling and improve documentation.
The function needs error handling and documentation for better maintainability.
- Add JSDoc documentation explaining the purpose, parameters, and return value.
- Add error handling for invalid input.
- Make the version configurable instead of hardcoding.
Apply this diff:
+/**
+ * Builds a sequence of build steps for a project.
+ * @param input - The project creation input containing project details and packages
+ * @returns A build sequence containing ordered handlers for project setup
+ * @throws {Error} If required input fields are missing or invalid
+ */
export function buildProjectSequenceByProject(
input: CreateProjectInput,
): BuildSequence {
+ if (!input.description || !input.packages) {
+ throw new Error('Missing required input fields');
+ }
+
const sequence: BuildSequence = {
id: uuidv4(),
- version: '1.0.0',
+ version: process.env.BUILD_SEQUENCE_VERSION || '1.0.0',
name: input.projectName,📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| export function buildProjectSequenceByProject( | |
| input: CreateProjectInput, | |
| ): BuildSequence { | |
| const sequence: BuildSequence = { | |
| id: uuidv4(), | |
| version: '1.0.0', | |
| name: input.projectName, | |
| description: input.description, | |
| databaseType: input.databaseType, | |
| packages: input.packages, | |
| nodes: [ | |
| { | |
| handler: ProjectInitHandler, | |
| name: 'Project Folders Setup', | |
| }, | |
| { | |
| handler: PRDHandler, | |
| name: 'Project Requirements Document Node', | |
| }, | |
| { | |
| handler: UXSMDHandler, | |
| name: 'UX Sitemap Document Node', | |
| }, | |
| { | |
| handler: UXSMSHandler, | |
| name: 'UX Sitemap Structure Node', | |
| }, | |
| { | |
| handler: UXDMDHandler, | |
| name: 'UX DataMap Document Node', | |
| }, | |
| { | |
| handler: DBRequirementHandler, | |
| name: 'Database Requirements Node', | |
| }, | |
| { | |
| handler: FileStructureHandler, | |
| name: 'File Structure Generation', | |
| options: { | |
| projectPart: 'frontend', | |
| }, | |
| }, | |
| { | |
| handler: UXSMSPageByPageHandler, | |
| name: 'Level 2 UX Sitemap Structure Node details', | |
| }, | |
| { | |
| handler: DBSchemaHandler, | |
| name: 'Database Schemas Node', | |
| }, | |
| { | |
| handler: FileFAHandler, | |
| name: 'File Arch', | |
| }, | |
| { | |
| handler: BackendRequirementHandler, | |
| name: 'Backend Requirements Node', | |
| }, | |
| { | |
| handler: BackendCodeHandler, | |
| name: 'Backend Code Generator Node', | |
| }, | |
| { | |
| handler: BackendFileReviewHandler, | |
| name: 'Backend File Review Node', | |
| }, | |
| { | |
| handler: FrontendCodeHandler, | |
| name: 'Frontend Code Generator Node', | |
| }, | |
| ], | |
| }; | |
| return sequence; | |
| } | |
| /** | |
| * Builds a sequence of build steps for a project. | |
| * @param input - The project creation input containing project details and packages | |
| * @returns A build sequence containing ordered handlers for project setup | |
| * @throws {Error} If required input fields are missing or invalid | |
| */ | |
| export function buildProjectSequenceByProject( | |
| input: CreateProjectInput, | |
| ): BuildSequence { | |
| if (!input.description || !input.packages) { | |
| throw new Error('Missing required input fields'); | |
| } | |
| const sequence: BuildSequence = { | |
| id: uuidv4(), | |
| version: process.env.BUILD_SEQUENCE_VERSION || '1.0.0', | |
| name: input.projectName, | |
| description: input.description, | |
| databaseType: input.databaseType, | |
| packages: input.packages, | |
| nodes: [ | |
| { | |
| handler: ProjectInitHandler, | |
| name: 'Project Folders Setup', | |
| }, | |
| { | |
| handler: PRDHandler, | |
| name: 'Project Requirements Document Node', | |
| }, | |
| { | |
| handler: UXSMDHandler, | |
| name: 'UX Sitemap Document Node', | |
| }, | |
| { | |
| handler: UXSMSHandler, | |
| name: 'UX Sitemap Structure Node', | |
| }, | |
| { | |
| handler: UXDMDHandler, | |
| name: 'UX DataMap Document Node', | |
| }, | |
| { | |
| handler: DBRequirementHandler, | |
| name: 'Database Requirements Node', | |
| }, | |
| { | |
| handler: FileStructureHandler, | |
| name: 'File Structure Generation', | |
| options: { | |
| projectPart: 'frontend', | |
| }, | |
| }, | |
| { | |
| handler: UXSMSPageByPageHandler, | |
| name: 'Level 2 UX Sitemap Structure Node details', | |
| }, | |
| { | |
| handler: DBSchemaHandler, | |
| name: 'Database Schemas Node', | |
| }, | |
| { | |
| handler: FileFAHandler, | |
| name: 'File Arch', | |
| }, | |
| { | |
| handler: BackendRequirementHandler, | |
| name: 'Backend Requirements Node', | |
| }, | |
| { | |
| handler: BackendCodeHandler, | |
| name: 'Backend Code Generator Node', | |
| }, | |
| { | |
| handler: BackendFileReviewHandler, | |
| name: 'Backend File Review Node', | |
| }, | |
| { | |
| handler: FrontendCodeHandler, | |
| name: 'Frontend Code Generator Node', | |
| }, | |
| ], | |
| }; | |
| return sequence; | |
| } |
Summary by CodeRabbit
New Features
Refactor