Refactor: relocate assets from mbed to FileSystem (#541)

Co-authored-by: mirkoCrobu <mirkocrobu@NB-0531.localdomain>
Co-authored-by: Alessio Perugini <alessio@perugini.xyz>

Author: 3 people

.gitignore

@@ -34,4 +34,4 @@ build/
 /arduino-app-cli
 /apps
 # temporary staging directories
-/debian/arduino-app-cli/home/
+/debian/arduino-app-cli/home/arduino/.local/share/arduino-app-cli/examples

README.md

@@ -252,7 +252,7 @@ The orchestrator will write apps in `~/ArduinoApps` folder, and examples in `~/.
 To override the path provide the following flags:
 
 - `ARDUINO_APP_CLI__APPS_DIR`
-- `ARDUINO_APP_CLI__DATA_DIR`
+- `ARDUINO_APP_CLI__CONFIG_DIR`
 
 ### App folder and persistent data
 

Taskfile.yml

@@ -107,13 +107,13 @@ tasks:
           set -e
           echo "Runner version set as: {{ .EXAMPLE_VERSION }}"
           TMP_PATH="$(mktemp -d)"
-          DEST_PATH="debian/arduino-app-cli/home/arduino/.config/arduino-app-cli/"
+          DEST_PATH="debian/arduino-app-cli/home/arduino/.local/share/arduino-app-cli/"
           echo "Cloning bcmi-labs/app-bricks-example into temporary directory ${TMP_PATH}..."
           git clone --depth 1 --branch "{{ .EXAMPLE_VERSION }}" https://github.com/bcmi-labs/app-bricks-example "${TMP_PATH}"
-          rm -rf "${DEST_PATH}"
+          rm -rf "${DEST_PATH}/examples"
           mkdir -p "${DEST_PATH}"
           mv "${TMP_PATH}/examples" "${DEST_PATH}"
-          rm -rf "${TMP_PATH}"
+          rm -rf "${TMP_PATH}/examples"
           echo "Examples successfully cloned."
     silent: false
 
@@ -333,7 +333,8 @@ tasks:
       - |
           tmpdir="${TMPDIR:-/tmp}"
           semver_tag={{.RUNNER_VERSION}}
-          DST_DIR=internal/orchestrator/assets/static/"${semver_tag}"
+          ROOT_DEST_DIR=debian/arduino-app-cli/home/arduino/.local/share/arduino-app-cli/assets
+          DST_DIR="${ROOT_DEST_DIR}/${semver_tag}"
           if [ -d "$DST_DIR" ]; then
             exit 0
           fi
@@ -342,8 +343,8 @@ tasks:
           ZIP_NAME="$tmpdir"/arduino_app_bricks-"${semver_tag}"-py3-none-any.whl
           OUTPUT_DIR="${tmpdir}/${semver_tag}"
           unzip -o "$ZIP_NAME" -d "$OUTPUT_DIR"
-          rm -rf "internal/orchestrator/assets/static"
-          mkdir -p "internal/orchestrator/assets/static"
+          rm -rf "$ROOT_DEST_DIR"
+          mkdir -p "$ROOT_DEST_DIR"
           mv "$OUTPUT_DIR"/arduino/app_bricks/static "$DST_DIR"
           rm -r "$OUTPUT_DIR" "$ZIP_NAME"
           # Bumps the default pinned latest base python image tag

cmd/arduino-app-cli/app/start.go

@@ -44,6 +44,7 @@ func startHandler(ctx context.Context, cfg config.Configuration, app app.Arduino
 		servicelocator.GetBricksIndex(),
 		app,
 		cfg,
+		servicelocator.GetStaticStore(),
 	)
 	for message := range stream {
 		switch message.GetType() {

cmd/arduino-app-cli/daemon/daemon.go

@@ -55,6 +55,7 @@ func NewDaemonCmd(cfg config.Configuration, version string) *cobra.Command {
 					servicelocator.GetBricksIndex(),
 					servicelocator.GetAppIDProvider(),
 					cfg,
+					servicelocator.GetStaticStore(),
 				)
 				if err != nil {
 					slog.Error("Failed to start default app", slog.String("error", err.Error()))

cmd/arduino-app-cli/internal/servicelocator/servicelocator.go

@@ -35,39 +35,18 @@ var (
 	runnerVersion = "0.1.16"
 
 	GetBricksIndex = sync.OnceValue(func() *bricksindex.BricksIndex {
-		var bIndex *bricksindex.BricksIndex
-		if GetProvisioner().IsUsingDynamicProvision() {
-			dynamicProvisionDir := GetProvisioner().DynamicProvisionDir()
-			bIndex = f.Must(bricksindex.GenerateBricksIndexFromFile(dynamicProvisionDir))
-		} else {
-			bricksIndexContent := f.Must(GetStaticStore().GetBricksListFile())
-			defer bricksIndexContent.Close()
-			bIndex = f.Must(bricksindex.LoadBricksIndex(bricksIndexContent))
-		}
-		return bIndex
+		return f.Must(bricksindex.GenerateBricksIndexFromFile(GetStaticStore().GetAssetsFolder()))
 	})
 
 	GetModelsIndex = sync.OnceValue(func() *modelsindex.ModelsIndex {
-		var mIndex *modelsindex.ModelsIndex
-		if GetProvisioner().IsUsingDynamicProvision() {
-			dynamicProvisionDir := GetProvisioner().DynamicProvisionDir()
-			mIndex = f.Must(modelsindex.GenerateModelsIndexFromFile(dynamicProvisionDir))
-		} else {
-			modelsIndexContent := f.Must(GetStaticStore().GetModelsListFile())
-			defer modelsIndexContent.Close()
-			mIndex = f.Must(modelsindex.LoadModelsIndex(modelsIndexContent))
-		}
-		return mIndex
+		return f.Must(modelsindex.GenerateModelsIndexFromFile(GetStaticStore().GetAssetsFolder()))
 	})
 
 	GetProvisioner = sync.OnceValue(func() *orchestrator.Provision {
-		pythonImage, usedPythonImageTag := getPythonImageAndTag()
-		slog.Debug("Using pythonImage", slog.String("image", pythonImage))
-
+		pythonImage, _ := getPythonImageAndTag()
 		return f.Must(orchestrator.NewProvision(
 			GetDockerClient(),
-			GetStaticStore(),
-			usedPythonImageTag != runnerVersion,
+			shouldUseDynamicProvisioning(),
 			pythonImage,
 		))
 	})
@@ -102,7 +81,13 @@ var (
 	})
 
 	GetStaticStore = sync.OnceValue(func() *store.StaticStore {
-		return store.NewStaticStore(runnerVersion)
+		var baseDir string
+		if GetProvisioner().IsUsingDynamicProvision() {
+			baseDir = GetProvisioner().DynamicProvisionDir().String()
+		} else {
+			baseDir = globalConfig.AssetsDir().Join(runnerVersion).String()
+		}
+		return store.NewStaticStore(baseDir)
 	})
 
 	GetBrickService = sync.OnceValue(func() *bricks.Service {
@@ -136,3 +121,9 @@ func getPythonImageAndTag() (string, string) {
 	}
 	return pythonImage, usedPythonImageTag
 }
+
+func shouldUseDynamicProvisioning() bool {
+	pythonImage, usedPythonImageTag := getPythonImageAndTag()
+	slog.Debug("Using pythonImage", slog.String("image", pythonImage))
+	return usedPythonImageTag != runnerVersion
+}

debian/arduino-app-cli/DEBIAN/postinst

@@ -1,5 +1,6 @@
 #!/bin/sh
 
-chown -R arduino:arduino /home/arduino/.config/arduino-app-cli/examples
+chown -R arduino:arduino /home/arduino/.config/arduino-app-cli
+chown -R arduino:arduino /home/arduino/.local/share/arduino-app-cli
 
 systemctl enable arduino-app-cli

debian/arduino-app-cli/home/arduino/.local/share/arduino-app-cli/assets/0.1.16/api-docs/arduino/app_bricks/air_quality_monitoring/API.md

@@ -0,0 +1,192 @@
+# air_quality_monitoring API Reference
+
+## Index
+
+- Class `AQILevel`
+- Class `AirQualityData`
+- Class `AirQualityMonitoring`
+- Class `AirQualityLookupError`
+
+---
+
+## `AQILevel` dataclass
+
+```python
+class AQILevel()
+```
+
+Data class to represent AQI levels.
+
+### Attributes
+
+- **min_value** (*int*): Minimum AQI value for the level.
+- **max_value** (*int*): Maximum AQI value for the level.
+- **description** (*str*): Description of the AQI level.
+- **color** (*str*): Color associated with the AQI level in hex.
+
+
+---
+
+## `AirQualityData` dataclass
+
+```python
+class AirQualityData()
+```
+
+Data class to represent air quality data.
+
+### Attributes
+
+- **city** (*str*): Name of the city.
+- **lat** (*float*): Latitude of the city.
+- **lon** (*float*): Longitude of the city.
+- **url** (*str*): URL for more information about the air quality data.
+- **last_update** (*str*): Last update timestamp of the air quality data.
+- **aqi** (*int*): Air Quality Index value.
+- **dominantpol** (*str*): Dominant pollutant in the air.
+- **iaqi** (*dict*): Individual AQI values for various pollutants.
+
+### Methods
+
+#### `AirQualityData.pandas_dict()`
+
+Return the data as a dictionary suitable for pandas DataFrame.
+
+
+---
+
+## `AirQualityMonitoring` class
+
+```python
+class AirQualityMonitoring(token: str)
+```
+
+Class to get air quality data from AQICN API.
+
+### Parameters
+
+- **token** (*str*): API token for AQICN service.
+
+### Raises
+
+- **ValueError**: If the token is not provided.
+
+### Methods
+
+#### `AirQualityMonitoring.get_air_quality_by_city(city: str)`
+
+Get air quality data by city name.
+
+##### Parameters
+
+- **city** (*str*): Name of the city.
+
+##### Returns
+
+- (*AirQualityData*): Air quality assembled data.
+
+##### Raises
+
+- **AirQualityLookupError**: If the API request fails.
+
+#### `AirQualityMonitoring.get_air_quality_by_coords(latitude: float, longitude: float)`
+
+Get air quality data by coordinates.
+
+##### Parameters
+
+- **latitude** (*float*): Latitude.
+- **longitude** (*float*): Longitude.
+
+##### Returns
+
+- (*AirQualityData*): Air quality assembled data.
+
+##### Raises
+
+- **AirQualityLookupError**: If the API request fails.
+
+#### `AirQualityMonitoring.get_air_quality_by_ip()`
+
+Get air quality data by IP address.
+
+##### Returns
+
+- (*AirQualityData*): Air quality assembled data.
+
+##### Raises
+
+- **AirQualityLookupError**: If the API request fails.
+
+#### `AirQualityMonitoring.process(item: dict)`
+
+Process the input dictionary to get air quality data.
+
+##### Parameters
+
+- **item** (*dict*): Input dictionary containing either 'city', 'latitude' and 'longitude', or 'ip'.
+
+##### Returns
+
+- (*dict*): Air quality data.
+
+##### Raises
+
+- **ValueError**: If the input dictionary is not valid.
+
+#### `AirQualityMonitoring.assemble_data(data: dict)`
+
+Create a payload for the air quality data.
+
+##### Parameters
+
+- **data** (*dict*): Air quality data.
+
+##### Returns
+
+- (*dict*): Payload with relevant air quality information.
+
+#### `AirQualityMonitoring.map_aqi_level(aqi: int)`
+
+Returns AQILevel class matching provided AQI.
+
+
+---
+
+## `AirQualityLookupError` class
+
+```python
+class AirQualityLookupError(message: str, status: str)
+```
+
+Custom exception for air quality lookup errors.
+
+### Parameters
+
+- **message** (*str*): Error message.
+- **status** (*str*): Status of the error, defaults to None.
+
+### Methods
+
+#### `AirQualityLookupError.from_api_response(cls, data: dict)`
+
+AirQualityLookupError error handling based on response provided by AQI API.
+
+Documented errors:
+- {"status": "error", "data": "Invalid key"}
+- {"status": "error", "data": "Unknown station"}
+- {"status": "error", "data": "Over quota"}
+- {"status": "error", "data": "Invalid query"}
+- {"status": "error", "data": "Too Many Requests"}
+- {"status": "error", "data": "IP not allowed"}
+- {"status": "error", "data": "Unknown error"}
+- {"status": "error", "data": {"message": "..."}}
+
+##### Parameters
+
+- **data** (*dict*): Response data from the AQI API.
+
+##### Returns
+
+- (*AirQualityLookupError*): An instance of AirQualityLookupError with the error message and status.
+