From 3aea2fccc0493ad88ea72dc5adcd89fa6aee0b0e Mon Sep 17 00:00:00 2001 From: Joe Numainville Date: Thu, 29 Feb 2024 16:13:09 -0600 Subject: [PATCH] comments --- .github/workflows/modified-plugin.yml | 4 +- .github/workflows/release-python-package.yml | 4 +- plugins/packaging/.gitignore | 8 + plugins/packaging/LICENSE | 202 ++++++++++++++++++ plugins/packaging/README.md | 25 +++ plugins/packaging/pyproject.toml | 3 + plugins/packaging/setup.cfg | 29 +++ .../deephaven/plugin/packaging/__init__.py | 1 + .../src/deephaven/plugin/packaging/utils.py | 41 ++++ plugins/utilities/README.md | 3 +- .../deephaven/plugin/utilities/__init__.py | 1 + .../utilities/dhe_safe_callback_wrapper.py | 52 +++++ .../src/deephaven/plugin/utilities/utils.py | 62 +----- tools/update_version.sh | 3 + 14 files changed, 377 insertions(+), 61 deletions(-) create mode 100644 plugins/packaging/.gitignore create mode 100644 plugins/packaging/LICENSE create mode 100644 plugins/packaging/README.md create mode 100644 plugins/packaging/pyproject.toml create mode 100644 plugins/packaging/setup.cfg create mode 100644 plugins/packaging/src/deephaven/plugin/packaging/__init__.py create mode 100644 plugins/packaging/src/deephaven/plugin/packaging/utils.py create mode 100644 plugins/utilities/src/deephaven/plugin/utilities/dhe_safe_callback_wrapper.py diff --git a/.github/workflows/modified-plugin.yml b/.github/workflows/modified-plugin.yml index 00a96cb4d..f7e3ec601 100644 --- a/.github/workflows/modified-plugin.yml +++ b/.github/workflows/modified-plugin.yml @@ -11,7 +11,8 @@ on: - 'matplotlib-v*' - 'json-v*' - 'ui-v*' - - 'utilities-v*' + - 'packaging-v*' + - 'packaging-v*' jobs: changes: @@ -34,6 +35,7 @@ jobs: json: plugins/json/** ui: plugins/ui/** utilities: plugins/utilities/** + packaging: plugins/packaging/** # Test all python packages that have been modified individually test-python: diff --git a/.github/workflows/release-python-package.yml b/.github/workflows/release-python-package.yml index 5b4441f07..8f9c7e804 100644 --- a/.github/workflows/release-python-package.yml +++ b/.github/workflows/release-python-package.yml @@ -32,8 +32,8 @@ jobs: run: npm ci - name: Build npm packages - # utilities package does not have any npm package to build - if : ${{ inputs.package != 'utilities' }} + # packaging and packaging packages do not have npm packages to build + if : ${{ inputs.package != 'packaging' && inputs.package != 'packaging' }} run: npm run build -- --scope "@deephaven/js-plugin-${{ inputs.package }}" - name: Set up Python diff --git a/plugins/packaging/.gitignore b/plugins/packaging/.gitignore new file mode 100644 index 000000000..3356dc1ce --- /dev/null +++ b/plugins/packaging/.gitignore @@ -0,0 +1,8 @@ +build/ +dist/ +.venv/ +/venv +*.egg-info/ +.idea +.DS_store +__pycache__/ \ No newline at end of file diff --git a/plugins/packaging/LICENSE b/plugins/packaging/LICENSE new file mode 100644 index 000000000..d64569567 --- /dev/null +++ b/plugins/packaging/LICENSE @@ -0,0 +1,202 @@ + + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "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. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "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. + + "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). + + "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. + + "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." + + "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. + + 2. 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. + + 3. 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. + + 4. 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: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (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 + + (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. + + 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. + + 5. 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. + + 6. 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. + + 7. 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. + + 8. 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. + + 9. 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. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To 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. + + Copyright [yyyy] [name of copyright owner] + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/plugins/packaging/README.md b/plugins/packaging/README.md new file mode 100644 index 000000000..6f83ea754 --- /dev/null +++ b/plugins/packaging/README.md @@ -0,0 +1,25 @@ +# Deephaven Plugin Packaging + +This is a Python package that stores cross-plugin utilities for packaging Deephaven plugins. +This package is used by the Deephaven plugin build process to create wheels for plugins. +If the functions need to be available at runtime, they should be added to `utilities` instead. +This is not a plugin on its own. + +## Build + +To create your build / development environment (skip the first two lines if you already have a venv): + +```sh +python -m venv .venv +source .venv/bin/activate +pip install --upgrade pip setuptools +pip install build +``` + +To build: + +```sh +python -m build --wheel +``` + +The wheel is stored in `dist/`. diff --git a/plugins/packaging/pyproject.toml b/plugins/packaging/pyproject.toml new file mode 100644 index 000000000..62df2b006 --- /dev/null +++ b/plugins/packaging/pyproject.toml @@ -0,0 +1,3 @@ +[build-system] +requires = ["setuptools>=43.0.0", "wheel"] +build-backend = "setuptools.build_meta" diff --git a/plugins/packaging/setup.cfg b/plugins/packaging/setup.cfg new file mode 100644 index 000000000..1d2e14b16 --- /dev/null +++ b/plugins/packaging/setup.cfg @@ -0,0 +1,29 @@ +[metadata] +name = deephaven-plugin-packaging +description = Deephaven Plugin Packaging +long_description = file: README.md +long_description_content_type = text/markdown +version = 0.0.1.dev0 +url = https://github.com/deephaven/deephaven-plugins +project_urls = + Source Code = https://github.com/deephaven/deephaven-plugins + Bug Tracker = https://github.com/deephaven/deephaven-plugins/issues +classifiers = + Programming Language :: Python :: 3 + License :: OSI Approved :: Apache Software License + Operating System :: OS Independent + Environment :: Plugins + Development Status :: 3 - Alpha +keywords = deephaven, plugin, packaging +author = Joe Numainville +author_email = josephnumainville@deephaven.io +platforms = any + +[options] +package_dir= + =src +packages=find_namespace: +include_package_data = True + +[options.packages.find] +where=src diff --git a/plugins/packaging/src/deephaven/plugin/packaging/__init__.py b/plugins/packaging/src/deephaven/plugin/packaging/__init__.py new file mode 100644 index 000000000..16281fe0b --- /dev/null +++ b/plugins/packaging/src/deephaven/plugin/packaging/__init__.py @@ -0,0 +1 @@ +from .utils import * diff --git a/plugins/packaging/src/deephaven/plugin/packaging/utils.py b/plugins/packaging/src/deephaven/plugin/packaging/utils.py new file mode 100644 index 000000000..cc4bb6f69 --- /dev/null +++ b/plugins/packaging/src/deephaven/plugin/packaging/utils.py @@ -0,0 +1,41 @@ +import shutil +import os +import subprocess + + +def package_js(js_dir: str, dest_dir: str) -> None: + """ + Package the built JS files at the given JS directory and unpack them into the destination directory. + + Args: + js_dir: + The directory containing the JS files + dest_dir: + The directory to unpack the JS files into + """ + dist_dir = os.path.join(js_dir, "dist") + build_dir = os.path.join(js_dir, "build") + package_dir = os.path.join(build_dir, "package") + + # copy the bundle to the directory + # the path may not exist (e.g. when running tests) + # so it is not strictly necessary to copy the bundle + if os.path.exists(dist_dir): + # ignore errors as the directory may not exist + shutil.rmtree(build_dir, ignore_errors=True) + shutil.rmtree(dest_dir, ignore_errors=True) + + os.makedirs(build_dir, exist_ok=True) + + # pack and unpack into the js directory + subprocess.run( + ["npm", "pack", "--pack-destination", "build"], cwd=js_dir, check=True + ) + # it is assumed that there is only one tarball in the directory + files = os.listdir(build_dir) + for file in files: + subprocess.run(["tar", "-xzf", file], cwd=build_dir, check=True) + os.remove(os.path.join(build_dir, file)) + + # move the package directory to the expected package location + shutil.move(package_dir, dest_dir) diff --git a/plugins/utilities/README.md b/plugins/utilities/README.md index fb224f9c3..48f8ac1c0 100644 --- a/plugins/utilities/README.md +++ b/plugins/utilities/README.md @@ -1,7 +1,8 @@ # Deephaven Plugin Utilities This is a Python package that stores cross-plugin utilities for building Deephaven plugins. -It is not a plugin itself. +If the functions are only used during the build process, they should be added to `packaging` instead. +This is not a plugin on its own. ## Build diff --git a/plugins/utilities/src/deephaven/plugin/utilities/__init__.py b/plugins/utilities/src/deephaven/plugin/utilities/__init__.py index 16281fe0b..1b2cca4e7 100644 --- a/plugins/utilities/src/deephaven/plugin/utilities/__init__.py +++ b/plugins/utilities/src/deephaven/plugin/utilities/__init__.py @@ -1 +1,2 @@ from .utils import * +from .dhe_safe_callback_wrapper import * diff --git a/plugins/utilities/src/deephaven/plugin/utilities/dhe_safe_callback_wrapper.py b/plugins/utilities/src/deephaven/plugin/utilities/dhe_safe_callback_wrapper.py new file mode 100644 index 000000000..d02302075 --- /dev/null +++ b/plugins/utilities/src/deephaven/plugin/utilities/dhe_safe_callback_wrapper.py @@ -0,0 +1,52 @@ +from deephaven.plugin import Callback, Plugin +import logging +from deephaven.plugin.js import JsPlugin +from .utils import in_enterprise_environment + +logger = logging.getLogger(__name__) + + +class DheSafeCallbackWrapper: + """ + + A wrapper around the Callback class that provides a safe way to register plugins. + + """ + + def __init__(self, callback: Callback): + self._callback = callback + + def register(self, plugin: Plugin) -> None: + """ + Register a plugin with the provided callback + + Args: + plugin: The plugin to register + + """ + if isinstance(plugin, JsPlugin): + self._register_js(plugin) + else: + self._callback.register(plugin) + + def _register_js(self, js_plugin: JsPlugin) -> None: + """ + Attempt to register a JS plugin. + If failed and enterprise is detected, a debug message will be logged. + If failed and enterprise is not detected, an exception will be raised. + + Args: + js_plugin: + The JS plugin to register + """ + try: + self._callback.register(js_plugin) + except RuntimeError as e: + if in_enterprise_environment(): + logger.debug( + f"Failed to register {js_plugin} embedded in Python plugin. Skipping." + ) + else: + raise RuntimeError( + f"Failed to register {js_plugin} embedded in Python plugin: {e}" + ) diff --git a/plugins/utilities/src/deephaven/plugin/utilities/utils.py b/plugins/utilities/src/deephaven/plugin/utilities/utils.py index 6c1543c65..f6d71bafb 100644 --- a/plugins/utilities/src/deephaven/plugin/utilities/utils.py +++ b/plugins/utilities/src/deephaven/plugin/utilities/utils.py @@ -1,77 +1,25 @@ import abc import logging -import shutil import os -import subprocess from functools import partial from typing import Callable, ContextManager import importlib.resources import json import pathlib import sys -from deephaven.plugin import Callback from deephaven.plugin.js import JsPlugin logger = logging.getLogger(__name__) -def package_js(js_dir: str, dest_dir: str) -> None: +def in_enterprise_environment() -> bool: """ - Package the built JS files at the given JS directory and unpack them into the destination directory. + Check if the environment is an enterprise environment. - Args: - js_dir: - The directory containing the JS files - dest_dir: - The directory to unpack the JS files into - """ - dist_dir = os.path.join(js_dir, "dist") - build_dir = os.path.join(js_dir, "build") - package_dir = os.path.join(build_dir, "package") - - # copy the bundle to the directory - # the path may not exist (e.g. when running tests) - # so it is not strictly necessary to copy the bundle - if os.path.exists(dist_dir): - # ignore errors as the directory may not exist - shutil.rmtree(build_dir, ignore_errors=True) - shutil.rmtree(dest_dir, ignore_errors=True) - - os.makedirs(build_dir, exist_ok=True) - - # pack and unpack into the js directory - subprocess.run( - ["npm", "pack", "--pack-destination", "build"], cwd=js_dir, check=True - ) - # it is assumed that there is only one tarball in the directory - files = os.listdir(build_dir) - for file in files: - subprocess.run(["tar", "-xzf", file], cwd=build_dir, check=True) - os.remove(os.path.join(build_dir, file)) - - # move the package directory to the expected package location - shutil.move(package_dir, dest_dir) - - -def attempt_registration(callback: Callback, js_plugin: JsPlugin) -> None: - """ - Attempt to register a JS plugin. - If failed, and enterprise is not detected, it will log as a warning and continue. - - Args: - callback: - A callback to register the JS plugin - js_plugin: - The JS plugin to register + Returns: + True if the environment is an enterprise environment, False otherwise """ - try: - callback.register(js_plugin) - except RuntimeError: - # warning should only be logged if enterprise is not detected - if not os.path.exists("/usr/illumon/latest/bin"): - logger.warning( - f"Failed to register {js_plugin} embedded in python plugin. Skipping." - ) + return any("coreplus" in path or "dnd" in path for path in sys.path) def _create_from_npm_package_json( diff --git a/tools/update_version.sh b/tools/update_version.sh index 9279484c5..0eee3ab85 100755 --- a/tools/update_version.sh +++ b/tools/update_version.sh @@ -142,6 +142,9 @@ case "$package" in utilities) update_file utilities/setup.cfg 'version = ' '' "$extra" ;; + packaging) + update_file packaging/setup.cfg 'version = ' '' "$extra" + ;; *) { log_error "Unhandled plugin $package. You will need to add wiring in $SCRIPT_NAME"