From b233a471f8a681cfb313507390b20f1c4d8398bc Mon Sep 17 00:00:00 2001 From: Joe Numainville Date: Thu, 29 Feb 2024 09:46:45 -0600 Subject: [PATCH] wip --- .github/workflows/modified-plugin.yml | 2 + .github/workflows/release-python-package.yml | 2 + plugins/utilities/.gitignore | 8 + plugins/utilities/LICENSE | 202 ++++++++++++++++++ plugins/utilities/README.md | 26 +++ plugins/utilities/pyproject.toml | 3 + plugins/utilities/setup.cfg | 31 +++ .../deephaven/plugin/utilities/__init__.py | 1 + .../src/deephaven/plugin/utilities/utils.py | 159 ++++++++++++++ tools/update_version.sh | 3 + 10 files changed, 437 insertions(+) create mode 100644 plugins/utilities/.gitignore create mode 100644 plugins/utilities/LICENSE create mode 100644 plugins/utilities/README.md create mode 100644 plugins/utilities/pyproject.toml create mode 100644 plugins/utilities/setup.cfg create mode 100644 plugins/utilities/src/deephaven/plugin/utilities/__init__.py create mode 100644 plugins/utilities/src/deephaven/plugin/utilities/utils.py diff --git a/.github/workflows/modified-plugin.yml b/.github/workflows/modified-plugin.yml index 4c4837347..00a96cb4d 100644 --- a/.github/workflows/modified-plugin.yml +++ b/.github/workflows/modified-plugin.yml @@ -11,6 +11,7 @@ on: - 'matplotlib-v*' - 'json-v*' - 'ui-v*' + - 'utilities-v*' jobs: changes: @@ -32,6 +33,7 @@ jobs: matplotlib: plugins/matplotlib/** json: plugins/json/** ui: plugins/ui/** + utilities: plugins/utilities/** # 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 5ffa014a2..5b4441f07 100644 --- a/.github/workflows/release-python-package.yml +++ b/.github/workflows/release-python-package.yml @@ -32,6 +32,8 @@ jobs: run: npm ci - name: Build npm packages + # utilities package does not have any npm package to build + if : ${{ inputs.package != 'utilities' }} run: npm run build -- --scope "@deephaven/js-plugin-${{ inputs.package }}" - name: Set up Python diff --git a/plugins/utilities/.gitignore b/plugins/utilities/.gitignore new file mode 100644 index 000000000..3356dc1ce --- /dev/null +++ b/plugins/utilities/.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/utilities/LICENSE b/plugins/utilities/LICENSE new file mode 100644 index 000000000..d64569567 --- /dev/null +++ b/plugins/utilities/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/utilities/README.md b/plugins/utilities/README.md new file mode 100644 index 000000000..fb224f9c3 --- /dev/null +++ b/plugins/utilities/README.md @@ -0,0 +1,26 @@ +# Deephaven Plugin Utilities + +This is a Python package that stores cross-plugin utilities for building Deephaven plugins. +It is not a plugin itself. + +## 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 deephaven-plugin +``` + +To build: + +```sh +python -m build --wheel +``` + +The wheel is stored in `dist/`. + +To test within [deephaven-core](https://github.com/deephaven/deephaven-core), note where this wheel is stored (using `pwd`, for example). +Then, follow the directions in the top-level README.md to install the wheel into your Deephaven environment. diff --git a/plugins/utilities/pyproject.toml b/plugins/utilities/pyproject.toml new file mode 100644 index 000000000..62df2b006 --- /dev/null +++ b/plugins/utilities/pyproject.toml @@ -0,0 +1,3 @@ +[build-system] +requires = ["setuptools>=43.0.0", "wheel"] +build-backend = "setuptools.build_meta" diff --git a/plugins/utilities/setup.cfg b/plugins/utilities/setup.cfg new file mode 100644 index 000000000..78b1efcd4 --- /dev/null +++ b/plugins/utilities/setup.cfg @@ -0,0 +1,31 @@ +[metadata] +name = deephaven-plugin-utilities +description = Deephaven Plugin Utilities +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, utilities +author = Joe Numainville +author_email = josephnumainville@deephaven.io +platforms = any + +[options] +package_dir= + =src +packages=find_namespace: +install_requires = + deephaven-plugin>=0.6.0 +include_package_data = True + +[options.packages.find] +where=src diff --git a/plugins/utilities/src/deephaven/plugin/utilities/__init__.py b/plugins/utilities/src/deephaven/plugin/utilities/__init__.py new file mode 100644 index 000000000..16281fe0b --- /dev/null +++ b/plugins/utilities/src/deephaven/plugin/utilities/__init__.py @@ -0,0 +1 @@ +from .utils import * diff --git a/plugins/utilities/src/deephaven/plugin/utilities/utils.py b/plugins/utilities/src/deephaven/plugin/utilities/utils.py new file mode 100644 index 000000000..6c1543c65 --- /dev/null +++ b/plugins/utilities/src/deephaven/plugin/utilities/utils.py @@ -0,0 +1,159 @@ +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: + """ + 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) + + +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 + """ + 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." + ) + + +def _create_from_npm_package_json( + path_provider: Callable[[], ContextManager[pathlib.Path]], plugin_class: abc.ABCMeta +) -> JsPlugin: + """ + Create a JsPlugin from an npm package.json file. + + Args: + path_provider: + A function that returns a context manager that provides a pathlib.Path to the package.json file + plugin_class: + The class to create. It must be a subclass of JsPlugin. + """ + with path_provider() as tmp_js_path: + js_path = tmp_js_path + if not js_path.exists(): + raise Exception( + f"Package is not installed in a normal python filesystem, '{js_path}' does not exist" + ) + with (js_path / "package.json").open("rb") as f: + package_json = json.load(f) + return plugin_class( + package_json["name"], + package_json["version"], + package_json["main"], + js_path, + ) + + +def _resource_js_path_provider( + package_namespace: str, js_name: str +) -> Callable[[], ContextManager[pathlib.Path]]: + """ + Get the path to a resource in a package. + + Args: + package_namespace: + The package namespace + js_name: + The resource name + """ + return partial(_resource_js_path, package_namespace, js_name) + + +def _resource_js_path( + package_namespace: str, js_name: str +) -> ContextManager[pathlib.Path]: + """ + Get the path to a resource in a package. + + Args: + package_namespace: + The package namespace + js_name: + The resource name + """ + + if sys.version_info < (3, 9): + return importlib.resources.path(package_namespace, js_name) + else: + return importlib.resources.as_file( + importlib.resources.files(package_namespace).joinpath(js_name) + ) + + +def create_js_plugin( + package_namespace: str, js_name: str, plugin_class: abc.ABCMeta +) -> JsPlugin: + """ + Create a JsPlugin from an npm package.json file. + + Args: + package_namespace: + The package namespace + js_name: + The resource name + plugin_class: + The class to create. It must be a subclass of JsPlugin. + + Returns: + The created JsPlugin + """ + js_path = _resource_js_path_provider(package_namespace, js_name) + return _create_from_npm_package_json(js_path, plugin_class) diff --git a/tools/update_version.sh b/tools/update_version.sh index 3892a1873..9279484c5 100755 --- a/tools/update_version.sh +++ b/tools/update_version.sh @@ -139,6 +139,9 @@ case "$package" in update_file ui/src/js/package.json '"version": "' '",' update_file ui/src/deephaven/ui/__init__.py '__version__ = "' '"' "$extra" ;; + utilities) + update_file utilities/setup.cfg 'version = ' '' "$extra" + ;; *) { log_error "Unhandled plugin $package. You will need to add wiring in $SCRIPT_NAME"