Skip to content
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.

Sign up for GitHub

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

Doc reviewed by Localization #1551

Closed
wants to merge 2 commits into from
Closed

Doc reviewed by Localization #1551

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b6df037
New translations issues-during-extending-the-faststore-api-schema.md …
GeorgeLimaDev Nov 13, 2024
85891f4
Reviewed by Localization.
kaio-donadelli Nov 13, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 12 additions & 12 deletions docs/localization/issues-during-extending-the-faststore-api-schema.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,17 +1,17 @@
---
title: 'Issues during extending the FastStore API schema'
slug: "issues-during-extending-the-faststore-api-schema"
excerpt: "Updating EANs in VTEX can lead to catalog sync issues affecting inventory."
excerpt: "Updating EANs on VTEX can lead to catalog sync issues affecting inventory."
tags:
- faststore
- api
---

**Keywords:** FastStore | API extension

Although the FastStore API provides a GraphQL schema for ecommerce, you can extend the FastStore API schema to access other or more specific information from your store. During this implementation, you encounter issues such as not having the GraphQL changes you performed aren’t visible during development or in the store production.
Although the FastStore API provides a GraphQL schema for ecommerce, you can extend it to access other or more specific information from your store. You may encounter some common issues during the implementation like your GraphQL changes not being visible in the development environment or in the production store.

Below are different troubleshooting checks and instructions you can use to solve API extension issues:
Below are some troubleshooting checks and instructions to solve API extension issues:

- [GraphQL changes not visible during development](#graphql-changes-not-visible-during-development)
- [Deploy preview/production GraphQL schema different from development](#deploy-previewproduction-graphql-schema-different-from-development)
Expand All @@ -21,34 +21,34 @@ Below are different troubleshooting checks and instructions you can use to solve

## GraphQL changes not visible during development

If your GraphQL changes aren't visible during development, the changes you have made since you started the development server (`yarn dev`) are probably not optimized.
If your GraphQL changes aren't visible during development, your changes are probably not optimized since you started development server (`yarn dev`).

To trigger the optimization, run `yarn generate` (recommended) or `yarn run faststore generate-graphql`. Alternatively, you can stop and restart the development server using `yarn dev`.

> ℹ️ This optimization can also be performed while the development server is running.

## Deploy preview/production GraphQL schema different from development

If you notice differences between the GraphQL schema in your deploy preview or production environment and your development setup, it may be because the schema has not been optimized since the development server's initiation. The build process optimizes the schema before deployment to accurately reflect the schema declared in the store's code.
If you notice differences between the GraphQL schema in your deploy preview or production environment and your development setup, the schema may not have been optimized since the development server initiation. The build process optimizes the schema before deployment to accurately reflect the schema declared in the store code.

To fix the issue, refer to the [GraphQL changes not visible during development](#graphql-changes-not-visible-during-development) topic.
To fix this issue, see the section [GraphQL changes not visible during development](#graphql-changes-not-visible-during-development).

## Type generation errors and warnings

Some errors can occur during GraphQL optimizations and type generation. Here's how to troubleshoot them:

| **Error message** | **Possible cause** | **Solution** |
| ----------------- | ------------------ | ------------ |
| `error Failed to run 'yarn generate:schema'. Please check your setup.` | Malformed files in your GraphQL Schema Extensions definitions. | Check the graphql files inside the `src/graphql/(vtex or thirdParty)/typeDefs` folders for syntax or definition errors. |
| `error GraphQL was not optimized and TS files were not updated. Changes in the GraphQL layer did not take effect` | Malformed files or GraphQL types within your GraphQL layer, including errors in GraphQL Schema Extensions, declared queries, and fragments. | Check the graphql files inside the `src/graphql/(vtex or thirdParty)/typeDefs` folders and component (`.ts`, `tsx`) files declaring queries and fragments in your project for syntax or definition errors. |
| `warn: Failed to format generated files. 'yarn format:generated' thrown errors` | An issue occurred during the formatting process for the generated GraphQL optimization and types files. | This is a warning, not an error. Your GraphQL layer will still function correctly. If you want to investigate and resolve the formatting issue, follow these steps: <ol><li>1. Retry formatting: Run the `yarn format:generated` command again.</li> <li>2. Check formatting configuration: Ensure the formatting rules are correct and compatible with the generated files.</li><li>3. Inspect error logs: Look for specific error messages that might provide more clues about the issue.</li></ol> |
| `error Failed to run 'yarn generate:schema'. Please check your setup.` | Malformed files in your GraphQL schema extensions definitions. | Check the GraphQL files in the `src/graphql/(vtex or thirdParty)/typeDefs` folders for syntax or definition errors. |
| `error GraphQL was not optimized, and TS files were not updated. Changes in the GraphQL layer did not take effect` | Malformed files or GraphQL types within your GraphQL layer, including errors in GraphQL schema extensions, declared queries, and fragments. | Check the GraphQL files in the `src/graphql/(vtex or thirdParty)/typeDefs` folders and component (`.ts`, `tsx`) files declaring queries and fragments in your project for syntax or definition errors. |
| `warn: Failed to format generated files. 'yarn format:generated' thrown errors` | An issue occurred during the formatting process for the generated GraphQL optimization and type files. | This is a warning, not an error. Your GraphQL layer will still work correctly. To investigate and solve the formatting issue, follow these steps: <ol><li>1. Retry formatting: Run the `yarn format:generated` command again.</li> <li>2. Check formatting configuration: Make sure the formatting rules are correct and compatible with the generated files.</li><li>3. Inspect error logs: Look for specific error messages that might provide more clues about the issue.</li></ol> |
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[markdownlint] reported by reviewdog 🐶
MD033/no-inline-html Inline HTML [Element: li]

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[markdownlint] reported by reviewdog 🐶
MD033/no-inline-html Inline HTML [Element: li]

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[markdownlint] reported by reviewdog 🐶
MD033/no-inline-html Inline HTML [Element: li]

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[markdownlint] reported by reviewdog 🐶
MD033/no-inline-html Inline HTML [Element: ol]


### Error details

To access more detailed error information, use the `--debug` flag when manually running the `yarn generate` command to see detailed errors on why the generation has failed.
To access this information, use the `--debug` flag when manually running the `yarn generate` command to see detailed errors on why the generation has failed.

## GraphQL changes not visible in production/deploy preview

During the build step, the GraphQL optimization and type files are always generated fresh, reflecting the most recent changes in the code.
During the build step, the GraphQL optimization and type files are always generated afresh, reflecting the most recent changes in the code.

If your changes are not visible in production, this means you must not have committed them to the branch you're currently working on. If you see different GraphQL schema, queries, or data during development, refer to the [GraphQL changes not visible during development](#graphql-changes-not-visible-during-development) topic.
If your changes are not visible in production, this means you didn't commit them to the branch you're currently working on. If the GraphQL schema, queries, or data look different during development, refer to the [GraphQL changes not visible during development](#graphql-changes-not-visible-during-development) topic.
Loading