DiscoveryVIP / Apps Script AcademyHelp

97. Designing an application architecture

Module 20 · 20 minutes · Lesson 96; earlier service and JavaScript fundamentals

Open Interactive Lesson

Discover

How can you use designing an application architecture without changing the wrong data?

Predict

Which values or resources will change, and which should stay unchanged? Write your prediction before execution.

Understand

Write down the path from input to validation to side effects and audit output. Choose where data lives, which identity executes and how retries behave. A graph helps expose dependencies but is not proof of correctness. This example validates an architecture contract before allowing a report stage. The workflow builder runs supported graph nodes against actual local state.

Example 1: Working automation

The dependency check catches a workflow that writes before review even though it contains all stages.

function main() {
  const stages = ["read", "validate", "transform", "review", "write"];
  const review = stages.indexOf("review");
  const write = stages.indexOf("write");
  if (review < 0 || review > write) throw new Error("Review must precede write");
  console.log(stages.join(" → "));
}
Important line explanations
Line 1: function main() {
Define a named block of instructions. Run Script calls main; helpers run only when called.
Line 2: const stages = ["read", "validate", "transform", "review", "write"];
Initialize a local binding. const prevents reassignment of that binding, but does not freeze a referenced object.
Line 3: const review = stages.indexOf("review");
Initialize a local binding. const prevents reassignment of that binding, but does not freeze a referenced object.
Line 4: const write = stages.indexOf("write");
Initialize a local binding. const prevents reassignment of that binding, but does not freeze a referenced object.
Line 5: if (review < 0 || review > write) throw new Error("Review must precede write");
Reject the current operation with an explicit error instead of silently continuing on invalid assumptions.
Line 6: console.log(stages.join(" → "));
Record diagnostic evidence. A log does not grant permissions or prove a later side effect succeeded.
Line 7: }
Close the current block. Indentation makes scope and the function boundary visible.
Exact expected output and resource
{
  "logs": [
    "read \u2192 validate \u2192 transform \u2192 review \u2192 write"
  ],
  "error": null,
  "resource": "logs",
  "value": null
}

Example 2: Investigate a reproducible failure

Predict the effect of "transform", "write", "review" and identify the first mismatch. This example is intentionally faulty.

function main() {
  const stages = ["read", "validate", "transform", "write", "review"];
  const review = stages.indexOf("review");
  const write = stages.indexOf("write");
  if (review < 0 || review > write) throw new Error("Review must precede write");
  console.log(stages.join(" → "));
}
Important line explanations
Line 1: function main() {
Define a named block of instructions. Run Script calls main; helpers run only when called.
Line 2: const stages = ["read", "validate", "transform", "write", "review"];
Initialize a local binding. const prevents reassignment of that binding, but does not freeze a referenced object.
Line 3: const review = stages.indexOf("review");
Initialize a local binding. const prevents reassignment of that binding, but does not freeze a referenced object.
Line 4: const write = stages.indexOf("write");
Initialize a local binding. const prevents reassignment of that binding, but does not freeze a referenced object.
Line 5: if (review < 0 || review > write) throw new Error("Review must precede write");
Reject the current operation with an explicit error instead of silently continuing on invalid assumptions.
Line 6: console.log(stages.join(" → "));
Record diagnostic evidence. A log does not grant permissions or prove a later side effect succeeded.
Line 7: }
Close the current block. Indentation makes scope and the function boundary visible.
Exact expected output and resource
{
  "logs": [],
  "error": "Review must precede write",
  "resource": "logs",
  "value": null
}

Example 3: Separate setup from execution and inspect repeat behavior

Call the same named operation twice. Compare outputs and resource counts to learn whether this operation is idempotent. Repeated creation is deliberately visible; real exports require a rerun policy.

function lessonAction() {
  const stages = ["read", "validate", "transform", "review", "write"];
  const review = stages.indexOf("review");
  const write = stages.indexOf("write");
  if (review < 0 || review > write) throw new Error("Review must precede write");
  console.log(stages.join(" → "));
}
function main() {
  lessonAction();
  lessonAction();
}
Important line explanations
Line 1: function lessonAction() {
Define a named block of instructions. Run Script calls main; helpers run only when called.
Line 2: const stages = ["read", "validate", "transform", "review", "write"];
Initialize a local binding. const prevents reassignment of that binding, but does not freeze a referenced object.
Line 3: const review = stages.indexOf("review");
Initialize a local binding. const prevents reassignment of that binding, but does not freeze a referenced object.
Line 4: const write = stages.indexOf("write");
Initialize a local binding. const prevents reassignment of that binding, but does not freeze a referenced object.
Line 5: if (review < 0 || review > write) throw new Error("Review must precede write");
Reject the current operation with an explicit error instead of silently continuing on invalid assumptions.
Line 6: console.log(stages.join(" → "));
Record diagnostic evidence. A log does not grant permissions or prove a later side effect succeeded.
Line 7: }
Close the current block. Indentation makes scope and the function boundary visible.
Line 8: function main() {
Define a named block of instructions. Run Script calls main; helpers run only when called.
Line 9: lessonAction();
Follow this operation using the surrounding named values. Compare the actual recorded state with the lesson’s specific explanation below.
Line 10: lessonAction();
Follow this operation using the surrounding named values. Compare the actual recorded state with the lesson’s specific explanation below.
Line 11: }
Close the current block. Indentation makes scope and the function boundary visible.
Exact expected output and resource
{
  "logs": [
    "read \u2192 validate \u2192 transform \u2192 review \u2192 write",
    "read \u2192 validate \u2192 transform \u2192 review \u2192 write"
  ],
  "error": null,
  "resource": "logs",
  "value": null
}

Example 4: Add a diagnostic boundary around the operation

Observe start, successful completion or a rethrown failure. This optional professional pattern adds error context without swallowing the error or rolling back changes.

function lessonAction() {
  const stages = ["read", "validate", "transform", "review", "write"];
  const review = stages.indexOf("review");
  const write = stages.indexOf("write");
  if (review < 0 || review > write) throw new Error("Review must precede write");
  console.log(stages.join(" → "));
}
function main() {
  console.log("Start: Designing an application architecture");
  try { lessonAction(); console.log("Completed operation"); }
  catch(error) { console.error("Failed operation: " + error.message); throw error; }
}
Important line explanations
Line 1: function lessonAction() {
Define a named block of instructions. Run Script calls main; helpers run only when called.
Line 2: const stages = ["read", "validate", "transform", "review", "write"];
Initialize a local binding. const prevents reassignment of that binding, but does not freeze a referenced object.
Line 3: const review = stages.indexOf("review");
Initialize a local binding. const prevents reassignment of that binding, but does not freeze a referenced object.
Line 4: const write = stages.indexOf("write");
Initialize a local binding. const prevents reassignment of that binding, but does not freeze a referenced object.
Line 5: if (review < 0 || review > write) throw new Error("Review must precede write");
Reject the current operation with an explicit error instead of silently continuing on invalid assumptions.
Line 6: console.log(stages.join(" → "));
Record diagnostic evidence. A log does not grant permissions or prove a later side effect succeeded.
Line 7: }
Close the current block. Indentation makes scope and the function boundary visible.
Line 8: function main() {
Define a named block of instructions. Run Script calls main; helpers run only when called.
Line 9: console.log("Start: Designing an application architecture");
Record diagnostic evidence. A log does not grant permissions or prove a later side effect succeeded.
Line 10: try { lessonAction(); console.log("Completed operation"); }
Record diagnostic evidence. A log does not grant permissions or prove a later side effect succeeded.
Line 11: catch(error) { console.error("Failed operation: " + error.message); throw error; }
Record diagnostic evidence. A log does not grant permissions or prove a later side effect succeeded.
Line 12: }
Close the current block. Indentation makes scope and the function boundary visible.
Exact expected output and resource
{
  "logs": [
    "Start: Designing an application architecture",
    "read \u2192 validate \u2192 transform \u2192 review \u2192 write",
    "Completed operation"
  ],
  "error": null,
  "resource": "logs",
  "value": null
}

Build and test

Repair the supplied script so that: The dependency check catches a workflow that writes before review even though it contains all stages. Preserve other source data. Checks compare observable output and the named resource, not exact source text.

function main() {
  const stages = ["read", "validate", "transform", "write", "review"];
  const review = stages.indexOf("review");
  const write = stages.indexOf("write");
  if (review < 0 || review > write) throw new Error("Review must precede write");
  console.log(stages.join(" → "));
}

Graduated hints

Hint 1

Inspect the operation containing "transform", "write", "review". Compare it with the stated rule and the first mismatch.

Hint 2

The repair concerns "transform", "review", "write". Change only the relevant argument, operator or method; rerun with fresh input.

Hint 3

The reference uses "transform", "review", "write" where the broken source uses "transform", "write", "review". Explain why before applying it.

Reference solution

function main() {
  const stages = ["read", "validate", "transform", "review", "write"];
  const review = stages.indexOf("review");
  const write = stages.indexOf("write");
  if (review < 0 || review > write) throw new Error("Review must precede write");
  console.log(stages.join(" → "));
}

Explain and reflect

Which operation proves the intended result in designing an application architecture? Which wrong input would expose a weakness, and what would remain unchanged?

Adapt the calculation or validation to a second realistic case. Write its expected result before running. Demonstrate one invalid case and explain whether the side effects should be rolled back or retried.

Troubleshooting

If the console is empty, inspect the logs preview: this script may work through state changes. If the function is missing, select main. For a service error inspect the first failed timeline entry and its arguments. Use Manual unless investigating a trigger. Changing input data also changes the expected result; restore sample data before the authored checks.

Knowledge check

Explain the key method or operator. Give an exact output for a second input, plus one invalid case. Verify the result in the interactive lesson; written explanations need self or educator review.

Optional AI practice

Explain this concept using the source above. Help implement one small extension and define its tests. Review/debug the source using its actual expected output; cite real method references and never claim execution.

Transfer to Google and authorization guide

Next lesson: Building a multi-service solution