--- name: ring-using-assert-97cb6be42faa description: "Using lib-observability/assert, Lerian's runtime assertion package, in two modes. Sweep Mode detects panic()/log.Fatal zero-panic violations, DIY invariant checks, hand-rolled domain predicates, and missing InitAssertionMetrics. Reference Mode catalogs the asserter lifecycle, domain predicates, observability trident, AssertionError unwrapping, and the panic-vs-assert-vs-error decision tree. Go-only. Skip for non-Go or frontend code." --- # ring:using-assert ## Moved from lib-commons The canonical home for this package is now `github.com/LerianStudio/lib-observability/assert`. It lived in `github.com/LerianStudio/lib-commons/v4/commons/assert` and `github.com/LerianStudio/lib-commons/v5/commons/assert` through the v4 and v5 shim period; lib-commons v5 still re-exports every symbol via type aliases and thin wrappers for backward compatibility, but every type and function in `lib-commons/v5/commons/assert` is marked `Deprecated:` and delegates to `lib-observability/assert`. New code MUST import `github.com/LerianStudio/lib-observability/assert`. Existing imports continue to compile during the deprecation window — there are no behavior changes, only an import-path move. ## When to use Sweep mode: - "Sweep the codebase for lib-observability/assert opportunities" - "Audit this service for zero-panic policy compliance" - "Find panic()/log.Fatal violations" - "Replace DIY invariant checks with lib-observability/assert" Reference mode: - "What's the signature for assert.DebitsEqualCredits?" - "How do I initialize assertion metrics?" - "Should I panic, assert, or return an error here?" - "How do I unwrap AssertionError in a Fiber error handler?" ## Skip when - Working on non-Go services - Working on frontend code - Target codebase is Ring itself ## Related **Similar:** ring:using-lib-observability, ring:using-runtime **Compatibility:** ring:using-lib-commons (covers the v5 deprecation shim and re-export aliases) ## Mode Selection | Request Shape | Mode | |---|---| | "Sweep / audit for assert opportunities" | **Sweep** | | "Find panic()/log.Fatal() violations" | **Sweep** | | "What's the signature for X?" | **Reference** | | "Should I panic, assert, or return error?" | **Reference** | --- # SWEEP MODE 4-phase sweep. Each phase has a hard gate — do not proceed until the current phase produces its artifact. ``` Phase 1: Version Reconnaissance → assert-version-report.json Phase 2: CHANGELOG Delta Analysis → assert-delta-report.json Phase 3: Multi-Angle DIY Sweep → 6 × assert-sweep-{N}-{angle}.json Phase 4: Consolidated Report → assert-sweep-report.md + assert-sweep-tasks.json ``` ## Phase 1: Version Reconnaissance 1. Read `go.mod` — extract pinned versions of `github.com/LerianStudio/lib-observability` and (if present) `github.com/LerianStudio/lib-commons/vN`. Either import path is valid: lib-observability is canonical; lib-commons/v5/commons/assert is a deprecation shim that re-exports the same symbols. 2. WebFetch `https://api.github.com/repos/LerianStudio/lib-observability/releases/latest` — extract `tag_name`. Also fetch the lib-commons release tag for shim consumers. 3. Classify drift: up-to-date / minor-drift / moderate-drift / major-upgrade / module-mismatch. Treat "imports lib-commons assert shim" as `module-mismatch` for new code — the recommended migration is to switch the import to `lib-observability/assert`. 4. Emit `/tmp/assert-version-report.json`: `{pinned_observability_version, pinned_commons_version, latest_observability_version, drift_classification, major_upgrade_required, module_path, uses_shim}` ## Phase 2: CHANGELOG Delta Analysis 1. WebFetch `https://raw.githubusercontent.com/LerianStudio/lib-observability/main/CHANGELOG.md` 2. Filter entries between pinned_observability_version and latest_observability_version that affect `assert` 3. Classify: `new-predicate` / `new-method` / `breaking-change` / `security-fix` / `bugfix` 4. Emit `/tmp/assert-delta-report.json` ## Phase 3: Multi-Angle DIY Sweep ### ⛔ STOP-CHECK BEFORE DISPATCH Before emitting any Task call, count the explorers you intend to launch in this turn. - Count MUST equal 6. - If count < 6 → STOP. Do not partial-dispatch. Reconcile against the 6 angles below and try again. - The 6 angles are the canonical sweep. No substitutions, no omissions. ### ⛔ MUST NOT trickle-dispatch All 6 explorers leave in the SAME TURN, before reading any explorer output. Forbidden sequences: - Dispatch explorer 1 → read result → dispatch explorer 2 - Dispatch a subset → wait → dispatch the rest - Dispatch follow-up explorers conditioned on partial output - Loop sequentially over the angle list If you find yourself about to dispatch an explorer in a turn AFTER any explorer has already returned a result → STOP. You violated parallel dispatch. Report the violation and mark the phase INCOMPLETE rather than completing the trickle. ### Self-verify after dispatch After the dispatch turn, verify all 6 Task calls were emitted in that single turn. If fewer than 6 went out, the phase did NOT execute correctly. Mark INCOMPLETE and surface the dispatch failure — do NOT silently continue with a partial pool. ### Parallel dispatch — atomic batch Emit all 6 Task calls in a SINGLE TURN, as one atomic batch. **If your runtime exposes a `multi_tool_use.parallel` wrapper**, use it to dispatch the complete pool in one wrapped invocation. This is the canonical fan-out mechanism on OpenAI-style tool envelopes and on certain Anthropic SDK consumers — naming it explicitly activates parallel emission on runtimes where trickle-dispatch is the default behavior. **If your runtime emits parallel tool_use blocks natively** (Claude Code with Claude models), `multi_tool_use.parallel` may not be needed — but naming it is harmless and serves as an enforcement anchor. The STOP-CHECK, anti-trickle, and self-verify guards above remain binding regardless of which mechanism your runtime uses. Dispatch all 6 explorer angles in **one parallel batch**. Wait for all before Phase 4. **Per-explorer dispatch** (`subagent_type: ring:codebase-explorer`): ``` ## Target: ## Your Angle: ## Severity Calibration / DIY Patterns / Replacement / Migration Complexity / Version Context ## Output Write to: /tmp/assert-sweep-{N}-{angle-slug}.json Schema: { angle_number, angle_name, severity, migration_complexity, findings: [{file, line, diy_pattern, replacement, evidence_snippet, notes}], summary, requires_major_upgrade } If no findings: write file with empty findings array. ``` Full angle specifications: `sub-files/sweep-angles.md` The 6 angles cover: 1. `panic()` in non-test code (CRITICAL) 2. Defensive nil/empty checks without metric emission (HIGH) 3. Hand-rolled domain predicates duplicating `assert.*` (HIGH) 4. Missing `InitAssertionMetrics` at startup (HIGH) 5. Financial invariants in tests only, not production (CRITICAL) 6. `AssertionError` not unwrapped in error boundaries (MEDIUM) ## Phase 4: Consolidated Report Dispatch synthesizer to read all 6 explorer files and emit: 1. `/tmp/assert-sweep-report.md` — aggregate findings by severity 2. `/tmp/assert-sweep-tasks.json` — one task per DIY pattern cluster Surface report path + task count; offer handoff to `ring:running-dev-cycle`. --- # REFERENCE MODE Full API reference in `sub-files/reference.md`. Load sections relevant to your task. ## Quick Navigation | # | Section | What you'll find | |---|---|---| | 1 | API Surface | Exported symbols, signatures | | 2 | Asserter Lifecycle | Scoping, naming, anti-patterns | | 3 | Instance Methods | That / NotNil / NotEmpty / NoError / Never / Halt | | 4 | Domain Predicate Catalog | Numeric / financial / state-machine / network / time | | 5 | Composition Pattern | Pure predicates + observable asserter | | 6 | Observability Trident | Log + span event + metric on every failure | | 7 | AssertionError Unwrapping | Error boundary patterns | | 8 | Decision Tree | panic vs assert vs error | | 9 | Testing Patterns | Proving assertions fire | | 10 | Anti-Pattern Catalog | Six anti-patterns | | 11 | Bootstrap Order | InitAssertionMetrics placement | | 12–14 | Cross-references, Patterns, Breaking Changes | v4→v5 delta | Read `sub-files/reference.md` for full API detail. --- Source attribution: LerianStudio Original project: https://github.com/LerianStudio/ring/blob/ecea35d9ce472b8016afb4606bd287170d206963/dev-team/skills/using-assert/SKILL.md License: Apache-2.0 License information: https://www.apache.org/licenses/LICENSE-2.0 Original upstream instructions; downloaded from Mega AI Hub. ## Upstream license notice 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 APPENDIX: How to apply the Apache License to your work. To apply the Apache License to your work, attach the following boilerplate notice, with the fields enclosed by brackets "[]" replaced with your own identifying information. (Don't include the brackets!) The text should be enclosed in the appropriate comment syntax for the file format. We also recommend that a file or class name and description of purpose be included on the same "printed page" as the copyright notice for easier identification within third-party archives. Copyright [yyyy] [name of copyright owner] Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. # Mega AI Hub resource metadata Creator / publisher: LerianStudio Original project: https://github.com/LerianStudio/ring/blob/ecea35d9ce472b8016afb4606bd287170d206963/dev-team/skills/using-assert/SKILL.md Attribution basis: Source repository record Fields of work: Development & Engineering Roles: Backend Developer, DevOps / SRE, QA / Test Engineer Specialties: API, Frontend, Git, Testing Tools: GitHub Country applicability: Country not specified Classification basis: Source catalog labels Instruction SHA-256: cd9f9e484299393327da2450b6f84510f47a40ecec5421d8c0b573855f4ee4d7