Allow extending a serve handler by overriding the existing isProduction

jpwilliams commented 9 months ago

Summary

Allows users to override the existing isProduction check performed by serve handlers, providing their own value (or dynamic value).

[!NOTE] Not specifying the value--or if the value or dynamic value is undefined--will ensure the SDK falls back to using the current production checks.

import { functions, inngest } from "@/inngest";
import { serve } from "inngest/next";

export default serve({
  client: inngest,
  functions,
  // set a static value
  isProduction: false,
});

import { functions, inngest } from "@/inngest";
import { serve } from "inngest/next";

export default serve({
  client: inngest,
  functions,
  // or use an environment variable check
  isProduction: process.env.MY_CUSTOM_VAR === "yes",
});

import { functions, inngest } from "@/inngest";
import { serve } from "inngest/next";

export default serve({
  client: inngest,
  functions,
  // or use a function to calculate the value dynamically
  isProduction: async () => {
    const amIProd = await makeRequestToCheck();
    return amIProd;
  },
});

It's specified on the serve() handler as they already need to be able to decide for themselves whether they're in production mode, as some pieces of the puzzle (like environment variables) are not available until the request enters the system.

Therefore, this is the first part of allowing users to extend existing serve handlers to override pieces of functionality such as production checks, URL creation, or accessing environment variables.

Checklist

[ ] Added a docs PR that references this PR
[ ] Added unit/integration tests
[ ] Added changesets if applicable

inngest / inngest-js

Allow extending a serve handler by overriding the existing isProduction #425

Summary

Checklist

Related

⚠️ No Changeset found