repo,etc: rename respondRdr to replyMetadata

Author: yoursunny

pkg/repo-api/src/mod.ts

@@ -4,7 +4,6 @@ export * from "./copy";
 export * from "./data-array";
 export * from "./data-tape";
 export * from "./read-from-network";
-export * from "./respond-rdr";
 
 /**
  * Namespace consists of interfaces that form the DataStore API.
@@ -17,3 +16,11 @@ export * from "./respond-rdr";
  * if it should be explicitly closed.
  */
 export * as DataStore from "./data-store";
+
+import { replyMetadata } from "./reply-metadata";
+
+export {
+  replyMetadata,
+  /** @deprecated Use `replyMetadata` instead. */
+  replyMetadata as respondRdr,
+};

pkg/repo-api/src/respond-rdr.ts pkg/repo-api/src/reply-metadata.tspkg/repo-api/src/respond-rdr.ts renamed to pkg/repo-api/src/reply-metadata.ts

@@ -5,13 +5,13 @@ import { type Data, digestSigning, type Interest, type Name, type NamingConventi
 import type * as S from "./data-store";
 
 /**
- * Respond to RDR discovery Interest with RDR metadata describing the latest version
+ * Respond to metadata discovery Interest with metadata packet describing the latest version
  * among stored Data.
  */
-export async function respondRdr(interest: Interest, store: S.ListNames, {
+export async function replyMetadata(interest: Interest, store: S.ListNames, {
   versionConvention = Version,
   signer = digestSigning,
-}: respondRdr.Options = {}): Promise<Data | undefined> {
+}: replyMetadata.Options = {}): Promise<Data | undefined> {
   if (!isDiscoveryInterest(interest)) {
     return undefined;
   }
@@ -37,7 +37,7 @@ export async function respondRdr(interest: Interest, store: S.ListNames, {
   return makeMetadataPacket(new Metadata(bestName), { signer });
 }
 
-export namespace respondRdr {
+export namespace replyMetadata {
   export interface Options {
     /**
      * Version naming convention.

pkg/repo-cli/README.md

@@ -8,7 +8,7 @@ This package is part of [NDNts](https://yoursunny.com/p/NDNts/), Named Data Netw
 
 ```bash
 # with NFD running, start the repo server
-ndnts-repo server --store=/tmp/repo --rdr=true
+ndnts-repo server --store=/tmp/repo --metadata=true
 ```
 
 ## `ndnts-repo fillbi`: Fill Repo with Demo Data

pkg/repo-cli/src/server.ts

@@ -2,14 +2,14 @@ import { createServer } from "node:net";
 
 import { exitClosers, getSigner, openUplinks } from "@ndn/cli-common";
 import { joinHostPort } from "@ndn/node-transport";
-import { type DataStore, RepoProducer, respondRdr } from "@ndn/repo";
+import { type DataStore, metadataFallback, RepoProducer } from "@ndn/repo";
 import { BulkInsertTarget } from "@ndn/repo-api";
 import type { CommandModule } from "yargs";
 
 import { openStore, type StoreArgs, storeOptions } from "./util";
 
 interface Args extends StoreArgs {
-  rdr: boolean;
+  metadata: boolean;
   bi: boolean;
   "bi-host": string;
   "bi-port": number;
@@ -44,9 +44,9 @@ export const ServerCommand: CommandModule<{}, Args> = {
   builder(argv) {
     return argv
       .options(storeOptions)
-      .option("rdr", {
+      .option("metadata", {
         default: false,
-        desc: "respond to RDR discovery Interests",
+        desc: "reply to metadata discovery Interests",
         type: "boolean",
       })
       .option("bi", {
@@ -80,7 +80,7 @@ export const ServerCommand: CommandModule<{}, Args> = {
     await openUplinks();
     const store = await openStore(args);
     const producer = RepoProducer.create(store, {
-      fallback: args.rdr ? respondRdr({ signer: await getSigner() }) : undefined,
+      fallback: args.metadata ? metadataFallback({ signer: await getSigner() }) : undefined,
     });
     exitClosers.push(producer);
 

pkg/repo/src/metadata-fallback.ts

@@ -0,0 +1,16 @@
+import { replyMetadata } from "@ndn/repo-api";
+
+import type { RepoProducer } from "./producer";
+
+/**
+ * Provide a {@link RepoProducer.FallbackHandler} that replies to metadata discovery Interests.
+ *
+ * @remarks
+ * The returned function should be passed as {@link RepoProducer.Options.fallback}.
+ */
+export function metadataFallback(opts: replyMetadata.Options = {}): RepoProducer.FallbackHandler {
+  return (interest, producer, store) => {
+    void producer;
+    return replyMetadata(interest, store, opts);
+  };
+}

pkg/repo/src/mod.ts

@@ -3,4 +3,11 @@ export { makeInMemoryDataStore } from "./data-store-memory";
 export { makePersistentDataStore } from "./data-store-persistent";
 export * from "./prefix-reg/mod";
 export { RepoProducer } from "./producer";
-export { respondRdr } from "./respond-rdr";
+
+import { metadataFallback } from "./metadata-fallback";
+
+export {
+  metadataFallback,
+  /** @deprecated Use `metadataFallback` instead. */
+  metadataFallback as respondRdr,
+};

pkg/repo/src/producer.ts

@@ -65,7 +65,7 @@ export namespace RepoProducer {
      * Interest handler function for when Data is not found in repo.
      *
      * @remarks
-     * To support RDR metadata version discovery, pass {@link respondRdr} as this option.
+     * To support version discovery via metadata retrieval protocol, pass {@link metadataFallback} as this option.
      */
     fallback?: FallbackHandler;
 

pkg/repo/src/respond-rdr.ts

@@ -8,7 +8,7 @@ import { Component, Data, Interest, Name, type NameLike, NameMultiSet } from "@n
 import { delay } from "@ndn/util";
 import { beforeEach, expect, test } from "vitest";
 
-import { type DataStore, makeInMemoryDataStore, PrefixRegShorter, PrefixRegStatic, PrefixRegStrip, RepoProducer, respondRdr } from "..";
+import { type DataStore, makeInMemoryDataStore, metadataFallback, PrefixRegShorter, PrefixRegStatic, PrefixRegStrip, RepoProducer } from "..";
 
 let store: DataStore;
 let announced: NameMultiSet; // could be NameSet
@@ -118,7 +118,7 @@ test("prefixreg strip custom", async () => {
   expect(listAnnounced()).toEqualNames([]);
 });
 
-test("respondRdr", async () => {
+test("metadataFallback", async () => {
   await insertData(
     "/A/9",
     new Name("/A").append(Version, 6),
@@ -129,7 +129,7 @@ test("respondRdr", async () => {
 
   using _producer = RepoProducer.create(store, {
     reg: PrefixRegStatic(new Name("/A")),
-    fallback: respondRdr(),
+    fallback: metadataFallback(),
   });
 
   const metadata = await retrieveMetadata("/A");