Release 3.2 #105

tymees · 2024-07-30T13:13:00Z

Release 3.2

So, this is my last release as maintainer of this project. Sad noises :(

It's been interesting to see a project which was originally just a bad way to fix a non-problem turn out into a foundation for more than 10 applications. Talking about legacy :P

Anyway, so long, and thanks for all the fish

What's Changed

Features:

New mailing code: cdh.mail; this new version is compatible with Django >=4.2
- It's API-compatible with cdh.core.mail, so just update the imports/base templates. (Don't forget to add cdh.mail to INSTALLED_APPS)
- Note: the new code is 'fault-permissive'; any exceptions thrown during sending are now catched (and logged) by default. If you depend on the old behavior either set CDH_EMAIL_FAIL_SILENTLY to False in your settings, or provide the fail_silently=False kwarg to the various send methods/functions.
Fake form field for headers etc by @tymees in feature: fake form field for headers etc #90
- This can be used to display static text as part of the form, without resorting to JS injection of said text. See the custom form page in the dev project
New vue-based list (UUList) by @tymees in Feature/uu list #89
- Replacement for Fancy-List
feat: added Django 5 support by @tymees in feat: added Django 5 support #93
Feature/js search widget by @tymees in Feature/js search widget #95
- Uses Select2 as a simple widget, no own JS/CSS required
New date widgets hardcoded to use dutch formatting: BootstrapDateInput, BootstrapSplitDateInput

Fixes:

use window.jQuery instead of window.$ to avoid clashes by @bbonf in use window.jQuery instead of window.$ to avoid clashes #99
Saver thread-local storage for ThreadLocalStorageMiddleware
Validation errors are now visible when using SearchableSelectWidget
SearchableSelectWidget now correctly takes the width it's given on the page.

Deprecations

File-loader utilities in cdh.core; use Form Media instead
cdh.core.mail, use cdh.mail instead. The old code is not usable in Django versions >= 4.2

Docs:

docs: update new repo url by @tymees in docs: update new repo url #91
Docs/update readme by @tymees in Docs/update readme #92

Known problems

cdh.core.mail does not work with Django >=4.2; Migrate to cdh.mail for a working implementation

Full Changelog: v3.1.0...v3.2.0

# Conflicts: # package.json # src/cdh/core/static/cdh.core/css/bootstrap.css # src/cdh/core/static/cdh.core/css/bootstrap.css.map # yarn.lock

That one _can_ handle proxy objects, such as lazy strings

Fixes #62

…m-fields feature: fake form field for headers etc

…adme Docs/update readme

# Conflicts: # src/cdh/core/forms.py

Feature/uu list

feat: added Django 5 support

…rch-widget Feature/js search widget

Fixes #96

BREAKING CHANGE: Drops support for 4.0 and lower

fed-auth is actually 4.1 now

use window.jQuery instead of window.$ to avoid clashes

Based upon the old cdh.core.mail code, but with refactored template-code and non-blocking errors. (Including new logging).

Fixes #102

Fixes #101

V3.2

tymees · 2024-07-30T13:16:41Z

@miggol I've added you as a reviewer as a 'passing the buck' kind of thing. Actually reviewing is probably too much of a chore ;)

The description is the draft release notes, which I always write as part of the staging -> main PR. (Mostly because the diff a PR gives me is a good way to write those)

miggol · 2024-08-14T12:16:35Z

Alright, I'm starting to look at this today.

As you say, won't be quality review. But it's a good reason to dive into the codebase and as good a place as any for questions.

Congratulations on leaving such a legacy! Bit daunting, mind you.

miggol

Alright, I went through most of this once and learned a lot! Nothing to really comment, just some questions.

I didn't go through cdh.mail or the vue-lib side of uu-list thoroughly, I'll get to figuring those out when I need them.

miggol · 2024-08-26T14:01:52Z

.github/workflows/django-tests.yml

@@ -14,7 +14,7 @@ jobs:
    strategy:
      max-parallel: 2
      matrix:
-        python-version: ['3.9', '3.10']
+        python-version: ['3.11']


Is there a reason tests don't all suported Python versions named in README.md?

I can imagine it eats up lots of runner minutes.

Testing is now done using Django 5, which does not support Python 3.9;

At some point I had multiple requirements.txt per Django version, which would allow proper testing of all version combinations, but that was a lot of (annoying) upkeep.

miggol · 2024-08-26T14:29:32Z

assets/vue/example-custom-uu-list/package.json

+  "author": "Humanities IT Portal development",
+  "license": "Apache-2.0",
+  "scripts": {
+    "dev": "vite dev",


Could you give me a quick rundown of how you develop a component that uses whole stack at once? Is it just running the Django test project with both Vite and sass watching for changes in the background?

Yes, sort off. Writing a Vue component just involves running yarn dev (and the dev-app), and a lot of 'full-refreshing'.

The dev command starts a watcher that compiles everything configured in the vite.config.ts (in this case src/index.ts, which is just a small set of imports/exports) into the configured output dir (the static-dir of the django app).
Any component or imported (S)CSS is compiled by Vite as well, so no extra command needed for that.

However, that's only for the Vue components. If you want to build any of the 'root stylesheets' shipped in the library (read: the full UU-bootstrap project + django specific additions), you'll need the build-css, watch-css and build-fedauth-css commands in the root package.json.
(The last one is a very minimal build of the UU-Bootstrap with only a small subset of the whole thing, to 1) have an independent build for the fed-auth app and 2) keep that build as small as possible).

miggol · 2024-08-26T14:48:56Z

src/cdh/vue3/static/cdh.vue3/components/uu-list/UUList.iife.js

Is building an IIFE required or an optimization? Is IIFE a conscious choice over the other formats suggested by Vite?

Yes, it's a conscious choice; the other options all build (relatively) complicated modules, which are a pain to load properly. (Ben has it working, but he compiles a full app/uses Vue in a global scope, we are interested in mounting a single component).

Basically, IIFE will compile everything into a single non-module file, which can be easily loaded.

miggol · 2024-08-26T14:55:06Z

dev/dev_vue/views.py

The Django side of UU-List is looking super clean!

miggol · 2024-08-26T15:38:02Z

src/cdh/core/templates/base/minimal.html

+     vV\|/vV|`-'\  ,---\   | \Vv\hjwVv\//v
+                _) )    `. \ /
+               (__/       ) )
+                         (_/
 Miauw!


:･ﾟ✧(=✪ ᆺ ✪=);:･ﾟ✧

miggol · 2024-08-26T15:51:02Z

src/cdh/core/static/cdh.core/js/datepicker-full.js

Just scrolling through this gives me secondhand trauma

If this is vanillajs-datepicker, it's just in here to not require a build step in projects that use DSC, right? Or have you made modifications?

This is just a copy of the JS files shipped with the NPM package (node_modules/vanillajs-datepicker/dist/js/datepicker-full.js), no edits. It's copied here to avoid having a build-step, yes. (AFAIK there is not a nice way to even do that in this specific case).

The needed CSS is custom/compiled in-project however;
See build-datepicker-css in package.json and https://github.com/CentreForDigitalHumanities/django-shared-core/blob/1397a7ea62828ce0e8378dcdcc0f01492b986074/assets/scss/vanillajs-datepicker.scss

That's needed because UU-Bootstrap != Bootstrap, so we cannot use the shipped CSS. (That, and this library does not actually build their CSS properly, but that's a different rant).
By compiling it ourselves we can make use of the bootstrap configuration shipped with UU-Bootstrap, which will make sure the right values are used. (The right colors, border roundiness, borders, etc).

(The separate rant being that they don't use the CSS variables Bootstrap provides, and instead only use SCSS variables. If they did the former, we probably could've re-used the shipped CSS. But alas, they don't, so we need to compile it with our own set of SCSS variables. It's not a 'bad' approach, it's a lot easier, just not a very 'bootstrap-y' way of doing things)

(This comment is mostly here for if someone else reads this comment through a google search or something, and thinks I'm being overly negative.)

tymees added 30 commits October 20, 2023 11:18

feature: new Vue 3 based list-view

3952cee

feature: setup Vue-i18n if loaded as a global

5ddf522

feature: provide global versions of Vue and Vue-i18n

87a035a

chore: add missing dependency

3c51435

feature: UU-Bootstrap 1.5.0-alpha.0

b70a010

feature: New cat!

5271454

feature: saver thread-local storage

d06eb7b

chore: deprecate file_loading utils

e03f246

feature: use Django media to load in widget dependencies

1040fc4

Merge branch 'develop' into feature/uu-list

4650693

# Conflicts: # package.json # src/cdh/core/static/cdh.core/css/bootstrap.css # src/cdh/core/static/cdh.core/css/bootstrap.css.map # yarn.lock

fix: use the DjangoJSONEnconder as base

0854871

That one _can_ handle proxy objects, such as lazy strings

chore: use cdh-vue-lib 0.2.2

3b14659

fix: ordering was always set to default

f3dd309

feature: fake form field for headers etc

8b3c007

Fixes #62

fix: From -> Form typo

4466820

docs: added HTML injection warning

4c622ee

Merge pull request #90 from DH-IT-Portal-Development/feature/fake-for…

f1b3c1a

…m-fields feature: fake form field for headers etc

fix: custom date(time) fields were not using ISO formatting

5865efa

Merge pull request #92 from CentreForDigitalHumanities/docs/update-re…

4cfb0fd

…adme Docs/update readme

chore: update cdh-vue-lib to 0.3.1

8a11768

feat: added custom DSC list example

d53b7d6

Merge branch 'develop' into feature/uu-list

89d20a5

# Conflicts: # src/cdh/core/forms.py

Merge pull request #89 from CentreForDigitalHumanities/feature/uu-list

47b471b

Feature/uu list

feat: added Django 5 support

81c076d

Merge pull request #93 from CentreForDigitalHumanities/support/django-5

5c4e9a5

feat: added Django 5 support

Upped package version

3b19d5d

feat: added select2 widget

1cc2c2f

deps: update to uu bootstrap 1.5 alpha 1

f013dda

Merge pull request #95 from CentreForDigitalHumanities/feature/js-sea…

8831dea

…rch-widget Feature/js search widget

fix: remove broken experiment

07ecf50

Fixes #96

bbonf and others added 14 commits April 4, 2024 12:15

use window.jQuery instead of window.$ to avoid clashes

f3dfe3c

fix: use new mixin name for LogoutInitView

b5d7e79

BREAKING CHANGE: Drops support for 4.0 and lower

docs: upped the minimum required versions to 2024 standards

40d30d3

fed-auth is actually 4.1 now

Merge pull request #99 from CentreForDigitalHumanities/fix/jquery-dollar

9c56f9d

use window.jQuery instead of window.$ to avoid clashes

feat: new (semi) stand-alone mail app

a326f5e

Based upon the old cdh.core.mail code, but with refactored template-code and non-blocking errors. (Including new logging).

chore: mark cdh.core.mail as deprecated

51de62c

Merge remote-tracking branch 'origin/develop' into develop

26bb7aa

fix: added missing template

0ce5c6b

feat: new custom date-inputs in NL format

7dd75d9

refactor: remove old datepicker library

b43c065

fix: show form feedback for SearchableSelectWidget

b73c97c

Fixes #102

fix: make sure select2 uses the width it has

7aab132

Fixes #101

chore: bump versions

74a3b3a

Merge pull request #104 from CentreForDigitalHumanities/develop

1397a7e

V3.2

tymees requested a review from miggol July 30, 2024 13:14

miggol approved these changes Aug 26, 2024

View reviewed changes

tymees merged commit 4525a60 into master Sep 3, 2024
3 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Release 3.2 #105

Release 3.2 #105

tymees commented Jul 30, 2024 •

edited

Loading

tymees commented Jul 30, 2024

miggol commented Aug 14, 2024

miggol left a comment

miggol Aug 26, 2024

tymees Aug 26, 2024

miggol Aug 26, 2024

tymees Aug 26, 2024

miggol Aug 27, 2024

miggol Aug 26, 2024

tymees Aug 26, 2024

miggol Aug 26, 2024

miggol Aug 26, 2024

miggol Aug 26, 2024

tymees Aug 26, 2024

tymees Aug 26, 2024

Release 3.2 #105

Release 3.2 #105

Conversation

tymees commented Jul 30, 2024 • edited Loading

Release 3.2

What's Changed

Features:

Fixes:

Deprecations

Docs:

Known problems

tymees commented Jul 30, 2024

miggol commented Aug 14, 2024

miggol left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

tymees commented Jul 30, 2024 •

edited

Loading