[PM-12989] Allow clients to get SDK version

.github/workflows/build-wasm-internal.yml

@@ -23,6 +23,23 @@ jobs:
       - name: Checkout repo
         uses: actions/checkout@eef61447b9ff4aafe5dcd4e0bbf5d482be7e7871 # v4.2.1
 
+      - name: Set version (PR)
+        if: ${{ github.event_name == 'pull_request' }}
+        run: |
+          echo REF_NAME="${{ github.event.pull_request.head.ref }}" >> $GITHUB_ENV
+          echo SHA="${{ github.event.pull_request.head.sha }}" >> $GITHUB_ENV
+
+      - name: Set env variables (Branch/Tag)
+        if: ${{ github.event_name == 'push' }}
+        run: |
+          echo REF_NAME="${GITHUB_REF_NAME}" >> $GITHUB_ENV
+          echo SHA="${GITHUB_SHA}" >> $GITHUB_ENV
+
+      - name: Set version
+        run: |
+          echo SDK_VERSION="${REF_NAME} (${SHA:0:7})" >> $GITHUB_ENV
+          echo "SDK_VERSION=${SDK_VERSION}"
+
       - name: Setup Node
         uses: actions/setup-node@0a44ba7841725637a19e28fa30b79a866c81b0a6 # v4.0.4
         with:

crates/bitwarden-wasm-internal/build.rs

@@ -0,0 +1,53 @@
+use std::{env, process::Command};
+
+fn main() {
+    // Use the SDK_VERSION environment variable if it is set (e.g. by CI) or get it from Git
+    let sdk_version = env::var("SDK_VERSION")
+        .or_else(|_| version_from_git_info())
+        .unwrap_or("unknown".to_string());
+
+    println!("cargo:rustc-env=SDK_VERSION={sdk_version}");
+    println!("cargo:rustc-env=CARGO_PKG_VERSION={sdk_version}");
+}
+
+fn run(args: &[&str]) -> Result<String, std::io::Error> {
+    use std::io::{Error, ErrorKind};
+    let out = Command::new(args[0]).args(&args[1..]).output()?;
+    if !out.status.success() {
+        return Err(Error::new(ErrorKind::Other, "Command not successful"));
+    }
+    Ok(String::from_utf8(out.stdout)
+        .map_err(|e| Error::new(ErrorKind::Other, e.to_string()))?
+        .trim()
+        .to_string())
+}
+
+/// This method reads info from Git, namely tags, branch, and revision
+/// To access these values, use:
+///    - `env!("GIT_EXACT_TAG")`
+///    - `env!("GIT_BRANCH")`
+///    - `env!("GIT_REV")`
+fn version_from_git_info() -> Result<String, std::io::Error> {
+    // The exact tag for the current commit, can be empty when
+    // the current commit doesn't have an associated tag
+    let exact_tag = run(&["git", "describe", "--abbrev=0", "--tags", "--exact-match"]).ok();
+    if let Some(ref exact) = exact_tag {
+        println!("cargo:rustc-env=GIT_EXACT_TAG={exact}");
+    }
+
+    // The current branch name
+    let branch = run(&["git", "rev-parse", "--abbrev-ref", "HEAD"])?;
+    println!("cargo:rustc-env=GIT_BRANCH={branch}");
+
+    // The current git commit hash
+    let rev = run(&["git", "rev-parse", "HEAD"])?;
+    let rev_short = rev.get(..8).unwrap_or_default();
+    println!("cargo:rustc-env=GIT_REV={rev_short}");
+
+    // Combined version
+    if let Some(exact) = exact_tag {
+        Ok(exact)
+    } else {
+        Ok(format!("{branch} ({rev_short})"))
+    }
+}

crates/bitwarden-wasm-internal/src/client.rs

@@ -49,6 +49,10 @@
         msg
     }
 
+    pub fn version(&self) -> String {
+        env!("SDK_VERSION").to_owned()
+    }
+
     pub fn throw(&self, msg: String) -> Result<(), crate::error::GenericError> {
         Err(crate::error::GenericError(msg))
     }