Custom code generation using statementToCode stops after first disabled block.

[stefan-stanca]

Check for duplicates

• I have searched for similar issues before opening a new one.

Description

We've recently upgraded from v10x to v12.3.0 and noticed strange behavior with our json generation logic. Our json generator for procedures_defreturn uses the following:
const branch = generator.statementToCode(block, "STACK");

statementToCode no longer continues after it encounters a disabled statement and it ignores any enabled statements that come after that. I could not find anything in the release notice documenting this change. Below is a simple example to replicate the issue:

<xml xmlns="https://developers.google.com/blockly/xml"><variables><variable id="st;R3Gv?hZO%gen/D,DD\">test</variable></variables><block type="procedures_defreturn" id="X9dKT|eT3]ebKyUClC6f" deletable="false" editable="false" x="350" y="150"><field name="NAME">test</field><comment pinned="false" h="80" w="160">Describe this function...</comment><statement name="STACK"><block type="controls_if" id="0`5}e{BBT{nYvzo}ORJW" disabled-reasons="user%20action"><next><block type="variables_set_dynamic" id="^^vGa8uiHh`4*49qXGhL"><field name="VAR" id="st;R3Gv?hZO%gen/D,DD">test</field><value name="VALUE"><block type="text" id="^(nef#JuKjwP7*wW-d%("><field name="TEXT"></field></block></value></block></next></block></statement><value name="RETURN"><block type="text" id="(krxy}_(hXRVy8%f8.^g"><field name="TEXT"></field></block></value></block></xml>

Reproduction steps

1. Create a workspace with a procedures_defreturn block and define a custom json generator, add 2 statements and disable the first.
2. Call generator.statementToCode(block, "STACK"); in the json generator.
3. Notice the second statement is ommited from the final output.

Stack trace

Screenshots

No response

Browsers

No response

[cpcallen]

Hi @stefan-stanca. Thanks for this bug report!

Unfortunately I am unable to reproduce this with the given information. I tried reconstructing the block arrangement you gave (after reformatting your XML so I could paste it into the playground), and it appears to generate the correct output—at least in JavaScript—despite the disabled block, and despite the JavaScript block generator function for procecudres_defreturn including the following code:

  if (block.getInput('STACK')) {
    // The 'procedures_defreturn' block might not have a STACK input.
    branch = generator.statementToCode(block, 'STACK');
  }

Here are some thing that would be helpful:

• Can you tell us what version of Blockly is the last known one to work correctly? We did a major refactor of the code generators between v10.1.3 and v10.2.0; if it was working in v10.0.0 but broken in the current version then I would expect the break probably occurred between those two versions.
• Can you please supply the full source code for your custom procedures_defreturn block generator function?
• Have you done anything to the Generator or <Language>Generator classes that might interfere with the correct operation of the code in Generator.prototype.blockToCode that handles disabled blocks?

[stefan-stanca]

@cpcallen

export const jsonGenerator = new Generator("JSON") as unknown as JSONGenerator;
const BlocklyJSON = jsonGenerator;
...
BlocklyJSON.forBlock.procedures_defreturn = function (block: Block, generator: JSONGenerator) {
  // Define a procedure with a return value.

  const funcName = block.getFieldValue("NAME");
  const branch = generator.statementToCode(block, "STACK");
  const returnValue = generator.valueToCode(block, "RETURN", BlocklyJSON.ORDER_NONE) || "";
  const args: BlocklyVariableDefinition[] = [];
  const variables = block.getVarModels();

  for (let i = 0; i < variables.length; i++) {
    args.push({
      //name: variables[i].getName(),
      name: generator.getVariableName(variables[i].getId()),
      type: variables[i].getType(),
    });
  }

  const codeObj: IFunctionDefinition = {
    name: funcName,
    params: args,
    logic: JSON.parse(`[${branch ?? ""}]`),
    return: returnValue && JSON.parse(returnValue),
  };

  BlocklyJSON.definitions.functions.push(codeObj);
  return JSON.stringify(codeObj);
};

For brevity i have omitted the generators for other blocks.

Last known version was 10.0.x and we have upgraded directly to v.12.3.x

Have you done anything to the Generator or Generator classes that might interfere with the correct operation of [the code in Generator.prototype.blockToCode that handles disabled blocks]
No we have not overriden blockToCode anywhere. We also use javascript generators and they work fine. The problem is with the json generator.

By the way, block.isEnabled() is no longer a sufficient check for a block to be disabled as it does not check if the block is disabled by its parent. This was also a breaking change we struggled with. The correct way to check now is:
b.isEnabled() && !b.getInheritedDisabled() .In my opinion this is also a bug as previously isEnabled() would return correct when the block was disabled by a parent.