@hot-updater/postgres 0.36.7 → 1.0.0-rc.1

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@hot-updater/postgres",
   "type": "module",
-  "version": "0.36.7",
+  "version": "1.0.0-rc.1",
   "description": "React Native OTA solution for self-hosted",
   "main": "./dist/index.cjs",
   "module": "./dist/index.mjs",
@@ -34,24 +34,17 @@
   "dependencies": {
     "kysely": "0.28.17",
     "pg": "8.13.1",
-    "@hot-updater/core": "0.36.7",
-    "@hot-updater/plugin-core": "0.36.7"
+    "@hot-updater/core": "1.0.0-rc.0",
+    "@hot-updater/plugin-core": "1.0.0-rc.1"
   },
   "devDependencies": {
     "@electric-sql/pglite": "0.4.1",
     "@types/node": "^20",
     "@types/pg": "^8.11.10",
     "camelcase-keys": "^9.1.3",
+    "kysely-pglite-dialect": "1.2.0",
     "pg-minify": "^1.6.5",
-    "@hot-updater/js": "0.36.7",
-    "@hot-updater/test-utils": "0.36.7"
-  },
-  "inlinedDependencies": {
-    "camelcase": "8.0.0",
-    "camelcase-keys": "9.1.3",
-    "map-obj": "5.0.0",
-    "pg-minify": "1.8.0",
-    "quick-lru": "6.1.2"
+    "@hot-updater/test-utils": "1.0.0-rc.1"
   },
   "scripts": {
     "build": "tsdown",

package/sql/bundles.sql

@@ -1,45 +1,179 @@
--- HotUpdater.bundles
-
-CREATE TYPE platforms AS ENUM ('ios', 'android');
-
-CREATE TABLE bundles (
-    id uuid PRIMARY KEY,
-    platform platforms NOT NULL,
-    should_force_update boolean NOT NULL,
-    enabled boolean NOT NULL,
-    file_hash text NOT NULL,
-    git_commit_hash text,
-    message text,
-    channel text NOT NULL DEFAULT 'production',
-    storage_uri text NOT NULL,
-    target_app_version text,
-    fingerprint_hash text,
-    CONSTRAINT check_version_or_fingerprint CHECK (
-        (target_app_version IS NOT NULL) OR (fingerprint_hash IS NOT NULL)
-    ),
-    metadata jsonb DEFAULT '{}'::jsonb,
-    manifest_storage_uri text,
-    manifest_file_hash text,
-    asset_base_storage_uri text,
-    rollout_cohort_count INTEGER DEFAULT 1000
-      CHECK (rollout_cohort_count >= 0 AND rollout_cohort_count <= 1000),
-    target_cohorts TEXT[]
-);
-
-CREATE TABLE bundle_patches (
-    id text PRIMARY KEY,
-    bundle_id uuid NOT NULL REFERENCES bundles(id) ON DELETE CASCADE,
-    base_bundle_id uuid NOT NULL REFERENCES bundles(id) ON DELETE CASCADE,
-    base_file_hash text NOT NULL,
-    patch_file_hash text NOT NULL,
-    patch_storage_uri text NOT NULL,
-    order_index integer NOT NULL DEFAULT 0
-);
-
-CREATE INDEX bundles_target_app_version_idx ON bundles(target_app_version);
-CREATE INDEX bundles_fingerprint_hash_idx ON bundles(fingerprint_hash);
-CREATE INDEX bundles_channel_idx ON bundles(channel);
-CREATE INDEX bundles_rollout_idx ON bundles(rollout_cohort_count);
-CREATE INDEX bundles_target_cohorts_idx ON bundles USING GIN (target_cohorts);
-CREATE INDEX bundle_patches_bundle_id_idx ON bundle_patches(bundle_id);
-CREATE INDEX bundle_patches_base_bundle_id_idx ON bundle_patches(base_bundle_id);
+-- HotUpdater.schema
+
+create table channels (
+  id varchar(255) primary key not null,
+  name varchar(255) not null
+);
+
+create table bundles (
+  id uuid primary key not null,
+  platform text not null,
+  file_hash text not null,
+  git_commit_hash text,
+  storage_uri text not null,
+  archive_byte_size double precision not null,
+  metadata json not null default '{}'::json,
+  manifest_storage_uri text,
+  manifest_file_hash text,
+  asset_base_storage_uri text
+);
+
+create table bundle_patches (
+  id varchar(255) primary key not null,
+  bundle_id uuid not null,
+  base_bundle_id uuid not null,
+  base_file_hash text not null,
+  patch_file_hash text not null,
+  patch_storage_uri text not null,
+  byte_size double precision not null,
+  order_index integer not null default 0
+);
+
+create table releases (
+  id uuid primary key not null,
+  revision integer not null,
+  scope_key varchar(2048) not null,
+  channel_id varchar(255) not null,
+  platform text not null,
+  kind text not null,
+  bundle_id uuid,
+  strategy text not null,
+  target_app_version text,
+  fingerprint_hash text,
+  enabled boolean not null,
+  should_force_update boolean not null,
+  message text,
+  rollout_cohort_count integer not null default 1000,
+  target_cohorts json not null default '[]'::json,
+  operation text not null,
+  source_release_id uuid,
+  created_at_ms double precision not null,
+  updated_at_ms double precision not null
+);
+
+create table release_catalogs (
+  scope_key varchar(2048) primary key not null,
+  catalog_id varchar(255) not null,
+  strategy text not null,
+  channel_id varchar(255) not null,
+  channel_key varchar(1400) not null,
+  platform text not null,
+  fingerprint_hash text,
+  generation double precision not null,
+  payload text not null,
+  catalog_hash varchar(71) not null,
+  byte_size integer not null,
+  is_tombstone boolean not null,
+  updated_at_ms double precision not null
+);
+
+create table bundle_events (
+  id uuid primary key not null,
+  type text not null,
+  install_id text not null,
+  user_id text,
+  username text,
+  from_release_id uuid,
+  from_bundle_id uuid,
+  to_release_id uuid,
+  to_bundle_id uuid not null,
+  platform text not null,
+  app_version text not null,
+  channel text not null,
+  cohort text not null,
+  update_strategy text,
+  fingerprint_hash text,
+  sdk_version text,
+  received_at_ms double precision not null
+);
+
+create table api_keys (
+  id varchar(255) primary key not null,
+  hash text not null,
+  name text not null,
+  prefix text not null,
+  role text not null,
+  created_at_ms double precision not null,
+  revoked_at_ms double precision
+);
+
+create table private_hot_updater_settings (
+  key varchar(255) primary key not null,
+  value text not null default '1.0.0'
+);
+
+create unique index channels_name_key on channels(name);
+create index bundle_patches_bundle_id_idx on bundle_patches(bundle_id);
+create index bundle_patches_base_bundle_id_idx on bundle_patches(base_bundle_id);
+create index releases_scope_order_idx on releases(scope_key, id);
+create index releases_channel_platform_order_idx on releases(channel_id, platform, id);
+create index releases_bundle_id_idx on releases(bundle_id);
+create index releases_fingerprint_hash_idx on releases(fingerprint_hash);
+create index releases_enabled_idx on releases(enabled);
+create index release_catalogs_channel_idx on release_catalogs(channel_id);
+create index bundle_events_received_at_idx on bundle_events(received_at_ms, id);
+create index bundle_events_install_idx on bundle_events(install_id, received_at_ms, id);
+create index bundle_events_user_id_idx on bundle_events(user_id, received_at_ms, id);
+create index bundle_events_username_idx on bundle_events(username, received_at_ms, id);
+create index bundle_events_to_bundle_idx on bundle_events(type, to_bundle_id, received_at_ms, id);
+create index bundle_events_from_bundle_idx on bundle_events(type, from_bundle_id, received_at_ms, id);
+create index bundle_events_to_release_idx on bundle_events(type, to_release_id, received_at_ms, id);
+create index bundle_events_from_release_idx on bundle_events(type, from_release_id, received_at_ms, id);
+create unique index api_keys_hash_key on api_keys(hash);
+create index api_keys_created_at_idx on api_keys(created_at_ms, id);
+
+alter table channels add constraint channels_id_length_check
+  check (char_length(id) between 1 and 255);
+alter table channels add constraint channels_name_length_check
+  check (char_length(name) between 1 and 255);
+alter table bundles add constraint bundles_archive_byte_size_check
+  check (archive_byte_size >= 0 and archive_byte_size <= 9007199254740991);
+alter table bundle_patches add constraint bundle_patches_byte_size_check
+  check (byte_size >= 0 and byte_size <= 9007199254740991);
+alter table releases add constraint releases_revision_check
+  check (revision >= 1);
+alter table releases add constraint releases_kind_bundle_check
+  check ((kind = 'BUNDLE' and bundle_id is not null) or (kind = 'EMBEDDED' and bundle_id is null));
+alter table releases add constraint releases_strategy_target_check
+  check ((strategy = 'APP_VERSION' and target_app_version is not null and fingerprint_hash is null) or (strategy = 'FINGERPRINT' and target_app_version is null and fingerprint_hash is not null));
+alter table releases add constraint releases_rollout_cohort_count_check
+  check (rollout_cohort_count >= 0 and rollout_cohort_count <= 1000);
+alter table releases add constraint releases_operation_check
+  check (operation in ('DEPLOY', 'PROMOTE', 'ROLLBACK'));
+alter table release_catalogs add constraint release_catalogs_strategy_target_check
+  check ((strategy = 'APP_VERSION' and fingerprint_hash is null) or (strategy = 'FINGERPRINT' and fingerprint_hash is not null));
+alter table release_catalogs add constraint release_catalogs_generation_check
+  check (generation >= 1 and generation <= 9007199254740991);
+alter table release_catalogs add constraint release_catalogs_byte_size_check
+  check (byte_size >= 0 and byte_size <= 262144);
+alter table bundle_events add constraint bundle_events_type_check
+  check (type in ('UPDATE_APPLIED', 'RECOVERED', 'RELEASE_ADOPTED', 'UNCHANGED'));
+alter table bundle_events add constraint bundle_events_platform_check
+  check (platform in ('ios', 'android'));
+alter table bundle_events add constraint bundle_events_shape_check
+  check (((type in ('UPDATE_APPLIED', 'RECOVERED', 'RELEASE_ADOPTED')) and from_bundle_id is not null and update_strategy is not null and update_strategy in ('fingerprint', 'appVersion')) or (type = 'UNCHANGED' and from_bundle_id is null and update_strategy is null));
+alter table bundle_events add constraint bundle_events_received_at_check
+  check (received_at_ms >= 0);
+alter table api_keys add constraint api_keys_role_check
+  check (role = 'client');
+alter table api_keys add constraint api_keys_created_at_check
+  check (created_at_ms >= 0);
+alter table api_keys add constraint api_keys_revoked_at_check
+  check (revoked_at_ms is null or revoked_at_ms >= 0);
+
+alter table bundle_patches add constraint bundle_patches_bundle_id_fk
+  foreign key (bundle_id) references bundles(id) on update restrict on delete cascade;
+alter table bundle_patches add constraint bundle_patches_base_bundle_id_fk
+  foreign key (base_bundle_id) references bundles(id) on update restrict on delete cascade;
+alter table releases add constraint releases_channel_id_fk
+  foreign key (channel_id) references channels(id) on update restrict on delete restrict;
+alter table releases add constraint releases_bundle_id_fk
+  foreign key (bundle_id) references bundles(id) on update restrict on delete restrict;
+alter table releases add constraint releases_source_release_id_fk
+  foreign key (source_release_id) references releases(id) on update restrict on delete set null;
+alter table release_catalogs add constraint release_catalogs_channel_id_fk
+  foreign key (channel_id) references channels(id) on update restrict on delete restrict;
+
+insert into private_hot_updater_settings (key, value)
+values ('schema.core', '1.0.0')
+on conflict (key) do update set value = excluded.value;

package/sql/get_target_app_version_list.sql

@@ -1,21 +0,0 @@
--- HotUpdater.get_target_app_version_list
-
-CREATE OR REPLACE FUNCTION get_target_app_version_list (
-    app_platform platforms,
-    min_bundle_id uuid
-)
-RETURNS TABLE (
-    target_app_version text
-)
-LANGUAGE plpgsql
-AS
-$$
-BEGIN
-    RETURN QUERY
-    SELECT b.target_app_version
-    FROM bundles b 
-    WHERE b.platform = app_platform
-    AND b.id >= min_bundle_id
-    GROUP BY b.target_app_version;
-END;
-$$;

package/sql/get_update_info.spec.ts

@@ -1,171 +0,0 @@
-import { PGlite } from "@electric-sql/pglite";
-import {
-  type Bundle,
-  type GetBundlesArgs,
-  NIL_UUID,
-  type UpdateInfo,
-} from "@hot-updater/core";
-import { filterCompatibleAppVersions } from "@hot-updater/js";
-import { setupGetUpdateInfoTestSuite } from "@hot-updater/test-utils";
-import camelcaseKeys from "camelcase-keys";
-import { afterAll, beforeEach, describe } from "vitest";
-
-import { prepareSql } from "./prepareSql";
-
-const createInsertBundleQuery = (bundle: Bundle) => {
-  const rolloutCohortCount = bundle.rolloutCohortCount ?? 1000;
-  const targetCohorts = bundle.targetCohorts
-    ? `ARRAY[${bundle.targetCohorts.map((id) => `'${id}'`).join(",")}]::TEXT[]`
-    : "NULL";
-
-  return `
-    INSERT INTO bundles (
-      id, file_hash, platform, target_app_version,
-      should_force_update, enabled, git_commit_hash, message, channel, storage_uri, fingerprint_hash,
-      rollout_cohort_count, target_cohorts
-    ) VALUES (
-      '${bundle.id}',
-      '${bundle.fileHash}',
-      '${bundle.platform}',
-      ${bundle.targetAppVersion ? `'${bundle.targetAppVersion}'` : "null"},
-      ${bundle.shouldForceUpdate},
-      ${bundle.enabled},
-      ${bundle.gitCommitHash ? `'${bundle.gitCommitHash}'` : "null"},
-      ${bundle.message ? `'${bundle.message}'` : "null"},
-      '${bundle.channel}',
-      '${bundle.storageUri}',
-      ${bundle.fingerprintHash ? `'${bundle.fingerprintHash}'` : "null"},
-      ${rolloutCohortCount},
-      ${targetCohorts}
-    ) ON CONFLICT (id) DO UPDATE SET
-      file_hash = EXCLUDED.file_hash,
-      platform = EXCLUDED.platform,
-      target_app_version = EXCLUDED.target_app_version,
-      should_force_update = EXCLUDED.should_force_update,
-      enabled = EXCLUDED.enabled,
-      git_commit_hash = EXCLUDED.git_commit_hash,
-      message = EXCLUDED.message,
-      channel = EXCLUDED.channel,
-      storage_uri = EXCLUDED.storage_uri,
-      fingerprint_hash = EXCLUDED.fingerprint_hash,
-      rollout_cohort_count = EXCLUDED.rollout_cohort_count,
-      target_cohorts = EXCLUDED.target_cohorts;
-  `;
-};
-
-const createGetUpdateInfo =
-  (db: PGlite) =>
-  async (
-    bundles: Bundle[],
-    args: GetBundlesArgs,
-  ): Promise<UpdateInfo | null> => {
-    const {
-      bundleId,
-      platform,
-      minBundleId = NIL_UUID,
-      channel = "production",
-      _updateStrategy,
-    } = args;
-    await db.exec(createInsertBundleQuerys(bundles));
-
-    if (_updateStrategy === "fingerprint") {
-      const fingerprintHash = args.fingerprintHash;
-      const cohort = args.cohort;
-      const cohortSql = cohort ? `'${cohort}'` : "NULL";
-      const result = await db.query<{
-        id: string;
-        should_force_update: boolean;
-        message: string;
-        status: string;
-        storage_uri: string | null;
-        file_hash: string | null;
-      }>(
-        `
-      SELECT * FROM get_update_info_by_fingerprint_hash(
-        '${platform}',
-        '${bundleId}',
-        '${minBundleId}',
-        '${channel}',
-        '${fingerprintHash}',
-        ${cohortSql}
-      );
-      `,
-      );
-
-      if (!result.rows[0]) {
-        return null;
-      }
-
-      const row = result.rows[0];
-      return camelcaseKeys(row) as UpdateInfo;
-    }
-
-    const appVersion = args.appVersion;
-    const { rows: appVersionList } = await db.query<{
-      target_app_version: string;
-    }>(
-      `
-      SELECT target_app_version FROM get_target_app_version_list('${platform}', '${minBundleId}');
-      `,
-    );
-
-    const targetAppVersionList = filterCompatibleAppVersions(
-      appVersionList?.map((group) => group.target_app_version) ?? [],
-      appVersion,
-    );
-
-    const cohort = args.cohort;
-    const cohortSql = cohort ? `'${cohort}'` : "NULL";
-    const result = await db.query<{
-      id: string;
-      should_force_update: boolean;
-      message: string;
-      status: string;
-      storage_uri: string | null;
-      file_hash: string | null;
-    }>(
-      `
-      SELECT * FROM get_update_info_by_app_version(
-        '${platform}',
-        '${appVersion}',
-        '${bundleId}',
-        '${minBundleId ?? NIL_UUID}',
-        '${channel}',
-        ARRAY[${targetAppVersionList.map((v) => `'${v}'`).join(",")}]::text[],
-        ${cohortSql}
-      );
-      `,
-    );
-
-    if (!result.rows[0]) {
-      return null;
-    }
-
-    const row = result.rows[0];
-    return camelcaseKeys(row) as UpdateInfo;
-  };
-
-const createInsertBundleQuerys = (bundles: Bundle[]) => {
-  return bundles.map(createInsertBundleQuery).join("\n");
-};
-
-const db = new PGlite();
-
-const sql = await prepareSql();
-await db.exec(sql);
-const getUpdateInfo = createGetUpdateInfo(db);
-
-describe("getUpdateInfo", () => {
-  beforeEach(async () => {
-    await db.exec("DELETE FROM bundle_patches");
-    await db.exec("DELETE FROM bundles");
-  });
-
-  afterAll(async () => {
-    await db.close();
-  });
-
-  setupGetUpdateInfoTestSuite({
-    getUpdateInfo: getUpdateInfo,
-  });
-});

package/sql/get_update_info_by_app_version.sql

@@ -1,126 +0,0 @@
--- HotUpdater.get_update_info_by_app_version
-
-DROP FUNCTION IF EXISTS get_update_info_by_app_version;
-
-CREATE OR REPLACE FUNCTION get_update_info_by_app_version (
-    app_platform   platforms,
-    app_version text,
-    bundle_id  uuid,
-    min_bundle_id uuid,
-    target_channel text,
-    target_app_version_list text[],
-    cohort TEXT DEFAULT NULL
-)
-RETURNS TABLE (
-    id            uuid,
-    should_force_update  boolean,
-    message       text,
-    status        text,
-    storage_uri   text,
-    file_hash     text
-)
-LANGUAGE plpgsql
-AS
-$$
-DECLARE
-    NIL_UUID CONSTANT uuid := '00000000-0000-0000-0000-000000000000';
-BEGIN
-    RETURN QUERY
-    WITH candidate_bundles AS (
-        SELECT
-            b.id,
-            b.should_force_update,
-            b.message,
-            b.storage_uri,
-            b.file_hash,
-            b.rollout_cohort_count,
-            b.target_cohorts
-        FROM bundles b
-        WHERE b.enabled = TRUE
-          AND b.platform = app_platform
-          AND b.id >= min_bundle_id
-          AND b.target_app_version IN (SELECT unnest(target_app_version_list))
-          AND b.channel = target_channel
-    ),
-    current_candidate AS (
-        SELECT
-            cb.id,
-            is_cohort_eligible(
-                cb.id,
-                cohort,
-                cb.rollout_cohort_count,
-                cb.target_cohorts
-            ) AS is_eligible
-        FROM candidate_bundles cb
-        WHERE cb.id = bundle_id
-        LIMIT 1
-    ),
-    eligible_update_candidate AS (
-        SELECT
-            cb.id,
-            cb.should_force_update,
-            cb.message,
-            'UPDATE' AS status,
-            cb.storage_uri,
-            cb.file_hash
-        FROM candidate_bundles cb
-        WHERE cb.id > bundle_id
-          AND is_cohort_eligible(
-              cb.id,
-              cohort,
-              cb.rollout_cohort_count,
-              cb.target_cohorts
-          )
-        ORDER BY cb.id DESC
-        LIMIT 1
-    ),
-    rollback_candidate AS (
-        SELECT
-            cb.id,
-            TRUE AS should_force_update,
-            cb.message,
-            'ROLLBACK' AS status,
-            cb.storage_uri,
-            cb.file_hash
-        FROM candidate_bundles cb
-        WHERE cb.id < bundle_id
-          AND NOT EXISTS (
-              SELECT 1
-              FROM current_candidate
-              WHERE current_candidate.is_eligible = TRUE
-          )
-          AND NOT EXISTS (SELECT 1 FROM eligible_update_candidate)
-        ORDER BY cb.id DESC
-        LIMIT 1
-    ),
-    final_result AS (
-        SELECT * FROM eligible_update_candidate
-        UNION ALL
-        SELECT * FROM rollback_candidate
-        WHERE NOT EXISTS (SELECT 1 FROM eligible_update_candidate)
-    )
-    SELECT *
-    FROM final_result
-    WHERE final_result.id != bundle_id
-
-    UNION ALL
-
-    SELECT
-        NIL_UUID      AS id,
-        TRUE          AS should_force_update,
-        NULL          AS message,
-        'ROLLBACK'    AS status,
-        NULL          AS storage_uri,
-        NULL          AS file_hash
-    WHERE (SELECT COUNT(*) FROM final_result) = 0
-      AND bundle_id != NIL_UUID
-      AND bundle_id > min_bundle_id
-      AND NOT EXISTS (
-          SELECT 1
-          FROM current_candidate
-          WHERE current_candidate.is_eligible = TRUE
-      )
-      AND NOT EXISTS (SELECT 1 FROM eligible_update_candidate)
-      AND NOT EXISTS (SELECT 1 FROM rollback_candidate);
-END;
-$$;