refactor(postgres): port sales_order_analysis report to the query builder

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>

erpnext/selling/report/sales_order_analysis/sales_order_analysis.py

@@ -6,9 +6,9 @@ from collections import OrderedDict
 
 import frappe
 from frappe import _, qb
-from frappe.query_builder import CustomFunction
+from frappe.query_builder import Case, CustomFunction
-from frappe.query_builder.functions import Max
+from frappe.query_builder.functions import Coalesce, DateDiff, Max, Sum
-from frappe.utils import date_diff, flt, getdate
+from frappe.utils import date_diff, flt, getdate, nowdate
 
 
 def execute(filters=None):
@@ -18,8 +18,7 @@ def execute(filters=None):
 	validate_filters(filters)
 
 	columns = get_columns(filters)
-	conditions = get_conditions(filters)
+	data = get_data(filters)
-	data = get_data(conditions, filters)
 	so_elapsed_time = get_so_elapsed_time(data)
 
 	if not data:
@@ -39,64 +38,66 @@ def validate_filters(filters):
 		frappe.throw(_("To Date cannot be before From Date."))
 
 
-def get_conditions(filters):
+def get_data(filters):
-	conditions = ""
+	so = qb.DocType("Sales Order")
-	if filters.get("from_date") and filters.get("to_date"):
+	soi = qb.DocType("Sales Order Item")
-		conditions += " and so.transaction_date between %(from_date)s and %(to_date)s"
+	sii = qb.DocType("Sales Invoice Item")
 
-	if filters.get("company"):
+	# Use the application's today (nowdate, System Settings timezone) rather than the database
-		conditions += " and so.company = %(company)s"
+	# server's CURRENT_DATE: the two differ by a day when the DB server runs in a different timezone
+	# (e.g. UTC DB + IST app near midnight), which made delay_days non-deterministic on postgres CI.
+	# DateDiff is cross-database: DATEDIFF() on MariaDB, date subtraction on postgres; it casts the
+	# string date to a date on postgres. delivery_date is functionally dependent on the grouped
+	# soi.name primary key, so this is valid under both.
+	delay = DateDiff(nowdate(), soi.delivery_date)
+	conversion_rate = Coalesce(so.conversion_rate, 1)
 
-	if filters.get("sales_order"):
+	query = (
-		conditions += " and so.name in %(sales_order)s"
+		qb.from_(so)
-
+		.join(soi)
-	if filters.get("status"):
+		.on(soi.parent == so.name)
-		conditions += " and so.status in %(status)s"
+		.left_join(sii)
-
+		.on((sii.so_detail == soi.name) & (sii.docstatus == 1))
-	if filters.get("warehouse"):
+		.select(
-		conditions += " and soi.warehouse = %(warehouse)s"
+			so.transaction_date.as_("date"),
-
+			soi.delivery_date.as_("delivery_date"),
-	return conditions
+			so.name.as_("sales_order"),
-
+			so.status,
-
+			so.customer,
-def get_data(conditions, filters):
+			soi.item_code,
-	data = frappe.db.sql(
+			delay.as_("delay_days"),
-		f"""
+			Case().when(so.status.isin(["Completed", "To Bill"]), 0).else_(delay).as_("delay"),
-		SELECT
+			soi.qty,
-			so.transaction_date as date,
+			soi.delivered_qty,
-			soi.delivery_date as delivery_date,
+			(soi.qty - soi.delivered_qty).as_("pending_qty"),
-			so.name as sales_order,
+			Coalesce(Sum(sii.qty), 0).as_("billed_qty"),
-			so.status, so.customer, soi.item_code,
+			soi.base_amount.as_("amount"),
-			DATEDIFF(CURRENT_DATE, soi.delivery_date) as delay_days,
+			(soi.delivered_qty * soi.base_rate).as_("delivered_qty_amount"),
-			IF(so.status in ('Completed','To Bill'), 0, (SELECT delay_days)) as delay,
+			(soi.billed_amt * conversion_rate).as_("billed_amount"),
-			soi.qty, soi.delivered_qty,
+			(soi.base_amount - (soi.billed_amt * conversion_rate)).as_("pending_amount"),
-			(soi.qty - soi.delivered_qty) AS pending_qty,
+			soi.warehouse.as_("warehouse"),
-			IFNULL(SUM(sii.qty), 0) as billed_qty,
+			so.company,
-			soi.base_amount as amount,
+			soi.name,
-			(soi.delivered_qty * soi.base_rate) as delivered_qty_amount,
+			soi.description.as_("description"),
-			(soi.billed_amt * IFNULL(so.conversion_rate, 1)) as billed_amount,
+		)
-			(soi.base_amount - (soi.billed_amt * IFNULL(so.conversion_rate, 1))) as pending_amount,
+		.where((so.status.notin(["Stopped", "On Hold"])) & (so.docstatus == 1))
-			soi.warehouse as warehouse,
+		.groupby(soi.name, so.name)
-			so.company, soi.name,
+		.orderby(so.transaction_date)
-			soi.description as description
+		.orderby(soi.item_code)
-		FROM
-			`tabSales Order` so,
-			`tabSales Order Item` soi
-		LEFT JOIN `tabSales Invoice Item` sii
-			ON sii.so_detail = soi.name and sii.docstatus = 1
-		WHERE
-			soi.parent = so.name
-			and so.status not in ('Stopped', 'On Hold')
-			and so.docstatus = 1
-			{conditions}
-		GROUP BY soi.name
-		ORDER BY so.transaction_date ASC, soi.item_code ASC
-	""",
-		filters,
-		as_dict=1,
 	)
 
-	return data
+	if filters.get("from_date") and filters.get("to_date"):
+		query = query.where(so.transaction_date[filters.get("from_date") : filters.get("to_date")])
+	if filters.get("company"):
+		query = query.where(so.company == filters.get("company"))
+	if filters.get("sales_order"):
+		query = query.where(so.name.isin(filters.get("sales_order")))
+	if filters.get("status"):
+		query = query.where(so.status.isin(filters.get("status")))
+	if filters.get("warehouse"):
+		query = query.where(soi.warehouse == filters.get("warehouse"))
+
+	return query.run(as_dict=True)
 
 
 def get_so_elapsed_time(data):
@@ -112,7 +113,17 @@ def get_so_elapsed_time(data):
 		dn = qb.DocType("Delivery Note")
 		dni = qb.DocType("Delivery Note Item")
 
-		to_seconds = CustomFunction("TO_SECONDS", ["date"])
+		# TO_SECONDS is MariaDB-only. On postgres, subtracting dates yields days, so multiply
+		# by 86400 for the equivalent second delta. so.transaction_date is neither aggregated nor
+		# in the GROUP BY, but it is selectable under postgres' strict GROUP BY because it is
+		# functionally dependent on the grouped so.name (a doctype's `name` is always the PK).
+		if frappe.db.db_type == "postgres":
+			elapsed_seconds = ((Max(dn.posting_date) - so.transaction_date) * 86400).as_("elapsed_seconds")
+		else:
+			to_seconds = CustomFunction("TO_SECONDS", ["date"])
+			elapsed_seconds = (to_seconds(Max(dn.posting_date)) - to_seconds(so.transaction_date)).as_(
+				"elapsed_seconds"
+			)
 
 		query = (
 			qb.from_(so)
@@ -125,11 +136,11 @@ def get_so_elapsed_time(data):
 			.select(
 				so.name.as_("sales_order"),
 				soi.item_code.as_("so_item_code"),
-				(to_seconds(Max(dn.posting_date)) - to_seconds(so.transaction_date)).as_("elapsed_seconds"),
+				elapsed_seconds,
 			)
 			.where((so.name.isin(sales_orders)) & (dn.docstatus == 1))
 			.orderby(so.name, soi.name)
-			.groupby(soi.name)
+			.groupby(soi.name, so.name)
 		)
 		dn_elapsed_time = query.run(as_dict=True)