codeant-ai-for-open-source[bot] commented on code in PR #37368: URL: https://github.com/apache/superset/pull/37368#discussion_r2721218681
########## superset/db_engine_specs/mongodb.py: ########## @@ -0,0 +1,123 @@ +# 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. +"""MongoDB engine spec for Superset. + +Uses PyMongoSQL (https://github.com/passren/PyMongoSQL) as the SQLAlchemy dialect +to enable SQL queries on MongoDB collections. +""" + +from __future__ import annotations + +from datetime import datetime +from typing import Any, Optional + +from sqlalchemy import types + +from superset.constants import TimeGrain +from superset.db_engine_specs.base import BaseEngineSpec, DatabaseCategory + + +class MongoDBEngineSpec(BaseEngineSpec): + """Engine spec for MongoDB using PyMongoSQL dialect.""" + + engine = "mongodb" + engine_name = "MongoDB" + force_column_alias_quotes = False + + metadata = { + "description": ("MongoDB is a document-oriented, operational NoSQL database."), + "logo": "mongodb.png", + "homepage_url": "https://www.mongodb.com/";, + "categories": [ + DatabaseCategory.SEARCH_NOSQL, + DatabaseCategory.PROPRIETARY, + ], + "pypi_packages": ["pymongosql"], + "connection_string": ( + "mongodb://{username}:{password}@{host}:{port}/{database}?mode=superset" + ), + "parameters": { + "username": "Username for MongoDB", + "password": "Password for MongoDB", + "host": "MongoDB host", + "port": "MongoDB port", + "database": "Database name", + }, + "drivers": [ + { + "name": "MongoDB Atlas Cloud", + "pypi_package": "pymongosql", + "connection_string": "mongodb+srv://{username}:{password}@{host}/{database}?mode=superset", + "notes": "For MongoDB Atlas cloud service.", + "is_recommended": True, + }, + { + "name": "MongoDB Cluster", + "pypi_package": "pymongosql", + "connection_string": "mongodb://{username}:{password}@{host}:{port}/{database}?mode=superset", + "is_recommended": False, + "notes": ("For self-hosted MongoDB instances."), + }, + ], + "notes": "Uses PartiQL for SQL queries. Requires mode=superset parameter.", + "docs_url": "https://github.com/passren/PyMongoSQL";, + } + + _time_grain_expressions = { + None: "{col}", + TimeGrain.SECOND: "DATETIME(STRFTIME('%Y-%m-%dT%H:%M:%S', {col}))", + TimeGrain.MINUTE: "DATETIME(STRFTIME('%Y-%m-%dT%H:%M:00', {col}))", + TimeGrain.HOUR: "DATETIME(STRFTIME('%Y-%m-%dT%H:00:00', {col}))", + TimeGrain.DAY: "DATETIME({col}, 'start of day')", + TimeGrain.WEEK: ( + "DATETIME({col}, 'start of day', -strftime('%w', {col}) || ' days')" + ), + TimeGrain.MONTH: "DATETIME({col}, 'start of month')", + TimeGrain.QUARTER: ( + "DATETIME({col}, 'start of month', " + "printf('-%d month', (strftime('%m', {col}) - 1) % 3))" + ), + TimeGrain.YEAR: "DATETIME({col}, 'start of year')", + TimeGrain.WEEK_ENDING_SATURDAY: "DATETIME({col}, 'start of day', 'weekday 6')", + TimeGrain.WEEK_ENDING_SUNDAY: "DATETIME({col}, 'start of day', 'weekday 0')", + TimeGrain.WEEK_STARTING_SUNDAY: ( + "DATETIME({col}, 'start of day', 'weekday 0', '-7 days')" + ), + TimeGrain.WEEK_STARTING_MONDAY: ( + "DATETIME({col}, 'start of day', 'weekday 1', '-7 days')" + ), + } + + @classmethod + def epoch_to_dttm(cls) -> str: + return "datetime({col}, 'unixepoch')" + + @classmethod + def convert_dttm( + cls, + target_type: str, + dttm: datetime, + db_extra: Optional[dict[str, Any]] = None, + ) -> Optional[str]: + """Convert Python datetime to MongoDB/SQL datetime string.""" + sqla_type = cls.get_sqla_column_type(target_type) + + if isinstance(sqla_type, (types.String, types.DateTime)): + # Return ISO format datetime string for MongoDB compatibility + return f"""'{dttm.isoformat(sep=" ", timespec="seconds")}'""" Review Comment: **Suggestion:** convert_dttm only handles `String` and `DateTime` SQLAlchemy types; DATE and TIMESTAMP columns will not be converted and the function will return None, potentially breaking queries against DATE/TIMESTAMP columns—include `types.Date` and `types.TIMESTAMP` in the type check so common date column types are handled. [possible bug] <details> <summary><b>Severity Level:</b> Critical 🚨</summary> ```mdx - ❌ Temporal filters fail for DATE/TIMESTAMP columns. - ❌ Query generation omits datetime literals. - ⚠️ Unit tests for datetime conversion may fail. ``` </details> ```suggestion if isinstance(sqla_type, (types.String, types.DateTime, types.Date, types.TIMESTAMP)): # Return ISO format datetime string for MongoDB compatibility return f'''{dttm.isoformat(sep=" ", timespec="seconds")!r}''' ``` <details> <summary><b>Steps of Reproduction ✅ </b></summary> ```mdx 1. Open convert_dttm in superset/db_engine_specs/mongodb.py (method defined around lines 109-123). It calls cls.get_sqla_column_type(target_type) (see BaseEngineSpec.get_sqla_column_type in superset/db_engine_specs/base.py lines 2252-2271). 2. Ensure a table has a native column type that maps to SQLAlchemy's types.Date or types.TIMESTAMP (this mapping is produced by get_column_spec/get_sqla_column_type in BaseEngineSpec). 3. Call code-paths that render datetime literals for filters/time predicates (Superset builds SQL using EngineSpec.convert_dttm when substituting datetime values into queries). Because convert_dttm currently only matches types.String and types.DateTime, a sqla_type of types.Date or types.TIMESTAMP will not match and the function will return None. 4. Observe behavior: the query builder receives None instead of a datetime literal, causing either a malformed SQL fragment or a fallback code path that may produce incorrect queries. Running unit tests for datetime conversion (tests/unit_tests/db_engine_specs/test_mongodb.py from the PR) will expose missing handling for DATE/TIMESTAMP types. ``` </details> <details> <summary><b>Prompt for AI Agent 🤖 </b></summary> ```mdx This is a comment left during a code review. **Path:** superset/db_engine_specs/mongodb.py **Line:** 119:121 **Comment:** *Possible Bug: convert_dttm only handles `String` and `DateTime` SQLAlchemy types; DATE and TIMESTAMP columns will not be converted and the function will return None, potentially breaking queries against DATE/TIMESTAMP columns—include `types.Date` and `types.TIMESTAMP` in the type check so common date column types are handled. 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]
