bazis-front 0.1.0__tar.gz

bazis_front-0.1.0/.dockerignore

@@ -0,0 +1,3 @@
+.gitlab-ci.yml
+.gitignore
+.dockerignore

bazis_front-0.1.0/.editorconfig

@@ -0,0 +1,12 @@
+root = true
+
+[*]
+charset = utf-8
+end_of_line = lf
+insert_final_newline = true
+trim_trailing_whitespace = true
+indent_style = space
+indent_size = 2
+
+[*.md]
+trim_trailing_whitespace = false

bazis_front-0.1.0/.github/workflows/build-publish.yml

@@ -0,0 +1,20 @@
+name: Build and Publish
+
+on:
+  push:
+    tags:
+      - 'v*.*.*'
+  # started by the Release workflow on the tag it creates: a tag pushed with the
+  # workflow token does not trigger the push event above
+  workflow_dispatch:
+
+permissions:
+  contents: write
+
+jobs:
+  build:
+    if: startsWith(github.ref, 'refs/tags/v')
+    uses: ecofuture-tech/.github/.github/workflows/reusable-build-publish.yml@main
+    secrets:
+      PYPI_TOKEN: ${{ secrets.PYPI_TOKEN }}
+      TEST_PYPI_TOKEN: ${{ secrets.TEST_PYPI_TOKEN }}

bazis_front-0.1.0/.github/workflows/release.yml

@@ -0,0 +1,77 @@
+name: Release
+
+# Creates the release tag vX.Y.Z on the current main commit and starts Build and Publish
+# for it. Run it from the Actions tab (or through the GitHub API) on the main branch.
+
+on:
+  workflow_dispatch:
+    inputs:
+      version:
+        description: 'Version without the "v" prefix, e.g. 2.3.0 or 2.4.0-rc1'
+        required: true
+        type: string
+
+permissions:
+  contents: write
+  actions: write
+
+concurrency:
+  group: release
+  cancel-in-progress: false
+
+jobs:
+  release:
+    runs-on: ubuntu-latest
+    timeout-minutes: 10
+    if: github.ref == 'refs/heads/main'
+    env:
+      GH_TOKEN: ${{ github.token }}
+      VERSION: ${{ inputs.version }}
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Validate the version
+        run: |
+          if [[ ! "$VERSION" =~ ^[0-9]+\.[0-9]+\.[0-9]+(-(alpha|beta|rc)[0-9]+)?$ ]]; then
+            echo "::error::Invalid version '$VERSION', expected e.g. 2.3.0 or 2.4.0-rc1"
+            exit 1
+          fi
+          if git rev-parse -q --verify "refs/tags/v$VERSION" >/dev/null; then
+            echo "::error::Tag v$VERSION already exists"
+            exit 1
+          fi
+          # versionsort.suffix: a pre-release (v2.4.0-rc1) sorts before its release (v2.4.0)
+          LAST_TAG=$(git -c versionsort.suffix=- tag --list 'v*' --sort=-v:refname | head -n 1)
+          echo "Last release: ${LAST_TAG:-none}, new release: v$VERSION"
+          # sort -V orders "~" before anything, as versionsort.suffix does with "-"
+          NEWEST=$(printf '%s\n%s\n' "${LAST_TAG#v}" "$VERSION" | sed 's/-/~/' | sort -V | tail -n 1)
+          if [ -n "$LAST_TAG" ] && [ "$NEWEST" != "${VERSION/-/\~}" ]; then
+            echo "::error::Version $VERSION is not newer than $LAST_TAG"
+            exit 1
+          fi
+
+      - name: Require green tests on this commit
+        run: |
+          CONCLUSION=$(gh run list --workflow tests.yml --commit "$GITHUB_SHA" --status completed \
+            --json conclusion --jq 'map(.conclusion) | first // "none"')
+          echo "Tests on $GITHUB_SHA: $CONCLUSION"
+          if [ "$CONCLUSION" != "success" ]; then
+            echo "::error::The Tests workflow has not succeeded on $GITHUB_SHA ($CONCLUSION)"
+            exit 1
+          fi
+
+      - name: Create the tag
+        run: |
+          git config user.name 'github-actions[bot]'
+          git config user.email '41898282+github-actions[bot]@users.noreply.github.com'
+          git tag -a "v$VERSION" -m "${{ github.event.repository.name }} $VERSION" "$GITHUB_SHA"
+          git push origin "v$VERSION"
+
+      - name: Start Build and Publish
+        run: gh workflow run build-publish.yml --ref "v$VERSION"
+
+      - name: Summary
+        run: |
+          echo "Tagged \`v$VERSION\` at \`$GITHUB_SHA\` and started Build and Publish." >> "$GITHUB_STEP_SUMMARY"

bazis_front-0.1.0/.github/workflows/tests.yml

@@ -0,0 +1,402 @@
+name: Tests
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+
+permissions:
+  contents: read
+
+concurrency:
+  group: tests-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    timeout-minutes: 10
+    steps:
+      - uses: actions/checkout@v4
+      - uses: astral-sh/setup-uv@v6
+      - run: uvx ruff check bazis tests sample scripts
+      - name: Check the contents of the wheel
+        run: |
+          uv build --wheel --out-dir wheel
+          python scripts/check_wheel.py wheel
+
+  tests:
+    name: tests (python ${{ matrix.python }}, ${{ matrix.resolution }})
+    runs-on: ubuntu-latest
+    timeout-minutes: 30
+    strategy:
+      fail-fast: false
+      matrix:
+        python: ['3.12', '3.13', '3.14']
+        resolution: [highest]
+        include:
+          # the lowest versions allowed by pyproject.toml
+          - python: '3.12'
+            resolution: lowest-direct
+
+    # the contract reads the roles of bazis-permit and the transits of bazis-statusy from the
+    # database of the sample
+    services:
+      postgres:
+        image: postgis/postgis:16-3.4
+        env:
+          POSTGRES_USER: postgres
+          POSTGRES_PASSWORD: postgres
+          POSTGRES_DB: bazis
+        ports:
+          - 5432:5432
+        options: >-
+          --health-cmd pg_isready
+          --health-interval 5s
+          --health-timeout 5s
+          --health-retries 10
+      redis:
+        image: redis:7
+        ports:
+          - 6379:6379
+        options: >-
+          --health-cmd "redis-cli ping"
+          --health-interval 5s
+          --health-timeout 5s
+          --health-retries 10
+    env:
+      BS_DEBUG: 'true'
+      BS_SECRET_KEY: ci-only-secret-key-that-is-long-enough-0123456789
+      BS_DATABASES__DEFAULT__HOST: localhost
+      BS_DATABASES__DEFAULT__PORT: '5432'
+      BS_DATABASES__DEFAULT__NAME: bazis
+      BS_DATABASES__DEFAULT__USER: postgres
+      BS_DATABASES__DEFAULT__PASSWORD: postgres
+      BS_CACHES__DEFAULT__LOCATION: redis://localhost:6379/1
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Install GDAL (required by the PostGIS database backend)
+        # a stalled Ubuntu mirror must fail the step quickly instead of hanging the job
+        timeout-minutes: 10
+        run: |
+          APT="sudo apt-get -o Acquire::Retries=3 -o Acquire::http::Timeout=30 -o Acquire::https::Timeout=30"
+          $APT update
+          $APT install -y --no-install-recommends gdal-bin
+
+      - uses: astral-sh/setup-uv@v6
+        with:
+          python-version: ${{ matrix.python }}
+          activate-environment: true
+
+      - name: Install dependencies
+        run: uv pip install --resolution ${{ matrix.resolution }} -e '.[test]'
+
+      - name: Check for missing migrations
+        working-directory: sample
+        run: python manage.py makemigrations --check --dry-run
+
+      - name: Run tests
+        working-directory: sample
+        run: python -m pytest ../tests -o addopts="" -p no:cacheprovider
+
+  # the TypeScript assets: dev-only Node tooling of this repository
+  assets:
+    runs-on: ubuntu-latest
+    timeout-minutes: 10
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
+        with:
+          node-version: 22
+          cache: npm
+      - run: npm ci
+      - run: npm run lint
+      - run: npm run typecheck
+      # the tests of the helpers of the end-to-end tests run in Chromium
+      - run: npx playwright install --with-deps chromium
+      - run: npm test
+
+  # a frontend made by `init` from the sample backend, with every component added: the
+  # template and the components compile, lint, pass their contract tests and build against
+  # the generated contract, the copied client and the copied hooks
+  frontend:
+    name: frontend (${{ matrix.variant }})
+    runs-on: ubuntu-latest
+    timeout-minutes: 20
+    # the components take their defaults from the theme: their contract tests run under
+    # the starters of both presets. `empty` is a new product before its first model: the
+    # sample without its apps and routes (only bazis-front, as `bazis new` creates it), whose
+    # contract has no resources, roles or transits
+    strategy:
+      fail-fast: false
+      matrix:
+        include:
+          - {variant: workspace, preset: workspace}
+          - {variant: portal, preset: portal}
+          - {variant: empty, preset: workspace, empty: true}
+    services:
+      postgres:
+        image: postgis/postgis:16-3.4
+        env:
+          POSTGRES_USER: postgres
+          POSTGRES_PASSWORD: postgres
+          POSTGRES_DB: bazis
+        ports:
+          - 5432:5432
+        options: >-
+          --health-cmd pg_isready
+          --health-interval 5s
+          --health-timeout 5s
+          --health-retries 10
+      redis:
+        image: redis:7
+        ports:
+          - 6379:6379
+        options: >-
+          --health-cmd "redis-cli ping"
+          --health-interval 5s
+          --health-timeout 5s
+          --health-retries 10
+    env:
+      BS_DEBUG: 'true'
+      BS_SECRET_KEY: ci-only-secret-key-that-is-long-enough-0123456789
+      BS_DATABASES__DEFAULT__HOST: localhost
+      BS_DATABASES__DEFAULT__PORT: '5432'
+      BS_DATABASES__DEFAULT__NAME: bazis
+      BS_DATABASES__DEFAULT__USER: postgres
+      BS_DATABASES__DEFAULT__PASSWORD: postgres
+      BS_CACHES__DEFAULT__LOCATION: redis://localhost:6379/1
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Install GDAL (required by the PostGIS database backend)
+        timeout-minutes: 10
+        run: |
+          APT="sudo apt-get -o Acquire::Retries=3 -o Acquire::http::Timeout=30 -o Acquire::https::Timeout=30"
+          $APT update
+          $APT install -y --no-install-recommends gdal-bin
+
+      - uses: astral-sh/setup-uv@v6
+        with:
+          python-version: '3.12'
+          activate-environment: true
+      - uses: actions/setup-node@v4
+        with:
+          node-version: 22
+
+      - name: Install dependencies
+        run: uv pip install -e '.[test]'
+
+      # the product root (BASE_DIR) is outside the checkout, so that the frontend is not
+      # inside the npm workspaces of this repository
+      - name: Create the frontend of the sample
+        if: ${{ !matrix.empty }}
+        working-directory: sample
+        run: |
+          echo "BS_BASE_DIR=$RUNNER_TEMP/product" >> "$GITHUB_ENV"
+          export BS_BASE_DIR="$RUNNER_TEMP/product"
+          mkdir -p "$BS_BASE_DIR"
+          python manage.py migrate
+          python manage.py bazis_front init --preset ${{ matrix.preset }}
+          python manage.py bazis_front contract
+          python manage.py bazis_front contract --check
+          python manage.py bazis_front check
+          # the theme that init compiled from the starters of the design
+          python manage.py bazis_front design --check
+          python manage.py bazis_front add resource-list resource-card resource-form status-badge status-history transit-bar file-field live-query notification-center task-progress async-result map
+
+      - name: Check and build the frontend
+        if: ${{ !matrix.empty }}
+        working-directory: ${{ env.BS_BASE_DIR }}/frontend
+        run: |
+          # the sample has bazis-statusy, bazis-uploadable, bazis-ws, bazis-notify, bazis-bg and
+          # bazis-async-background: their hooks are copied and compiled with the rest
+          test -f src/bazis/react/statusy/index.ts
+          test -f src/bazis/react/uploadable/index.ts
+          test -f src/bazis/react/ws/index.ts
+          test -f src/bazis/react/notify/index.ts
+          test -f src/bazis/react/bg/index.ts
+          test -f src/bazis/react/async/index.ts
+          test -f src/bazis/ui/transit-bar/transit-bar.contract.test.tsx
+          test -f src/bazis/ui/file-field/file-field.contract.test.tsx
+          test -f src/bazis/ui/notification-center/notification-center.contract.test.tsx
+          test -f src/bazis/ui/task-progress/task-progress.contract.test.tsx
+          test -f src/bazis/ui/async-result/async-result.contract.test.tsx
+          test -f src/bazis/ui/map/map.contract.test.tsx
+          # the npm dependency that `add map` set in package.json (Leaflet)
+          npm install
+          npx tsc --noEmit
+          npm run lint
+          # `npm run format` of a new product changes nothing: the template has its style
+          npx --no-install prettier --check src e2e
+          # the contract tests of the components with the tests of the template
+          npm test
+          npm run build -- --manifest
+          # the chunks loaded with the entry: within the budget, Leaflet not among them
+          python "$GITHUB_WORKSPACE/scripts/check_chunks.py" dist
+
+      # the overrides of the settings of sample/project.env: no app of the sample, the
+      # default router (nothing registered) and the user model of Django
+      - name: Create the frontend of a product without resources
+        if: ${{ matrix.empty }}
+        working-directory: sample
+        env:
+          BS_INSTALLED_APPS: '["bazis.contrib.front"]'
+          BS_BAZIS_ROUTER_MODULE: ''
+          BS_AUTH_USER_MODEL: auth.User
+          BS_AUTH_ANONYMOUS_USER_MODEL: ''
+        run: |
+          echo "BS_BASE_DIR=$RUNNER_TEMP/product" >> "$GITHUB_ENV"
+          export BS_BASE_DIR="$RUNNER_TEMP/product"
+          mkdir -p "$BS_BASE_DIR"
+          python manage.py migrate
+          python manage.py bazis_front init --preset ${{ matrix.preset }}
+          python manage.py bazis_front contract
+          python manage.py bazis_front contract --check
+          python -c 'import json, sys; c = json.load(open(sys.argv[1])); assert c["project"]["resources"] == {} and "permit" not in c["capabilities"], c' "$BS_BASE_DIR/contract/contract.json"
+          python manage.py bazis_front check
+          python manage.py bazis_front design --check
+          # the components that need no capability
+          python manage.py bazis_front add resource-list resource-card resource-form notification-center map
+
+      - name: Check and build the frontend of a product without resources
+        if: ${{ matrix.empty }}
+        working-directory: ${{ env.BS_BASE_DIR }}/frontend
+        run: |
+          npm install
+          npx tsc --noEmit
+          npm run lint
+          npx --no-install prettier --check src e2e
+          npm test
+          npm run build -- --manifest
+          python "$GITHUB_WORKSPACE/scripts/check_chunks.py" dist
+
+  # the end-to-end tests of the scenarios of the sample (sample/spec/product.yaml): a frontend
+  # made by `init` from the sample, with the components and the screens of the sample
+  # (sample/frontend-overlay/), the tests generated by `bazis_front e2e`, run by Playwright
+  # against the sample backend with its test data
+  e2e:
+    runs-on: ubuntu-latest
+    timeout-minutes: 30
+    services:
+      postgres:
+        image: postgis/postgis:16-3.4
+        env:
+          POSTGRES_USER: postgres
+          POSTGRES_PASSWORD: postgres
+          POSTGRES_DB: bazis
+        ports:
+          - 5432:5432
+        options: >-
+          --health-cmd pg_isready
+          --health-interval 5s
+          --health-timeout 5s
+          --health-retries 10
+      redis:
+        image: redis:7
+        ports:
+          - 6379:6379
+        options: >-
+          --health-cmd "redis-cli ping"
+          --health-interval 5s
+          --health-timeout 5s
+          --health-retries 10
+    env:
+      BS_DEBUG: 'true'
+      BS_SECRET_KEY: ci-only-secret-key-that-is-long-enough-0123456789
+      BS_DATABASES__DEFAULT__HOST: localhost
+      BS_DATABASES__DEFAULT__PORT: '5432'
+      BS_DATABASES__DEFAULT__NAME: bazis
+      BS_DATABASES__DEFAULT__USER: postgres
+      BS_DATABASES__DEFAULT__PASSWORD: postgres
+      BS_CACHES__DEFAULT__LOCATION: redis://localhost:6379/1
+      # the password of the test users, set by `e2e_data` and read by the tests
+      E2E_PASSWORD: ci-only-e2e-password-0123
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Install GDAL (required by the PostGIS database backend)
+        timeout-minutes: 10
+        run: |
+          APT="sudo apt-get -o Acquire::Retries=3 -o Acquire::http::Timeout=30 -o Acquire::https::Timeout=30"
+          $APT update
+          $APT install -y --no-install-recommends gdal-bin
+
+      - uses: astral-sh/setup-uv@v6
+        with:
+          python-version: '3.12'
+          activate-environment: true
+      - uses: actions/setup-node@v4
+        with:
+          node-version: 22
+
+      - name: Install dependencies
+        run: uv pip install -e '.[test]'
+
+      # the product root (BASE_DIR) is outside the checkout, as in the frontend job; it has
+      # the complete specs of the sample, with their scenarios
+      - name: Create the frontend of the sample and its end-to-end tests
+        working-directory: sample
+        run: |
+          echo "BS_BASE_DIR=$RUNNER_TEMP/product" >> "$GITHUB_ENV"
+          export BS_BASE_DIR="$RUNNER_TEMP/product"
+          mkdir -p "$BS_BASE_DIR"
+          cp -R spec "$BS_BASE_DIR/spec"
+          # `migrate` applies the declared roles, statuses and transits of the sample
+          python manage.py migrate
+          # the e2e data command: the test users of the roles and the task of a scenario
+          python manage.py e2e_data
+          python manage.py bazis_front init
+          python manage.py bazis_front contract
+          python manage.py bazis_front check
+          python manage.py bazis_front add resource-list resource-card resource-form status-badge status-history transit-bar file-field live-query notification-center task-progress map
+          # the screens of the sample, product code, and the files that its scenarios upload
+          cp -R frontend-overlay/src/. "$BS_BASE_DIR/frontend/src/"
+          cp -R frontend-overlay/e2e/. "$BS_BASE_DIR/frontend/e2e/"
+          python manage.py bazis_front e2e
+          python manage.py bazis_front e2e --check
+          # the theme of the design of the sample
+          python manage.py bazis_front design --check
+
+      - name: Check and build the frontend
+        working-directory: ${{ env.BS_BASE_DIR }}/frontend
+        run: |
+          # the npm dependency that `add map` set in package.json (Leaflet)
+          npm install
+          npx tsc --noEmit
+          npm run lint
+          npm run build -- --manifest
+          # Leaflet and the file field are chunks of their own, not in the main chunk, and the
+          # chunks loaded with the entry are within the budget with the screens of the sample
+          python "$GITHUB_WORKSPACE/scripts/check_chunks.py" dist
+
+      # the backend serves the socket of bazis-ws (`/api/v1/ws`), which `vite preview` proxies: the
+      # notifications of the scenarios come over it (Redis pub/sub)
+      - name: Start the backend and the frontend
+        run: |
+          (cd sample && nohup uvicorn sample.main:app --host 127.0.0.1 --port 8000 > "$RUNNER_TEMP/backend.log" 2>&1 &)
+          (cd "$BS_BASE_DIR/frontend" && BAZIS_API_URL=http://127.0.0.1:8000 nohup npx vite preview --port 4173 --strictPort > "$RUNNER_TEMP/frontend.log" 2>&1 &)
+          # the list of the tasks, which an anonymous user (the viewer role) may read, through the proxy
+          timeout 120 sh -c 'until curl -sf -o /dev/null http://localhost:4173/api/v1/tasks/task/; do sleep 1; done'
+
+      - name: Run the end-to-end tests
+        working-directory: ${{ env.BS_BASE_DIR }}/frontend
+        env:
+          E2E_BASE_URL: http://localhost:4173
+        run: |
+          npx playwright install --with-deps chromium
+          npm run e2e
+
+      - name: Upload the report of Playwright
+        if: failure()
+        uses: actions/upload-artifact@v4
+        with:
+          name: playwright-report
+          path: |
+            ${{ env.BS_BASE_DIR }}/frontend/playwright-report/
+            ${{ env.BS_BASE_DIR }}/frontend/test-results/
+            ${{ runner.temp }}/backend.log
+            ${{ runner.temp }}/frontend.log
+          retention-days: 7

bazis_front-0.1.0/.github/workflows/update-licenses.yml

@@ -0,0 +1,18 @@
+name: Update Licenses
+
+on:
+  push:
+    branches:
+      - main
+    paths:
+      - '**.py'
+      - 'pyproject.toml'
+
+permissions:
+  contents: write
+
+jobs:
+  update-licenses:
+    uses: ecofuture-tech/.github/.github/workflows/reusable-update-licenses.yml@main
+    secrets:
+      WORKFLOW_LICENSE_TOKEN: ${{ secrets.WORKFLOW_LICENSE_TOKEN }}

bazis_front-0.1.0/.gitignore

@@ -0,0 +1,54 @@
+.idea
+.ipynb_checkpoints
+.mypy_cache
+.vscode
+__pycache__
+.pytest_cache
+htmlcov
+dist
+site
+.coverage
+coverage.xml
+.netlify
+test.db
+log.txt
+Pipfile.lock
+env3.*
+env
+docs_build
+venv
+.venv
+docs.zip
+archive.zip
+
+.env
+local.env
+*/.env*
+
+# vim temporary files
+*~
+.*.sw?
+*.DS_Store
+
+*.egg-info
+build
+dist
+
+docs/_autosummary
+docs/_build
+*.DS_Store
+*.log
+my-*
+My*
+*/**/_version.py
+/uv.lock
+
+# Node tooling of the assets (dev-only)
+node_modules/
+coverage/
+*.tsbuildinfo
+build/
+
+# Playwright runs of the helpers
+test-results/
+playwright-report/