Merge pull request #2 from masenf/user-rename

rename User to LocalUser

Author: masenf

.github/workflows/publish.yml

@@ -0,0 +1,21 @@
+name: Publish Component to PyPI
+
+on:
+  push:
+    tags:
+     - '*'
+
+jobs:
+  publish:
+    name: Publish Component to PyPI
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@master
+    - name: Set up Python 3.12
+      uses: actions/setup-python@v3
+      with:
+        python-version: '3.12'
+    - name: Install package
+      run: pip install .
+    - name: Publish to PyPI
+      run: reflex component publish -t ${{ secrets.PYPI_TOKEN }} --no-share --no-validate-project-info

README.md

@@ -90,7 +90,7 @@ def protected_page():
 
 ## Customization
 
-The basic `reflex_local_auth.User` model provides password hashing and
+The basic `reflex_local_auth.LocalUser` model provides password hashing and
 verification, and an enabled flag. Additional functionality can be added by
 creating a new `UserInfo` model and creating a foreign key relationship to the
 `user.id` field.
@@ -146,7 +146,7 @@ def register_error() -> rx.Component:
         reflex_local_auth.RegistrationState.error_message != "",
         rx.callout(
             reflex_local_auth.RegistrationState.error_message,
-            icon="alert_triangle",
+            icon="triangle_alert",
             color_scheme="red",
             role="alert",
             width="100%",
@@ -234,4 +234,21 @@ def user_info():
             ),
         ),
     )
+```
+
+## Migrating from 0.0.x to 0.1.x
+
+The `User` model has been renamed to `LocalUser` and the `AuthSession` model has
+been renamed to `LocalAuthSession`. If your app was using reflex-local-auth 0.0.x,
+then you will need to make manual changes to migration script to copy existing user
+data into the new tables _after_ running `reflex db makemigrations`.
+
+See [`local_auth_demo/alembic/version/cb01e050df85_.py`](local_auth_demo/alembic/version/cb01e050df85_.py) for an example migration script.
+
+Importantly, your `upgrade` function should include the following lines, after creating
+the new tables and before dropping the old tables:
+
+```python
+    op.execute("INSERT INTO localuser SELECT * FROM user;")
+    op.execute("INSERT INTO localauthsession SELECT * FROM authsession;")
 ```

custom_components/reflex_local_auth/__init__.py

@@ -4,13 +4,13 @@
 from .login import require_login, LoginState
 from .registration import RegistrationState
 from .routes import set_login_route, set_register_route
-from .user import User
+from .user import LocalUser
 
 __all__ = [
     "LocalAuthState",
+    "LocalUser",
     "LoginState",
     "RegistrationState",
-    "User",
     "pages",
     "routes",
     "require_login",

custom_components/reflex_local_auth/auth_session.py

@@ -5,7 +5,7 @@
 import reflex as rx
 
 
-class AuthSession(
+class LocalAuthSession(
     rx.Model,
     table=True,  # type: ignore
 ):

custom_components/reflex_local_auth/local_auth.py

@@ -12,8 +12,8 @@
 
 import reflex as rx
 
-from .auth_session import AuthSession
-from .user import User
+from .auth_session import LocalAuthSession
+from .user import LocalUser
 
 
 AUTH_TOKEN_LOCAL_STORAGE_KEY = "_auth_token"
@@ -25,26 +25,26 @@ class LocalAuthState(rx.State):
     auth_token: str = rx.LocalStorage(name=AUTH_TOKEN_LOCAL_STORAGE_KEY)
 
     @rx.cached_var
-    def authenticated_user(self) -> User:
+    def authenticated_user(self) -> LocalUser:
         """The currently authenticated user, or a dummy user if not authenticated.
 
         Returns:
-            A User instance with id=-1 if not authenticated, or the User instance
+            A LocalUser instance with id=-1 if not authenticated, or the LocalUser instance
             corresponding to the currently authenticated user.
         """
         with rx.session() as session:
             result = session.exec(
-                select(User, AuthSession).where(
-                    AuthSession.session_id == self.auth_token,
-                    AuthSession.expiration
+                select(LocalUser, LocalAuthSession).where(
+                    LocalAuthSession.session_id == self.auth_token,
+                    LocalAuthSession.expiration
                     >= datetime.datetime.now(datetime.timezone.utc),
-                    User.id == AuthSession.user_id,
+                    LocalUser.id == LocalAuthSession.user_id,
                 ),
             ).first()
             if result:
                 user, session = result
                 return user
-        return User(id=-1)  # type: ignore
+        return LocalUser(id=-1)  # type: ignore
 
     @rx.cached_var
     def is_authenticated(self) -> bool:
@@ -56,10 +56,10 @@ def is_authenticated(self) -> bool:
         return self.authenticated_user.id >= 0
 
     def do_logout(self) -> None:
-        """Destroy AuthSessions associated with the auth_token."""
+        """Destroy LocalAuthSessions associated with the auth_token."""
         with rx.session() as session:
             for auth_session in session.exec(
-                select(AuthSession).where(AuthSession.session_id == self.auth_token)
+                select(LocalAuthSession).where(LocalAuthSession.session_id == self.auth_token)
             ).all():
                 session.delete(auth_session)
             session.commit()
@@ -70,14 +70,14 @@ def _login(
         user_id: int,
         expiration_delta: datetime.timedelta = DEFAULT_AUTH_SESSION_EXPIRATION_DELTA,
     ) -> None:
-        """Create an AuthSession for the given user_id.
+        """Create an LocalAuthSession for the given user_id.
 
-        If the auth_token is already associated with an AuthSession, it will be
+        If the auth_token is already associated with an LocalAuthSession, it will be
         logged out first.
 
         Args:
-            user_id: The user ID to associate with the AuthSession.
-            expiration_delta: The amount of time before the AuthSession expires.
+            user_id: The user ID to associate with the LocalAuthSession.
+            expiration_delta: The amount of time before the LocalAuthSession expires.
         """
         if self.is_authenticated:
             self.do_logout()
@@ -86,7 +86,7 @@ def _login(
         self.auth_token = self.auth_token or self.router.session.client_token
         with rx.session() as session:
             session.add(
-                AuthSession(  # type: ignore
+                LocalAuthSession(  # type: ignore
                     user_id=user_id,
                     session_id=self.auth_token,
                     expiration=datetime.datetime.now(datetime.timezone.utc)

custom_components/reflex_local_auth/login.py

@@ -6,7 +6,7 @@
 
 from . import routes
 from .local_auth import LocalAuthState
-from .user import User
+from .user import LocalUser
 
 
 class LoginState(LocalAuthState):
@@ -26,7 +26,7 @@ def on_submit(self, form_data) -> rx.event.EventSpec:
         password = form_data["password"]
         with rx.session() as session:
             user = session.exec(
-                select(User).where(User.username == username)
+                select(LocalUser).where(LocalUser.username == username)
             ).one_or_none()
         if user is not None and not user.enabled:
             self.error_message = "This account is disabled."

custom_components/reflex_local_auth/pages/login.py

@@ -19,7 +19,7 @@ def login_error() -> rx.Component:
         LoginState.error_message != "",
         rx.callout(
             LoginState.error_message,
-            icon="alert_triangle",
+            icon="triangle_alert",
             color_scheme="red",
             role="alert",
             width="100%",

custom_components/reflex_local_auth/pages/registration.py

@@ -19,7 +19,7 @@ def register_error() -> rx.Component:
         RegistrationState.error_message != "",
         rx.callout(
             RegistrationState.error_message,
-            icon="alert_triangle",
+            icon="triangle_alert",
             color_scheme="red",
             role="alert",
             width="100%",

custom_components/reflex_local_auth/registration.py

@@ -9,7 +9,7 @@
 
 from . import routes
 from .local_auth import LocalAuthState
-from .user import User
+from .user import LocalUser
 
 
 POST_REGISTRATION_DELAY = 0.5
@@ -30,7 +30,7 @@ def _validate_fields(
             return rx.set_focus("username")
         with rx.session() as session:
             existing_user = session.exec(
-                select(User).where(User.username == username)
+                select(LocalUser).where(LocalUser.username == username)
             ).one_or_none()
         if existing_user is not None:
             self.error_message = (
@@ -50,9 +50,9 @@ def _validate_fields(
     def _register_user(self, username, password) -> None:
         with rx.session() as session:
             # Create the new user and add it to the database.
-            new_user = User()  # type: ignore
+            new_user = LocalUser()  # type: ignore
             new_user.username = username
-            new_user.password_hash = User.hash_password(password)
+            new_user.password_hash = LocalUser.hash_password(password)
             new_user.enabled = True
             session.add(new_user)
             session.commit()

custom_components/reflex_local_auth/user.py

@@ -6,7 +6,7 @@
 import reflex as rx
 
 
-class User(
+class LocalUser(
     rx.Model,
     table=True,  # type: ignore
 ):

local_auth_demo/alembic/versions/cb01e050df85_.py

@@ -0,0 +1,90 @@
+"""empty message
+
+Revision ID: cb01e050df85
+Revises: 05267fabef38
+Create Date: 2024-04-10 13:12:57.109831
+
+"""
+from typing import Sequence, Union
+
+from alembic import op
+import sqlalchemy as sa
+import sqlmodel
+
+# revision identifiers, used by Alembic.
+revision: str = 'cb01e050df85'
+down_revision: Union[str, None] = '05267fabef38'
+branch_labels: Union[str, Sequence[str], None] = None
+depends_on: Union[str, Sequence[str], None] = None
+
+
+def upgrade() -> None:
+    # ### commands auto generated by Alembic - please adjust! ###
+    op.create_table('localauthsession',
+    sa.Column('id', sa.Integer(), nullable=False),
+    sa.Column('user_id', sa.Integer(), nullable=False),
+    sa.Column('session_id', sqlmodel.sql.sqltypes.AutoString(), nullable=False),
+    sa.Column('expiration', sa.DateTime(timezone=True), server_default=sa.text('(CURRENT_TIMESTAMP)'), nullable=False),
+    sa.PrimaryKeyConstraint('id')
+    )
+    op.create_index(op.f('ix_localauthsession_session_id'), 'localauthsession', ['session_id'], unique=True)
+    op.create_index(op.f('ix_localauthsession_user_id'), 'localauthsession', ['user_id'], unique=False)
+    op.create_table('localuser',
+    sa.Column('id', sa.Integer(), nullable=False),
+    sa.Column('username', sqlmodel.sql.sqltypes.AutoString(), nullable=False),
+    sa.Column('password_hash', sa.LargeBinary(), nullable=False),
+    sa.Column('enabled', sa.Boolean(), nullable=False),
+    sa.PrimaryKeyConstraint('id')
+    )
+    op.create_index(op.f('ix_localuser_username'), 'localuser', ['username'], unique=True)
+    op.execute("INSERT INTO localuser SELECT * FROM user;")
+    op.execute("INSERT INTO localauthsession SELECT * FROM authsession;")
+    op.drop_index('ix_authsession_session_id', table_name='authsession')
+    op.drop_index('ix_authsession_user_id', table_name='authsession')
+    op.drop_table('authsession')
+    naming_convention = {
+        "fk":
+        "fk_%(table_name)s_%(column_0_name)s_%(referred_table_name)s",
+    }
+    with op.batch_alter_table('userinfo', naming_convention=naming_convention) as batch_op:
+        batch_op.drop_constraint('fk_userinfo_user_id_user', type_='foreignkey')
+        batch_op.create_foreign_key('fk_userinfo_user_id_localuser', 'localuser', ['user_id'], ['id'])
+    op.drop_index('ix_user_username', table_name='user')
+    op.drop_table('user')
+    # ### end Alembic commands ###
+
+
+def downgrade() -> None:
+    # ### commands auto generated by Alembic - please adjust! ###
+    op.create_table('user',
+    sa.Column('id', sa.INTEGER(), nullable=False),
+    sa.Column('username', sa.VARCHAR(), nullable=False),
+    sa.Column('password_hash', sa.BLOB(), nullable=False),
+    sa.Column('enabled', sa.BOOLEAN(), nullable=False),
+    sa.PrimaryKeyConstraint('id')
+    )
+    op.create_index('ix_user_username', 'user', ['username'], unique=1)
+    op.create_table('authsession',
+    sa.Column('id', sa.INTEGER(), nullable=False),
+    sa.Column('user_id', sa.INTEGER(), nullable=False),
+    sa.Column('session_id', sa.VARCHAR(), nullable=False),
+    sa.Column('expiration', sa.DATETIME(), server_default=sa.text('(CURRENT_TIMESTAMP)'), nullable=False),
+    sa.PrimaryKeyConstraint('id')
+    )
+    op.create_index('ix_authsession_user_id', 'authsession', ['user_id'], unique=False)
+    op.create_index('ix_authsession_session_id', 'authsession', ['session_id'], unique=1)
+    op.execute("INSERT INTO user SELECT * FROM localuser;")
+    op.execute("INSERT INTO authsession SELECT * FROM localauthsession;")
+    naming_convention = {
+        "fk":
+        "fk_%(table_name)s_%(column_0_name)s_%(referred_table_name)s",
+    }
+    with op.batch_alter_table('userinfo', naming_convention=naming_convention) as batch_op:
+        batch_op.drop_constraint('fk_userinfo_user_id_localuser', type_='foreignkey')
+        batch_op.create_foreign_key('fk_userinfo_user_id_user', 'localuser', ['user_id'], ['id'])
+    op.drop_index(op.f('ix_localuser_username'), table_name='localuser')
+    op.drop_table('localuser')
+    op.drop_index(op.f('ix_localauthsession_user_id'), table_name='localauthsession')
+    op.drop_index(op.f('ix_localauthsession_session_id'), table_name='localauthsession')
+    op.drop_table('localauthsession')
+    # ### end Alembic commands ###

local_auth_demo/local_auth_demo/custom_user_info.py

@@ -10,7 +10,7 @@ class UserInfo(rx.Model, table=True):
     email: str
     created_from_ip: str
 
-    user_id: int = sqlmodel.Field(foreign_key="user.id")
+    user_id: int = sqlmodel.Field(foreign_key="localuser.id")
 
 
 class MyLocalAuthState(reflex_local_auth.LocalAuthState):
@@ -52,7 +52,7 @@ def register_error() -> rx.Component:
         reflex_local_auth.RegistrationState.error_message != "",
         rx.callout(
             reflex_local_auth.RegistrationState.error_message,
-            icon="alert_triangle",
+            icon="triangle_alert",
             color_scheme="red",
             role="alert",
             width="100%",

local_auth_demo/local_auth_demo/local_auth_demo.py

@@ -1,4 +1,5 @@
 """Main app module to demo local authentication."""
+
 import reflex as rx
 
 import reflex_local_auth
@@ -93,3 +94,6 @@ def protected():
     route=reflex_local_auth.routes.REGISTER_ROUTE,
     title="Register",
 )
+
+# Create the database if it does not exist (hosting service does not migrate automatically)
+rx.Model.migrate()

local_auth_demo/requirements.txt

@@ -1,2 +1,2 @@
-reflex==0.4.3
+reflex>=0.4.3
 reflex_local_auth>=0.0.1

pyproject.toml

@@ -7,8 +7,8 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "reflex-local-auth"
-version = "0.0.3"
-description = "Reflex custom component local-auth"
+version = "0.1.0"
+description = "Local DB user authentication for Reflex apps"
 readme = "README.md"
 license = { text = "Apache-2.0" }
 requires-python = ">=3.8"