Checkpoint Workflow Hooks

Before proceeding, test your understanding:

1. What are workflow hooks and why are they useful?

   Workflow hooks are injection points in Medusa’s core workflows where you can add custom logic. They allow you to extend core functionality (like product creation) without forking Medusa’s code. When a core workflow reaches a hook point, it executes all registered hook subscribers, allowing your custom code to run as part of the standard flow.

2. Why do we need both a step function AND a compensation function in the hook?

   Hook subscribers are treated as workflow steps, which means they need compensation for rollback. If product creation succeeds and the link is created, but a later step fails (e.g., inventory allocation), the compensation function removes the link to maintain data consistency. This ensures links are only persisted when the entire product creation succeeds.

3. What is additional_data and why do we use it?

   additional_data is a flexible object in Medusa’s core workflows that allows you to pass custom data without modifying core workflow types. For product creation, we use it to pass brand_id from the API request to our hook subscriber. This is the standard pattern for extending core workflows with custom parameters.

4. Why do we need to configure additional_data validation in middleware?

   Without validation configuration, Medusa won’t allow brand_id in the request body - it would be filtered out or cause validation errors. The additionalDataValidator in middleware tells Medusa “it’s okay to accept brand_id in additional_data” and validates it against your schema before the request reaches the workflow.

Implementation Check

Let me verify your implementation. Please share the following:

1. Hook Subscriber File

Show me your src/workflows/hooks/product-brand-link.ts file (or wherever you defined the hook).

Key things to check:

• Not done: Imports createProductsWorkflow from “@medusajs/medusa/core-flows”
• Not done: Imports StepResponse from “@medusajs/framework/workflows-sdk”
• Not done: Imports ContainerRegistrationKeys from “@medusajs/framework/utils”
• Not done: Calls createProductsWorkflow.hooks.productsCreated()
• Not done: Hook has async step function: async ({ products, additional_data }, { container }) => { ... }
• Not done: Hook has async compensation function: async (links, { container }) => { ... }
• Not done: Step function:
  • Resolves link service: container.resolve(ContainerRegistrationKeys.LINK)
  • Extracts brand_id from additional_data
  • Creates links using link.create()
  • Returns new StepResponse(links, links)
• Not done: Compensation function:
  • Checks if links exist: if (!links?.length) return
  • Resolves link service
  • Dismisses links: link.dismiss(links)

2. Middleware Configuration

Show me your src/api/middlewares.ts file (specifically the POST /admin/products configuration).

Key things to check:

• Not done: Imports createFindParams, createOperatorMap from “@medusajs/medusa/api/utils/validators”
• Not done: Defines CreateProductSchema or similar with Zod
• Not done: Schema includes additional_data field:

  typescriptCopy

  additional_data: z.object({
    brand_id: z.string().optional(),
  }).optional()

• Not done: Route configuration:
  • Matcher: "/admin/products"
  • Method: "POST"
  • Uses validateAndTransformBody() with schema and additionalDataValidator
  • Example:

  typescriptCopy

  validateAndTransformBody(CreateProductSchema, {
    additionalDataValidator: {
      brand_id: z.string(),
    },
  })

3. Test: Create Product with Brand

With dev server running, test creating a product with brand_id:

Replace brand_... with an actual brand ID from your database (use the Nike brand you created in Lesson 1).

Expected output: Product should be created successfully with a product ID.

Common Issues

“Hook not executing” / Link not created

Symptom: Product is created but link doesn’t exist

Causes and Fixes:

Cause 1: Hook file not in the right location

• Fix: Ensure file is in src/workflows/ directory (Medusa auto-discovers hooks here)
• Fix: Restart dev server after creating hook file

Cause 2: brand_id not passed in request

• Fix: Include additional_data: { brand_id: "..." } in POST body

Cause 3: additional_data validation not configured

• Fix: Check middleware configuration (see below)

Cause 4: Hook has syntax errors

• Fix: Check server logs for errors

“Validation error: additional_data not allowed”

Symptom: 400 error when posting with additional_data

Cause: Middleware not configured to accept additional_data

Fix: In src/api/middlewares.ts, add configuration for POST /admin/products:

Testing Checklist

Verify each of these steps:

• Not done: Hook file created in src/workflows/ directory
• Not done: Server starts without hook-related errors
• Not done: Middleware configured for POST /admin/products with additionalDataValidator
• Not done: Build succeeds: npm run build

Architecture Understanding

At this point, you should understand:

How hooks extend core workflows:

Why this matters:

• No forking: You don’t modify Medusa’s code
• Upgrade safe: Your hooks continue to work when Medusa updates
• Composable: Multiple hooks can subscribe to the same point
• Rollback included: Your hook gets automatic compensation

Example: If inventory allocation (step 4) fails:

1. Medusa calls your hook’s compensation function
2. Your hook removes the brand-product link
3. Medusa calls product creation compensation
4. Product is deleted from database
5. Everything is rolled back - all or nothing

Next Steps

Once this checkpoint passes:

1. Module Link defined
2. Workflow Hook consuming productsCreated
3. Next: Query Linked Records (Part 3 of Lesson 2)

The link is now created automatically when products are created. Next, we’ll learn how to query linked data to retrieve brands with their products and vice versa.

Ready to continue? Let me know when all checks pass, and we’ll move on to querying linked records.