Support NextJS edge runtime #618

marcusschiesser · 2024-03-07T04:18:45Z

This PR is working with NextJS edge run-time (tested with Chat LlamaIndex (using pnpm build && pnpm start - pnpm dev doesn't work yet))

Changes:

Make core edge compatible
Removed non-edge compatible deps

Next steps:
Discuss how to deal with non-edge compatible deps - see comments

changeset-bot · 2024-03-07T04:18:48Z

🦋 Changeset detected

Latest commit: afc000b

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 2 packages

Name	Type
llamaindex	Patch
@llamaindex/experimental	Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

vercel · 2024-03-07T04:18:51Z

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
llama-index-ts-docs	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Mar 18, 2024 8:06am

packages/core/src/readers/SimpleDirectoryReader.ts

packages/core/src/storage/index.ts

packages/core/src/readers/SimpleDirectoryReader.ts

packages/core/src/readers/index.ts

himself65

My suggestion would be change "index.edge-ligtht.js" and only export core module.

But no matter how, this would need more effort because need to change many path import

himself65 · 2024-03-07T05:31:41Z

But no matter how, this would need more effort because we need to change many path import

For example, some files would indirectly import vectorStore.js

index.edge-light.js -> ... -> verctorStore.js

packages/core/package.json

marcusschiesser · 2024-03-13T04:27:36Z

packages/edge/package.json

+  "exports": {
+    "./readers/SimpleDirectoryReader": {
+      "import": {
+        "types": "./dist/type/readers/SimpleDirectoryReader.edge.d.ts",


We could call this EdgeDirectoryReader then we won't need this edge specific export

marcusschiesser · 2024-03-13T04:28:36Z

packages/edge/package.json

+  "license": "MIT",
+  "type": "module",
+  "dependencies": {
+    "@anthropic-ai/sdk": "^0.15.0",


best we generate this file from core/package.json and copy its dependencies and version

marcusschiesser · 2024-03-13T04:29:23Z

packages/core/src/index.ts

-export * from "./objects/index.js";
-export * from "./postprocessors/index.js";
-export * from "./prompts/index.js";
+export * from "./index.edge.js";
 export * from "./readers/index.js";


here's the trick: edge is neither importing readers nor storage

himself65

seems not working

himself65 · 2024-03-18T02:57:55Z

packages/edge/package.json

@@ -0,0 +1,80 @@
+{


Is this package empty?

yes, idea is to just copy the build from core and then use different exports in this package

himself65 · 2024-03-18T02:59:37Z

packages/core/src/index.edge.ts

@@ -0,0 +1,31 @@
+export * from "./ChatHistory.js";


This seems to work, but might need test to make sure won't have regression

himself65 · 2024-03-18T04:24:50Z

seems not working

working, but some deps seem not correct

marcusschiesser · 2024-03-18T04:28:55Z

packages/core/e2e/test-edge-runtime/package.json

+    "lint": "next lint"
+  },
+  "dependencies": {
+    "llamaindex": "workspace:*",


should use @llamaindex/edge package

marcusschiesser · 2024-03-18T04:43:59Z

packages/core/package.json

@@ -60,14 +60,12 @@
    ".": {
      "import": {
        "types": "./dist/type/index.d.ts",
+        "edge-light": "./dist/index.edge.js",


@himself65 the idea is that @llamaindex/edge is working with edge, but llamaindex is not - that's why i removed edge-light from the core package

marcusschiesser marked this pull request as draft March 7, 2024 04:19

vercel bot deployed to Preview March 7, 2024 04:20 View deployment

marcusschiesser commented Mar 7, 2024

View reviewed changes

packages/core/src/readers/SimpleDirectoryReader.ts Outdated Show resolved Hide resolved

marcusschiesser commented Mar 7, 2024

View reviewed changes

packages/core/src/storage/index.ts Outdated Show resolved Hide resolved

marcusschiesser commented Mar 7, 2024

View reviewed changes

packages/core/src/readers/SimpleDirectoryReader.ts Show resolved Hide resolved

marcusschiesser commented Mar 7, 2024

View reviewed changes

packages/core/src/readers/index.ts Outdated Show resolved Hide resolved

marcusschiesser mentioned this pull request Mar 7, 2024

multiple js runtime support #387

Closed

himself65 reviewed Mar 7, 2024

View reviewed changes

marcusschiesser force-pushed the ms/use-edge-run-time branch from abace24 to d977285 Compare March 11, 2024 09:29

vercel bot deployed to Preview March 11, 2024 09:31 View deployment

marcusschiesser commented Mar 11, 2024

View reviewed changes

packages/core/package.json Outdated Show resolved Hide resolved

marcusschiesser force-pushed the ms/use-edge-run-time branch from d977285 to fda0dec Compare March 13, 2024 04:22

vercel bot had a problem deploying to Preview March 13, 2024 04:23 Failure

marcusschiesser commented Mar 13, 2024

View reviewed changes

vercel bot had a problem deploying to Preview March 13, 2024 04:32 Failure

vercel bot deployed to Preview March 13, 2024 07:39 View deployment

marcusschiesser force-pushed the ms/use-edge-run-time branch from c81d7b2 to b113df4 Compare March 13, 2024 09:22

vercel bot deployed to Preview March 13, 2024 09:24 View deployment

himself65 changed the title ~~Support NextJS edge run time~~ Support NextJS edge runtime Mar 18, 2024

himself65 requested changes Mar 18, 2024

View reviewed changes

marcusschiesser commented Mar 18, 2024

View reviewed changes

vercel bot deployed to Preview March 18, 2024 04:39 View deployment

marcusschiesser commented Mar 18, 2024

View reviewed changes

fix: make core edge compatible

7faa048

marcusschiesser added 4 commits March 18, 2024 13:38

feat: add edge specific code

c537c97

feat: add edge package

568b84a

docs(changeset): Add support for edge runtime by using @llamaindex/edge

6d71681

fix build

38fb668

marcusschiesser force-pushed the ms/use-edge-run-time branch from 9cdff64 to 0c8d7fb Compare March 18, 2024 06:52

vercel bot deployed to Preview March 18, 2024 07:13 View deployment

test: added edge e2e test (thanks @himself65)

20c85f8

marcusschiesser force-pushed the ms/use-edge-run-time branch from 0c8d7fb to 20c85f8 Compare March 18, 2024 07:29

vercel bot deployed to Preview March 18, 2024 07:48 View deployment

chore: ensure version and deps for release

afc000b

vercel bot deployed to Preview March 18, 2024 08:06 View deployment

marcusschiesser marked this pull request as ready for review March 18, 2024 08:13

marcusschiesser merged commit 259c842 into main Mar 18, 2024
13 checks passed

marcusschiesser deleted the ms/use-edge-run-time branch March 18, 2024 08:13

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Support NextJS edge runtime #618

Support NextJS edge runtime #618

marcusschiesser commented Mar 7, 2024 •

edited

Loading

changeset-bot bot commented Mar 7, 2024 •

edited

Loading

vercel bot commented Mar 7, 2024 •

edited

Loading

himself65 left a comment

himself65 commented Mar 7, 2024

marcusschiesser Mar 13, 2024

marcusschiesser Mar 13, 2024

marcusschiesser Mar 13, 2024

himself65 left a comment

himself65 Mar 18, 2024

marcusschiesser Mar 18, 2024

himself65 Mar 18, 2024

himself65 commented Mar 18, 2024

marcusschiesser Mar 18, 2024

marcusschiesser Mar 18, 2024

Support NextJS edge runtime #618

Support NextJS edge runtime #618

Conversation

marcusschiesser commented Mar 7, 2024 • edited Loading

changeset-bot bot commented Mar 7, 2024 • edited Loading

🦋 Changeset detected

vercel bot commented Mar 7, 2024 • edited Loading

himself65 left a comment

Choose a reason for hiding this comment

himself65 commented Mar 7, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

himself65 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

himself65 commented Mar 18, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

marcusschiesser commented Mar 7, 2024 •

edited

Loading

changeset-bot bot commented Mar 7, 2024 •

edited

Loading

vercel bot commented Mar 7, 2024 •

edited

Loading