City-of-Helsinki/update-asuntomyynti-react-local-dev

Update Asuntomyynti React (Local Dev)

Quick context

• React app: asuntomyynti-react/
• Drupal module: drupal-asuntotuotanto/public/modules/custom/asu_apartment_search/
• React dev server uses yarn start (Node 16 recommended if export errors occur).
• Drupal module updates are Composer-driven (root composer.json + composer.lock, then composer install).

Update workflow (React)

1. Ensure Node 16 if you hit: Package subpath './lib/tokenize' is not defined by "exports" ...
   • nvm install 16.0
2. Install dependencies:
   • yarn
3. Update dist build:
   • Preferred: make asuntomyynti-react-rebuild-dist
   • Or manually: nvm use 16; yarn dist;
   • If you run into errors, fix them and tell the human what you did
   • Ensure compose-dev.yaml mounts asuntomyynti-react/dist as /asuntomyynti-react.

Drupal module update workflow (Composer)

1. Update asuntomyynti-react/package.json version number.
2. Update the asuntomyynti-react package version in root composer.json.
3. Update composer.lock accordingly.
4. Run:
   • composer install
5. Confirm the built React assets are updated in the Drupal module.

Composer package paths

Use the local dist zip path in both files.

composer.json:

"package": {
  "name": "asuntomyynti/react",
  "version": "<VERSION>",
  "dist": {
    "url": "/asuntomyynti-react/asuntomyynti-react-<VERSION>.zip",
    "type": "zip"
  }
}

composer.lock:

{
  "name": "asuntomyynti/react",
  "version": "<VERSION>",
  "dist": {
    "type": "zip",
    "url": "ZIP FILE PATH IN dist/"
  },
  "type": "library"
}

Filters and query alignment

• When modifying filter behavior, ensure query params match /elasticsearch expectations.
• Keep project apartment widget filters aligned with the Drupal module’s documented filters.

Verification checklist

• yarn start runs locally without errors.
• Widget renders and filters apply correctly.
• Local /elasticsearch queries return expected results.
• Drupal module assets are refreshed after composer install.

If updates are not visible

1. Check the served module asset (note the path):
   • /modules/custom/asu_apartment_search/assets/react/hitas/asu_react_main.js
2. If the module asset is stale, ensure the dist mount is visible in the container:
   • /asuntomyynti-react should contain the zip from dist/.
   • If empty, restart the stack: make asuntomyynti-react-restart-dev
3. Force reinstall in container:
   • Preferred: make asuntomyynti-react-force-reinstall
4. For a quick sync/debug check, run:
   • make asuntomyynti-react-check-sync

Example triggers

• “Update asuntomyynti-react to the latest release locally.”
• “Rebuild the React widget used by asu_apartment_search.”
• “Adjust project apartments filters in local dev.”