commit a72ebb09e727660f8c3332051158124d607425aa Author: Jeremy Wall Date: Fri Mar 28 17:46:09 2025 -0400 init: project setup diff --git a/.envrc b/.envrc new file mode 100644 index 0000000..217fd75 --- /dev/null +++ b/.envrc @@ -0,0 +1,12 @@ +#!/usr/bin/env bash + +if has lorri; then + echo Using lorri + eval "$(lorri direnv)" +elif has nix; then + echo Using flake fallback + use flake +else + # noop + echo unsupported direnv configuration +fi diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..d99f800 --- /dev/null +++ b/.gitignore @@ -0,0 +1,3 @@ +result/ +result +target/ diff --git a/Cargo.lock b/Cargo.lock new file mode 100644 index 0000000..ce2be21 --- /dev/null +++ b/Cargo.lock @@ -0,0 +1,7 @@ +# This file is automatically @generated by Cargo. +# It is not intended for manual editing. +version = 3 + +[[package]] +name = "offline-web" +version = "0.1.0" diff --git a/Cargo.toml b/Cargo.toml new file mode 100644 index 0000000..263406a --- /dev/null +++ b/Cargo.toml @@ -0,0 +1,6 @@ +[package] +name = "offline-web" +version = "0.1.0" +edition = "2021" + +[dependencies] diff --git a/DESIGN.md b/DESIGN.md new file mode 100644 index 0000000..d900359 --- /dev/null +++ b/DESIGN.md @@ -0,0 +1,110 @@ +# Design Notes + +## Synchronization + +We assume that our resources map easily to REST concepts. + +- Resources map to a path. +- Groups of resources are represented in the path structure. +- `HEAD` to get the header to check whether we need to sync. +- `POST` is create +- `PUT` is mutate +- `GET` retrieves the resource +- `DELETE` removes the resources + +## Resource Query Datamodel + +We assume all resources are content-addressable and form a merkle tree. We +maintain an index of path to content-addressable items. + +Resource reference paths are rooted at `/api/v1/ref/`. + +```json +{ + "objectId": , + "dependents": [ + { "path": "path/name1", content: { "objectId": } }, + { "path": "path/name2", content: { "objectId": } } + ], +} +``` + +Resource references contain a payload with the objectID and a list of any +dependent resources. They support the following operations + +* `GET` +* `POST` +* `PUT` +* `DELETE` +* `HEAD` + +`HEAD` requests return only the objectId in the payload. Primarily used to detect +if a reference needs to be updated on the client or not. + +Resource Requests can be expanded to their object reference payloads at any +configurable depth with the query parameters `?depth=` or to the full +tree depth with `?full=true`. This will add recursive dependent sections to the +content key. + +```json +{ + "objectId": , + "dependents": [ + { + "path": "path/name1", + "content": { + "objectId": , + "dependents": [ + { "path": "path/name1", "objectId": , } + { "path": "path/name2", "objectId": , } + ], + } + }, + { + "path": "path/name2", + "content": { + "objectId": , + "dependents": [ + { "path": "path/name1", "objectId": , } + { "path": "path/name2", "objectId": , } + ], + } + } + ], +} +``` + +### Reserved References + +* `/api/v1/resource/all/` The root of the resouce tree. List all sub + resources that the user has access too. +* `/api/v1/resource/user/` The user information. + +### Content-Addressable Query API + +The content addressable store is considered immutable. You do not delete from +it. We may garbage collect at some point as a storage optimization. + +Content addressable paths are rooted at `/api/v1/object/`. + +Their payloads are whatever the contents serialize to in json and support the following +operations. + +* `GET` +* `POST` + +## Syncrhonization + +### Bootstrapping + +* Load `/api/v1/resource/all/` and then follow the sub resources to + load the entire dataset locally making sure to keep the content-addresses + around for comparison. + +# Benchmarking + +## Bootstrapping benchmark tests + +* Server side loading +* Client side loading +* WebSocket? diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..f49a4e1 --- /dev/null +++ b/LICENSE @@ -0,0 +1,201 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. \ No newline at end of file diff --git a/README.md b/README.md new file mode 100644 index 0000000..fbf681c --- /dev/null +++ b/README.md @@ -0,0 +1,17 @@ +# An opinionated offline-first web app framework + +Consists of two parts. + +* A server implementation that uses path based resource apis and a configurable frontend API. +* A client side implementation that uses path based resource syncing + +The API is versioned by default to allow for resource evolution. + +## Features + +* Offline first + * Etag or hash based resource synchronization +* Built in Authentication +* Built in resource level Authorization + +[Design Notes](./DESIGN.md) diff --git a/flake.lock b/flake.lock new file mode 100644 index 0000000..501c535 --- /dev/null +++ b/flake.lock @@ -0,0 +1,130 @@ +{ + "nodes": { + "flake-compat": { + "flake": false, + "locked": { + "lastModified": 1733328505, + "narHash": "sha256-NeCCThCEP3eCl2l/+27kNNK7QrwZB1IJCrXfrbv5oqU=", + "owner": "edolstra", + "repo": "flake-compat", + "rev": "ff81ac966bb2cae68946d5ed5fc4994f96d0ffec", + "type": "github" + }, + "original": { + "owner": "edolstra", + "repo": "flake-compat", + "type": "github" + } + }, + "flake-utils": { + "inputs": { + "systems": "systems" + }, + "locked": { + "lastModified": 1731533236, + "narHash": "sha256-l0KFg5HjrsfsO/JpG+r7fRrqm12kzFHyUHqHCVpMMbI=", + "owner": "numtide", + "repo": "flake-utils", + "rev": "11707dc2f618dd54ca8739b309ec4fc024de578b", + "type": "github" + }, + "original": { + "owner": "numtide", + "repo": "flake-utils", + "type": "github" + } + }, + "naersk": { + "inputs": { + "nixpkgs": "nixpkgs" + }, + "locked": { + "lastModified": 1742901344, + "narHash": "sha256-o9dXcpfXpBm6+/SRqcQW0GzRkJymwyEAu5UD5LMDd3s=", + "owner": "nix-community", + "repo": "naersk", + "rev": "a75c0584b0d69de943babc899530e9c70c642b42", + "type": "github" + }, + "original": { + "owner": "nix-community", + "repo": "naersk", + "type": "github" + } + }, + "nixpkgs": { + "locked": { + "lastModified": 1743076231, + "narHash": "sha256-yQugdVfi316qUfqzN8JMaA2vixl+45GxNm4oUfXlbgw=", + "owner": "NixOS", + "repo": "nixpkgs", + "rev": "6c5963357f3c1c840201eda129a99d455074db04", + "type": "github" + }, + "original": { + "id": "nixpkgs", + "type": "indirect" + } + }, + "nixpkgs_2": { + "locked": { + "lastModified": 1743076231, + "narHash": "sha256-yQugdVfi316qUfqzN8JMaA2vixl+45GxNm4oUfXlbgw=", + "owner": "NixOS", + "repo": "nixpkgs", + "rev": "6c5963357f3c1c840201eda129a99d455074db04", + "type": "github" + }, + "original": { + "id": "nixpkgs", + "type": "indirect" + } + }, + "root": { + "inputs": { + "flake-compat": "flake-compat", + "flake-utils": "flake-utils", + "naersk": "naersk", + "nixpkgs": "nixpkgs_2", + "rust-overlay": "rust-overlay" + } + }, + "rust-overlay": { + "inputs": { + "nixpkgs": [ + "nixpkgs" + ] + }, + "locked": { + "lastModified": 1743129211, + "narHash": "sha256-gE8t+U9miTwm2NYWS9dFY8H1/QB4ifaFDq1KdV9KEqo=", + "owner": "oxalica", + "repo": "rust-overlay", + "rev": "f93da1d26ba9963f34f94a6872b67a7939699543", + "type": "github" + }, + "original": { + "owner": "oxalica", + "repo": "rust-overlay", + "type": "github" + } + }, + "systems": { + "locked": { + "lastModified": 1681028828, + "narHash": "sha256-Vy1rq5AaRuLzOxct8nz4T6wlgyUR7zLU309k9mBC768=", + "owner": "nix-systems", + "repo": "default", + "rev": "da67096a3b9bf56a91d16901293e51ba5b49a27e", + "type": "github" + }, + "original": { + "owner": "nix-systems", + "repo": "default", + "type": "github" + } + } + }, + "root": "root", + "version": 7 +} diff --git a/flake.nix b/flake.nix new file mode 100644 index 0000000..826e7f1 --- /dev/null +++ b/flake.nix @@ -0,0 +1,44 @@ +{ + inputs = { + rust-overlay = { + url = "github:oxalica/rust-overlay"; + inputs.nixpkgs.follows = "nixpkgs"; + }; + naersk.url = "github:nix-community/naersk"; + flake-utils = {url = "github:numtide/flake-utils"; }; + flake-compat = { url = "github:edolstra/flake-compat"; flake = false; }; + + }; + + outputs = {self, nixpkgs, flake-utils, rust-overlay, naersk, flake-compat}: + flake-utils.lib.eachDefaultSystem (system: let + overlays = [ + rust-overlay.overlays.default + ]; + pkgs = import nixpkgs { inherit system overlays; }; + rust-bin = pkgs.rust-bin.stable.latest.default; + naersk-lib = pkgs.callPackage naersk { + rustc = rust-bin; + cargo = rust-bin; + }; + project = naersk-lib.buildPackage { + src = ./.; + root = ./.; + nativeBuildInputs = [pkgs.pkg-config]; + buildInputs = + ( + if pkgs.stdenv.isDarwin + then with pkgs.darwin.apple_sdk.frameworks; [Security SystemConfiguration] + else [pkgs.openssl] + ) + ++ [rust-bin]; + }; + in + { + packages.default = project; + devShells.default = pkgs.mkShell { + buildInputs = [ rust-bin pkgs.rust-analyzer pkgs.cargo-tarpaulin ]; + packages = with pkgs; [ gnumake ]; + }; + }); +} diff --git a/src/lib.rs b/src/lib.rs new file mode 100644 index 0000000..b93cf3f --- /dev/null +++ b/src/lib.rs @@ -0,0 +1,14 @@ +pub fn add(left: u64, right: u64) -> u64 { + left + right +} + +#[cfg(test)] +mod tests { + use super::*; + + #[test] + fn it_works() { + let result = add(2, 2); + assert_eq!(result, 4); + } +}