Copyright text isn't embedded to aboutlibraries.json starting from 11.1.1
DennisBauer opened this issue · 10 comments
About this issue
- With the update from 11.1.0 to 11.1.1 the plugin doesn't add the copyright text of spdx ID dependencies to the
aboutlibraries.jsongenerated. - That makes the Compose Material 3 UI open the website instead of the copyright text embedded with the app as in the previous version.
Details
- Used library version: 11.1.1
- Used support library version
- Used gradle build tools version: 8.3.1
- Used tooling / Android Studio version: Android Studio Iguana | 2023.2.1 Patch 1
- Other used libraries, potential conflicting libraries
Having the following plugin configuration
aboutLibraries {
offlineMode = false
includePlatform = true
prettyPrint = true
duplicationMode = com.mikepenz.aboutlibraries.plugin.DuplicateMode.LINK
allowedLicenses = arrayOf(
"ASDKL",
"Apache-2.0",
"BSD-2-Clause",
"BSD-3-Clause",
"MIT",
)
strictMode = StrictMode.FAIL
}
Checklist
- Searched for similar issues
- Checked out the sample application
- Read the README
- Checked out the CHANGELOG
- Read the MIGRATION GUIDE
Thank you for the report. Lowering the version directly solves it again for you?
Looked through the diff, there doesn't appear something that would describe such behavior.
I also looked into the changes and the changelog, but couldn't find a change which looks reasonable to me provoking this. The only one is the serializable change but not sure.
Yes going back to 11.1.0 solves the issue and works totally fine.
could you please send the aboutlibraries.json from 11.1.0 and 11.1.1, having trouble to reproduce what you note.
Trying to see if it is actually the export (e.g. the plugin) -> which wasn't modified (beside the gradle update) - or parsing the output maybe.
Using the sample app still works as intended as far as I can tell.
I tried to isolate the issue in a plain new sample app and cannot reproduce it there as well. However in my other project I can always reproduce it once I update to 11.1.1. Here's a snippet of the generated json file for one of the licenses added at the bottom.
Using 11.1.0:
{
"licenses": {
"Apache-2.0": {
"content": "Apache License\nVersion 2.0, January 2004\nhttp://www.apache.org/licenses/\n\nTERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION\n\n1. Definitions.\n\n\"License\" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document.\n\n\"Licensor\" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License.\n\n\"Legal Entity\" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, \"control\" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity.\n\n\"You\" (or \"Your\") shall mean an individual or Legal Entity exercising permissions granted by this License.\n\n\"Source\" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files.\n\n\"Object\" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types.\n\n\"Work\" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below).\n\n\"Derivative Works\" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof.\n\n\"Contribution\" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, \"submitted\" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as \"Not a Contribution.\"\n\n\"Contributor\" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work.\n\n2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form.\n\n3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed.\n\n4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions:\n\n (a) You must give any other recipients of the Work or Derivative Works a copy of this License; and\n\n (b) You must cause any modified files to carry prominent notices stating that You changed the files; and\n\n (c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and\n\n (d) If the Work includes a \"NOTICE\" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License.\n\n You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License.\n\n5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions.\n\n6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file.\n\n7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an \"AS IS\" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License.\n\n8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages.\n\n9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability.\n\nEND OF TERMS AND CONDITIONS\n\nAPPENDIX: How to apply the Apache License to your work.\n\nTo apply the Apache License to your work, attach the following boilerplate notice, with the fields enclosed by brackets \"[]\" replaced with your own identifying information. (Don't include the brackets!) The text should be enclosed in the appropriate comment syntax for the file format. We also recommend that a file or class name and description of purpose be included on the same \"printed page\" as the copyright notice for easier identification within third-party archives.\n\nCopyright [yyyy] [name of copyright owner]\n\nLicensed under the Apache License, Version 2.0 (the \"License\");\nyou may not use this file except in compliance with the License.\nYou may obtain a copy of the License at\n\nhttp://www.apache.org/licenses/LICENSE-2.0\n\nUnless required by applicable law or agreed to in writing, software\ndistributed under the License is distributed on an \"AS IS\" BASIS,\nWITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\nSee the License for the specific language governing permissions and\nlimitations under the License.",
"hash": "Apache-2.0",
"internalHash": "Apache-2.0",
"url": "https://spdx.org/licenses/Apache-2.0.html",
"spdxId": "Apache-2.0",
"name": "Apache License 2.0"
}
}
}
Using 11.1.1:
{
"licenses": {
"Apache-2.0": {
"hash": "Apache-2.0",
"internalHash": "Apache-2.0",
"url": "https://www.apache.org/licenses/LICENSE-2.0.txt",
"spdxId": "Apache-2.0",
"name": "The Apache Software License, Version 2.0"
},
}
}
Comparing the results the content block is completely missing, but also the url and name doesn't match anymore. I'll let you know if I find out anything else.
Thank you so much for having a look!
that's extremely interesting. the only change was gradle 🤔
If you update only the plugin but not the ui, or inverse. would it make a difference?
Wondering if some gradle cache is causing this
I had problems building the project with the latest Android Studio version bundled with JDK 17 instead of 11, which the project asks for. I'll try it again using an external JDK 11.
I have finally found the cause of this misbehavior. The problem was in the build setup of the project, not in this plugin. The download request to spdx.org was blocked by a firewall, which prevented the plugin from adding the license content to the JSON file. Sorry to bother you with this and thanks for looking into it.
@DennisBauer thank you so much for the feedback. And no, don't worry. That's awesome feedback. I need to double check what log level errors are for such cases. Because maybe the plugin didn't report visible enough that the request wasn't going through.
I agree, logging such failed requests instead of just processing them silently might be helpful for others. I used the info log level, but that didn't help me figure out the problem.
Ok checked. There should have been error/warning logs. But I suppose the log around the GitHub rate limit might have been the major one, not indicating the request couldn't be done at all:
https://github.com/mikepenz/AboutLibraries/blob/develop/plugin-build/plugin/src/main/kotlin/com/mikepenz/aboutlibraries/plugin/api/GitHubApi.kt#L39
Btw. if you would prefer the plugin to act offline without doing requests, you can do so. And you can supply the license content via the config folder.
For example as done in the sample: https://github.com/mikepenz/AboutLibraries/tree/develop/config/licenses