[jwrosewell]

The JSON Builder now fails, and sets no JSON, when no Sequence Element has produced a sequence number, as the JSON Builder page says. The rest of what this draft first carried, being the switch for each web integration element, the Sequence Element first and its Element Data, the sequence rules and the JSON exclusions, reached rc through #53, merged as f5763dc1, and rc is merged in here, so this diff holds only what #53 did not.

Problem

On rc, jsonbundler.js read query.sequence straight out of Evidence and treated an absent value as "below 10", so a Pipeline with no Sequence Element still produced JSON, with the sequence silently missing, and listed the JavaScript Properties on every request.

What the specification says

The Sequence number section of json-builder.md at e89679e9, the specifications rc head, says

If no Sequence Element has produced a sequence number when the Element runs, the Element MUST fail with an error and MUST NOT set its JSON value. The error SHOULD say that a Sequence Element needs to be placed before the JSON Builder Element in the Pipeline.

and

A query.sequence value taken from a query string is text and not an integer, so it does not count as a sequence number. An integer that a caller added to query.sequence without a Sequence Element does count in .NET and Java, because the Element reads the integer in Evidence whoever added it.

.NET, 51degrees-python#76 and 51degrees-php#50 fail in the same way, and specifications#80 settled the wording.

What changed

• pipeline/fiftyone.pipeline.core/jsonbundler.js gains getSequence, which reads the Sequence Element's Element Data, falls back to a whole number in query.sequence, and throws "There is no sequence number. A Sequence Element needs to be placed before the JSON Builder Element in the Pipeline." where there is neither. processInternal calls it first, so a Pipeline with no sequence number sets no JSON. The number 10, from which no JavaScript Properties are listed, is the named constant MaxJavaScriptSequence.
• cloudCache.test.js and cloudRequestEngineCredentials.test.js, which came with Give each web integration element its own switch, put Sequence first, and give it element data #53, built their pipelines with only the Sequence Element left out, so the JSON Builder failed every request. They test the Cloud Request Engine, so they now pass addJavaScriptBuilder: false, which leaves out the Sequence Element, the JSON Builder and the JavaScript Builder together. No test of the JSON Builder's rule is relaxed.
• shareUsage.test.js and sessionIdAndSequence.test.js each have a test that leaves out the Sequence Element, and each adds a stand-in element under the sequence data key that gives a sequence number without touching the Evidence, so the JSON Builder in that pipeline has what it needs and what the test checks is unchanged.

Tests

• pipeline/fiftyone.pipeline.core/tests/jsonBuilderSequence.test.js, new, checks that the Element fails and sets no JSON with no Sequence Element, that '3', '', 'abc', 3.5 and null in query.sequence are each not a sequence number, that a whole number a caller added is accepted, and that a Pipeline with a Sequence Element and a default Pipeline both work.

Every temporary run below sits in one workflow file shared by the temporary runs, so its page can carry the name of another branch in its title. Each run's own branch is named here.

• Red, on branch tmp/node-59-red2, run 43005641915, this draft's three changed test files on rc at f5763dc1. 6 of 86 fail, every one in jsonBuilderSequence.test.js ("fails with an error and sets no JSON" and the five values that are not a whole number), and the other two files pass.
• Red for the cloud tests, on branch tmp/node-59-red3, run 43005665570, the merge bc6091e before the test change. 10 of 22 fail in cloudCache.test.js and cloudRequestEngineCredentials.test.js with "Errors occurred during processing of jsonbundler, javascriptbuilder".
• Green, on branch tmp/node-59-green, run 43005681174, the head 99962c9 with those five files and core.test.js, 122 of 122 pass.
• The first full build of this draft, run 42983408288 on 771ad57, failed the same cloud tests for the reason above.
• Full build on the head 99962c9, success, run 43006231028. Configure and the Ubuntu, Ubuntu ARM and Windows jobs on Node 22 and 24 pass, 1061 of 1063 tests with 2 skipped in each, Configure printed "Left out 2 macOS entries", and all 7 Setting 'PullRequestSha' lines are 99962c92f9df62f9ae75ef9d5aab101640ad03c0. rc has since taken #65, which touches only the data update service, and the draft still merges cleanly.

macOS was left out of this draft's full build under the 9 November decision. The rc head is built with macOS before it merges into main.

Not done here

Writing delayexecution only for a Property that has a value, which json-builder.md asks for in its suffix table, is a separate audit row and is not part of this change.