mistercrunch commented on a change in pull request #5524: A tagging system for
dashboards, charts and queries
URL:
https://github.com/apache/incubator-superset/pull/5524#discussion_r207061699
##########
File path: superset/models/tags.py
##########
@@ -0,0 +1,233 @@
+# -*- coding: utf-8 -*-
+# pylint: disable=no-init
+from __future__ import absolute_import
+from __future__ import division
+from __future__ import print_function
+from __future__ import unicode_literals
+
+import enum
+
+from flask_appbuilder import Model
+from sqlalchemy import Column, Enum, ForeignKey, Integer, String
+from sqlalchemy.orm import relationship, sessionmaker
+from sqlalchemy.orm.exc import NoResultFound
+
+from superset.models.helpers import AuditMixinNullable
+
+
+Session = sessionmaker(autoflush=False)
+
+
+class TagTypes(enum.Enum):
+
+ """
+ Types for tags.
+
+ Objects (queries, charts and dashboards) will have with implicit tags based
+ on metadata: types, owners and who favorited them. This way, user "alice"
+ can find all their objects by querying for the tag `owner:alice`.
+ """
+
+ # explicit tags, added manually by the owner
+ custom = 1
+
+ # implicit tags, generated automatically
+ type = 2
+ owner = 3
+ favorited_by = 4
+
+
+class ObjectTypes(enum.Enum):
+
+ """Object types."""
+
+ query = 1
+ chart = 2
+ dashboard = 3
+
+
+class Tag(Model, AuditMixinNullable):
+
+ """A tag attached to an object (query, chart or dashboard)."""
+
+ __tablename__ = 'tag'
+ id = Column(Integer, primary_key=True) # pylint: disable=invalid-name
+ name = Column(String(250), unique=True)
+ type = Column(Enum(TagTypes))
+
+
+class TaggedObject(Model, AuditMixinNullable):
+
+ """An association between an object and a tag."""
+
+ __tablename__ = 'tagged_object'
+ id = Column(Integer, primary_key=True) # pylint: disable=invalid-name
+ tag_id = Column(Integer, ForeignKey('tag.id'))
+ object_id = Column(Integer)
+ object_type = Column(Enum(ObjectTypes))
+
+ tag = relationship('Tag')
+
+
+def get_tag(name, session, type_):
+ try:
+ tag = session.query(Tag).filter_by(name=name, type=type_).one()
+ except NoResultFound:
+ tag = Tag(name=name, type=type_)
+ session.add(tag)
+ session.commit()
+
+ return tag
+
+
+def get_object_type(class_name):
+ mapping = {
+ 'slice': ObjectTypes.chart,
+ 'dashboard': ObjectTypes.dashboard,
+ 'query': ObjectTypes.query,
+ }
+ try:
+ return mapping[class_name.lower()]
+ except KeyError:
+ raise Exception('No mapping found for {0}'.format(class_name))
+
+
+class ObjectUpdater(object):
+
+ object_type = None
+
+ @classmethod
+ def get_owners_ids(cls, target):
+ raise NotImplementedError('Subclass should implement `get_owners_ids`')
+
+ @classmethod
+ def after_insert(cls, mapper, connection, target):
+ # pylint: disable=unused-argument
+ session = Session(bind=connection)
+
+ # add `owner:` tags
+ for owner_id in cls.get_owners_ids(target):
+ name = 'owner:{0}'.format(owner_id)
+ tag = get_tag(name, session, TagTypes.owner)
+ tagged_object = TaggedObject(
+ tag_id=tag.id,
+ object_id=target.id,
+ object_type=ObjectTypes.chart,
+ )
+ session.add(tagged_object)
+
+ # add `type:` tags
+ tag = get_tag(
+ 'type:{0}'.format(cls.object_type), session, TagTypes.type)
+ tagged_object = TaggedObject(
+ tag_id=tag.id,
+ object_id=target.id,
+ object_type=ObjectTypes.query,
+ )
+ session.add(tagged_object)
+
+ session.commit()
+
+ @classmethod
+ def after_update(cls, mapper, connection, target):
+ # pylint: disable=unused-argument
+ session = Session(bind=connection)
+
+ # delete current `owner:` tags
+ query = session.query(TaggedObject.id).join(Tag).filter(
+ TaggedObject.object_type == cls.object_type,
+ TaggedObject.object_id == target.id,
+ Tag.type == TagTypes.owner,
+ )
+ ids = [row[0] for row in query]
+ session.query(TaggedObject).filter(
+ TaggedObject.id.in_(ids)).delete(
+ synchronize_session=False)
+
+ # add `owner:` tags
+ for owner_id in cls.get_owners_ids(target):
+ name = 'owner:{0}'.format(owner_id)
+ tag = get_tag(name, session, TagTypes.owner)
+ tagged_object = TaggedObject(
+ tag_id=tag.id,
+ object_id=target.id,
+ object_type=ObjectTypes.chart,
+ )
+ session.add(tagged_object)
+
+ session.commit()
+
+ @classmethod
+ def after_delete(cls, mapper, connection, target):
+ # pylint: disable=unused-argument
+ session = Session(bind=connection)
+
+ # delete row from `tagged_objects`
+ session.query(TaggedObject).filter(
+ TaggedObject.object_type == cls.object_type,
+ TaggedObject.object_id == target.id,
+ ).delete()
+
+ session.commit()
+
+
+class ChartUpdater(ObjectUpdater):
+
+ object_type = 'chart'
+
+ @classmethod
+ def get_owners_ids(cls, target):
+ return [owner.id for owner in target.owners]
+
+
+class DashboardUpdater(ObjectUpdater):
+
+ object_type = 'dashboard'
+
+ @classmethod
+ def get_owners_ids(cls, target):
+ return [owner.id for owner in target.owners]
+
+
+class QueryUpdater(ObjectUpdater):
+
+ object_type = 'query'
+
+ @classmethod
+ def get_owners_ids(cls, target):
+ return [target.user_id]
+
+
+class FavStarUpdater(object):
+
+ @classmethod
+ def after_insert(cls, mapper, connection, target):
+ # pylint: disable=unused-argument
+ session = Session(bind=connection)
+ name = 'favorited_by:{0}'.format(target.user_id)
+ tag = get_tag(name, session, TagTypes.favorited_by)
+ tagged_object = TaggedObject(
+ tag_id=tag.id,
+ object_id=target.obj_id,
+ object_type=get_object_type(target.class_name),
+ )
+ session.add(tagged_object)
+
+ session.commit()
+
+ @classmethod
+ def after_delete(cls, mapper, connection, target):
+ # pylint: disable=unused-argument
+ session = Session(bind=connection)
+ name = 'favorited_by:{0}'.format(target.user_id)
+ query = session.query(TaggedObject.id).join(Tag).filter(
+ TaggedObject.object_id == target.obj_id,
+ Tag.type == TagTypes.favorited_by,
+ Tag.name == name,
+ )
Review comment:
I think you could just `query.delete()` at the next line here (as long as
you change `session.query(TaggedObject.id)` -> `session.query(TaggedObject)`),
no need for another query I think.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
[email protected]
With regards,
Apache Git Services
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
