Skip to content
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

projector: Fix esbuild-bundled projector. #5944

Merged
merged 3 commits into from Sep 22, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
4 changes: 4 additions & 0 deletions .github/workflows/ci.yml
Expand Up @@ -325,6 +325,10 @@ jobs:
! git grep -E '"@npm_angular_bazel//:index.bzl"' 'tensorboard/**/BUILD'
- run: |
! git grep -E 'mat-color|$mat-' 'tensorboard/**/*.scss'
# Make sure no one depends on the numeric library directly. Please
# import the indirection in //tensorboard/webapp/third_party.
- run: |
! git grep -E '@npm//numeric' 'tensorboard/*/BUILD' ':!tensorboard/webapp/third_party/**'

lint-misc: # build, protos, etc.
runs-on: ubuntu-18.04
Expand Down
2 changes: 1 addition & 1 deletion tensorboard/plugins/projector/vz_projector/BUILD
Expand Up @@ -60,10 +60,10 @@ tf_ts_library(
"//tensorboard/components/polymer:register_style_dom_module",
"//tensorboard/components/tf_wbr_string",
"//tensorboard/webapp/third_party:d3",
"//tensorboard/webapp/third_party:numeric",
"//tensorboard/webapp/third_party:tfjs",
"@npm//@polymer/decorators",
"@npm//@polymer/polymer",
"@npm//numeric",
"@npm//three",
"@npm//umap-js",
],
Expand Down
2 changes: 1 addition & 1 deletion tensorboard/plugins/projector/vz_projector/data.ts
Expand Up @@ -12,8 +12,8 @@ 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.
==============================================================================*/
import numeric from 'numeric';
import {UMAP} from 'umap-js';
import {numeric} from '../../../webapp/third_party/numeric';
import {TSNE} from './bh_tsne';
import {SpriteMetadata} from './data-provider';
import * as knn from './knn';
Expand Down
9 changes: 9 additions & 0 deletions tensorboard/webapp/third_party/BUILD
Expand Up @@ -31,3 +31,12 @@ tf_ts_library(
"@npm//marked",
],
)

tf_ts_library(
name = "numeric",
srcs = ["numeric.ts"],
strict_checks = False,
deps = [
"@npm//numeric",
],
)
32 changes: 32 additions & 0 deletions tensorboard/webapp/third_party/numeric.ts
@@ -0,0 +1,32 @@
/* Copyright 2022 The TensorFlow Authors. All Rights Reserved.

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.
==============================================================================*/
import numeric from 'numeric';

// The numeric library requires that the symbol 'numeric' is available in the
// global scope when its operations are executed by other modules. See, for
// example, how the definition of some of its operations refer to the string
// 'numeric' in the Function definition, unmodifiable by the
// bundler/minification code:
//
// https://github.com/sloisel/numeric/blob/656fa1254be540f428710738ca9c1539625777f1/src/numeric.js#L696
//
// The esbuild bundler does not keep 'numeric' in global scope and instead
// renames it as part of bundling/minification. We work around this by manually
// adding it to global scope here.
window['numeric'] = window['numeric'] ?? numeric;
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This makes sense as a fix given the circumstance but it's still pretty gross. Looking at the situation though I'm not really sure how it was working before.
It seems like the numeric library hasn't been updated since 2012 so at some point (clearly not a priority) it would be nice to move away from it.


// Reexport the numeric library. All imports of numeric should be done through
// this file to ensure 'numeric' is available in the global scope.
export {numeric};