Skip to content

Document jsondb-core 1.1.63 - #9

Merged
FarooqKhan merged 1 commit into
masterfrom
release-1.1.63
Nov 18, 2026
Merged

FarooqKhan merged 1 commit into
masterfrom
release-1.1.63

Conversation

@FarooqKhan

Copy link
Copy Markdown
Contributor

Updates the site for jsondb-core 1.1.63, the version on Maven Central since 2026-11-18.

Where to look

Review closely

  • src/content/docs/guides/jsondbtemplate.md: new "Surviving a crash" section. Check the claims: writes are flushed before the rename; a returned write can still be lost on a power cut unless setSyncFolderOnWrite(true) is on; and folder sync has no effect on Windows. The last one comes from the JsonWriter.syncDirectory javadoc.
  • src/content/docs/guides/crud.md: a new paragraph says any write that can't be saved throws JsonDBException and leaves the collection unchanged. The 1.1.16 misspelt-name warning becomes one sentence.
  • src/content/docs/reference/upgrading.md:
    • retitled "Upgrading";
    • the JsonDBException bullet now covers 1.1.63's new cases;
    • four 1.1.63 fixes are added to "Bugs fixed";
    • there's a new "From 1.1.16" section.
  • src/content/docs/guides/documents.md: documents inserted without an id are stored under a random UUID, but the object you pass keeps its null id.

Skim

  • guides/file-change-listeners.md, start/quick-start.mdx: the 1.1.16 warnings are removed.

Safe to skip

  • The version bumps from 1.1.16 to 1.1.63:
    • index.mdx (the pill and both snippets);
    • installation.mdx;
    • astro.config.mjs (the Javadoc link, which returns 200);
    • xpath-cheatsheet.md and the CodeAndFile.astro comment (both are claims that the code was run against this version; see below).
  • "New in 1.1.16" and "since 1.1.16" stay as they are, because they're history, not the current version.

How it was checked

  • Every snippet was re-run against io.jsondb:jsondb-core:1.1.63 from Maven Central. This used the same scratch harness as New documentation site: Astro + Starlight, indigo theme, new icon #8 (not committed), compiled with --release 8, and all 129 checks pass.
  • Old checks that asserted the 1.1.16 bugs were changed to the fixed behaviour. New checks cover:
    • misspelt names on all four writes;
    • id-less inserts, single and batch, including after a reload;
    • setSyncFolderOnWrite;
    • writes into a read-only folder throwing JsonDBException, with no change in memory or on disk and no .tmp file left;
    • re-adding a listener, which receives events again.
  • The landing page's users.json output is byte-for-byte the same in 1.1.63.
  • npm run build passes, and the links validator reports all internal links valid, anchors included.

What this does not do

  • It doesn't say that thrown errors are no longer logged, although the 1.1.63 release notes say so. In practice, a write into a read-only folder still logs ERROR io.jsondb.io.JsonWriter - Failed to create temporary file for collection users with a stack trace, then throws. That looks like a jsondb-core issue, so the site says nothing about it either way.
  • It doesn't mention the two deprecations (JsonWriter.renameKeyInJsonFile() and Util.setFieldValueForEntity()). The site never documented either method.
  • Not yet checked in a browser by a person.

Bump the current version, drop the warnings about the 1.1.16 bugs that 1.1.63 fixes, and document setSyncFolderOnWrite and the JsonDBException now thrown when a write can't be saved.
@FarooqKhan
FarooqKhan merged commit b493040 into master Nov 18, 2026
2 checks passed
@FarooqKhan
FarooqKhan deleted the release-1.1.63 branch November 18, 2026 19:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant