Latest Updates

Documenting code, one commit at a time.

JavaScript Mermaid

Handling Mermaid Diagram Rendering Errors

Sometimes, the most challenging bugs are not in the core logic, but in the tooling around it. Recently, while working on the diagram rendering service for a project, I encountered an issue where invalid Mermaid syntax would cause the entire process to hang. Here's how I tackled it.

The Problem

The diagram rendering service, used for generating visualizations, relied on an external script to

Read more
PHP Mermaid

Improving Code Quality with Consistent Mermaid Diagram Generation

Introduction

Ensuring consistent code quality and documentation can be a challenge. One area where consistency is crucial is in the generation of diagrams for technical documentation. This post discusses how we've improved the consistency and validity of Mermaid diagrams generated as part of our technical writing process for the devlog-ist/landing project, which provides a landing page for

Read more
PHP Debugging

Enhancing Debugging in the Landing Page Diagram Pipeline

Introduction

In the ongoing development of the landing page for the devlog-ist project, we've recently focused on improving our debugging capabilities, particularly around the diagram generation and rendering pipeline.

The Challenge

Generating and rendering diagrams, while powerful, can be opaque. Identifying the source of errors or unexpected behavior in the diagram pipeline was proving

Read more
C Security Debugging

Eliminating False Positives in Audit Logs for Generic File Paths

When auditing file system operations within an application, a common challenge arises when dealing with generic or placeholder file paths. These paths, often used during testing or initial setup, can trigger false positive alerts in audit logs, obscuring genuine security concerns. A recent update addresses this issue, enhancing the accuracy and reliability of our auditing process.

Read more

Enhancing Application Observability Through Consistent Error Logging

Introduction

Ensuring application stability and দ্রুত problem resolution hinges on effective error logging. Silent catch blocks, while seemingly benign, can mask critical failures, making them invisible to monitoring systems. This post outlines a strategy for replacing these silent catch blocks with proper logging mechanisms, enhancing overall application observability.

The Problem with

Read more

Enhancing Subscription Recognition in Billing Systems

Introduction

This post addresses an issue where a billing system, specifically when using a service like Cashier, fails to correctly identify active subscriptions beyond the default type. We'll explore the problem and provide a solution to ensure all subscription types are properly recognized.

The Problem: Default Subscription Type Bias

In many billing systems, especially those utilizing

Read more

Enhancing Application Logging with Tenant Context

Introduction

Effective logging is crucial for monitoring and debugging applications, especially in multi-tenant environments. This post explores how to enhance application logging by incorporating tenant-specific context, enabling better isolation and analysis of log data.

The Importance of Tenant-Aware Logging

In a multi-tenant system, logs from different tenants are often interleaved,

Read more