Module slack_sdk.oauth.state_store.sqlalchemy

Classes

class SQLAlchemyOAuthStateStore (expiration_seconds: int, engine: sqlalchemy.engine.base.Engine, logger: logging.Logger = <Logger slack_sdk.oauth.state_store.sqlalchemy (WARNING)>, table_name: str = 'slack_oauth_states')

Expand source code

class SQLAlchemyOAuthStateStore(OAuthStateStore):
    default_table_name: str = "slack_oauth_states"

    expiration_seconds: int
    engine: Engine
    metadata: MetaData
    oauth_states: Table

    @classmethod
    def build_oauth_states_table(cls, metadata: MetaData, table_name: str) -> Table:
        return sqlalchemy.Table(
            table_name,
            metadata,
            metadata,
            Column("id", Integer, primary_key=True, autoincrement=True),
            Column("state", String(200), nullable=False),
            Column("expire_at", DateTime, nullable=False),
        )

    def __init__(
        self,
        expiration_seconds: int,
        engine: Engine,
        logger: Logger = logging.getLogger(__name__),
        table_name: str = default_table_name,
    ):
        self.expiration_seconds = expiration_seconds
        self._logger = logger
        self.engine = engine
        self.metadata = MetaData()
        self.oauth_states = self.build_oauth_states_table(self.metadata, table_name)

    def create_tables(self):
        self.metadata.create_all(self.engine)

    @property
    def logger(self) -> Logger:
        if self._logger is None:
            self._logger = logging.getLogger(__name__)
        return self._logger

    def issue(self, *args, **kwargs) -> str:
        state: str = str(uuid4())
        now = datetime.utcfromtimestamp(time.time() + self.expiration_seconds)
        with self.engine.begin() as conn:
            conn.execute(
                self.oauth_states.insert(),
                {"state": state, "expire_at": now},
            )
        return state

    def consume(self, state: str) -> bool:
        try:
            with self.engine.begin() as conn:
                c = self.oauth_states.c
                query = self.oauth_states.select().where(and_(c.state == state, c.expire_at > datetime.utcnow()))
                result = conn.execute(query)
                for row in result.mappings():
                    self.logger.debug(f"consume's query result: {row}")
                    conn.execute(self.oauth_states.delete().where(c.id == row["id"]))
                    return True
            return False
        except Exception as e:  # skipcq: PYL-W0703
            message = f"Failed to find any persistent data for state: {state} - {e}"
            self.logger.warning(message)
            return False

Ancestors

• OAuthStateStore

Class variables

var default_table_name : str

var engine : sqlalchemy.engine.base.Engine

var expiration_seconds : int

var metadata : sqlalchemy.sql.schema.MetaData

var oauth_states : sqlalchemy.sql.schema.Table

Static methods

def build_oauth_states_table(metadata: sqlalchemy.sql.schema.MetaData, table_name: str) ‑> sqlalchemy.sql.schema.Table

Expand source code

@classmethod
def build_oauth_states_table(cls, metadata: MetaData, table_name: str) -> Table:
    return sqlalchemy.Table(
        table_name,
        metadata,
        metadata,
        Column("id", Integer, primary_key=True, autoincrement=True),
        Column("state", String(200), nullable=False),
        Column("expire_at", DateTime, nullable=False),
    )

Instance variables

var logger : logging.Logger

Expand source code

@property
def logger(self) -> Logger:
    if self._logger is None:
        self._logger = logging.getLogger(__name__)
    return self._logger

Methods

def consume(self, state: str) ‑> bool

Expand source code

def consume(self, state: str) -> bool:
    try:
        with self.engine.begin() as conn:
            c = self.oauth_states.c
            query = self.oauth_states.select().where(and_(c.state == state, c.expire_at > datetime.utcnow()))
            result = conn.execute(query)
            for row in result.mappings():
                self.logger.debug(f"consume's query result: {row}")
                conn.execute(self.oauth_states.delete().where(c.id == row["id"]))
                return True
        return False
    except Exception as e:  # skipcq: PYL-W0703
        message = f"Failed to find any persistent data for state: {state} - {e}"
        self.logger.warning(message)
        return False

def create_tables(self)

Expand source code

def create_tables(self):
    self.metadata.create_all(self.engine)

def issue(self, *args, **kwargs) ‑> str

Expand source code

def issue(self, *args, **kwargs) -> str:
    state: str = str(uuid4())
    now = datetime.utcfromtimestamp(time.time() + self.expiration_seconds)
    with self.engine.begin() as conn:
        conn.execute(
            self.oauth_states.insert(),
            {"state": state, "expire_at": now},
        )
    return state