Skip to content

chore: remove deprecated api #108

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 20 commits into from
Jul 18, 2025
Merged

Conversation

matthewmcneely
Copy link
Member

Description

This PR removes the deprecated generics-based API from modusGraph.

It also establishes a mechanism to set the memory cache (ristretto) size when operating in local mode

Checklist

  • Code compiles correctly and linting passes locally
  • Tests added for new functionality, or regression tests for bug fixes added as applicable

@Copilot Copilot AI review requested due to automatic review settings July 14, 2025 20:37
@matthewmcneely matthewmcneely requested a review from a team as a code owner July 14, 2025 20:37
@matthewmcneely matthewmcneely enabled auto-merge (squash) July 14, 2025 20:38
Copy link
Contributor

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR removes the deprecated generics-based API surfaces and adds a way to configure the embedded database’s in-memory cache size.

  • Remove all generics-based CRUD functions (Create, Get, Upsert, Query, Delete) and their internal helpers under api/
  • Introduce a cacheSizeMB field in Config and Client, a WithCacheSizeMB setter, and propagate it into posting.Init
  • Update tests (package renames, CI invocation) and bump various dependencies in go.mod

Reviewed Changes

Copilot reviewed 30 out of 31 changed files in this pull request and generated no comments.

Show a summary per file
File Description
zero.go Dropped deprecated nextUID method
config.go Added cacheSizeMB, default and WithCacheSizeMB, validation
engine.go Propagate cacheSizeMB into posting.Init
client.go Added cacheSizeMB to client options and key, WithCacheSizeMB
live.go Renamed log keys for data load progress
load_test/live_test.go Set cache size explicitly in live loader test
namespace_test.go Renamed test and switched package to modusgraph_test
vector_test.go, engine_test.go Switched test packages to modusgraph_test
unit_test/… Removed all tests for the old generics API
api/… Removed entire api/ folder (deprecated generics API)
go.mod Bumped versions of dgo, dgraph, and many indirect deps
.github/workflows/ci-go-unit-tests.yaml Adjusted test invocation
Comments suppressed due to low confidence (3)

live.go:85

  • The log field key nquadsProcessed is inconsistent with the variable name nqudsProcessed (missing the 'a'). Consider renaming the variable to nquadsProcessed to avoid confusion.
					"nquadsProcessed", nqudsProcessed,

config.go:14

  • [nitpick] Add a comment explaining the purpose and units of the cacheSizeMB field in Config for better maintainability (e.g., "// cacheSizeMB sets the in-memory posting list cache size in megabytes").
	cacheSizeMB        int

load_test/live_test.go:92

  • [nitpick] There are no tests validating behavior when WithCacheSizeMB is applied (e.g., zero, default, or negative). Consider adding unit tests to verify that the cache size is correctly passed to the engine and that invalid values are rejected.
	conf := modusgraph.NewDefaultConfig(t.TempDir()).WithLogger(logger).WithCacheSizeMB(0)

@matthewmcneely matthewmcneely force-pushed the matthewmcneely/remove-deprecated-api branch from 54055fb to 9411cad Compare July 18, 2025 16:08
@matthewmcneely
Copy link
Member Author

@ryanfoxtyler Can you have a look at this one? Will tag this at v0.2.0 when merged.

@matthewmcneely matthewmcneely merged commit bb9ac86 into main Jul 18, 2025
8 checks passed
@matthewmcneely matthewmcneely deleted the matthewmcneely/remove-deprecated-api branch July 18, 2025 18:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

2 participants