Pin "BSEC Software Library" dependency at working version #70
Conversation
This file contains hidden or 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
The "Arduino_MKRIoTCarrier" library has a dependency on "BSEC Software Library". The recent 1.7.1492 release of that library has a bug in its `#include` directives that causes compilation to fail with a "`No such file or directory`" error. When "Arduino_MKRIoTCarrier" is installed via the Arduino Library Manager, the dependencies listed in the `depends` metadata field are also installed. Arduino IDE 2.x and Arduino CLI (>=0.7.0) support version constraints in this field: https://arduino.github.io/arduino-cli/latest/library-specification/#version-constraints If a constraint is provided in this field, Library Manager will install the appropriate version of the dependency. Arduino IDE 1.x does not recognize dependency version constraints, but is compatible with this metadata in that it is simply ignored and does not cause any change in the behavior of the Library Manager installation. Using the version constraint to "pin" the "BSEC Software Library" to the last good version (1.6.1480) will mitigate the breakage caused by the bad 1.7.1492 release of that dependency by ensuring the good version is installed along with "Arduino_MKRIoTCarrier" when the user does the installation via the Arduino IDE 2.x or Arduino CLI Library Manager. It is only a partial mitigation because breakage will still be experienced by users under other conditions: - Using Arduino Cloud (which will use the latest available dependency version regardless of constraints in the metadata) - Using Arduino IDE 1.x - Updates "BSEC Software Library" separately
per1234
added
type: imperfection
aentinger
approved these changes
Feb 6, 2023
There was a problem hiding this comment.
Good catch @per1234 🚀 . A really difficult situation 😢 and thank you very much for gathering all the background information. I'd say it really hinges on Bosch's fix and re-release of their library, for which you've already submitted a PR. I suggest two things:
a) Ask @pnndra to contact Bosch directly to expedit the fix.
b) Merge this PR for now, but keep a reminder (i.e. in Slack) to revert it, as soon as Bosch gets their act together.
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.
The "Arduino_MKRIoTCarrier" library has a dependency on "BSEC Software Library". The recent 1.7.1492 release of that library has a bug in its
#includedirectives that causes compilation to fail with a "No such file or directory" error (boschsensortec/BSEC-Arduino-library#58, #69).When "Arduino_MKRIoTCarrier" is installed via the Arduino Library Manager, the dependencies listed in the
dependsmetadata field are also installed. Arduino IDE 2.x and Arduino CLI (>=0.7.0) support version constraints in this field:https://arduino.github.io/arduino-cli/latest/library-specification/#version-constraints
If a constraint is provided in this field, Library Manager will install the appropriate version of the dependency. Arduino IDE 1.x does not recognize dependency version constraints, but is compatible with this metadata in that it is simply ignored and does not cause any change in the behavior of the Library Manager installation.
Using the version constraint to "pin" "BSEC Software Library" to the last good version (1.6.1480) will mitigate the breakage caused by the bad 1.7.1492 release of that dependency by ensuring the good version is installed along with "Arduino_MKRIoTCarrier" when the user does the installation via the Arduino IDE 2.x or Arduino CLI Library Manager. It is only a partial mitigation because breakage will still be experienced by users under other conditions: