Update server references to point to new @xviz/server and add deprecation notice to old script (#473)

Author: twojtasz

README.md

@@ -13,15 +13,16 @@ This repo contains the following submodules:
 
 - `@xviz/builder` - Node.js utilities for converting data to the XVIZ protocol.
 - `@xviz/cli` - CLI utilities for the XVIZ protocol.
+- `@xviz/io` - Library for loading, accessing, and manipiulating XVIZ data.
 - `@xviz/parser` - Client-side decoder and synchronizer for consuming XVIZ data.
 - `@xviz/schema` - Validation and schemas for the XVIZ protocol.
+- `@xviz/server` - A complete server module supporting the full XVIZ protocol.
 
 And examples:
 
 - Sample converters that convert open datasets such as
   [KITTI](http://www.cvlibs.net/datasets/kitti/raw_data.php) and [Nutonomy](https://nuscenes.org) to
   the XVIZ protocol.
-- A minimal Node.js-based XVIZ stream server.
 
 ## Quick start
 

docs/getting-started/README.md

@@ -29,6 +29,6 @@ relationships.
 This tutorial will also cover some optional data generation to showcase some XVIZ features that are
 not currently present in the KITTI data but are supported by XVIZ and streetscape.gl
 
-Once the XVIZ data has been generated we will cover how to server up the XVIZ data using our simple
-[XVIZ Server](/docs/getting-started/xviz-server.md) and view it using the example
-[XVIZ Viewer](/docs/example-guide/xviz-viewer.md) web application.
+Once the XVIZ data has been generated we will cover how to server up the XVIZ data using our
+[XVIZ Server](/docs/getting-started/xviz-server.md) and view it using the
+[streetscape.gl starter kit](https://github.com/uber/streetscape.gl/blob/master/docs/get-started/starter-kit.md).

docs/getting-started/running-the-example.md

@@ -54,14 +54,22 @@ $ yarn start -d 2011_09_26/2011_09_26_drive_0005_sync --image-max-width=300 --di
 Run the [example XVIZ server](/docs/getting-started/xviz-server.md) to serve your converted data:
 
 ```
-$ cd examples/server
-$ yarn  # install dependencies
-$ yarn start -d kitti/2011_09_26/2011_09_26_drive_0005_sync
+$ yarn bootstrap # Install deps and build modules
+$ ./modules/server/bin/babel-xvizserver -d data/generated/kitti/2011_09_26/2011_09_26_drive_0005_sync --port 8081
 ```
 
-To see a full list of options of the stream server, run `yarn start --help`.
+To see a full list of options of the stream server, run
+`./modules/server/bin/babel-xvizserver --help`.
 
 # Start Client Application
 
 See
-[streetscape.gl starter kit](https://github.com/uber/streetscape.gl/blob/master/docs/get-started/starter-kit.md).
+[streetscape.gl starter kit](https://github.com/uber/streetscape.gl/blob/master/docs/get-started/starter-kit.md)
+to get the web application setup.
+
+Once you have finished the setup the only change to run against the local server you started above
+is the following:
+
+```
+streetscape.gl/examples/get-started$ yarn start-streaming-local
+```

docs/getting-started/xviz-server.md

@@ -6,24 +6,22 @@ This simple XVIZ Server will read XVIZ index and data files produced from the
 [XVIZBuilder](/docs/api-reference/xviz-builder.md) and server them over a web socket. The server
 supports the basic [XVIZ Session](/docs/protocol-schema/session-protocol.md).
 
-A more capable server is planned in our [Roadmap](/docs/overview/roadmap.md).
-
 ## Quick Start
 
-Change to the server directory
+Run our bootstrap to install dependencies and build the modules if you have not already
 
 ```
-$ cd ./examples/server
+$ yarn bootstrap
 ```
 
-Install dependencies
+Change to the @xviz/server module directory
 
 ```
-$ yarn
+$ cd ./modules/server
 ```
 
 Launch the server point it at your XVIZ data folder
 
 ```
-$ node index.js -d <XVIZ data folder>
+$ ./bin/xvizserver -d <XVIZ data folder> --port 8081
 ```

examples/server/xviz-serve-data.js

@@ -698,8 +698,13 @@ function packFrame({json, isBinary}) {
 }
 
 // Main
-/* eslint-disable complexity */
+/* eslint-disable complexity, max-statements */
 module.exports = function main(args) {
+  console.warn('!!!');
+  console.warn(
+    '!!! NOTE: This script has been deprecated and will eventually be removed. Please switch to the @xviz/server module and scripts as a replacement'
+  );
+  console.warn('!!!');
   const runScenario = args.scenario.length > 0;
 
   // Until scenarios generate data in a way that is compatible with

scripts/run-kitti-example.sh

@@ -66,7 +66,7 @@ if [ "$force_xviz_conversion" = "true" ] || ([ ! -f "${OUTPUT_DIR}/1-frame.json"
 fi
 
 # Start server & web app
-cd "${SCRIPT_DIR}/../examples/server" && node ./index.js  -d "${OUTPUT_DIR}" &
+cd "${SCRIPT_DIR}/../modules/server" && ./bin/xvizserver -d "${OUTPUT_DIR}" --port 8081 &
 pids[1]=$!
 
 echo "##"