INTPYTHON-377 langgraph-checkpoint-mongodb

.github/scripts/check_diff.py

@@ -2,7 +2,7 @@
 import sys
 from typing import Dict
 
-LIB_DIRS = ["libs/mongodb"]
+LIB_DIRS = ["libs/langgraph-checkpoint-mongodb"]
 
 if __name__ == "__main__":
     files = sys.argv[1:]
@@ -33,14 +33,16 @@
             for dir_ in LIB_DIRS:
                 if file.startswith(dir_):
                     dirs_to_run["test"].add(dir_)
+                if "langgraph-checkpoint-mongodb/tests" not in file:
+                    dirs_to_run["lint"].add(dir_)
         elif file.startswith("libs/"):
             raise ValueError(
                 f"Unknown lib: {file}. check_diff.py likely needs "
                 "an update for this new library!"
             )
 
     outputs = {
-        "dirs-to-lint": list(dirs_to_run["lint"] | dirs_to_run["test"]),
+        "dirs-to-lint": list(dirs_to_run["lint"]),
         "dirs-to-test": list(dirs_to_run["test"]),
     }
     for key, value in outputs.items():

.github/workflows/_compile_integration_test.yml

@@ -36,7 +36,7 @@ jobs:
 
       - name: Install integration dependencies
         shell: bash
-        run: poetry install --with=test_integration,test
+        run: poetry install --with dev
 
       - name: Check integration tests compile
         shell: bash

.github/workflows/_lint.yml

@@ -65,7 +65,7 @@ jobs:
         # It doesn't matter how you change it, any change will cause a cache-bust.
         working-directory: ${{ inputs.working-directory }}
         run: |
-          poetry install --with lint,typing
+          poetry install --with dev
 
       - name: Get .mypy_cache to speed up mypy
         uses: actions/cache@v4
@@ -85,7 +85,7 @@ jobs:
       - name: Install unit+integration test dependencies
         working-directory: ${{ inputs.working-directory }}
         run: |
-          poetry install --with test,test_integration
+          poetry install --with dev
 
       - name: Get .mypy_cache_test to speed up mypy
         uses: actions/cache@v4
@@ -96,7 +96,7 @@ jobs:
             ${{ env.WORKDIR }}/.mypy_cache_test
           key: mypy-test-${{ runner.os }}-${{ runner.arch }}-py${{ matrix.python-version }}-${{ inputs.working-directory }}-${{ hashFiles(format('{0}/poetry.lock', inputs.working-directory)) }}
 
-      - name: Analysing the code with our lint
-        working-directory: ${{ inputs.working-directory }}
-        run: |
-          make lint_tests
+#      - name: Analysing the code with our lint
+#        working-directory: ${{ inputs.working-directory }}
+#        run: |
+#          make lint_tests

.github/workflows/_release.yml

@@ -138,7 +138,7 @@ jobs:
           poetry run python -c "import $IMPORT_NAME; print(dir($IMPORT_NAME))"
 
       - name: Import test dependencies
-        run: poetry install --with test,test_integration
+        run: poetry install --with dev
         working-directory: ${{ inputs.working-directory }}
 
       # Overwrite the local version of the package with the test PyPI version.

.github/workflows/_test.yml

@@ -36,7 +36,10 @@ jobs:
 
       - name: Install dependencies
         shell: bash
-        run: poetry install --with test
+        run: poetry install --with dev
+
+      - name: Start MongoDB
+        uses: supercharge/[email protected]
 
       - name: Run core tests
         shell: bash

README.md

@@ -1,5 +1,9 @@
 # 🦜️🔗 LangChain MongoDB
 
-This repository contains 1 package with MongoDB integrations with LangChain:
+This is a Monorepo containing partner packages of MongoDB and LangChainAI.
+It includes integrations between MongoDB, Atlas, LangChain, and LangGraph.
 
-- [langchain-mongodb](https://pypi.org/project/langchain-mongodb/)
+It contains the following packages.
+
+- `langchain-mongodb` ([PyPI](https://pypi.org/project/langchain-mongodb/))
+- `langgraph-checkpoint-mongodb`

libs/langgraph-checkpoint-mongodb/Makefile

@@ -0,0 +1,42 @@
+.PHONY: test lint format help
+
+######################
+# TESTING AND COVERAGE
+######################
+
+test tests:
+	poetry run pytest tests
+
+######################
+# LINTING AND FORMATTING
+######################
+
+# Define a variable for Python and notebook files.
+PYTHON_FILES=.
+MYPY_CACHE=.mypy_cache
+lint format: PYTHON_FILES=.
+lint_diff format_diff: PYTHON_FILES=$(shell git diff --name-only --relative --diff-filter=d main . | grep -E '\.py$$|\.ipynb$$')
+lint_package: PYTHON_FILES=langgraph
+lint_tests: PYTHON_FILES=tests
+lint_tests: MYPY_CACHE=.mypy_cache_test
+
+lint lint_diff lint_package lint_tests:
+	poetry run ruff check .
+	[ "$(PYTHON_FILES)" = "" ] || poetry run ruff format $(PYTHON_FILES) --diff
+	[ "$(PYTHON_FILES)" = "" ] || poetry run ruff check --select I $(PYTHON_FILES)
+	[ "$(PYTHON_FILES)" = "" ] || mkdir -p $(MYPY_CACHE)
+	[ "$(PYTHON_FILES)" = "" ] || poetry run mypy $(PYTHON_FILES) --cache-dir $(MYPY_CACHE)
+
+format format_diff:
+	poetry run ruff format $(PYTHON_FILES)
+	poetry run ruff check --select I --fix $(PYTHON_FILES)
+
+######################
+# HELP
+######################
+
+help:
+	@echo '----'
+	@echo 'format                       - run code formatters'
+	@echo 'lint                         - run linters'
+	@echo 'test                         - run unit tests'

libs/langgraph-checkpoint-mongodb/README.md

@@ -0,0 +1,95 @@
+# LangGraph Checkpoint MongoDB
+
+Implementation of LangGraph CheckpointSaver that uses MongoDB.
+
+## Usage
+
+```python
+from langgraph.checkpoint.mongodb import MongoDBSaver
+
+write_config = {"configurable": {"thread_id": "1", "checkpoint_ns": ""}}
+read_config = {"configurable": {"thread_id": "1"}}
+
+MONGODB_URI = "mongodb://localhost:27017"
+DB_NAME = "checkpoint_example"
+
+with MongoDBSaver.from_conn_string(MONGODB_URI, DB_NAME) as checkpointer:
+    # call .setup() the first time you're using the checkpointer
+    checkpointer.setup()
+    checkpoint = {
+        "v": 1,
+        "ts": "2024-07-31T20:14:19.804150+00:00",
+        "id": "1ef4f797-8335-6428-8001-8a1503f9b875",
+        "channel_values": {
+            "my_key": "meow",
+            "node": "node"
+        },
+        "channel_versions": {
+            "__start__": 2,
+            "my_key": 3,
+            "start:node": 3,
+            "node": 3
+        },
+        "versions_seen": {
+            "__input__": {},
+            "__start__": {
+            "__start__": 1
+            },
+            "node": {
+            "start:node": 2
+            }
+        },
+        "pending_sends": [],
+    }
+
+    # store checkpoint
+    checkpointer.put(write_config, checkpoint, {}, {})
+
+    # load checkpoint
+    checkpointer.get(read_config)
+
+    # list checkpoints
+    list(checkpointer.list(read_config))
+```
+
+### Async
+
+```python
+from langgraph.checkpoint.pymongo import AsyncMongoDBSaver
+
+async with AsyncMongoDBSaver.from_conn_string(MONGODB_URI) as checkpointer:
+    checkpoint = {
+        "v": 1,
+        "ts": "2024-07-31T20:14:19.804150+00:00",
+        "id": "1ef4f797-8335-6428-8001-8a1503f9b875",
+        "channel_values": {
+            "my_key": "meow",
+            "node": "node"
+        },
+        "channel_versions": {
+            "__start__": 2,
+            "my_key": 3,
+            "start:node": 3,
+            "node": 3
+        },
+        "versions_seen": {
+            "__input__": {},
+            "__start__": {
+            "__start__": 1
+            },
+            "node": {
+            "start:node": 2
+            }
+        },
+        "pending_sends": [],
+    }
+
+    # store checkpoint
+    await checkpointer.aput(write_config, checkpoint, {}, {})
+
+    # load checkpoint
+    await checkpointer.aget(read_config)
+
+    # list checkpoints
+    [c async for c in checkpointer.alist(read_config)]
+```