Is677/trial account (ITISFoundation#3352)

Author: pcrespov

api/specs/webserver/components/schemas/me.yaml

@@ -9,18 +9,17 @@ ProfileCommon:
     first_name: Pedro
     last_name: Crespo
 
-ProfileInput:
+ProfileUpdate:
   allOf:
     - $ref: "#/ProfileCommon"
-  example:
-    first_name: Pedro
-    last_name: Crespo
 
-ProfileOutput:
+ProfileGet:
   allOf:
     - $ref: "#/ProfileCommon"
     - type: object
       properties:
+        id:
+          type: integer
         login:
           type: string
           format: email
@@ -30,18 +29,18 @@ ProfileOutput:
           $ref: "./group.yaml#/AllUsersGroups"
         gravatar_id:
           type: string
-  example:
-    login: [email protected]
-    role: Admin
-    gravatar_id: 205e460b479e2e5b48aec07710c08d50
+        expirationDate:
+          type: string
+          format: date
+          description: "If user has a trial account, it sets the expiration date, otherwise None"
 
 ProfileEnveloped:
   type: object
   required:
     - data
   properties:
     data:
-      $ref: "#/ProfileOutput"
+      $ref: "#/ProfileGet"
     error:
       nullable: true
       default: null
@@ -63,9 +62,6 @@ Token:
   required:
     - service
     - token_key
-  example:
-    service: "github-api-v1"
-    token_key: N1BP5ZSpB
 
 TokenId:
   description: toke identifier

api/specs/webserver/openapi-user.yaml

@@ -21,7 +21,7 @@ paths:
         content:
           application/json:
             schema:
-              $ref: "./components/schemas/me.yaml#/ProfileInput"
+              $ref: "./components/schemas/me.yaml#/ProfileUpdate"
       responses:
         "204":
           description: updated profile

api/specs/webserver/openapi.yaml

@@ -1,7 +1,7 @@
 openapi: 3.0.0
 info:
   title: "osparc-simcore web API"
-  version: 0.7.0
+  version: 0.8.0
   description: "API designed for the front-end app"
   contact:
     name: IT'IS Foundation

packages/models-library/src/models_library/basic_types.py

@@ -1,6 +1,6 @@
 from enum import Enum
 
-from pydantic import conint, constr
+from pydantic import PositiveInt, conint, constr
 
 from .basic_regex import UUID_RE, VERSION_RE
 
@@ -23,6 +23,9 @@
 # e.g. '5c833a78-1af3-43a7-9ed7-6a63b188f4d8'
 UUIDStr = constr(regex=UUID_RE)
 
+# auto-incremented primary-key IDs
+IdInt = PrimaryKeyInt = PositiveInt
+
 
 class LogLevel(str, Enum):
     DEBUG = "DEBUG"

packages/postgres-database/src/simcore_postgres_database/migration/versions/ead667546b12_user_expiration.py

@@ -0,0 +1,38 @@
+"""User expiration
+
+Revision ID: ead667546b12
+Revises: 9d477e20d06e
+Create Date: 2022-09-12 14:09:04.385524+00:00
+
+"""
+import sqlalchemy as sa
+from alembic import op
+
+# revision identifiers, used by Alembic.
+revision = "ead667546b12"
+down_revision = "9d477e20d06e"
+branch_labels = None
+depends_on = None
+
+
+def upgrade():
+    op.add_column("users", sa.Column("expires_at", sa.DateTime(), nullable=True))
+
+    # https://medium.com/makimo-tech-blog/upgrading-postgresqls-enum-type-with-sqlalchemy-using-alembic-migration-881af1e30abe
+    with op.get_context().autocommit_block():
+        op.execute("ALTER TYPE userstatus ADD VALUE 'EXPIRED'")
+
+
+def downgrade():
+    op.drop_column("users", "expires_at")
+
+    # https://medium.com/makimo-tech-blog/upgrading-postgresqls-enum-type-with-sqlalchemy-using-alembic-migration-881af1e30abe
+    op.execute("ALTER TYPE userstatus RENAME TO userstatus_old")
+    op.execute(
+        "CREATE TYPE userstatus AS ENUM('CONFIRMATION_PENDING', 'ACTIVE', 'BANNED')"
+    )
+    op.execute(
+        "ALTER TABLE users ALTER COLUMN status TYPE userstatus USING "
+        "status::text::userstatus"
+    )
+    op.execute("DROP TYPE userstatus_old")

packages/postgres-database/src/simcore_postgres_database/models/users.py

@@ -59,20 +59,37 @@ class UserStatus(Enum):
     """
     pending: user registered but not confirmed
     active: user is confirmed and can use the platform
+    expired: user is not authorized because it expired after a trial period
     banned: user is not authorized
     """
 
     CONFIRMATION_PENDING = "PENDING"
     ACTIVE = "ACTIVE"
+    EXPIRED = "EXPIRED"
     BANNED = "BANNED"
 
 
 users = sa.Table(
     "users",
     metadata,
-    sa.Column("id", sa.BigInteger, nullable=False),
-    sa.Column("name", sa.String, nullable=False),
-    sa.Column("email", sa.String, nullable=False),
+    sa.Column(
+        "id",
+        sa.BigInteger,
+        nullable=False,
+        doc="Primary key for user identifier",
+    ),
+    sa.Column(
+        "name",
+        sa.String,
+        nullable=False,
+        doc="Display name. NOTE: this is NOT a user name since uniqueness is NOT guaranteed",
+    ),
+    sa.Column(
+        "email",
+        sa.String,
+        nullable=False,
+        doc="User email is used as username since it is a unique human-readable identifier",
+    ),
     sa.Column(
         "phone",
         sa.String,
@@ -89,30 +106,57 @@ class UserStatus(Enum):
             onupdate="CASCADE",
             ondelete="RESTRICT",
         ),
+        doc="User's group ID",
     ),
     sa.Column(
         "status",
         sa.Enum(UserStatus),
         nullable=False,
         default=UserStatus.CONFIRMATION_PENDING,
+        doc="Status of the user account. SEE UserStatus",
+    ),
+    sa.Column(
+        "role",
+        sa.Enum(UserRole),
+        nullable=False,
+        default=UserRole.USER,
+        doc="Use for role-base authorization",
+    ),
+    sa.Column(
+        "created_at",
+        sa.DateTime(),
+        nullable=False,
+        server_default=func.now(),
+        doc="Registration timestamp",
     ),
-    sa.Column("role", sa.Enum(UserRole), nullable=False, default=UserRole.USER),
-    sa.Column("created_at", sa.DateTime(), nullable=False, server_default=func.now()),
     sa.Column(
         "modified",
         sa.DateTime(),
         nullable=False,
         server_default=func.now(),
         onupdate=func.now(),  # this will auto-update on modification
+        doc="Last modification timestamp",
+    ),
+    sa.Column(
+        "expires_at",
+        sa.DateTime(),
+        nullable=True,
+        doc="Sets the expiration date for trial accounts."
+        "If set to NULL then the account does not expire.",
+    ),
+    sa.Column(
+        "created_ip",
+        sa.String(),
+        nullable=True,
+        doc="User IP from which use was created",
     ),
-    sa.Column("created_ip", sa.String(), nullable=True),
-    #
+    # ---------------------------
     sa.PrimaryKeyConstraint("id", name="user_pkey"),
     sa.UniqueConstraint("email", name="user_login_key"),
     sa.UniqueConstraint(
         "phone",
         name="user_phone_unique_constraint",
-        # cannot use same phone for two users
+        # NOTE: that cannot use same phone for two user accounts
     ),
 )
 

packages/postgres-database/tests/test_users.py

@@ -1,4 +1,17 @@
-from simcore_postgres_database.models.users import _USER_ROLE_TO_LEVEL, UserRole
+from datetime import datetime, timedelta
+from typing import Optional
+
+import sqlalchemy as sa
+from aiopg.sa.engine import Engine
+from aiopg.sa.result import ResultProxy, RowProxy
+from pytest_simcore.helpers.rawdata_fakers import random_user
+from simcore_postgres_database.models.users import (
+    _USER_ROLE_TO_LEVEL,
+    UserRole,
+    UserStatus,
+    users,
+)
+from sqlalchemy.sql import func
 
 
 def test_user_role_to_level_map_in_sync():
@@ -48,3 +61,45 @@ def test_user_role_comparison():
 
     assert UserRole.ADMIN <= UserRole.ADMIN
     assert UserRole.ADMIN == UserRole.ADMIN
+
+
+async def test_trial_accounts(pg_engine: Engine):
+    EXPIRATION_INTERVAL = timedelta(minutes=5)
+
+    async with pg_engine.acquire() as conn:
+
+        # creates trial user
+        client_now = datetime.utcnow()
+        user_id: Optional[int] = await conn.scalar(
+            users.insert()
+            .values(
+                **random_user(
+                    status=UserStatus.ACTIVE,
+                    # Using some magic from sqlachemy ...
+                    expires_at=func.now() + EXPIRATION_INTERVAL,
+                )
+            )
+            .returning(users.c.id)
+        )
+        assert user_id
+
+        # check expiration date
+        result: ResultProxy = await conn.execute(
+            sa.select([users.c.status, users.c.created_at, users.c.expires_at]).where(
+                users.c.id == user_id
+            )
+        )
+        row: Optional[RowProxy] = await result.first()
+        assert row
+        assert row.created_at - client_now < timedelta(
+            minutes=1
+        ), "Difference between server and client now should not differ much"
+        assert row.expires_at - row.created_at == EXPIRATION_INTERVAL
+        assert row.status == UserStatus.ACTIVE
+
+        # sets user as expired
+        await conn.execute(
+            users.update()
+            .values(status=UserStatus.EXPIRED)
+            .where(users.c.id == user_id)
+        )

services/web/server/VERSION

@@ -1 +1 @@
-0.7.0
+0.8.0

services/web/server/setup.cfg

@@ -1,9 +1,9 @@
 [bumpversion]
-current_version = 0.7.0
+current_version = 0.8.0
 commit = True
 message = services/webserver api version: {current_version} → {new_version}
 tag = False
-commit-args = --no-verify
+commit_args = --no-verify
 
 [bumpversion:file:VERSION]
 
@@ -14,6 +14,6 @@ commit-args = --no-verify
 [tool:pytest]
 addopts = --strict-markers
 asyncio_mode = auto
-markers =
+markers = 
 	slow: marks tests as slow (deselect with '-m "not slow"')
 	acceptance_test: "marks tests as 'acceptance tests' i.e. does the system do what the user expects? Typically those are workflows."

services/web/server/src/simcore_service_webserver/api/v0/openapi.yaml

@@ -1,7 +1,7 @@
 openapi: 3.0.0
 info:
   title: osparc-simcore web API
-  version: 0.7.0
+  version: 0.8.0
   description: API designed for the front-end app
   contact:
     name: IT'IS Foundation
@@ -664,6 +664,8 @@ paths:
                       - $ref: '#/paths/~1me/put/requestBody/content/application~1json/schema/allOf/0'
                       - type: object
                         properties:
+                          id:
+                            type: integer
                           login:
                             type: string
                             format: email
@@ -673,10 +675,10 @@ paths:
                             $ref: '#/paths/~1groups/get/responses/200/content/application~1json/schema/properties/data'
                           gravatar_id:
                             type: string
-                    example:
-                      login: [email protected]
-                      role: Admin
-                      gravatar_id: 205e460b479e2e5b48aec07710c08d50
+                          expirationDate:
+                            type: string
+                            format: date
+                            description: 'If user has a trial account, it sets the expiration date, otherwise None'
                   error:
                     nullable: true
                     default: null
@@ -700,9 +702,6 @@ paths:
                   example:
                     first_name: Pedro
                     last_name: Crespo
-              example:
-                first_name: Pedro
-                last_name: Crespo
       responses:
         '204':
           description: updated profile
@@ -763,9 +762,6 @@ paths:
                   required:
                     - service
                     - token_key
-                  example:
-                    service: github-api-v1
-                    token_key: N1BP5ZSpB
                 error:
                   nullable: true
                   default: null
@@ -2470,12 +2466,12 @@ paths:
             CreationStatus:
               operationId: get_task_status
               parameters:
-                task_id: '$response.body#/data/task_id'
+                task_id: $response.body#/data/task_id
             CreationResult:
               operationId: get_task_result
               description: Returns 201 if creation succeeded
               parameters:
-                task_id: '$response.body#/data/task_id'
+                task_id: $response.body#/data/task_id
         default:
           $ref: '#/components/responses/DefaultErrorResponse'
   /projects/active: