Skip to content

Latest commit

 

History

History
296 lines (222 loc) · 11.9 KB

README.md

File metadata and controls

296 lines (222 loc) · 11.9 KB
Raw

A2J - Digitale Rechtsantragstelle

First draft of implementing a platform to create requests to the Rechtsantragstelle.

interactive code map

Development

Requirements

  • Node.js >= 20.0.0
  • Docker (Redis dependency)
  • npm 7 or greater
  • strapi (see below)

Strapi

Three options:

  1. A local strapi instance:

    • Start strapi locally,
    • configure .env with CMS=STRAPI and STRAPI_API pointing to your local strapi instance (cp .env.example .env should do the trick)

  2. Using the the deployed staging strapi instance:

    • Set STRAPI_API=<STRAPI_STAGING_URL>/api and set STRAPI_ACCESS_KEY to your token (create a new key in the strapi GUI at "Settings" > "API Tokens" > "Create new API Token")

  3. Use a local content file:

    • Set STRAPI_API and STRAPI_ACCESS_KEY to point to staging like in option 2.
    • Set CMS=FILE
    • Run npm run build:localContent (should have generated a content.json file)
Locales

For each Strapi page, there are two locales: Staging (sg) and Production (de). This is because while we're able to feature flag code changes in PostHog, we aren't able to feature flag content changes in the CMS. E.g. If we want to test out content changes, like different components on the same page, we must use Strapi's Locale feature, as Multi-Environments is only supported by Strapi Cloud.

The App first checks to see if valid staging data exists, and if not, pull the requested data from the production environment. By default, we develop features in the Production environment.

Run Server in Development Mode

npm install
docker compose up -d
npm run dev

This starts your app in development mode, rebuilding assets on file changes. Open the app in localhost:3000

Tests

Unit tests

  • run: npm run test
  • run in watch mode: npm run test:watch
  • run with coverage: npm run test:coverage
  • run subset: npm run test -- -t "STRING_TO_MATCH"

E2E tests

  • run: npm run test:e2e
  • UI: npx playwright test --ui
  • debug (F10 to step over): npx playwright test --debug

Note

Remember to install playwright cli and set the environment variable GERICHTSFINDER_ENCRYPTION_KEY.

Write E2E tests

Debug E2E tests in CI

  1. download playwright-report.zip artifact from GitHub action summary page (only present on e2e failure for 30 days)
  2. unzip
  3. npx playwright show-trace <DOWNLOAD_PATH>/data/<HASH>.zip

Git Hooks

We use lefthook for running several pre-commit hooks,install them using npm run init.

The git hooks check formatting, linting, unit tests, typecheck (see lefthook.yaml for more details). You may execute them before commiting using lefthook run pre-commit.

How to add a new "Antrag" or form pdf to services/pdf/

  1. Create a new folder for example: prozesskostenhilfe
  2. Store the antrag or form pdf there: prozesskostenhilfe/Erklaerung_Verhaeltnisse_Prozess_oder_Verfahrenskostenhilfe.pdf
  3. Run npm run build:pdf

After running the command, a new file named prozesskostenhilfe.generated.ts will be generated in the specified directory. You can use this file to fill out the PDF based on the input fields defined within it.

How to add a new Array page to a form flow (UNDER CONSTRUCTION)

(This section is still under construction, as there are still open questions about what the generic array case is [or should be] and how to document it) Form flow arrays should, generally speaking, be defined like the following inside of flow.json:

"<Plural name>": {
   "initial": "<Plural name>-frage",
   "states": {
      "<Plural name>-frage": {
         "on":
            {
            "SUBMIT": [
               {
                  "guard": "hasOther<Plural name>",
                  "target": "uebersicht"
               }
            ],
            "BACK": "<Previous step>"
         }
      },
      "uebersicht": {
         "on": {
            "SUBMIT": [
               {
                  "guard": "hasOther<Plural name>AndEmptyArray",
                  "target": "warnung"
               }
            ],
            "BACK": "<Plural name>-frage",
            "add-<Plural name>": {
               "guard": "isValid<Plural name>ArrayIndex",
               "target": "<Singular name>"
            }
         }
      },
      "warnung": {
         "on": {
            "BACK": "uebersicht",
            "SUBMIT": "<Next Step>"
         }
      },
      "<Singular name>": {
         "initial": "daten",
         "states": {
            "daten": {
               "on": {
                  "BACK": "#<Plural name>.uebersicht",
                  "SUBMIT": "#<Plural name>.uebersicht"
               }
            }
         }
      }
   }
}

Note the following:

  • The step begins with a ____-frage step, usually a yes/no radio page, indicating whether or not to show the ArraySummary page at all. E.g. "Do you have any additional income you would like to report?"
  • The uebersicht page is the ArraySummary, which will display all the items the user has added, along with an "Add item" button
  • warnung is necessary as a type of form validation, to ensure that the user has entered >= 1 item (actual form validation would be tricky here, so displaying a warning to the user is the next best thing)
  • Finally, the <Singular name> step is basically a placeholder for the data entered per item (daten), so that the url reads as <Singular name>/<item number>/daten e.g. arbeitsausgabe/0/daten

After these steps have been entered in flow.json, we need to define the matching ArrayConfig in index.ts of the respective flow:

config: _.merge(<flow>, {
   meta: {
      arrays: {
         <Plural name>: {
            url: "/<flowId>/<stepId>/<Plural name>/<Singular name>",
            initialInputUrl: "daten",
            event: "add-<Plural name>",
         },
      } satisfies Partial<Record<AllContextKeys, ArrayConfig>>,
   }
})

(If multiple ArrayConfigs are being added, it might be sensible to add them to an arrayConfigurations.ts file and spread them in)

Data Flow

sequenceDiagram

box Backend
participant Loader
participant CMS
participant Validation
end

box Frontend
participant PageComponent
participant StrapiComponent
participant AppComponent
end

Loader->>CMS: Fetch data (REST / JSON file lookup)
CMS-->>Loader: CMS Data (JSON)
Loader->>Validation: zod.validate()
Validation-->>Loader: typed StrapiData
Loader->>PageComponent: Remix (json({content}) -> useLoaderData)
PageComponent->>StrapiComponent: Typed Strapi Data (Prop drilling)
StrapiComponent->>AppComponent: sanatize & map
AppComponent->>StrapiComponent: JSX Element(s)
StrapiComponent->>PageComponent: JSX Element(s)
Loading

Deployment

App and content are deployed seperately from each other. Refer to the following flow chart:

flowchart TD

    classDef e2eTest fill:#f56
    classDef deploy fill:#f96
    classDef artifact fill:#3f6

    subgraph registry
        latest_published_app([App image: a2j-rechtsantragstelle-app]):::artifact
        latest_published_content([Content image: a2j-rechtsantragstelle-content]):::artifact
        latest_published_prod([Production image: a2j-rechtsantragstelle]):::artifact
    end

    subgraph app-release
    commit_to_main[New commit to main] --> app_e2e
    app_e2e{{E2E test: new app and released content}}:::e2eTest --> build_app_container
    build_app_container -.push to registry.-> latest_published_app

    build_app_container[Build & publish app container] --> build_prod_container_with_new_app
    build_prod_container_with_new_app[Build & publish prod container] -.push to registry.-> latest_published_prod
    end

    subgraph content-release
    publish_content['Publish' button on strapi] --> content_e2e
    latest_published_app -.fetch image.-> content_e2e
    content_e2e{{E2E test: new content and released app}}:::e2eTest --> build_content_container
    build_content_container[Build & publish content container] -.push to registry.-> latest_published_content
    build_content_container --> build_prod_container_with_new_content
    build_prod_container_with_new_content[Build & publish prod container] -.push to registry.-> latest_published_prod
    end

    subgraph deployment
    latest_published_prod -.fetch image.-> deploy_to_staging:::deploy
    build_prod_container_with_new_app --> deploy_to_staging[Deploy to staging]
    build_prod_container_with_new_app --> deploy_to_preview:::deploy
    latest_published_content -.fetch image.-> app_e2e
    latest_published_prod -.fetch image.-> deploy_to_preview
    build_prod_container_with_new_content --> deploy_to_preview
    deploy_to_preview[Deploy to preview] --> e2e_against_preview
    e2e_against_preview{{E2E against preview}}:::e2eTest --> deploy_to_production
    latest_published_prod -.fetch image.-> deploy_to_production:::deploy
    deploy_to_production[Deploy to production] --> production_check[Verify production deploy]

    end
Loading

Storybook

We have a storybook instance running. On the Staging and preview environments it can be accessed via /storybook. In development mode, run the npm run start:storybook command.

Data update

License

npm run build:licenses

Airport

npm run build:airports-data

Airline

npm run build:airlines-data "AIRLINE_FILE_PATH"

The AIRLINE_FILE_PATH corresponds to the file that contains airlines data that will be transformed into json via the build:airlines-data task. For more information, please contact the maintainers of this repository.

Contributions Welcome!

🇬🇧 Everyone is welcome to contribute to the development of Zugang zu Recht - Access to Justice - A2J. You can contribute by opening pull requests, providing documentation, answering questions or giving feedback. Please do follow our guidelines and our Code of Conduct.

🇩🇪 Jede:r ist herzlich eingeladen, die Entwicklung von Zugang zu Recht - Access to Justice - A2J mitzugestalten. Du kannst einen Beitrag leisten, indem du Pull-Requests eröffnest, die Dokumentation erweiterst, Fragen beantwortest oder Feedback gibst. Bitte befolge die Richtlinien und unseren Verhaltenskodex.

Code Contributions

🇬🇧 Open a pull request with your changes, and it will be reviewed by someone from the team. When you submit a pull request, you declare that you have the right to license your contribution to DigitalService and the community. By submitting the patch, you agree that your contributions are licensed under the MIT License.

Please make sure that your changes have been tested before submitting a pull request.

🇩🇪 Nach dem Erstellen eines Pull Requests wird dieser von einer Person aus dem Team überprüft. Wenn du einen Pull Request einreichst, erklärst du dich damit einverstanden, deinen Beitrag an den DigitalService und die Community zu lizenzieren. Durch das Einreichen des Patches erklärst du dich damit einverstanden, dass deine Beiträge unter der MIT License lizenziert sind.

Bitte stelle sicher, dass deine Änderungen getestet wurden bevor du einen Pull Request sendest.