codeant-ai-for-open-source[bot] commented on code in PR #42009: URL: https://github.com/apache/superset/pull/42009#discussion_r3584300806
########## superset-frontend/packages/superset-ui-core/src/utils/handleKeyboardActivation.test.ts: ########## @@ -0,0 +1,61 @@ +/** + * 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. + */ +import { KeyboardEvent } from 'react'; +import { handleKeyboardActivation } from './handleKeyboardActivation'; + +const makeEvent = (key: string, repeat = false) => { + const preventDefault = jest.fn(); + return { + event: { key, repeat, preventDefault } as unknown as KeyboardEvent, + preventDefault, + }; +}; + +test('invokes the callback and prevents default on Enter', () => { + const callback = jest.fn(); + const { event, preventDefault } = makeEvent('Enter'); + handleKeyboardActivation(callback)(event); + expect(callback).toHaveBeenCalledWith(event); + expect(preventDefault).toHaveBeenCalled(); +}); + +test('invokes the callback and prevents default on Space', () => { + const callback = jest.fn(); + const { event, preventDefault } = makeEvent(' '); + handleKeyboardActivation(callback)(event); + expect(callback).toHaveBeenCalledWith(event); + expect(preventDefault).toHaveBeenCalled(); +}); + +test('ignores other keys', () => { + const callback = jest.fn(); + const { event, preventDefault } = makeEvent('a'); + handleKeyboardActivation(callback)(event); + expect(callback).not.toHaveBeenCalled(); + expect(preventDefault).not.toHaveBeenCalled(); +}); + +test('ignores auto-repeat keydown events fired while a key is held', () => { + const callback = jest.fn(); + const { event, preventDefault } = makeEvent('Enter', true); + handleKeyboardActivation(callback)(event); + expect(callback).not.toHaveBeenCalled(); + // Still prevents default so the page doesn't scroll while Space is held. + expect(preventDefault).toHaveBeenCalled(); Review Comment: **Suggestion:** The inline comment says the assertion is about holding Space, but this test uses Enter (`makeEvent('Enter', true)`), which is misleading and can cause future maintenance mistakes; update the comment to match the actual key under test or change the test input to Space. [comment mismatch] <details> <summary><b>Severity Level:</b> Minor ๐งน</summary> ```mdx โ ๏ธ Test comment misleads about key under repeat scenario. โ ๏ธ Future changes may misinterpret Enter vs Space behavior. ``` </details> <details> <summary><b>Steps of Reproduction โ </b></summary> ```mdx 1. Open `superset-frontend/packages/superset-ui-core/src/utils/handleKeyboardActivation.test.ts` and locate the test `ignores auto-repeat keydown events fired while a key is held` at lines 54-60; it constructs the event via `makeEvent('Enter', true)` at lines 55-56, so the key under test is Enter with `repeat = true`. 2. In the same test, inspect the inline comment at line 59: `// Still prevents default so the page doesn't scroll while Space is held.` โ this explicitly states the scenario as Space being held, even though the test uses Enter. 3. Compare with the implementation in `superset-frontend/packages/superset-ui-core/src/utils/handleKeyboardActivation.ts` lines 30-45: the handler prevents default for both Enter (`event.key === 'Enter'`) and Space (`event.key === ' '`) and then early-returns when `event.repeat` is true, so the repeat-path applies equally to both keys. 4. Because the test body currently exercises the Enter repeat-path while its comment describes Space, maintainers reading the test may misinterpret which key path is being validated, making the test intent inaccurate even though runtime behavior is correct; updating either the comment or the key argument would align the documentation with the exercised code. ``` </details> [](https://app.codeant.ai/fix-in-ide?tool=cursor&prompt_id=96b812d36d7348d4abb0ee530899b966&service=github&base_url=https%3A%2F%2Fgithub.com&org=apache&repo=apache%2Fsuperset) [](https://app.codeant.ai/fix-in-ide?tool=vscode-claude&prompt_id=96b812d36d7348d4abb0ee530899b966&service=github&base_url=https%3A%2F%2Fgithub.com&org=apache&repo=apache%2Fsuperset) *(Use Cmd/Ctrl + Click for best experience)* <details> <summary><b>Prompt for AI Agent ๐ค </b></summary> ```mdx This is a comment left during a code review. **Path:** superset-frontend/packages/superset-ui-core/src/utils/handleKeyboardActivation.test.ts **Line:** 59:60 **Comment:** *Comment Mismatch: The inline comment says the assertion is about holding Space, but this test uses Enter (`makeEvent('Enter', true)`), which is misleading and can cause future maintenance mistakes; update the comment to match the actual key under test or change the test input to Space. 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. Once fix is implemented, also check other comments on the same PR, and ask user if the user wants to fix the rest of the comments as well. if said yes, then fetch all the comments validate the correctness and implement a minimal fix ``` </details> <a href='https://app.codeant.ai/feedback?pr_url=https%3A%2F%2Fgithub.com%2Fapache%2Fsuperset%2Fpull%2F42009&comment_hash=9e39c47eb515694a4c870db0e544df5cde439432f0929320c20ddd87707f884b&reaction=like'>๐</a> | <a href='https://app.codeant.ai/feedback?pr_url=https%3A%2F%2Fgithub.com%2Fapache%2Fsuperset%2Fpull%2F42009&comment_hash=9e39c47eb515694a4c870db0e544df5cde439432f0929320c20ddd87707f884b&reaction=dislike'>๐</a> -- 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]
