Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Pin markupsafe for Jinja2 workaround #1804

Merged
merged 2 commits into from
Mar 1, 2022
Merged

Pin markupsafe for Jinja2 workaround #1804

merged 2 commits into from
Mar 1, 2022

Conversation

ebeahan
Copy link
Member

@ebeahan ebeahan commented Mar 1, 2022

Recently, Markupsafe released version 2.1.0, and the change now causes versions of Jinja2 2.x to throw an exception when running the generator script:

ImportError: cannot import name 'soft_unicode' from 'markupsafe'

A more recent version of Jinja2 resolves the issue: #1782.

Bumping a dependency to the next major for previous ECS releases feels excessive. However, new installs and CI for any backport to an older branch will fail without a fix.

The following branches will have markupsafe==2.0.1 pinned in their requirements files:

  • 8.0 -> 8.0.1 will be released including the fix.
  • 1.12
  • 1.11
  • 1.10
  • 1.9
  • 1.8
  • 1.7
  • 1.6

Branches pre-1.6. did not use Jinja2 as a dependency, so they are not affected.

@ebeahan ebeahan self-assigned this Mar 1, 2022
@ebeahan ebeahan requested a review from kgeller March 1, 2022 17:39
@ebeahan ebeahan merged commit 8a2318b into elastic:8.0 Mar 1, 2022
@ebeahan ebeahan deleted the fix/pin-markupsafe branch March 1, 2022 20:51
ebeahan added a commit to ebeahan/ecs that referenced this pull request Mar 1, 2022
@ebeahan
Pin markupsafe for Jinja2 workaround (elastic#1804)
90535a9 
* pin markupsafe version

* add changelog

(cherry picked from commit 8a2318b)
@ebeahan ebeahan mentioned this pull request Mar 1, 2022
Merged
ebeahan added a commit to ebeahan/ecs that referenced this pull request Mar 1, 2022
@ebeahan
Pin markupsafe for Jinja2 workaround (elastic#1804)
2fd0c1f 
* pin markupsafe version

* add changelog

(cherry picked from commit 8a2318b)
ebeahan added a commit to ebeahan/ecs that referenced this pull request Mar 1, 2022
@ebeahan
Pin markupsafe for Jinja2 workaround (elastic#1804)
4ea6d0d 
* pin markupsafe version

* add changelog

(cherry picked from commit 8a2318b)

# Conflicts:
#	CHANGELOG.next.md
@ebeahan ebeahan mentioned this pull request Mar 1, 2022
Merged
ebeahan added a commit to ebeahan/ecs that referenced this pull request Mar 1, 2022
@ebeahan
Pin markupsafe for Jinja2 workaround (elastic#1804)
e56d99e 
* pin markupsafe version

* add changelog

(cherry picked from commit 8a2318b)
@ebeahan ebeahan mentioned this pull request Mar 1, 2022
Merged
ebeahan added a commit to ebeahan/ecs that referenced this pull request Mar 1, 2022
@ebeahan
Pin markupsafe for Jinja2 workaround (elastic#1804)
97db74e 
* pin markupsafe version

* add changelog

(cherry picked from commit 8a2318b)
@ebeahan ebeahan mentioned this pull request Mar 1, 2022
Merged
ebeahan added a commit to ebeahan/ecs that referenced this pull request Mar 1, 2022
@ebeahan
Pin markupsafe for Jinja2 workaround (elastic#1804)
f99074b 
* pin markupsafe version

* add changelog

(cherry picked from commit 8a2318b)

# Conflicts:
#	scripts/requirements.txt
@ebeahan ebeahan mentioned this pull request Mar 1, 2022
Merged
ebeahan added a commit to ebeahan/ecs that referenced this pull request Mar 1, 2022
@ebeahan
Pin markupsafe for Jinja2 workaround (elastic#1804)
2c7d6c7 
* pin markupsafe version

* add changelog

(cherry picked from commit 8a2318b)

# Conflicts:
#	CHANGELOG.next.md
#	scripts/requirements.txt
@ebeahan ebeahan mentioned this pull request Mar 1, 2022
Merged
ebeahan added a commit to ebeahan/ecs that referenced this pull request Mar 1, 2022
@ebeahan
Pin markupsafe for Jinja2 workaround (elastic#1804)
85711e1 
* pin markupsafe version

* add changelog

(cherry picked from commit 8a2318b)

# Conflicts:
#	scripts/requirements.txt
@ebeahan ebeahan mentioned this pull request Mar 1, 2022
Merged
@ebeahan
Copy link
Member Author

ebeahan commented Mar 1, 2022

💚 All backports created successfully

Status Branch Result
✅ 1.12
✅ 1.11
✅ 1.10
✅ 1.9
✅ 1.8
✅ 1.7
✅ 1.6

Questions ?

Please refer to the Backport tool documentation

ebeahan added a commit to ebeahan/ecs that referenced this pull request Mar 1, 2022
@ebeahan
Pin markupsafe for Jinja2 workaround (elastic#1804)
c34c2cf 
* pin markupsafe version

* add changelog

(cherry picked from commit 8a2318b)

# Conflicts:
#	CHANGELOG.next.md
ebeahan added a commit to ebeahan/ecs that referenced this pull request Mar 1, 2022
@ebeahan
Pin markupsafe for Jinja2 workaround (elastic#1804)
79b6b50 
* pin markupsafe version

* add changelog

(cherry picked from commit 8a2318b)

# Conflicts:
#	CHANGELOG.next.md
ebeahan added a commit to ebeahan/ecs that referenced this pull request Mar 1, 2022
@ebeahan
Pin markupsafe for Jinja2 workaround (elastic#1804)
3ea3ac2 
* pin markupsafe version

* add changelog

(cherry picked from commit 8a2318b)

# Conflicts:
#	CHANGELOG.next.md
ebeahan added a commit to ebeahan/ecs that referenced this pull request Mar 1, 2022
@ebeahan
Pin markupsafe for Jinja2 workaround (elastic#1804)
d6219f4 
* pin markupsafe version

* add changelog

(cherry picked from commit 8a2318b)

# Conflicts:
#	CHANGELOG.next.md
ebeahan added a commit to ebeahan/ecs that referenced this pull request Mar 1, 2022
@ebeahan
Pin markupsafe for Jinja2 workaround (elastic#1804)
5f61ecf 
* pin markupsafe version

* add changelog

(cherry picked from commit 8a2318b)
ebeahan added a commit to ebeahan/ecs that referenced this pull request Mar 1, 2022
@ebeahan
Pin markupsafe for Jinja2 workaround (elastic#1804)
19a3d7e 
* pin markupsafe version

* add changelog

(cherry picked from commit 8a2318b)
ebeahan added a commit to ebeahan/ecs that referenced this pull request Mar 1, 2022
@ebeahan
Pin markupsafe for Jinja2 workaround (elastic#1804)
606cfc9 
* pin markupsafe version

* add changelog

(cherry picked from commit 8a2318b)

# Conflicts:
#	scripts/requirements.txt
ebeahan added a commit to ebeahan/ecs that referenced this pull request Mar 1, 2022
@ebeahan
Pin markupsafe for Jinja2 workaround (elastic#1804)
cee84de 
* pin markupsafe version

* add changelog

(cherry picked from commit 8a2318b)

# Conflicts:
#	scripts/requirements.txt
ebeahan added a commit that referenced this pull request Mar 1, 2022
@ebeahan
Pin markupsafe for Jinja2 workaround (#1804) (#1806)
6902cbd 
* pin markupsafe version

* add changelog

(cherry picked from commit 8a2318b)
ebeahan added a commit that referenced this pull request Mar 1, 2022
@ebeahan
Pin markupsafe for Jinja2 workaround (#1804) (#1807)
c008349 
* pin markupsafe version

* add changelog

(cherry picked from commit 8a2318b)
ebeahan added a commit that referenced this pull request Mar 1, 2022
@ebeahan
Pin markupsafe for Jinja2 workaround (#1804) (#1808)
55f6abf 
* pin markupsafe version

* add changelog

(cherry picked from commit 8a2318b)
ebeahan added a commit that referenced this pull request Mar 1, 2022
@ebeahan
Pin markupsafe for Jinja2 workaround (#1804) (#1809)
7a2cfc4 
* pin markupsafe version

* add changelog

(cherry picked from commit 8a2318b)
ebeahan added a commit that referenced this pull request Mar 1, 2022
@ebeahan
Pin markupsafe for Jinja2 workaround (#1804) (#1810)
f9d68ce 
* pin markupsafe version

* add changelog

(cherry picked from commit 8a2318b)
ebeahan added a commit that referenced this pull request Mar 1, 2022
@ebeahan
Pin markupsafe for Jinja2 workaround (#1804) (#1811)
6d765ae 
* pin markupsafe version

* add changelog

(cherry picked from commit 8a2318b)
ebeahan added a commit that referenced this pull request Mar 1, 2022
@ebeahan
Pin markupsafe for Jinja2 workaround (#1804) (#1812)
9e18a26 
* pin markupsafe version

* add changelog

(cherry picked from commit 8a2318b)
chosak added a commit to chosak/wagtail that referenced this pull request Apr 4, 2022
@chosak
Pin MarkupSafe to fix tests on 2.15.x
94218ed 
MarkupSafe release 2.10 [0] removed method `soft_unicode`. Jinja2
version 2.11.3 doesn't put an upper bound on its MarkupSafe dependency
[1], so pulls in this changed version of MarkupSafe.

The Wagtail tests specify a Jinja2 version >=2.11,<3.0, so they try
to import Jinja2 2.11.3 and MarkupSafe 2.1.1. These versions are
incompatible due to the removal of `soft_unicode`, producing this
error:

> ImportError: cannot import name 'soft_unicode' from 'markupsafe'

This fails CI, for example [2].

This change adds an upper bound to Wagtail's import of MarkupSafe,
which allows the tests to pass.

Relevant MarkupSafe issue discussing the deprecation: [3]
Comparable project choosing to similarly pin MarkupSafe: [4]

[0] https://markupsafe.palletsprojects.com/en/2.1.x/changes/#version-2-1-0
[1] https://github.com/pallets/jinja/blob/cf215390d4a4d6f0a4de27e2687eed176878f13d/setup.py#L53
[2] https://github.com/wagtail/wagtail/runs/5793338719?check_suite_focus=true
[3] pallets/markupsafe#286
[4] elastic/ecs#1804
chosak added a commit to chosak/wagtail that referenced this pull request Apr 4, 2022
@chosak
Pin MarkupSafe to fix tests on 2.15.x
f346e66 
MarkupSafe release 2.1.0 [0] removed method `soft_unicode`. Jinja2
version 2.11.3 doesn't put an upper bound on its MarkupSafe dependency
[1], so pulls in this changed version of MarkupSafe.

The Wagtail tests specify a Jinja2 version >=2.11,<3.0, so they try
to import Jinja2 2.11.3 and MarkupSafe 2.1.1. These versions are
incompatible due to the removal of `soft_unicode`, producing this
error:

> ImportError: cannot import name 'soft_unicode' from 'markupsafe'

This fails CI, for example [2].

This change adds an upper bound to Wagtail's import of MarkupSafe,
which allows the tests to pass.

Relevant MarkupSafe issue discussing the deprecation: [3]
Comparable project choosing to similarly pin MarkupSafe: [4]

[0] https://markupsafe.palletsprojects.com/en/2.1.x/changes/#version-2-1-0
[1] https://github.com/pallets/jinja/blob/cf215390d4a4d6f0a4de27e2687eed176878f13d/setup.py#L53
[2] https://github.com/wagtail/wagtail/runs/5793338719?check_suite_focus=true
[3] pallets/markupsafe#286
[4] elastic/ecs#1804
@chosak chosak mentioned this pull request Apr 4, 2022
Closed
@rachmadaniHaryono rachmadaniHaryono mentioned this pull request Apr 22, 2022
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@kgeller kgeller kgeller approved these changes

Assignees

@ebeahan ebeahan

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@ebeahan @kgeller