codeant-ai-for-open-source[bot] commented on code in PR #37404: URL: https://github.com/apache/superset/pull/37404#discussion_r2722489089
########## docs/plugins/robots-txt-plugin.js: ########## @@ -0,0 +1,81 @@ +/** + * 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. + */ + +const fs = require('fs'); +const path = require('path'); + +/** + * Docusaurus plugin to generate robots.txt during build + * Configuration is passed via plugin options + */ +module.exports = function robotsTxtPlugin(context, options) { Review Comment: **Suggestion:** The destructuring of `options` assumes it is always defined; if the plugin is ever configured without options, this will throw a TypeError at load time, preventing the Docusaurus build from running. Adding a default empty object for `options` makes the plugin robust when no options are passed. [type error] <details> <summary><b>Severity Level:</b> Critical 🚨</summary> ```mdx - ❌ Builds fail when plugin added without options. - ⚠️ CI jobs running docs build may break. - ⚠️ Developer DX: local `yarn build` crashes. ``` </details> ```suggestion module.exports = function robotsTxtPlugin(context, options = {}) { ``` <details> <summary><b>Steps of Reproduction ✅ </b></summary> ```mdx 1. Build the docs site with this plugin configured in docusaurus.config.js but without passing an options object (e.g., plugin entry `['./docs/plugins/robots-txt-plugin.js']`). The plugin file is at docs/plugins/robots-txt-plugin.js line 27 where the function signature is declared. 2. Docusaurus loads plugins during startup and will call the exported function at docs/plugins/robots-txt-plugin.js:27. Because the code immediately destructures properties from the `options` parameter (lines 29-32 in the file), if `options` is undefined this will throw a TypeError while loading plugins. 3. The TypeError occurs before build hooks run, causing `yarn build` to fail early. You will see an error in the build logs referencing the plugin file and the destructuring. 4. Confirm by adding a minimal docusaurus.config.js with the plugin entry omitted of options and running `yarn build` — build fails with TypeError at docs/plugins/robots-txt-plugin.js:27-32. The proposed change (defaulting options to {}) prevents this by ensuring destructuring always has an object. ``` </details> <details> <summary><b>Prompt for AI Agent 🤖 </b></summary> ```mdx This is a comment left during a code review. **Path:** docs/plugins/robots-txt-plugin.js **Line:** 27:27 **Comment:** *Type Error: The destructuring of `options` assumes it is always defined; if the plugin is ever configured without options, this will throw a TypeError at load time, preventing the Docusaurus build from running. Adding a default empty object for `options` makes the plugin robust when no options are passed. 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]
