inngest 0.0.0-streaming-20230424112237

package/.changeset/README.md

@@ -0,0 +1,8 @@
+# Changesets
+
+Hello and welcome! This folder has been automatically generated by `@changesets/cli`, a build tool that works
+with multi-package repos, or single-package repos to help you version and publish your code. You can
+find the full documentation for it [in our repository](https://github.com/changesets/changesets)
+
+We have a quick list of common questions to get you started engaging with this project in
+[our documentation](https://github.com/changesets/changesets/blob/main/docs/common-questions.md)

package/.changeset/config.json

@@ -0,0 +1,11 @@
+{
+  "$schema": "https://unpkg.com/@changesets/config@2.3.0/schema.json",
+  "changelog": "@changesets/cli/changelog",
+  "commit": false,
+  "fixed": [],
+  "linked": [],
+  "access": "public",
+  "baseBranch": "main",
+  "updateInternalDependencies": "patch",
+  "ignore": []
+}

package/.devcontainer/devcontainer.json

@@ -0,0 +1,56 @@
+{
+  "image": "mcr.microsoft.com/devcontainers/universal:2",
+  "features": {
+    "ghcr.io/enricosecondulfo/devcontainer-features/volta:1": {}
+  },
+  "customizations": {
+    "vscode": {
+      "settings": {
+        "deno.enablePaths": ["./deno_compat"],
+        "typescript.tsdk": "node_modules/typescript/lib",
+        "eslint.validate": [
+          "javascript",
+          "javascriptreact",
+          "typescript",
+          "typescriptreact",
+          "graphql"
+        ],
+        "editor.rulers": [80],
+        "typescript.format.enable": false,
+        "eslint.format.enable": true,
+        "editor.codeActionsOnSave": {
+          "source.organizeImports": true,
+          "source.fixAll": true
+        },
+        "search.exclude": {
+          "**/dist": true,
+          "**/etc": true
+        },
+        "[javascript]": {
+          "editor.defaultFormatter": "dbaeumer.vscode-eslint"
+        },
+        "[javascriptreact]": {
+          "editor.defaultFormatter": "dbaeumer.vscode-eslint"
+        },
+        "[typescript]": {
+          "editor.defaultFormatter": "dbaeumer.vscode-eslint"
+        },
+        "[typescriptreact]": {
+          "editor.defaultFormatter": "dbaeumer.vscode-eslint"
+        },
+        "[yaml]": {
+          "editor.defaultFormatter": "redhat.vscode-yaml"
+        },
+        "files.eol": "\n"
+      },
+      "extensions": [
+        "dbaeumer.vscode-eslint",
+        "kumar-harsh.graphql-for-vscode",
+        "wix.vscode-import-cost",
+        "esbenp.prettier-vscode",
+        "OfHumanBondage.react-proptypes-intellisense",
+        "redhat.vscode-yaml"
+      ]
+    }
+  }
+}

package/.eslintignore

@@ -0,0 +1 @@
+landing/**/*

package/.eslintrc.js

@@ -0,0 +1,40 @@
+module.exports = {
+  extends: [
+    "eslint:recommended",
+    "plugin:@typescript-eslint/recommended",
+    "plugin:@typescript-eslint/recommended-requiring-type-checking",
+    "prettier",
+    "plugin:prettier/recommended",
+  ],
+  parser: "@typescript-eslint/parser",
+  parserOptions: {
+    tsconfigRootDir: __dirname,
+    project: ["./tsconfig.json"],
+  },
+  plugins: ["@typescript-eslint", "@inngest"],
+  root: true,
+  ignorePatterns: ["dist/", "*.d.ts", "*.js", "deno_compat/"],
+  rules: {
+    "prettier/prettier": "warn",
+    "@inngest/process-warn": "off",
+    "@typescript-eslint/no-unused-vars": [
+      "warn",
+      { varsIgnorePattern: "^_", argsIgnorePattern: "^_" },
+    ],
+  },
+  overrides: [
+    {
+      files: ["src/**/*.ts"],
+      excludedFiles: [
+        "*.d.ts",
+        "*.test.ts",
+        "src/test/**/*",
+        "src/examples/**/*",
+        "src/init.ts",
+      ],
+      rules: {
+        "@inngest/process-warn": "warn",
+      },
+    },
+  ],
+};

package/.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,33 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: "[BUG]"
+labels: bug
+assignees: ""
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce the behavior:
+
+1. Create a function with '...'
+2. Send this event '...'
+3. ...
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Code snippets / Logs / Screenshots**
+If applicable, add screenshots to help explain your problem.
+
+**System info (please complete the following information):**
+
+- OS: [e.g. Mac, Windows]
+- npm package Version [e.g. 0.7.0]
+- Framework [e.g. Next.js, Express]
+- Platform [e.g. Vercel, AWS Lambda]
+
+**Additional context**
+Add any other context about the problem here.

package/.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,19 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: ""
+labels: feature
+assignees: ""
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.

package/.github/actions/setup-and-build/action.yml

@@ -0,0 +1,37 @@
+name: "Setup and build"
+description: "Sets up Node, installs dependencies, and builds the project."
+inputs:
+  working-directory:  # id of input
+    description: 'The directory to run the action in.'
+    required: false
+    default: '.'
+runs:
+  using: composite
+  steps:
+    - uses: volta-cli/action@v4
+
+    - name: Get yarn cache directory path
+      id: yarn-cache-dir-path
+      shell: bash
+      run: echo "dir=$(yarn cache dir)" >> $GITHUB_OUTPUT
+      working-directory: ${{ inputs.working-directory }}
+
+    - uses: actions/cache@v3
+      id: yarn-cache # use this to check for `cache-hit` (`steps.yarn-cache.outputs.cache-hit != 'true'`)
+      with:
+        path: ${{ steps.yarn-cache-dir-path.outputs.dir }}
+        key: ${{ runner.os }}-yarn-${{ hashFiles('**/yarn.lock') }}
+        restore-keys: |
+          ${{ runner.os }}-yarn-
+
+    - shell: bash
+      run: yarn install --frozen-lockfile
+      working-directory: ${{ inputs.working-directory }}
+
+    - shell: bash
+      run: yarn install --frozen-lockfile
+      working-directory: ${{ inputs.working-directory }}/landing
+
+    - shell: bash
+      run: yarn build
+      working-directory: ${{ inputs.working-directory }}

package/.github/workflows/pr.yml

@@ -0,0 +1,248 @@
+name: PR checks
+
+on:
+  pull_request:
+  workflow_dispatch:
+  workflow_call:
+  push:
+    branches:
+      - 'renovate/**'
+
+concurrency:
+  group: pr-${{ github.ref }}
+  cancel-in-progress: true
+
+env:
+  NODE_AUTH_TOKEN: nothing
+
+jobs:
+  test:
+    name: Runtime
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        nodeVersion:
+          - 14
+          - 16
+          - 18
+          - lts
+    steps:
+      - uses: actions/checkout@v3
+      - uses: ./.github/actions/setup-and-build
+      - run: volta run --node ${{ matrix.nodeVersion }} yarn test
+
+  types:
+    name: Types
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        tsVersion:
+         - 'latest'
+         - '~5.0.0'
+         - '~4.9.0'
+         - '~4.8.0'
+         - "~4.7.0"
+    steps:
+      - uses: actions/checkout@v3
+      - uses: ./.github/actions/setup-and-build
+      - run: yarn prelink
+      - run: yarn add -D typescript@${{ matrix.tsVersion }}
+      - run: yarn test:types
+
+  api_diff:
+    name: Local API diff
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: ./.github/actions/setup-and-build
+      - run: yarn run api-extractor run
+
+  lint:
+    name: Lint
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: ./.github/actions/setup-and-build
+      - run: yarn lint
+
+  examples:
+    name: Test examples
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        repo:
+          # - inngest/sdk-example-cloudflare-workers - BROKEN
+          - inngest/sdk-example-nextjs-vercel
+          # - inngest/sdk-example-redwoodjs-vercel - BROKEN
+          - inngest/sdk-example-nextjs-cloudflare
+          - inngest/sdk-example-nextjs-netlify
+          - inngest/sdk-example-remix-vercel
+          - inngest/sdk-example-nuxt-vercel
+    steps:
+      # Checkout the repo
+      - name: Checkout SDK
+        uses: actions/checkout@v3
+        with:
+          path: sdk
+      - uses: ./sdk/.github/actions/setup-and-build
+        with:
+          working-directory: sdk
+
+      # Checkout the example repo
+      - name: Checkout example
+        uses: actions/checkout@v3
+        with:
+          repository: ${{ matrix.repo }}
+          path: examples/${{ matrix.repo }}
+          ref: main
+
+      # Get the SDK ready and link it locally
+      - name: Prepare SDK for linking
+        run: yarn prelink
+        working-directory: sdk
+      - name: Create link to SDK
+        run: yarn link
+        working-directory: sdk/dist
+
+      # If we find a deno.json file in the example repo, we need to pull Deno on
+      # to the toolchain.
+      - name: Check if Deno is used
+        id: deno-check
+        run: echo "isDeno=$(test -f deno.json && echo true || echo false)" >> $GITHUB_OUTPUT
+        working-directory: examples/${{ matrix.repo }}
+      - name: If Deno is used, install it
+        uses: denoland/setup-deno@v1
+        if: ${{ steps.deno-check.outputs.isDeno == 'true' }}
+        with:
+          deno-version: vx.x.x
+
+      # Install dependencies in the example repo
+      - name: Install example dependencies
+        if: ${{ steps.deno-check.outputs.isDeno != 'true' }}
+        run: |
+          if test -f yarn.lock; then
+            yarn install --frozen-lockfile
+          elif test -f package-lock.json; then
+            npm ci
+          fi
+        working-directory: examples/${{ matrix.repo }}
+
+      # Link the SDK, making sure to use the same Yarn version that we used to
+      # create the link.
+      #
+      # Because repos are always owner/repo with a slash, the directory will be
+      # the same, therefore we must venture an extra level deep when searching
+      # for package.json.
+      #
+      # Yarn v3 (berry) will override Volta's version control and always use
+      # whatever version is specified and cached in the repo's `.yarnrc.yml`
+      # file.
+      # Because of this, we must instead link the SDK using a relative path, and
+      # have the library's `dist/` directory appear as a separate package by
+      # specifying an empty `yarn.lock` file within.
+      #
+      # Locally linking the lib to a Deno repo is harder, as Deno doesn't
+      # support local linking between ESM and CJS. Instead, we run a manual
+      # shim script to bend paths and adjust the target repo's import path.
+      - name: Link local SDK to example
+        run: |
+          if test -f deno.json; then
+            deno run --allow-read --allow-write ../../../sdk/deno_compat/link.ts
+          else
+            yarnv=$(volta run --yarn $(cat ../../../sdk/package.json | jq -r .volta.yarn) yarn -v)
+
+            if [[ $yarnv == 3* ]]; then
+              touch ../../../sdk/dist/yarn.lock
+              yarn link ../../../sdk/dist
+            else
+              volta run --yarn $(cat ../../../sdk/package.json | jq -r .volta.yarn) yarn link inngest
+            fi
+          fi
+        working-directory: examples/${{ matrix.repo }}
+
+
+      # Copy any SDK function examples to the example repo so that we're always
+      # testing many functions against many handlers.
+      - name: Find inngest functions path in example
+        id: inngest-functions-path
+        run: echo "dir=$(dirname $(echo \"$(git ls-files | grep inngest/index.ts)))\"" >> $GITHUB_OUTPUT
+        working-directory: examples/${{ matrix.repo }}
+      - name: Remove any existing inngest functions
+        run: rm -rf ${{ steps.inngest-functions-path.outputs.dir }}
+        working-directory: examples/${{ matrix.repo }}
+      - name: Copy functions to test to example
+        run: cp -Tr ../../../sdk/src/examples/ ${{ steps.inngest-functions-path.outputs.dir }}
+        working-directory: examples/${{ matrix.repo }}
+      # IF we're using Deno, also replace any "inngest..." imports with
+      # "npm:inngest..." and any direct file imports in `inngest/index.ts` with
+      # `.ts` suffixes.
+      - name: If Deno, transform imports
+        if: ${{ steps.deno-check.outputs.isDeno == 'true' }}
+        run: |
+          find ${{ steps.inngest-functions-path.outputs.dir }} -type f -name "*.ts" -exec sed -i 's/from "inngest/from "npm:inngest/g' {} \;
+          find ${{ steps.inngest-functions-path.outputs.dir }} -type f -name "*.ts" -exec sed -i -E 's/from "\.(.+)"/from "\.\1\/index\.ts"/g' {} \;
+        working-directory: examples/${{ matrix.repo }}
+
+      # Try to build the example
+      - name: If not Deno, build the example
+        if: ${{ steps.deno-check.outputs.isDeno != 'true' }}
+        run: |
+          if test -f yarn.lock; then
+            yarn build
+          elif test -f package-lock.json; then
+            npm run build
+          fi
+        working-directory: examples/${{ matrix.repo }}
+
+      - name: Run the Inngest dev server
+        run: npx inngest-cli@latest dev > cli.log 2>&1 &
+        working-directory: examples/${{ matrix.repo }}
+        env:
+          DO_NOT_TRACK: 1
+      - name: Wait for the Inngest dev server to start
+        uses: mydea/action-wait-for-api@v1
+        with:
+          url: "http://localhost:8288"
+          timeout: "60"
+
+      # Run the example
+      - name: Run the example's dev server
+        run: |
+          if test -f yarn.lock; then
+            (yarn dev > dev.log 2>&1 &)
+          elif test -f package-lock.json; then
+            (npm run dev > dev.log 2>&1 &)
+          else
+            (deno task start > dev.log 2>&1 &)
+          fi
+        working-directory: examples/${{ matrix.repo }}
+        # Provide the example any env vars it might need
+        env:
+          PORT: 3000
+          DO_NOT_TRACK: 1
+      - name: Wait for the example to start
+        uses: mydea/action-wait-for-api@v1
+        with:
+          url: "http://localhost:3000/api/inngest"
+          timeout: "60"
+
+      # Give the dev server 5 seconds to register with the example
+      # TODO Check logs instead of sleeping
+      - name: Wait 5 seconds for dev server registration
+        run: sleep 5
+
+      # Run the examples test suite against the dev server
+      - name: Run integration test suite
+        run: yarn test:examples
+        working-directory: sdk
+
+      - if: ${{ always() }}
+        run: cat dev.log
+        working-directory: examples/${{ matrix.repo }}
+
+      - if: ${{ always() }}
+        run: cat cli.log
+        working-directory: examples/${{ matrix.repo }}

package/.github/workflows/release.yml

@@ -0,0 +1,31 @@
+name: Release
+
+on:
+  push:
+    branches:
+      - main
+
+concurrency: ${{ github.workflow }}-${{ github.ref }}
+
+env:
+  NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
+
+jobs:
+  release:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+      id-token: write
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          persist-credentials: false
+      - uses: ./.github/actions/setup-and-build
+      - uses: changesets/action@v1
+        id: changesets
+        with:
+          publish: yarn release
+        env:
+          GITHUB_TOKEN: ${{ secrets.CHANGESET_GITHUB_TOKEN }}
+          NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
+          NODE_ENV: test # disable npm access checks; they don't work in CI

package/.vscode/settings.json

@@ -0,0 +1,4 @@
+{
+  "deno.enablePaths": ["./deno_compat"],
+  "typescript.tsdk": "node_modules/typescript/lib"
+}

package/CHANGELOG.md

@@ -0,0 +1,112 @@
+# inngest
+
+## 0.0.0-streaming-20230424112237
+
+### Minor Changes
+
+- a6c573e: INN-1087 Add edge streaming support to `"inngest/next"` serve handler
+
+## 1.7.1
+
+### Patch Changes
+
+- 34b6d39: INN-1240 Add `queueMicrotask()` fallback for restrictive environments
+
+## 1.7.0
+
+### Minor Changes
+
+- c999896: INN-1029 Add `env` option to `Inngest` client to explicitly push to a particular Inngest env
+
+### Patch Changes
+
+- 131727a: Adjust README to have a slightly clearer intro
+- c999896: INN-1186 Send `x-inngest-platform` and `x-inngest-framework` headers during registration
+- 0728308: Expose run ID to function executions for user-managed logging and tracing
+- 3ac579f: Warn users when some functions appear undefined when serving
+- eb1ea34: Allow signing keys with multiple prefixes, as required for branch environment support
+
+## 1.6.1
+
+### Patch Changes
+
+- a840e67: INN-1126 Execute a step early if it's the only pending item during a discovery
+
+  This reduces the number of "Function steps" used for simple step functions.
+
+## 1.6.0
+
+### Minor Changes
+
+- c7d1bee: Add `onFailure` handler to `createFunction` options, allowing you to specify a new function to run when the initial handler fails
+
+## 1.5.4
+
+### Patch Changes
+
+- 071fe89: INN-1054 Ensure serve handlers return `any` instead of `unknown` so that they don't needlessly conflict with user types
+
+## 1.5.3
+
+### Patch Changes
+
+- 906aca5: INN-1009 Show warnings when using the package with TS versions `<4.7.2` and Node versions `<14`
+
+  This includes tests to assert we appropriately support these versions now and in the future.
+
+- ca7d79e: Detect env vars from Node and Deno in serve handlers (INN-1012)
+
+## 1.5.2
+
+### Patch Changes
+
+- 2d6e0b5: Fix infinite type instantiation using a looping type in serve handlers (thanks for the report, @grempe)
+
+## 1.5.1
+
+### Patch Changes
+
+- 0836145: Refactor `InngestCommHandler` to better detect env and reduce duplication (INN-997)
+
+## 1.5.0
+
+### Minor Changes
+
+- ac81320: Add `"inngest/lambda"` serve handler for AWS Lambda environments
+- f73a346: Add `"inngest/edge"` serve handler for use in v8 edge runtimes
+
+## 1.4.1
+
+### Patch Changes
+
+- 43162d3: The "_Connected to `inngest dev`_" pill at the top of the SDK's landing page now links to the connected dev server.
+
+  _Thanks, [**@khill-fbmc**](https://github.com/khill-fbmc)!_
+
+  ![image](https://user-images.githubusercontent.com/1736957/225711717-fdc87dda-b8df-4aa4-a76b-233729f4d547.png)
+
+- 56b8e9a: Removes many `any` types from the internal and public APIs.
+
+  Affects the public API, so will therefore be a package bump, but shouldn't affect any expected areas of use.
+
+- a45601e: Update dependency typescript to v5
+
+  Including a bump for this as it does seem to fix some complex inference for future features.
+
+## 1.4.0
+
+### Minor Changes
+
+- ebb8740: Add ability to control the concurrency of a specific function via the `concurrency` option when creating an Inngest function
+- e61cf0f: Add `cancelOn` option when creating a function, allowing you cancel execution of a function based on incoming events.
+
+## 1.3.5
+
+### Patch Changes
+
+- a4f8ae8: Fixes a typing bug where both `event` and `cron` could be specified as a trigger at the same time.
+
+  Multiple event triggers will be coming in a later update, but not in this format.
+
+- d6a8329: Ensure signatures are not validated during development
+- 950a2bc: Ensure `inngest.send()` and `step.sendEvent()` can be given an empty array without error