mirror of
https://github.com/ynput/ayon-core.git
synced 2025-12-24 12:54:40 +01:00
removed server addon
This commit is contained in:
Jakub Trllo
parent
b69085f65d
commit
54b73e2ad4
2 changed files with 0 additions and 410 deletions
|
|
@ -1,34 +0,0 @@
|
|||
# Addons for AYON server
|
||||
Preparation of AYON addons based on OpenPype codebase. The output is a bunch of zip files in `./packages` directory that can be uploaded to AYON server. One of the packages is `openpype` which is OpenPype code converted to AYON addon. The addon is must have requirement to be able to use `ayon-launcher`. The versioning of `openpype` addon is following versioning of OpenPype. The other addons contain only settings models.
|
||||
|
||||
## Intro
|
||||
OpenPype is transitioning to AYON, a dedicated server with its own database, moving away from MongoDB. During this transition period, OpenPype will remain compatible with both MongoDB and AYON. However, we will gradually update the codebase to align with AYON's data structure and separate individual components into addons.
|
||||
|
||||
Currently, OpenPype has an AYON mode, which means it utilizes the AYON server instead of MongoDB through conversion utilities. Initially, we added the AYON executable alongside the OpenPype executables to enable AYON mode. While this approach worked, updating to new code versions would require a complete reinstallation. To address this, we have decided to create a new repository specifically for the base desktop application logic, which we currently refer to as the AYON Launcher. This Launcher will replace the executables generated by the OpenPype build and convert the OpenPype code into a server addon, resulting in smaller updates.
|
||||
|
||||
Since the implementation of the AYON Launcher is not yet fully completed, we will maintain both methods of starting AYON mode for now. Once the AYON Launcher is finished, we will remove the AYON executables from the OpenPype codebase entirely.
|
||||
|
||||
During this transitional period, the AYON Launcher addon will be a requirement as the entry point for using the AYON Launcher.
|
||||
|
||||
## How to start
|
||||
There is a `create_ayon_addons.py` python file which contains logic how to create server addon from OpenPype codebase. Just run the code.
|
||||
```shell
|
||||
./.poetry/bin/poetry run python ./server_addon/create_ayon_addons.py
|
||||
```
|
||||
|
||||
It will create directory `./packages/<addon name>.zip` files for AYON server. You can then copy upload the zip files to AYON server. Restart server to update addons information, add the addon version to server bundle and set the bundle for production or staging usage.
|
||||
|
||||
Once addon is on server and is enabled, you can just run AYON launcher. Content will be downloaded and used automatically.
|
||||
|
||||
### Additional arguments
|
||||
Additional arguments are useful for development purposes.
|
||||
|
||||
To skip zip creation to keep only server ready folder structure, pass `--skip-zip` argument.
|
||||
```shell
|
||||
./.poetry/bin/poetry run python ./server_addon/create_ayon_addons.py --skip-zip
|
||||
```
|
||||
|
||||
To create both zips and keep folder structure, pass `--keep-sources` argument.
|
||||
```shell
|
||||
./.poetry/bin/poetry run python ./server_addon/create_ayon_addons.py --keep-sources
|
||||
```
|
||||
|
|
@ -1,376 +0,0 @@
|
|||
import io
|
||||
import os
|
||||
import sys
|
||||
import re
|
||||
import shutil
|
||||
import argparse
|
||||
import zipfile
|
||||
import types
|
||||
import importlib.machinery
|
||||
import platform
|
||||
import collections
|
||||
from pathlib import Path
|
||||
from typing import Optional, Iterable, Pattern, List, Tuple
|
||||
|
||||
# Patterns of directories to be skipped for server part of addon
|
||||
IGNORE_DIR_PATTERNS: List[Pattern] = [
|
||||
re.compile(pattern)
|
||||
for pattern in {
|
||||
# Skip directories starting with '.'
|
||||
r"^\.",
|
||||
# Skip any pycache folders
|
||||
"^__pycache__$"
|
||||
}
|
||||
]
|
||||
|
||||
# Patterns of files to be skipped for server part of addon
|
||||
IGNORE_FILE_PATTERNS: List[Pattern] = [
|
||||
re.compile(pattern)
|
||||
for pattern in {
|
||||
# Skip files starting with '.'
|
||||
# NOTE this could be an issue in some cases
|
||||
r"^\.",
|
||||
# Skip '.pyc' files
|
||||
r"\.pyc$"
|
||||
}
|
||||
]
|
||||
|
||||
IGNORED_HOSTS = [
|
||||
"flame",
|
||||
"harmony",
|
||||
]
|
||||
|
||||
IGNORED_MODULES = []
|
||||
|
||||
PACKAGE_PY_TEMPLATE = """name = "{addon_name}"
|
||||
version = "{addon_version}"
|
||||
plugin_for = ["ayon_server"]
|
||||
"""
|
||||
|
||||
CLIENT_VERSION_CONTENT = '''# -*- coding: utf-8 -*-
|
||||
"""Package declaring AYON addon '{}' version."""
|
||||
__version__ = "{}"
|
||||
'''
|
||||
|
||||
|
||||
class ZipFileLongPaths(zipfile.ZipFile):
|
||||
"""Allows longer paths in zip files.
|
||||
|
||||
Regular DOS paths are limited to MAX_PATH (260) characters, including
|
||||
the string's terminating NUL character.
|
||||
That limit can be exceeded by using an extended-length path that
|
||||
starts with the '\\?\' prefix.
|
||||
"""
|
||||
_is_windows = platform.system().lower() == "windows"
|
||||
|
||||
def _extract_member(self, member, tpath, pwd):
|
||||
if self._is_windows:
|
||||
tpath = os.path.abspath(tpath)
|
||||
if tpath.startswith("\\\\"):
|
||||
tpath = "\\\\?\\UNC\\" + tpath[2:]
|
||||
else:
|
||||
tpath = "\\\\?\\" + tpath
|
||||
|
||||
return super()._extract_member(member, tpath, pwd)
|
||||
|
||||
|
||||
def _value_match_regexes(value: str, regexes: Iterable[Pattern]) -> bool:
|
||||
return any(
|
||||
regex.search(value)
|
||||
for regex in regexes
|
||||
)
|
||||
|
||||
|
||||
def find_files_in_subdir(
|
||||
src_path: str,
|
||||
ignore_file_patterns: Optional[List[Pattern]] = None,
|
||||
ignore_dir_patterns: Optional[List[Pattern]] = None,
|
||||
include_empty_dirs: bool = True
|
||||
):
|
||||
"""Find all files to copy in subdirectories of given path.
|
||||
|
||||
All files that match any of the patterns in 'ignore_file_patterns' will
|
||||
be skipped and any directories that match any of the patterns in
|
||||
'ignore_dir_patterns' will be skipped with all subfiles.
|
||||
|
||||
Args:
|
||||
src_path (str): Path to directory to search in.
|
||||
ignore_file_patterns (Optional[List[Pattern]]): List of regexes
|
||||
to match files to ignore.
|
||||
ignore_dir_patterns (Optional[List[Pattern]]): List of regexes
|
||||
to match directories to ignore.
|
||||
include_empty_dirs (Optional[bool]): Do not skip empty directories.
|
||||
|
||||
Returns:
|
||||
List[Tuple[str, str]]: List of tuples with path to file and parent
|
||||
directories relative to 'src_path'.
|
||||
"""
|
||||
if not os.path.exists(src_path):
|
||||
return []
|
||||
|
||||
if ignore_file_patterns is None:
|
||||
ignore_file_patterns = IGNORE_FILE_PATTERNS
|
||||
|
||||
if ignore_dir_patterns is None:
|
||||
ignore_dir_patterns = IGNORE_DIR_PATTERNS
|
||||
output: List[Tuple[str, str]] = []
|
||||
|
||||
hierarchy_queue = collections.deque()
|
||||
hierarchy_queue.append((src_path, []))
|
||||
while hierarchy_queue:
|
||||
item: Tuple[str, List[str]] = hierarchy_queue.popleft()
|
||||
dirpath, parents = item
|
||||
subnames = list(os.listdir(dirpath))
|
||||
if not subnames and include_empty_dirs:
|
||||
output.append((dirpath, os.path.sep.join(parents)))
|
||||
|
||||
for name in subnames:
|
||||
path = os.path.join(dirpath, name)
|
||||
if os.path.isfile(path):
|
||||
if not _value_match_regexes(name, ignore_file_patterns):
|
||||
items = list(parents)
|
||||
items.append(name)
|
||||
output.append((path, os.path.sep.join(items)))
|
||||
continue
|
||||
|
||||
if not _value_match_regexes(name, ignore_dir_patterns):
|
||||
items = list(parents)
|
||||
items.append(name)
|
||||
hierarchy_queue.append((path, items))
|
||||
|
||||
return output
|
||||
|
||||
|
||||
def create_addon_zip(
|
||||
output_dir: Path,
|
||||
addon_name: str,
|
||||
addon_version: str,
|
||||
files_mapping: List[Tuple[str, str]],
|
||||
client_zip_content: io.BytesIO
|
||||
):
|
||||
zip_filepath = output_dir / f"{addon_name}-{addon_version}.zip"
|
||||
|
||||
with ZipFileLongPaths(zip_filepath, "w", zipfile.ZIP_DEFLATED) as zipf:
|
||||
for src_path, dst_subpath in files_mapping:
|
||||
zipf.write(src_path, dst_subpath)
|
||||
|
||||
if client_zip_content is not None:
|
||||
zipf.writestr("private/client.zip", client_zip_content.getvalue())
|
||||
|
||||
|
||||
def prepare_client_zip(
|
||||
addon_dir: Path,
|
||||
addon_name: str,
|
||||
addon_version: str,
|
||||
client_dir: str
|
||||
):
|
||||
if not client_dir:
|
||||
return None
|
||||
client_dir_obj = addon_dir / "client" / client_dir
|
||||
if not client_dir_obj.exists():
|
||||
return None
|
||||
|
||||
# Update version.py with server version if 'version.py' is available
|
||||
version_path = client_dir_obj / "version.py"
|
||||
if version_path.exists():
|
||||
with open(version_path, "w") as stream:
|
||||
stream.write(
|
||||
CLIENT_VERSION_CONTENT.format(addon_name, addon_version)
|
||||
)
|
||||
|
||||
zip_content = io.BytesIO()
|
||||
with ZipFileLongPaths(zip_content, "a", zipfile.ZIP_DEFLATED) as zipf:
|
||||
# Add client code content to zip
|
||||
for path, sub_path in find_files_in_subdir(
|
||||
str(client_dir_obj), include_empty_dirs=False
|
||||
):
|
||||
sub_path = os.path.join(client_dir, sub_path)
|
||||
zipf.write(path, sub_path)
|
||||
|
||||
zip_content.seek(0)
|
||||
return zip_content
|
||||
|
||||
|
||||
def import_filepath(path: Path, module_name: Optional[str] = None):
|
||||
if not module_name:
|
||||
module_name = os.path.splitext(path.name)[0]
|
||||
|
||||
# Convert to string
|
||||
path = str(path)
|
||||
module = types.ModuleType(module_name)
|
||||
module.__file__ = path
|
||||
|
||||
# Use loader so module has full specs
|
||||
module_loader = importlib.machinery.SourceFileLoader(
|
||||
module_name, path
|
||||
)
|
||||
module_loader.exec_module(module)
|
||||
return module
|
||||
|
||||
|
||||
def _get_server_mapping(
|
||||
addon_dir: Path, addon_version: str
|
||||
) -> List[Tuple[str, str]]:
|
||||
server_dir = addon_dir / "server"
|
||||
public_dir = addon_dir / "public"
|
||||
src_package_py = addon_dir / "package.py"
|
||||
pyproject_toml = addon_dir / "client" / "pyproject.toml"
|
||||
|
||||
mapping: List[Tuple[str, str]] = [
|
||||
(src_path, f"server/{sub_path}")
|
||||
for src_path, sub_path in find_files_in_subdir(str(server_dir))
|
||||
]
|
||||
mapping.extend([
|
||||
(src_path, f"public/{sub_path}")
|
||||
for src_path, sub_path in find_files_in_subdir(str(public_dir))
|
||||
])
|
||||
mapping.append((src_package_py.as_posix(), "package.py"))
|
||||
if pyproject_toml.exists():
|
||||
mapping.append((pyproject_toml.as_posix(), "private/pyproject.toml"))
|
||||
|
||||
return mapping
|
||||
|
||||
|
||||
def create_addon_package(
|
||||
addon_dir: Path,
|
||||
output_dir: Path,
|
||||
create_zip: bool,
|
||||
):
|
||||
src_package_py = addon_dir / "package.py"
|
||||
|
||||
package = import_filepath(src_package_py)
|
||||
addon_name = package.name
|
||||
addon_version = package.version
|
||||
|
||||
files_mapping = _get_server_mapping(addon_dir, addon_version)
|
||||
|
||||
client_dir = getattr(package, "client_dir", None)
|
||||
client_zip_content = prepare_client_zip(
|
||||
addon_dir, addon_name, addon_version, client_dir
|
||||
)
|
||||
|
||||
if create_zip:
|
||||
create_addon_zip(
|
||||
output_dir,
|
||||
addon_name,
|
||||
addon_version,
|
||||
files_mapping,
|
||||
client_zip_content
|
||||
)
|
||||
|
||||
else:
|
||||
addon_output_dir = output_dir / addon_dir.name / addon_version
|
||||
if addon_output_dir.exists():
|
||||
shutil.rmtree(str(addon_output_dir))
|
||||
|
||||
addon_output_dir.mkdir(parents=True, exist_ok=True)
|
||||
|
||||
for src_path, dst_subpath in files_mapping:
|
||||
dst_path = addon_output_dir / dst_subpath
|
||||
dst_path.parent.mkdir(parents=True, exist_ok=True)
|
||||
shutil.copy2(src_path, dst_path)
|
||||
|
||||
if client_zip_content is not None:
|
||||
private_dir = addon_output_dir / "private"
|
||||
private_dir.mkdir(parents=True, exist_ok=True)
|
||||
with open(private_dir / "client.zip", "wb") as stream:
|
||||
stream.write(client_zip_content.read())
|
||||
|
||||
|
||||
def main(
|
||||
output_dir=None,
|
||||
skip_zip=True,
|
||||
clear_output_dir=False,
|
||||
addons=None,
|
||||
):
|
||||
current_dir = Path(os.path.dirname(os.path.abspath(__file__)))
|
||||
create_zip = not skip_zip
|
||||
|
||||
if output_dir:
|
||||
output_dir = Path(output_dir)
|
||||
else:
|
||||
output_dir = current_dir / "packages"
|
||||
|
||||
if output_dir.exists() and clear_output_dir:
|
||||
shutil.rmtree(str(output_dir))
|
||||
|
||||
print("Package creation started...")
|
||||
print(f"Output directory: {output_dir}")
|
||||
|
||||
# Make sure output dir is created
|
||||
output_dir.mkdir(parents=True, exist_ok=True)
|
||||
ignored_addons = set(IGNORED_HOSTS) | set(IGNORED_MODULES)
|
||||
for addon_dir in current_dir.iterdir():
|
||||
if not addon_dir.is_dir():
|
||||
continue
|
||||
|
||||
if addons and addon_dir.name not in addons:
|
||||
continue
|
||||
|
||||
if addon_dir.name in ignored_addons:
|
||||
continue
|
||||
|
||||
server_dir = addon_dir / "server"
|
||||
if not server_dir.exists():
|
||||
continue
|
||||
|
||||
create_addon_package(addon_dir, output_dir, create_zip)
|
||||
|
||||
print(f"- package '{addon_dir.name}' created")
|
||||
print(f"Package creation finished. Output directory: {output_dir}")
|
||||
|
||||
|
||||
if __name__ == "__main__":
|
||||
parser = argparse.ArgumentParser()
|
||||
parser.add_argument(
|
||||
"--skip-zip",
|
||||
dest="skip_zip",
|
||||
action="store_true",
|
||||
help=(
|
||||
"Skip zipping server package and create only"
|
||||
" server folder structure."
|
||||
)
|
||||
)
|
||||
parser.add_argument(
|
||||
"--keep-sources",
|
||||
dest="keep_sources",
|
||||
action="store_true",
|
||||
help=(
|
||||
"Keep folder structure when server package is created."
|
||||
)
|
||||
)
|
||||
parser.add_argument(
|
||||
"-o", "--output",
|
||||
dest="output_dir",
|
||||
default=None,
|
||||
help=(
|
||||
"Directory path where package will be created"
|
||||
" (Will be purged if already exists!)"
|
||||
)
|
||||
)
|
||||
parser.add_argument(
|
||||
"-c", "--clear-output-dir",
|
||||
dest="clear_output_dir",
|
||||
action="store_true",
|
||||
help=(
|
||||
"Clear output directory before package creation."
|
||||
)
|
||||
)
|
||||
parser.add_argument(
|
||||
"-a",
|
||||
"--addon",
|
||||
dest="addons",
|
||||
action="append",
|
||||
help="Limit addon creation to given addon name",
|
||||
)
|
||||
|
||||
args = parser.parse_args(sys.argv[1:])
|
||||
if args.keep_sources:
|
||||
print("Keeping sources is not supported anymore!")
|
||||
|
||||
main(
|
||||
args.output_dir,
|
||||
args.skip_zip,
|
||||
args.clear_output_dir,
|
||||
args.addons,
|
||||
)
|
||||
Loading…
Add table
Add a link
Reference in a new issue