Add criterion benchmark to forc-doc + initial code quality pass (#7242)

## Description
Doing some general code quality changes at the same time. 

## Checklist

- [ ] I have linked to any relevant issues.
- [ ] I have commented my code, particularly in hard-to-understand
areas.
- [ ] I have updated the documentation where relevant (API docs, the
reference, and the Sway book).
- [ ] If my change requires substantial documentation changes, I have
[requested support from the DevRel
team](https://github.com/FuelLabs/devrel-requests/issues/new/choose)
- [ ] I have added tests that prove my fix is effective or that my
feature works.
- [ ] I have added (or requested a maintainer to add) the necessary
`Breaking*` or `New Feature` labels where relevant.
- [ ] I have done my best to ensure that my PR adheres to [the Fuel Labs
Code Review
Standards](https://github.com/FuelLabs/rfcs/blob/master/text/code-standards/external-contributors.md).
- [ ] I have requested a review from the relevant team or maintainers.

Author: JoshuaBatty

.github/workflows/benchmark.yml

@@ -10,7 +10,7 @@ on:
        - sway-lsp/**
        - forc-pkg/**
        - sway-core/**
-
+       - forc-plugins/forc-doc/**
   # `workflow_dispatch` allows CodSpeed to trigger backtest
   # performance analysis in order to generate initial data.
   workflow_dispatch:
@@ -38,11 +38,15 @@ jobs:
         with:
           tool: cargo-codspeed
 
-      - name: Build the benchmark target(s)
-        run: cargo codspeed build
+      - name: Build the benchmark targets
+        run: |
+          cargo codspeed build -p sway-lsp
+          cargo codspeed build -p forc-doc
 
       - name: Run the benchmarks
         uses: CodSpeedHQ/action@v3
         with:
-          run: cargo codspeed run
+          run: |
+            cargo codspeed run -p sway-lsp
+            cargo codspeed run -p forc-doc
           token: ${{ secrets.CODSPEED_TOKEN }}

Cargo.lock

@@ -29,5 +29,13 @@ sway-types.workspace = true
 swayfmt.workspace = true
 
 [dev-dependencies]
+codspeed-criterion-compat.workspace = true
 dir_indexer.workspace = true
 expect-test.workspace = true
+
+[[bench]]
+name = "bench_main"
+harness = false
+
+[lib]
+bench = false

forc-plugins/forc-doc/Cargo.toml

@@ -0,0 +1,28 @@
+use codspeed_criterion_compat::{criterion_group, criterion_main, Criterion};
+use forc_doc::{compile, compile_html, Command, DocContext};
+use std::path::Path;
+
+fn benchmarks(c: &mut Criterion) {
+    let path = Path::new("./../../sway-lib-std");
+    let opts = Command {
+        path: Some(path.to_str().unwrap().to_string()),
+        ..Default::default()
+    };
+    let ctx = DocContext::from_options(&opts).unwrap();
+    let compile_results = compile(&ctx, &opts).unwrap().collect::<Vec<_>>();
+
+    c.bench_function("build_std_lib_docs", |b| {
+        b.iter(|| {
+            let mut results = compile_results.clone();
+            let _ = compile_html(&opts, &ctx, &mut results);
+        });
+    });
+}
+
+criterion_group! {
+    name = benches;
+    config = Criterion::default().measurement_time(std::time::Duration::from_secs(10));
+    targets = benchmarks
+}
+
+criterion_main!(benches);

forc-plugins/forc-doc/benches/bench_main.rs

@@ -7,7 +7,7 @@ use crate::{
             context::{Context, ContextType, ItemContext},
             documentable_type::DocumentableType,
         },
-        util::format::{code_block::trim_fn_body, docstring::DocStrings},
+        util::format::docstring::DocStrings,
     },
 };
 use anyhow::Result;
@@ -23,6 +23,7 @@ use swayfmt::parse;
 trait RequiredMethods {
     fn to_methods(&self, decl_engine: &DeclEngine) -> Vec<TyTraitFn>;
 }
+
 impl RequiredMethods for Vec<DeclRefTraitFn> {
     fn to_methods(&self, decl_engine: &DeclEngine) -> Vec<TyTraitFn> {
         self.iter()
@@ -380,3 +381,11 @@ impl Descriptor {
         }
     }
 }
+
+/// Takes a formatted function signature & body and returns only the signature.
+fn trim_fn_body(f: String) -> String {
+    match f.find('{') {
+        Some(index) => f.split_at(index).0.to_string(),
+        None => f,
+    }
+}

forc-plugins/forc-doc/src/cli.rs

@@ -1,4 +1,7 @@
 //! Handles conversion of compiled typed Sway programs into [Document]s that can be rendered into HTML.
+mod descriptor;
+pub mod module;
+
 use crate::{
     doc::{descriptor::Descriptor, module::ModuleInfo},
     render::{
@@ -22,11 +25,7 @@ use sway_core::{
     Engines,
 };
 use sway_features::ExperimentalFeatures;
-use sway_types::BaseIdent;
-use sway_types::Spanned;
-
-mod descriptor;
-pub mod module;
+use sway_types::{BaseIdent, Spanned};
 
 #[derive(Default, Clone)]
 pub struct Documentation(pub Vec<Document>);
@@ -86,7 +85,7 @@ impl Documentation {
             if let Ok(Descriptor::Documentable(doc)) =
                 Descriptor::from_type_info(impl_for_type.as_ref(), engines, module_info.clone())
             {
-                if !docs.iter().any(|existing_doc| *existing_doc == doc) {
+                if !docs.contains(&doc) {
                     docs.push(doc);
                 }
             }

forc-plugins/forc-doc/src/doc/descriptor.rs

@@ -1,5 +1,5 @@
 //! Handles the gathering of module information used in navigation and documentation of modules.
-use crate::render::{constant::INDEX_FILENAME, util::format::docstring::create_preview};
+use crate::render::{util::format::docstring::create_preview, INDEX_FILENAME};
 use anyhow::Result;
 use horrorshow::{box_html, Template};
 use std::{fmt::Write, path::PathBuf};