feat: Allow using testIndex for numberic fields like order. (#598)

joist-orm · Mar 31, 2023 · 6d841df · 6d841df
1 parent 77c55a1
commit 6d841df
Show file tree

Hide file tree

Showing 3 changed files with 25 additions and 9 deletions.
diff --git a/packages/integration-tests/src/EntityManager.factories.test.ts b/packages/integration-tests/src/EntityManager.factories.test.ts
@@ -22,7 +22,7 @@ import {
   PublisherType,
   SmallPublisher,
 } from "@src/entities";
-import { maybeNew, maybeNewPoly, newTestInstance } from "joist-orm";
+import { maybeNew, maybeNewPoly, newTestInstance, testIndex } from "joist-orm";
 import { newEntityManager } from "./setupDbTests";
 
 describe("EntityManager.factories", () => {
@@ -129,7 +129,7 @@ describe("EntityManager.factories", () => {
     newBook(em);
     // Then the newAuthor factory was told to override any `books: [{}]` defaults
     expect(lastAuthorFactoryOpts).toStrictEqual({
-      firstName: "aTEST_INDEX",
+      firstName: `a${testIndex}`,
       image: undefined,
       age: 40,
       books: [],
@@ -150,7 +150,7 @@ describe("EntityManager.factories", () => {
     expect(a1.publisher.get).toEqual(p1);
     // And we explicitly passed the publisher b/c it's an explicit `use` entry
     expect(lastAuthorFactoryOpts).toStrictEqual({
-      firstName: "aTEST_INDEX",
+      firstName: `a${testIndex}`,
       image: undefined,
       age: 40,
       books: [],
@@ -191,6 +191,7 @@ describe("EntityManager.factories", () => {
     expect(lastBookFactoryOpts).toStrictEqual({
       author: expect.any(Author),
       use: expect.any(Map),
+      order: testIndex,
     });
   });
 
@@ -259,8 +260,9 @@ describe("EntityManager.factories", () => {
     newBookReview(em, { book: {} });
     expect(lastBookFactoryOpts).toStrictEqual({
       author: maybeNew<Author>({ age: 40 }),
-      title: "Book for Review TEST_INDEX",
+      title: `Book for Review ${testIndex}`,
       reviews: [],
+      order: testIndex,
       use: expect.any(Map),
     });
   });
@@ -269,7 +271,7 @@ describe("EntityManager.factories", () => {
     const em = newEntityManager();
     newImage(em, { author: {} });
     expect(lastAuthorFactoryOpts).toStrictEqual({
-      firstName: "aTEST_INDEX",
+      firstName: `a${testIndex}`,
       age: undefined,
       image: null,
       use: expect.any(Map),
@@ -617,4 +619,11 @@ describe("EntityManager.factories", () => {
       expect(br3.book.get.author.get.age).toBeUndefined();
     });
   });
+
+  it("can have test indexes that are numbers", async () => {
+    const em = newEntityManager();
+    const [b1, b2] = [newBook(em), newBook(em)];
+    expect(b1.order).toBe(1);
+    expect(b2.order).toBe(2);
+  });
 });
diff --git a/packages/integration-tests/src/entities/Book.factories.ts b/packages/integration-tests/src/entities/Book.factories.ts
@@ -1,4 +1,4 @@
-import { DeepNew, EntityManager, FactoryOpts, maybeNew, newTestInstance } from "joist-orm";
+import { DeepNew, EntityManager, FactoryOpts, maybeNew, newTestInstance, testIndex } from "joist-orm";
 import { Author, Book } from "./entities";
 
 // for testing factories
@@ -9,5 +9,6 @@ export function newBook(em: EntityManager, opts: FactoryOpts<Book> = {}): DeepNe
   return newTestInstance(em, Book, opts, {
     // Pass a default age so that we can test deep-merging author.age and opts.firstName
     author: maybeNew<Author>({ age: 40 }),
+    order: testIndex,
   });
 }
diff --git a/packages/orm/src/newTestInstance.ts b/packages/orm/src/newTestInstance.ts
@@ -90,9 +90,13 @@ export function newTestInstance<T extends Entity>(
           case "enum":
           case "primaryKey":
             // Look for strings that want to use the test index
-            if (typeof optValue === "string" && optValue.includes(testIndex)) {
+            if (typeof optValue === "string" && optValue.includes(testIndexString)) {
               const actualIndex = getTestIndex(em, meta.cstr);
-              return [fieldName, optValue.replace(testIndex, String(actualIndex))];
+              const value = optValue.replace(testIndexString, String(actualIndex));
+              return [fieldName, value];
+            } else if (typeof optValue === "number" && optValue === testIndex) {
+              const actualIndex = getTestIndex(em, meta.cstr);
+              return [fieldName, actualIndex];
             }
             // Otherwise just use the user's opt value as-is
             return [fieldName, optValue];
@@ -332,7 +336,9 @@ function applyUse(optsMaybeNew: object, use: UseMap, metadata: EntityMetadata<an
  * This is meant to just be a helpful identifier in fields like entity names/descriptions for
  * debugging purposes.
  */
-export const testIndex = "TEST_INDEX";
+export const testIndex: number = 1_111_111_222;
+
+const testIndexString = String(testIndex);
 
 const defaultValueMarker: any = {};