feat: codegen the clients #216
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Contributor
Reviewer's Guide by SourceryThis pull request implements code generation for GraphQL clients, refactoring the existing code to support multiple client types and introducing a new client template generation feature. Sequence diagram for gqltadaCodegen client template generationsequenceDiagram
participant Env as DotEnv
participant Codegen as gqltadaCodegen
participant FS as FileSystem
participant Project as ProjectRoot
Env->>Codegen: Provide environment variables
Codegen->>Codegen: Determine gqlEndpoint and templateName
Codegen->>Project: Get project root directory
Project-->>Codegen: Return project directory
Codegen->>FS: Create codegen directory
Codegen->>FS: Check if client template file exists
alt File does not exist
Codegen->>FS: Write client template file
end
File-Level Changes
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
📦 Packages
|
![sourcery-ai[bot]](https://avatars.githubusercontent.com/in/48477?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Hey @roderik - I've reviewed your changes - here's some feedback:
Overall Comments:
- Consider logging errors even when allowToFail is true, to aid in debugging.
Here's what I looked at during the review
- 🟢 General issues: all looks good
- 🟢 Security: all looks good
- 🟡 Review instructions: 3 issues found
- 🟢 Testing: all looks good
- 🟢 Complexity: all looks good
- 🟢 Documentation: all looks good
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
| env, | ||
| }); | ||
| await gqltadaCodegen({ | ||
| type: "THEGRAPH", |
Contributor
There was a problem hiding this comment.
suggestion (review_instructions): Consider using an enum for type values
Using an enum for the type values would improve type safety and make the code more maintainable. It would also prevent typos and ensure consistency across the codebase.
enum CodegenType {
THE_GRAPH = "THE_GRAPH",
// Add other types as needed
}
// ...
await gqltadaCodegen({
type: CodegenType.THE_GRAPH,
env,
allowToFail: true,
Review instructions:
Path patterns: **/*.ts
Instructions:
- You always use the latest version of NodeJS, Bun, React, NestJS and NextJS, and you are familiar with the latest features and best practices.
- Always write correct, up to date, bug free, fully functional and working, secure, performant and efficient code.
- Focus on readability over being performant, but performance is important.
Comment on lines
+181
to
+197
| import { createServer${templateName}Client } from "@settlemint/sdk-hasura"; | ||
| import type { introspection } from "../../${templateName}.d.ts; | ||
| export const { client: ${templateName}Client, graphql: ${templateName}Graphql } = createServer${templateName}Client<{ | ||
| introspection: introspection; | ||
| disableMasking: true; | ||
| scalars: { | ||
| DateTime: Date; | ||
| JSON: Record<string, unknown>; | ||
| }; | ||
| }>({ | ||
| instance: process.env.SETTLEMINT_${options.type}_ENDPOINT!, | ||
| accessToken: process.env.SETTLEMINT_ACCESS_TOKEN!, | ||
| ${options.type === "HASURA" ? "adminSecret: process.env.SETTLEMINT_HASURA_ADMIN_SECRET!," : ""} | ||
| }); | ||
| `; | ||
|
|
Contributor
There was a problem hiding this comment.
suggestion (review_instructions): Consider moving the template string to a separate file
Large template strings can make the code harder to read. Moving this to a separate file (e.g., a .ts or .ejs file) could improve maintainability and separation of concerns.
import { readFileSync } from 'fs';
import { join } from 'path';
const templatePath = join(__dirname, '..', '..', 'templates', 'clientTemplate.ts');
const clientTemplate = readFileSync(templatePath, 'utf-8');
const renderedTemplate = clientTemplate
.replace(/\${templateName}/g, templateName)
.replace(/\${options.type}/g, options.type);
Review instructions:
Path patterns: **/*.ts
Instructions:
- You always use the latest version of NodeJS, Bun, React, NestJS and NextJS, and you are familiar with the latest features and best practices.
- Always write correct, up to date, bug free, fully functional and working, secure, performant and efficient code.
- Focus on readability over being performant, but performance is important.
Comment on lines
+204
to
+205
| writeFileSync(filePath, clientTemplate, "utf8"); | ||
| } |
Contributor
There was a problem hiding this comment.
suggestion (review_instructions): Consider using async file operations
Using synchronous file operations can block the event loop. Consider using the async versions (e.g., fs.promises.writeFile) for better performance, especially in a CLI tool that might be used in various environments.
const { access, writeFile } = require('fs').promises;
try {
await access(filePath);
} catch {
await writeFile(filePath, clientTemplate, "utf8");
}
Review instructions:
Path patterns: **/*.ts
Instructions:
- You always use the latest version of NodeJS, Bun, React, NestJS and NextJS, and you are familiar with the latest features and best practices.
- Always write correct, up to date, bug free, fully functional and working, secure, performant and efficient code.
- Focus on readability over being performant, but performance is important.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary by Sourcery
Implement code generation for GraphQL client files, enhancing the naming convention for GraphQL types and ensuring client files are created for different environments with appropriate configurations.
New Features:
Enhancements: