Merge branch 'master' into kim/smoketests/retry-if-no-leader

Author: kim

.github/workflows/docs-check-links.yml

@@ -0,0 +1,30 @@
+name: Docs - Check Link Validity
+
+on:
+  pull_request:
+  push:
+    branches:
+      - master
+  merge_group:
+
+jobs:
+  check-links:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v3
+
+      - name: Set up Node.js
+        uses: actions/setup-node@v3
+        with:
+          node-version: '16' # or the version of Node.js you're using
+
+      - name: Install dependencies
+        working-directory: docs
+        run: |
+          npm install
+
+      - name: Run link check
+        working-directory: docs
+        run: |
+          npm run check-links

.github/workflows/docs-validate-nav-build.yml

@@ -0,0 +1,47 @@
+name: Docs - Validate nav.ts Matches nav.js
+
+on:
+  pull_request:
+  push:
+    branches:
+      - master
+  merge_group:
+
+jobs:
+  validate-build:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v3
+
+      - name: Set up Node.js
+        uses: actions/setup-node@v3
+        with:
+          node-version: '16'
+
+      - name: Install dependencies
+        working-directory: docs
+        run: |
+          npm install
+
+      - name: Backup existing nav.js
+        working-directory: docs
+        run: |
+          mv docs/nav.js docs/nav.js.original
+
+      - name: Build nav.ts
+        working-directory: docs
+        run: |
+          npm run build
+
+      - name: Compare generated nav.js with original nav.js
+        working-directory: docs
+        run: |
+          diff -q docs/nav.js docs/nav.js.original || (echo "Generated nav.js differs from committed version. Run 'npm run build' and commit the updated file." && exit 1)
+
+      - name: Restore original nav.js
+        working-directory: docs
+        if: success() || failure()
+        run: |
+          mv docs/nav.js.original docs/nav.js

.github/workflows/pr-only-ci.yml

@@ -31,18 +31,12 @@ jobs:
         with:
           ref: ${{ env.GIT_REF }}
       - uses: dsherret/rust-toolchain-file@v1
-      - name: Checkout docs
-        uses: actions/checkout@v4
-        with:
-          repository: clockworklabs/spacetime-docs
-          ref: master
-          path: spacetime-docs
       - name: Check for docs change
         run: |
-          cargo run --features markdown-docs -p spacetimedb-cli > spacetime-docs/docs/cli-reference.md
-          cd spacetime-docs
+          cargo run --features markdown-docs -p spacetimedb-cli > docs/docs/cli-reference.md
+          cd docs
           # This is needed because our website doesn't render markdown quite properly.
-          # See the README in spacetime-docs for more details.
+          # See the README in docs for more details.
           sed -i'' -E 's!^(##) `(.*)`$!\1 \2!' docs/cli-reference.md
           sed -i'' -E 's!^(######) \*\*(.*)\*\*$!\1 <b>\2</b>!' docs/cli-reference.md
           git status

crates/commitlog/src/lib.rs

@@ -32,7 +32,12 @@ pub mod stream;
 pub mod tests;
 
 /// [`Commitlog`] options.
-#[derive(Clone, Copy, Debug)]
+#[derive(Clone, Copy, Debug, PartialEq)]
+#[cfg_attr(
+    feature = "serde",
+    derive(serde::Serialize, serde::Deserialize),
+    serde(rename_all = "kebab-case")
+)]
 pub struct Options {
     /// Set the log format version to write, and the maximum supported version.
     ///
@@ -42,23 +47,27 @@ pub struct Options {
     /// with new or very old versions.
     ///
     /// Default: [`DEFAULT_LOG_FORMAT_VERSION`]
+    #[cfg_attr(feature = "serde", serde(default = "Options::default_log_format_version"))]
     pub log_format_version: u8,
     /// The maximum size in bytes to which log segments should be allowed to
     /// grow.
     ///
     /// Default: 1GiB
+    #[cfg_attr(feature = "serde", serde(default = "Options::default_max_segment_size"))]
     pub max_segment_size: u64,
     /// The maximum number of records in a commit.
     ///
     /// If this number is exceeded, the commit is flushed to disk even without
     /// explicitly calling [`Commitlog::flush`].
     ///
     /// Default: 65,535
+    #[cfg_attr(feature = "serde", serde(default = "Options::default_max_records_in_commit"))]
     pub max_records_in_commit: NonZeroU16,
     /// Whenever at least this many bytes have been written to the currently
     /// active segment, an entry is added to its offset index.
     ///
     /// Default: 4096
+    #[cfg_attr(feature = "serde", serde(default = "Options::default_offset_index_interval_bytes"))]
     pub offset_index_interval_bytes: NonZeroU64,
     /// If `true`, require that the segment must be synced to disk before an
     /// index entry is added.
@@ -74,22 +83,53 @@ pub struct Options {
     /// strictly every `offset_index_interval_bytes`.
     ///
     /// Default: false
+    #[cfg_attr(
+        feature = "serde",
+        serde(default = "Options::default_offset_index_require_segment_fsync")
+    )]
     pub offset_index_require_segment_fsync: bool,
 }
 
 impl Default for Options {
     fn default() -> Self {
-        Self {
-            log_format_version: DEFAULT_LOG_FORMAT_VERSION,
-            max_segment_size: 1024 * 1024 * 1024,
-            max_records_in_commit: NonZeroU16::MAX,
-            offset_index_interval_bytes: NonZeroU64::new(4096).unwrap(),
-            offset_index_require_segment_fsync: false,
-        }
+        Self::DEFAULT
     }
 }
 
 impl Options {
+    pub const DEFAULT_MAX_SEGMENT_SIZE: u64 = 1024 * 1024 * 1024;
+    pub const DEFAULT_MAX_RECORDS_IN_COMMIT: NonZeroU16 = NonZeroU16::MAX;
+    pub const DEFAULT_OFFSET_INDEX_INTERVAL_BYTES: NonZeroU64 = NonZeroU64::new(4096).expect("4096 > 0, qed");
+    pub const DEFAULT_OFFSET_INDEX_REQUIRE_SEGMENT_FSYNC: bool = false;
+
+    pub const DEFAULT: Self = Self {
+        log_format_version: DEFAULT_LOG_FORMAT_VERSION,
+        max_segment_size: Self::default_max_segment_size(),
+        max_records_in_commit: Self::default_max_records_in_commit(),
+        offset_index_interval_bytes: Self::default_offset_index_interval_bytes(),
+        offset_index_require_segment_fsync: Self::default_offset_index_require_segment_fsync(),
+    };
+
+    pub const fn default_log_format_version() -> u8 {
+        DEFAULT_LOG_FORMAT_VERSION
+    }
+
+    pub const fn default_max_segment_size() -> u64 {
+        Self::DEFAULT_MAX_SEGMENT_SIZE
+    }
+
+    pub const fn default_max_records_in_commit() -> NonZeroU16 {
+        Self::DEFAULT_MAX_RECORDS_IN_COMMIT
+    }
+
+    pub const fn default_offset_index_interval_bytes() -> NonZeroU64 {
+        Self::DEFAULT_OFFSET_INDEX_INTERVAL_BYTES
+    }
+
+    pub const fn default_offset_index_require_segment_fsync() -> bool {
+        Self::DEFAULT_OFFSET_INDEX_REQUIRE_SEGMENT_FSYNC
+    }
+
     /// Compute the length in bytes of an offset index based on the settings in
     /// `self`.
     pub fn offset_index_len(&self) -> u64 {

demo/Blackholio/.gitignore

@@ -0,0 +1,38 @@
+.idea/
+.vsconfig
+.vs/
+
+### macOS ###
+# General
+.DS_Store
+.AppleDouble
+.LSOverride
+
+# Icon must end with two \r
+Icon
+
+
+# Thumbnails
+._*
+
+# Files that might appear in the root of a volume
+.DocumentRevisions-V100
+.fseventsd
+.Spotlight-V100
+.TemporaryItems
+.Trashes
+.VolumeIcon.icns
+.com.apple.timemachine.donotpresent
+
+# Directories potentially created on remote AFP share
+.AppleDB
+.AppleDesktop
+Network Trash Folder
+Temporary Items
+.apdisk
+
+### macOS Patch ###
+# iCloud generated files
+*.icloud
+
+# End of https://www.toptal.com/developers/gitignore/api/macos

demo/Blackholio/DEVELOP.md

@@ -0,0 +1 @@
+Please make changes and submit pull requests to the root repository at [SpacetimeDB/demo/Blackholio](https://github.com/clockworklabs/SpacetimeDB/tree/master/demo/Blackholio). The [Blackholio repository](https://github.com/clockworklabs/Blackholio) is only a mirror.