Axiomantic Spellbook Async Await Patterns

Invariant Principles

1. Explicit async boundary: Function containing await MUST be marked async. Compiler enforces; no exceptions.
2. Await ALL promises: Every promise-returning call requires await. Missing await = bug.
3. Structured error handling: try-catch wraps async operations. Unhandled rejections crash applications.
4. Pattern consistency: async/await XOR promise chains. Never mix in same function.
5. Parallelism via combinators: Independent operations use Promise.all/allSettled. Sequential only when dependencies exist.

Required Reasoning

1. Is this operation asynchronous? (API calls, file I/O, timers, database queries)
2. Did I mark the containing function as async?
3. Did I use await for every promise-returning operation?
4. Did I add proper try-catch error handling?
5. Did I avoid mixing async/await with .then()/.catch()?
6. Can independent operations run in parallel with Promise.all?

Now write asynchronous code following this checklist.

Core Pattern

async function operationName(): Promise<ReturnType> {
  try {
    const result = await asyncOperation();
    return result;
  } catch (error) {
    throw error; // Handle or rethrow with context
  }
}

Forbidden Patterns: Quick Reference

Forbidden Patterns: Detailed Examples

// BAD
function fetchData() {
  return fetch('/api/data')
    .then(response => response.json())
    .then(data => processData(data))
    .catch(error => handleError(error));
}

// CORRECT
async function fetchData() {
  try {
    const response = await fetch('/api/data');
    const data = await response.json();
    return processData(data);
  } catch (error) {
    handleError(error);
    throw error;
  }
}

// BAD - returns Promise instead of value
async function getData() {
  const data = fetchFromDatabase(); // Forgot await!
  return data.id; // Error: data is a Promise
}

// CORRECT
async function getData() {
  const data = await fetchFromDatabase();
  return data.id;
}

// BAD - SyntaxError
function loadUser() {
  const user = await database.getUser();
  return user;
}

// CORRECT
async function loadUser() {
  const user = await database.getUser();
  return user;
}

// BAD - unhandled promise rejection if save fails
async function saveData(data) {
  const result = await database.save(data);
  return result;
}

// CORRECT
async function saveData(data) {
  try {
    const result = await database.save(data);
    return result;
  } catch (error) {
    console.error('Save failed:', error);
    throw new Error('Failed to save data');
  }
}

// BAD
async function processUser() {
  const user = await getUser();
  return updateUser(user)
    .then(result => result.data)
    .catch(error => console.error(error));
}

// CORRECT
async function processUser() {
  try {
    const user = await getUser();
    const result = await updateUser(user);
    return result.data;
  } catch (error) {
    console.error(error);
    throw error;
  }
}

Parallel vs Sequential

// PARALLEL: independent operations
const [a, b, c] = await Promise.all([fetchA(), fetchB(), fetchC()]);

// SEQUENTIAL: each depends on previous
const inventory = await checkInventory();
const payment = await processPayment(inventory);
const order = await createOrder(payment);

// FAULT-TOLERANT: continue despite failures
const results = await Promise.allSettled([op1(), op2(), op3()]);
// Each result: { status: 'fulfilled', value } or { status: 'rejected', reason }

Complete Real-World Example

async function updateUserProfile(userId: string, updates: ProfileUpdates): Promise<User> {
  try {
    const user = await database.users.findById(userId);

    if (!user) {
      throw new Error(`User ${userId} not found`);
    }

    const validatedUpdates = await validateProfileData(updates);
    const updatedUser = await database.users.update(userId, validatedUpdates);

    await Promise.all([
      notificationService.send(userId, 'Profile updated'),
      auditLog.record('profile_update', { userId, updates: validatedUpdates })
    ]);

    return updatedUser;

  } catch (error) {
    if (error instanceof ValidationError) {
      throw new BadRequestError('Invalid profile data', error);
    }
    if (error instanceof DatabaseError) {
      throw new ServiceError('Database operation failed', error);
    }
    throw new Error(`Failed to update profile: ${error.message}`);
  }
}

Recommended: Python Asyncio Pipeline Architecture

For Python scripts with multiple network requests or I/O operations, consider using asyncio with pipeline queues. This is not mandatory, but works well when a script naturally decomposes into producer/consumer stages:

• Network I/O: 3-5 parallel workers
• File I/O: 2-3 parallel workers
• Rate-limited APIs: Single worker with delays
• Shared state: Single worker or locks

This pattern shines when you have distinct stages (fetch, transform, write) that can overlap. For simple scripts with a handful of sequential requests, asyncio.gather or Promise.all is sufficient.

Self-Check

• Did I mark the function as async?
• Did I use await for EVERY promise-returning operation?
• Did I wrap await operations in try-catch blocks?
• Did I avoid using .then()/.catch() chains?
• Did I avoid mixing async/await with promise chains?
• Did I avoid using callbacks when async/await is available?
• Did I consider whether operations can run in parallel with Promise.all()?
• Did I provide meaningful error messages in catch blocks?
• Does error handling preserve error context?

If NO to ANY item above: STOP. Rewrite using proper async/await before proceeding.

Converted and distributed by TomeVault — claim your Tome and manage your conversions.