bito-code-review[bot] commented on code in PR #37680: URL: https://github.com/apache/superset/pull/37680#discussion_r2766915065
########## superset/models/onboarding_workflow.py: ########## @@ -0,0 +1,41 @@ +# 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. + +from flask_appbuilder import Model +from sqlalchemy import Column, Integer, String + +from superset.models.helpers import AuditMixinNullable + + +class OnboardingWorkflow(Model, AuditMixinNullable): + """ + Represents a high-level onboarding workflow definition. + + An onboarding workflow defines a guided user experience (e.g. creating a + dashboard or chart) that can be presented to users as part of Superset’s + onboarding system. This model stores the static metadata for each workflow + and is intended to be reusable across all users. + + User-specific progress and visitation state (e.g. whether a workflow has + been completed or how many times it has been viewed) is tracked separately + and should not be stored on this model. + """ + + __tablename__ = "onboarding_workflow" + id = Column(Integer, primary_key=True) Review Comment: <div> <div id="suggestion"> <div id="issue"><b>Use UUID primary key for new models</b></div> <div id="fix"> New models in this codebase should use UUID primary keys instead of auto-incrementing integers, as outlined in the development standards. This change requires updating the foreign key reference in `user_onboarding_workflow.py` to maintain data integrity. </div> </div> <details> <summary><b>Citations</b></summary> <ul> <li> Rule Violated: <a href="https://github.com/apache/superset/blob/a247185/.cursor/rules/dev-standard.mdc#L50";>dev-standard.mdc:50</a> </li> </ul> </details> <small><i>Code Review Run #6e17fe</i></small> </div> --- Should Bito avoid suggestions like this for future reviews? (<a href=https://alpha.bito.ai/home/ai-agents/review-rules>Manage Rules</a>) - [ ] Yes, avoid them -- 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]
