toga-ai 1.0.250 → 1.0.251
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
|
@@ -13,7 +13,7 @@
|
|
|
13
13
|
| [Etilize Catalog Item Import & Refresh](features/etilize-catalog-item-import.md) | Client-generic catalog onboarding from an S3 CSV plus an Etilize re-pull. | worker2/Worker/Etilize/Items.php |
|
|
14
14
|
| [Etilize Item Translation Import](features/etilize-item-translation-import.md) | The abstract worker class `_Worker_Etilize_ItemTranslations` imports **non-English** item text from Etilize into the client's `ItemTranslations` table. | worker2/Worker/Etilize/ItemTranslations.php |
|
|
15
15
|
| [Monitoring Framework (Orchestrator + Child Monitors)](features/monitoring-framework.md) | A unified, DB-driven monitoring framework for business-critical data flows (Compass POs, Prudential asset imports, AIG closed claims, …). | worker2/Worker/Monitor.php, worker2/Worker/Monitors/, worker2/Worker/Monitors/RateEntitlement.php, worker2/Worker/Notification/Email.php, worker2/Worker/Rate.php, dbchanges2/Core/2026-05-21 - Monitors.sql, dbchanges2/Core/2026-06-29a - Rate Entitlement Contract Monitor.sql |
|
|
16
|
-
| [NetSuite
|
|
16
|
+
| [NetSuite ↔ ClickUp / TOGA Opportunity Sync (API Message Queue + worker2 webhook)](features/netsuite-opportunity-sync.md) | Outbound sync from NetSuite to TOGA for the record types the Forecast2 importer pulls (opportunities first; sales/items/etc. | worker2/Worker/Netsuite.php, worker2/Worker/Netsuite/Opportunity.php, worker2/Worker/Clickup.php, worker2/Worker/Clickup/Opportunity.php, worker2/Controller/Index.php, _underscore/Worker.php, test/@dave/NetSuite/api-message-queue/lib_amq_queue.js, test/@dave/NetSuite/api-message-queue/ue_api_msg_queue_enqueue.js, test/@dave/NetSuite/api-message-queue/ue_amq_drain.js, test/@dave/NetSuite/api-message-queue/ss_amq_drain.js, test/@dave/NetSuite/api-message-queue/DEPLOY_RUNBOOK.md, test/@dave/clickup/backfill_opportunity_numbers.php, test/@dave/clickup/probe_opportunity_fields.php, test/@dave/probe_clickup_desc_match.php, test/@dave/test_model_load_behavior.php, dbchanges2/Forecast/2026-06-25a - Add unique index on Opportunities netsuiteOpportunityInternalId.sql, worker/crons/toga2/forecast2/common_import_sales_from_netsuite.php |
|
|
17
17
|
| [NetSuite → Forecast Open-Orders Sync (salesOrder webhook → OpenOrderItems)](features/netsuite-salesorder-open-orders-sync.md) | Webhook-driven, single-record port of the legacy open-orders importer (TRUE-79142). | worker2/Worker/Netsuite/SalesOrder.php, worker2/Worker/Netsuite.php, test/@dave/probe_salesorder_rest_shape.php, test/@dave/probe_open_order_lines.php, test/@dave/check_so_status.php, test/@dave/check_so_history.php, test/@dave/probe_so_rest_lines.php, test/@dave/probe_missing_oo_timing.php, test/@dave/probe_missing_oo_createdby.php, test/@dave/probe_drift_so_dates.php, test/@dave/probe_open_order_gating.php, worker/crons/toga2/forecast2/import_open_orders.php, worker/crons/toga2/forecast2/common_import_sales_from_netsuite.php |
|
|
18
18
|
| [NetSuite Supporting-Record Webhook Importer (the reusable recipe)](features/netsuite-supporting-record-webhook-importer.md) | A single **repeatable recipe** for porting a legacy daily-pull NetSuite *supporting-record* importer (the lookup/dimension tables behind Forecast2 — Employees, | worker2/Worker/Netsuite/Employee.php, worker2/Worker/Netsuite/Account.php, worker2/Worker/Netsuite/Classification.php, worker2/Worker/Netsuite/Customer.php, worker2/Worker/Netsuite/Item.php, worker2/Worker/Netsuite.php, _underscore/Model/Forecast/Employee.php, _underscore/Model/Forecast/Account.php, _underscore/Model/Forecast/Classification.php, _underscore/Component/Forecast/Db/Db.php, test/@dave/test_employee_lifecycle.php, test/@dave/test_account_lifecycle.php, test/@dave/test_classification_lifecycle.php, test/@dave/NetSuite/api-message-queue/ue_api_msg_queue_enqueue.js, worker/crons/toga2/forecast2/import_supporting_records.php |
|
|
19
19
|
| [Background Email-Template Worker (_Worker_Notification_EmailTemplate)](features/notification-email-template.md) | `_Worker_Notification_EmailTemplate::Send(...)` dispatches a **stored, client-defined `EmailTemplates` row off-thread** as a background WorkerJob. | worker2/Worker/Notification/EmailTemplate.php, _underscore/Model/Client/EmailTemplate.php |
|
|
@@ -1,16 +1,18 @@
|
|
|
1
1
|
---
|
|
2
|
-
title: NetSuite
|
|
2
|
+
title: NetSuite ↔ ClickUp / TOGA Opportunity Sync (API Message Queue + worker2 webhook)
|
|
3
3
|
framework: "2.0"
|
|
4
4
|
repo: worker2
|
|
5
5
|
project: Worker
|
|
6
6
|
client: shared
|
|
7
7
|
type: feature
|
|
8
8
|
status: active
|
|
9
|
-
updated: 2026-06-
|
|
9
|
+
updated: 2026-06-30
|
|
10
10
|
owners: ["dfranks"]
|
|
11
11
|
files:
|
|
12
12
|
- worker2/Worker/Netsuite.php
|
|
13
13
|
- worker2/Worker/Netsuite/Opportunity.php
|
|
14
|
+
- worker2/Worker/Clickup.php
|
|
15
|
+
- worker2/Worker/Clickup/Opportunity.php
|
|
14
16
|
- worker2/Controller/Index.php
|
|
15
17
|
- _underscore/Worker.php
|
|
16
18
|
- test/@dave/NetSuite/api-message-queue/lib_amq_queue.js
|
|
@@ -38,7 +40,10 @@ Outbound sync from NetSuite to TOGA for the record types the Forecast2 importer
|
|
|
38
40
|
record ("API Message Queue"), a scheduled SuiteScript drains it to
|
|
39
41
|
`webhook.togahub.com/netsuite`, and worker2 routes it to a per-recordType handler that upserts
|
|
40
42
|
into the `Forecast` DB. The legacy NetSuite→ClickUp opportunity-task creation is preserved as a
|
|
41
|
-
second, independently-gated concern in the same handler.
|
|
43
|
+
second, independently-gated concern in the same handler. As of 2026-06-30 (TRUE-79181) the ClickUp leg
|
|
44
|
+
is **bidirectional for field + stage**: ClickUp task edits flow back to the linked NetSuite opportunity
|
|
45
|
+
(`_Worker_Clickup_Opportunity`, update-only), and NS→CU now drives the ClickUp task **status** — see
|
|
46
|
+
the "CU→NS direction" section.
|
|
42
47
|
|
|
43
48
|
## Key files / entry points
|
|
44
49
|
|
|
@@ -364,29 +369,106 @@ None — platform-wide Forecast sync.
|
|
|
364
369
|
(doubled-prefix ids — see the doubled-id gotcha), which are **SuiteQL-queryable** for after-the-fact
|
|
365
370
|
diagnosis even though the calling-script log rolls off.
|
|
366
371
|
|
|
367
|
-
## CU→NS direction (
|
|
372
|
+
## CU→NS direction (BUILT 2026-06-30, TRUE-79181): reverse sync
|
|
368
373
|
|
|
369
|
-
The
|
|
370
|
-
|
|
371
|
-
|
|
372
|
-
before comparing-to / writing-to NetSuite:
|
|
374
|
+
The integration is now **bidirectional** for **field + stage**. ClickUp task edits flow back to the
|
|
375
|
+
linked NetSuite opportunity via a new handler, and NS→CU now drives the ClickUp task **status** (not
|
|
376
|
+
just description text).
|
|
373
377
|
|
|
374
|
-
|
|
375
|
-
|
|
376
|
-
|
|
377
|
-
|
|
378
|
-
-
|
|
379
|
-
`NetSuite Internal ID:` line. Company / Amount / Expected Close / Stage are NS-derived display, not
|
|
380
|
-
ClickUp-authored — parse them out and ignore.
|
|
381
|
-
- **Custom fields** are already discrete — no extraction.
|
|
378
|
+
**Handler:** `_Worker_Clickup_Opportunity` (`worker2/Worker/Clickup/Opportunity.php`) — an abstract
|
|
379
|
+
static-class worker, dispatched by `_Worker_Clickup::Webhook` via
|
|
380
|
+
`_Worker::runTask('Clickup/Opportunity/Process', {taskId,event,data})`. Routing is gated by the ClickUp
|
|
381
|
+
**LIST id** (Presales Qualification list `901111987449`) for `taskUpdated`/`taskStatusUpdated` events;
|
|
382
|
+
non-opportunity lists fall through to the legacy sprint handling in `Clickup.php`.
|
|
382
383
|
|
|
383
|
-
|
|
384
|
-
|
|
385
|
-
|
|
386
|
-
`
|
|
387
|
-
|
|
384
|
+
**CU→NS is UPDATE-ONLY** (never create/delete):
|
|
385
|
+
1. Resolve the linked NS opportunity from the task's `Opportunity #` custom field
|
|
386
|
+
(`a5529cdc-8dbb-4165-8bc5-9f5cc691796a`, = NS `tranId`) via a one-row SuiteQL
|
|
387
|
+
`SELECT id FROM transaction WHERE type='Opprtnty' AND tranid='<n>'`.
|
|
388
|
+
2. GET the opportunity with `expandSubResources=true` — this also supplies the **current** NS values
|
|
389
|
+
for the diff.
|
|
390
|
+
3. **No match → skip.**
|
|
391
|
+
4. PATCH **only** the NS-owned fields that actually differ (currently `title`, `stage`). A no-op write
|
|
392
|
+
fires no NS event, so the write cannot re-trigger NS→CU. **Echo prevention is the difference-check
|
|
393
|
+
alone** — there is no actor-identity / "last-synced-from" suppression field (that hardening was
|
|
394
|
+
explicitly deferred; see Decisions).
|
|
395
|
+
|
|
396
|
+
**Shared `STAGE_MAP` — single source of truth, declared on `_Worker_Netsuite_Opportunity`.** Maps NS
|
|
397
|
+
`entityStatus` internalId → ClickUp status on the Presales Qualification list (VERIFIED live 2026-06-30):
|
|
398
|
+
|
|
399
|
+
| NS internalId | NS stage | ClickUp status |
|
|
400
|
+
|---|---|---|
|
|
401
|
+
| 124 | Closed - Won | `opportunity won` |
|
|
402
|
+
| 14 | Closed Lost | `closed lost` |
|
|
403
|
+
| 125/126/122/123/128 | 10% / 25% / 50% / 75% / 95% | `in progress` |
|
|
404
|
+
| 130 | Alternate Quote | *(unmapped)* |
|
|
405
|
+
|
|
406
|
+
**CRITICAL non-1:1 gotcha:** the five probability stages all collapse to `in progress`, so the reverse
|
|
407
|
+
map `CU_STATUS_TO_NS_STAGE` only covers the **unambiguous terminal** stages (won/lost). CU→NS leaves a
|
|
408
|
+
non-terminal status alone rather than guessing a percentage. The percentage-reverse mapping is an
|
|
409
|
+
**unresolved stakeholder (Aaron) decision** — do not invent one.
|
|
410
|
+
|
|
411
|
+
**NS→CU now drives the ClickUp task STATUS** from the NS stage via `STAGE_MAP` (previously the stage was
|
|
412
|
+
only rendered in the description text). Applied on both create and update; the update PUT carries
|
|
413
|
+
**only** the changed fields (`name`/`description`/`status`) to stay echo-safe.
|
|
414
|
+
|
|
415
|
+
**Outbound NS calls** use the `Logs.Api` two-save pattern (`_Model_Core_Logs_Api`, `DB_LOGS`,
|
|
416
|
+
`DIRECTION_OUT`: save the request row, then save the response/failure row), with
|
|
417
|
+
`\Sentry\captureException($e); throw $e;` on failure so `WorkerJobs` records `isSuccess=0`. Logged
|
|
418
|
+
payloads are length-capped. NS access is the **2.0 adapter `_Component_Api_Netsuite`** (GET/PATCH +
|
|
419
|
+
SuiteQL POST with `Prefer: transient`); the **1.0 `App_Api_Netsuite_Rest` / SOAP toolkit are
|
|
420
|
+
deprecated** for production opportunity code.
|
|
421
|
+
|
|
422
|
+
### CU→NS gotchas
|
|
423
|
+
|
|
424
|
+
- **SuiteQL over `_Component_Api_Netsuite` has NO placeholder binding.** When a SuiteQL filter value
|
|
425
|
+
comes from an **external** source (here a ClickUp custom-field `tranId`, not a local PK), sanitize
|
|
426
|
+
with an **allowlist-and-REJECT-on-mismatch**, not strip-and-use:
|
|
427
|
+
`$safe = preg_replace('/[^A-Za-z0-9_-]/','',$v); if ($safe!==$v) return null;`. Reject-on-mismatch is
|
|
428
|
+
the firewall; silently stripping characters is not enough.
|
|
429
|
+
- **Validate `task_id` format at the webhook entry.** ClickUp native task ids are alphanumeric. The
|
|
430
|
+
legacy `_Worker_Clickup::Webhook` interpolates the raw `$payload->task_id` into Team-DB SQL at ~20
|
|
431
|
+
sites (a **pre-existing** SQL-injection exposure, NOT introduced here). A single input-boundary
|
|
432
|
+
format guard at the top of `Webhook()` closes that class for the raw payload id without rewriting
|
|
433
|
+
each query. **FLAG:** the broader legacy `$taskId`/`$customTaskId` raw-SQL interpolation throughout
|
|
434
|
+
`Clickup.php` is real pre-existing debt that warrants a dedicated security ticket.
|
|
435
|
+
- **ClickUp opportunity field ids:** list `901111987449` ("Presales Qualification");
|
|
436
|
+
`Opportunity #` = `a5529cdc-8dbb-4165-8bc5-9f5cc691796a`,
|
|
437
|
+
`Customer #` = `170dc118-b3fa-413b-826b-2753e9405851`.
|
|
438
|
+
|
|
439
|
+
### Deferred (documented follow-up)
|
|
440
|
+
|
|
441
|
+
- **Notes & attachments (CU→NS)** were intentionally deferred — they require NetSuite custom fields
|
|
442
|
+
(`custentity_cu_synced_notes` / `custentity_cu_synced_files`) + a File Cabinet folder that **do not
|
|
443
|
+
exist yet**, plus unconfirmed NS REST note/file shapes. Field + stage sync is bidirectional;
|
|
444
|
+
notes/attachments remain a documented follow-up.
|
|
445
|
+
- **Actor-identity echo hardening** deferred — the difference-check is the current (and sufficient for
|
|
446
|
+
field/stage) echo-prevention mechanism. A "drop events authored by our own integration user" gate is
|
|
447
|
+
the planned hardening if/when no-op-safe writes can't fully cover a future field.
|
|
448
|
+
- **Percentage reverse-mapping** (which NS percentage stage a CU `in progress` should map back to) is
|
|
449
|
+
blocked on the Aaron stakeholder decision noted above.
|
|
388
450
|
|
|
389
451
|
## Change history
|
|
452
|
+
- 2026-06-30 — **Built the CU→NS reverse sync + NS→CU stage drive (TRUE-79181) — integration now
|
|
453
|
+
bidirectional for field + stage.** New `_Worker_Clickup_Opportunity` handler
|
|
454
|
+
(`worker2/Worker/Clickup/Opportunity.php`), dispatched by `_Worker_Clickup::Webhook` via
|
|
455
|
+
`_Worker::runTask('Clickup/Opportunity/Process', …)`, gated by ClickUp **list id `901111987449`** for
|
|
456
|
+
`taskUpdated`/`taskStatusUpdated`. CU→NS is **update-only**: resolve the linked opp by the task's
|
|
457
|
+
`Opportunity #` (= `tranId`) via one-row SuiteQL, GET it (`expandSubResources=true`) for the current
|
|
458
|
+
values, PATCH only the differing NS-owned fields (`title`, `stage`). **Echo prevention = difference-check
|
|
459
|
+
only** (actor-identity hardening explicitly deferred). Added a shared `STAGE_MAP` on
|
|
460
|
+
`_Worker_Netsuite_Opportunity` (NS entityStatus internalId → ClickUp status; VERIFIED live: 124→won,
|
|
461
|
+
14→lost, 125/126/122/123/128→`in progress`, 130 unmapped) — its **five-probability-stages-collapse-to-
|
|
462
|
+
one** non-1:1 means the reverse map covers only the terminal stages; the percentage reverse-mapping is
|
|
463
|
+
an open Aaron decision. NS→CU now also drives the ClickUp task **status** from the stage (was
|
|
464
|
+
description-text only), PUT carrying only changed fields to stay echo-safe. Outbound NS calls use the
|
|
465
|
+
`Logs.Api` two-save OUT pattern + `Sentry::captureException;throw` on failure; NS access via the 2.0
|
|
466
|
+
`_Component_Api_Netsuite` adapter (1.0 `App_Api_Netsuite_Rest`/SOAP deprecated for prod). Gotchas
|
|
467
|
+
recorded: **SuiteQL has no placeholder binding** → external filter values need allowlist-**reject-on-
|
|
468
|
+
mismatch** sanitize; **validate `task_id` format at the webhook boundary** (the legacy `Clickup.php`
|
|
469
|
+
interpolates the raw payload id into Team-DB SQL at ~20 sites — pre-existing injection debt flagged for
|
|
470
|
+
a dedicated security ticket). Notes/attachments CU→NS deferred (need NetSuite custom fields +
|
|
471
|
+
File-Cabinet folder that don't exist yet). (dfranks)
|
|
390
472
|
- 2026-06-25 — **Fixed the Opportunity duplicate-row amplification + added a unique-index guard.**
|
|
391
473
|
Root cause: `_Model::load()` returns TRUE only on an **exactly-one** match (FALSE for 0 *and* 2+),
|
|
392
474
|
so once an nsId had 2 rows the `load()`-then-upsert handler could never re-find it and every
|
package/package.json
CHANGED