Test Indexer: Add utilities to read/write entities in-between processing

[DZakh]

const indexer = createTestIndexer();

const user: User = {
  id: "test-user-1",
  address: "0x1234",
  updatesCountOnUserForTesting: 5,
  gravatar_id: undefined,
  accountType: "USER",
};

// Set entity
indexer.User.set(user);

// Get entity
const retrieved = await indexer.User.get("test-user-1");
assert.deepEqual(retrieved, user);

await indexer.process({...}) // The user value will be available from handlers

Summary by CodeRabbit

• New Features

  • Added direct entity get/set methods on the test indexer, with safeguards to block access during active processing.

• Tests

  • Added tests covering storage, retrieval, overwrite behavior, and error handling when access occurs during processing.

• Documentation

  • Updated ReScript guidance to recommend explicit type annotations when using the magic casting utility.

_{✏️ Tip: You can customize this high-level summary in your review settings.}

[coderabbitai]

📝 Walkthrough

Walkthrough

A new public API exposes per-entity get and set operations on TestIndexer, implemented in type declarations and ReScript and guarded to error if invoked while the indexer is processing; unit tests and a small docs note were added.

Changes

Cohort / File(s)	Summary
Type Definitions codegenerator/cli/npm/envio/index.d.ts	Added EntityOps<Entity> type (get/set) and augmented TestIndexerFromConfig<Config> with a mapped type exposing per-entity EntityOps.
ReScript Implementation codegenerator/cli/npm/envio/src/TestIndexer.res	Added makeEntityGet and makeEntitySet with state checks, introduced entityOps type, and wired per-entity ops into makeCreateTestIndexer result (excluded internal entities).
Tests scenarios/test_codegen/test/EventHandler_test.ts	Added tests for Entity.set/Entity.get normal behavior, overwrite behavior, undefined for missing, and error cases when called during processing.
Docs AGENTS.md	Added note about using Utils.magic with explicit type annotations in ReScript examples.

Sequence Diagram(s)

mermaid
sequenceDiagram
participant Client as Client
participant TestIndexer as TestIndexer
participant Store as EntityStore
rect rgba(200,200,255,0.5)
Client->>TestIndexer: call Entity.get(id) / Entity.set(entity)
TestIndexer->>TestIndexer: check processing state
alt processing running
TestIndexer-->>Client: throw/error "cannot access while processing"
else not processing
TestIndexer->>Store: read/write entity by id
Store-->>TestIndexer: return entity / ack
TestIndexer-->>Client: return result
end
end

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~25 minutes

Possibly related PRs

• Add proper TypeScript types for TestIndexer changes #920 — Modifies TestIndexerFromConfig surface and entity exposure; closely related to the type-surface changes here.

Suggested reviewers

• JonoPrest
• JasoonS

Poem

🐰 I nibble bytes in moonlit code,

I hop where entities abode,
Get and set with gentle paw,
But not while engines hum and draw —
Safe and snug, your data's stowed.

🚥 Pre-merge checks | ✅ 3

✅ Passed checks (3 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title accurately describes the main change: adding utilities (get/set methods) to read and write entities in the TestIndexer between processing cycles.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[JonoPrest]

Can we add explicit types for the type casting in this function?

[DZakh]

Done

[JonoPrest]

Great looks good 🙏🏼

Non blocking but would prefer we always have explicit types for casting to make it easier to evolve code.