Refactor packages and rename @opencensus/web-all to @opencensus/web-scripts (#148)

Author: crdgonzalezca

CHANGELOG.md

@@ -4,6 +4,15 @@ All notable changes to this project will be documented in this file.
 
 ## Unreleased
 
+- Rename `@opencensus/web-all` to `@opencensus/web-scripts` so now this package 
+    is only in charge of bundling OC Web to allow importing it as <script> tag.
+
+- To use OC Web as an npm dependency, there are several options: `@opencensus/web-initial-load`
+    to instrument with only the initial page load module, `@opencensus/web-instrumentation-zone`
+    to instrument it with all the OC Web functionality plus the `Zone.js` library and 
+    `@opencensus/web-instrumentation-zone-peer-dep` also exports all the functionality but `Zone.js`
+    is a peer dependency.
+
 ## 0.0.3 - 2019-06-08
 
 - Support custom end time for span (#95), thanks @skjindal93

README.md

@@ -87,7 +87,7 @@ The script tag should go before the `</body>`. You will also need to set the
 trace sample rate via an `ocSampleRate` global variable as well.
 ```html
 ...
-  <script src="https://unpkg.com/@opencensus/web-all@0.0.2/dist/initial-load-all.js"
+  <script src="https://unpkg.com/@opencensus/web-scripts@0.0.3/dist/initial-load-all.js"
           integrity="sha384-VPY9XX7tiXeLekDPFXkfO2AqNpLTCNOzfXxVghzoVP05PXrG+wtHOW2kOP2ggO9o"
           async crossorigin="anonymous">
   </script>
@@ -105,16 +105,16 @@ trace sample rate via an `ocSampleRate` global variable as well.
 
 You can also host the `initial-load-all.js` bundle from your own site. For
 docs on how to build the bundle see the
-[@opencensus/web-all readme][package-web-all].
+[@opencensus/web-scripts readme][package-web-scripts].
 
 #### Using as NPM dependency in existing JS build
 
 If you already have a JS build pipeline using e.g. webpack or similar, you can 
-do `npm install @opencensus/web-all`, and then set the configuration variables
+do `npm install @opencensus/web-initial-load`, and then set the configuration variables
 and trigger the recording and exporting of the initial load spans as follows:
 
 ```js
-import { exportRootSpanAfterLoadEvent } from '@opencensus/web-all';
+import { exportRootSpanAfterLoadEvent } from '@opencensus/web-initial-load';
 
 window.ocAgent = 'https://example.com/my-opencensus-agent-endpoint';
 window.ocSampleRate = 1.0; // Sample at 100% for test only. Default is 1/10000.
@@ -139,7 +139,7 @@ variable. The `traceparent` variable should be in the
 
 ```html
   ...
-  <script src="https://unpkg.com/@opencensus/web-all@0.0.2/dist/initial-load-all.js"
+  <script src="https://unpkg.com/@opencensus/web-scripts@0.0.3/dist/initial-load-all.js"
           integrity="sha384-VPY9XX7tiXeLekDPFXkfO2AqNpLTCNOzfXxVghzoVP05PXrG+wtHOW2kOP2ggO9o"
           async crossorigin="anonymous">
   </script>
@@ -174,7 +174,7 @@ The OpenCensus web library is composed of the following packages:
 - **[@opencensus/web-propagation-tracecontext][package-web-propagation-tracecontext]**. This provides utilities to serialize and deserialize a `traceparent` trace context header in the [W3C draft trace context format][trace-context-url]
 - **[@opencensus/web-initial-load][package-web-initial-load]**. This package is in charge of generating the initial load page trace, plus the corresponding sampling decision for OpenCensus Web and 
 storing a global initial load span context to be used by other packages. 
-- **[@opencensus/web-all][package-web-all]**. This depends on all the other OpenCensus Web libraries and provides top-level functions for instrumenting the initial page load and exporting its spans to the OpenCensus Agent. It also provides WebPack builds for JS bundles that can be used in `<script>` tags.
+- **[@opencensus/web-scripts][package-web-scripts]**. This depends on all the other OpenCensus Web libraries and provides top-level functions for instrumenting the initial page load and exporting its spans to the OpenCensus Agent. It also provides WebPack builds for JS bundles that can be used in `<script>` tags.
 
 ## Useful links
 - For more information on OpenCensus, visit: <https://opencensus.io/>
@@ -224,7 +224,7 @@ Apache 2.0 - See [LICENSE][license-url] for more information.
 [opencensus-node-url]: https://github.com/census-instrumentation/opencensus-node
 [opencensus-service-url]: https://github.com/census-instrumentation/opencensus-service
 [package-core]: https://github.com/census-instrumentation/opencensus-node/tree/master/packages/opencensus-core
-[package-web-all]: https://github.com/census-instrumentation/opencensus-web/tree/master/packages/opencensus-web-all
+[package-web-scripts]: https://github.com/census-instrumentation/opencensus-web/tree/master/packages/opencensus-web-scripts
 [package-web-core]: https://github.com/census-instrumentation/opencensus-web/tree/master/packages/opencensus-web-core
 [package-web-exporter-ocagent]: https://github.com/census-instrumentation/opencensus-web/tree/master/packages/opencensus-web-exporter-ocagent
 [package-web-initial-load]: https://github.com/census-instrumentation/opencensus-web/tree/master/packages/opencensus-web-initial-load

examples/initial_load/README.md

@@ -38,10 +38,10 @@ go run github.com/census-instrumentation/opencensus-service/cmd/ocagent
 ### Step 2: Run the local webpack server
 
 Then within your `opencensus-web` folder run the local webpack server for the
-`opencensus-all` package to serve the OpenCensus web scripts:
+`opencensus-scripts` package to serve the OpenCensus web scripts:
 
 ```bash
-cd packages/opencensus-web-all
+cd packages/opencensus-web-scripts
 npm run start:webpack-server
 ```
 
@@ -111,9 +111,9 @@ First build the OpenCensus Web scripts that will be deployed with the
 application:
 
 ```bash
-npm run build:prod --prefix=../../packages/opencensus-web-all
+npm run build:prod --prefix=../../packages/opencensus-web-scripts
 mkdir -p static
-cp ../../packages/opencensus-web-all/dist/*.js ./static
+cp ../../packages/opencensus-web-scripts/dist/*.js ./static
 ```
 Then build the server container and push it to GCR:
 

examples/user_interaction/client/package-lock.json

@@ -12,7 +12,6 @@
     "metrics"
   ],
   "dependencies": {
-    "@opencensus/web-all": "^0.0.3",
     "@opencensus/web-instrumentation-zone": "^0.0.3",
     "react": "^16.8.6",
     "react-dom": "^16.8.6",

examples/user_interaction/client/package.json

@@ -15,7 +15,7 @@
  */
 
 import React from 'react';
-import { tracing } from '@opencensus/web-core';
+import { tracing } from '@opencensus/web-instrumentation-zone';
 
 class App extends React.Component {
 

examples/user_interaction/client/src/App.js

@@ -18,8 +18,7 @@ import React from 'react';
 import ReactDOM from 'react-dom';
 import App from './App';
 import SecondPage from './SecondPage';
-import { exportRootSpanAfterLoadEvent } from '@opencensus/web-all';
-import { startInteractionTracker } from '@opencensus/web-instrumentation-zone';
+import { startTracing } from '@opencensus/web-instrumentation-zone';
 
 import { Route, BrowserRouter as Router, Link } from 'react-router-dom'
 
@@ -47,8 +46,4 @@ window.ocAgent = 'http://localhost:55678';
 window.ocTraceHeaderHostRegex = /.*/;
 window.ocSampleRate = 1.0; // Sample at 100% for test only. Default is 1/10000.
 
-// Send the root span and child spans for the initial page load to the
-// OpenCensus agent if this request was sampled for trace.
-exportRootSpanAfterLoadEvent();
-
-startInteractionTracker();
+startTracing();