[FEAT] object store compatibility test

.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1,8 @@
+blank_issues_enabled: false
+contact_links:
+  - name: Discussion
+    url: https://github.com/nats-io/nats.deno/discussions
+    about: Ideal for ideas, feedback, or longer form questions.
+  - name: Chat
+    url: https://slack.nats.io
+    about: Ideal for short, one-off questions, general conversation, and meeting other NATS users!

.github/ISSUE_TEMPLATE/defect.yml

@@ -0,0 +1,41 @@
+---
+name: Defect
+description: Report a defect, such as a bug or regression.
+labels:
+  - defect
+body:
+  - type: textarea
+    id: versions
+    attributes:
+      label: What version were you using?
+      description: Include the server version (`nats-server --version`) and any client versions when observing the issue.
+    validations:
+      required: true
+  - type: textarea
+    id: environment
+    attributes:
+      label: What environment was the server running in?
+      description: This pertains to the operating system, CPU architecture, and/or Docker image that was used.
+    validations:
+      required: true
+  - type: textarea
+    id: steps
+    attributes:
+      label: Is this defect reproducible?
+      description: Provide best-effort steps to showcase the defect.
+    validations:
+      required: true
+  - type: textarea
+    id: expected
+    attributes:
+      label: Given the capability you are leveraging, describe your expectation?
+      description: This may be the expected behavior or performance characteristics.
+    validations:
+      required: true
+  - type: textarea
+    id: actual
+    attributes:
+      label: Given the expectation, what is the defect you are observing?
+      description: This may be an unexpected behavior or regression in performance.
+    validations:
+      required: true

.github/ISSUE_TEMPLATE/proposal.yml

@@ -0,0 +1,34 @@
+---
+name: Proposal
+description: Propose an enhancement or new feature.
+labels:
+  - proposal
+body:
+  - type: textarea
+    id: usecase
+    attributes:
+      label: What motivated this proposal?
+      description: Describe the use case justifying this request.
+    validations:
+      required: true
+  - type: textarea
+    id: change
+    attributes:
+      label: What is the proposed change?
+      description: This could be a behavior change, enhanced API, or a branch new feature.
+    validations:
+      required: true
+  - type: textarea
+    id: benefits
+    attributes:
+      label: Who benefits from this change?
+      description: Describe how this not only benefits you.
+    validations:
+      required: false
+  - type: textarea
+    id: alternates
+    attributes:
+      label: What alternatives have you evaluated?
+      description: This could be using existing features or relying on an external dependency.
+    validations:
+      required: false

.github/workflows/test.yml

@@ -16,7 +16,7 @@ jobs:
     environment: CI
     strategy:
       matrix:
-        deno-version: [1.36.1]
+        deno-version: [1.36.4]
 
     steps:
       - name: Git Checkout Deno Module
@@ -30,7 +30,7 @@ jobs:
           deno-version: ${{ matrix.deno-version }}
 
       - name: Set NATS Server Version
-        run: echo "NATS_VERSION=v2.9.21" >> $GITHUB_ENV
+        run: echo "NATS_VERSION=v2.10.1" >> $GITHUB_ENV
 
       # this here because dns seems to be wedged on gha
 #      - name: Add hosts to /etc/hosts

bin/bundle.ts

@@ -0,0 +1,58 @@
+/*
+ * Copyright 2023 The NATS Authors
+ * 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.
+ */
+import { cli } from "https://deno.land/x/cobra@v0.0.9/mod.ts";
+import { bundle } from "https://deno.land/x/emit@0.26.0/mod.ts";
+
+const root = cli({
+  use: "bundle javascript/typescript",
+  run: async (_cmd, _args, flags) => {
+    const src = flags.value<string>("src");
+    const out = flags.value<string>("out");
+    const type = flags.value<boolean>("module") ? "module" : "classic";
+    try {
+      const r = URL.canParse(src)
+        ? await bundle(new URL(src), { type })
+        : await bundle(src, { type });
+      await Deno.writeTextFile(out, r.code);
+      console.log(`wrote ${out}`);
+      return 0;
+    } catch (err) {
+      console.log(`failed to bundle: ${err.message}`);
+      console.log(err.stack);
+      return 1;
+    }
+  },
+});
+
+root.addFlag({
+  name: "src",
+  type: "string",
+  usage: "input module source path",
+  required: true,
+});
+root.addFlag({
+  name: "out",
+  type: "string",
+  usage: "output bundle path",
+  required: true,
+});
+root.addFlag({
+  name: "module",
+  type: "boolean",
+  usage: "output esm module (default)",
+  default: true,
+});
+
+Deno.exit(await root.execute(Deno.args));

bin/exports.ts

@@ -13,13 +13,13 @@
  * limitations under the License.
  */
 
-import { parse } from "https://deno.land/std@0.190.0/flags/mod.ts";
+import { parse } from "https://deno.land/std@0.200.0/flags/mod.ts";
 import {
   basename,
   extname,
   join,
   resolve,
-} from "https://deno.land/std@0.190.0/path/mod.ts";
+} from "https://deno.land/std@0.200.0/path/mod.ts";
 
 const argv = parse(
   Deno.args,

bin/fix-os.ts

@@ -12,7 +12,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-import { parse } from "https://deno.land/std@0.190.0/flags/mod.ts";
+import { parse } from "https://deno.land/std@0.200.0/flags/mod.ts";
 import { ObjectStoreImpl, ServerObjectInfo } from "../jetstream/objectstore.ts";
 import {
   connect,

bin/os_compatibility.ts

@@ -0,0 +1,207 @@
+/*
+ * Copyright 2023 The NATS Authors
+ * 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.
+ */
+
+import { connect, millis, Msg } from "../src/mod.ts";
+import { sha256 } from "https://denopkg.com/chiefbiiko/sha256@v1.0.0/mod.ts";
+
+const nc = await connect({ servers: "localhost:4222" });
+const js = nc.jetstream();
+console.log("connected");
+
+const sub = nc.subscribe("tests.object-store.>");
+
+const defaultBucket = async function (m: Msg): Promise<void> {
+  const config = m.json<{
+    config: {
+      bucket: string;
+    };
+  }>();
+  await js.views.os(config.config.bucket);
+  m.respond();
+};
+
+const customBucket = async function (m: Msg): Promise<void> {
+  const testRequest = m.json<{ config: Record<string, unknown> }>();
+  console.log(`custom  config: ${JSON.stringify(testRequest)}`);
+  const name = testRequest.config.bucket as string || "";
+  delete testRequest.config.bucket;
+  testRequest.config.millis = millis(testRequest.config.max_age as number || 0);
+  await js.views.os(name, testRequest.config);
+  m.respond();
+};
+
+const putObject = async function (m: Msg): Promise<void> {
+  const testRequest = m.json<{
+    bucket: string;
+    url: string;
+    config: {
+      description: string;
+      name: string;
+    };
+  }>();
+  console.log(`put object config: ${JSON.stringify(testRequest)}`);
+
+  const file = await fetch(testRequest.url);
+
+  if (!file.body) {
+    throw new Error("Failed to fetch body");
+  }
+  const bucket = await js.views.os(testRequest.bucket);
+
+  await bucket.put(testRequest.config, file.body);
+  m.respond();
+};
+
+const getObject = async function (m: Msg): Promise<void> {
+  const testRequest = m.json<
+    {
+      bucket: string;
+      object: string;
+    }
+  >();
+  console.log(`get object config: ${JSON.stringify(testRequest)}`);
+
+  const bucket = await js.views.os(testRequest.bucket);
+  const object = await bucket.getBlob(testRequest.object);
+
+  if (!object) {
+    throw new Error("Failed to get object");
+  }
+
+  const hash = sha256(object);
+  m.respond(hash);
+};
+
+const updateMetadata = async function (m: Msg): Promise<void> {
+  const testRequest = m.json<
+    {
+      bucket: string;
+      object: string;
+      config: {
+        description: string;
+        name: string;
+      };
+    }
+  >();
+  const bucket = await js.views.os(testRequest.bucket);
+  await bucket.update(testRequest.object, testRequest.config);
+  m.respond();
+};
+
+const watchUpdates = async function (m: Msg): Promise<void> {
+  const testRequest = m.json<{
+    bucket: string;
+  }>();
+
+  const bucket = await js.views.os(testRequest.bucket);
+  const iter = await bucket.watch({ includeHistory: false });
+
+  for await (const object of iter) {
+    m.respond(object?.digest);
+    break;
+  }
+};
+
+const watch = async function (m: Msg): Promise<void> {
+  const testRequest = m.json<{
+    bucket: string;
+  }>();
+
+  const bucket = await js.views.os(testRequest.bucket);
+  const iter = await bucket.watch({ includeHistory: true });
+
+  const values: string[] = [];
+  for await (const object of iter) {
+    if (object) {
+      values.push(object.digest);
+    }
+    if (values.length == 2) {
+      break; // Exit the loop once two values have been collected
+    }
+  }
+  const result = values.join(",");
+  m.respond(result);
+};
+
+const getLink = async function (m: Msg): Promise<void> {
+  const testRequest = m.json<{
+    object: string;
+    bucket: string;
+  }>();
+
+  const bucket = await js.views.os(testRequest.bucket);
+  const object = await bucket.getBlob(testRequest.object);
+
+  if (object) {
+    const hash = sha256(object);
+    m.respond(hash);
+  }
+};
+
+const putLink = async function (m: Msg): Promise<void> {
+  const testRequest = m.json<{
+    object: string;
+    bucket: string;
+    link_name: string;
+  }>();
+
+  const bucket = await js.views.os(testRequest.bucket);
+  const object = await bucket.get(testRequest.object);
+
+  if (object) {
+    await bucket.link(testRequest.link_name, object.info);
+  }
+  m.respond();
+};
+
+const result = function (test: string) {
+  return function (message: Msg): Promise<void> {
+    if (message.headers) {
+      console.log(`test ${test} failed`);
+      return Promise.reject("test failed");
+    } else {
+      console.log(`test ${test} ok`);
+      return Promise.resolve();
+    }
+  };
+};
+
+const opts = [
+  defaultBucket,
+  result("defaultBucket"),
+  customBucket,
+  result("customBucket"),
+  putObject,
+  result("putObject"),
+  getObject,
+  result("getObject"),
+  updateMetadata,
+  result("updateMetadata"),
+  watchUpdates,
+  result("watchUpdates"),
+  watch,
+  result("watch"),
+  getLink,
+  result("getLink"),
+  putLink,
+  result("putLink"),
+];
+
+console.log("waiting for tests");
+let i = 0;
+for await (const m of sub) {
+  await opts[i++](m);
+}
+console.log("all tests done");