-
Notifications
You must be signed in to change notification settings - Fork 0
wip #1
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
wip #1
Conversation
Summary of ChangesHello @klajmajk, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed! This pull request primarily focuses on enhancing the process definition deployment API and refining the local development environment. It updates the OpenAPI specification to correctly handle binary BPMN file uploads via Highlights
🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console. Using Gemini Code AssistThe full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips. Invoking Gemini You can request assistance from Gemini at any point by creating a comment using either
Customization To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a Limitations & Feedback Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here. You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension. Footnotes
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Code Review
This pull request updates the process definition deployment to use multipart/form-data, which is appropriate for file uploads. It also includes a beneficial refactoring of the OpenAPI specification and a fix for the Vite development server proxy. My review focuses on improving the efficiency of an API call, ensuring consistency with the API specification, and cleaning up configuration files.
| export const createProcessDefinition = async (xml: string): Promise<ProcessDefinitionDetail> => { | ||
| const response = await AXIOS_INSTANCE.post<ProcessDefinitionDetail>('/process-definitions', xml, { | ||
| headers: { 'Content-Type': 'application/xml' }, | ||
| }); | ||
| return response.data; | ||
| // Convert XML string to Blob | ||
| const blob = new Blob([xml], { type: 'application/xml' }); | ||
|
|
||
| // Create request body for the generated client | ||
| const requestBody: CreateProcessDefinitionBody = { | ||
| resource: blob | ||
| }; | ||
|
|
||
| // Call the generated client | ||
| const response = await createProcessDefinitionApi(requestBody); | ||
| const processDefinitionKey = response.processDefinitionKey; | ||
|
|
||
| const detailResponse = await getProcessDefinition(processDefinitionKey); | ||
| return detailResponse; | ||
| }; |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This implementation makes two separate API calls: one to create the process definition and another to fetch its details. This is inefficient. To improve performance, consider modifying the backend POST /process-definitions endpoint to return the complete ProcessDefinitionDetail object upon successful creation. This would eliminate the need for the second getProcessDefinition call.
| }); | ||
| return response.data; | ||
| // Convert XML string to Blob | ||
| const blob = new Blob([xml], { type: 'application/xml' }); |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The Blob is created with type: 'application/xml', but the OpenAPI specification for this endpoint (openapi/api.yaml line 497) specifies contentType: application/octet-stream for the resource part. While BPMN files are XML-based, it's best to align with the API contract to prevent potential issues.
| const blob = new Blob([xml], { type: 'application/xml' }); | |
| const blob = new Blob([xml], { type: 'application/octet-stream' }); |
| target: 'http://localhost:8080', | ||
| changeOrigin: true, | ||
| rewrite: (path) => path.replace(/^\/api/, '/v1'), | ||
| // rewrite: (path) => path.replace(/^\/api/, '/v1'), |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@marcel-ouska2