René's URL Explorer Experiment

{"@context":"https://schema.org","@type":"DiscussionForumPosting","headline":"LWS Protocol Mode Support (Draft/Future)","articleBody":"## Summary\n\nAdd optional `--lws-mode` flag to support W3C Linked Web Storage (LWS) protocol semantics alongside the current Solid Protocol/LDP implementation.\n\n**Status:** 📋 Draft/Exploratory - LWS spec is in early stages (PR #37 just merged Jan 2026)\n**Priority:** Low (monitor ecosystem first)\n**Related:** https://github.com/w3c/lws-protocol/pull/37\n\n## Background\n\n### What is LWS?\n\nThe W3C Linked Web Storage protocol suite defines CRUD operations with different conventions than Solid/LDP:\n\n- **POST for creation** (server-assigned URIs with Slug hints)\n- **PUT for updates only** (not creation)\n- **Link headers for metadata** (removes slash semantics for containers)\n- **Mandatory ETag concurrency control**\n- **JSON Merge Patch for metadata updates** (via separate linkset resources)\n\n### Current State: LDP/Solid\n\nJSS implements Solid Protocol conventions based on LDP:\n\n- ✅ PUT creates **or** updates resources\n- ✅ Trailing slash indicates containers\n- ✅ POST to containers with Slug support\n- ✅ ETag-based If-Match/If-None-Match\n- ✅ N3 Patch and SPARQL Update for RDF modifications\n\n## Key Differences\n\n| Aspect | Solid/LDP (Current) | LWS Protocol (Proposed) |\n|--------|---------------------|-------------------------|\n| **Resource Creation** | PUT or POST | POST only |\n| **PUT Semantics** | Create or update | Update only (404 if not exists) |\n| **Container Detection** | Trailing slash (`/alice/`) | Link header: `rel=\"type\"` |\n| **Metadata Updates** | N3 Patch, SPARQL Update | JSON Merge Patch on linkset |\n| **Concurrency Control** | Optional ETag | Mandatory ETag |\n| **Slash Semantics** | Standard (containers end with `/`) | Removed (header-based only) |\n\n## Proposed Implementation\n\n### Configuration Flag\n\n```bash\n# LWS mode\njss start --lws-mode\n\n# Solid/LDP mode (default, current behavior)\njss start\n```\n\n### Code Changes Required\n\n#### 1. PUT Handler Split (src/handlers/resource.js)\n**Effort:** 3 hours\n\n```javascript\nexport async function handlePut(request, reply) {\n  const lwsMode = request.lwsMode || false;\n  \n  if (lwsMode) {\n    // LWS: PUT only for updates\n    const stats = await storage.stat(storagePath);\n    if (\\!stats) {\n      return reply.code(404).send({\n        error: 'Use POST to create resources in LWS mode'\n      });\n    }\n  } else {\n    // LDP: PUT creates or updates (current)\n    const existed = stats \\!== null;\n  }\n}\n```\n\n#### 2. Container Detection Toggle (src/utils/url.js)\n**Effort:** 4 hours\n\n```javascript\nexport function isContainer(urlPath, request) {\n  if (request?.lwsMode) {\n    // LWS: Check Link header for Container type\n    const linkHeader = request?.headers?.link || '';\n    return linkHeader.includes('ldp#Container');\n  } else {\n    // LDP: Trailing slash\n    return urlPath.endsWith('/');\n  }\n}\n```\n\n**Files affected:** src/utils/url.js, src/handlers/resource.js, src/handlers/container.js, src/ldp/headers.js\n\n#### 3. Linkset Metadata Endpoints (new)\n**Effort:** 8 hours\n\nNew file: `src/handlers/linkset.js`\n\n- `GET /resource;linkset` - Return metadata as JSON\n- `PATCH /resource;linkset` - JSON Merge Patch for user-managed metadata\n\n#### 4. Config Infrastructure\n**Effort:** 2 hours\n\nAdd `--lws-mode` flag to CLI and config system.\n\n#### 5. Testing Matrix\n**Effort:** 12 hours\n\nDuplicate all CRUD tests for LWS mode (223 tests × 2 modes = 446 tests total).\n\n## Complexity Assessment\n\n| Component | Effort | Files | Risk |\n|-----------|--------|-------|------|\n| Config flag | 2h | 3 | Low |\n| PUT behavior | 3h | 1 | Medium |\n| Container detection | 4h | 4 | High |\n| Linkset endpoints | 8h | 1 new | Medium |\n| Testing | 12h | All | High |\n| Documentation | 2h | 2 | Low |\n| **Total** | **~31 hours** | **~15** | **High** |\n\n## Trade-offs\n\n### Pros ✅\n\n- **Future-proof** if LWS gains adoption\n- **Universal server** supporting both protocols\n- **Research value** for evaluating LWS concepts\n- **Subdomain isolation** - run Solid + LWS pods on same server\n\n### Cons ❌\n\n- **Test burden** - doubles maintenance (446 tests)\n- **Code complexity** - branching logic throughout\n- **Premature** - LWS ecosystem is tiny (no known apps)\n- **Bug risk** - less-used mode more error-prone\n- **Documentation split** - user confusion\n\n## Decision Criteria\n\n**Do NOT implement until:**\n\n- ✅ At least **3 other servers** implement LWS\n- ✅ At least **5 client apps** request LWS support\n- ✅ W3C Solid CG shows **interest in LWS alignment**\n- ✅ LWS spec reaches **Candidate Recommendation** status\n\n## Monitor These Signals\n\n- [ ] Number of servers implementing LWS\n- [ ] Client apps using LWS endpoints\n- [ ] W3C Solid CG discussions about LWS\n- [ ] LWS spec maturity (currently early draft)\n\n## Alternative: Plugin Architecture\n\nInstead of core branching, design protocol adapters:\n\n```bash\njss start --protocol=lws      # LWS semantics\njss start --protocol=solid    # LDP semantics (default)\njss start --protocol=s3       # Future: S3-compatible\n```\n\nBenefits:\n- Clean core implementation\n- Community experimentation\n- No test matrix explosion\n\n## Current LWS Ecosystem (Jan 2026)\n\n- **Servers:** Unknown\n- **Clients:** Likely zero\n- **Spec status:** Early draft (PR #37 just merged)\n- **Community:** Small W3C working group\n\n## Recommendation\n\n**Priority: Low - Monitor but don't implement**\n\n**Timeline:**\n- **Now:** Capture this analysis\n- **Q2 2026:** Survey LWS ecosystem adoption\n- **Q4 2026:** Reassess if signals show traction\n- **2027+:** Implement if ecosystem warrants\n\n**Keep focus on:**\n- ✅ did:key authentication (#86) - adds capability without breaking changes\n- ✅ Solid Protocol improvements - serve existing ecosystem\n- ✅ Performance and stability - core value\n\n## References\n\n- [W3C LWS Protocol PR #37](https://github.com/w3c/lws-protocol/pull/37)\n- [W3C LWS Protocol Repo](https://github.com/w3c/lws-protocol)\n- [LDP Specification](https://www.w3.org/TR/ldp/)\n- [Solid Protocol](https://solidproject.org/TR/protocol)","author":{"url":"https://github.com/melvincarvalho","@type":"Person","name":"melvincarvalho"},"datePublished":"2026-01-14T14:41:04.000Z","interactionStatistic":{"@type":"InteractionCounter","interactionType":"https://schema.org/CommentAction","userInteractionCount":1},"url":"https://github.com/87/JavaScriptSolidServer/issues/87"}