From b301ab23776f6c8f957df17593fad262020287f1 Mon Sep 17 00:00:00 2001 From: Archmonger <16909269+Archmonger@users.noreply.github.com> Date: Sun, 30 Jan 2022 19:16:46 -0800 Subject: [PATCH 1/9] Create CHANGELOG.md --- CHANGELOG.md | 65 ++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 65 insertions(+) create mode 100644 CHANGELOG.md diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 00000000..17479865 --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,65 @@ +# Changelog + +All notable changes to this project will be documented in this file. + +The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), +and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). + + + +## [Unreleased] + +### Added + +- Nothing (yet) + +## [0.0.2] - 2022-01-30 + +### Added + +- Support for declaring the HTML class of the component div via the `idom_component` tag +- `name = ...` parameter to IDOM HTTP paths for use with `django.urls.reverse()` +- Fully async method of fetching `web_modules` from disk +- Cache versioning to automatically invalidate old web module files from the cache backend +- Automatic pre-population of the IDOM component registry +- Type hinting for `IdomWebsocket` + +### Changed + +- Static files are now contained within a `django_idom/` parent folder +- `IDOM_WS_MAX_RECONNECT_DELAY` has been renamed to `IDOM_WS_MAX_RECONNECT_TIMEOUT` +- Upgraded IDOM to version `0.36.0` +- The optional `idom_web_modules` cache backend has been renamed to `idom` +- Minimum Django required is now `4.0` +- Minimum Python required is now `3.8` + +### Removed + +- `IDOM_WEB_MODULES_PATH` has been removed and replaced with Django `include(...)` + +### Fixed + +- Increase test timeout values to prevent them from failing as a false positive +- Windows compatibility for building Django-IDOM + +### Security + +- Fixed potential directory travesal attack on the IDOM web modules URL + +## [0.0.1] - 2021-08-18 + +### Added + +- Support for IDOM within the Django + +[unreleased]: https://github.com/idom-team/django-idom/compare/0.0.2...HEAD +[0.0.2]: https://github.com/idom-team/django-idom/compare/0.0.1...0.0.2 +[0.0.1]: https://github.com/idom-team/django-idom/releases/tag/0.0.1 From d29e22374c4cf759483e7f5f80cbf2a9f61b43da Mon Sep 17 00:00:00 2001 From: Archmonger <16909269+Archmonger@users.noreply.github.com> Date: Sun, 30 Jan 2022 19:19:20 -0800 Subject: [PATCH 2/9] move idom_web_modules to removed section --- CHANGELOG.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 17479865..8c199024 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -37,13 +37,13 @@ Types of changes are to be listed in this order - Static files are now contained within a `django_idom/` parent folder - `IDOM_WS_MAX_RECONNECT_DELAY` has been renamed to `IDOM_WS_MAX_RECONNECT_TIMEOUT` - Upgraded IDOM to version `0.36.0` -- The optional `idom_web_modules` cache backend has been renamed to `idom` - Minimum Django required is now `4.0` - Minimum Python required is now `3.8` ### Removed - `IDOM_WEB_MODULES_PATH` has been removed and replaced with Django `include(...)` +- `idom_web_modules` cache backend has been renamed to `idom` ### Fixed From d346f9d55587b83acb648cc854bd129e1cb6e114 Mon Sep 17 00:00:00 2001 From: Archmonger <16909269+Archmonger@users.noreply.github.com> Date: Sun, 30 Jan 2022 19:20:00 -0800 Subject: [PATCH 3/9] add version to py/dj change --- CHANGELOG.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 8c199024..50572556 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -37,8 +37,8 @@ Types of changes are to be listed in this order - Static files are now contained within a `django_idom/` parent folder - `IDOM_WS_MAX_RECONNECT_DELAY` has been renamed to `IDOM_WS_MAX_RECONNECT_TIMEOUT` - Upgraded IDOM to version `0.36.0` -- Minimum Django required is now `4.0` -- Minimum Python required is now `3.8` +- Minimum Django version required is now `4.0` +- Minimum Python version required is now `3.8` ### Removed From 2a729e13e69de35b3a13287f8c97eb28aa279efd Mon Sep 17 00:00:00 2001 From: Archmonger <16909269+Archmonger@users.noreply.github.com> Date: Sun, 30 Jan 2022 19:20:45 -0800 Subject: [PATCH 4/9] clean up test timeout bullet --- CHANGELOG.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 50572556..30372fe5 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -47,7 +47,7 @@ Types of changes are to be listed in this order ### Fixed -- Increase test timeout values to prevent them from failing as a false positive +- Increase test timeout values to prevent false positives - Windows compatibility for building Django-IDOM ### Security From fd21b2cfbe292095fed04ddfe135897dbda7da47 Mon Sep 17 00:00:00 2001 From: Archmonger <16909269+Archmonger@users.noreply.github.com> Date: Sun, 30 Jan 2022 19:22:33 -0800 Subject: [PATCH 5/9] minor cleanup of html bullet --- CHANGELOG.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 30372fe5..cd5e2be5 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -25,7 +25,7 @@ Types of changes are to be listed in this order ### Added -- Support for declaring the HTML class of the component div via the `idom_component` tag +- Ability to declare the HTML class of the top-level component `div` - `name = ...` parameter to IDOM HTTP paths for use with `django.urls.reverse()` - Fully async method of fetching `web_modules` from disk - Cache versioning to automatically invalidate old web module files from the cache backend From 07f01029d980156a281d0a47350a86edcab90eff Mon Sep 17 00:00:00 2001 From: Archmonger <16909269+Archmonger@users.noreply.github.com> Date: Sun, 30 Jan 2022 19:34:02 -0800 Subject: [PATCH 6/9] move web modules bullet to changed --- CHANGELOG.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index cd5e2be5..10108abf 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -27,13 +27,13 @@ Types of changes are to be listed in this order - Ability to declare the HTML class of the top-level component `div` - `name = ...` parameter to IDOM HTTP paths for use with `django.urls.reverse()` -- Fully async method of fetching `web_modules` from disk - Cache versioning to automatically invalidate old web module files from the cache backend - Automatic pre-population of the IDOM component registry - Type hinting for `IdomWebsocket` ### Changed +- Fetching `web_modules` from disk and/or cache is now fully async - Static files are now contained within a `django_idom/` parent folder - `IDOM_WS_MAX_RECONNECT_DELAY` has been renamed to `IDOM_WS_MAX_RECONNECT_TIMEOUT` - Upgraded IDOM to version `0.36.0` From d1d1ca21e565c4794679332fc1b9deeaeb4e62ef Mon Sep 17 00:00:00 2001 From: Archmonger <16909269+Archmonger@users.noreply.github.com> Date: Sun, 30 Jan 2022 19:35:07 -0800 Subject: [PATCH 7/9] move IDOM_WS_MAX_RECONNECT_DELAY to removed --- CHANGELOG.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 10108abf..12b5f690 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -35,7 +35,6 @@ Types of changes are to be listed in this order - Fetching `web_modules` from disk and/or cache is now fully async - Static files are now contained within a `django_idom/` parent folder -- `IDOM_WS_MAX_RECONNECT_DELAY` has been renamed to `IDOM_WS_MAX_RECONNECT_TIMEOUT` - Upgraded IDOM to version `0.36.0` - Minimum Django version required is now `4.0` - Minimum Python version required is now `3.8` @@ -43,6 +42,7 @@ Types of changes are to be listed in this order ### Removed - `IDOM_WEB_MODULES_PATH` has been removed and replaced with Django `include(...)` +- `IDOM_WS_MAX_RECONNECT_DELAY` has been renamed to `IDOM_WS_MAX_RECONNECT_TIMEOUT` - `idom_web_modules` cache backend has been renamed to `idom` ### Fixed From 55454b63bf9bb69acf65478f2ea7bbeea477f74a Mon Sep 17 00:00:00 2001 From: Archmonger <16909269+Archmonger@users.noreply.github.com> Date: Sun, 30 Jan 2022 19:37:49 -0800 Subject: [PATCH 8/9] remove extra verbiage --- CHANGELOG.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 12b5f690..86cdc1e8 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -41,7 +41,7 @@ Types of changes are to be listed in this order ### Removed -- `IDOM_WEB_MODULES_PATH` has been removed and replaced with Django `include(...)` +- `IDOM_WEB_MODULES_PATH` has been replaced with Django `include(...)` - `IDOM_WS_MAX_RECONNECT_DELAY` has been renamed to `IDOM_WS_MAX_RECONNECT_TIMEOUT` - `idom_web_modules` cache backend has been renamed to `idom` From bedc3f6df824e58895421288ead5dbb7d41ff1ef Mon Sep 17 00:00:00 2001 From: Archmonger <16909269+Archmonger@users.noreply.github.com> Date: Sun, 30 Jan 2022 19:39:54 -0800 Subject: [PATCH 9/9] remove unneeded code block --- CHANGELOG.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 86cdc1e8..ac99bf59 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -33,7 +33,7 @@ Types of changes are to be listed in this order ### Changed -- Fetching `web_modules` from disk and/or cache is now fully async +- Fetching web modules from disk and/or cache is now fully async - Static files are now contained within a `django_idom/` parent folder - Upgraded IDOM to version `0.36.0` - Minimum Django version required is now `4.0`