(1.0.1) Update docs, add links to crates.io, set_as_global_default_with_config returns a Result (#13)

dsgallups · web-flow · commit 8e20e550b828 · 2024-12-17T22:40:13.000-05:00
* chore: add documentation key

* chore: add license copies in root

* refactor:  no longer panics

* chore: update docs

* chore: update changelog, version
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,35 @@
+# 1.0.1 (December 17, 2024)
+
+### Added
+- Update docs, doc links
+- Add licenses to crate root
+- `wasm_tracing::set_as_global_default_with_config` should not panic by default
+
+# 1.0.0 (December 17, 2024)
+## Notes
+
+Thank y'all for bearing with me! I have not been able to find a satisfactory test reference, so I've gone ahead and manually checked different logging configuration options. More importantly, I think this crate's recording implementation is flawed from the ground up. Without overhauling literally every original aspect of `tracing-wasm`, I have opted to find a middle route. Suggestions are highly appreciated!
+
+## Features
+- Added `WasmLayerConfig::show_origin`. When disabled, this will remove the line numbers from the console.
+
+## Breaking Changes
+### WasmLayerConfig
+- `WASMLayerConfigBuilder` has been removed.
+  - This builder performed 1:1 logic on `WasmLayerConfig`, and was not useful. The values for `WasmLayerConfig` are now public.
+- `WasmLayerConfig` now takes in a `ConsoleConfig` parameter. This replaces `WasmLayerConfig::report_logs_in_console` and `WasmLayerConfig::use_console_color`.
+This removes the capability to use a console color while the console is disabled. If there is a use case for this, please let me know.
+
+## Deprecations
+- `WASMLayerConfig` has been semantically renamed to `WasmLayerConfig`. A type alias has been marked as deprecated.
+- `WASMLayer` has been semantically renamed to `WasmLayer`. A type alias has been marked as deprecated.
+
+## Niceties
+- Added more documentation to the crate
+- Added a single `wasm_bindgen_test` to visibly check different `WasmLayerConfig` options. This is far from ideal. I plan on expanding functionality of this crate to modify the default global recorder in the future.
+
+**Full Changelog**: https://github.com/dsgallups/wasm-tracing/compare/0.2.0...1.0.0
+
 # 0.2.0 (September 4, 2024)
 
 ### Added
diff --git a/Cargo.lock b/Cargo.lock
diff --git a/Cargo.toml b/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "wasm-tracing"
-version = "1.0.0"
+version = "1.0.1"
 authors = ["Daniel Gallups <dsgallups@protonmail.com>"]
 edition = "2021"
 categories = [
@@ -9,6 +9,7 @@ categories = [
     "no-std",
     "wasm",
 ]
+documentation = "https://docs.rs/wasm_tracing"
 description = "Tracing subscriber for WebAssembly. Maintained fork of tracing-wasm."
 keywords = ["logging", "metrics", "wasm", "spans", "tracing"]
 license = "MIT OR Apache-2.0"
diff --git a/LICENSE-APACHE b/LICENSE-APACHE
@@ -0,0 +1,176 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
diff --git a/LICENSE-MIT b/LICENSE-MIT
@@ -0,0 +1,19 @@
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
diff --git a/src/config/console.rs b/src/config/console.rs
@@ -10,6 +10,7 @@ pub enum ConsoleConfig {
 }
 
 impl ConsoleConfig {
+    /// True if the console reporting spans
     pub fn reporting_enabled(&self) -> bool {
         !matches!(self, ConsoleConfig::NoReporting)
     }
diff --git a/src/config/mod.rs b/src/config/mod.rs
@@ -5,12 +5,12 @@ pub use console::*;
 #[deprecated(since = "1.0.0", note = "Rename WASMLayerConfig to WasmLayerConfig.")]
 pub type WASMLayerConfig = WasmLayerConfig;
 
-#[doc = r#"
-Configuration parameters for the [WasmLayer](crate::prelude::WasmLayer).
-"#]
+///Configuration parameters for the [WasmLayer](crate::prelude::WasmLayer).
 #[derive(Debug, PartialEq, Eq, Clone, Copy)]
 pub struct WasmLayerConfig {
+    /// In dev-tools, report timings of traces
     pub report_logs_in_timings: bool,
+    /// See [ConsoleConfig]
     pub console: ConsoleConfig,
     /// Maximum log level
     pub max_level: tracing::Level,
@@ -33,6 +33,7 @@ impl Default for WasmLayerConfig {
 }
 
 impl WasmLayerConfig {
+    /// Create a default [WasmLayerConfig]
     pub fn new() -> WasmLayerConfig {
         WasmLayerConfig::default()
     }
@@ -66,6 +67,7 @@ impl WasmLayerConfig {
         self
     }
 
+    /// True if the console reporting spans
     pub fn console_enabled(&self) -> bool {
         self.console.reporting_enabled()
     }
diff --git a/src/layer.rs b/src/layer.rs
@@ -13,13 +13,37 @@ use crate::{
 #[deprecated(since = "1.0.0", note = "Rename WASMLayer to WasmLayer.")]
 pub type WASMLayer = WasmLayer;
 
-/// Implements [tracing_subscriber::layer::Layer] which uses [wasm_bindgen] for marking and measuring with `window.performance`
+#[doc = r#"
+Implements [tracing_subscriber::layer::Layer] which uses [wasm_bindgen] for marking and measuring via `window.performance` and `window.console`
+
+If composing a subscriber, provide `WasmLayer` as such:
+
+```notest
+use tracing_subscriber::prelude::*;
+use tracing::Subscriber;
+
+pub struct MySubscriber {
+    // ...
+}
+
+impl Subscriber for MySubscriber {
+    // ...
+}
+
+let subscriber = MySubscriber::new()
+    .with(WasmLayer::default());
+
+tracing::subscriber::set_global_default(subscriber);
+```
+
+"#]
 pub struct WasmLayer {
     last_event_id: AtomicUsize,
     config: WasmLayerConfig,
 }
 
 impl WasmLayer {
+    /// Create a new [Layer] with the provided config
     pub fn new(config: WasmLayerConfig) -> Self {
         WasmLayer {
             last_event_id: AtomicUsize::new(0),
@@ -28,7 +52,7 @@ impl WasmLayer {
     }
 }
 
-impl core::default::Default for WasmLayer {
+impl Default for WasmLayer {
     fn default() -> Self {
         WasmLayer::new(WasmLayerConfig::default())
     }
@@ -56,7 +80,6 @@ impl<S: Subscriber + for<'a> LookupSpan<'a>> Layer<S> for WasmLayer {
         }
     }
 
-    /// doc: Notifies this layer that a span with the given Id recorded the given values.
     fn on_record(&self, id: &tracing::Id, values: &tracing::span::Record<'_>, ctx: Context<'_, S>) {
         if let Some(span_ref) = ctx.span(id) {
             if let Some(debug_record) = span_ref.extensions_mut().get_mut::<StringRecorder>() {
@@ -65,9 +88,6 @@ impl<S: Subscriber + for<'a> LookupSpan<'a>> Layer<S> for WasmLayer {
         }
     }
 
-    // /// doc: Notifies this layer that a span with the ID span recorded that it follows from the span with the ID follows.
-    // fn on_follows_from(&self, _span: &tracing::Id, _follows: &tracing::Id, ctx: Context<'_, S>) {}
-    /// doc: Notifies this layer that an event has occurred.
     fn on_event(&self, event: &tracing::Event<'_>, ctx: Context<'_, S>) {
         if !self.config.report_logs_in_timings && !self.config.console.reporting_enabled() {
             return;
@@ -160,13 +180,13 @@ impl<S: Subscriber + for<'a> LookupSpan<'a>> Layer<S> for WasmLayer {
             ConsoleConfig::NoReporting => unreachable!(),
         };
     }
-    /// Notifies this layer that a span with the given ID was entered.
+
     fn on_enter(&self, id: &tracing::Id, _ctx: Context<'_, S>) {
         if self.config.report_logs_in_timings {
             mark(&mark_name(id));
         }
     }
-    /// Notifies this layer that the span with the given ID was exited.
+
     fn on_exit(&self, id: &tracing::Id, ctx: Context<'_, S>) {
         if !self.config.report_logs_in_timings {
             return;
@@ -198,15 +218,4 @@ impl<S: Subscriber + for<'a> LookupSpan<'a>> Layer<S> for WasmLayer {
             }
         }
     }
-
-    // //If [WasmLayerConfig::report_logs_in_timings] is true, the mark is discarded
-    // fn on_close(&self, id: tracing::Id, _ctx: Context<'_, S>) {
-    // if self.config.report_logs_in_timings {
-    // clear_mark(&mark_name(&id))
-    // }
-    // }
-
-    // /// doc: Notifies this layer that a span ID has been cloned, and that the subscriber returned a different ID.
-    // /// I'm not sure if I need to do something here...
-    // fn on_id_change(&self, _old: &tracing::Id, _new: &tracing::Id, ctx: Context<'_, S>) {}
 }
diff --git a/src/lib.rs b/src/lib.rs
diff --git a/tests/wasm.rs b/tests/wasm.rs

Original file line number	Diff line number	Diff line change
`@@ -10,6 +10,7 @@ pub enum ConsoleConfig {`
`10`	`10`	`}`
`11`	`11`
`12`	`12`	`impl ConsoleConfig {`
	`13`	`+ /// True if the console reporting spans`
`13`	`14`	`pub fn reporting_enabled(&self) -> bool {`
`14`	`15`	`!matches!(self, ConsoleConfig::NoReporting)`
`15`	`16`	`}`