codeant-ai-for-open-source[bot] commented on code in PR #37404: URL: https://github.com/apache/superset/pull/37404#discussion_r2729866254
########## docs/plugins/remark-tech-article-schema.mjs: ########## @@ -0,0 +1,161 @@ +/** + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ + +// Note: visit from unist-util-visit is available if needed for tree traversal + +/** + * Remark plugin that automatically injects TechArticle schema import and component + * into documentation MDX files based on frontmatter. + * + * This enables rich snippets for technical documentation in search results. + * + * Frontmatter options: + * - title: (required) Article headline + * - description: (required) Article description + * - keywords: (optional) Array of keywords + * - seo_proficiency: (optional) 'Beginner' or 'Expert', defaults to 'Beginner' + * - seo_schema: (optional) Set to false to disable schema injection + */ +export default function remarkTechArticleSchema() { + return (tree, file) => { + const frontmatter = file.data.frontMatter || {}; + + // Skip if explicitly disabled or missing required fields + if (frontmatter.seo_schema === false) { + return; + } + + // Only add schema if we have title and description + if (!frontmatter.title || !frontmatter.description) { + return; + } + + const title = frontmatter.title; + const description = frontmatter.description; + const keywords = frontmatter.keywords || []; Review Comment: **Suggestion:** The plugin assumes that the `keywords` frontmatter field is always an array, but if a documentation author provides a single string (e.g. `keywords: superset faq`), calling `.map` on it when building the ESTree will throw `keywords.map is not a function` at build time and break the docs build; normalizing the value to an array before later use avoids this type error. [type error] <details> <summary><b>Severity Level:</b> Critical 🚨</summary> ```mdx - ❌ Site build fails when authors use string keywords. - ⚠️ TechArticle schema injection aborted for affected pages. - ⚠️ Blocks CI that runs `yarn build` for docs changes. ``` </details> ```suggestion const rawKeywords = frontmatter.keywords; const keywords = Array.isArray(rawKeywords) ? rawKeywords : rawKeywords ? [rawKeywords] : []; ``` <details> <summary><b>Steps of Reproduction ✅ </b></summary> ```mdx 1. Add or edit a documentation MDX file to include frontmatter with a single string keywords value, e.g. at docs/faq/getting-started.md frontmatter: `keywords: superset faq`. This is a typical author edit. 2. Run the site build with `yarn build` (Docusaurus build). The remark plugin `remarkTechArticleSchema` in docs/plugins/remark-tech-article-schema.mjs is executed during remark/mdx processing (file: docs/plugins/remark-tech-article-schema.mjs). 3. Inside the plugin (file lines 49-52), the code sets `const keywords = frontmatter.keywords || [];` (line 51). If frontmatter.keywords is a string, `keywords` becomes a string. 4. Later the plugin constructs an ESTree array using `keywords.map(...)` at line 121. If `keywords` is a string this causes `TypeError: keywords.map is not a function` during build, breaking `yarn build` and preventing site output. 5. Reproduced by running `yarn build` after step 1 and observing a build failure stack trace pointing into docs/plugins/remark-tech-article-schema.mjs around lines 119-123. Note: The plugin runs on all docs pages with title+description frontmatter so this is reachable whenever an author uses a string for keywords. ``` </details> <details> <summary><b>Prompt for AI Agent 🤖 </b></summary> ```mdx This is a comment left during a code review. **Path:** docs/plugins/remark-tech-article-schema.mjs **Line:** 51:51 **Comment:** *Type Error: The plugin assumes that the `keywords` frontmatter field is always an array, but if a documentation author provides a single string (e.g. `keywords: superset faq`), calling `.map` on it when building the ESTree will throw `keywords.map is not a function` at build time and break the docs build; normalizing the value to an array before later use avoids this type error. Validate the correctness of the flagged issue. If correct, How can I resolve this? If you propose a fix, implement it and please make it concise. ``` </details> -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected] --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
