Skip to content

Move the renderer build into the renderer dir #1685

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Jul 9, 2021
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ This project adheres to [Semantic Versioning](https://semver.org/).

### Changed
- [#1675](https://github.com/plotly/dash/pull/1675) Remove the constraint that `requests_pathname_prefix` ends with `routes_pathname_prefix`. When you are serving your app behind a reverse proxy that rewrites URLs that constraint needs to be violated.
- [#1611](https://github.com/plotly/dash/pull/1611) Package dash-renderer artifacts and dependencies with Dash, and source renderer resources from within Dash.
- [#1611](https://github.com/plotly/dash/pull/1611) and [#1685](https://github.com/plotly/dash/pull/1685) Package dash-renderer artifacts and dependencies with Dash, and source renderer resources from within Dash.
- [#1567](https://github.com/plotly/dash/pull/1567) Julia component generator puts components into `src/jl` - fixes an issue on case-insensitive filesystems when the component name and module name match (modulo case) and no prefix is used. Also reduces JS/Julia clutter in the overloaded `src` directory.

### Fixed
Expand Down
2 changes: 2 additions & 0 deletions MANIFEST.in
Original file line number Diff line number Diff line change
Expand Up @@ -5,3 +5,5 @@ include dash/favicon.ico
include dash/extract-meta.js
include dash/deps/*.js
include dash/deps/*.map
include dash/dash-renderer/build/*.js
include dash/dash-renderer/build/*.map
8 changes: 4 additions & 4 deletions dash/_dash_renderer.py
Original file line number Diff line number Diff line change
Expand Up @@ -37,15 +37,15 @@

_js_dist = [
{
"relative_package_path": "deps/dash_renderer.min.js",
"dev_package_path": "deps/dash_renderer.dev.js",
"relative_package_path": "dash-renderer/build/dash_renderer.min.js",
"dev_package_path": "dash-renderer/build/dash_renderer.dev.js",
"external_url": "https://unpkg.com/[email protected]"
"/dash_renderer/dash_renderer.min.js",
"namespace": "dash",
},
{
"relative_package_path": "deps/dash_renderer.min.js.map",
"dev_package_path": "deps/dash_renderer.dev.js.map",
"relative_package_path": "dash-renderer/build/dash_renderer.min.js.map",
"dev_package_path": "dash-renderer/build/dash_renderer.dev.js.map",
"namespace": "dash",
"dynamic": True,
},
Expand Down
10 changes: 5 additions & 5 deletions dash/dash-renderer/init.template
Original file line number Diff line number Diff line change
Expand Up @@ -37,15 +37,15 @@ _js_dist_dependencies = [

_js_dist = [
{
"relative_package_path": "deps/dash_renderer.min.js",
"dev_package_path": "deps/dash_renderer.dev.js",
"relative_package_path": "dash-renderer/build/dash_renderer.min.js",
"dev_package_path": "dash-renderer/build/dash_renderer.dev.js",
"external_url": "https://unpkg.com/dash-renderer@$version"
"/dash_renderer/dash_renderer.min.js",
"/build/dash_renderer.min.js",
"namespace": "dash",
},
{
"relative_package_path": "deps/dash_renderer.min.js.map",
"dev_package_path": "deps/dash_renderer.dev.js.map",
"relative_package_path": "dash-renderer/build/dash_renderer.min.js.map",
"dev_package_path": "dash-renderer/build/dash_renderer.dev.js.map",
"namespace": "dash",
"dynamic": True,
},
Expand Down
4 changes: 2 additions & 2 deletions dash/dash-renderer/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
"name": "dash-renderer",
"version": "1.9.1",
"description": "render dash components in react",
"main": "../deps/dash_renderer.min.js",
"main": "build/dash_renderer.min.js",
"scripts": {
"prepublishOnly": "rm -rf lib && babel src --extensions=\".ts,.tsx,.js,.jsx\" --out-dir lib --copy-files",
"private::format.eslint": "eslint --quiet --fix src tests",
Expand Down Expand Up @@ -85,7 +85,7 @@
"whatwg-fetch": "^3.6.2"
},
"files": [
"../deps/*{.js,.map}",
"build/*{.js,.map}",
"/lib/**"
],
"prettier": "@plotly/prettier-config-dash"
Expand Down
4 changes: 2 additions & 2 deletions dash/dash-renderer/webpack.base.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ const rendererOptions = {
main: ['whatwg-fetch', './src/index.js'],
},
output: {
path: path.resolve(__dirname, "..", "deps"),
path: path.resolve(__dirname, "build"),
filename: `${dashLibraryName}.dev.js`,
library: dashLibraryName,
libraryTarget: 'window',
Expand All @@ -64,7 +64,7 @@ module.exports = options => [
{
mode: 'production',
output: {
path: path.resolve(__dirname, "..", "deps"),
path: path.resolve(__dirname, "build"),
filename: `${dashLibraryName}.min.js`,
library: dashLibraryName,
libraryTarget: 'window',
Expand Down
45 changes: 24 additions & 21 deletions dash/development/build_process.py
Original file line number Diff line number Diff line change
Expand Up @@ -21,19 +21,20 @@ class BuildProcess(object):
def __init__(self, main, deps_info):
self.logger = logger
self.main = main
self.build_folder = self._concat(self.main, "build")
self.deps_info = deps_info
self.npm_modules = self._concat(self.main, "node_modules")
self.package_lock = self._concat(self.main, "package-lock.json")
self.package = self._concat(self.main, "package.json")
self._parse_package(path=self.package)
self.asset_paths = (self.build_folder, self.npm_modules)
self.asset_paths = (self.deps_folder, self.npm_modules)

def _parse_package(self, path):
with open(path, "r") as fp:
package = json.load(fp)
self.version = package["version"]
self.name = package["name"]
self.build_folder = self._concat(self.main, os.pardir, "deps")
self.deps_folder = self._concat(self.main, os.pardir, "deps")
self.deps = package["dependencies"]

@staticmethod
Expand Down Expand Up @@ -79,25 +80,27 @@ def build(self, build=None):

@job("compute the hash digest for assets")
def digest(self):
if not os.path.exists(self.build_folder):
if not os.path.exists(self.deps_folder):
try:
os.makedirs(self.build_folder)
os.makedirs(self.deps_folder)
except OSError:
logger.exception("🚨 having issues manipulating %s", self.build_folder)
logger.exception("🚨 having issues manipulating %s", self.deps_folder)
sys.exit(1)

copies = tuple(
_
for _ in os.listdir(self.build_folder)
if os.path.splitext(_)[-1] in {".js", ".map"}
)
logger.info("bundles in %s %s", self.build_folder, copies)

payload = {self.name: self.version}
for copy in copies:
payload["MD5 ({})".format(copy)] = compute_md5(
self._concat(self.build_folder, copy)

for folder in (self.deps_folder, self.build_folder):
copies = tuple(
_
for _ in os.listdir(folder)
if os.path.splitext(_)[-1] in {".js", ".map"}
)
logger.info("bundles in %s %s", folder, copies)

for copy in copies:
payload["MD5 ({})".format(copy)] = compute_md5(
self._concat(folder, copy)
)

with open(self._concat(self.main, "digest.json"), "w") as fp:
json.dump(payload, fp, sort_keys=True, indent=4, separators=(",", ":"))
Expand All @@ -108,11 +111,11 @@ def digest(self):

@job("copy and generate the bundles")
def bundles(self, build=None):
if not os.path.exists(self.build_folder):
if not os.path.exists(self.deps_folder):
try:
os.makedirs(self.build_folder)
os.makedirs(self.deps_folder)
except OSError:
logger.exception("🚨 having issues manipulating %s", self.build_folder)
logger.exception("🚨 having issues manipulating %s", self.deps_folder)
sys.exit(1)

self._parse_package(self.package_lock)
Expand All @@ -138,20 +141,20 @@ def bundles(self, build=None):

shutil.copyfile(
self._concat(self.npm_modules, scope, name, subfolder, filename),
self._concat(self.build_folder, target),
self._concat(self.deps_folder, target),
)

_script = "build:dev" if build == "local" else "build:js"
logger.info("run `npm run %s`", _script)
os.chdir(self._concat(self.build_folder, os.pardir, "dash-renderer"))
os.chdir(self.main)
run_command_with_process("npm run {}".format(_script))

logger.info("generate the `__init__.py` from template and versions")
with open(self._concat(self.main, "init.template")) as fp:
t = string.Template(fp.read())

with open(
self._concat(self.build_folder, os.pardir, "_dash_renderer.py"), "w"
self._concat(self.deps_folder, os.pardir, "_dash_renderer.py"), "w"
) as fp:
fp.write(t.safe_substitute(versions))

Expand Down