@forwardimpact/svcmemory 0.1.84

package/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 the 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 2026 Dick Olsson
+
+   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.

package/index.js

@@ -0,0 +1,83 @@
+import { services } from "@forwardimpact/librpc";
+import { MemoryWindow } from "@forwardimpact/libmemory";
+import { MemoryIndex } from "@forwardimpact/libmemory/index/memory.js";
+
+const { MemoryBase } = services;
+
+/**
+ * Memory service for managing transient resources and memory windows
+ */
+export class MemoryService extends MemoryBase {
+  #storage;
+  #resourceIndex;
+  #indices = new Map();
+  #maxTokens;
+
+  /**
+   * Creates a new Memory service instance
+   * @param {import("@forwardimpact/libconfig").ServiceConfigInterface} config - Service configuration object
+   * @param {import("@forwardimpact/libstorage").StorageInterface} storage - Storage instance for memories
+   * @param {import("@forwardimpact/libresource").ResourceIndex} resourceIndex - Resource index for loading resources
+   */
+  constructor(config, storage, resourceIndex) {
+    super(config);
+    if (!storage) throw new Error("storage is required");
+    if (!resourceIndex) throw new Error("resourceIndex is required");
+
+    this.#storage = storage;
+    this.#resourceIndex = resourceIndex;
+    this.#maxTokens = config.max_tokens;
+    if (!this.#maxTokens || this.#maxTokens <= 0) {
+      throw new Error("config.max_tokens is required and must be positive");
+    }
+  }
+
+  /**
+   * Gets (and creates if necessary) the MemoryIndex for a specific resource
+   * @param {string} id - Resource ID
+   * @returns {MemoryIndex} MemoryIndex instance for the resource
+   * @private
+   */
+  #getMemoryIndex(id) {
+    if (!this.#indices.has(id)) {
+      const key = `${id}.jsonl`;
+      const index = new MemoryIndex(this.#storage, key);
+      this.#indices.set(id, index);
+    }
+    return this.#indices.get(id);
+  }
+
+  /** @inheritdoc */
+  async AppendMemory(req) {
+    if (!req.resource_id) throw new Error("resource_id is required");
+
+    const memoryIndex = this.#getMemoryIndex(req.resource_id);
+    const window = new MemoryWindow(
+      req.resource_id,
+      this.#resourceIndex,
+      memoryIndex,
+    );
+
+    if (req.identifiers && req.identifiers.length > 0) {
+      await window.append(req.identifiers);
+    }
+
+    return { accepted: req.resource_id };
+  }
+
+  /** @inheritdoc */
+  async GetWindow(req) {
+    if (!req.resource_id) throw new Error("resource_id is required");
+    if (!req.model) throw new Error("model is required");
+
+    const memoryIndex = this.#getMemoryIndex(req.resource_id);
+    const window = new MemoryWindow(
+      req.resource_id,
+      this.#resourceIndex,
+      memoryIndex,
+    );
+    const { messages, tools } = await window.build(req.model, this.#maxTokens);
+
+    return { messages, tools, max_tokens: this.#maxTokens };
+  }
+}

package/package.json

@@ -0,0 +1,22 @@
+{
+  "name": "@forwardimpact/svcmemory",
+  "version": "0.1.84",
+  "description": "Memory service for managing transient resources and memory windows",
+  "type": "module",
+  "main": "index.js",
+  "scripts": {
+    "dev": "node --watch server.js",
+    "start": "npx download && node server.js",
+    "test": "node --test test/*.test.js"
+  },
+  "dependencies": {
+    "@forwardimpact/libconfig": "^0.1.58",
+    "@forwardimpact/libmemory": "^0.1.33",
+    "@forwardimpact/libresource": "^0.1.89",
+    "@forwardimpact/librpc": "^0.1.77",
+    "@forwardimpact/libstorage": "^0.1.53"
+  },
+  "devDependencies": {
+    "@forwardimpact/libharness": "^0.1.5"
+  }
+}

package/server.js

@@ -0,0 +1,23 @@
+#!/usr/bin/env node
+import { Server } from "@forwardimpact/librpc";
+import { createServiceConfig } from "@forwardimpact/libconfig";
+import { createStorage } from "@forwardimpact/libstorage";
+import { createTracer } from "@forwardimpact/librpc";
+import { createLogger } from "@forwardimpact/libtelemetry";
+import { createResourceIndex } from "@forwardimpact/libresource";
+
+import { MemoryService } from "./index.js";
+
+const config = await createServiceConfig("memory");
+
+// Initialize observability
+const logger = createLogger("memory");
+const tracer = await createTracer("memory");
+
+const memoryStorage = createStorage("memories");
+const resourceIndex = createResourceIndex("resources");
+
+const service = new MemoryService(config, memoryStorage, resourceIndex);
+const server = new Server(service, config, logger, tracer);
+
+await server.start();

package/test/memory.test.js

@@ -0,0 +1,275 @@
+import { test, describe, beforeEach } from "node:test";
+import assert from "node:assert";
+import { resource, common } from "@forwardimpact/libtype";
+
+// Module under test
+import { MemoryService } from "../index.js";
+import {
+  createMockConfig,
+  createMockStorage,
+  createMockResourceIndex,
+} from "@forwardimpact/libharness";
+
+describe("memory service", () => {
+  describe("MemoryService", () => {
+    test("exports MemoryService class", () => {
+      assert.strictEqual(typeof MemoryService, "function");
+      assert.ok(MemoryService.prototype);
+    });
+
+    test("MemoryService has AppendMemory method", () => {
+      assert.strictEqual(
+        typeof MemoryService.prototype.AppendMemory,
+        "function",
+      );
+    });
+
+    test("MemoryService has GetWindow method", () => {
+      assert.strictEqual(typeof MemoryService.prototype.GetWindow, "function");
+    });
+
+    test("MemoryService constructor accepts expected parameters", () => {
+      // Test constructor signature by checking parameter count
+      assert.strictEqual(MemoryService.length, 3); // config, storage, resourceIndex
+    });
+
+    test("MemoryService has proper method signatures", () => {
+      const methods = Object.getOwnPropertyNames(MemoryService.prototype);
+      assert(methods.includes("AppendMemory"));
+      assert(methods.includes("GetWindow"));
+      assert(methods.includes("constructor"));
+    });
+  });
+
+  describe("MemoryService business logic", () => {
+    let mockConfig;
+    let mockStorage;
+    let mockResourceIndex;
+
+    beforeEach(() => {
+      mockConfig = createMockConfig("memory");
+      mockStorage = createMockStorage();
+      mockResourceIndex = createMockResourceIndex({ tools: ["search"] });
+    });
+
+    test("constructor validates required dependencies", () => {
+      assert.throws(
+        () => new MemoryService(mockConfig, null),
+        /storage is required/,
+      );
+
+      assert.throws(
+        () => new MemoryService(mockConfig, mockStorage, null),
+        /resourceIndex is required/,
+      );
+    });
+
+    test("creates service instance with valid parameters", () => {
+      const service = new MemoryService(
+        mockConfig,
+        mockStorage,
+        mockResourceIndex,
+      );
+
+      assert.ok(service);
+      assert.strictEqual(service.config, mockConfig);
+    });
+
+    test("AppendMemory validates required resource_id parameter", async () => {
+      const service = new MemoryService(
+        mockConfig,
+        mockStorage,
+        mockResourceIndex,
+      );
+
+      await assert.rejects(
+        () => service.AppendMemory({ identifiers: [] }),
+        /resource_id is required/,
+      );
+    });
+
+    test("AppendMemory processes identifiers correctly", async () => {
+      const service = new MemoryService(
+        mockConfig,
+        mockStorage,
+        mockResourceIndex,
+      );
+
+      const result = await service.AppendMemory({
+        resource_id: "test-conversation",
+        identifiers: [
+          resource.Identifier.fromObject({
+            type: "common.Message",
+            name: "message1",
+            tokens: 10,
+          }),
+        ],
+      });
+
+      assert.ok(result);
+      assert.strictEqual(result.accepted, "test-conversation");
+    });
+
+    test("GetWindow validates required resource_id parameter", async () => {
+      const service = new MemoryService(
+        mockConfig,
+        mockStorage,
+        mockResourceIndex,
+      );
+
+      await assert.rejects(
+        () => service.GetWindow({}),
+        /resource_id is required/,
+      );
+    });
+
+    test("GetWindow validates required model parameter", async () => {
+      const service = new MemoryService(
+        mockConfig,
+        mockStorage,
+        mockResourceIndex,
+      );
+
+      await assert.rejects(
+        () => service.GetWindow({ resource_id: "test-conversation" }),
+        /model is required/,
+      );
+
+      await assert.rejects(
+        () =>
+          service.GetWindow({ resource_id: "test-conversation", model: "" }),
+        /model is required/,
+      );
+    });
+
+    test("GetWindow returns messages and tools structure with max_tokens", async () => {
+      const service = new MemoryService(
+        mockConfig,
+        mockStorage,
+        mockResourceIndex,
+      );
+
+      const result = await service.GetWindow({
+        resource_id: "test-conversation",
+        model: "test-model-1000",
+      });
+
+      assert.ok(result);
+      assert.ok(Array.isArray(result.messages), "Should have messages array");
+      assert.ok(Array.isArray(result.tools), "Should have tools array");
+      assert.strictEqual(
+        result.max_tokens,
+        4096,
+        "Should include max_tokens from config",
+      );
+    });
+
+    test("GetWindow returns assistant as first message", async () => {
+      const service = new MemoryService(
+        mockConfig,
+        mockStorage,
+        mockResourceIndex,
+      );
+
+      const result = await service.GetWindow({
+        resource_id: "test-conversation",
+        model: "test-model-1000",
+      });
+
+      assert.ok(
+        result.messages.length >= 1,
+        "Should have at least one message",
+      );
+      assert.strictEqual(
+        result.messages[0].id?.name,
+        "test-agent",
+        "First message should be assistant",
+      );
+    });
+
+    test("GetWindow returns tools from assistant configuration", async () => {
+      const service = new MemoryService(
+        mockConfig,
+        mockStorage,
+        mockResourceIndex,
+      );
+
+      const result = await service.GetWindow({
+        resource_id: "test-conversation",
+        model: "test-model-1000",
+      });
+
+      assert.strictEqual(result.tools.length, 1, "Should have 1 tool");
+      assert.strictEqual(
+        result.tools[0].function?.name,
+        "search",
+        "Tool should be search",
+      );
+    });
+
+    test("GetWindow returns conversation messages within budget", async () => {
+      // Override max_tokens to fit within test model context (1000 tokens)
+      const customConfig = {
+        ...mockConfig,
+        max_tokens: 100,
+      };
+
+      // Add some test messages to memory
+      await mockStorage.append(
+        "test-conversation.jsonl",
+        JSON.stringify({
+          id: "common.Message.message1",
+          identifier: resource.Identifier.fromObject({
+            type: "common.Message",
+            name: "message1",
+            tokens: 15,
+          }),
+        }),
+      );
+      await mockStorage.append(
+        "test-conversation.jsonl",
+        JSON.stringify({
+          id: "common.Message.message2",
+          identifier: resource.Identifier.fromObject({
+            type: "common.Message",
+            name: "message2",
+            tokens: 20,
+          }),
+        }),
+      );
+
+      // Add messages to resource index so they can be loaded
+      mockResourceIndex.addMessage(
+        common.Message.fromObject({
+          id: { name: "message1", tokens: 15 },
+          role: "user",
+          content: "Hello",
+        }),
+      );
+      mockResourceIndex.addMessage(
+        common.Message.fromObject({
+          id: { name: "message2", tokens: 20 },
+          role: "assistant",
+          content: "Hi there",
+        }),
+      );
+
+      const service = new MemoryService(
+        customConfig,
+        mockStorage,
+        mockResourceIndex,
+      );
+
+      const result = await service.GetWindow({
+        resource_id: "test-conversation",
+        model: "test-model-1000",
+      });
+
+      // Should return assistant + 2 conversation messages
+      assert.strictEqual(result.messages.length, 3);
+      assert.strictEqual(result.messages[0].id?.name, "test-agent");
+      assert.strictEqual(result.messages[1].id?.name, "message1");
+      assert.strictEqual(result.messages[2].id?.name, "message2");
+    });
+  });
+});