Drop Marshal from persistent storage in favour of Deriving_Json

.github/workflows/doc.yml

@@ -26,9 +26,12 @@ on:
         required: false
         default: ""
 
+# Serialise gh-pages writes: a push (rebuilds dev/) and a release
+# workflow_dispatch (freezes <version>/ and repoints latest) must never push to
+# gh-pages at the same time, or the second push fails non-fast-forward.
 concurrency:
-  group: ${{ github.workflow }}-${{ github.head_ref || github.ref }}
-  cancel-in-progress: ${{ github.event_name == 'pull_request' }}
+  group: doc-deploy-${{ github.workflow }}
+  cancel-in-progress: false
 
 jobs:
   build-deploy:
@@ -117,6 +120,10 @@ jobs:
     # No rebuild — the docs of a release are exactly the dev docs at that point.
     if: github.repository == 'ocsigen/eliom' && github.event_name == 'workflow_dispatch' && github.event.inputs.version != ''
     runs-on: ubuntu-latest
+    # Pass the user-supplied version through the environment; never interpolate
+    # it directly into a run: shell (avoids command injection from the input).
+    env:
+      VERSION: ${{ github.event.inputs.version }}
     permissions:
       contents: write
     steps:
@@ -142,7 +149,7 @@ jobs:
         # write the root index.html redirect if missing, refresh versions.json.
         run: >-
           opam exec -- wodoc release --site site --from dev
-          --version "${{ github.event.inputs.version }}"
+          --version "$VERSION"
 
       - name: Commit and push gh-pages
         run: |
@@ -151,5 +158,5 @@ jobs:
           git config user.email "github-actions[bot]@users.noreply.github.com"
           git add -A
           git diff --cached --quiet \
-            || git commit -m "Release doc ${{ github.event.inputs.version }} (freeze dev, repoint latest)"
+            || git commit -m "Release doc $VERSION (freeze dev, repoint latest)"
           git push

.github/workflows/workflow.yml

@@ -43,6 +43,9 @@ jobs:
           token: ${{ github.token }}
 
       - run: opam pin -y git+https://github.com/ocsigen/ocsigenserver#master
+      # ocsipersist's released version targets the old flat module names; the
+      # master pin tracks the Ocsigen Server 8 API.
+      - run: opam pin -yn git+https://github.com/ocsigen/ocsipersist#master
       # Published js_of_ocaml (6.3.2) caps at ocaml < 5.5; pin master for
       # 5.5 support (also pulls wasm_of_ocaml, hence the binaryen set-up).
       - run: opam pin -y git+https://github.com/ocsigen/js_of_ocaml#master

.gitignore

@@ -9,6 +9,16 @@ src/**/*.mllib
 src/**/*.mldylib
 src/**/*.odocl
 
+# Generated odoc/wodoc documentation output
+_wodoc-html/
+_wodoc-md/
+
 ocsigen.org-data
 
 _opam
+
+# Local files (not part of the project)
+AGENTS*.md
+instructions
+2026-*.md
+doc/manual/menu.wiki

.ocamlformat

@@ -1,4 +1,4 @@
-version=0.28.1
+version=0.29.0
 parse-docstrings = false
 wrap-comments = false
 break-cases = fit

CHANGES

@@ -1,3 +1,104 @@
+===== 13.0~dev =====
+* PPX: the Eliom syntax extension is now a no-op on plain .ml/.mli files;
+  only .eliom/.eliomi files are processed as client-server code. This
+  prevents server-only .ml modules that create services at toplevel from
+  emitting client values that are never linked on the client (reported as
+  "Code generating the following client values is not linked on the client").
+* Persistent storage: replace Stdlib.Marshal with Deriving_Json
+** perssessgrp values (session-group keys) are now serialised with
+   Deriving_Json instead of Stdlib.Marshal. The on-disk format
+   becomes stable across OCaml versions and human-readable.
+   BREAKING: existing session-group entries from older Eliom
+   versions become unreadable; tables are renamed in later commits
+   to make this migration explicit.
+** Persistent-cookie table (eliom_persist_cookies) now uses
+   Ocsipersist.Column.Json instead of Column.Marshal. The table
+   suffix is bumped to _v6. BREAKING: persistent cookies issued by
+   earlier Eliom versions are dropped on upgrade and clients are
+   asked to remove the cookie on next visit.
+** Session-group table is migrated from Ocsipersist.Polymorphic to a
+   typed functorial table with Column.Json. Renamed from
+   __eliom_session_group_table to __eliom_session_group_table_v2.
+   BREAKING: existing session groups are dropped on upgrade.
+** Eliom references and persistent session-data tables drop all
+   reliance on Stdlib.Marshal. The user-facing API now requires a
+   Deriving_Json codec:
+     Reference.eref ~persistent:("name", [%json: t]) v
+     State.create_persistent_table ~scope ~json:[%json: t] "name"
+   The stored values must be annotated with [@@deriving json].
+   Internally:
+     - The global persistent store (Ocsiper) now uses
+       Ocsipersist.Store_json.
+     - Per-site and per-user persistent tables use a typed
+       Ocsipersist functorial table with Column.Json registered
+       via Persistent_tables.create_json.
+     - The vestigial int64 column previously prefixed to every
+       session value is dropped.
+     - Ocsipersist.Polymorphic is no longer used in Eliom and the
+       Common.Ocsipersist.Polymorphic wrapper is removed.
+   BREAKING: existing per-reference / per-session persistent data
+   becomes unreadable on upgrade because the on-disk format changes
+   (Ocsipersist's Store_json stores in a different table than
+   Store; Polymorphic tables are not opened any more).
+* Module namespace modernization
+** Public modules are now accessed as Eliom.Service, Eliom.Content,
+   Eliom.Parameter, Eliom.Registration, Eliom.Client, ... instead of
+   the legacy flat Eliom_xxx prefix. Implemented with
+   (include_subdirs qualified) + (wrapped false) in dune.
+** Eliom_common is now Eliom.Common; most internal modules lost
+   their eliom_/eliommod_ prefix as well (Content_core, Mod_main,
+   Mod_pagegen, ...). A few names are kept as-is for conflict
+   reasons (Eliom_form, Eliom_lazy, Eliom_react, Eliom_uri).
+** New eliom-compat opam package: provides the legacy Eliom_xxx
+   module names as include-aliases of the new Eliom.Xxx modules,
+   to ease migration of existing code.
+** BREAKING: Eliom.run is now Eliom.App.run (the auto-generated
+   wrapper module cannot contain val declarations).
+* Eliom.Content.Html.T
+** New named module type for the Tyxml HTML signature shared by F
+   and D, with Eliom's LINKS_AND_FORMS extensions. Use it as the
+   parameter signature of functors that need to abstract over the
+   F/D choice, instead of [module type of Content.Html.F]. The
+   latter triggers an OCaml strengthening bug in wrapped libraries.
+   Tools.Make, Ot.Icons.Make and the os_template Make functor all
+   use it.
+* Distillery template install path
+** Eliom's three templates (app.exe, app.lib, basic.ppx) are now
+   installed at lib/eliom/templates/<name>/ via the standard dune
+   (install (section lib_root) ... (with_prefix ...)) pattern.
+   Third-party packages (e.g. ocsigen-start) that ship templates
+   are expected to install at the same location.
+* Build system
+** Migrated to wrapped ocsigenserver module names (Ocsigen.Server,
+   Ocsigen.Extensions, Ocsigen.Request, Ocsigen.Response,
+   Ocsigen.Config, Ocsigen_base.Lib, Ocsigen_http.Header, ...).
+** PPX gained -internal and -internal-prefix flags for compiling
+   wrapped libraries.
+** Removed the eliom.ocamlbuild plugin and the legacy topkg/pkg
+   build artifacts. API documentation is now generated by
+   build/gen_wikidoc.sh (ocamldoc + wikidoc, no ocamlbuild
+   dependency); run via [make wikidoc].
+* Exception renames
+** Common.Eliom_site_information_not_available is now
+   Common.Site_information_not_available, Common.Eliom_do_redirection
+   is now Common.Do_redirection, and Common.Eliom_do_half_xhr_redirection
+   is now Common.Do_half_xhr_redirection. The old names are kept as
+   backwards-compatible aliases (exception X = Y).
+** The internal client exception
+   Request_info.Eliom_no_raw_post_data_on_client was renamed to
+   No_raw_post_data_on_client (no alias kept, as it was not exposed).
+* Bug fixes
+** Syntax.is_site_available now checks that the sitedata stack is
+   actually non-empty during initialisation, instead of just
+   relying on Ocsigen.Extensions.during_initialisation. Fixes a
+   crash on startup
+   (Eliom_site_information_not_available "get_current_sitedata")
+   exposed by the new module link order: PPX-inserted top-level
+   close_server_section calls in extension-linked .eliom files
+   (Service_base, Content, Tools, ...) now correctly route their
+   compilation-unit data into !global_data when no site is active,
+   matching the design intent stated in the comment on
+   get_global_data.
 ===== 12.1.0 =====
 * Compatibility with OCaml 5.5
   (Outcometree's Otyp_object replaced open_row with a row field, and out_type
@@ -10,7 +111,7 @@
 * Eliom_lib
 ** Deprecated logging functions were removed (#821)
    These are: debug_exn, debug, error, error_any, jsdebug
-* Full WASM support: build system and sending either js or wasm depending on the browser 
+* Full WASM support: build system and sending either js or wasm depending on the browser
 * Use Log instead of Lwt_logs
 
 ===== 11.1 =====

Makefile

@@ -1,42 +1,8 @@
 ### Building
-BEST=$(if $(shell command -v ocamlopt 2> /dev/null),native,byte)
-BUILDER=_build/build/build.$(BEST)
-
 .PHONY: all
 all:
 	dune build
 
-### Doc
-.PHONY: doc wikidoc doc man alldoc
-DOCS_DIR=src/lib/client src/lib/server src/ocamlbuild src/ppx
-DOCS_HTML=$(addsuffix /api.docdir/index.html,$(DOCS_DIR))
-DOCS_WIKI=$(addsuffix /api.wikidocdir/index.wiki,$(DOCS_DIR))
-DOCS_MAN= src/lib/client/api.mandocdir/man.3oc \
-          src/lib/server/api.mandocdir/man.3os \
-          src/ocamlbuild/api.mandocdir/man.3o \
-          src/ppx/api.mandocdir/man.3o
-API_DIR=_build/doc/dev/api
-doc: $(BUILDER)
-	$(BUILDER) $(DOCS_HTML)
-wikidoc: $(BUILDER)
-	$(BUILDER) $(DOCS_WIKI)
-man: $(BUILDER)
-	$(BUILDER) $(DOCS_MAN)
-alldoc: man wikidoc doc
-
-doccp: alldoc
-	mkdir -p $(API_DIR)/server $(API_DIR)/client $(API_DIR)/ocamlbuild $(API_DIR)/ppx
-	cp -Rf _build/src/lib/server/api.wikidocdir/*.wiki $(API_DIR)/server/
-	cp -Rf _build/src/lib/client/api.wikidocdir/*.wiki $(API_DIR)/client/
-	cp -Rf _build/src/ocamlbuild/api.wikidocdir/*.wiki $(API_DIR)/ocamlbuild/
-	cp -Rf _build/src/ppx/api.wikidocdir/*.wiki $(API_DIR)/ppx/
-	cp -Rf doc/index.wiki $(API_DIR)/
-
-$(BUILDER): $(wildcard build/*.ml)
-	ocamlbuild -no-plugin -I src/ocamlbuild -no-links -use-ocamlfind build/build.$(BEST) 1> /dev/null
-	ocaml pkg/build.ml manpage=false native=true native-dynlink=true
-builder: $(BUILDER)
-
 ### Cleaning ###
 .PHONY: clean distclean
 clean:

README.md

@@ -32,23 +32,23 @@ Defining a service on path `/foo`, taking any GET parameters:
 
 ```ocaml
 let myservice =
-  Eliom_service.create
-    ~path:(Eliom_service.Path ["foo"])
-    ~meth:(Eliom_service.Get (Eliom_parameter.any))
+  Eliom.Service.create
+    ~path:(Eliom.Service.Path ["foo"])
+    ~meth:(Eliom.Service.Get (Eliom.Parameter.any))
     ()
 
 let () =
-  Eliom_registration.Html.register ~service:myservice
+  Eliom.Registration.Html.register ~service:myservice
     (fun get_params () ->
       Lwt.return
-         Eliom_content.Html.F.(html (head (title (txt "")))
+         Eliom.Content.Html.F.(html (head (title (txt "")))
                                     (body [h1 [txt "Hello"]])))
 ```
 
 Inserting a link towards that service, with parameters:
 
 ```ocaml
-Eliom_content.Html.D.a ~service:myservice [txt "Home"] [("param1", "v1"); ("param2", "v2")]
+Eliom.Content.Html.D.a ~service:myservice [txt "Home"] [("param1", "v1"); ("param2", "v2")]
 ```
 
 Event handlers are written in OCaml:
@@ -90,22 +90,22 @@ let%client () =
 Saving session data on the server using Eliom references:
 
 ```ocaml
-let%server r = Eliom_reference.eref ~scope:Eliom_common.default_session_scope 0
+let%server r = Eliom.Reference.eref ~scope:Eliom.Common.default_session_scope 0
 
 let%server f () =
-  let%lwt v = Eliom_reference.get r in
-  Eliom_reference.set r (v + 1);
+  let%lwt v = Eliom.Reference.get r in
+  Eliom.Reference.set r (v + 1);
   ...
 
 ```
 Where scope can be:
-* `Eliom_common.default_session_scope` (different value for each browser),
-* `Eliom_common.default_process_scope` (different value for each tab),
-* `Eliom_common.default_group_scope` (different value for each user),
-* `Eliom_common.site_scope` (value for the whole site),
-* `Eliom_common.global_scope` (global value for the whole server).
+* `Eliom.Common.default_session_scope` (different value for each browser),
+* `Eliom.Common.default_process_scope` (different value for each tab),
+* `Eliom.Common.default_group_scope` (different value for each user),
+* `Eliom.Common.site_scope` (value for the whole site),
+* `Eliom.Common.global_scope` (global value for the whole server).
 Eliom references are persistant if you add optional parameter `~persistent`
-to function `Eliom_reference.eref`.
+to function `Eliom.Reference.eref`.
 
 ## Learning Eliom