github SalesforceLabs/OrgCheck Oxygen
Oxygen (O, 8)

one month ago

🚀 Org Check — Version Oxygen (v8) Release Notes

Welcome to Org Check Oxygen (v8)! This release marks a significant architectural milestone for the tool, transitioning the codebase into a multi-package repository (monorepo) using Lerna. This structural update aligns the Org Check API, the Salesforce LWC App, and the Salesforce CLI (sf) Plugin into a single, cohesive ecosystem.

With the Oxygen release, you gain a brand-new Command Line Interface plugin, deep insights into sharing rules, an improved cache manager, and structural performance optimizations.


🌟 Key Highlights

1. Architectural Evolution: Monorepo & The Core API Wrapper

  • The "Multipacking" Transition: Org Check has been completely refactored into a multi-package layout managed by Lerna. This isolates business logic into distinct, modular units (orgcheck-api, orgcheck-salesforce-app, and orgcheck-sfdx-plugin).
  • Unified Wrapper Engine: Core data-manipulation layers have been extracted and moved entirely to the API side. By embedding the orchestration wrapper inside the base library, redundant payload filtering and extra data manipulation have been eliminated across both the desktop UI and CLI channels.
  • JSForce Standardization: Standardized the underlying API connection engine by matching jsforce versions across the core library and the LWC Salesforce application layout, ensuring perfect cross-package compatibility.

2. Deep Dive Metadata Additions

  • Object Sharing Rules Analysis (#528): You can now audit Sharing Rules for both standard and custom objects. Org Check itemizes active sharing rules and explicitly surfaces the absolute volume of sharing rules applied per object to help keep you safely below platform limits.
  • Platform Release Updates (#631): Added dedicated tracking for Salesforce Release Updates directly inside the core engine and exposed them via the frontend UI to help administrators stay ahead of upcoming breaking platform changes.
  • RecordType Cleanup: Removed references to the deprecated IsMaster flag on RecordType metadata objects to guarantee long-term compatibility with newer Salesforce Metadata API versions.

3. The Official sf CLI Plugin is Live (#645)

  • Production-Ready Command Suite: The @orgcheck/sfdx-plugin package has been fully initialized and structured as an extension of the modern Salesforce SfCommand architecture.
  • CLI Cache Management: Added native cache handling capabilities directly inside the terminal interface to let you manage local metadata storage without needing to boot up a browser session.
  • Explicit Terms Enforcement: To prevent automated runtime accidents, the CLI/API will now explicitly throw exceptions if required usage terms are not programmatically accepted via flags.

4. UI/UX & Quality-of-Life Enhancements

  • Data Refresh Controls (#642): Added a dedicated interactive button directly on the primary viewing pages allowing users to force-refresh active metadata without a complete application restart.
  • Enhanced Cache Manager UI: Re-imagined the internal cache controller dashboard with clearer metrics, better UI layouts, and automated troubleshooting signals.
  • UX Micro-interactions: Modals can now be instantly dismissed using the keyboard Escape key, loading spinners have been updated for smoother transitions, and the animated application logo has been refreshed to visually reflect the v8 release.
  • Actionable Errors & Tips (#621): The error modal system now populates intelligent tips alongside exceptions, assisting administrators with quick debugging suggestions whenever a metadata scan fails.

🛠️ Bug Fixes & Refactorings

🛡️ AppExchange & Security Compliance

  • AppExchange Security Scanning Alignment: Patched several code patterns to proactively fix code violations surfaced by automated AppExchange source scanners.
  • Hardcoded URL Resolution (#674): Eradicated hardcoded Salesforce instance URL patterns within both the application and CLI plugins, ensuring proper routing across specialized MyDomain configurations.
  • Explicit Org Limit Checking (#643): Restructured how platform boundaries are validated by switching to explicit orglimit polling routines.

🐛 Critical Bug Fixes

  • Circular Definition Erasure: Patched a critical bug that caused stack crashes during massive org scans by stripping internal cross-references from final object outputs, eliminating infinite circular loops.
  • Numeric KeyPrefix Support: Fixed data export routines failing on specific objects whose unique Salesforce keyPrefix was composed entirely of digits (such as standard Account frameworks).
  • Bad URL and Global-View Mapping (#634, #674): Patched target instance detection logic to resolve analytical edge cases within the globalview dashboard layout.
  • Gitignore and Workspace Cleanup: Cleaned up overlapping .gitignore parameters and deleted redundant generated development files across the workspaces to maintain lean build targets.

📦 Dependency Upgrades

A massive automated effort went into framework modernization and vulnerability patching across all sub-packages via Dependabot integrations:

  • Core Compilers & Workspaces: Upgraded rollup (from 4.53.3 to 4.60.0), @rollup/plugin-terser to 1.0.0, lint-staged to 17.0.2, and updated internal lerna configurations.
  • Type Frameworks: Shifted base TypeScript packages to TypeScript 6.0.2.
  • Testing Engines: Migrated development testing environments to Jest 30.4.2 and upgraded accessibility tracking via @sa11y/jest to 8.0.27.
  • Linter Frameworks: Standardized internal code guidelines across packages by updating eslint up to 10.1.0.

💾 Get Started with v8

Local Installation for CLI Developers

To install or upgrade the local CLI suite alongside the newly restructured monorepo layout:

sf plugins install @orgcheck/sfdx-plugin@latest

Don't miss a new OrgCheck release

NewReleases is sending notifications on new releases.