SAP-samples / SAP-samples/codejam-code-based-agents

JavaScript track: exercises 06 and 07 appear to be in the wrong order

Open Beginner friendly
#35 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
54
Forks
36
PR merge metrics
No merged PRs in 30d

Description

Summary

06-discover-connected-crimes.md references code that's only introduced in 07-solve-the-crime.md:

  • Around line 238, it calls this.orchestrationClient.chatCompletion(...), but orchestrationClient as a class field is only declared and constructed in exercise 07's Step 1 (07-solve-the-crime.md, "Add orchestrationClient as a class field and initialize it in the constructor").
  • Around line 213, it instructs learners to add the new node "before leadDetectiveNode" — but leadDetectiveNode is also only created in exercise 07.

Effect

Following the exercises in their numbered order (06 then 07), a learner's investigationWorkflow.ts wouldn't type-check at exercise 06's step — this.orchestrationClient doesn't exist as a class member yet, and leadDetectiveNode doesn't exist to insert before.

Suggested fix

Either:

  1. Swap the exercise order (make current 07's class-field/constructor setup + Lead Detective node come before current 06's Intelligence Researcher node), or
  2. Move the orchestrationClient class-field/constructor setup into exercise 06 itself, and have exercise 07 only add leadDetectiveNode.

Either way, the sequencing needs to match what the code in each step actually depends on.

Environment

Reproduced on a personal SAP AI Core tenant, JavaScript/TypeScript track, exercises 01–07 followed in numbered order.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with 06-discover-connected-crimes.md and 07-solve-the-crime.md, comparing the referenced investigationWorkflow.ts steps and their numbered order. Check that orchestrationClient and leadDetectiveNode are introduced before exercise 06 uses them, then follow exercises 01–07 to confirm the JavaScript/TypeScript workflow type-checks at each step.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript, typescript
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Active
Clarity
Clearly specified
Newbie friendliness
78/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.