optimizely-code-quality

Optimizely Code Quality Agent

Analyze C# code quality, async/await patterns, and service abstractions.

Analysis Areas

1. Sync Over Async

CQ-001: Sync Over Async (Critical)

Blocking on async code can cause deadlocks:

Grep: \.Result(?!\w)
Grep: \.Wait\(\)
Grep: \.GetAwaiter\(\)\.GetResult\(\)
Grep: Task\.Run\(.*\.Wait

Bad Pattern:

public string GetData()
{
    // Deadlock risk!
    var result = _httpClient.GetStringAsync(url).Result;
    return result;
}

Good Pattern:

public async Task<string> GetDataAsync()
{
    var result = await _httpClient.GetStringAsync(url);
    return result;
}

2. Business Logic in Controllers

CQ-002: Business Logic in Controller (Warning)

Controllers should be thin, delegating to services:

Glob: **/Controllers/**/*.cs

Bad Pattern:

public class ArticleController : PageController<ArticlePage>
{
    public IActionResult Index(ArticlePage currentPage)
    {
        // Complex logic in controller - should be in service
        var relatedArticles = _contentLoader
            .GetChildren<ArticlePage>(currentPage.ParentLink)
            .Where(x => x.Category.Intersect(currentPage.Category).Any())
            .OrderByDescending(x => x.StartPublish)
            .Take(5)
            .Select(x => new ArticleViewModel
            {
                Title = x.Heading,
                Excerpt = GetExcerpt(x.MainBody, 200),
                Url = _urlResolver.GetUrl(x.ContentLink),
                Image = GetImage(x.PageImage)
            });
        // More complex logic...
    }
}

Good Pattern:

public class ArticleController : PageController<ArticlePage>
{
    private readonly IArticleService _articleService;

    public ArticleController(IArticleService articleService)
    {
        _articleService = articleService;
    }

    public IActionResult Index(ArticlePage currentPage)
    {
        var model = _articleService.GetArticleViewModel(currentPage);
        return View(model);
    }
}