6192161735

Committed 15 Sep 2023 12:06AM UTC coverage: 88.51% (-0.04%) from 88.549%

Build # 6192161735

Build Type

push

github

Committed by

web-flow

Commit Message

Update required parts for build orders (#5542) (#5543)

- When a BomItem is created or edited, update any active build orders which use it
- Runs as a background task
- Fixes https://github.com/inventree/InvenTree/issues/5541

(cherry picked from commit c8021ec31)

Co-authored-by: Oliver <oliver.henry.walters@gmail.com>

Run Details

17 of 17 new or added lines in 3 files covered. (100.0%)

26838 of 30322 relevant lines covered (88.51%)

0.89 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

56.9

/InvenTree/build/tasks.py

"""Background task definitions for the BuildOrder app"""

from datetime import datetime, timedelta
from decimal import Decimal
import logging

from django.utils.translation import gettext_lazy as _
from django.template.loader import render_to_string

from allauth.account.models import EmailAddress

from plugin.events import trigger_event
import common.notifications
import build.models
import InvenTree.email
import InvenTree.helpers_model
import InvenTree.tasks
from InvenTree.status_codes import BuildStatusGroups
from InvenTree.ready import isImportingData

import part.models as part_models


logger = logging.getLogger('inventree')


def update_build_order_lines(bom_item_pk: int):
    """Update all BuildOrderLineItem objects which reference a particular BomItem.

    This task is triggered when a BomItem is created or updated.
    """

    logger.info(f"Updating build order lines for BomItem {bom_item_pk}")

    bom_item = part_models.BomItem.objects.filter(pk=bom_item_pk).first()

    # If the BomItem has been deleted, there is nothing to do
    if not bom_item:
        return

    assemblies = bom_item.get_assemblies()

    # Find all active builds which reference any of the parts
    builds = build.models.Build.objects.filter(
        part__in=list(assemblies),
        status__in=BuildStatusGroups.ACTIVE_CODES
    )

    # Iterate through each build, and update the relevant line items
    for bo in builds:
        # Try to find a matching build order line
        line = build.models.BuildLine.objects.filter(
            build=bo,
            bom_item=bom_item,
        ).first()

        q = bom_item.get_required_quantity(bo.quantity)

        if line:
            # Ensure quantity is correct
            if line.quantity != q:
                line.quantity = q
                line.save()
        else:
            # Create a new line item
            build.models.BuildLine.objects.create(
                build=bo,
                bom_item=bom_item,
                quantity=q,
            )

    if builds.count() > 0:
        logger.info(f"Updated {builds.count()} build orders for part {bom_item.part}")


def check_build_stock(build: build.models.Build):
    """Check the required stock for a newly created build order.

    Send an email out to any subscribed users if stock is low.
    """
    # Do not notify if we are importing data
    if isImportingData():
        return

    # Iterate through each of the parts required for this build

    lines = []

    if not build:
        logger.error("Invalid build passed to 'build.tasks.check_build_stock'")
        return

    try:
        part = build.part
    except part_models.Part.DoesNotExist:
        # Note: This error may be thrown during unit testing...
        logger.error("Invalid build.part passed to 'build.tasks.check_build_stock'")
        return

    for bom_item in part.get_bom_items():

        sub_part = bom_item.sub_part

        # The 'in stock' quantity depends on whether the bom_item allows variants
        in_stock = sub_part.get_stock_count(include_variants=bom_item.allow_variants)

        allocated = sub_part.allocation_count()

        available = max(0, in_stock - allocated)

        required = Decimal(bom_item.quantity) * Decimal(build.quantity)

        if available < required:
            # There is not sufficient stock for this part

            lines.append({
                'link': InvenTree.helpers_model.construct_absolute_url(sub_part.get_absolute_url()),
                'part': sub_part,
                'in_stock': in_stock,
                'allocated': allocated,
                'available': available,
                'required': required,
            })

    if len(lines) == 0:
        # Nothing to do
        return

    # Are there any users subscribed to these parts?
    subscribers = build.part.get_subscribers()

    emails = EmailAddress.objects.filter(
        user__in=subscribers,
    )

    if len(emails) > 0:

        logger.info(f"Notifying users of stock required for build {build.pk}")

        context = {
            'link': InvenTree.helpers_model.construct_absolute_url(build.get_absolute_url()),
            'build': build,
            'part': build.part,
            'lines': lines,
        }

        # Render the HTML message
        html_message = render_to_string('email/build_order_required_stock.html', context)

        subject = _("Stock required for build order")

        recipients = emails.values_list('email', flat=True)

        InvenTree.email.send_email(subject, '', recipients, html_message=html_message)


def notify_overdue_build_order(bo: build.models.Build):
    """Notify appropriate users that a Build has just become 'overdue'"""

    targets = []

    if bo.issued_by:
        targets.append(bo.issued_by)

    if bo.responsible:
        targets.append(bo.responsible)

    name = _('Overdue Build Order')

    context = {
        'order': bo,
        'name': name,
        'message': _(f"Build order {bo} is now overdue"),
        'link': InvenTree.helpers_model.construct_absolute_url(
            bo.get_absolute_url(),
        ),
        'template': {
            'html': 'email/overdue_build_order.html',
            'subject': name,
        }
    }

    event_name = 'build.overdue_build_order'

    # Send a notification to the appropriate users
    common.notifications.trigger_notification(
        bo,
        event_name,
        targets=targets,
        context=context
    )

    # Register a matching event to the plugin system
    trigger_event(event_name, build_order=bo.pk)


@InvenTree.tasks.scheduled_task(InvenTree.tasks.ScheduledTask.DAILY)
def check_overdue_build_orders():
    """Check if any outstanding BuildOrders have just become overdue

    - This check is performed daily
    - Look at the 'target_date' of any outstanding BuildOrder objects
    - If the 'target_date' expired *yesterday* then the order is just out of date
    """

    yesterday = datetime.now().date() - timedelta(days=1)

    overdue_orders = build.models.Build.objects.filter(
        target_date=yesterday,
        status__in=BuildStatusGroups.ACTIVE_CODES
    )

    for bo in overdue_orders:
        notify_overdue_build_order(bo)

1	"""Background task definitions for the BuildOrder app"""
2
3	from datetime import datetime, timedelta
4	from decimal import Decimal
5	import logging
6
7	from django.utils.translation import gettext_lazy as _
8	from django.template.loader import render_to_string
9
10	from allauth.account.models import EmailAddress
11
12	from plugin.events import trigger_event
13	import common.notifications
14	import build.models
15	import InvenTree.email
16	import InvenTree.helpers_model
17	import InvenTree.tasks
18	from InvenTree.status_codes import BuildStatusGroups
19	from InvenTree.ready import isImportingData
20
21	import part.models as part_models
22
23
24	logger = logging.getLogger('inventree')
25
26
27	def update_build_order_lines(bom_item_pk: int):
28	"""Update all BuildOrderLineItem objects which reference a particular BomItem.
29
30	This task is triggered when a BomItem is created or updated.
31	"""
32
33	logger.info(f"Updating build order lines for BomItem {bom_item_pk}")	×
34
35	bom_item = part_models.BomItem.objects.filter(pk=bom_item_pk).first()	×
36
37	# If the BomItem has been deleted, there is nothing to do
38	if not bom_item:	×
39	return	×
40
41	assemblies = bom_item.get_assemblies()	×
42
43	# Find all active builds which reference any of the parts
44	builds = build.models.Build.objects.filter(
45	part__in=list(assemblies),
46	status__in=BuildStatusGroups.ACTIVE_CODES
47	)
48
49	# Iterate through each build, and update the relevant line items
50	for bo in builds:	×
51	# Try to find a matching build order line
52	line = build.models.BuildLine.objects.filter(
53	build=bo,
54	bom_item=bom_item,
55	).first()
56
57	q = bom_item.get_required_quantity(bo.quantity)	×
58
59	if line:	×
60	# Ensure quantity is correct
61	if line.quantity != q:	×
62	line.quantity = q	×
63	line.save()	×
64	else:	×
65	# Create a new line item
66	build.models.BuildLine.objects.create(
67	build=bo,
68	bom_item=bom_item,
69	quantity=q,
70	)
71
72	if builds.count() > 0:	×
73	logger.info(f"Updated {builds.count()} build orders for part {bom_item.part}")	×
74
75
76	def check_build_stock(build: build.models.Build):	1✔
77	"""Check the required stock for a newly created build order.
78
79	Send an email out to any subscribed users if stock is low.
80	"""
81	# Do not notify if we are importing data
82	if isImportingData():	1✔
83	return	×
84
85	# Iterate through each of the parts required for this build
86
87	lines = []	1✔
88
89	if not build:	1✔
90	logger.error("Invalid build passed to 'build.tasks.check_build_stock'")	×
91	return	×
92
93	try:	1✔
94	part = build.part	1✔
95	except part_models.Part.DoesNotExist:	×
96	# Note: This error may be thrown during unit testing...
97	logger.error("Invalid build.part passed to 'build.tasks.check_build_stock'")	×
98	return	×
99
100	for bom_item in part.get_bom_items():	1✔
101
102	sub_part = bom_item.sub_part	1✔
103
104	# The 'in stock' quantity depends on whether the bom_item allows variants
105	in_stock = sub_part.get_stock_count(include_variants=bom_item.allow_variants)	1✔
106
107	allocated = sub_part.allocation_count()	1✔
108
109	available = max(0, in_stock - allocated)	1✔
110
111	required = Decimal(bom_item.quantity) * Decimal(build.quantity)	1✔
112
113	if available < required:	1✔
114	# There is not sufficient stock for this part
115
116	lines.append({	1✔
117	'link': InvenTree.helpers_model.construct_absolute_url(sub_part.get_absolute_url()),	1✔
118	'part': sub_part,	1✔
119	'in_stock': in_stock,	1✔
120	'allocated': allocated,	1✔
121	'available': available,	1✔
122	'required': required,	1✔
123	})
124
125	if len(lines) == 0:	1✔
126	# Nothing to do
127	return	1✔
128
129	# Are there any users subscribed to these parts?
130	subscribers = build.part.get_subscribers()	1✔
131
132	emails = EmailAddress.objects.filter(	1✔
133	user__in=subscribers,	1✔
134	)
135
136	if len(emails) > 0:	1✔
137
138	logger.info(f"Notifying users of stock required for build {build.pk}")	×
139
140	context = {
141	'link': InvenTree.helpers_model.construct_absolute_url(build.get_absolute_url()),
142	'build': build,
143	'part': build.part,
144	'lines': lines,
145	}
146
147	# Render the HTML message
148	html_message = render_to_string('email/build_order_required_stock.html', context)	×
149
150	subject = _("Stock required for build order")	×
151
152	recipients = emails.values_list('email', flat=True)	×
153
154	InvenTree.email.send_email(subject, '', recipients, html_message=html_message)	×
155
156
157	def notify_overdue_build_order(bo: build.models.Build):	1✔
158	"""Notify appropriate users that a Build has just become 'overdue'"""
159
160	targets = []
161
162	if bo.issued_by:
163	targets.append(bo.issued_by)
164
165	if bo.responsible:
166	targets.append(bo.responsible)
167
168	name = _('Overdue Build Order')
169
170	context = {
171	'order': bo,
172	'name': name,
173	'message': _(f"Build order {bo} is now overdue"),
174	'link': InvenTree.helpers_model.construct_absolute_url(
175	bo.get_absolute_url(),
176	),
177	'template': {
178	'html': 'email/overdue_build_order.html',
179	'subject': name,
180	}
181	}
182
183	event_name = 'build.overdue_build_order'
184
185	# Send a notification to the appropriate users
186	common.notifications.trigger_notification(
187	bo,
188	event_name,
189	targets=targets,
190	context=context
191	)
192
193	# Register a matching event to the plugin system
194	trigger_event(event_name, build_order=bo.pk)
195
196
197	@InvenTree.tasks.scheduled_task(InvenTree.tasks.ScheduledTask.DAILY)
198	def check_overdue_build_orders():
199	"""Check if any outstanding BuildOrders have just become overdue
200
201	- This check is performed daily
202	- Look at the 'target_date' of any outstanding BuildOrder objects
203	- If the 'target_date' expired yesterday then the order is just out of date
204	"""
205
206	yesterday = datetime.now().date() - timedelta(days=1)	1✔
207
208	overdue_orders = build.models.Build.objects.filter(	1✔
209	target_date=yesterday,	1✔
210	status__in=BuildStatusGroups.ACTIVE_CODES	1✔
211	)
212
213	for bo in overdue_orders:	1✔
214	notify_overdue_build_order(bo)	1✔

inventree / InvenTree / 6192161735

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous