Compare commits

...
49 Commits
Author SHA1 Message Date
ari ba13c281d2 stylinh 2022-08-18 11:54:36 -04:00
ari 9184d1f7bd better repeat error parsing 2022-08-18 11:49:42 -04:00
ari f8f6d74d6a elipses 2022-08-18 11:21:51 -04:00
ari 819a76f8e3 minor ui tweaks 2022-08-18 11:01:45 -04:00
ari a391eae7c5 sync'd up 2022-08-18 10:50:11 -04:00
ari 7cb1a5d907 additional api refactor 2022-08-18 10:19:17 -04:00
ari 8792ed6ed8 displaying source file 2022-08-16 21:14:10 -04:00
ari 9bafbf4e8c removed upsert 2022-08-16 20:48:13 -04:00
ari c67d1bd32f - refactor for multi-config suport done
- added better errror captures
2022-08-16 11:40:30 -04:00
ari 55ea1e23a4 backend modified 2022-08-15 21:56:48 -04:00
ari d96c1fb953 tags 2022-08-15 21:23:51 -04:00
ari f8b59c6b17 tags 2022-08-15 19:50:24 -04:00
ari 02cbacabe0 clean up 2022-08-15 15:46:58 -04:00
ari b0d924f63a using sync process 2022-08-15 15:43:18 -04:00
ari 7aadfbc175 initial manager work 2022-08-14 16:50:58 -04:00
ari 08af01dd11 config watcher 2022-08-14 15:31:42 -04:00
ari 586f52ba56 rapid changes 2022-08-14 01:26:11 -04:00
ari e11f4deab5 watching folders 2022-08-14 01:07:19 -04:00
ari 579017d9ec automation path loader 2022-08-14 01:00:19 -04:00
ari a746c4db3a testing loader 2022-08-14 00:41:05 -04:00
ari 3a89fe5efc v2 initial work 2022-08-14 00:24:44 -04:00
ari 2bc7e11bb1 clean up 2022-08-08 21:24:24 -04:00
ari e6a835a5f3 minor clean up 2022-08-08 20:53:31 -04:00
ari 107def4fac fixed up calednar 2022-08-07 21:45:11 -04:00
ari 6b21734041 added scene support 2022-08-06 22:43:56 -04:00
ari 754cc2ef98 added more support for trigger types 2022-08-06 22:37:26 -04:00
ari 1cb40288b1 remove state for zone 2022-08-06 20:41:02 -04:00
ari 129ba28ff5 v0.5.3 2022-08-06 20:28:09 -04:00
Ari Sosnovsky 44e246f79b Update README.md 2022-08-06 20:22:34 -04:00
ari 8bcbcaa801 added a redirect 2022-08-06 20:03:10 -04:00
ari b479476833 fixed up invalid node issue 2022-08-06 15:29:41 -04:00
Przemysław Adam Sowa baa31ab649 Don't use network host mode in the example docker-compose.yaml (#128) 2022-08-06 14:20:27 -04:00
Ari Sosnovsky dc7c6273e4 Update README.md 2022-08-06 13:16:34 -04:00
Ari Sosnovsky 2942b6173b Update README.md 2022-08-05 23:41:46 -04:00
ari bcfc648011 controls 2022-08-05 23:35:47 -04:00
ari 084d86ad7a fixed up build 2022-08-05 23:12:48 -04:00
ari ea6be4a8f3 infinte undo 2022-08-05 23:08:00 -04:00
ari 14649ac1fd added dial 2022-08-05 22:54:17 -04:00
ari f1b99cad1c trigger automation in metadata 2022-08-05 22:22:28 -04:00
ari ab7f50d4aa fixed trigger device validation 2022-08-05 22:04:31 -04:00
ari d22bba8c4d moving things around 2022-08-05 22:04:31 -04:00
ari 549f52655b refactor inputs 2022-08-05 22:04:31 -04:00
renovate[bot] 2c5d64ab86 Update dependency jss to v10.9.2 (#119)
Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
2022-08-02 15:09:24 -04:00
renovate[bot] 7c50c345ec Update dependency react-jss to v10.9.2 (#120)
Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
2022-08-02 15:09:13 -04:00
ari f4261f9701 better tag edit viz 2022-08-02 12:51:22 -04:00
ari 34826acb97 v0.5.1 2022-07-31 23:34:11 -04:00
ari cd1b4e8e2b ensuring scroll 2022-07-31 22:22:21 -04:00
ari 2b4c64c94b added ignore 2022-07-29 21:43:27 -04:00
ari 067f5fa642 added delay to save 2022-07-29 21:42:50 -04:00
196 changed files with 4548 additions and 2492 deletions

No files matched your search

+25
View File
@@ -1,5 +1,30 @@
# Changelog ![GitHub release (latest by date)](https://img.shields.io/github/v/release/asosnovsky/Shortumation?label=&style=for-the-badge)
## [0.5.3] - Bug Fixes
- Redirecting `/` to `/web` to resolve container install strangeness reported in https://github.com/asosnovsky/Shortumation/issues/125
- Fixed missing flag that caused the automation to explode in https://github.com/asosnovsky/Shortumation/issues/124
## [0.5.2] - Better Controls
- Add automation trigger
- Speed dial on the bottom
<img src="https://user-images.githubusercontent.com/7451445/183231968-9891bbb4-5c7c-4e05-b804-36978c809a5c.png" width="200px"/>
- Infinite undos <img src="https://user-images.githubusercontent.com/7451445/183231977-ed000017-2886-4a57-b5fb-c7e527bf3894.png" width="200px"/>
## [0.5.1] - Sidebar!
- completely redesigned the sidebar!
- Disable/enable automatons
- See 'bad state' automatons
- Delete automatons from registry (in cases where references are stale)
- Refactored sidebar UX to match MUI standards
- Cleaned up editing tags in sidebar
<img src="https://user-images.githubusercontent.com/7451445/182066721-07a93651-2f83-44d5-8420-15093caa52df.png" width="400px"/>
- Websockets now live-refresh when updates occur
## [0.4.0] - Depedency update
- Core dependency updates
+8 -4
View File
@@ -1,4 +1,4 @@
# Shortumation ![GitHub release (latest by date)](https://img.shields.io/github/v/release/asosnovsky/Shortumation?label=&style=platsic)
# <img src="logo.png" height="40x"/> Shortumation ![GitHub release (latest by date)](https://img.shields.io/github/v/release/asosnovsky/Shortumation?label=&style=platsic)
[![Test](https://github.com/asosnovsky/Shortumation/actions/workflows/test.yml/badge.svg)](https://github.com/asosnovsky/Shortumation/actions/workflows/test.yml) [![Build](https://github.com/asosnovsky/Shortumation/actions/workflows/build.yml/badge.svg)](https://github.com/asosnovsky/Shortumation/actions/workflows/build.yml)
@@ -6,7 +6,9 @@
| ------- | ------------------------------------------------------------------------------------------------------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------- |
| Version | ![GitHub release (latest by date)](https://img.shields.io/github/v/release/asosnovsky/Shortumation?label=&style=for-the-badge) | ![Docker Image Version (latest semver)](https://img.shields.io/docker/v/asosnovsky/shortumation-amd64?&sort=date&label=&style=for-the-badge) |
A [home-assistant addon](https://www.home-assistant.io/addons/) for a better UI for managing and writing your automations. We provide a way to visualize your automation using a visual-programming language that draws inspirations from [Node-Red](https://nodered.org/).
A [home-assistant addon](https://www.home-assistant.io/addons/) for a better UI for managing and writing your automations. We provide a way to visualize your automation using a visual-programming language that draws inspirations from [Node-Red](https://nodered.org/).
<img src="./assets/comparisons.png">
## Features
@@ -46,12 +48,14 @@ Add the repository URL under **Supervisor → Add-on store → ⋮ → Manage ad
It should now appear in your `Add-on Store` and you should be able to install it!
**Please note that you may need to enable advance mode in your settings first!**
### Containerized or HA Core
Please note that this way of using Shortumation is **not future proof**.
If this warning does not scare you or you still want to try things out, then take a look at the example [docker-compose.yaml](example/containerized/docker-compose.yaml), or read the [extended guide here](https://github.com/asosnovsky/Shortumation/wiki/Installation#containerized--ha-core).
In general, if you want to help provide this to more home-assistant fans please join on the conversation here https://github.com/asosnovsky/Shortumation/issues/102 or help contribute :)
## FAQ
**How is this different from Node-Red?**
-3
View File
@@ -1,3 +0,0 @@
LOG_LEVEL=DEBUG
SUPERVISOR_TOKEN=eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiI2ZjJiYzM2MjkyOWM0OGM1Yjg1NzgxNDEzNTRkNDk0NSIsImlhdCI6MTY1OTExMTExMCwiZXhwIjoxOTc0NDcxMTEwfQ.Q5Ei1a9BXyB4-whrPGoko6CKavOOloFC1fbP-jAYBpU
HASSIO_WS=ws://homeassistant:8123/api/websocket
+5 -10
View File
@@ -1,12 +1,7 @@
{
"python.formatting.provider": "black",
"python.testing.unittestArgs": [
"-v",
"-s",
"./tests",
"-p",
"*test_*.py"
],
"python.testing.pytestEnabled": false,
"python.testing.unittestEnabled": true
"python.formatting.provider": "black",
"python.testing.unittestArgs": ["-v", "-s", "./tests", "-p", "*test_*.py"],
"python.testing.pytestEnabled": false,
"python.testing.unittestEnabled": true,
"python.envFile": "${workspaceFolder}/development_config/.env"
}
+19 -14
View File
@@ -1,14 +1,19 @@
list_autos # unused function (/home/ari/Projects/Shortumation/api/src/api/routes/automations.py:17)
upsert_auto # unused function (/home/ari/Projects/Shortumation/api/src/api/routes/automations.py:28)
delete_auto # unused function (/home/ari/Projects/Shortumation/api/src/api/routes/automations.py:32)
read_details # unused function (/home/ari/Projects/Shortumation/api/src/api/routes/details.py:10)
read_ping # unused function (/home/ari/Projects/Shortumation/api/src/api/routes/ping.py:10)
websocket_endpoint # unused function (/home/ari/Projects/Shortumation/api/src/api/routes/socket.py:9)
params # unused variable (/home/ari/Projects/Shortumation/api/src/api/types.py:18)
total_items # unused variable (/home/ari/Projects/Shortumation/api/src/api/types.py:19)
id # unused variable (/home/ari/Projects/Shortumation/api/src/automations/types.py:8)
alias # unused variable (/home/ari/Projects/Shortumation/api/src/automations/types.py:9)
description # unused variable (/home/ari/Projects/Shortumation/api/src/automations/types.py:10)
trigger_variables # unused variable (/home/ari/Projects/Shortumation/api/src/automations/types.py:11)
mode # unused variable (/home/ari/Projects/Shortumation/api/src/automations/types.py:12)
json_dumps # unused function (/home/ari/Projects/Shortumation/api/src/json_serializer.py:5)
get_index # unused function (src/api/app.py:43)
list_autos # unused function (src/api/routes/automations.py:12)
upsert_auto # unused function (src/api/routes/automations.py:24)
delete_auto # unused function (src/api/routes/automations.py:32)
read_details # unused function (src/api/routes/details.py:10)
read_ping # unused function (src/api/routes/ping.py:10)
websocket_endpoint # unused function (src/api/routes/socket.py:13)
params # unused variable (src/api/types.py:16)
total_items # unused variable (src/api/types.py:17)
data # unused variable (src/api/types.py:18)
trigger_variables # unused variable (src/automations/types.py:13)
trigger # unused variable (src/automations/types.py:15)
condition # unused variable (src/automations/types.py:16)
action # unused variable (src/automations/types.py:17)
_.to_json # unused method (src/automations/types.py:38)
_.automation_tags # unused property (src/hass_config/loader.py:18)
_.save_automations # unused method (src/hass_config/loader.py:48)
_.save_tags # unused method (src/hass_config/loader.py:56)
json_dumps # unused function (src/json_serializer.py:5)
+4 -1
View File
@@ -45,4 +45,7 @@ start-docker:
tar -xvf ../development_config.tar.gz -C ./
cp ./development_config/.env .env.api
docker-compose down
docker-compose up
docker-compose up
update-vulture-whitelist:
$(VENV_BIN)/vulture --make-whitelist src > .vulture_whitelist
+11 -1
View File
@@ -1,5 +1,6 @@
from fastapi import FastAPI
from fastapi.middleware.cors import CORSMiddleware
from fastapi.responses import RedirectResponse
from fastapi.staticfiles import StaticFiles
from src.automations.manager import AutomationManager
@@ -10,7 +11,8 @@ from .routes import automations, details, ping, socket
def make_app(automation_mgr: AutomationManager) -> FastAPI:
app = FastAPI()
if (ROOT_FOLDER / "web").exists():
has_web_folder = (ROOT_FOLDER / "web").exists()
if has_web_folder:
app.mount(
f"{API_PREFIX}/web",
StaticFiles(
@@ -19,6 +21,7 @@ def make_app(automation_mgr: AutomationManager) -> FastAPI:
),
name="web",
)
else:
print("WARN: could not find web folder")
app.add_middleware(
@@ -36,4 +39,11 @@ def make_app(automation_mgr: AutomationManager) -> FastAPI:
details.make_details_router(automation_mgr.hass_config), prefix=f"{API_PREFIX}/details"
)
app.include_router(socket.router, prefix=f"{API_PREFIX}/socket")
@app.get("/")
def get_index():
if has_web_folder:
return RedirectResponse("/web")
return RedirectResponse("/details")
return app
+24 -21
View File
@@ -1,43 +1,46 @@
from fastapi import APIRouter, HTTPException
from src.api.types import (
DeleteAutoRequest,
ListData,
ListParams,
UpdateAutoRequest,
UpdateTags,
)
from src.api.types import ListData, ListParams, UpdateTags
from src.automations.errors import FailedDeletion
from src.automations.manager import AutomationManager
from src.automations.types import AutomationData
from src.automations.types import Automation, ExtenededAutomation
from src.errors import ErrorSet
def make_automation_router(automations: AutomationManager) -> APIRouter:
router = APIRouter()
@router.post("/list")
def list_autos(body: ListParams) -> ListData[AutomationData]:
return ListData(
params=body,
totalItems=automations.get_total_items(),
data=automations.find(
offset=body.offset,
limit=body.limit,
),
)
def list_autos(body: ListParams) -> ListData[ExtenededAutomation]:
try:
automations.reload()
return ListData(
params=body,
totalItems=automations.count(),
data=automations.list(
offset=body.offset,
limit=body.limit,
),
)
except ErrorSet as err:
raise HTTPException(status_code=400, detail=err.gen_message())
@router.post("/item")
def upsert_auto(body: UpdateAutoRequest):
automations.update(body.index, body.data)
def insert_auto(body: Automation):
automations.create(body)
@router.put("/item")
def update_auto(body: ExtenededAutomation):
automations.update(body)
@router.post("/item/tags")
def update_tags(body: UpdateTags):
automations.update_tags(body.automation_id, body.tags)
@router.delete("/item")
def delete_auto(body: DeleteAutoRequest):
def delete_auto(body: ExtenededAutomation):
try:
automations.delete(body.index)
automations.delete(body)
except FailedDeletion as err:
return HTTPException(
status_code=400,
+5 -1
View File
@@ -2,6 +2,7 @@ from fastapi import APIRouter
from src.env import BUILD_VERSION, HASSIO_TOKEN, HASSIO_WS
from src.hass_config import HassConfig
from src.automations.loader import extract_automation_paths
def make_details_router(hass_config: HassConfig) -> APIRouter:
@@ -15,7 +16,10 @@ def make_details_router(hass_config: HassConfig) -> APIRouter:
"hassio_url": HASSIO_WS,
"config": hass_config.get_configuration_path(),
"tags": hass_config.get_automation_tags_path(),
"autos": hass_config.get_automation_path(),
"autos": {
config_key: auto_file
for config_key, auto_file in extract_automation_paths(hass_config)
},
}
return router
-11
View File
@@ -4,8 +4,6 @@ from pydantic import BaseModel
from pydantic.fields import Field
from pydantic.generics import GenericModel
from src.automations.types import ExtenededAutomationData
DataT = TypeVar("DataT")
@@ -20,15 +18,6 @@ class ListData(GenericModel, Generic[DataT]):
data: List[DataT]
class UpdateAutoRequest(BaseModel):
index: int = Field(description="Index of the automation to update")
data: ExtenededAutomationData
class UpdateTags(BaseModel):
automation_id: str = Field(description="Automation Id to update")
tags: Dict[str, str]
class DeleteAutoRequest(BaseModel):
index: int = Field(description="Index of the automation to update")
+116
View File
@@ -0,0 +1,116 @@
import base64
import json
import sqlite3
from contextlib import contextmanager
from pathlib import Path
from typing import Iterable, Iterator, List, Optional
from src.logger import get_logger
from .errors import DBDataError, DBError, DBNoAutomationFound, RepeatedAutomationId
from .types import ExtenededAutomation
logger = get_logger(__file__)
automations_tbl = "autos"
def encode_auto(auto: ExtenededAutomation) -> str:
return base64.b64encode(
json.dumps(auto.to_primitive(include_tags=True)).encode("utf-8")
).decode("utf-8")
def decode_auto(
auto_str: str, source_file: str, source_file_type: str, configuration_key: str
) -> ExtenededAutomation:
return ExtenededAutomation(
source_file=source_file,
source_file_type=source_file_type,
configuration_key=configuration_key,
**json.loads(base64.b64decode(auto_str.encode("utf-8")).decode("utf-8")),
)
class AutomationDBConnection:
def __init__(self, db_file: Path) -> None:
self.db_file = db_file
def reset(self):
self.db_file.unlink(missing_ok=True)
self.create_db()
@contextmanager
def get_cur(self) -> Iterator[sqlite3.Cursor]:
conn = sqlite3.connect(self.db_file)
cur = conn.cursor()
try:
yield cur
conn.commit()
except sqlite3.DatabaseError as err:
raise DBError(*err.args) from err
finally:
cur.close()
conn.close()
def create_db(self):
with self.get_cur() as cur:
cur.execute(
f"""
CREATE TABLE IF NOT EXISTS {automations_tbl} (
id TEXT NOT NULL PRIMARY KEY,
alias TEXT,
description TEXT,
mode TEXT NOT NULL,
source_file TEXT NOT NULL,
source_file_type TEXT NOT NULL,
configuration_key TEXT NOT NULL,
rest BLOB NOT NULL
);
"""
)
def insert_automations(self, automations: List[ExtenededAutomation]):
with self.get_cur() as cur:
for automation in automations:
try:
cur.execute(
f"""
INSERT INTO {automations_tbl} VALUES (
"{automation.id}",
"{automation.alias}",
"{automation.description}",
"{automation.mode}",
"{automation.source_file}",
"{automation.source_file_type}",
"{automation.configuration_key}",
"{encode_auto(automation)}"
);
""",
)
except sqlite3.IntegrityError as err:
raise RepeatedAutomationId(
f"automation id '{automation.id}' in '{automation.source_file}' was already seen before. Please check for duplicate automation ids in your files."
) from err
def get_automation(self, automation_id: str) -> ExtenededAutomation:
with self.get_cur() as cur:
cur.execute(
f'SELECT rest, source_file, source_file_type, configuration_key FROM {automations_tbl} WHERE id = "{automation_id}"'
)
objs = cur.fetchone()
if objs is None:
raise DBNoAutomationFound(automation_id)
[rest, source_file, source_file_type, configuration_key] = objs
return decode_auto(rest, source_file, source_file_type, configuration_key)
def list_automations(self, offset: int, limit: int) -> Iterable[ExtenededAutomation]:
with self.get_cur() as cur:
for [rest, source_file, source_file_type, configuration_key] in cur.execute(
f"SELECT rest, source_file, source_file_type, configuration_key FROM {automations_tbl} LIMIT {limit} OFFSET {offset}"
):
yield decode_auto(rest, source_file, source_file_type, configuration_key)
def count_automations(self) -> int:
with self.get_cur() as cur:
return cur.execute(f"SELECT count(id) FROM {automations_tbl}").fetchone()[0]
+20
View File
@@ -5,9 +5,29 @@ class AutomationLoaderException(Exception):
)
class AttemptingToOverwriteAnIncompatibleFileError(AutomationLoaderException):
pass
class InvalidAutomationFile(AutomationLoaderException):
pass
class FailedDeletion(AutomationLoaderException):
pass
class DBError(Exception):
pass
class DBDataError(DBError):
pass
class RepeatedAutomationId(DBDataError):
pass
class DBNoAutomationFound(DBError):
pass
+135 -23
View File
@@ -1,38 +1,150 @@
from typing import Any, Iterator, Union
from pydantic.error_wrappers import ValidationError
from pathlib import Path
from typing import Any, Iterator, Tuple, Union
from src.json_serializer import normalize_obj
from src.logger import get_logger
from src.utils import extract_files
from src.yaml_serializer import dump_yaml, load_yaml
from src.yaml_serializer.types import IncludedYaml, IncludedYamlDir
from ..hass_config.loader import HassConfig
from .errors import InvalidAutomationFile
from .types import AutomationMetdata, ExtenededAutomationData
from .tags import TagManager
from .types import ExtenededAutomation
logger = get_logger(__file__)
AUTOMATION_CONFIGURATION_KEY = "automation shortumation"
# Single loader
def load_automation(
auto_raw: dict,
tags: dict,
) -> Iterator[ExtenededAutomationData]:
"""Converts an automation dictionary loaded directly from the config into
several python typed objects
def extract_automation_paths(
hass_config: HassConfig,
) -> Iterator[Tuple[str, str]]:
found = False
for key, value in extract_automation_keys(hass_config):
logger.info(f"Loading automations from '{key}'")
found = True
if isinstance(value, IncludedYaml):
yield key, value.path_str
elif isinstance(value, IncludedYamlDir):
yield key, value.name
else:
logger.warning(f"found an invalid type in {key}!")
if not found:
yield "", "automations.yaml"
def get_base_automation_key(hass_config: HassConfig):
found_any = False
for key, value in extract_automation_keys(hass_config):
found_any = True
if isinstance(value, IncludedYaml):
return key, value.path_str
configurations = hass_config.configurations
if found_any:
out_path = hass_config.get_backup_automation_file_path()
else:
out_path = hass_config.get_default_automation_path()
out_file = str(out_path.relative_to(hass_config.root_path))
configurations[AUTOMATION_CONFIGURATION_KEY] = IncludedYaml(out_file)
out_path.touch(exist_ok=True)
with hass_config.get_configuration_path().open("w") as fp:
fp.write(dump_yaml(configurations))
return AUTOMATION_CONFIGURATION_KEY, out_file
def extract_automation_keys(
hass_config: HassConfig,
) -> Iterator[Tuple[str, Union[IncludedYaml, IncludedYamlDir]]]:
for key, value in hass_config.configurations.items():
if str(key).startswith("automation"):
if isinstance(value, dict) or isinstance(value, list):
raise NotImplementedError(
"No support for automations baked into configuration.yaml! Please extract these into a seperate file"
)
elif isinstance(value, IncludedYaml) or isinstance(value, IncludedYamlDir):
yield key, value
else:
logger.warning(f"found an invalid type in {key}!")
def load_automation_path(
root_path: Path,
automation_path: Path,
configuration_key: str,
tag_manager: TagManager,
) -> Iterator[ExtenededAutomation]:
"""
Args:
automations_raw_data (Iterable[dict])
automation_path (Path)
configuration_key (str)
Returns:
Iterator[ExtenededAutomationData]
Iterator[ExtenededAutomation]
"""
try:
yield ExtenededAutomationData(
metadata=AutomationMetdata.parse_obj(auto_raw),
condition=ifempty_or_null_then_list(load_conditions(auto_raw.get("condition", []))),
sequence=ifempty_or_null_then_list(load_conditions(auto_raw.get("action", []))),
trigger=ifempty_or_null_then_list(normalize_obj(auto_raw.get("trigger", []))),
tags=tags,
)
except ValidationError as err:
raise InvalidAutomationFile from err
if not automation_path.exists():
logger.warning(f"the file {automation_path} does not exists")
return
if automation_path.is_dir():
for f in extract_files(automation_path):
yield from load_automation_path(root_path, f, configuration_key, tag_manager)
else:
try:
with automation_path.open("r") as fp:
automations = load_yaml(fp)
except Exception as err:
raise InvalidAutomationFile(
when="loading yaml",
automation_path=automation_path,
error=err,
) from err
if isinstance(automations, dict):
try:
yield ExtenededAutomation(
**clean_automation(automations),
tags=tag_manager.get(automations["id"], {}),
configuration_key=configuration_key,
source_file=str(automation_path.relative_to(root_path)),
source_file_type="obj",
)
except Exception as err:
raise InvalidAutomationFile(
when="reading file contents",
automation_path=automation_path,
error=err,
) from err
else:
if automations is None:
logger.warning(f"the file {automation_path} is empty")
return
for automation in automations:
try:
yield ExtenededAutomation(
**clean_automation(automation),
tags=tag_manager.get(automation["id"], {}),
configuration_key=configuration_key,
source_file=str(automation_path.relative_to(root_path)),
source_file_type="list",
)
except Exception as err:
raise InvalidAutomationFile(
when="reading file contents",
automation_path=automation_path,
error=err,
automation=automation,
) from err
def clean_automation(auto_raw: dict):
return {
**auto_raw,
"condition": ifempty_or_null_then_list(load_conditions(auto_raw.get("condition", []))),
"action": ifempty_or_null_then_list(load_conditions(auto_raw.get("action", []))),
"trigger": ifempty_or_null_then_list(normalize_obj(auto_raw.get("trigger", []))),
}
def ifempty_or_null_then_list(obj: Any):
+146 -64
View File
@@ -1,76 +1,158 @@
from typing import Dict, Iterator, List, Optional
from enum import auto
from pathlib import Path
from tempfile import mktemp
from typing import Dict, Optional, Union
from src.automations.errors import FailedDeletion, InvalidAutomationFile
from src.automations.types import AutomationData, ExtenededAutomationData
from src.hass_config.loader import HassConfig
from src.yaml_serializer import dump_yaml, load_yaml
from .loader import load_automation
from ..errors import ErrorSet
from ..logger import get_logger
from .db import AutomationDBConnection
from .errors import (
AttemptingToOverwriteAnIncompatibleFileError,
DBError,
InvalidAutomationFile,
)
from .loader import extract_automation_paths, get_base_automation_key, load_automation_path
from .tags import TagManager
from .types import Automation, ExtenededAutomation
logger = get_logger(__file__)
class AutomationManager:
def __init__(self, hass_config: HassConfig) -> None:
self.hass_config = hass_config
def find(
def __init__(
self,
offset: int = 0,
limit: int = 10,
) -> Iterator[AutomationData]:
tags = self.hass_config.automation_tags
for i, auto in enumerate(self.hass_config.automations):
if i < offset:
continue
if i >= offset + limit:
break
yield from load_automation(auto, tags.get(auto.get("id", ""), {}))
hass_config: HassConfig,
db_path: Optional[Path] = None,
) -> None:
if db_path is None:
db_path = Path(mktemp())
self.hass_config = hass_config
self.db = AutomationDBConnection(db_path)
self.tag_path = hass_config.get_automation_tags_path()
self.tag_manager = TagManager()
self.reload_tags()
def get(self, index: int) -> Optional[ExtenededAutomationData]:
tags = self.hass_config.automation_tags
if index >= 0:
for i, auto in enumerate(self.hass_config.automations):
if not isinstance(auto, dict):
raise InvalidAutomationFile(automation_index=i)
if i == index:
return next(load_automation(auto, tags.get(auto.get("id", ""), {})))
return None
def reload_tags(self):
if self.tag_path.exists():
self.tag_manager = TagManager.load(self.tag_path)
def update(self, index: int, automation: ExtenededAutomationData):
tags = self.hass_config.automation_tags
automations: List[dict] = []
updated_index: Optional[int] = None
for i, orig_auto in enumerate(self.hass_config.automations):
if i == index:
automations.append(automation.to_primitive())
updated_index = i
else:
automations.append(orig_auto)
if updated_index is None:
automations.append(automation.to_primitive())
updated_index = len(automations) - 1
tags[automation.metadata.id] = automation.tags
self.hass_config.save_automations(automations)
self.hass_config.save_tags(tags)
def reload(self):
self.db.reset()
self.reload_tags()
errors = []
for config_key, p in extract_automation_paths(self.hass_config):
try:
automations = list(
load_automation_path(
self.hass_config.root_path,
self.hass_config.root_path / p,
config_key,
self.tag_manager,
)
)
self.db.insert_automations(automations)
except InvalidAutomationFile as e:
logger.warning(e)
errors.append(e)
except DBError as e:
logger.warning(e)
errors.append(e)
if len(errors) > 0:
raise ErrorSet(*errors)
def update_tags(self, auto_id: str, tags: Dict[str, str]):
autos_tags = self.hass_config.automation_tags
autos_tags[auto_id] = tags
self.hass_config.save_tags(autos_tags)
def list(self, offset: int, limit: int):
return self.db.list_automations(offset=offset, limit=limit)
def delete(self, index: int):
automations: List[dict] = []
deleted = False
for i, orig_auto in enumerate(self.hass_config.automations):
if i == index:
deleted = True
else:
automations.append(orig_auto)
if not deleted:
raise FailedDeletion("No such automation found")
self.hass_config.save_automations(automations)
def count(self):
return self.db.count_automations()
# TODO: improve on this without keeping things in memory
def get_total_items(self) -> int:
count = 0
for i, _ in enumerate(self.hass_config.automations):
count = i
return count + 1
def get(self, auto_id: str):
return self.db.get_automation(auto_id)
def create(self, automation: Automation):
config_key, config_path = get_base_automation_key(self.hass_config)
return self.update(
ExtenededAutomation(
**automation.dict(),
configuration_key=config_key,
source_file=config_path,
source_file_type="list",
),
create_if_not_found=True,
)
def update(self, automation: ExtenededAutomation, create_if_not_found: bool = False):
automation_path = self.hass_config.root_path / automation.source_file
if not automation_path.parent.exists():
automation_path.parent.mkdir(parents=True)
objs: Optional[Union[list, dict]] = None
if automation_path.exists():
with automation_path.open("r") as fp:
objs = load_yaml(fp)
if automation.source_file_type == "obj":
if isinstance(objs, list):
raise AttemptingToOverwriteAnIncompatibleFileError(
f"{automation_path} is a list, but expected a obj for {automation}"
)
raw_auto = automation.to_primitive(include_tags=False)
automation_path.write_text(dump_yaml(raw_auto))
else:
if isinstance(objs, dict):
raise AttemptingToOverwriteAnIncompatibleFileError(
f"{automation_path} is a list, but expected a obj for {automation}"
)
elif objs is None:
objs = []
if not isinstance(objs, list):
raise AssertionError(
f"Attemption to save automation to {automation_path} but encountering an invalid list yaml file. Did you modify this file prior to saving?\n{automation}"
)
found = False
for i, obj in enumerate(objs):
if obj["id"] == automation.id:
objs[i] = automation.to_primitive(include_tags=False)
found = True
break
if not found:
if create_if_not_found:
objs.append(automation.to_primitive(include_tags=False))
else:
raise InvalidAutomationFile(
"Could not update automations, not found in source file."
)
automation_path.write_text(dump_yaml(objs))
self.update_tags(automation.id, automation.tags)
def update_tags(self, automation_id: str, tags: Dict[str, str]):
self.reload_tags()
self.tag_manager[automation_id] = tags
self.tag_manager.save(self.tag_path)
def delete_tags(self, automation_id: str):
self.reload_tags()
if automation_id in self.tag_manager:
del self.tag_manager[automation_id]
self.tag_manager.save(self.tag_path)
def delete(self, automation: ExtenededAutomation):
automation_path = self.hass_config.root_path / automation.source_file
if automation.source_file_type == "obj":
automation_path.unlink(missing_ok=True)
else:
with automation_path.open("r") as fp:
objs = load_yaml(fp)
if not isinstance(objs, list):
raise AssertionError(
f"Attemption to save automation to {automation_path} but encountering an invalid list yaml file. Did you modify this file prior to saving?\n{automation}"
)
kept = []
for i, obj in enumerate(objs):
if obj["id"] != automation.id:
kept.append(obj)
automation_path.write_text(dump_yaml(kept))
self.delete_tags(automation.id)
+2
View File
@@ -6,6 +6,8 @@ from src.yaml_serializer import dump_yaml, load_yaml
class TagManager(Dict[str, Dict[str, str]]):
def save(self, path: Path):
if not path.parent.exists():
path.parent.mkdir(parents=True)
path.write_text(dump_yaml(dict(self)))
@classmethod
+29 -14
View File
@@ -1,31 +1,46 @@
from typing import Dict, List, Optional, Union
import json
from pathlib import Path
from typing import Dict, List, Literal, Optional, Union
from pydantic import BaseModel
from pydantic.fields import Field
class AutomationMetdata(BaseModel):
class BaseAutomation(BaseModel):
id: str
alias: Optional[str] = None
description: Optional[str] = None
trigger_variables: Optional[Dict[str, Union[str, int, bool, float]]] = None
mode: str = "single"
class AutomationData(BaseModel):
metadata: AutomationMetdata
trigger: List[dict] = []
condition: List[dict] = []
sequence: List[dict] = []
action: List[dict] = []
def to_primitive(self):
return {
**self.metadata.dict(exclude_unset=True, exclude_none=True),
"trigger": self.trigger,
"condition": self.condition,
"action": self.sequence,
}
return self.dict(exclude_unset=True, exclude_none=True)
class ExtenededAutomationData(AutomationData):
class Automation(BaseAutomation):
tags: Dict[str, str] = Field(default_factory=dict)
def to_primitive(self, include_tags: bool = False):
out = super().to_primitive()
if not include_tags and out.get("tags", None) is not None:
del out["tags"]
return out
class ExtenededAutomation(Automation):
source_file: str
source_file_type: Literal["list", "obj"]
configuration_key: str
def to_primitive(self, include_tags: bool = False):
out = super().to_primitive(include_tags=include_tags)
del out["source_file"]
del out["source_file_type"]
del out["configuration_key"]
return out
def to_json(self):
return json.loads(self.json())
+12
View File
@@ -0,0 +1,12 @@
class ErrorSet(Exception):
"""An exception collection exception"""
def __init__(self, *errors: Exception) -> None:
self.errors = errors
super().__init__(self.gen_message())
def gen_message(self):
if len(self.errors) > 1:
return "Encountered multiple errors:\n >" + "\n >".join(map(repr, self.errors))
else:
return str(self.errors[0].args)
-6
View File
@@ -1,6 +0,0 @@
class HassConfigError(Exception):
pass
class MissingFile(HassConfigError):
pass
+14 -26
View File
@@ -5,8 +5,6 @@ from src.automations.tags import TagManager
from src.yaml_serializer import dump_yaml, load_yaml
from src.yaml_serializer.types import IncludedYaml
from .errors import MissingFile
class HassConfig:
def __init__(self, root_path: Path) -> None:
@@ -17,32 +15,18 @@ class HassConfig:
with self.get_configuration_path().open("r") as f:
return dict(load_yaml(f)) # type: ignore
@property
def automations(self) -> List[dict]:
if automation_path := self.get_automation_path():
try:
with automation_path.open("r") as f:
return load_yaml(f) # type: ignore
except FileNotFoundError as err:
raise MissingFile("automations.yaml") from err
return self.configurations["automation"]
@property
def automation_tags(self) -> TagManager:
tag_path = self.get_automation_tags_path()
if not tag_path.exists():
tag_path.parent.mkdir(parents=True, exist_ok=True)
return TagManager()
else:
return TagManager.load(tag_path)
def get_automation_tags_path(self) -> Path:
return self.root_path / ".shortumations" / "tags.yaml"
def get_backup_automation_file_path(self) -> Path:
return self.get_shortumations_path() / "automations.yaml"
def get_configuration_path(self) -> Path:
return self.root_path / "configuration.yaml"
def get_automation_path(self) -> Optional[Path]:
def get_default_automation_path(self) -> Optional[Path]:
"""Get Automation Path (if not included in configuration.yaml, in this case the return value is None)
Returns:
@@ -57,13 +41,17 @@ class HassConfig:
return None
return self.root_path / "automations.yaml"
def save_automations(self, automations: List[dict]):
if automation_path := self.get_automation_path():
automation_path.write_text(dump_yaml(automations))
else:
self.get_configuration_path().write_text(
dump_yaml({**self.configurations, "automation": automations})
)
def get_shortumations_path(self) -> Path:
shortumations_path = self.root_path / ".shortumations"
if not shortumations_path.exists():
shortumations_path.mkdir(parents=True, exist_ok=True)
return shortumations_path
def get_automation_tags_path(self) -> Path:
return self.get_shortumations_path() / "tags.yaml"
def get_configuration_path(self) -> Path:
return self.root_path / "configuration.yaml"
def save_tags(self, tags: TagManager):
tags.save(self.get_automation_tags_path())
+5 -11
View File
@@ -2,17 +2,11 @@ import logging
from src.env import LOG_LEVEL
if LOG_LEVEL == "DEBUG":
logging.basicConfig(level=logging.DEBUG)
elif LOG_LEVEL == "INFO":
logging.basicConfig(level=logging.INFO)
elif LOG_LEVEL == "WARN":
logging.basicConfig(level=logging.WARN)
elif LOG_LEVEL == "ERROR":
logging.basicConfig(level=logging.ERROR)
else:
logging.basicConfig(level=logging.NOTSET)
logging.basicConfig(
format="%(asctime)s|%(levelname)-4s[%(pathname)s:%(lineno)d@%(funcName)s] %(message)s",
datefmt="%Y-%m-%d:%H:%M:%S",
level=logging._nameToLevel.get(LOG_LEVEL, logging.INFO),
)
logger = logging.getLogger()
+20
View File
@@ -0,0 +1,20 @@
from pathlib import Path
from typing import Iterator
def extract_files(p: Path) -> Iterator[Path]:
"""Extracts all files in folder and it's subfolders
Args:
p (Path):
Yields:
Iterator[Path]
"""
if not p.exists():
return
if p.is_dir():
for c in p.iterdir():
yield from extract_files(c)
else:
yield p
+1 -1
View File
@@ -6,7 +6,7 @@ from websockets.client import WebSocketClientProtocol, connect
from websockets.exceptions import ConnectionClosedOK
from src.env import HASSIO_TOKEN, HASSIO_WS
from src.logger import get_logger, logger
from src.logger import get_logger
OnMessage = Callable[[str], Coroutine]
logger = get_logger(__name__)
+1 -1
View File
@@ -36,6 +36,6 @@ def load_yaml(yaml_stream: TextIO) -> Union[dict, list]:
yaml_stream (io.StringIO)
Returns:
List[dict, list]
Union[dict, list]
"""
return yaml.load(yaml_stream, Loader=YamlSafeLoader) # nosec
@@ -0,0 +1,14 @@
id: "1659114822642"
alias: On Home Down
description: Example
mode: single
trigger:
- platform: homeassistant
event: shutdown
condition: []
action:
- service: counter.increment
target:
entity_id:
- counter.up_times
data: {}
@@ -0,0 +1,13 @@
id: "1659114647066"
alias: On Home Up
description: Example
mode: single
trigger:
- platform: homeassistant
event: start
condition: []
action:
- service: counter.increment
data: {}
target:
entity_id: counter.up_times
@@ -0,0 +1,13 @@
id: "1659114647067"
alias: Notify Washer
description: Example
mode: single
trigger:
- platform: homeassistant
event: start
condition: []
action:
- service: counter.increment
data: {}
target:
entity_id: counter.up_times
@@ -0,0 +1,4 @@
# Loads default set of integrations. Do not remove.
default_config:
automation: !include_dir_list ./automations
@@ -0,0 +1,14 @@
id: "1659114822642"
alias: On Home Down
description: Example
mode: single
trigger:
- platform: homeassistant
event: shutdown
condition: []
action:
- service: counter.increment
target:
entity_id:
- counter.up_times
data: {}
@@ -0,0 +1,13 @@
id: "1659114647066"
alias: HA Up
description: Example
mode: single
trigger:
- platform: homeassistant
event: start
condition: []
action:
- service: counter.increment
data: {}
target:
entity_id: counter.up_times
@@ -0,0 +1,13 @@
id: "1659114647067"
alias: Notify Washer
description: Example
mode: single
trigger:
- platform: homeassistant
event: start
condition: []
action:
- service: counter.increment
data: {}
target:
entity_id: counter.up_times
@@ -0,0 +1,7 @@
- id: "mlist1"
alias: Merged List 1
description: ""
trigger: []
condition: []
action: []
mode: single
@@ -0,0 +1,14 @@
- id: "mlist2"
alias: Merged List 2
description: ""
trigger: []
condition: []
action: []
mode: single
- id: "mlist3"
alias: Merged List 3
description: ""
trigger: []
condition: []
action: []
mode: single
@@ -0,0 +1,14 @@
- id: "sublist3-mlist2"
alias: Sublist 3 - Merged List 2
description: ""
trigger: []
condition: []
action: []
mode: single
- id: "sublist3-mlist3"
alias: Sublist 3 - Merged List 3
description: ""
trigger: []
condition: []
action: []
mode: single
@@ -0,0 +1,23 @@
- id: '165911464702444'
alias: In File
description: Example
mode: single
trigger:
- platform: homeassistant
event: start
condition: []
action:
- service: counter.increment
data: {}
target:
entity_id: counter.up_times
- id: '1660439437914'
alias: NEW
description: ''
trigger:
- platform: sun
event: sunrise
offset: 0
condition: []
action: []
mode: single
@@ -0,0 +1,12 @@
# Loads default set of integrations. Do not remove.
default_config:
# Text to speech
tts:
- platform: google_translate
automation manual: !include_dir_list ./automations/include_dir_list
automation ui: !include automations/ui.yaml
automation cools: !include_dir_merge_list automations/include_dir_merge_list
script: !include scripts.yaml
scene: !include scenes.yaml
@@ -0,0 +1,7 @@
- id: "1660439557193"
alias: SHOULD NOT BE LOADED!
description: ""
trigger: []
condition: []
action: []
mode: single
@@ -0,0 +1,23 @@
- id: "base1"
alias: BASE
description: Example
mode: single
trigger:
- platform: homeassistant
event: start
condition: []
action:
- service: counter.increment
data: {}
target:
entity_id: counter.up_times
- id: "base2"
alias: base 2
description: ""
trigger:
- platform: sun
event: sunrise
offset: 0
condition: []
action: []
mode: single
@@ -0,0 +1,14 @@
id: "1659114822642"
alias: On Home Down
description: Example
mode: single
trigger:
- platform: homeassistant
event: shutdown
condition: []
action:
- service: counter.increment
target:
entity_id:
- counter.up_times
data: {}
@@ -0,0 +1,13 @@
id: "1659114647066"
alias: HA Up
description: Example
mode: single
trigger:
- platform: homeassistant
event: start
condition: []
action:
- service: counter.increment
data: {}
target:
entity_id: counter.up_times
@@ -0,0 +1,13 @@
id: "1659114647067"
alias: Notify Washer
description: Example
mode: single
trigger:
- platform: homeassistant
event: start
condition: []
action:
- service: counter.increment
data: {}
target:
entity_id: counter.up_times
@@ -0,0 +1,7 @@
- id: "mlist1"
alias: Merged List 1
description: ""
trigger: []
condition: []
action: []
mode: single
@@ -0,0 +1,14 @@
- id: "mlist2"
alias: Merged List 2
description: ""
trigger: []
condition: []
action: []
mode: single
- id: "mlist3"
alias: Merged List 3
description: ""
trigger: []
condition: []
action: []
mode: single
@@ -0,0 +1,18 @@
- id: "sublist3-mlist2"
alias: Sublist 3 - Merged List 2
description: "That was correct!"
trigger: []
condition: []
action:
- service: "switch.turn_off"
target:
entity_id: "switch.bathroom"
data:
mode: single
- id: "sublist3-mlist3"
alias: Sublist 3 - Merged List 3
description: ""
trigger: []
condition: []
action: []
mode: single
@@ -0,0 +1,23 @@
- id: "ui1"
alias: UI 1
description: Example
mode: single
trigger:
- platform: homeassistant
event: start
condition: []
action:
- service: counter.increment
data: {}
target:
entity_id: counter.up_times
- id: "ui2"
alias: UI 2
description: ""
trigger:
- platform: sun
event: sunrise
offset: 0
condition: []
action: []
mode: single
@@ -0,0 +1,13 @@
# Loads default set of integrations. Do not remove.
default_config:
# Text to speech
tts:
- platform: google_translate
automation manual: !include_dir_list ./automations/include_dir_list
automation ui: !include automations/ui.yaml
automation: !include automations/base.yaml
automation cools: !include_dir_merge_list automations/include_dir_merge_list
script: !include scripts.yaml
scene: !include scenes.yaml
+265 -205
View File
@@ -1,15 +1,12 @@
from pathlib import Path
from unittest import TestCase
import yaml
from fastapi.testclient import TestClient
from src.api.app import make_app
from src.automations.types import (
AutomationData,
AutomationMetdata,
ExtenededAutomationData,
)
from tests.utils import HA_CONFIG2_EXAMPLE, get_example_automation_loader
from src.automations.types import Automation, ExtenededAutomation
from tests.utils import HA_CONFIG2_EXAMPLE, HA_CONFIG6_EXAMPLE, get_example_automation_loader
class BaseTestCase(TestCase):
@@ -22,7 +19,7 @@ class BaseTestCase(TestCase):
self.client = TestClient(make_app(self.automation_loader))
class automation_list_tests(BaseTestCase):
class automation_pagination_tests(BaseTestCase):
test_params = {"total": 32, "subtest2_found_items": 7, "subtest1_found_items": 10}
@@ -87,7 +84,7 @@ class automation_list_tests(BaseTestCase):
self.assertEqual(len(d["data"]), self.test_params["subtest2_found_items"])
class automation2_lists_tests(automation_list_tests):
class automation_pagination_tests_2(automation_pagination_tests):
test_params = {
"total": 1,
"subtest2_found_items": 0,
@@ -104,232 +101,295 @@ class automation2_lists_tests(automation_list_tests):
class automation_update_tests(BaseTestCase):
test_params = {
"total": 32,
"modify_item": 20,
"consitency_tests": {
1: {
"offset": 15,
"file_offset": 15,
"expected_change": {
"metadata": {
"id": "1629422438707",
"alias": "I CHANGED!",
"description": "",
"mode": "single",
},
"trigger": [{"platform": "time", "at": "input_datetime.vita_night_pump_time"}],
"condition": [
{
"conditions": [
{
"condition": "time",
"after": "input_datetime.vita_night_pump_time",
"before": "00:00:00",
},
{"condition": "time", "after": "00:00:00", "before": "06:00:00"},
],
"condition": "and",
},
],
"action": [
{
"service": "light.turn_on",
"target": {
"entity_id": "light.bulb_staircase",
"area_id": "living_room",
},
"data": {"brightness_pct": 40, "transition": 15},
}
],
},
},
2: {
"offset": 27,
"file_offset": 27,
"expected_change": {
"metadata": {
"id": "1649947692702",
"alias": "I CHANGED!",
"description": "",
"mode": "single",
},
"trigger": [
{
"device_id": "das2qdasdasdasadaasd",
"domain": "zha",
"platform": "device",
"type": "remote_button_short_press",
"subtype": "turn_on",
"id": "turn_on",
},
{
"device_id": "das2qdasdasdasadaasd",
"domain": "zha",
"platform": "device",
"type": "remote_button_short_press",
"subtype": "turn_off",
"id": "turn_off",
},
{
"device_id": "das2qdasdasdasadaasd",
"domain": "zha",
"platform": "device",
"type": "remote_button_short_press",
"subtype": "dim_up",
"id": "dim_up",
},
{
"device_id": "das2qdasdasdasadaasd",
"domain": "zha",
"platform": "device",
"type": "remote_button_short_press",
"subtype": "dim_down",
"id": "dim_down",
},
{
"device_id": "das2qdasdasdasadaasd",
"domain": "zha",
"platform": "device",
"type": "remote_button_double_press",
"subtype": "turn_on",
"id": "up_dbclk",
},
],
"condition": [],
"action": [
{
"choose": [
{
"conditions": [{"condition": "trigger", "id": "turn_off"}],
"sequence": [
{
"type": "turn_off",
"device_id": "das2qdasdasdasadaasd",
"entity_id": "light.bulb_ari_lamp",
"domain": "light",
}
],
},
{
"conditions": [{"condition": "trigger", "id": "turn_on"}],
"sequence": [
{
"service": "light.turn_on",
"data": {"color_temp": 153, "brightness_pct": 100},
"target": {"device_id": "das2qdasdasdasadaasd"},
}
],
},
{
"conditions": [{"condition": "trigger", "id": "dim_up"}],
"sequence": [
{
"device_id": "das2qdasdasdasadaasd",
"domain": "light",
"entity_id": "light.bulb_ari_lamp",
"type": "brightness_increase",
}
],
},
{
"conditions": [{"condition": "trigger", "id": "dim_down"}],
"sequence": [
{
"device_id": "das2qdasdasdasadaasd",
"domain": "light",
"entity_id": "light.bulb_ari_lamp",
"type": "brightness_decrease",
}
],
},
{
"conditions": [{"condition": "trigger", "id": "up_dbclk"}],
"sequence": [
{
"service": "light.turn_on",
"data": {"color_temp": 500, "brightness_pct": 100},
"target": {"device_id": "das2qdasdasdasadaasd"},
}
],
},
],
"default": [],
}
],
},
},
},
}
def test_insert_new(self):
resp = self.client.post("/automations/list", json={"limit": 1, "offset": 0})
self.assertEqual(resp.json()["totalItems"], 32)
resp = self.client.post(
"/automations/list", json={"limit": self.test_params["total"] + 1, "offset": 0}
)
autos = resp.json()["data"]
self.assertEqual(resp.json()["totalItems"], self.test_params["total"])
self.assertNotIn("i am new", set([a["id"] for a in autos]))
resp = self.client.post(
"/automations/item",
json={
"index": 33,
"data": AutomationData(metadata=AutomationMetdata(id="testme")).dict(),
},
json=Automation(
id="i am new",
).dict(),
)
self.assertEqual(resp.status_code, 200)
resp = self.client.post("/automations/list", json={"limit": 1, "offset": 32})
resp = self.client.post(
"/automations/list", json={"limit": self.test_params["total"] + 1, "offset": 0}
)
data = resp.json()
self.assertEqual(data["totalItems"], 33)
self.assertEqual(data["data"][0]["metadata"]["id"], "testme")
self.assertEqual(data["totalItems"], self.test_params["total"] + 1)
self.assertIn("i am new", set([a["id"] for a in data["data"]]))
def test_update_some(self):
resp = self.client.post("/automations/list", json={"limit": 1, "offset": 20})
original_auto = resp.json()["data"][0]
resp = self.client.post(
"/automations/list", json={"limit": 1, "offset": self.test_params["modify_item"]}
)
original_auto = resp.json()["data"][0]
changed_to = ExtenededAutomation(
id=original_auto["id"],
alias="I have been modified",
configuration_key=original_auto["configuration_key"],
source_file_type=original_auto["source_file_type"],
source_file=original_auto["source_file"],
)
resp = self.client.put(
"/automations/item",
json={
"index": 20,
"data": AutomationData(metadata=AutomationMetdata(id="testme")).dict(),
},
json=changed_to.to_json(),
)
self.assertEqual(resp.status_code, 200)
resp = self.client.post("/automations/list", json={"limit": 1, "offset": 20})
resp = self.client.post(
"/automations/list", json={"limit": 1, "offset": self.test_params["modify_item"]}
)
new_auto = resp.json()["data"][0]
self.assertNotEqual(original_auto, new_auto)
self.assertEqual(
ExtenededAutomationData(metadata=AutomationMetdata(id="testme")).dict(), new_auto
changed_to.to_json(),
new_auto,
)
def test_consistent_standard_1(self):
resp = self.client.post("/automations/list", json={"limit": 1, "offset": 15})
original_auto = resp.json()["data"][0]
original_auto["metadata"]["alias"] = "I CHANGED!"
resp = self.client.post(
"/automations/item",
json={
"index": 15,
"data": original_auto,
},
)
self.assertEqual(resp.status_code, 200)
with (self.config_folder / "automations.yaml").open("r") as fp:
disk_data = dict(yaml.safe_load(fp)[15])
trigger = list(map(dict, disk_data.pop("trigger")))
condition = disk_data.pop("condition")
action = list(map(dict, disk_data.pop("action")))
self.assertDictEqual(
disk_data,
{"id": "1629422438707", "alias": "I CHANGED!", "description": "", "mode": "single"},
)
self.assertListEqual(
trigger, [{"platform": "time", "at": "input_datetime.vita_night_pump_time"}]
)
self.assertListEqual(
condition,
[
{
"conditions": [
{
"condition": "time",
"after": "input_datetime.vita_night_pump_time",
"before": "00:00:00",
},
{"condition": "time", "after": "00:00:00", "before": "06:00:00"},
],
"condition": "and",
},
],
)
self.assertListEqual(
action,
[
{
"service": "light.turn_on",
"target": {"entity_id": "light.bulb_staircase", "area_id": "living_room"},
"data": {"brightness_pct": 40, "transition": 15},
}
],
)
for test_id, test_params in self.test_params["consitency_tests"].items():
with self.subTest(test_id=test_id):
resp = self.client.post(
"/automations/list",
json={"limit": 1, "offset": test_params["offset"]},
)
original_auto = resp.json()["data"][0]
original_auto["alias"] = "I CHANGED!"
resp = self.client.post(
"/automations/item",
json=original_auto,
)
self.assertEqual(resp.status_code, 200)
with (self.config_folder / original_auto["source_file"]).open("r") as fp:
disk_data = dict(yaml.safe_load(fp)[test_params["file_offset"]])
trigger = list(map(dict, disk_data.pop("trigger")))
condition = disk_data.pop("condition")
action = list(map(dict, disk_data.pop("action")))
self.assertDictEqual(
disk_data,
test_params["expected_change"]["metadata"],
)
self.assertListEqual(
trigger,
test_params["expected_change"]["trigger"],
)
self.assertListEqual(
condition,
test_params["expected_change"]["condition"],
)
self.assertListEqual(
action,
test_params["expected_change"]["action"],
)
def test_consistent_standard_2(self):
resp = self.client.post("/automations/list", json={"limit": 1, "offset": 27})
original_auto = resp.json()["data"][0]
original_auto["metadata"]["alias"] = "I CHANGED!"
resp = self.client.post(
"/automations/item",
json={
"index": 27,
"data": original_auto,
},
)
self.assertEqual(resp.status_code, 200)
with (self.config_folder / "automations.yaml").open("r") as fp:
disk_data = dict(yaml.safe_load(fp)[27])
trigger = list(map(dict, disk_data.pop("trigger")))
condition = disk_data.pop("condition")
action = list(map(dict, disk_data.pop("action")))
self.assertDictEqual(
disk_data,
{"id": "1649947692702", "alias": "I CHANGED!", "description": "", "mode": "single"},
)
self.assertListEqual(
trigger,
[
{
"device_id": "das2qdasdasdasadaasd",
"domain": "zha",
"platform": "device",
"type": "remote_button_short_press",
"subtype": "turn_on",
"id": "turn_on",
},
{
"device_id": "das2qdasdasdasadaasd",
"domain": "zha",
"platform": "device",
"type": "remote_button_short_press",
"subtype": "turn_off",
"id": "turn_off",
},
{
"device_id": "das2qdasdasdasadaasd",
"domain": "zha",
"platform": "device",
"type": "remote_button_short_press",
"subtype": "dim_up",
"id": "dim_up",
},
{
"device_id": "das2qdasdasdasadaasd",
"domain": "zha",
"platform": "device",
"type": "remote_button_short_press",
"subtype": "dim_down",
"id": "dim_down",
},
{
"device_id": "das2qdasdasdasadaasd",
"domain": "zha",
"platform": "device",
"type": "remote_button_double_press",
"subtype": "turn_on",
"id": "up_dbclk",
},
],
)
self.assertListEqual(condition, [])
self.assertListEqual(
action,
[
{
"choose": [
class automation_update_split_config_tests(automation_update_tests):
test_params = {
"total": 12,
"modify_item": 3,
"consitency_tests": {
1: {
"offset": 3,
"file_offset": 0,
"expected_change": {
"metadata": {
"alias": "I CHANGED!",
"description": "Example",
"id": "ui1",
"mode": "single",
},
"trigger": [{"platform": "homeassistant", "event": "start"}],
"condition": [],
"action": [
{
"conditions": [{"condition": "trigger", "id": "turn_off"}],
"sequence": [
{
"type": "turn_off",
"device_id": "das2qdasdasdasadaasd",
"entity_id": "light.bulb_ari_lamp",
"domain": "light",
}
],
},
{
"conditions": [{"condition": "trigger", "id": "turn_on"}],
"sequence": [
{
"service": "light.turn_on",
"data": {"color_temp": 153, "brightness_pct": 100},
"target": {"device_id": "das2qdasdasdasadaasd"},
}
],
},
{
"conditions": [{"condition": "trigger", "id": "dim_up"}],
"sequence": [
{
"device_id": "das2qdasdasdasadaasd",
"domain": "light",
"entity_id": "light.bulb_ari_lamp",
"type": "brightness_increase",
}
],
},
{
"conditions": [{"condition": "trigger", "id": "dim_down"}],
"sequence": [
{
"device_id": "das2qdasdasdasadaasd",
"domain": "light",
"entity_id": "light.bulb_ari_lamp",
"type": "brightness_decrease",
}
],
},
{
"conditions": [{"condition": "trigger", "id": "up_dbclk"}],
"sequence": [
{
"service": "light.turn_on",
"data": {"color_temp": 500, "brightness_pct": 100},
"target": {"device_id": "das2qdasdasdasadaasd"},
}
],
},
"service": "counter.increment",
"data": {},
"target": {"entity_id": "counter.up_times"},
}
],
"default": [],
}
],
)
},
},
},
}
def setUp(self) -> None:
(
self.config_folder,
self.hass_config,
self.automation_loader,
) = get_example_automation_loader(HA_CONFIG6_EXAMPLE)
self.client = TestClient(make_app(self.automation_loader))
class automation_delete_tests(BaseTestCase):
def test_delete_some(self):
resp = self.client.post("/automations/list", json={"limit": 1, "offset": 0})
autos = resp.json()["data"]
self.assertEqual(resp.json()["totalItems"], 32)
resp = self.client.delete(
"/automations/item",
json={
"index": 20,
},
json=autos[0],
)
self.assertEqual(resp.status_code, 200)
resp = self.client.post("/automations/list", json={"limit": 1, "offset": 0})
@@ -0,0 +1,66 @@
from pathlib import Path
from src.automations.types import ExtenededAutomation
from src.automations.errors import DBDataError
from .utils import TestWithDB
class db_tests(TestWithDB):
def test_db_creation(self):
with self.db.get_cur() as cur:
cur.execute("SELECT name FROM sqlite_schema WHERE type ='table'")
tables = cur.fetchall()
self.assertListEqual(tables, [("autos",)])
self.db.create_db()
with self.db.get_cur() as cur:
cur.execute("SELECT name FROM sqlite_schema WHERE type ='table'")
tables = cur.fetchall()
self.assertListEqual(tables, [("autos",)])
def test_insert_automations(self):
originals = [
ExtenededAutomation(
id="test",
alias="test",
source_file="automation.yaml",
source_file_type="obj",
configuration_key="automation",
),
ExtenededAutomation(
id="test2",
alias="test",
source_file="automation.yaml",
source_file_type="obj",
action=[{"event": {"nice": "one"}, "event_type": "custom"}],
configuration_key="automation",
),
]
self.db.insert_automations(originals)
for original in originals:
with self.subTest(original=original):
self.assertEqual(self.db.get_automation(original.id), original)
autos = list(self.db.list_automations(0, 10))
self.assertEqual(len(autos), 2)
def test_insert_repeat_automations(self):
originals = [
ExtenededAutomation(
id="test",
alias="test",
source_file="automation.yaml",
source_file_type="obj",
configuration_key="automation",
),
ExtenededAutomation(
id="test",
alias="test",
source_file="automation.yaml",
source_file_type="obj",
action=[{"event": {"nice": "one"}, "event_type": "custom"}],
configuration_key="automation",
),
]
with self.assertRaises(DBDataError) as err:
self.db.insert_automations(originals)
autos = list(self.db.list_automations(0, 10))
self.assertEqual(len(autos), 0)
+127 -43
View File
@@ -1,59 +1,143 @@
from pathlib import Path
from tempfile import mktemp
from unittest import TestCase
from src.automations.loader import load_automation
from src.automations.types import AutomationMetdata, ExtenededAutomationData
from src.yaml_serializer.types import NOT_IMPLEMENTED_SV_MSG, SecretValue
from src.automations.loader import (
extract_automation_paths,
load_automation_path,
)
from src.automations.tags import TagManager
from src.automations.types import ExtenededAutomation
from src.hass_config.loader import HassConfig
from tests.utils import (
HA_CONFIG2_EXAMPLE,
HA_CONFIG3_EXAMPLE,
HA_CONFIG4_EXAMPLE,
HA_CONFIG5_EXAMPLE,
HA_CONFIG6_EXAMPLE,
HA_CONFIG_EXAMPLE,
)
class loader_tests(TestCase):
def test_load_automation_runs(self):
auto = list(
load_automation(
{
"id": "1616887975473",
"alias": "Home Assistant Off",
"description": "",
"trigger": [{"platform": "homeassistant", "event": "shutdown"}],
"condition": ["states(time.time) >= '10:00:00'"],
"action": [
{
"device_id": SecretValue("my_mobile_phone", "..."),
"domain": "mobile_app",
"type": "notify",
"title": "Hassio Status",
"message": "Hassio Is turning off...",
}
],
"mode": "single",
},
{},
def test_load_automation_list_file(self):
automations = list(
load_automation_path(
HA_CONFIG2_EXAMPLE,
HA_CONFIG2_EXAMPLE / "automations.yaml",
configuration_key="automation",
tag_manager=TagManager({"1652069225859": {"type": "routine"}}),
)
)
self.assertEqual(len(automations), 1)
self.assertEqual(
auto[0],
ExtenededAutomationData(
metadata=AutomationMetdata(
id="1616887975473",
alias="Home Assistant Off",
description="",
mode="single",
),
trigger=[{"platform": "homeassistant", "event": "shutdown"}],
condition=[
automations[0],
ExtenededAutomation(
id="1652069225859",
source_file="automations.yaml",
source_file_type="list",
configuration_key="automation",
alias="Climate - Pref temperature ",
description="",
mode="single",
tags={"type": "routine"},
trigger=[
{
"condition": "template",
"value_template": "states(time.time) >= '10:00:00'",
"platform": "state",
"entity_id": "input_number.preferred_temperature",
}
],
sequence=[
condition=[],
action=[
{
"device_id": NOT_IMPLEMENTED_SV_MSG,
"domain": "mobile_app",
"type": "notify",
"title": "Hassio Status",
"message": "Hassio Is turning off...",
"service": "climate.set_temperature",
"data": {
"temperature": {
"[object Object]": None,
}
},
"target": {
"entity_id": "climate.main_floor",
},
}
],
tags={},
),
)
def test_load_automation_obj_file(self):
automations = list(
load_automation_path(
HA_CONFIG4_EXAMPLE,
HA_CONFIG4_EXAMPLE / "automations" / "notify_washer.yaml",
configuration_key="automation base",
tag_manager=TagManager({"1659114647067": {"room": "laundry"}}),
)
)
self.assertEqual(len(automations), 1)
self.assertEqual(
automations[0],
ExtenededAutomation(
id="1659114647067",
source_file="automations/notify_washer.yaml",
source_file_type="obj",
configuration_key="automation base",
alias="Notify Washer",
description="Example",
mode="single",
tags={"room": "laundry"},
trigger=[
{
"platform": "homeassistant",
"event": "start",
}
],
condition=[],
action=[
{
"service": "counter.increment",
"data": {},
"target": {"entity_id": "counter.up_times"},
}
],
),
)
def test_load_automation_empty_file(self):
file_path = Path(mktemp())
file_path.touch()
automations = list(
load_automation_path(
file_path.parent,
file_path,
configuration_key="automation ui",
tag_manager=TagManager(),
)
)
self.assertEqual(len(automations), 0)
def test_load_automation_none_existing_file(self):
file_path = Path(mktemp())
file_path.unlink(missing_ok=True)
automations = list(
load_automation_path(
file_path.parent,
file_path,
configuration_key="automation manual",
tag_manager=TagManager(),
)
)
self.assertEqual(len(automations), 0)
def test_extract_all_automation_files(self):
for ha_path, expected in [
(HA_CONFIG_EXAMPLE, 1),
(HA_CONFIG2_EXAMPLE, 1),
(HA_CONFIG3_EXAMPLE, 1),
(HA_CONFIG4_EXAMPLE, 1),
(HA_CONFIG5_EXAMPLE, 3),
(HA_CONFIG6_EXAMPLE, 4),
]:
with self.subTest(ha_path=ha_path, expected=expected):
hass_config = HassConfig(ha_path)
paths = list(extract_automation_paths(hass_config))
self.assertEqual(len(paths), expected)
+307 -95
View File
@@ -1,115 +1,327 @@
from unittest import TestCase
from pathlib import Path
from src.automations.errors import FailedDeletion, InvalidAutomationFile
from src.automations.types import AutomationMetdata, ExtenededAutomationData
from src import yaml_serializer
from src.automations.errors import (
AttemptingToOverwriteAnIncompatibleFileError,
DBNoAutomationFound,
InvalidAutomationFile,
)
from src.automations.manager import AutomationManager
from src.automations.types import ExtenededAutomation
from src.errors import ErrorSet
from src.hass_config.loader import HassConfig
from tests.utils import (
get_dummy_automation_loader,
get_example_automation_loader,
HA_CONFIG6_EXAMPLE,
HA_CONFIG_EXAMPLE,
create_copy_of_example_config,
)
from .utils import TestWithDB
class manager_tests(TestCase):
def test_find_limit_and_get(self):
_, _, loader = get_example_automation_loader()
first_auto_with_find = list(loader.find(limit=1))
first_auto_with_get = loader.get(0)
self.assertEqual(first_auto_with_find[0], first_auto_with_get)
def test_find_at_most_with_offset(self):
_, _, loader = get_example_automation_loader()
autos = list(loader.find(limit=10, offset=10))
self.assertTrue(len(autos), 10)
class manager_tests(TestWithDB):
def get_manager(self, ha_config_example: Path):
self.config_path = create_copy_of_example_config(ha_config_example)
self.automation_manager = AutomationManager(
HassConfig(self.config_path),
self.db_file,
)
return self.config_path, self.automation_manager
def test_load_complex_read_modify_delete(self):
_, automation_manager = self.get_manager(HA_CONFIG6_EXAMPLE)
self.assertEqual(automation_manager.count(), 0)
automation_manager.reload()
self.assertEqual(automation_manager.count(), 12)
automation = automation_manager.get("sublist3-mlist2")
self.assertEqual(automation.description, "That was correct!")
self.assertEqual(
automation.action,
[
{
"service": "switch.turn_off",
"target": {"entity_id": "switch.bathroom"},
"data": None,
}
],
)
self.assertEqual(automation.configuration_key, "automation cools")
automation.trigger.append(
{"platform": "zone", "entity_id": "person.thor", "zone": "zone.azguard"}
)
automation_manager.update(automation)
self.assertEqual(
automation_manager.get("sublist3-mlist2").trigger,
[],
)
automation_manager.reload()
self.assertEqual(
automation_manager.get("sublist3-mlist2").trigger,
[
{
"platform": "zone",
"entity_id": "person.thor",
"zone": "zone.azguard",
}
],
)
def test_find_invalid(self):
_, _, loader = get_example_automation_loader()
self.assertIsNone(loader.get(-1))
self.assertIsNone(loader.get(1_000))
self.assertIsNone(loader.get(33))
def test_length(self):
_, _, loader = get_example_automation_loader()
self.assertEqual(loader.get_total_items(), 32)
_, automation_manager = self.get_manager(HA_CONFIG6_EXAMPLE)
automation_manager.reload()
with self.assertRaises(DBNoAutomationFound):
automation_manager.get("invalid")
def test_bad_automations_file(self):
folder, _, manager = get_dummy_automation_loader(
[],
automation_in_conifguration_mode="none",
)
(folder / "automations.yaml").write_text("bob is an uncle")
with self.assertRaises(InvalidAutomationFile):
manager.get(0)
config_path, automation_manager = self.get_manager(HA_CONFIG_EXAMPLE)
(config_path / "automations.yaml").write_text("bob is an uncle")
with self.assertRaises(ErrorSet) as err:
automation_manager.reload()
self.assertEqual(len(err.exception.errors), 1)
self.assertIsInstance(err.exception.errors[0], InvalidAutomationFile)
self.assertEqual(automation_manager.count(), 0)
def test_create_automation(self):
_, _, manager = get_dummy_automation_loader(
[],
automation_in_conifguration_mode="none",
)
manager.update(1, ExtenededAutomationData(metadata=AutomationMetdata(id="test1")))
auto = manager.get(0)
self.assertIsNotNone(auto)
self.assertEqual(auto.metadata.id, "test1") # type: ignore
def test_one_bad_automations_file(self):
config_path, automation_manager = self.get_manager(HA_CONFIG6_EXAMPLE)
(config_path / "automations" / "ui.yaml").write_text("bob is an uncle")
with self.assertRaises(ErrorSet) as err:
automation_manager.reload()
self.assertEqual(len(err.exception.errors), 1)
self.assertIsInstance(err.exception.errors[0], InvalidAutomationFile)
self.assertEqual(automation_manager.count(), 10)
def test_create_automation_with_example_folder(self):
_, _, manager = get_example_automation_loader()
self.assertEqual(manager.get_total_items(), 32)
manager.update(40, ExtenededAutomationData(metadata=AutomationMetdata(id="test1")))
auto = manager.get(32)
self.assertIsNotNone(auto)
self.assertEqual(manager.get_total_items(), 33)
self.assertEqual(auto.metadata.id, "test1") # type: ignore
def test_delete_automation_in_single_file(self):
config_path, automation_manager = self.get_manager(HA_CONFIG6_EXAMPLE)
self.assertTrue((config_path / "automations/include_dir_list/home/down.yaml").exists())
automation_manager.reload()
automation = automation_manager.get("1659114822642")
self.assertEqual(automation.configuration_key, "automation manual")
automation_manager.delete(automation)
automation_manager.reload()
with self.assertRaises(DBNoAutomationFound):
automation_manager.get("1659114822642")
self.assertFalse((config_path / "automations/include_dir_list/home/down.yaml").exists())
def test_update_automation(self):
_, _, manager = get_dummy_automation_loader(
[
ExtenededAutomationData(metadata=AutomationMetdata(id="test1")),
ExtenededAutomationData(metadata=AutomationMetdata(id="test2")),
ExtenededAutomationData(metadata=AutomationMetdata(id="test3")),
],
automation_in_conifguration_mode="none",
def test_delete_automation_in_list(self):
config_path, automation_manager = self.get_manager(HA_CONFIG6_EXAMPLE)
self.assertTrue(
(config_path / "automations/include_dir_merge_list/sub/list2.yaml").exists()
)
automation_manager.reload()
automation = automation_manager.get("mlist2")
self.assertEqual(automation.configuration_key, "automation cools")
automation_manager.delete(automation)
automation_manager.reload()
with self.assertRaises(DBNoAutomationFound):
automation_manager.get("mlist2")
self.assertTrue(
(config_path / "automations/include_dir_merge_list/sub/list2.yaml").exists()
)
auto = manager.get(0)
self.assertEqual(auto.metadata.id, "test1") # type: ignore
manager.update(0, ExtenededAutomationData(metadata=AutomationMetdata(id="toaster-7")))
auto = manager.get(0)
self.assertEqual(auto.metadata.id, "toaster-7") # type: ignore
def test_delete_automation(self):
_, _, manager = get_dummy_automation_loader(
[
ExtenededAutomationData(metadata=AutomationMetdata(id="test1")),
ExtenededAutomationData(metadata=AutomationMetdata(id="test2")),
ExtenededAutomationData(metadata=AutomationMetdata(id="test3")),
],
automation_in_conifguration_mode="none",
def test_create_new_in_single_file(self):
config_path, automation_manager = self.get_manager(HA_CONFIG6_EXAMPLE)
automation_manager.reload()
self.assertFalse((config_path / "automations/include_dir_list/home/left.yaml").exists())
with self.assertRaises(DBNoAutomationFound):
automation_manager.get("newlymade")
automation_manager.update(
ExtenededAutomation(
id="newlymade",
configuration_key="automation manual",
source_file="automations/include_dir_list/home/left.yaml",
source_file_type="obj",
)
)
self.assertTrue((config_path / "automations/include_dir_list/home/left.yaml").exists())
automation_manager.reload()
self.assertEqual(
automation_manager.get("newlymade"),
ExtenededAutomation(
id="newlymade",
configuration_key="automation manual",
source_file="automations/include_dir_list/home/left.yaml",
source_file_type="obj",
),
)
self.assertEqual(manager.get_total_items(), 3)
manager.delete(1)
self.assertEqual(manager.get_total_items(), 2)
for auto in manager.find(0, 1000):
self.assertNotEqual(auto.metadata.id, "test2")
def test_failed_deletion_automation(self):
_, _, manager = get_dummy_automation_loader(
[
ExtenededAutomationData(metadata=AutomationMetdata(id="test1")),
ExtenededAutomationData(metadata=AutomationMetdata(id="test2")),
ExtenededAutomationData(metadata=AutomationMetdata(id="test3")),
],
automation_in_conifguration_mode="none",
def test_create_new_in_existing_list_file(self):
config_path, automation_manager = self.get_manager(HA_CONFIG6_EXAMPLE)
automation_manager.reload()
self.assertTrue(
(config_path / "automations/include_dir_merge_list/sub/list2.yaml").exists()
)
with self.assertRaises(DBNoAutomationFound):
automation_manager.get("newlymade")
automation_manager.update(
ExtenededAutomation(
id="newlymade",
configuration_key="automation cools",
source_file="automations/include_dir_merge_list/sub/list2.yaml",
source_file_type="list",
),
create_if_not_found=True,
)
self.assertTrue(
(config_path / "automations/include_dir_merge_list/sub/list2.yaml").exists()
)
automation_manager.reload()
self.assertEqual(
automation_manager.get("newlymade"),
ExtenededAutomation(
id="newlymade",
configuration_key="automation cools",
source_file="automations/include_dir_merge_list/sub/list2.yaml",
source_file_type="list",
),
)
self.assertEqual(manager.get_total_items(), 3)
with self.assertRaises(FailedDeletion):
manager.delete(10)
def test_save_tags(self):
_, _, manager = get_dummy_automation_loader(
[
ExtenededAutomationData(metadata=AutomationMetdata(id="test1")),
ExtenededAutomationData(metadata=AutomationMetdata(id="test2")),
ExtenededAutomationData(metadata=AutomationMetdata(id="test3")),
],
automation_in_conifguration_mode="none",
def test_create_new_in_new_list_file(self):
config_path, automation_manager = self.get_manager(HA_CONFIG6_EXAMPLE)
automation_manager.reload()
self.assertFalse(
(config_path / "automations/include_dir_merge_list/sub/list4.yaml").exists()
)
with self.assertRaises(DBNoAutomationFound):
automation_manager.get("newlymade")
automation_manager.update(
ExtenededAutomation(
id="newlymade",
configuration_key="automation cools",
source_file="automations/include_dir_merge_list/sub/list4.yaml",
source_file_type="list",
),
create_if_not_found=True,
)
self.assertTrue(
(config_path / "automations/include_dir_merge_list/sub/list4.yaml").exists()
)
automation_manager.reload()
self.assertEqual(
automation_manager.get("newlymade"),
ExtenededAutomation(
id="newlymade",
configuration_key="automation cools",
source_file="automations/include_dir_merge_list/sub/list4.yaml",
source_file_type="list",
),
)
def test_save_improper_types_list_to_obj(self):
config_path, automation_manager = self.get_manager(HA_CONFIG6_EXAMPLE)
automation_manager.reload()
self.assertTrue(
(config_path / "automations/include_dir_merge_list/sub/list2.yaml").exists()
)
with self.assertRaises(DBNoAutomationFound):
automation_manager.get("newlymade")
with self.assertRaises(AttemptingToOverwriteAnIncompatibleFileError):
automation_manager.update(
ExtenededAutomation(
id="newlymade",
configuration_key="automation cools",
source_file="automations/include_dir_merge_list/sub/list2.yaml",
source_file_type="obj",
),
create_if_not_found=True,
)
automation_manager.reload()
with self.assertRaises(DBNoAutomationFound):
automation_manager.get("newlymade")
data = yaml_serializer.load_yaml(
(config_path / "automations/include_dir_merge_list/sub/list2.yaml").open("r")
)
self.assertIsInstance(data, list)
def test_save_improper_types_obj_to_list(self):
config_path, automation_manager = self.get_manager(HA_CONFIG6_EXAMPLE)
automation_manager.reload()
self.assertTrue((config_path / "automations/include_dir_list/home/down.yaml").exists())
with self.assertRaises(DBNoAutomationFound):
automation_manager.get("newlymade")
with self.assertRaises(AttemptingToOverwriteAnIncompatibleFileError):
automation_manager.update(
ExtenededAutomation(
id="newlymade",
configuration_key="automation cools",
source_file="automations/include_dir_list/home/down.yaml",
source_file_type="list",
),
create_if_not_found=True,
)
automation_manager.reload()
with self.assertRaises(DBNoAutomationFound):
automation_manager.get("newlymade")
data = yaml_serializer.load_yaml(
(config_path / "automations/include_dir_list/home/down.yaml").open("r")
)
self.assertIsInstance(data, dict)
def test_update_tags_through_automation_update(self):
_, automation_manager = self.get_manager(HA_CONFIG_EXAMPLE)
automation_manager.reload()
auto = automation_manager.get("1619371298367")
self.assertDictEqual(
auto.tags,
{
"Room": "Living",
"Type": "Button",
},
)
auto.tags["Room"] = "Bathroom"
automation_manager.update(auto)
del auto
automation_manager.reload()
auto = automation_manager.get("1619371298367")
self.assertDictEqual(
auto.tags,
{
"Room": "Bathroom",
"Type": "Button",
},
)
def test_update_tags_through_tags(self):
_, automation_manager = self.get_manager(HA_CONFIG_EXAMPLE)
automation_manager.reload()
auto = automation_manager.get("1619371298367")
self.assertDictEqual(
auto.tags,
{
"Room": "Living",
"Type": "Button",
},
)
auto.tags["Room"] = "Bathroom"
automation_manager.update_tags(auto.id, auto.tags)
del auto
automation_manager.reload()
auto = automation_manager.get("1619371298367")
self.assertDictEqual(
auto.tags,
{
"Room": "Bathroom",
"Type": "Button",
},
)
def test_delete_tags(self):
_, automation_manager = self.get_manager(HA_CONFIG_EXAMPLE)
automation_manager.reload()
auto = automation_manager.get("1619371298367")
self.assertDictEqual(
auto.tags,
{
"Room": "Living",
"Type": "Button",
},
)
automation_manager.delete_tags(auto.id)
del auto
automation_manager.reload()
auto = automation_manager.get("1619371298367")
self.assertDictEqual(
auto.tags,
{},
)
manager.update_tags("test1", {"room": "bathroom"})
auto = manager.get(0)
assert auto.tags == {"room": "bathroom"}
+19
View File
@@ -0,0 +1,19 @@
from pathlib import Path
from tempfile import mktemp
from unittest import TestCase
from src.automations.db import AutomationDBConnection
def make_temp_db():
return AutomationDBConnection(Path(mktemp() + ".db"))
class TestWithDB(TestCase):
def setUp(self) -> None:
self.db = make_temp_db()
self.db.create_db()
self.db_file = self.db.db_file
def tearDown(self) -> None:
self.db_file.unlink()
+5 -11
View File
@@ -1,7 +1,6 @@
from unittest import TestCase
from src.automations.types import AutomationData, AutomationMetdata
from src.hass_config.errors import MissingFile
from src.automations.types import BaseAutomation
from src.hass_config.loader import HassConfig
from tests.utils import create_dummy_config_folder
@@ -9,41 +8,36 @@ from tests.utils import create_dummy_config_folder
class loader_tests(TestCase):
def test_load_automation_from_config_yaml(self):
folder = create_dummy_config_folder(
[AutomationData(metadata=AutomationMetdata(id="test"))],
[BaseAutomation(id="test")],
automation_in_conifguration_mode="inline",
)
hass_config = HassConfig(folder)
self.assertIsInstance(hass_config.configurations, dict)
self.assertTrue("automation" in hass_config.configurations)
self.assertEqual(hass_config.automations[0]["id"], "test")
def test_load_automation_from_config_yaml_include(self):
folder = create_dummy_config_folder(
[AutomationData(metadata=AutomationMetdata(id="test"))],
[BaseAutomation(id="test")],
automation_in_conifguration_mode="include",
)
hass_config = HassConfig(folder)
self.assertIsInstance(hass_config.configurations, dict)
self.assertTrue("automation" in hass_config.configurations)
self.assertEqual(hass_config.automations[0]["id"], "test")
def test_load_automation_from_infer(self):
folder = create_dummy_config_folder(
[AutomationData(metadata=AutomationMetdata(id="test"))],
[BaseAutomation(id="test")],
automation_in_conifguration_mode="none",
)
hass_config = HassConfig(folder)
self.assertIsInstance(hass_config.configurations, dict)
self.assertFalse("automation" in hass_config.configurations)
self.assertEqual(hass_config.automations[0]["id"], "test")
def test_missing_automations(self):
folder = create_dummy_config_folder(
[AutomationData(metadata=AutomationMetdata(id="test"))],
[BaseAutomation(id="test")],
automation_in_conifguration_mode="none",
)
(folder / "automations.yaml").unlink()
hass_config = HassConfig(folder)
self.assertIsInstance(hass_config.configurations, dict)
with self.assertRaises(MissingFile):
list(hass_config.automations)
+30 -2
View File
@@ -7,7 +7,6 @@ from src.yaml_serializer.types import (
IncludedYamlDir,
SecretValue,
)
from tests.utils import SAMPLES_FOLDER
class dumping_yamls_tests(TestCase):
@@ -25,10 +24,39 @@ class dumping_yamls_tests(TestCase):
yaml = dump_yaml({"google_password": SecretValue("gpass", "supersec")})
self.assertEqual(yaml, "google_password: !secret 'gpass'\n")
def test_dumping_stub(self):
def test_dumping_include_dir_list(self):
yaml = dump_yaml({"sensor": IncludedYamlDir("include_dir_list", "sensors/*yaml")})
self.assertEqual(yaml, "sensor: !include_dir_list 'sensors/*yaml'\n")
def test_dumping_include_dir_merge_list(self):
yaml = dump_yaml({"sensor": IncludedYamlDir("include_dir_merge_list", "sensors/*yaml")})
self.assertEqual(yaml, "sensor: !include_dir_merge_list 'sensors/*yaml'\n")
def test_load_complex_automation_setup(self):
yaml_obj = load_yaml(
io.StringIO(
"""
automation manual: !include_dir_list ./automations/include_dir_list
automation ui: !include automations/ui.yaml
automation: !include automations/base.yaml
automation cools: !include_dir_merge_list automations/include_dir_merge_list
"""
)
)
self.assertDictEqual(
dict(yaml_obj),
{
"automation manual": IncludedYamlDir(
"include_dir_list", "./automations/include_dir_list"
),
"automation ui": IncludedYaml("automations/ui.yaml"),
"automation cools": IncludedYamlDir(
"include_dir_merge_list", "automations/include_dir_merge_list"
),
"automation": IncludedYaml("automations/base.yaml"),
},
)
def test_load_stub(self):
yaml_obj = load_yaml(
io.StringIO(
+8 -5
View File
@@ -4,7 +4,7 @@ from tempfile import mkdtemp
from typing import List, Literal, Optional, Tuple
from src.automations.manager import AutomationManager
from src.automations.types import AutomationData
from src.automations.types import BaseAutomation
from src.hass_config.loader import HassConfig
from src.yaml_serializer import dump_yaml
from src.yaml_serializer.types import IncludedYaml
@@ -14,6 +14,9 @@ SAMPLES_FOLDER = THIS_FOLDER / "samples"
HA_CONFIG_EXAMPLE = SAMPLES_FOLDER / "config"
HA_CONFIG2_EXAMPLE = SAMPLES_FOLDER / "config-2"
HA_CONFIG3_EXAMPLE = SAMPLES_FOLDER / "config-3"
HA_CONFIG4_EXAMPLE = SAMPLES_FOLDER / "config-4"
HA_CONFIG5_EXAMPLE = SAMPLES_FOLDER / "config-5"
HA_CONFIG6_EXAMPLE = SAMPLES_FOLDER / "config-6"
def get_example_automation_loader(
@@ -43,7 +46,7 @@ def create_copy_of_example_config(config_to_copy: Path = HA_CONFIG_EXAMPLE) -> P
def get_dummy_automation_loader(
auto: List[AutomationData],
auto: List[BaseAutomation],
secrets: Optional[dict] = None,
other_config: Optional[dict] = None,
automation_in_conifguration_mode: Literal["include", "inline", "none"] = "include",
@@ -51,7 +54,7 @@ def get_dummy_automation_loader(
"""Creates a dummy /config structure for testing and return the loader and config
Args:
auto (List[AutomationData]): automations
auto (List[BaseAutomation]): automations
secrets (Optional[dict], optional): dictionary of secrets
other_config (Optional[dict], optional): some config stuff to place into configuration.yaml. Defaults to None.
automation_in_conifguration_mode (Literal['include', 'inline', 'none'], optional): whether to !include automation as a separete file or in the configuration yaml. Defaults to inline.
@@ -71,7 +74,7 @@ def get_dummy_automation_loader(
def create_dummy_config_folder(
auto: List[AutomationData],
auto: List[BaseAutomation],
secrets: Optional[dict] = None,
other_config: Optional[dict] = None,
automation_in_conifguration_mode: Literal["include", "inline", "none"] = "include",
@@ -79,7 +82,7 @@ def create_dummy_config_folder(
"""Creates a dummy /config structure for testing
Args:
auto (List[AutomationData]): automations
auto (List[BaseAutomation]): automations
secrets (Optional[dict], optional): dictionary of secrets
other_config (Optional[dict], optional): some config stuff to place into configuration.yaml. Defaults to None.
automation_in_conifguration_mode (Literal['include', 'inline', 'none'], optional): whether to !include automation as a separete file or in the configuration yaml. Defaults to inline.
BIN
View File
Binary file not shown.
-1
View File
@@ -1 +0,0 @@
../webapp/build
BIN
View File
Binary file not shown.

After

Width:  |  Height:  |  Size: 2.9 MiB

+1 -1
View File
@@ -1,5 +1,5 @@
name: Shortumation
version: v0.4.0
version: v0.5.3
slug: shortumation
image: asosnovsky/shortumation-{arch}
url: "https://github.com/asosnovsky/Shortumation"
+5 -2
View File
@@ -12,9 +12,12 @@ services:
shortumation:
# make sure to replace the ARCH with whatever system you are running!
image: "asosnovsky/shortumation-${ARCH:-amd64}:${SHORTUMATION_VERSION:-latest}"
network_mode: host
ports:
- 8000:8000
extra_hosts:
- "host.docker.internal:host-gateway"
volumes:
- ./config:/config
environment:
- SUPERVISOR_TOKEN=${SUPERVISOR_TOKEN}
- HASSIO_WS=ws://0.0.0.0:8123/api/websocket
- HASSIO_WS=ws://host.docker.internal:8123/api/websocket
+3
View File
@@ -0,0 +1,3 @@
{
"task.allowAutomaticTasks": true
}
+6 -2
View File
@@ -2,13 +2,17 @@
"version": "2.0.0",
"tasks": [
{
"icon": {
"id": "server-environment"
},
"type": "shell",
"label": "Docker: Server",
"label": "Docker: Start Server",
"group": "none",
"command": [".vscode/bin/start-docker-server.sh"],
"runOptions": {
"runOn": "folderOpen"
}
},
"problemMatcher": []
},
{
"type": "npm",
+2 -2
View File
@@ -17,7 +17,7 @@
"@uiw/react-codemirror": "4.10.4",
"autosuggest-highlight": "3.3.4",
"home-assistant-js-websocket": "7.1.0",
"jss": "10.9.1",
"jss": "10.9.2",
"material-ui-confirm": "3.0.4",
"notistack": "2.0.5",
"react": "18.2.0",
@@ -25,7 +25,7 @@
"react-dom": "18.2.0",
"react-flow-renderer": "10.3.12",
"react-imask": "6.4.2",
"react-jss": "10.9.1",
"react-jss": "10.9.2",
"react-router-dom": "6.3.0",
"react-scripts": "5.0.1",
"superstruct": "0.16.0",
+18 -7
View File
@@ -1,20 +1,31 @@
import './App.css';
import "./App.css";
import { Routes, Route, BrowserRouter } from "react-router-dom";
import { AutomationRoute } from 'routes/automation';
import { useConnectedApiService } from 'apiService';
import { ErrorBoundary } from 'components/ErrorBoundary';
import { AutomationRoute } from "routes/automation";
import { useConnectedApiService } from "apiService";
import { ErrorBoundary } from "components/ErrorBoundary";
import { CookiesProvider } from "react-cookie";
import { Page } from "components/Page";
const ConnectedAutomationRoute = () => {
const api = useConnectedApiService();
return <AutomationRoute api={api} />;
};
function App() {
const api = useConnectedApiService();
return (
<div className="app">
<ErrorBoundary>
<CookiesProvider>
<BrowserRouter>
<Routes>
<Route path="*" element={<AutomationRoute api={api} />} />
<Route
path="*"
element={
<Page>
<ConnectedAutomationRoute />
</Page>
}
/>
</Routes>
</BrowserRouter>
</CookiesProvider>
+13 -10
View File
@@ -1,4 +1,4 @@
import { AutomationData } from "types/automations";
import { AutomationData, BareAutomationData } from "types/automations";
import { API } from "./base";
import { ListData, ListParams } from "./types";
import {
@@ -18,13 +18,18 @@ export const makeAutomationAPI = (api: API) => ({
});
return data;
},
async update({ index, auto }: { index: number; auto: AutomationData }) {
async update(auto: AutomationData) {
return await api.makeCall({
method: "PUT",
path: AUTOMTAION_ITEM,
data: {
index,
data: auto,
},
data: auto,
});
},
async create(auto: BareAutomationData) {
return await api.makeCall({
method: "POST",
path: AUTOMTAION_ITEM,
data: auto,
});
},
async updateTags({
@@ -42,13 +47,11 @@ export const makeAutomationAPI = (api: API) => ({
},
});
},
async remove({ index }: { index: number }) {
async remove(auto: AutomationData) {
return await api.makeCall({
method: "DELETE",
path: AUTOMTAION_ITEM,
data: {
index,
},
data: auto,
});
},
});
+17 -19
View File
@@ -1,22 +1,20 @@
import { APIRequest, APIResponse } from './types';
import { APIRequest, APIResponse } from "./types";
export interface API {
makeCall: <Res = any, Req = any>(req: APIRequest<Req>) => Promise<APIResponse<Res>>;
makeCall: <Res = any, Req = any>(
req: APIRequest<Req>
) => Promise<APIResponse<Res>>;
}
export const makeRemoteAPI = (baseURL: string): API => ({
async makeCall({
path,
method = "POST",
data = {}
}) {
async makeCall({ path, method = "POST", data = {} }) {
try {
const payload: RequestInit = {
method,
headers: {
"Content-Type": "application/json"
"Content-Type": "application/json",
},
};
if (method !== 'GET') {
if (method !== "GET") {
payload["body"] = JSON.stringify(data);
}
const reply = await fetch(baseURL + path, payload);
@@ -25,27 +23,27 @@ export const makeRemoteAPI = (baseURL: string): API => ({
response = {
ok: true,
data: await reply.json(),
}
};
} else {
response = {
ok: false,
error: await reply.text(),
}
console.error(response)
};
console.error(response);
}
return response
return response;
} catch (err) {
console.error(err)
let error = String(err)
console.error(err);
let error = String(err);
if (err instanceof Error) {
error += ` ${err.stack}`
error += ` ${err.stack}`;
}
return {
ok: false,
error,
}
};
}
}
})
},
});
+1
View File
@@ -22,6 +22,7 @@ export const useAPIService = (automationAPI: AutomationAPI) => {
state,
removeAutomation: wrapCall(automationAPI.remove),
updateAutomation: wrapCall(automationAPI.update),
createAutomation: wrapCall(automationAPI.create),
updateTags: wrapCall(automationAPI.updateTags),
};
};
+9 -9
View File
@@ -24,12 +24,12 @@ test("mock api uses initial autos for initial population -- some data", async ()
test("populate mock api with some data", async () => {
const mockApi = makeAutomationAPI(useMockAPI([], fakeUseRef as any));
await mockApi.update({ index: 0, auto: createMockAuto() });
await mockApi.update(createMockAuto());
let data = await mockApi.list({ limit: 10, offset: 0 });
expect(data.ok).toBe(true);
expect((data as any).data.data).toHaveLength(1);
expect((data as any).data.totalItems).toBe(1);
await mockApi.update({ index: 1, auto: createMockAuto() });
await mockApi.update(createMockAuto());
data = await mockApi.list({ limit: 10, offset: 0 });
expect((data as any).data.data).toHaveLength(2);
expect((data as any).data.totalItems).toBe(2);
@@ -50,13 +50,13 @@ test("delete/update data from mock api", async () => {
);
let data = ((await mockApi.list({ limit: 10, offset: 0 })) as any).data.data;
const toBeEdited = data[0];
toBeEdited.metadata.alias = "Bob is my uncle";
await mockApi.update({ index: 0, auto: toBeEdited });
toBeEdited.alias = "Bob is my uncle";
await mockApi.update(toBeEdited);
data = ((await mockApi.list({ limit: 10, offset: 0 })) as any).data.data;
expect(data[0].metadata.alias).toEqual("Bob is my uncle");
await mockApi.remove({ index: 0 });
expect(data[0].alias).toEqual("Bob is my uncle");
await mockApi.remove(data[0]);
data = ((await mockApi.list({ limit: 10, offset: 0 })) as any).data.data;
expect(data[0].metadata.alias === "Bob is my uncle").toEqual(false);
expect(data[0].alias === "Bob is my uncle").toEqual(false);
});
test("update tags from mock api", async () => {
@@ -74,7 +74,7 @@ test("update tags from mock api", async () => {
);
let data = ((await mockApi.list({ limit: 10, offset: 0 })) as any).data
.data as AutomationData[];
const autoId = data[0].metadata.id;
const autoId = data[0].id;
expect(data[0].tags).toStrictEqual({});
mockApi.updateTags({
automation_id: autoId,
@@ -85,7 +85,7 @@ test("update tags from mock api", async () => {
});
data = ((await mockApi.list({ limit: 10, offset: 0 })) as any).data
.data as AutomationData[];
expect(data[0].metadata.id).toEqual(autoId);
expect(data[0].id).toEqual(autoId);
expect(data[0].tags).toStrictEqual({
room: "bathroom",
type: "popup",
+29 -9
View File
@@ -1,5 +1,5 @@
import { useRef } from "react";
import { AutomationData } from "types/automations";
import { AutomationData, BareAutomationData } from "types/automations";
import { API } from "./base";
import {
AUTOMTAION_LIST,
@@ -35,10 +35,16 @@ export const useMockAPI = (
} as any;
}
if (path === AUTOMTAION_ITEM) {
if (method === "POST") {
const { index, data: auto } = data as any;
if (index >= automationsRef.current.length) {
automationsRef.current = [...automationsRef.current, auto];
if (method === "PUT") {
const auto = data as AutomationData;
const index = automationsRef.current.findIndex(
({ id }) => auto.id === id
);
if (index < 0) {
return {
ok: false,
error: "Not Found",
};
} else {
automationsRef.current = [
...automationsRef.current.slice(0, index),
@@ -51,10 +57,24 @@ export const useMockAPI = (
data: {},
};
} else if (method === "DELETE") {
const { index } = data as any;
const auto = data as AutomationData;
automationsRef.current = automationsRef.current.filter(
({ id }) => id !== auto.id
);
return {
ok: true,
data: {},
};
} else if (method === "POST") {
const auto = data as BareAutomationData;
automationsRef.current = [
...automationsRef.current.slice(0, index),
...automationsRef.current.slice(index + 1),
...automationsRef.current,
{
...auto,
source_file: "automation.yaml",
source_file_type: "list",
configuration_key: "automation",
},
];
return {
ok: true,
@@ -67,7 +87,7 @@ export const useMockAPI = (
const { automation_id, tags } = data as any;
for (let i = 0; i < automationsRef.current.length; i++) {
const auto = automationsRef.current[i];
if (auto.metadata.id === automation_id) {
if (auto.id === automation_id) {
automationsRef.current[i].tags = JSON.parse(JSON.stringify(tags));
break;
}
+15 -12
View File
@@ -1,26 +1,29 @@
import { AutomationData } from "types/automations";
export interface ListParams {
offset: number;
limit: number;
}
export type APIRequest<D> = {
path: string;
method?: "POST" | "DELETE" | "GET",
method?: "POST" | "DELETE" | "GET" | "PUT";
data?: D;
};
export type APIResponse<D> = {
ok: true;
data: D;
} | {
ok: false;
error: string;
}
export type Errorable<D> = ({ ready: true } & APIResponse<D>) | {
ready: false;
}
export type APIResponse<D> =
| {
ok: true;
data: D;
}
| {
ok: false;
error: string;
};
export type Errorable<D> =
| ({ ready: true } & APIResponse<D>)
| {
ready: false;
};
export interface ListData<D> {
params: ListParams;
totalItems: number;
+2 -2
View File
@@ -27,10 +27,10 @@ export const makeReloadAutomations = (
});
};
const wrapCall = <Call extends (a: any) => Promise<any>>(fcn: Call) => {
return async (args: Parameters<Call>[0]): Promise<ReturnType<Call>> => {
return async (args: Parameters<Call>[0]) => {
const resp = await fcn(args);
await reload();
return resp;
return resp as ReturnType<Call>;
};
};
return {
@@ -44,6 +44,9 @@ export const NoTags = make({
wowo: "!",
},
mode: "single",
source_file: "automation.yaml",
source_file_type: "list",
configuration_key: "automation",
},
});
@@ -60,5 +63,8 @@ export const SomeTags = make({
wowo: "!",
},
mode: "single",
source_file: "automation.yaml",
source_file_type: "list",
configuration_key: "automation",
},
});
@@ -1,7 +1,10 @@
import "./AutoInfoBox.css";
import { AutomationMetadata } from "types/automations";
import {
AutomationMetadata,
AutomationShortumationMetadata,
} from "types/automations";
import { InputList } from "components/Inputs/InputList";
import InputText from "components/Inputs/InputText";
import InputText from "components/Inputs/Base/InputText";
import { FC, ReactNode, useRef, useState } from "react";
import { AddIcon, TrashIcon } from "components/Icons";
import InputAutoText from "components/Inputs/InputAutoText";
@@ -9,7 +12,7 @@ import { TagDB } from "components/AutomationManager/TagDB";
import { ButtonIcon } from "components/Icons/ButtonIcons";
export interface AutoInfoBoxProps {
metadata: AutomationMetadata;
metadata: AutomationMetadata & Partial<AutomationShortumationMetadata>;
tags: Array<[string, string]>;
onUpdate: (m: AutomationMetadata, tags: Array<[string, string]>) => void;
tagDB: TagDB;
@@ -21,7 +21,7 @@ const Template: ComponentStory<typeof AutomationEditor> = (args) => {
<AutomationEditor
{...args}
tagDB={useTagDB(
state ? [{ id: state.metadata.id, tags: state.tags }] : [],
state ? [{ id: state.id, tags: state.tags }] : [],
() => {}
)}
automation={state}
@@ -46,16 +46,16 @@ Simple.args = {
Type: "Smell",
Use: "Flushing",
},
metadata: {
id:
"random" + String(Date.now()) + String(Date.now()) + String(Date.now()),
alias: "Random",
description: "Example Metadata",
trigger_variables: {
wowo: "!",
},
mode: "single",
id: "random" + String(Date.now()) + String(Date.now()) + String(Date.now()),
alias: "Random",
description: "Example Metadata",
trigger_variables: {
wowo: "!",
},
mode: "single",
source_file: "automation.yaml",
source_file_type: "list",
configuration_key: "automation",
trigger: [
{
platform: "numeric_state",
@@ -66,7 +66,7 @@ Simple.args = {
event: "start",
},
],
sequence: [
action: [
{
condition: "and",
conditions: [
@@ -102,17 +102,18 @@ EmptyStart.args = {
automation: {
condition: [],
tags: {},
metadata: {
id: "random",
alias: "Random",
description: "Example Metadata",
trigger_variables: {
wowo: "!",
},
mode: "single",
id: "random",
alias: "Random",
description: "Example Metadata",
source_file: "automation.yaml",
source_file_type: "list",
configuration_key: "automation",
trigger_variables: {
wowo: "!",
},
mode: "single",
trigger: [],
sequence: [],
action: [],
},
};
@@ -122,10 +123,9 @@ BadAutomationInvalidMetadata.args = {
automation: {
condition: [],
tags: {},
metadata: {} as any,
trigger: [],
sequence: [],
},
action: [],
} as any,
};
export const BadAutomationInvalidTriggers = Template.bind({});
@@ -134,17 +134,18 @@ BadAutomationInvalidTriggers.args = {
automation: {
condition: [],
tags: {},
metadata: {
id: "random",
alias: "Random",
description: "Example Metadata",
trigger_variables: {
wowo: "!",
},
mode: "single",
id: "random",
alias: "Random",
description: "Example Metadata",
source_file: "automation.yaml",
source_file_type: "list",
configuration_key: "automation",
trigger_variables: {
wowo: "!",
},
mode: "single",
trigger: ["haha I am a string"] as any,
sequence: [],
action: [],
},
};
@@ -154,34 +155,32 @@ BadAutomationInvalidSequence.args = {
automation: {
condition: [],
tags: {},
metadata: {
id: "random",
alias: "Bad Choose Sequence",
description: "Example Metadata",
trigger_variables: {
wowo: "!",
},
mode: "single",
alias: "Bad Choose Sequence",
description: "Example Metadata",
trigger_variables: {
wowo: "!",
},
mode: "single",
trigger: [],
sequence: [
action: [
{
choose: {},
},
] as any,
},
],
} as any,
};
export const RepeatExample = Template.bind({});
RepeatExample.args = {
...RepeatExample.args,
automation: {
metadata: {
id: "1654976151462",
alias: "Get out of baby room",
description: "",
mode: "single",
},
id: "1654976151462",
alias: "Get out of baby room",
description: "",
mode: "single",
source_file: "automation.yaml",
source_file_type: "list",
configuration_key: "automation",
trigger: [
{
type: "opened",
@@ -192,7 +191,7 @@ RepeatExample.args = {
},
],
condition: [],
sequence: [
action: [
{
service: "notify.mobile_app_levas_phone",
data: {
@@ -3,35 +3,41 @@ import "./index.mobile.css";
import { FC, useState } from "react";
import { useCookies } from "react-cookie";
import { ControlButton } from "react-flow-renderer";
import Skeleton from "@mui/material/Skeleton";
import LinearProgress from "@mui/material/LinearProgress";
import SpeedDial from "@mui/material/SpeedDial";
import SpeedDialAction from "@mui/material/SpeedDialAction";
import Edit from "@mui/icons-material/Edit";
import SpeedDialIcon from "@mui/icons-material/SettingsRounded";
import UndoIcon from "@mui/icons-material/UndoSharp";
import Icon from "@mui/material/Icon";
import ModeEditOutlineTwoToneIcon from "@mui/icons-material/ModeEditOutlineTwoTone";
import EditIcon from "@mui/icons-material/ModeEditOutlineTwoTone";
import DeleteIcon from "@mui/icons-material/DeleteForever";
import { CheckMarkIcon } from "components/Icons";
import RunIcon from "@mui/icons-material/RunCircleOutlined";
import { Modal } from "components/Modal";
import { Button } from "components/Inputs/Button";
import InputYaml from "components/Inputs/InputYaml";
import { Button } from "components/Inputs/Buttons/Button";
import InputYaml from "components/Inputs/Base/InputYaml";
import { TagDB } from "components/AutomationManager/TagDB";
import { DAGDims } from "components/DAGGraph/elements/types";
import { DAGAutomationGraph } from "components/DAGGraph";
import { InputList } from "components/Inputs/InputList";
import { InputTextView } from "components/Inputs/InputTextView";
import { AutomationData } from "types/automations";
import { AutomationData, BareAutomationData } from "types/automations";
import { MiniFailure } from "types/validators/helper";
import { AutoInfoBox } from "./AutoInfoBox";
import { useAutomatioEditorState, EditorData } from "./state";
interface Props {
automation?: AutomationData;
automation?: AutomationData | BareAutomationData;
dims: DAGDims;
onUpdate: (auto: AutomationData) => void;
onUpdate: (auto: AutomationData | BareAutomationData) => void;
onTrigger: () => void;
onDelete: () => void;
tagDB: TagDB;
isNew?: boolean;
}
@@ -39,6 +45,8 @@ export const AutomationEditor: FC<Props> = ({
dims,
automation: propsAutos,
onUpdate: propsOnUpdate,
onDelete,
onTrigger,
tagDB,
isNew,
}) => {
@@ -52,6 +60,7 @@ export const AutomationEditor: FC<Props> = ({
validate,
save,
saveAndUpdate,
undo,
} = useAutomatioEditorState(propsAutos, propsOnUpdate);
const [infoBoxOpen, setInfoBox] = useState(false);
const [
@@ -90,7 +99,7 @@ export const AutomationEditor: FC<Props> = ({
)}
<Modal open={infoBoxOpen}>
<AutoInfoBox
metadata={state.data.metadata}
metadata={state.data}
tags={state.data.tags}
onUpdate={updateMetadata}
tagDB={tagDB}
@@ -119,14 +128,14 @@ export const AutomationEditor: FC<Props> = ({
<div className="automation-editor--flow-wrapper--toolbar">
<div className="automation-editor--flow-wrapper--toolbar--title">
<span className="automation-editor--flow-wrapper--toolbar--title--text">
<div className="id">{state.data.metadata.id}</div>
<div className="id">{state.data.id}</div>
<InputTextView
value={state.data.metadata.alias ?? ""}
value={state.data.alias ?? ""}
placeholder="Name"
onChange={(alias) =>
updateMetadata(
{
...state.data.metadata,
...state.data,
alias,
},
state.data.tags
@@ -139,13 +148,13 @@ export const AutomationEditor: FC<Props> = ({
label="Mode"
className="automation-editor--flow-wrapper--toolbar--modes"
current={{
id: state.data.metadata.mode,
id: state.data.mode,
label: "",
}}
onChange={({ id }) =>
updateMetadata(
{
...state.data.metadata,
...state.data,
mode: id,
},
state.data.tags
@@ -176,12 +185,12 @@ export const AutomationEditor: FC<Props> = ({
/>
<InputTextView
className="description"
value={state.data.metadata.description ?? ""}
value={state.data.description ?? ""}
placeholder="Description"
onChange={(description) =>
updateMetadata(
{
...state.data.metadata,
...state.data,
description,
},
state.data.tags
@@ -198,34 +207,65 @@ export const AutomationEditor: FC<Props> = ({
Flip
</Button>
)}
<Button
className={"automation-editor--flow-wrapper--toolbar--edit-btn"}
onClick={() => setInfoBox(!infoBoxOpen)}
>
Metadata <Edit />
</Button>
{state.status === "changed" && (
<Button onClick={undo}>
<UndoIcon />
</Button>
)}
<Button
className={"automation-editor--flow-wrapper--toolbar--save-btn"}
onClick={save}
disabled={state.status !== "changed" && !isNew}
disabled={state.status !== "changed"}
>
Save <CheckMarkIcon color="#bf4" />
</Button>
</div>
<DAGAutomationGraph
sequence={state.data.sequence}
action={state.data.action}
trigger={state.data.trigger}
condition={state.data.condition}
onSequenceUpdate={updateSequence}
onActionUpdate={updateSequence}
onTriggerUpdate={updateTrigger}
onConditionUpdate={updateCondition}
isFlipped={flipped}
additionalControls={
<ControlButton onClick={() => setInfoBox(!infoBoxOpen)}>
<ModeEditOutlineTwoToneIcon />
</ControlButton>
}
/>
<SpeedDial
ariaLabel="options label"
sx={{
position: "absolute",
bottom: 16,
right: 16,
}}
icon={<SpeedDialIcon />}
>
<SpeedDialAction
// tooltipOpen
sx={{ pointerEvents: "auto" }}
icon={<RunIcon />}
tooltipTitle={"Trigger"}
onClick={onTrigger}
/>
<SpeedDialAction
// tooltipOpen
icon={<DeleteIcon />}
tooltipTitle={"Delete"}
onClick={onDelete}
/>
<SpeedDialAction
// tooltipOpen
icon={<EditIcon />}
tooltipTitle={"Metadata"}
onClick={() => setInfoBox(!infoBoxOpen)}
/>
{state.status === "changed" && (
<SpeedDialAction
// tooltipOpen
icon={<UndoIcon />}
tooltipTitle={"Undo"}
onClick={undo}
/>
)}
</SpeedDial>
</div>
</div>
);
@@ -242,26 +282,24 @@ export const ValidationBox: FC<{
data: props.data,
});
const makeSave =
<K extends keyof EditorData>(k: K) =>
(d: EditorData[K]) => {
const newData = {
...data,
[k]: d,
};
const newFails = props.validate(newData);
if (newFails) {
setState({
failures: newFails,
data: newData,
});
} else {
setState({
failures: [],
data: newData,
});
}
const onSave = (d: EditorData) => {
const newData = {
...data,
...d,
};
const newFails = props.validate(newData);
if (newFails) {
setState({
failures: newFails,
data: newData,
});
} else {
setState({
failures: [],
data: newData,
});
}
};
return (
<div className="automation-editor-failures">
@@ -282,27 +320,7 @@ export const ValidationBox: FC<{
<span>
Please correct the automation file manually and then continue!
</span>
<InputYaml
label="Metadata"
value={data.metadata}
onChange={makeSave("metadata")}
/>
<InputYaml label="Tags" value={data.tags} onChange={makeSave("tags")} />
<InputYaml
label="Trigger"
value={data.trigger}
onChange={makeSave("trigger")}
/>
<InputYaml
label="Condition"
value={data.condition}
onChange={makeSave("condition")}
/>
<InputYaml
label="Actions"
value={data.sequence}
onChange={makeSave("sequence")}
/>
<InputYaml label="Raw" value={data} onChange={onSave} />
<Button disabled={failures.length > 0} onClick={() => props.onSave(data)}>
Save
</Button>
+154 -101
View File
@@ -1,117 +1,170 @@
import { useState, useEffect } from 'react';
import { AutomationData, AutomationMetadata } from "types/automations";
import { useState, useEffect } from "react";
import {
AutomationData,
AutomationMetadata,
BareAutomationData,
} from "types/automations";
import * as v from "types/validators/autmation";
import { getFailures } from "types/validators/helper";
import { MiniFailure } from '../../types/validators/helper';
import { getFailures, MiniFailure } from "types/validators/helper";
export type EditorData = ReturnType<typeof genEditorData>;
export type EditorState = {
status: 'unchanged' | 'changed' | 'saving',
data: EditorData
} | {
status: 'loading'
} | {
status: 'invalid',
failures: MiniFailure[],
data: EditorData,
}
export type EditorStatus = EditorState['status'];
export type EditorState =
| {
status: "unchanged";
data: EditorData;
}
| {
status: "changed" | "saving";
previous: EditorData[];
data: EditorData;
}
| {
status: "loading";
}
| {
status: "invalid";
failures: MiniFailure[];
data: EditorData;
};
export type EditorStatus = EditorState["status"];
export const useAutomatioEditorState = (
automation: AutomationData | undefined,
onSave: (a: AutomationData) => void,
automation: AutomationData | BareAutomationData | undefined,
onSave: (a: AutomationData | BareAutomationData) => void
) => {
const [state, update] = useState<EditorState>({
status: "loading",
});
const makeUpdate = <K extends keyof EditorData, D extends EditorData[K]>(name: K) => (
data: D
) => ((state.status === 'changed') || (state.status === 'unchanged')) && update({
status: 'changed',
// state
const [state, update] = useState<EditorState>({
status: "loading",
});
// helpers
const validate = (data: any) => {
return getFailures(data, v.AutomationData);
};
const makeUpdate =
<K extends keyof EditorData, D extends EditorData[K]>(name: K) =>
(data: D) =>
(state.status === "changed" || state.status === "unchanged") &&
update({
status: "changed",
previous:
state.status === "unchanged"
? [state.data]
: state.previous.concat([state.data]),
data: {
...state.data,
[name]: data,
}
})
...state.data,
[name]: data,
},
});
const saveAndUpdate = (data: EditorData) => {
const cleanData = {
...data,
tags: data.tags.reduce((all, [tagName, tagValue]) => ({
...all,
[tagName.trim()]: tagValue.trim(),
}), {})
};
const saveAndUpdate = (data: EditorData) => {
if (state.status === "changed") {
const cleanData = {
...data,
tags: data.tags.reduce(
(all, [tagName, tagValue]) => ({
...all,
[tagName.trim()]: tagValue.trim(),
}),
{}
),
};
update({
status: "saving",
previous: state.previous,
data,
});
onSave(cleanData);
}
};
// pub methods
const methods = {
validate,
updateTrigger: makeUpdate("trigger"),
updateSequence: makeUpdate("action"),
updateCondition: makeUpdate("condition"),
saveAndUpdate,
updateMetadata: (
metadata: AutomationMetadata,
tags: Array<[string, string]>
) => {
if (state.status === "changed" || state.status === "unchanged") {
update({
status: "saving",
data,
})
onSave(cleanData);
}
useEffect(() => {
if (automation) {
const failures = getFailures(automation, v.AutomationData);
if (failures) {
update({
status: 'invalid',
failures,
data: genEditorData(automation),
})
} else {
update({
status: 'unchanged',
data: genEditorData(automation),
})
}
status: "changed",
previous:
state.status === "changed"
? state.previous.concat([state.data])
: [state.data],
data: {
...state.data,
tags,
...metadata,
},
});
}
},
save: () => {
if (state.status !== "loading") {
saveAndUpdate(state.data);
}
},
undo: () => {
if (state.status === "changed") {
if (state.previous.length === 1) {
update({
status: "unchanged",
data: state.previous[0],
});
} else {
update({
status: "changed",
data: state.previous[state.previous.length - 1],
previous: state.previous.slice(0, state.previous.length - 1),
});
}
}, [automation]);
}
},
get state() {
return state;
},
};
return {
validate: (data: any) => getFailures(data, v.AutomationData),
updateTrigger: makeUpdate('trigger'),
updateSequence: makeUpdate('sequence'),
updateCondition: makeUpdate('condition'),
saveAndUpdate,
updateMetadata: (metadata: AutomationMetadata, tags: Array<[string, string]>) => {
if ((state.status === 'changed') || (state.status === 'unchanged')) {
update({
status: 'changed',
data: {
...state.data,
tags,
metadata,
}
})
}
},
save: () => {
if (state.status !== 'loading') {
saveAndUpdate(state.data)
}
},
get state() {
return state;
}
// effects
useEffect(() => {
if (automation) {
const failures = validate(automation);
if (failures) {
update({
status: "invalid",
failures,
data: genEditorData(automation),
});
} else {
update({
status: "unchanged",
data: genEditorData(automation),
});
}
}
}
}, [automation]);
return methods;
};
const genEditorData = (automation: AutomationData) => {
const {
metadata,
trigger,
sequence,
condition,
} = automation;
const genEditorData = (automation: AutomationData | BareAutomationData) => {
const { tags: rawTags, trigger, action, condition, ...metadata } = automation;
const tags: [string, string][] = Object.keys(automation.tags).map(tagName => [tagName, automation.tags[tagName]]);
const tags: [string, string][] = Object.keys(rawTags).map((tagName) => [
tagName,
rawTags[tagName],
]);
return {
metadata,
trigger,
sequence,
condition,
tags,
}
}
return {
...metadata,
trigger,
action,
condition,
tags,
};
};
@@ -13,6 +13,10 @@
user-select: none;
}
.automation-manager--list-box-group.modified {
border: 1px var(--mui-success-main) solid;
}
.automation-manager--list-box-group {
border-color: var(--mui-text-secondary);
border-width: 0.125px;
@@ -14,7 +14,10 @@ const { make, componentMeta } = makeStory({
args: {
title: "Example",
type: "items",
isSelected: false,
flags: {
isSelected: false,
isModified: false,
},
data: [
{
id: "1",
@@ -23,7 +26,13 @@ const { make, componentMeta } = makeStory({
description: "Amazing automation!",
tags: {},
state: "on",
isSelected: false,
source_file: "automation.yaml",
source_file_type: "list",
configuration_key: "automation",
flags: {
isSelected: false,
isModified: false,
},
},
{
id: "2",
@@ -31,7 +40,13 @@ const { make, componentMeta } = makeStory({
entityId: "automation.2",
description: "Cool!",
state: "on",
isSelected: false,
source_file: "automation.yaml",
source_file_type: "list",
configuration_key: "automation",
flags: {
isSelected: false,
isModified: false,
},
tags: {
room: "main bedroom",
routine: "night time",
@@ -48,16 +63,25 @@ export const Basic = make({});
export const Nested = make({
title: "Top Group",
type: "group",
isSelected: false,
flags: {
isSelected: false,
isModified: false,
},
data: [
{
title: "Subgroup 1",
type: "group",
isSelected: true,
flags: {
isSelected: true,
isModified: false,
},
data: [
{
type: "items",
isSelected: true,
flags: {
isSelected: true,
isModified: false,
},
title: "Subsub group",
data: [
{
@@ -66,7 +90,13 @@ export const Nested = make({
description: "",
title: "Automation #1",
state: "on",
isSelected: true,
source_file: "automation.yaml",
source_file_type: "list",
configuration_key: "automation",
flags: {
isSelected: true,
isModified: false,
},
tags: {},
},
{
@@ -75,7 +105,13 @@ export const Nested = make({
description: "another one",
title: "Automation #2",
state: "off",
isSelected: false,
source_file: "automation.yaml",
source_file_type: "list",
configuration_key: "automation",
flags: {
isSelected: false,
isModified: false,
},
tags: {},
},
{
@@ -84,7 +120,13 @@ export const Nested = make({
description: "bad one",
title: "Automation #3",
state: "offing",
isSelected: false,
source_file: "automation.yaml",
source_file_type: "list",
configuration_key: "automation",
flags: {
isSelected: false,
isModified: false,
},
tags: {
type: "bad",
},
@@ -96,20 +138,32 @@ export const Nested = make({
{
title: "Subgroup 2",
type: "group",
isSelected: false,
flags: {
isSelected: false,
isModified: false,
},
data: [],
},
{
title: "Other",
type: "items",
isSelected: false,
flags: {
isSelected: false,
isModified: false,
},
data: [
{
id: "4",
entityId: "automation.4",
description: "Cool thing",
title: "Automation #4",
isSelected: false,
flags: {
isSelected: false,
isModified: false,
},
source_file: "automation.yaml",
source_file_type: "list",
configuration_key: "automation",
state: "on",
tags: {
type: "good",
@@ -16,6 +16,7 @@ export type ListBoxGroupProps = AutomationManagerItem & {
) => void;
onAutomationDelete: (aid: string, eid: string) => void;
onSelect: (aid: string) => void;
onRun: (eid: string) => void;
initialOpenState?: boolean;
tagsDB: TagDB;
};
@@ -23,7 +24,7 @@ export const ListBoxGroup: FC<ListBoxGroupProps> = ({
title,
type,
data,
isSelected,
flags,
initialOpenState,
tagsDB,
...events
@@ -41,7 +42,8 @@ export const ListBoxGroup: FC<ListBoxGroupProps> = ({
<div
className={[
"automation-manager--list-box-group",
isSelected ? "selected" : "",
flags.isSelected ? "selected" : "",
flags.isModified ? "modified" : "",
].join(" ")}
>
<div
@@ -67,7 +69,9 @@ export const ListBoxGroup: FC<ListBoxGroupProps> = ({
onDelete={() =>
events.onAutomationDelete(auto.id, auto.entityId)
}
isSelected={auto.flags.isSelected}
onSelect={() => events.onSelect(auto.id)}
onRun={() => events.onRun(auto.entityId)}
onDescriptionUpdate={(description) =>
events.onAutomationUpdate(
{
@@ -1,6 +1,6 @@
import { HassEntities } from "home-assistant-js-websocket";
import { useEffect, useState } from "react";
import { AutomationData } from "types/automations";
import { AutomationData, BareAutomationData } from "types/automations";
import { defaultAutomation } from "utils/defaults";
import { TagDB } from "../TagDB";
import { AutomationManagerAuto } from "../types";
@@ -12,7 +12,9 @@ export const useAutomationDB = (
) => {
const autoMap = genMapping(haEntities, configAutomations, tagsDB);
const [newAuto, setNewAuto] =
useState<null | [AutomationManagerAuto, AutomationData]>(null);
useState<
null | [AutomationManagerAuto, AutomationData | BareAutomationData]
>(null);
useEffect(() => {
if (newAuto && autoMap[newAuto[0].id]) {
@@ -28,17 +30,15 @@ export const useAutomationDB = (
return out;
}
},
getAutomationData(autoId: string) {
getAutomationData(
autoId: string
):
| null
| [AutomationManagerAuto, AutomationData | BareAutomationData | null] {
if (newAuto && newAuto[0].id === autoId) {
return newAuto[1];
return newAuto;
}
return (autoMap[autoId] ?? [null, null])[1];
},
getAutomationState(autoId: string): string | null {
if (newAuto && newAuto[0].id === autoId) {
return newAuto[0].state;
}
return (autoMap[autoId] ?? [{ state: null }, null])[0].state;
return autoMap[autoId] ?? null;
},
isAutoNew(autoId: string) {
return (newAuto && newAuto[0].id === autoId) ?? false;
@@ -50,14 +50,17 @@ export const useAutomationDB = (
const auto = defaultAutomation(String(Date.now()));
setNewAuto([
{
id: auto.metadata.id,
id: auto.id,
entityId: "",
title: auto.metadata.alias ?? "",
description: auto.metadata.description ?? "",
title: auto.alias ?? "",
description: auto.description ?? "",
state: "unregistered",
tags: {},
issue: "New Automation",
isNew: true,
source_file: "n/a",
source_file_type: "n/a",
configuration_key: "n/a",
},
auto,
]);
@@ -74,7 +77,7 @@ const genMapping = (
const configData: Record<string, AutomationData> = configAutomations.reduce(
(all, n) => ({
...all,
[n.metadata.id]: n,
[n.id]: n,
}),
{}
);
@@ -92,11 +95,16 @@ const genMapping = (
? undefined
: `recived invalid state "${entityData.state}, this could be because you have a lingering automation that was not cleared by homeassistant, try to reboot HA or manually clear this automation from HA Database."`;
let found: AutomationData | null = null;
let source_file = "n/a";
let source_file_type = "n/a";
let configuration_key = "n/a";
if (configData[autoId]) {
found = configData[entityData.attributes.id];
title = found.metadata.alias ?? title;
description = found.metadata.description ?? description;
title = found.alias ?? title;
description = found.description ?? description;
source_file = found.source_file ?? source_file;
source_file_type = found.source_file_type ?? source_file_type;
configuration_key = found.configuration_key ?? configuration_key;
delete configData[autoId];
} else {
issue = "failed to find this automation in '/config' folder";
@@ -110,6 +118,9 @@ const genMapping = (
description,
state: entityData.state,
tags: tagsDB.getTags(autoId),
source_file,
source_file_type,
configuration_key,
issue,
},
found,
@@ -117,14 +128,17 @@ const genMapping = (
});
Object.values(configData).forEach((auto) => {
automatioinMap[auto.metadata.id] = [
automatioinMap[auto.id] = [
{
id: auto.metadata.id,
id: auto.id,
entityId: "",
title: auto.metadata.alias ?? "",
description: auto.metadata.description ?? "",
title: auto.alias ?? "",
description: auto.description ?? "",
state: "unregistered",
tags: tagsDB.getTags(auto.metadata.id),
tags: tagsDB.getTags(auto.id),
source_file: auto.source_file,
source_file_type: auto.source_file_type,
configuration_key: auto.configuration_key,
issue:
"homeassistant did not load this automation, try to manually reload automations or restart homeassistant.",
},
@@ -9,14 +9,27 @@ import {
UseAutomationManagerStateArgs,
} from "./state";
import Alert from "@mui/material/Alert";
import { useConfirm } from "material-ui-confirm";
export type AutomationManagerLoadedProps = UseAutomationManagerStateArgs & {
onAutomationDelete: (aid: string, eid: string) => void;
};
export const AutomationManagerLoaded: FC<
PropsWithChildren<AutomationManagerLoadedProps>
> = ({ children, onAutomationDelete, ...args }) => {
> = ({ children, ...args }) => {
const state = useAutomationManagerState(args);
const confirm = useConfirm();
const onAutomationDelete = async (aid: string, eid: string) =>
confirm({
title: "Are you sure you want to delete this automation?",
confirmationText: "Delete",
})
.then(() => {
args.onAutomationDelete(aid, eid);
state.setSelectedAutomationId(null);
})
.catch(() => {});
return (
<div className="automation-manager">
@@ -27,11 +40,9 @@ export const AutomationManagerLoaded: FC<
selectedAutomationId={state.currentAutomationId}
onSelectedAutomationId={state.setSelectedAutomationId}
onAutomationAdd={() => state.addNew()}
onAutomationDelete={(aid, eid) => {
onAutomationDelete(aid, eid);
state.setSelectedAutomationId(null);
}}
onAutomationDelete={onAutomationDelete}
onAutomationUpdate={state.sideBarUpdateAutomation}
onRun={args.onAutomationRun}
/>
<div className={["automation-manager--editor"].join(" ")}>
{state.currentAutomationId !== null ? (
@@ -43,6 +54,22 @@ export const AutomationManagerLoaded: FC<
}}
automation={state.currentAutomation}
onUpdate={state.editorUpdateAutomation}
onDelete={() => {
if (
state.currentAutomationId &&
state.currentAutomationEntityId
) {
onAutomationDelete(
state.currentAutomationId,
state.currentAutomationEntityId
);
}
}}
onTrigger={() => {
if (state.currentAutomationEntityId) {
args.onAutomationRun(state.currentAutomationEntityId);
}
}}
tagDB={state.tagsDB}
isNew={state.currentAutomationIsNew}
/>
@@ -1,7 +1,7 @@
import { HassEntities } from "home-assistant-js-websocket";
import { useState } from "react";
import { useCookies } from "react-cookie";
import { AutomationData } from "types/automations";
import { AutomationData, BareAutomationData } from "types/automations";
import { useTagDB } from "../TagDB";
import { useAutomationDB } from "./automationDB";
import { useConfirm } from "material-ui-confirm";
@@ -12,9 +12,10 @@ export type UseAutomationManagerStateArgs = {
configAutomations: AutomationData[];
hassEntities: HassEntities;
onUpdateTags: (aid: string, tags: Record<string, string>) => void;
onAutomationAdd: (auto: AutomationData) => void;
onAutomationUpdate: (aid: string, auto: AutomationData) => void;
onAutomationAdd: (auto: BareAutomationData) => void;
onAutomationUpdate: (auto: AutomationData) => void;
onAutomationStateChange: (eid: string, on: boolean) => void;
onAutomationRun: (eid: string) => void;
};
export const useAutomationManagerState = ({
configAutomations,
@@ -29,10 +30,12 @@ export const useAutomationManagerState = ({
const snackbr = useSnackbar();
const cookies = useAMSCookies();
const tagsDB = useTagDB(
configAutomations.map(({ metadata: { id }, tags }) => ({
id,
tags,
})),
configAutomations
.filter((a) => typeof a === "object")
.map(({ id, tags = {} }) => ({
id,
tags,
})),
onUpdateTags
);
const automationDB = useAutomationDB(hassEntities, configAutomations, tagsDB);
@@ -65,12 +68,15 @@ export const useAutomationManagerState = ({
get tagsDB() {
return tagsDB;
},
get currentAutomation() {
return currentAutomation;
get currentAutomation(): AutomationData | BareAutomationData | null {
return currentAutomation === null ? null : currentAutomation[1];
},
get currentAutomationIsNew() {
return automationDB.isAutoNew(cookies.currentAutomationId ?? "");
},
get currentAutomationEntityId(): string | null {
return currentAutomation === null ? null : currentAutomation[0].entityId;
},
async setSelectedAutomationId(i: string | null, force: boolean = false) {
if (methods.currentAutomationIsNew && !force) {
if (!(await stillHaveNewAreYouSure())) {
@@ -87,13 +93,13 @@ export const useAutomationManagerState = ({
}
}
const auto = automationDB.addNew();
methods.setSelectedAutomationId(auto.metadata.id, true);
methods.setSelectedAutomationId(auto.id, true);
},
editorUpdateAutomation(auto: AutomationData) {
editorUpdateAutomation(auto: AutomationData | BareAutomationData) {
if (methods.currentAutomationIsNew) {
onAutomationAdd(auto);
} else if (methods.currentAutomationId) {
onAutomationUpdate(methods.currentAutomationId, auto);
onAutomationUpdate(auto as AutomationData);
}
},
sideBarUpdateAutomation(
@@ -101,19 +107,23 @@ export const useAutomationManagerState = ({
aid: string,
eid: string
) {
const previousAutoState = automationDB.getAutomationData(aid);
if (previousAutoState) {
const previousAuto = automationDB.getAutomationData(aid);
if (
previousAuto &&
previousAuto[1] &&
"configuration_key" in previousAuto[1] &&
"source_file" in previousAuto[1] &&
"source_file_type" in previousAuto[1]
) {
const previousAutoState = previousAuto[1];
if (
previousAutoState.metadata.alias !== a.title ||
previousAutoState.metadata.description !== a.description
previousAutoState.alias !== a.title ||
previousAutoState.description !== a.description
) {
onAutomationUpdate(aid, {
onAutomationUpdate({
...previousAutoState,
metadata: {
...previousAutoState.metadata,
alias: a.title,
description: a.description,
},
alias: a.title,
description: a.description,
});
}
} else {
@@ -124,7 +134,8 @@ export const useAutomationManagerState = ({
{ variant: "error" }
);
}
const previousState = automationDB.getAutomationState(aid);
const previousState =
previousAuto === null ? null : previousAuto[0].state;
if (previousState !== a.state) {
onAutomationStateChange(eid, a.state === "on");
}
@@ -8,7 +8,7 @@ import SaveIcon from "@mui/icons-material/SaveOutlined";
import { cleanUpUndefined } from "utils/helpers";
import { Modal } from "components/Modal";
import { Button } from "components/Inputs/Button";
import { Button } from "components/Inputs/Buttons/Button";
import InputAutoText from "components/Inputs/InputAutoText";
import { TagDB } from "../TagDB";
@@ -30,7 +30,7 @@ export type TagModalState =
export const Tags: FC<TagsProps> = ({ automationId, tagsDB }) => {
const [modalState, setModal] = useState<TagModalState>({ open: false });
const tags = tagsDB.getTags(automationId);
const tags = tagsDB.getTags(automationId, true);
const onUpdate = (t: Record<string, string>) =>
tagsDB.update(automationId, t);
@@ -25,6 +25,11 @@
.automation-manager--metadatabox .metadatabox--title {
flex: 1;
max-width: calc(80% - 5em);
}
.automation-manager--metadatabox .metadatabox--switch {
width: 5em;
}
.automation-manager--metadatabox .metadatabox--title .title {
@@ -42,12 +47,25 @@
font-size: 0.9em;
}
.automation-manager--metadatabox .buttons {
display: flex;
flex-direction: row;
gap: 0.25em;
}
.automation-manager--metadatabox .delete:hover {
cursor: pointer;
color: var(--mui-error-light);
color: var(--mui-error-contrastText);
background-color: var(--mui-error-dark);
}
.automation-manager--metadatabox .run:hover {
cursor: pointer;
color: var(--mui-success-contrastText);
background-color: var(--mui-success-dark);
}
.automation-manager--metadatabox .select:hover,
.automation-manager--metadatabox.selected.automation-manager--metadatabox .select {
cursor: pointer;
@@ -71,4 +89,15 @@
font-size: 0.75em;
user-select: none;
max-width: 5em;
}
.automation-manager--metadatabox .metadatabox--title--source {
margin-bottom: -0.5em;
}
.automation-manager--metadatabox .metadatabox--title--source .MuiChip-root {
font-size: 0.85em;
height: 2em;
max-width: 60%;
}
@@ -39,6 +39,10 @@ const { make, componentMeta } = makeStory({
export default componentMeta;
export const Basic = make({});
export const LongDescription = make({
description:
"Lorem Ipsum is simply dummy text of the printing and typesetting industry. Lorem Ipsum has been the industry's standard dummy text ever since the 1500s, when an unknown printer took a galley of type and scrambled it to make a type specimen book. It has survived not only five centuries, but also the leap into electronic typesetting, remaining essentially unchanged. It was popularised in the 1960s with the release of Letraset sheets containing Lorem Ipsum passages, and more recently with desktop publishing software like Aldus PageMaker including versions of Lorem Ipsum.",
});
export const IsSelected = make({ isSelected: true });
export const InvalidState = make({ state: "unavailable" });
export const WithIssue = make({ issue: "look at me" });
@@ -7,16 +7,19 @@ import Alert from "@mui/material/Alert";
import DeleteForeverIcon from "@mui/icons-material/DeleteForever";
import SelectIcon from "@mui/icons-material/HighlightAltSharp";
import RunIcon from "@mui/icons-material/RunCircleOutlined";
import { InputTextView } from "components/Inputs/InputTextView";
import { ButtonIcon } from "components/Icons/ButtonIcons";
import { AutomationManagerAuto } from "../types";
import { Tags } from "./Tags";
import { TagDB } from "../TagDB";
import { Chip, Tooltip } from "@mui/material";
export type MetadataBoxProps = AutomationManagerAuto & {
onDelete: () => void;
onSelect: () => void;
onRun: () => void;
onStateUpdate: (s: "on" | "off") => void;
onTitleUpdate: (t: string) => void;
onDescriptionUpdate: (t: string) => void;
@@ -51,6 +54,16 @@ export const MetadataBox: FC<MetadataBoxProps> = (props) => {
className="metadatabox--title"
title={`ID=${props.id}, EntityID=${props.entityId}`}
>
<span className="metadatabox--title--source">
<Tooltip
title={`This automation is located in the file ${props.source_file} and is set up in your configuration.yaml file under the key ${props.configuration_key}.`}
>
<Chip
label={`@${props.source_file} (${props.source_file_type})`}
className="text-ellipsis"
/>
</Tooltip>
</span>
<InputTextView
className="title"
placeholder="Title"
@@ -79,11 +92,19 @@ export const MetadataBox: FC<MetadataBoxProps> = (props) => {
className="select"
icon={<SelectIcon />}
onClick={props.onSelect}
title="Select automation"
/>
<ButtonIcon
className="run"
icon={<RunIcon />}
onClick={props.onRun}
title="Trigger automation"
/>
<ButtonIcon
className="delete"
icon={<DeleteForeverIcon />}
onClick={props.onDelete}
title="Delete automation"
/>
</div>
</div>
@@ -33,6 +33,7 @@ const story = makeStory({
selectedAutomationId={selectedAutomationId}
tagsDB={useTagDB(automations, (a, t) => onTagUpdate(t, a))}
automations={automations}
onRun={args.onRun}
onSelectedAutomationId={(aid) => {
args.onSelectedAutomationId(aid);
setSelAutoId(aid);
@@ -67,6 +68,9 @@ const story = makeStory({
tags: {},
entityId: "automation." + id,
state: "on",
source_file: "automation.yaml",
source_file_type: "list",
configuration_key: "automation",
},
]);
setSelAutoId(id);
@@ -93,6 +97,9 @@ const makeAuto = (
description: "",
state: "on",
tags: {},
source_file: "automation.yaml",
source_file_type: "list",
configuration_key: "automation",
...data,
};
};
@@ -5,7 +5,7 @@ import { FC, useState } from "react";
import ArrowIcon from "@mui/icons-material/ArrowBackIosNewOutlined";
import InputText from "components/Inputs/InputText";
import InputText from "components/Inputs/Base/InputText";
import InputMultiSelect from "components/Inputs/InputMultiSelect";
import { ListBoxGroup } from "../ListBoxGroup";
@@ -16,7 +16,7 @@ import {
AutomationManagerAuto,
AutomationManagerAutoUpdatable,
} from "../types";
import { Button } from "components/Inputs/Button";
import { Button } from "components/Inputs/Buttons/Button";
import { ButtonIcon } from "components/Icons/ButtonIcons";
export type AutomationManagerSidebarProps = {
@@ -31,6 +31,7 @@ export type AutomationManagerSidebarProps = {
onAutomationDelete: (aid: string, eid: string) => void;
onAutomationAdd: () => void;
onSelectedAutomationId: (aid: string) => void;
onRun: (eid: string) => void;
};
export const AutomationManagerSidebar: FC<AutomationManagerSidebarProps> = ({
automations,
@@ -60,7 +61,11 @@ export const AutomationManagerSidebar: FC<AutomationManagerSidebarProps> = ({
);
const items = grouping.top.map((i) =>
convertGroupingToItems(i, selectedAutomationId, automations, grouping)
convertGroupingToItems(i, automations, grouping, (aid, t) => ({
...t,
isSelected: aid === selectedAutomationId,
isModified: tagsDB.isModified(aid),
}))
);
return (
@@ -85,7 +90,10 @@ export const AutomationManagerSidebar: FC<AutomationManagerSidebarProps> = ({
<ListBoxGroup
{...item}
key={i}
onSelect={onSelectedAutomationId}
onSelect={(id) => {
onSelectedAutomationId(id);
setHidden(true);
}}
{...events}
tagsDB={tagsDB}
initialOpenState={true}
@@ -1,4 +1,9 @@
import { useEffect, useRef, useState } from "react";
type TagDBState = {
original: Record<string, Record<string, string>>;
changed: Record<string, Record<string, string>>;
};
export type TagDB = ReturnType<typeof useTagDB>;
export const useTagDB = (
automations: Array<{
@@ -8,28 +13,30 @@ export const useTagDB = (
onUpdate: (aid: string, tags: Record<string, string>) => void
) => {
const lastAuto = useRef(JSON.stringify(automations));
const [{ automationTags, changed }, setState] = useState({
automationTags: convertAutoListToMap(automations),
changed: new Set<string>(),
const [{ original, changed }, setState] = useState<TagDBState>({
original: convertAutoListToMap(automations),
changed: {},
});
const allTags = computeAllTags(automationTags);
const allTags = computeAllTags(original);
const allTagNames = Object.keys(allTags);
const isModified = changed.size > 0;
const isModified = Object.keys(changed).length > 0;
useEffect(() => {
const c = JSON.stringify(automations);
if (lastAuto.current !== c) {
lastAuto.current = c;
setState({
automationTags: convertAutoListToMap(automations),
changed: new Set(),
original: convertAutoListToMap(automations),
changed: {},
});
}
}, [automations, setState]);
return {
getTags(automationId: string) {
return automationTags[automationId] ?? {};
getTags(automationId: string, includeChanged: boolean = false) {
if (includeChanged) {
return changed[automationId] ?? original[automationId] ?? {};
}
return original[automationId] ?? {};
},
getTagNames(myTags: string[]): string[] {
return allTagNames.filter((n) => !myTags.includes(n)).sort();
@@ -39,27 +46,33 @@ export const useTagDB = (
? Array.from(allTags[tagName].values()).sort()
: [];
},
isModified(aid: string) {
return changed.has(aid);
isModified(aid: string): boolean {
return aid in changed;
},
update(aid: string, tags: Record<string, string>) {
if (JSON.stringify(tags) !== JSON.stringify(automationTags[aid])) {
setState({
changed: changed.add(aid),
automationTags: {
...automationTags,
[aid]: tags,
},
});
const update = JSON.stringify(tags);
if (aid in changed) {
if (update === JSON.stringify(changed[aid])) {
return;
}
} else if (update === JSON.stringify(original[aid])) {
return;
}
setState({
changed: {
...changed,
[aid]: tags,
},
original,
});
},
save(aid: string | null) {
if (isModified) {
if (aid) {
onUpdate(aid, automationTags[aid]);
onUpdate(aid, changed[aid]);
} else {
for (const aid of changed.values()) {
onUpdate(aid, automationTags[aid]);
for (const [aid, change] of Object.entries(changed)) {
onUpdate(aid, change);
}
}
}
@@ -4,42 +4,58 @@ import { AutomationManagerAuto } from "./types";
const automations: AutomationManagerAuto[] = [
createMockAuto({
Room: "Living Room",
Type: "Lights",
tags: {
Room: "Living Room",
Type: "Lights",
},
}),
createMockAuto({
Room: "Living Room",
Type: "Climate",
tags: {
Room: "Living Room",
Type: "Climate",
},
}),
createMockAuto({
Room: "Kitchen",
Type: "Climate",
tags: {
Room: "Kitchen",
Type: "Climate",
},
}),
createMockAuto({
Type: "Climate",
tags: {
Type: "Climate",
},
}),
createMockAuto({
Room: "Living Room",
tags: {
Room: "Living Room",
},
}),
createMockAuto({}),
].map<AutomationManagerAuto>((a) => ({
title: a.metadata.alias ?? "",
entityId: "automation." + a.metadata.id,
description: a.metadata.description ?? "",
title: a.alias ?? "",
entityId: "automation." + a.id,
description: a.description ?? "",
state: "on",
tags: a.tags,
id: a.metadata.id,
id: a.id,
isSelected: false,
source_file: "automation.yaml",
source_file_type: "list",
configuration_key: "automation",
}));
const bigList = bigMockAutoList.map<AutomationManagerAuto>((a) => ({
entityId: "automation." + a.metadata.id,
title: a.metadata.alias ?? "",
description: a.metadata.description ?? "",
entityId: "automation." + a.id,
title: a.alias ?? "",
description: a.description ?? "",
state: "on",
tags: a.tags,
id: a.metadata.id,
id: a.id,
isSelected: false,
source_file: "automation.yaml",
source_file_type: "list",
configuration_key: "automation",
}));
test("no grouping", () => {
@@ -99,7 +115,7 @@ test("bigAutoList groupings has not duplicate ids", () => {
test("convert grouper to items when no tags are selected", () => {
const grouping = makeGrouping(automations, [], null);
const items = grouping.top.map((i) =>
convertGroupingToItems(i, "", automations, grouping)
convertGroupingToItems(i, automations, grouping)
);
expect(items.filter((i) => i.type === "group")).toHaveLength(0);
expect(items).toHaveLength(1);
@@ -109,7 +125,7 @@ test("convert grouper to items when no tags are selected", () => {
test("convert grouper to items when 1 tag is selected", () => {
const grouping = makeGrouping(automations, ["Room"], null);
const items = grouping.top.map((i) =>
convertGroupingToItems(i, "", automations, grouping)
convertGroupingToItems(i, automations, grouping)
);
expect(grouping.top).toHaveLength(3);
expect(items.filter((i) => i.type === "group")).toHaveLength(0);
@@ -125,7 +141,7 @@ test("convert grouper to items when 1 tag is selected", () => {
test("convert grouper to items when 2 tag is selected", () => {
const grouping = makeGrouping(automations, ["Room", "Type"], null);
const items = grouping.top.map((i) =>
convertGroupingToItems(i, "", automations, grouping)
convertGroupingToItems(i, automations, grouping)
);
expect(grouping.top).toHaveLength(3);
expect(items.filter((i) => i.type === "group")).toHaveLength(2);
@@ -1,4 +1,9 @@
import { AutomationManagerAuto, AutomationManagerItem } from "./types";
import {
AutomationManagerAuto,
AutomationManagerAutoItem,
AutomationManagerItem,
AutomationManagerItemFlags,
} from "./types";
const makeGrouper = () => {
const groupIdNames: string[] = [];
@@ -149,33 +154,59 @@ export const makeGrouping = (
export const convertGroupingToItems = (
currentGroupIdx: number,
selectedAutomationId: string | null,
autos: AutomationManagerAuto[],
grouping: AutomationGrouping
grouping: AutomationGrouping,
computeFlags: (
aid: string,
f: AutomationManagerItemFlags
) => AutomationManagerItemFlags = (aid, t) => t
): AutomationManagerItem => {
const groupData = grouping.getData(currentGroupIdx);
const automationIds = grouping.getAutomations(currentGroupIdx);
if (automationIds.length > 0) {
const data = automationIds.map<AutomationManagerAutoItem>((i) => {
return {
...autos[i],
flags: computeFlags(autos[i].id, {
isSelected: false,
isModified: false,
}),
};
});
return {
type: "items",
title: groupData.name,
data: automationIds.map((i) => {
return {
...autos[i],
isSelected: autos[i].id === selectedAutomationId,
};
}),
isSelected: groupData.selected,
data,
flags: data.reduce<AutomationManagerItemFlags>(
(out, a) => ({
isSelected: out.isSelected || a.flags.isSelected,
isModified: out.isModified || a.flags.isModified,
}),
{
isSelected: false,
isModified: false,
}
),
};
}
const subgroups = grouping.getSubGroups(currentGroupIdx);
const data = subgroups.map((i) =>
convertGroupingToItems(i, autos, grouping, computeFlags)
);
return {
type: "group",
title: groupData.name,
data: subgroups.map((i) =>
convertGroupingToItems(i, selectedAutomationId, autos, grouping)
data,
flags: data.reduce<AutomationManagerItemFlags>(
(out, a) => ({
isSelected: out.isSelected || a.flags.isSelected,
isModified: out.isModified || a.flags.isModified,
}),
{
isSelected: false,
isModified: false,
}
),
isSelected: groupData.selected,
};
};
@@ -10,6 +10,10 @@
flex-direction: column;
}
.automation-manager.error>code {
padding: 1.5em;
}
.automation-manager.loading .automation-manager--sidebar.loading {
width: 25vh;
height: 100%;
@@ -23,4 +27,24 @@
.automation-manager.loading .automation-manager--editor.loading {
flex: 1;
height: 100%;
}
.invalid-automation-modal-list {
display: flex;
max-height: 50vh;
overflow: auto;
flex-direction: column;
padding: 0.5em;
margin: 0;
}
.invalid-automation-modal-list li {
display: flex;
flex-direction: column;
}
.invalid-automation-modal-list--errors ul {
max-height: 10vh;
overflow: auto;
}
@@ -19,9 +19,10 @@ const { make, componentMeta } = makeStory({
<AutomationManager
api={useMockApiService(args.automations ?? [], !args.automations)}
haEntities={useMockHAEntities(haEntities)}
refreshAutomations={() => {}}
forceDeleteAutomation={() => {}}
onAutomationStateChange={(eid, on) => {
refreshAutomations={async () => {}}
triggerAutomation={async () => {}}
forceDeleteAutomation={async () => {}}
onAutomationStateChange={async (eid, on) => {
if (!haEntities.loading && !haEntities.error) {
setHAE({
...haEntities,
@@ -78,17 +79,17 @@ export const Empty = make({
},
});
const auto1 = createMockAuto({
type: "button",
tags: { type: "button" },
});
export const One = make({
automations: [auto1],
haProps: {
loading: false,
entities: {
[`automation.${auto1.metadata.id}`]: {
entity_id: `automation.${auto1.metadata.id}`,
[`automation.${auto1.id}`]: {
entity_id: `automation.${auto1.id}`,
attributes: {
id: auto1.metadata.id,
id: auto1.id,
},
context: { id: "", parent_id: null, user_id: null },
last_changed: "",
@@ -104,11 +105,11 @@ export const MissingAutoInConfig = make({
haProps: {
loading: false,
entities: {
[`automation.${auto1.metadata.id}`]: {
entity_id: `automation.${auto1.metadata.id}`,
[`automation.${auto1.id}`]: {
entity_id: `automation.${auto1.id}`,
attributes: {
id: auto1.metadata.id,
friendly_name: auto1.metadata.alias,
id: auto1.id,
friendly_name: auto1.alias,
},
context: { id: "", parent_id: null, user_id: null },
last_changed: "",
@@ -119,3 +120,102 @@ export const MissingAutoInConfig = make({
entitySource: {},
},
});
export const CrashingAutomations = make({
haProps: {
loading: false,
entities: {},
entitySource: {},
},
automations: [""] as any,
});
export const BadAutomation = make({
haProps: {
loading: false,
entities: {
[`automation.${auto1.id}`]: {
entity_id: `automation.${auto1.id}`,
attributes: {
id: "test",
},
context: { id: "", parent_id: null, user_id: null },
last_changed: "",
last_updated: "",
state: "on",
},
},
entitySource: {},
},
automations: [
{
tags: {},
id: "test",
mode: "single",
alias: "Light.Tank_Day",
description: "",
source_file: "automation.yaml",
source_file_type: "list",
configuration_key: "automation",
trigger: [
{
platform: "sun",
event: "sunrise",
offset: "30",
} as any,
{ whoAmI: "bad node is who" } as any,
],
condition: [{ whoAmI: "bad node is who" } as any],
action: [
{ scene: "scene.light_day" } as any,
{ whoAmI: "bad node is who" } as any,
{
service: "input_select.set_options",
target: {
entity_id: "input_select.tank_light_mode",
},
data: {
options: "day",
},
},
],
},
],
});
export const OneCrashingOneGoodAutomations = make({
haProps: {
loading: false,
entities: {
[`automation.${auto1.id}`]: {
entity_id: `automation.${auto1.id}`,
attributes: {
id: auto1.id,
},
context: { id: "", parent_id: null, user_id: null },
last_changed: "",
last_updated: "",
state: "on",
},
"1235": {
entity_id: `automation.1235`,
attributes: {
id: "1235",
},
context: { id: "", parent_id: null, user_id: null },
last_changed: "",
last_updated: "",
state: "on",
},
},
entitySource: {},
},
automations: [
auto1,
{
id: "1235",
tags: {},
} as any,
"" as any,
],
});
+223 -77
View File
@@ -1,6 +1,6 @@
import "./index.css";
import { FC, useState } from "react";
import { FC, useEffect, useRef, useState } from "react";
import LinearProgress from "@mui/material/LinearProgress";
import Skeleton from "@mui/material/Skeleton";
@@ -9,11 +9,18 @@ import { HAEntitiesState } from "haService/HAEntities";
import { AutomationManagerLoaded } from "./Loaded";
import { Alert } from "@mui/material";
import { useSnackbar } from "notistack";
import { ErrorBoundary } from "components/ErrorBoundary";
import { getFailures } from "types/validators/helper";
import * as av from "types/validators/autmation";
import { useConfirm } from "material-ui-confirm";
import InputYaml from "components/Inputs/Base/InputYaml";
import { APIResponse } from "apiService/types";
export type AutomationManagerProps = {
onAutomationStateChange: (eid: string, on: boolean) => void;
refreshAutomations: () => void;
forceDeleteAutomation: (eid: string) => void;
onAutomationStateChange: (eid: string, on: boolean) => Promise<any>;
refreshAutomations: () => Promise<any>;
forceDeleteAutomation: (eid: string) => Promise<any>;
triggerAutomation: (eid: string) => Promise<any>;
haEntities: HAEntitiesState;
api: ApiService;
};
@@ -21,12 +28,144 @@ export type AutomationManagerProps = {
export const AutomationManager: FC<AutomationManagerProps> = ({
api,
haEntities,
onAutomationStateChange,
refreshAutomations,
forceDeleteAutomation,
onAutomationStateChange: _onAutomationStateChange,
refreshAutomations: _refreshAutomations,
forceDeleteAutomation: _forceDeleteAutomation,
triggerAutomation: _triggerAutomation,
}) => {
const snackbr = useSnackbar();
const [isSaving, setIsSaving] = useState(false);
const confirm = useConfirm();
const validationsShown = useRef(false);
const [isSaving, setIsSaving] = useState<string[]>([]);
// helpers
function wrapPromise<T>(
name: string,
errorMessage: string,
makePromise: () => Promise<T>
) {
setIsSaving(isSaving.concat([name]));
return makePromise()
.then((resp) => {
setIsSaving(isSaving.filter((k) => k !== name));
return resp;
})
.catch((err) => {
console.error(err);
snackbr.enqueueSnackbar(errorMessage.replace("{{err}}", String(err)), {
variant: "error",
});
setIsSaving(isSaving.filter((k) => k !== name));
});
}
const wrapApiPromise = (
name: string,
errorMessage: string,
makePromise: () => Promise<APIResponse<any>>
) => {
wrapPromise(name, errorMessage, makePromise).then((resp) => {
if (resp) {
if (resp.ok) {
refreshAutomations();
} else {
snackbr.enqueueSnackbar(errorMessage.replace("{{err}}", resp.error), {
variant: "error",
});
}
}
});
};
const onAutomationStateChange = (eid: string, on: boolean) =>
wrapPromise(
"changing automation state",
'failed to toggle autonation due to "{{err}}"',
() => _onAutomationStateChange(eid, on)
);
const refreshAutomations = () =>
wrapPromise(
"refreshing automations",
'failed refreshing automations due to "{{err}}"',
() => _refreshAutomations()
);
const forceDeleteAutomation = (eid: string) =>
wrapPromise("deleting automations", 'failed delete due to "{{err}}"', () =>
_forceDeleteAutomation(eid)
);
const triggerAutomation = (eid: string) =>
wrapPromise(
"triggering automations",
'failed trigger due to "{{err}}"',
() => _triggerAutomation(eid)
);
// effects
useEffect(() => {
refreshAutomations();
// eslint-disable-next-line
}, []);
useEffect(() => {
if (
api.state.automations.ready &&
api.state.automations.ok &&
!validationsShown.current
) {
const configAutomationsValidated = api.state.automations.data.data.map(
(a) => {
const failures = getFailures(a, av.AutomationData);
return {
automation: a,
failures,
};
}
);
const invalidAutomations = configAutomationsValidated.filter(
({ failures }) => failures !== null
);
if (invalidAutomations.length > 0 && !validationsShown.current) {
validationsShown.current = true;
confirm({
cancellationButtonProps: {
style: { display: "none" },
},
title: "Invalid Automations detected!",
content: (
<>
<ol className="invalid-automation-modal-list">
{invalidAutomations.map(({ automation, failures }, i) => (
<li key={i}>
<b>Automation</b>
<InputYaml
label=""
value={automation}
onChange={() => {}}
/>
<b>Errors</b>
<Alert
color="error"
className="invalid-automation-modal-list--errors"
>
<ul>
{failures &&
failures.map((f, fi) => (
<li key={fi}>
<b>{f.path}</b>: {f.message.join(", ")}
</li>
))}
</ul>
</Alert>
</li>
))}
</ol>
</>
),
})
.then(console.info)
.catch(console.error);
}
}
}, [api.state.automations, confirm]);
// handle bad states
if (!haEntities.ready && haEntities.error) {
@@ -56,89 +195,96 @@ export const AutomationManager: FC<AutomationManagerProps> = ({
}
if (!api.state.automations.ok) {
let error = api.state.automations.error;
try {
const errorObj = JSON.parse(api.state.automations.error);
if ("detail" in errorObj) {
error = errorObj["detail"];
}
} catch (_: any) {}
return (
<div className="automation-manager error">
<Alert color="error">
Failed to load automations from <code>/config</code>
</Alert>{" "}
<br />
<code>{api.state.automations.error}</code>
<code>{error}</code>
</div>
);
}
// alias
const configAutomations = api.state.automations.data;
const hassEntities = haEntities.collection;
const configAutomations = api.state.automations.data;
return (
<AutomationManagerLoaded
configAutomations={configAutomations.data}
hassEntities={hassEntities}
onAutomationStateChange={onAutomationStateChange}
onAutomationAdd={async (auto) => {
await api.updateAutomation({
index: configAutomations.totalItems + 1,
auto,
});
refreshAutomations();
}}
onAutomationDelete={(aid, eid) => {
const index = configAutomations.data.findIndex(
({ metadata }) => metadata.id === aid
);
let deleteSent = false;
if (index >= 0) {
api.removeAutomation({
index,
});
deleteSent = true;
}
const hassAuto = hassEntities[eid];
if (hassAuto) {
forceDeleteAutomation(eid);
deleteSent = true;
}
if (!deleteSent) {
snackbr.enqueueSnackbar(
"Failed to delete automation, this may be resolved by a refresh or reboot of Home Assistant",
{
variant: "error",
}
);
}
// refreshAutomations();
}}
onAutomationUpdate={(aid, auto) => {
const index = configAutomations.data.findIndex(
({ metadata }) => metadata.id === aid
);
if (index >= 0) {
api.updateAutomation({
index: configAutomations.data.findIndex(
({ metadata }) => metadata.id === aid
),
auto,
});
refreshAutomations();
} else {
snackbr.enqueueSnackbar(
"Failed to update automation, this may be resolved by a refresh or reboot of Home Assistant.",
{
variant: "error",
}
);
}
}}
onUpdateTags={async (aid, t) => {
setIsSaving(true);
await api.updateTags({
automation_id: aid,
tags: t,
});
setIsSaving(false);
<ErrorBoundary
additionalContext={{
configAutomations,
hassEntities,
}}
>
{isSaving && <LinearProgress />}
</AutomationManagerLoaded>
{isSaving.length > 0 && (
<>
<span>{isSaving.join(" and ")}...</span>
<LinearProgress />
</>
)}
<AutomationManagerLoaded
configAutomations={configAutomations.data}
hassEntities={hassEntities}
onAutomationRun={triggerAutomation}
onAutomationStateChange={onAutomationStateChange}
onAutomationAdd={(auto) =>
wrapApiPromise(
"adding automation",
"Failed to create automation, recieved error: {{err}}!",
() => api.createAutomation(auto) as any
)
}
onAutomationDelete={(aid, eid) => {
const autoToDelete = configAutomations.data.find(
({ id }) => id === aid
);
let deleteSent = false;
if (autoToDelete) {
api.removeAutomation(autoToDelete);
deleteSent = true;
}
const hassAuto = hassEntities[eid];
if (hassAuto) {
forceDeleteAutomation(eid);
deleteSent = true;
}
if (!deleteSent) {
snackbr.enqueueSnackbar(
"Failed to delete automation, this may be resolved by a refresh or reboot of Home Assistant",
{
variant: "error",
}
);
}
// refreshAutomations();
}}
onAutomationUpdate={(auto) =>
wrapApiPromise(
"updating automation",
"Failed to update automation, recieved error: {{err}}!",
() => api.updateAutomation(auto) as any
)
}
onUpdateTags={async (aid, t) => {
wrapApiPromise(
"updating tags",
"Failed to update tags, recieved error: {{err}}!",
() =>
api.updateTags({
automation_id: aid,
tags: t,
}) as any
);
}}
/>
</ErrorBoundary>
);
};
@@ -9,11 +9,20 @@ export type AutomationManagerAuto = AutomationManagerAutoUpdatable & {
tags: Record<string, string>;
issue?: string;
isNew?: boolean;
source_file: string;
source_file_type: string;
configuration_key: string;
};
export type AutomationManagerAutoItem = AutomationManagerAuto & {
flags: AutomationManagerItemFlags;
};
export type AutomationManagerItemFlags = {
isSelected: boolean;
isModified: boolean;
};
export type AutomationManagerItem = {
title: string;
isSelected: boolean;
flags: AutomationManagerItemFlags;
} & (
| {
type: "group";
@@ -21,6 +30,6 @@ export type AutomationManagerItem = {
}
| {
type: "items";
data: Array<AutomationManagerAuto & { isSelected: boolean }>;
data: Array<AutomationManagerAutoItem>;
}
);
@@ -7,7 +7,7 @@ import { AutomationCondition } from "types/automations/conditions";
import { getSubTypeList } from "utils/automations";
import { getConditionDefaultValues } from "utils/defaults";
import { useHA } from "haService";
import InputYaml from "components/Inputs/InputYaml";
import InputYaml from "components/Inputs/Base/InputYaml";
import { getViewer } from "./viewRender";
import { getEditor } from "./editorRender";
import useWindowSize from "utils/useWindowSize";
@@ -10,26 +10,26 @@ import {
TriggerCondition,
ZoneCondition,
} from "types/automations/conditions";
import InputNumber from "components/Inputs/InputNumber";
import InputText from "components/Inputs/InputText";
import { InputEntity } from "components/Inputs/InputEntities";
import InputNumber from "components/Inputs/Base/InputNumber";
import InputText from "components/Inputs/Base/InputText";
import { InputEntity } from "components/Inputs/AutoComplete/InputEntities";
import {
ConditionNodeBase,
ConditionNodeBaseViewMode,
} from "./ConditionNodeBase";
import { genUpdateMethods } from "./nestedUpdater";
import { InputTime } from "components/Inputs/InputTime";
import InputYaml from "components/Inputs/InputYaml";
import { InputTime } from "components/Inputs/Base/InputTime";
import InputYaml from "components/Inputs/Base/InputYaml";
import { HAService } from "haService";
import { DeviceEditor } from "components/DeviceEditor";
import { ButtonIcon } from "components/Icons/ButtonIcons";
import AddIcon from "@mui/icons-material/Add";
import { getEntityDomains } from "utils/automations";
import { InputAutoComplete } from "components/Inputs/InputAutoComplete";
import { InputTimeEntity } from "components/Inputs/InputTimeEntity";
import { InputAutoComplete } from "components/Inputs/AutoComplete/InputAutoComplete";
import { InputTimeEntity } from "components/Inputs/AutoComplete/InputTimeEntity";
import { prettyName } from "utils/formatting";
import { InputList } from "components/Inputs/InputList";
import { Button } from "components/Inputs/Button";
import { Button } from "components/Inputs/Buttons/Button";
import { RemoveCircle } from "@mui/icons-material";
interface Editor<C extends AutomationCondition>
@@ -6,7 +6,7 @@ export const NODE_HEIGHT = 80 as const;
export const DEFAULT_DIMS: DAGDims = {
collection: {
height: NODE_HEIGHT * 3,
width: NODE_WIDTH * 1.5,
width: NODE_WIDTH * 2.5,
},
node: {
height: NODE_HEIGHT,
@@ -8,67 +8,61 @@ import { AutomationActionData } from "types/automations";
import { createUpdaterFromAutomationData } from "../updater";
import { ModalState } from "../board/types";
import { DEFAULT_DIMS } from "./constants";
import { makeStory } from "devUtils";
const Demo: FC<{
automation: AutomationActionData;
flipped: boolean;
}> = (props) => {
const { namer } = useHA();
const [state, setState] = useState<AutomationActionData>(props.automation);
const [modalState, setModalState] =
useState<ModalState | undefined>(undefined);
const updater = createUpdaterFromAutomationData(
setModalState,
state,
setState
);
const elementData = useAutomationNodes(state, {
dims: {
...DEFAULT_DIMS,
flipped: props.flipped,
},
namer,
openModal: setModalState,
stateUpdater: updater,
});
return (
<DAGGraphBoard
modalState={modalState}
closeModal={() => setModalState(undefined)}
state={{
ready: true,
data: {
elements: elementData,
},
}}
/>
);
};
export default {
title: "DAGGraph/Elements",
component: Demo,
parameters: { actions: { argTypesRegex: "^on.*" } },
args: {
flipped: true,
automation: {
trigger: [],
condition: [],
sequence: [],
const { make, componentMeta } = makeStory({
Component: (props: {
automation: AutomationActionData;
flipped: boolean;
}) => {
const { namer } = useHA();
const [state, setState] = useState<AutomationActionData>(props.automation);
const [modalState, setModalState] =
useState<ModalState | undefined>(undefined);
const updater = createUpdaterFromAutomationData(
setModalState,
state,
setState
);
const elementData = useAutomationNodes(state, {
dims: {
...DEFAULT_DIMS,
flipped: props.flipped,
},
namer,
openModal: setModalState,
stateUpdater: updater,
});
return (
<DAGGraphBoard
modalState={modalState}
closeModal={() => setModalState(undefined)}
state={{
ready: true,
data: {
elements: elementData,
},
}}
/>
);
},
meta: {
title: "DAGGraph/Elements",
args: {
flipped: true,
automation: {
trigger: [],
condition: [],
action: [],
},
},
},
} as ComponentMeta<typeof Demo>;
});
const Template: ComponentStory<typeof Demo> = (args) => (
<Page>
<Demo {...args} />
</Page>
);
export default componentMeta;
export const Empty = Template.bind({});
export const Trigger = Template.bind({});
Trigger.args = {
...Trigger.args,
export const Empty = make({});
export const Trigger = make({
automation: {
trigger: [
{ platform: "homeassistant", event: "up" },
@@ -80,12 +74,11 @@ Trigger.args = {
},
],
condition: [],
sequence: [],
action: [],
},
};
export const Conditions = Template.bind({});
Conditions.args = {
...Conditions.args,
});
export const Conditions = make({
automation: {
trigger: [
{
@@ -117,13 +110,11 @@ Conditions.args = {
below: "15",
},
],
sequence: [],
action: [],
},
};
});
export const FullAuto = Template.bind({});
FullAuto.args = {
...FullAuto.args,
export const FullAuto = make({
automation: {
condition: [
{
@@ -160,7 +151,7 @@ FullAuto.args = {
bad: "node",
} as any,
],
sequence: [
action: [
{
condition: "and",
conditions: [
@@ -272,15 +263,13 @@ FullAuto.args = {
},
],
},
};
});
export const ChooseAuto = Template.bind({});
ChooseAuto.args = {
...ChooseAuto.args,
export const ChooseAuto = make({
automation: {
condition: [],
trigger: [],
sequence: [
action: [
{
choose: [
{
@@ -370,31 +359,26 @@ ChooseAuto.args = {
},
],
},
};
});
export const EmptyChooseAuto = Template.bind({});
EmptyChooseAuto.args = {
...EmptyChooseAuto.args,
export const EmptyChooseAuto = make({
automation: {
condition: [],
trigger: [],
sequence: [
action: [
{
choose: [],
default: [],
},
],
},
};
});
export const RepeatAuto = Template.bind({});
RepeatAuto.args = {
...RepeatAuto.args,
export const RepeatAuto = make({
automation: {
condition: [],
trigger: [],
sequence: [
action: [
{
repeat: {
while: 'states(lights.switch) == "on"',
@@ -437,15 +421,13 @@ RepeatAuto.args = {
},
],
},
};
});
export const ParallelAuto = Template.bind({});
ParallelAuto.args = {
...ParallelAuto.args,
export const ParallelAuto = make({
automation: {
condition: [],
trigger: [],
sequence: [
action: [
{
parallel: [
{
@@ -467,11 +449,9 @@ ParallelAuto.args = {
},
],
},
};
});
export const BadNodes = Template.bind({});
BadNodes.args = {
...BadNodes.args,
export const BadNodes = make({
automation: {
condition: [
{
@@ -489,7 +469,7 @@ BadNodes.args = {
{ condition: "and" },
"text?",
] as any,
sequence: [
action: [
{
parallel: {
bad: "me",
@@ -500,15 +480,13 @@ BadNodes.args = {
},
] as any,
},
};
});
export const IfElseNode = Template.bind({});
IfElseNode.args = {
...IfElseNode.args,
export const IfElseNode = make({
automation: {
condition: [],
trigger: [],
sequence: [
action: [
{
if: [],
else: [],
@@ -516,4 +494,24 @@ IfElseNode.args = {
},
],
},
};
});
export const TimeNodes = make({
automation: {
condition: [],
trigger: [
{
platform: "time",
at: "",
},
{
platform: "time_pattern",
},
],
action: [
{
condition: "time",
},
],
},
});
@@ -63,7 +63,7 @@ export const useAutomationNodes = (
);
outputState.extend(
makeSequenceNodes(automation.sequence, {
makeSequenceNodes(automation.action, {
...args,
state,
dims,
@@ -74,7 +74,7 @@ export const useAutomationNodes = (
dims,
true
),
nodeId: `${dims.flipped}-sequence`,
nodeId: `${dims.flipped}-action`,
nodeIndex: 2,
lastNodeId: outputState.lastNodeId,
})
@@ -98,7 +98,7 @@ export const makeSequenceNodes: ElementMaker<AutomationSequenceNode> = (
enabled: node.enabled ?? true,
label: getDescriptionFromAutomationNode(node, namer, true),
...state.getIsClosedActions(nodeId, node),
...stateUpdater.createNodeActions("sequence", nodeIndex, {
...stateUpdater.createNodeActions("action", nodeIndex, {
includeAdd: true,
flipped: dims.flipped,
}),
@@ -153,7 +153,7 @@ export const makeSequenceNodes: ElementMaker<AutomationSequenceNode> = (
dims,
{
icon: <AddIcon />,
onClick: () => stateUpdater.basic.sequence.addNode(null),
onClick: () => stateUpdater.basic.action.addNode(null),
}
),
true
@@ -261,7 +261,7 @@ export const makeChooseeNodes = makeSpecialNodeMaker(
nodeId: args.nodeId,
position: pos,
onClick: () =>
args.stateUpdater.basic.sequence.updateNode(
args.stateUpdater.basic.action.updateNode(
{
...node,
choose: [
@@ -464,10 +464,10 @@ export const makeParallelNodes = makeSpecialNodeMaker(
onClick: () =>
args.openModal({
allowedTypes: ["condition", "action"],
node: args.stateUpdater.basic.sequence.defaultNode,
node: args.stateUpdater.basic.action.defaultNode,
saveBtnCreateText: true,
update: (n) =>
args.stateUpdater.basic.sequence.updateNode(
args.stateUpdater.basic.action.updateNode(
{
...node,
parallel: [...node.parallel, n],
@@ -29,7 +29,7 @@ export const useDAGElementsState = () => {
},
getIsClosedActions(nodeId: string, node: AutomationNode) {
if (isSpecialNode(getNodeSubType(node))) {
if (isSpecialNode(getNodeSubType(node, true))) {
return {
isClosed: this.get(nodeId).isClosed ?? false,
setIsClosed: (v: boolean) => this.set(nodeId, "isClosed", v),
+6 -6
View File
@@ -10,10 +10,10 @@ import { AutomationTrigger } from "types/automations/triggers";
import { AutomationCondition } from "types/automations/conditions";
export const DAGAutomationGraph: FC<{
sequence: AutomationSequenceNode[];
action: AutomationSequenceNode[];
trigger: AutomationTrigger[];
condition: AutomationCondition[];
onSequenceUpdate: (s: AutomationSequenceNode[]) => void;
onActionUpdate: (s: AutomationSequenceNode[]) => void;
onTriggerUpdate: (t: AutomationTrigger[]) => void;
onConditionUpdate: (c: AutomationCondition[]) => void;
isFlipped: boolean;
@@ -24,9 +24,9 @@ export const DAGAutomationGraph: FC<{
useState<ModalState | undefined>(undefined);
const updater = createUpdater({
openModal: setModalState,
sequence: {
data: props.sequence,
onUpdate: props.onSequenceUpdate,
action: {
data: props.action,
onUpdate: props.onActionUpdate,
},
condition: {
data: props.condition,
@@ -39,7 +39,7 @@ export const DAGAutomationGraph: FC<{
});
const elementData = useAutomationNodes(
{
sequence: props.sequence,
action: props.action,
condition: props.condition,
trigger: props.trigger,
},
Loaded 100 of 196 files, more files were not shown because too many files have changed in this diff. Show more