Skip to content

NEW @W-21910054@ Make ApexGuru opt-in (apex-guru tag), reconcile rule severities, and reduce API timeout to 5 minutes #502

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
nikhil-mittal-165 wants to merge 2 commits into
base: dev
Choose a base branch
from
Open

NEW @W-21910054@ Make ApexGuru opt-in (apex-guru tag), reconcile rule severities, and reduce API timeout to 5 minutes #502

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d22ee91
apex guru severity changes
nikhil-mittal-165 Aug 20, 2026
ae45627
NEW @W-21910054@ Make ApexGuru engine opt-in via apex-guru tag and re…
nikhil-mittal-165 Aug 20, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
148 changes: 71 additions & 77 deletions packages/code-analyzer-apexguru-engine/src/apexguru-rules.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,16 @@


import { COMMON_TAGS, RuleDescription, SeverityLevel } from '@salesforce/code-analyzer-engine-api';
import { RuleDescription, SeverityLevel } from '@salesforce/code-analyzer-engine-api';

/**
* Tag carried by every ApexGuru rule.
*
* ApexGuru rules are opt-in: they are excluded from the default ("Recommended"), "all", and severity-based
* rule selection. They only run when explicitly requested by the engine name ('apexguru') or by this tag
* (e.g. via '--rule-selector apex-guru'). The opt-in exclusion is enforced in code-analyzer-core's
* rule selection logic, which special-cases this tag.
*/
export const APEXGURU_TAG: string = 'apex-guru';

/**
* Known ApexGuru rules with descriptions and metadata.
Expand All @@ -10,205 +20,189 @@ import { COMMON_TAGS, RuleDescription, SeverityLevel } from '@salesforce/code-an
*/
export const APEXGURU_RULES: RuleDescription[] = [
// =================================================================================================================
// PERFORMANCE RULES - HIGH SEVERITY (CRITICAL - RECOMMENDED)
// PERFORMANCE RULES - HIGH SEVERITY
// =================================================================================================================

{
name: 'SoqlInALoop',
severityLevel: SeverityLevel.High,
tags: [COMMON_TAGS.RECOMMENDED, COMMON_TAGS.CATEGORIES.PERFORMANCE],
tags: [APEXGURU_TAG],
description: 'SOQL query inside a loop causes performance issues and can hit governor limits',
resourceUrls: ['https://help.salesforce.com/s/articleView?id=xcloud.apexguru_antipattern_soql_in_loop.htm&type=5']
},

{
name: 'DmlInALoop',
severityLevel: SeverityLevel.High,
tags: [COMMON_TAGS.RECOMMENDED, COMMON_TAGS.CATEGORIES.PERFORMANCE],
tags: [APEXGURU_TAG],
description: 'DML statement inside a loop causes performance issues and can hit governor limits',
resourceUrls: ['https://help.salesforce.com/s/articleView?id=xcloud.apexguru_antipattern_dml_in_loop.htm&type=5']
},

// =================================================================================================================
// PERFORMANCE RULES - HIGH SEVERITY (PERFORMANCE ONLY - NOT RECOMMENDED)
// =================================================================================================================

{
name: 'SoqlInALoopOneHop',
severityLevel: SeverityLevel.High,
tags: [COMMON_TAGS.RECOMMENDED, COMMON_TAGS.CATEGORIES.PERFORMANCE],
description: 'SOQL query reached one method-hop away inside a loop causes performance issues and can hit governor limits',
resourceUrls: ['https://help.salesforce.com/s/articleView?id=xcloud.apexguru_antipattern_soql_in_loop_one_hop.htm&type=5']
},

{
name: 'ExpensiveMethods',
severityLevel: SeverityLevel.High,
tags: [COMMON_TAGS.RECOMMENDED, COMMON_TAGS.CATEGORIES.PERFORMANCE],
tags: [APEXGURU_TAG],
description: 'Method accounts for a large share of observed Apex CPU time and is a hotspot for performance work',
resourceUrls: ['https://help.salesforce.com/s/articleView?id=xcloud.apexguru_antipattern_expensive_methods.htm&type=5']
},

// =================================================================================================================
// PERFORMANCE RULES - MODERATE SEVERITY (CRITICAL - RECOMMENDED)
// =================================================================================================================

{
name: 'SoqlWithoutAWhereClauseOrLimitStatement',
severityLevel: SeverityLevel.Moderate,
tags: [COMMON_TAGS.RECOMMENDED, COMMON_TAGS.CATEGORIES.PERFORMANCE],
description: 'SOQL query without WHERE clause or LIMIT statement can cause performance issues and heap size exceptions',
resourceUrls: ['https://help.salesforce.com/s/articleView?id=xcloud.apexguru_antipattern_soql_without_where_clause_or_limit_statement.htm&type=5']
name: 'SchemaGetGlobalDescribeNotEfficient',
severityLevel: SeverityLevel.High,
tags: [APEXGURU_TAG],
description: 'Using Schema.getGlobalDescribe() causes unnecessary overhead and decreases performance',
resourceUrls: ['https://help.salesforce.com/s/articleView?id=xcloud.apexguru_antipattern_schema_getglobaldescribe_not_efficient.htm&type=5']
},

{
name: 'SoqlWithWildcardFilter',
severityLevel: SeverityLevel.Moderate,
tags: [COMMON_TAGS.RECOMMENDED, COMMON_TAGS.CATEGORIES.PERFORMANCE],
description: 'SOQL query using LIKE with leading wildcard is inefficient and cannot use indexes',
resourceUrls: ['https://help.salesforce.com/s/articleView?id=xcloud.apexguru_antipattern_soql_with_wildcard_filter.htm&type=5']
name: 'SoqlWithoutPlatformCache',
severityLevel: SeverityLevel.High,
tags: [APEXGURU_TAG],
description: 'Frequently executed SOQL query whose results could be served from Platform Cache to reduce database load',
resourceUrls: ['https://help.salesforce.com/s/articleView?id=xcloud.apexguru_antipattern_soql_without_platform_cache.htm&type=5']
},

// =================================================================================================================
// PERFORMANCE RULES - MODERATE SEVERITY
// =================================================================================================================

{
name: 'SchemaGetGlobalDescribeNotEfficient',
name: 'SoqlInALoopOneHop',
severityLevel: SeverityLevel.Moderate,
tags: [COMMON_TAGS.RECOMMENDED, COMMON_TAGS.CATEGORIES.PERFORMANCE],
description: 'Using Schema.getGlobalDescribe() causes unnecessary overhead and decreases performance',
resourceUrls: ['https://help.salesforce.com/s/articleView?id=xcloud.apexguru_antipattern_schema_getglobaldescribe_not_efficient.htm&type=5']
tags: [APEXGURU_TAG],
description: 'SOQL query reached one method-hop away inside a loop causes performance issues and can hit governor limits',
resourceUrls: ['https://help.salesforce.com/s/articleView?id=xcloud.apexguru_antipattern_soql_in_loop_one_hop.htm&type=5']
},

// =================================================================================================================
// PERFORMANCE RULES - MODERATE SEVERITY (PERFORMANCE ONLY - NOT RECOMMENDED)
// =================================================================================================================

{
name: 'Soql Aggregation',
severityLevel: SeverityLevel.Moderate,
tags: [COMMON_TAGS.RECOMMENDED, COMMON_TAGS.CATEGORIES.PERFORMANCE],
tags: [APEXGURU_TAG],
description: 'Manual aggregation in Apex instead of using SOQL aggregate functions causes performance issues',
resourceUrls: ['https://help.salesforce.com/s/articleView?id=xcloud.apexguru_antipattern_aggregating_in_apex.htm&type=5']
},

{
name: 'SoqlWithApexFilter',
severityLevel: SeverityLevel.Moderate,
tags: [COMMON_TAGS.RECOMMENDED, COMMON_TAGS.CATEGORIES.PERFORMANCE],
tags: [APEXGURU_TAG],
description: 'Filtering records in Apex instead of using SOQL WHERE clause causes performance issues',
resourceUrls: ['https://help.salesforce.com/s/articleView?id=xcloud.apexguru_antipattern_soql_with_apex_filter.htm&type=5']
},

{
name: 'CopyingListOrSetElementsUsingAForLoop',
severityLevel: SeverityLevel.Moderate,
tags: [COMMON_TAGS.RECOMMENDED, COMMON_TAGS.CATEGORIES.PERFORMANCE],
tags: [APEXGURU_TAG],
description: 'Copying list or set elements using a for loop is inefficient - use addAll() instead',
resourceUrls: ['https://help.salesforce.com/s/articleView?id=xcloud.apexguru_antipattern_copying_elements_with_for_loop.htm&type=5']
},

{
name: 'Redundant Soql',
severityLevel: SeverityLevel.Moderate,
tags: [COMMON_TAGS.RECOMMENDED, COMMON_TAGS.CATEGORIES.PERFORMANCE],
tags: [APEXGURU_TAG],
description: 'Multiple identical SOQL queries cause unnecessary database round trips',
resourceUrls: ['https://help.salesforce.com/s/articleView?id=xcloud.apexguru_antipattern_redundant_soql.htm&type=5']
},

{
name: 'SoqlWithNegativeExpressions',
severityLevel: SeverityLevel.Moderate,
tags: [COMMON_TAGS.RECOMMENDED, COMMON_TAGS.CATEGORIES.PERFORMANCE],
description: 'SOQL queries using negative expressions (NOT IN, !=) don\'t use indexes and cause full table scans',
resourceUrls: ['https://help.salesforce.com/s/articleView?id=xcloud.apexguru_antipattern_soql_with_negative_expressions.htm&type=5']
},

{
name: 'SObjectMapInAForLoop',
severityLevel: SeverityLevel.Moderate,
tags: [COMMON_TAGS.RECOMMENDED, COMMON_TAGS.CATEGORIES.PERFORMANCE],
tags: [APEXGURU_TAG],
description: 'Building Map<Id, SObject> using .put() in a for loop is inefficient - use map constructor or putAll()',
resourceUrls: ['https://help.salesforce.com/s/articleView?id=xcloud.apexguru_antipattern_sobject_map_in_for_loop.htm&type=5']
},

// =================================================================================================================
// PERFORMANCE RULES - LOW SEVERITY
// =================================================================================================================

{
name: 'SoqlWithoutPlatformCache',
severityLevel: SeverityLevel.Moderate,
tags: [COMMON_TAGS.RECOMMENDED, COMMON_TAGS.CATEGORIES.PERFORMANCE],
description: 'Frequently executed SOQL query whose results could be served from Platform Cache to reduce database load',
resourceUrls: ['https://help.salesforce.com/s/articleView?id=xcloud.apexguru_antipattern_soql_without_platform_cache.htm&type=5']
name: 'SoqlWithoutAWhereClauseOrLimitStatement',
severityLevel: SeverityLevel.Low,
tags: [APEXGURU_TAG],
description: 'SOQL query without WHERE clause or LIMIT statement can cause performance issues and heap size exceptions',
resourceUrls: ['https://help.salesforce.com/s/articleView?id=xcloud.apexguru_antipattern_soql_without_where_clause_or_limit_statement.htm&type=5']
},

// =================================================================================================================
// PERFORMANCE RULES - LOW SEVERITY (PERFORMANCE ONLY - NOT RECOMMENDED)
// =================================================================================================================
{
name: 'SoqlWithWildcardFilter',
severityLevel: SeverityLevel.Low,
tags: [APEXGURU_TAG],
description: 'SOQL query using LIKE with leading wildcard is inefficient and cannot use indexes',
resourceUrls: ['https://help.salesforce.com/s/articleView?id=xcloud.apexguru_antipattern_soql_with_wildcard_filter.htm&type=5']
},

{
name: 'SoqlWithNegativeExpressions',
severityLevel: SeverityLevel.Low,
tags: [APEXGURU_TAG],
description: 'SOQL queries using negative expressions (NOT IN, !=) don\'t use indexes and cause full table scans',
resourceUrls: ['https://help.salesforce.com/s/articleView?id=xcloud.apexguru_antipattern_soql_with_negative_expressions.htm&type=5']
},

{
name: 'LimitsGetHeapsizeMethods',
severityLevel: SeverityLevel.Low,
tags: [COMMON_TAGS.RECOMMENDED, COMMON_TAGS.CATEGORIES.PERFORMANCE],
tags: [APEXGURU_TAG],
description: 'Frequent Limits.getHeapSize() calls add runtime overhead',
resourceUrls: ['https://help.salesforce.com/s/articleView?id=xcloud.apexguru_antipattern_limits_getheapsize_methods.htm&type=5']
},

{
name: 'ExpensiveStringComparison',
severityLevel: SeverityLevel.Low,
tags: [COMMON_TAGS.RECOMMENDED, COMMON_TAGS.CATEGORIES.PERFORMANCE],
tags: [APEXGURU_TAG],
description: 'Inefficient string comparison wastes CPU time',
resourceUrls: ['https://help.salesforce.com/s/articleView?id=xcloud.apexguru_antipattern_expensive_string_comparison.htm&type=5']
},

{
name: 'ExpensiveDebugStatements',
severityLevel: SeverityLevel.Low,
tags: [COMMON_TAGS.RECOMMENDED, COMMON_TAGS.CATEGORIES.PERFORMANCE],
tags: [APEXGURU_TAG],
description: 'Expensive System.debug() statements add runtime overhead',
resourceUrls: ['https://help.salesforce.com/s/articleView?id=xcloud.apexguru_antipattern_expensive_debug_statements.htm&type=5']
},

// =================================================================================================================
// BEST PRACTICES - LOW SEVERITY (RECOMMENDED)
// =================================================================================================================

{
name: 'UsingTheTestMethodKeyword',
severityLevel: SeverityLevel.Low,
tags: [COMMON_TAGS.RECOMMENDED, COMMON_TAGS.CATEGORIES.PERFORMANCE],
tags: [APEXGURU_TAG],
description: 'The testMethod keyword is deprecated - use @isTest annotation instead',
resourceUrls: ['https://help.salesforce.com/s/articleView?id=xcloud.apexguru_test_case_antipattern_using_testmethod.htm&type=5']
},

// =================================================================================================================
// BEST PRACTICES - LOW SEVERITY (NOT RECOMMENDED)
// =================================================================================================================

{
name: 'SortingInApex',
severityLevel: SeverityLevel.Low,
tags: [COMMON_TAGS.RECOMMENDED, COMMON_TAGS.CATEGORIES.PERFORMANCE],
tags: [APEXGURU_TAG],
description: 'Sorting records in Apex wastes CPU time and can exceed governor limits - use ORDER BY in SOQL',
resourceUrls: ['https://help.salesforce.com/s/articleView?id=xcloud.apexguru_antipattern_sorting_in_apex.htm&type=5']
},

{
name: 'BusyLoopDelay',
severityLevel: SeverityLevel.Low,
tags: [COMMON_TAGS.RECOMMENDED, COMMON_TAGS.CATEGORIES.PERFORMANCE],
tags: [APEXGURU_TAG],
description: 'Using empty loops to delay execution wastes CPU time - use System.enqueueJob with delay parameter',
resourceUrls: ['https://help.salesforce.com/s/articleView?id=xcloud.apexguru_antipattern_busy_loop_delay.htm&type=5']
},

{
name: 'SoqlWithUnusedFields',
severityLevel: SeverityLevel.Low,
tags: [COMMON_TAGS.RECOMMENDED, COMMON_TAGS.CATEGORIES.PERFORMANCE],
tags: [APEXGURU_TAG],
description: 'SOQL query selecting unused fields increases resource consumption unnecessarily',
resourceUrls: ['https://help.salesforce.com/s/articleView?id=xcloud.apexguru_antipattern_soql_with_unused_fields.htm&type=5']
},

{
name: 'WritingFillerStatements',
severityLevel: SeverityLevel.Low,
tags: [COMMON_TAGS.RECOMMENDED, COMMON_TAGS.CATEGORIES.PERFORMANCE],
tags: [APEXGURU_TAG],
description: 'Filler statements written to inflate code coverage instead of testing real behavior',
resourceUrls: ['https://help.salesforce.com/s/articleView?id=xcloud.apexguru_test_case_antipattern_filler_statements.htm&type=5']
},
Expand All @@ -220,7 +214,7 @@ export const APEXGURU_RULES: RuleDescription[] = [
{
name: 'apexguru-other',
severityLevel: SeverityLevel.Moderate,
tags: [COMMON_TAGS.RECOMMENDED, COMMON_TAGS.CATEGORIES.PERFORMANCE],
tags: [APEXGURU_TAG],
description: 'Other ApexGuru rules - covers new rules added by Salesforce that are not yet explicitly declared',
resourceUrls: ['https://help.salesforce.com/s/articleView?id=xcloud.apexguru.htm']
}
Expand Down
8 changes: 4 additions & 4 deletions packages/code-analyzer-apexguru-engine/src/config.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ export type ApexGuruEngineConfig = {

/**
* Maximum time to wait for ApexGuru API response (in milliseconds)
* Default: 600000 (10 minutes)
* Default: 300000 (5 minutes)
*/
api_timeout_ms: number;

Expand Down Expand Up @@ -42,7 +42,7 @@ export type ApexGuruEngineConfig = {
* Default configuration values
*/
export const DEFAULT_APEXGURU_ENGINE_CONFIG: ApexGuruEngineConfig = {
api_timeout_ms: 600000, // 10 minutes
api_timeout_ms: 300000, // 5 minutes
api_initial_retry_ms: 2000, // 2 seconds
api_max_retry_ms: 60000, // 60 seconds
api_backoff_multiplier: 2 // 2x exponential backoff
Expand All @@ -60,9 +60,9 @@ export const APEXGURU_ENGINE_CONFIG_DESCRIPTION: ConfigDescription = {
defaultValue: null
},
api_timeout_ms: {
descriptionText: 'Maximum time to wait for ApexGuru API response (in milliseconds). Default: 600000 (10 minutes)',
descriptionText: 'Maximum time to wait for ApexGuru API response (in milliseconds). Default: 300000 (5 minutes)',
valueType: 'number',
defaultValue: 600000
defaultValue: 300000
},
api_initial_retry_ms: {
descriptionText: 'Initial retry delay for polling ApexGuru API (in milliseconds). Default: 2000 (2 seconds)',
Expand Down
Loading
Loading