Avoid ClassCastException when loading LogService from Scope #3518
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Motivation ---------- When alternative Loggers are on the classpath calling for the LogService can cause a ClassCastException in the CLI. In order to avoid the exception, leveraging the interface would be preferred. Modifications ------------- I've altered the call for the LogService to remove the explicit cast to JavaLogService. I've added an instanceof check for the original service in order to set the parent if it needs to be. Result ------ The result is a safe call to the LogService regardless of which logger is loaded in the CLI.
|
Initial/Pre-Review Thoughts Change makes sense to me, we don't want to be assuming a specific logger when the CLI code is running. Questions I have:
Potential risks:
What could make the full review difficult:
|
filipelautert
added
the
SafeToBuild
StevenMassaro
approved these changes
Dec 9, 2022
filipelautert
approved these changes
Dec 9, 2022
filipelautert
added
sprint2022-40
SafeToBuild
XDelphiGrl
approved these changes
Dec 12, 2022
There was a problem hiding this comment.
This PR addresses a bug impacting extensions such as https://github.com/mattbertolini/liquibase-slf4j/ that rely on the Liquibase logging framework.
- Functional and test harness executions passing.
- The failing test harness cases are due to an environmental issue in hsql and firebird setup.
- No additional testing required.
APPROVED
mattbertolini
deleted the
mbertolini/cli-logservice-cast-exception-fix
branch
benkard
added a commit
to benkard/mulkcms2
that referenced
this pull request
Jan 21, 2023
This MR contains the following updates: | Package | Type | Update | Change | |---|---|---|---| | [org.liquibase.ext:liquibase-hibernate5](https://github.com/liquibase/liquibase-hibernate/wiki) ([source](https://github.com/liquibase/liquibase-hibernate)) | build | minor | `4.18.0` -> `4.19.0` | | [org.liquibase:liquibase-maven-plugin](http://www.liquibase.org/liquibase-maven-plugin) ([source](https://github.com/liquibase/liquibase)) | build | minor | `4.18.0` -> `4.19.0` | | [io.quarkus:quarkus-maven-plugin](https://github.com/quarkusio/quarkus) | build | minor | `2.15.3.Final` -> `2.16.0.Final` | --- ### Release Notes <details> <summary>liquibase/liquibase-hibernate</summary> ### [`v4.19.0`](https://github.com/liquibase/liquibase-hibernate/releases/tag/v4.19.0) [Compare Source](liquibase/liquibase-hibernate@v4.18.0...v4.19.0) Support for Liquibase 4.19.0. #### What's Changed - Support Hibernate ORM 6.1 with Jakarta EE 10 by [@​papegaaij](https://github.com/papegaaij) in liquibase/liquibase-hibernate#434 - Bump hibernate.version from 6.1.5.Final to 6.1.6.Final by [@​dependabot](https://github.com/dependabot) in liquibase/liquibase-hibernate#447 - Bump spring.version from 6.0.2 to 6.0.3 by [@​dependabot](https://github.com/dependabot) in liquibase/liquibase-hibernate#448 #### New Contributors - [@​papegaaij](https://github.com/papegaaij) made their first contribution in liquibase/liquibase-hibernate#434 **Full Changelog**: liquibase/liquibase-hibernate@v4.18.0...v4.19.0 </details> <details> <summary>liquibase/liquibase</summary> ### [`v4.19.0`](https://github.com/liquibase/liquibase/releases/tag/v4.19.0) [Compare Source](liquibase/liquibase@v4.18.0...v4.19.0) ##### Liquibase v4.19.0 is a patch release with an XSD upgrade. #### Enhancements - Simplify assert calls and replaced with simpler and equivalent calls. by [@​arturobernalg](https://github.com/arturobernalg) in liquibase/liquibase#3497 - Delete unused import statement. by [@​arturobernalg](https://github.com/arturobernalg) in liquibase/liquibase#3522 - Added call to modifyChangeSet during execute method to allow the changeSet to be correctly set on the executor DAT-12388 by [@​wwillard7800](https://github.com/wwillard7800) in liquibase/liquibase#3511 - Remove unnecessary local variables that add nothing to the comprehensibility of a method. by [@​arturobernalg](https://github.com/arturobernalg) in liquibase/liquibase#3373 - Allow loading gzipped data files by [@​mike-seger](https://github.com/mike-seger) in liquibase/liquibase#3379 - Use try-with-resources Statement when is possible. by [@​arturobernalg](https://github.com/arturobernalg) in liquibase/liquibase#3374 - Define and reuse constants. Use an empty array styles to convert a collection to an array. by [@​arturobernalg](https://github.com/arturobernalg) in liquibase/liquibase#3500 - Add support for block comment rollback commands on SQL changesets by [@​krishnaenugandula](https://github.com/krishnaenugandula) in liquibase/liquibase#1399 - Allow primary key on addColumn for H2 by [@​nick318](https://github.com/nick318) in liquibase/liquibase#3372 - Additional (optional) tableType attribute on the CreateTableChange by [@​MartinRied](https://github.com/MartinRied) in liquibase/liquibase#3108 - Include "path" in databasechangelog's description column for all change types with "path" attributes by [@​MichaelKern-IVV](https://github.com/MichaelKern-IVV) in liquibase/liquibase#3244 - [#​1466](liquibase/liquibase#1466): Add ignore:true changeset attribute to Formatted SQL changeLogs by [@​skrivenko](https://github.com/skrivenko) in liquibase/liquibase#3377 - [#​1290](liquibase/liquibase#1290): Forbid empty changeSet id and author by [@​skrivenko](https://github.com/skrivenko) in liquibase/liquibase#3397 - Allow to drop and create a view for a Postgres database if replacing the view would fail by [@​rozenshteyn](https://github.com/rozenshteyn) in liquibase/liquibase#3399 - Rename DatabaseObjectComparator class to be DatabaseObjectCollectionComparator for clarity DAT-10112 by [@​wwillard7800](https://github.com/wwillard7800) in liquibase/liquibase#3544 - Do not lower case the ProvidedValue description if the string is capitalized, i.e. it starts with 2 upper-case characters DAT-12614 by [@​wwillard7800](https://github.com/wwillard7800) in liquibase/liquibase#3589 - Use 'Integer.compare' instead by [@​arturobernalg](https://github.com/arturobernalg) in liquibase/liquibase#3528 - Simplify 'Map' operations. by [@​arturobernalg](https://github.com/arturobernalg) in liquibase/liquibase#3527 - Remove unnecessary semicolon. by [@​arturobernalg](https://github.com/arturobernalg) in liquibase/liquibase#3571 - Missing Override annotations. by [@​arturobernalg](https://github.com/arturobernalg) in liquibase/liquibase#3558 - Prevents redundant loop iterations. Early loop exit in 'if' condition. by [@​arturobernalg](https://github.com/arturobernalg) in liquibase/liquibase#3547 - DAT 6635 - Implement TagCommand by [@​filipelautert](https://github.com/filipelautert) in liquibase/liquibase#3570 - DAT-12576 update release workflow to attach artifact by run_id by [@​ap-liquibase](https://github.com/ap-liquibase) in liquibase/liquibase#3629 - DAT-12365 update install4j script to version 10.x by [@​jnewton03](https://github.com/jnewton03) in liquibase/liquibase#3641 - Upgrades installer JDK version for next release. by [@​filipelautert](https://github.com/filipelautert) in liquibase/liquibase#3440 - remove licenses that were moved to individual extensions (DAT-12784) by [@​StevenMassaro](https://github.com/StevenMassaro) in liquibase/liquibase#3646 - DAT-12597 include commercial sources and javadoc in reversion by [@​ap-liquibase](https://github.com/ap-liquibase) in liquibase/liquibase#3671 #### Security, Driver, and other updates - Bump mariadb-java-client from 3.0.8 to 3.1.0 by [@​dependabot](https://github.com/dependabot) in liquibase/liquibase#3471 - Bump testcontainers-bom from 1.17.5 to 1.17.6 by [@​dependabot](https://github.com/dependabot) in liquibase/liquibase#3477 - Bump snowflake-jdbc from 3.13.22 to 3.13.25 by [@​dependabot](https://github.com/dependabot) in liquibase/liquibase#3475 - Bump slf4j-jdk14 from 2.0.3 to 2.0.4 by [@​dependabot](https://github.com/dependabot) in liquibase/liquibase#3485 - Bump maven-install-plugin from 3.0.1 to 3.1.0 by [@​dependabot](https://github.com/dependabot) in liquibase/liquibase#3484 - Bump castlabs/get-package-version-id-action from 2.0 to 2.1 by [@​dependabot](https://github.com/dependabot) in liquibase/liquibase#3490 - Bump sqlite-jdbc from 3.39.4.0 to 3.40.0.0 by [@​dependabot](https://github.com/dependabot) in liquibase/liquibase#3510 - Bump jaybird from 4.0.6.java8 to 4.0.8.java8 by [@​dependabot](https://github.com/dependabot) in liquibase/liquibase#3509 - Bump mockito-inline from 4.8.1 to 4.10.0 by [@​dependabot](https://github.com/dependabot) in liquibase/liquibase#3580 - Bump targetMavenVersion from 3.8.5 to 3.8.6 by [@​dependabot](https://github.com/dependabot) in liquibase/liquibase#3593 - Bump junit-jupiter-params from 5.8.1 to 5.9.1 by [@​dependabot](https://github.com/dependabot) in liquibase/liquibase#3592 - Bump jaybird from 4.0.6.java8 to 4.0.8.java8 by [@​dependabot](https://github.com/dependabot) in liquibase/liquibase#3602 - Bump slf4j-jdk14 from 2.0.4 to 2.0.6 by [@​dependabot](https://github.com/dependabot) in liquibase/liquibase#3566 - Bump snowflake-jdbc from 3.13.25 to 3.13.26 by [@​dependabot](https://github.com/dependabot) in liquibase/liquibase#3579 - Bump robinraju/release-downloader from 1.6 to 1.7 by [@​dependabot](https://github.com/dependabot) in liquibase/liquibase#3603 - Bump ojdbc8 from 21.7.0.0 to 21.8.0.0 by [@​dependabot](https://github.com/dependabot) in liquibase/liquibase#3551 - Bump up the max number of code points for JSON/YAML parser DAT-12657 by [@​wwillard7800](https://github.com/wwillard7800) in liquibase/liquibase#3552 - Bump actions/cache from 3.0.11 to 3.2.3 by [@​dependabot](https://github.com/dependabot) in liquibase/liquibase#3654 - update changelog version - 4.19 by [@​suryaaki2](https://github.com/suryaaki2) in liquibase/liquibase#3676 - Update changelog xsd 4.19 by [@​suryaaki2](https://github.com/suryaaki2) in liquibase/liquibase#3678 - Bump targetMavenVersion from 3.8.5 to 3.8.7 by [@​dependabot](https://github.com/dependabot) in liquibase/liquibase#3634 - Update release-published.yml by [@​jnewton03](https://github.com/jnewton03) in liquibase/liquibase#3540 - DAT-12783 Adding extension license information by [@​wwillard7800](https://github.com/wwillard7800) in liquibase/liquibase#3614 #### Fixes - fix overwriteOutputFile parameter for GenerateChangelog (DAT-12036) by [@​StevenMassaro](https://github.com/StevenMassaro) in liquibase/liquibase#3543 - Avoid ClassCastException when loading LogService from Scope by [@​mattbertolini](https://github.com/mattbertolini) in liquibase/liquibase#3518 - Adds exclusions for mariadb newly added waffle dependency. by [@​filipelautert](https://github.com/filipelautert) in liquibase/liquibase#3559 - Correctly handle indexes with descending columns in snapshot DAT-11447 by [@​wwillard7800](https://github.com/wwillard7800) in liquibase/liquibase#3535 - Fix getting default schema issue for firebird by [@​MalloD12](https://github.com/MalloD12) in liquibase/liquibase#3390 - Fix generatedSQL logic to allow setting up a function as a default value for MySQL version 8 by [@​MalloD12](https://github.com/MalloD12) in liquibase/liquibase#3362 - DAT-11579: when generating changelogs for MySQL, ignore table column order for PKs by [@​StevenMassaro](https://github.com/StevenMassaro) in liquibase/liquibase#3486 - Included SQL to return unique constraints for Sybase by [@​crenan](https://github.com/crenan) in liquibase/liquibase#3517 - Add varbinary and binary support for DB2 - fixes [#​3408](liquibase/liquibase#3408) by [@​mihaelaDev](https://github.com/mihaelaDev) in liquibase/liquibase#3428 - Added support for COMPUTED values inside CSV files for loadData change by [@​zbynekvavros](https://github.com/zbynekvavros) in liquibase/liquibase#944 - Prevent Executors collision due to hash used as a Map's key part by [@​Dasiu](https://github.com/Dasiu) in liquibase/liquibase#3533 - Breaks out of LockService.init loop after validations are completed by [@​filipelautert](https://github.com/filipelautert) in liquibase/liquibase#3576 - implement SingletonObject to solve [#​2349](liquibase/liquibase#2349) by [@​yairogen](https://github.com/yairogen) in liquibase/liquibase#3624 - Postgresql - Fallback to default schema name in SequenceSnapshotGenerator when this is null by [@​djochim](https://github.com/djochim) in liquibase/liquibase#3637 ##### OWASP Dependency Check: Reported Vulnerabilities - snakeyaml.jar - This is a ["critical" vulnerability reported against the snakeyaml library](https://ossindex.sonatype.org/vulnerability/CVE-2022-1471). We are currently on the newest version of snakeyaml and there is no fix for the issue as of yet. #### New Contributors - [@​mike-seger](https://github.com/mike-seger) made their first contribution in liquibase/liquibase#3379 - [@​crenan](https://github.com/crenan) made their first contribution in liquibase/liquibase#3517 - [@​mihaelaDev](https://github.com/mihaelaDev) made their first contribution in liquibase/liquibase#3428 - [@​krishnaenugandula](https://github.com/krishnaenugandula) made their first contribution in liquibase/liquibase#1399 - [@​skrivenko](https://github.com/skrivenko) made their first contribution in liquibase/liquibase#3397 - [@​zbynekvavros](https://github.com/zbynekvavros) made their first contribution in liquibase/liquibase#944 - [@​Dasiu](https://github.com/Dasiu) made their first contribution in liquibase/liquibase#3533 - [@​yairogen](https://github.com/yairogen) made their first contribution in liquibase/liquibase#3624 - [@​djochim](https://github.com/djochim) made their first contribution in liquibase/liquibase#3637 **Full Changelog**: liquibase/liquibase@v4.18.0...v4.19.0 ##### Get Certified Learn all the Liquibase fundamentals from free online courses by Liquibase experts and see how to apply them in the real world at https://learn.liquibase.com/. ##### Read the Documentation Please check out and contribute to the continually improving docs, now at https://docs.liquibase.com/. ##### Meet the Community Our community has built a lot. From extensions to integrations, you’ve helped make Liquibase the amazing open source project that it is today. Keep contributing to making it stronger: [Contribute code](https://www.liquibase.org/development/contribute.html) [Make doc updates](https://github.com/Datical/liquibase-docs) [Help by asking and answering questions](https://forum.liquibase.org/) [Set up a chat with the Product team](https://calendly.com/liquibase-outreach/product-feedback) Thanks to everyone who helps make the Liquibase community strong! #### File Descriptions - **Liquibase CLI** -- Includes open source + commercial functionality - **liquibase-x.y.z.tar.gz** -- Archive in tar.gz format - **liquibase-x.y.z.zip** -- Archive in zip format - **liquibase-windows-x64-installer-x.y.z.exe** -- Installer for Windows - **liquibase-macos-installer-x.y.z.dmg** -- Installer for MacOS - **Primary Libraries** - For embedding in other software - **liquibase-core-x.y.z.jar** – Base Liquibase library (open source) - **liquibase-commerical-x.y.z.jar** – Additional commercial functionality - **liquibase-additional-x.y.z.zip** – Contains additional, less commonly used files - Additional libraries such as liquibase-maven-plugin.jar and liquibase-cdi.jar - Javadocs for all the libraries - Source archives for all the open source libraries - ASC/MD5/SHA1 verification hashes for all files **NOTE: liquibase-core-<version>.jar** contains only the open-source license. If you use Liquibase Pro or other commercial add-ons, you must also **install liquibase-commercial-<version>.jar** </details> <details> <summary>quarkusio/quarkus</summary> ### [`v2.16.0.Final`](quarkusio/quarkus@2.15.3.Final...2.16.0.Final) [Compare Source](quarkusio/quarkus@2.15.3.Final...2.16.0.Final) </details> --- ### Configuration 📅 **Schedule**: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined). 🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied. ♻ **Rebasing**: Whenever MR is behind base branch, or you tick the rebase/retry checkbox. 👻 **Immortal**: This MR will be recreated if closed unmerged. Get [config help](https://github.com/renovatebot/renovate/discussions) if that's undesired. --- - [ ] <!-- rebase-check -->If you want to rebase/retry this MR, check this box --- This MR has been generated by [Renovate Bot](https://github.com/renovatebot/renovate). <!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzNC4yNC4wIiwidXBkYXRlZEluVmVyIjoiMzQuMjQuMCJ9-->
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Impact
Description
This PR fixes a bug where a
ClassCastExceptionoccurs when alternative logger implementations are on the classpath when the CLI is used. This was previously fixed on the older legacyMainclass but the newerLiquibaseCommandLinestill has the issue.Motivation is to avoid issues like this from being created.
Things to be aware of
Things to worry about
None that I know of. This change is backwards compatible.
Additional Context