refactor: extract db model factories package

Related to #83

apps/api/.eslintrc.json

@@ -1,6 +1,14 @@
 {
   "extends": "@serieslist/eslint-config-base",
   "root": true,
+  "rules": {
+    "no-restricted-imports": [
+      "error",
+      {
+        "patterns": ["#/features/*/*", "!#/features/*/jobs"]
+      }
+    ]
+  },
   "overrides": [
     {
       "files": ["src/test/mockTMDBServer.ts"],

apps/api/package.json

@@ -72,6 +72,7 @@
     "@graphql-codegen/client-preset": "^4.0.1",
     "@graphql-tools/executor-http": "^1.0.0",
     "@graphql-typed-document-node/core": "^3.2.0",
+    "@serieslist/db-factories": "workspace:^",
     "@serieslist/esbuild": "workspace:*",
     "@serieslist/eslint-config-base": "workspace:*",
     "@serieslist/prettier-config": "workspace:*",

apps/api/src/features/auth/__tests__/auth.schema.test.ts

@@ -1,8 +1,8 @@
 import { user, type User } from '@serieslist/db'
+import { userFactory } from '@serieslist/db-factories'
 import { eq } from 'drizzle-orm'
 import { nanoid } from 'nanoid'
 
-import { userFactory } from '#/features/users'
 import type { LoginInput, RegisterInput } from '#/generated/gql/graphql'
 import { graphql } from '#/generated/gql/index'
 import { db } from '#/lib/db'

apps/api/src/features/series/__tests__/series.schema.test.ts

@@ -6,6 +6,13 @@ import {
   series,
   userSeriesStatus,
 } from '@serieslist/db'
+import {
+  episodeFactory,
+  seasonFactory,
+  seriesFactory,
+  userSeriesStatusFactory,
+  userFactory,
+} from '@serieslist/db-factories'
 import {
   tmdbSeasonFactory,
   tmdbEpisodeFactory,
@@ -19,7 +26,6 @@ import { subDays } from 'date-fns'
 import { and, eq } from 'drizzle-orm'
 import { nanoid } from 'nanoid'
 
-import { userFactory } from '#/features/users'
 import { graphql } from '#/generated/gql'
 import type { SeriesUpdateStatusInput } from '#/generated/gql/graphql'
 import { db } from '#/lib/db'
@@ -31,11 +37,6 @@ import {
 } from '#/test/testUtils'
 import { parseDate } from '#/utils/date'
 
-import { episodeFactory } from '../episode.factory'
-import { seasonFactory } from '../season.factory'
-import { seriesFactory } from '../series.factory'
-import { userSeriesStatusFactory } from '../userSeriesStatus.factory'
-
 describe('features/series/series.schema', () => {
   describe('seriesSearch query', () => {
     const executeSearch = (keyword = 'testing') =>

apps/api/src/features/series/__tests__/series.service.test.ts

@@ -1,4 +1,11 @@
 import { episode, season, series, seriesProgress } from '@serieslist/db'
+import {
+  episodeFactory,
+  seasonFactory,
+  seriesFactory,
+  seriesProgressFactory,
+  userFactory,
+} from '@serieslist/db-factories'
 import {
   tmdbNotFoundResponseFactory,
   tmdbSeasonFactory,
@@ -9,9 +16,7 @@ import type { LiterallyAnything } from '@serieslist/type-utils'
 import { subDays } from 'date-fns'
 import { and, eq } from 'drizzle-orm'
 
-import { seriesProgressFactory } from '#/features/seriesProgress'
 import { tmdbEpisodeFactory, tmdbSeriesDetailsFactory } from '#/features/tmdb'
-import { userFactory } from '#/features/users'
 import { db } from '#/lib/db'
 import {
   createContext,
@@ -20,9 +25,6 @@ import {
 } from '#/test/testUtils'
 import { formatDate } from '#/utils/date'
 
-import { episodeFactory } from '../episode.factory'
-import { seasonFactory } from '../season.factory'
-import { seriesFactory } from '../series.factory'
 import {
   findStatusForSeries,
   reSyncSeries,

apps/api/src/features/series/index.ts

@@ -1,8 +1,4 @@
 export * from './series.schema'
-export * from './series.factory'
-export * from './season.factory'
-export * from './episode.factory'
-export * from './userSeriesStatus.factory'
 export { UserSeriesStatusStatus } from '@serieslist/db'
 export * as episodesService from './episodes.service'
 export * as seasonService from './season.service'

apps/api/src/features/series/series.service.ts

@@ -11,7 +11,8 @@ import { addDays, isFuture, subDays } from 'date-fns'
 import index from 'just-index'
 import unique from 'just-unique'
 
-import { seriesProgressService } from '#/features/seriesProgress'
+// TODO: This is a circular import
+import * as seriesProgressService from '#/features/seriesProgress/seriesProgress.service'
 import type {
   SeriesUpdateStatusInput,
   SeriesSearchInput,

apps/api/src/features/seriesProgress/__tests__/seriesProgress.schema.test.ts

@@ -1,13 +1,15 @@
 import { seenEpisode, seriesProgress, type User } from '@serieslist/db'
-import { addDays } from 'date-fns'
-import { and, eq, inArray } from 'drizzle-orm'
-
+import { UserSeriesStatusStatus } from '@serieslist/db'
 import {
+  seenEpisodeFactory,
+  seriesProgressFactory,
   episodeFactory,
-  UserSeriesStatusStatus,
   userSeriesStatusFactory,
-} from '#/features/series'
-import { userFactory } from '#/features/users'
+  userFactory,
+} from '@serieslist/db-factories'
+import { addDays } from 'date-fns'
+import { and, eq, inArray } from 'drizzle-orm'
+
 import { graphql } from '#/generated/gql'
 import type {
   MarkSeriesEpisodesAsSeenInput,
@@ -22,9 +24,6 @@ import {
   executeOperation,
 } from '#/test/testUtils'
 
-import { seenEpisodeFactory } from '../seenEpisode.factory'
-import { seriesProgressFactory } from '../seriesProgress.factory'
-
 describe('features/seriesProgress/seriesProgress.schema', () => {
   describe('toggleEpisodeSeen mutation', () => {
     const executeMutation = async ({

apps/api/src/features/seriesProgress/__tests__/seriesProgress.service.test.ts

@@ -1,15 +1,14 @@
 import { seriesProgress } from '@serieslist/db'
+import { seriesProgressFactory, seriesFactory } from '@serieslist/db-factories'
 import { and, eq } from 'drizzle-orm'
 
-import { seriesFactory } from '#/features/series'
 import { db } from '#/lib/db'
 import {
   createContext,
   createSeenEpisodesForUser,
   createSeriesWithEpisodesAndSeasons,
 } from '#/test/testUtils'
 
-import { seriesProgressFactory } from '../seriesProgress.factory'
 import {
   recalculateSeriesProgress,
   findLatestSeenEpisodesForSeries,

apps/api/src/features/seriesProgress/index.ts

@@ -1,4 +1 @@
-export * from './seenEpisode.factory'
-export * from './seriesProgress.factory'
-
 export * as seriesProgressService from './seriesProgress.service'

apps/api/src/features/seriesProgress/seriesProgress.service.ts

@@ -8,7 +8,9 @@ import type {
 import type { NonNullableFields } from '@serieslist/type-utils'
 import index from 'just-index'
 
-import { episodesService, seasonService } from '#/features/series'
+// TODO: Importing these from #/features/series causes a circular import error
+import * as episodesService from '#/features/series/episodes.service'
+import * as seasonService from '#/features/series/season.service'
 import { isTruthy } from '#/utils/isTruthy'
 
 import * as seenEpisodeRepository from './seenEpisode.repository'

apps/api/src/features/users/index.ts

@@ -1,3 +1,2 @@
 export * from './users.schema'
-export * from './user.factory'
 export * as usersService from './users.service'

apps/api/src/test/testUtils.ts

@@ -1,13 +1,17 @@
 import type { TypedDocumentNode } from '@graphql-typed-document-node/core'
 import type { User, Episode, Season, Series } from '@serieslist/db'
+import {
+  episodeFactory,
+  seasonFactory,
+  seriesFactory,
+  seenEpisodeFactory,
+  userFactory,
+} from '@serieslist/db-factories'
 import type { AuthenticatedContext, Context } from '@serieslist/graphql-server'
 import type { NotWorthIt } from '@serieslist/type-utils'
 import { type ExecutionResult, print } from 'graphql'
 import { createYoga, type YogaInitialContext } from 'graphql-yoga'
 
-import { episodeFactory, seasonFactory, seriesFactory } from '#/features/series'
-import { seenEpisodeFactory } from '#/features/seriesProgress'
-import { userFactory } from '#/features/users'
 import { createArrayOfLength } from '#/lib/createArrayOfLength'
 import { db } from '#/lib/db'
 import { schema } from '#/schema'

packages/db-factories/.eslintrc.json

@@ -0,0 +1,4 @@
+{
+  "extends": "@serieslist/eslint-config-base",
+  "root": true
+}

packages/db-factories/.prettierrc.json

@@ -0,0 +1 @@
+"@serieslist/prettier-config"

packages/db-factories/package.json

@@ -0,0 +1,28 @@
+{
+  "name": "@serieslist/db-factories",
+  "version": "1.0.0",
+  "type": "module",
+  "sideEffects": false,
+  "exports": {
+    ".": {
+      "import": "./src/index.ts",
+      "types": "./src/index.ts"
+    }
+  },
+  "scripts": {
+    "lint": "eslint src",
+    "tsc": "tsc --noEmit"
+  },
+  "devDependencies": {
+    "@serieslist/eslint-config-base": "workspace:*",
+    "@serieslist/prettier-config": "workspace:*",
+    "@serieslist/typescript-config-base": "workspace:*",
+    "typescript": "^5.3.3"
+  },
+  "dependencies": {
+    "@serieslist/db": "workspace:^",
+    "@serieslist/logger": "workspace:^",
+    "fishery": "^2.2.2",
+    "nanoid": "^4.0.2"
+  }
+}

apps/api/src/features/series/episode.factory.ts → packages/db-factories/src/episode.factory.ts

@@ -2,10 +2,9 @@ import { episode, type Episode } from '@serieslist/db'
 import { Factory } from 'fishery'
 import { nanoid } from 'nanoid'
 
-import { db } from '#/lib/db'
-import { generateRandomInt } from '#/utils/generateRandomInt'
-
+import { db } from './lib/db'
 import { seasonFactory } from './season.factory'
+import { generateRandomInt } from './utils/generateRandomInt'
 
 export const episodeFactory = Factory.define<Episode>(
   ({ sequence, onCreate, params }) => {

packages/db-factories/src/index.ts

@@ -0,0 +1,7 @@
+export * from './episode.factory'
+export * from './season.factory'
+export * from './seenEpisode.factory'
+export * from './series.factory'
+export * from './seriesProgress.factory'
+export * from './user.factory'
+export * from './userSeriesStatus.factory'

packages/db-factories/src/lib/db.ts

@@ -0,0 +1,5 @@
+import { createDbConnection } from '@serieslist/db'
+
+import { log } from './logger'
+
+export const { db } = await createDbConnection({ logger: log })

packages/db-factories/src/lib/logger.ts

@@ -0,0 +1,3 @@
+import { createLogger } from '@serieslist/logger'
+
+export const log = createLogger({ name: 'db-factories' })

apps/api/src/features/series/season.factory.ts → packages/db-factories/src/season.factory.ts

@@ -1,10 +1,9 @@
 import { season, type Season } from '@serieslist/db'
 import { Factory } from 'fishery'
 
-import { db } from '#/lib/db'
-import { generateRandomInt } from '#/utils/generateRandomInt'
-
+import { db } from './lib/db'
 import { seriesFactory } from './series.factory'
+import { generateRandomInt } from './utils/generateRandomInt'
 
 export const seasonFactory = Factory.define<Season>(
   ({ sequence, onCreate, params }) => {

apps/api/src/features/seriesProgress/seenEpisode.factory.ts → packages/db-factories/src/seenEpisode.factory.ts

@@ -1,9 +1,9 @@
 import { seenEpisode, type SeenEpisode } from '@serieslist/db'
 import { Factory } from 'fishery'
 
-import { episodeFactory } from '#/features/series'
-import { userFactory } from '#/features/users'
-import { db } from '#/lib/db'
+import { episodeFactory } from './episode.factory'
+import { db } from './lib/db'
+import { userFactory } from './user.factory'
 
 export const seenEpisodeFactory = Factory.define<SeenEpisode>(
   ({ onCreate, params }) => {

apps/api/src/features/series/series.factory.ts → packages/db-factories/src/series.factory.ts

@@ -2,8 +2,8 @@ import { series, type Series } from '@serieslist/db'
 import { Factory } from 'fishery'
 import { nanoid } from 'nanoid'
 
-import { db } from '#/lib/db'
-import { generateRandomInt } from '#/utils/generateRandomInt'
+import { db } from './lib/db'
+import { generateRandomInt } from './utils/generateRandomInt'
 
 export const seriesFactory = Factory.define<Series>(
   ({ sequence, onCreate }) => {

apps/api/src/features/seriesProgress/seriesProgress.factory.ts → packages/db-factories/src/seriesProgress.factory.ts

@@ -1,9 +1,10 @@
 import { seriesProgress, type SeriesProgress } from '@serieslist/db'
 import { Factory } from 'fishery'
 
-import { episodeFactory, seriesFactory } from '#/features/series'
-import { userFactory } from '#/features/users'
-import { db } from '#/lib/db'
+import { episodeFactory } from './episode.factory'
+import { db } from './lib/db'
+import { seriesFactory } from './series.factory'
+import { userFactory } from './user.factory'
 
 export const seriesProgressFactory = Factory.define<SeriesProgress>(
   ({ params, onCreate }) => {

apps/api/src/features/users/user.factory.ts → packages/db-factories/src/user.factory.ts

@@ -2,7 +2,7 @@ import { user, type User } from '@serieslist/db'
 import { Factory } from 'fishery'
 import { nanoid } from 'nanoid'
 
-import { db } from '#/lib/db'
+import { db } from './lib/db'
 
 export const userFactory = Factory.define<User>(({ sequence, onCreate }) => {
   onCreate(async (userArgs) => {

apps/api/src/features/series/userSeriesStatus.factory.ts → packages/db-factories/src/userSeriesStatus.factory.ts

@@ -2,11 +2,9 @@ import type { UserSeriesStatus } from '@serieslist/db'
 import { UserSeriesStatusStatus, userSeriesStatus } from '@serieslist/db'
 import { Factory } from 'fishery'
 
-import { db } from '#/lib/db'
-
-import { userFactory } from '../users'
-
+import { db } from './lib/db'
 import { seriesFactory } from './series.factory'
+import { userFactory } from './user.factory'
 
 export const userSeriesStatusFactory = Factory.define<UserSeriesStatus>(
   ({ params, onCreate }) => {

packages/db-factories/src/utils/generateRandomInt.ts

@@ -0,0 +1,3 @@
+export const generateRandomInt = (min: number, max: number) => {
+  return Math.floor(Math.random() * (max - min + 1) + min)
+}

packages/db-factories/tsconfig.json

@@ -0,0 +1,3 @@
+{
+  "extends": "@serieslist/typescript-config-base"
+}

packages/eslint-config-base/eslint-config-base.js

@@ -61,12 +61,6 @@ module.exports = {
         },
       },
     ],
-    'no-restricted-imports': [
-      'error',
-      {
-        patterns: ['#/features/*/*', '!#/features/*/jobs'],
-      },
-    ],
     '@nx/enforce-module-boundaries': ['error'],
   },
   overrides: [

packages/nx-plugin/src/generators/package/files/package.json.template

@@ -1,5 +1,5 @@
 {
-  "name": "@serieslist/<?= name %>",
+  "name": "@serieslist/<%= name %>",
   "version": "1.0.0",
   "type": "module",
   "sideEffects": false,