From b2eaac8cb1cc28f9f9545587710d8a173e546feb Mon Sep 17 00:00:00 2001 From: Philip Korsholm <88927411+pKorsholm@users.noreply.github.com> Date: Tue, 6 Feb 2024 11:10:54 +0800 Subject: [PATCH] feat(user): Init user module (#6293) * init user module * add migration * update module with latest utils * pr ready * make interface types interfaces --- packages/modules-sdk/src/definitions.ts | 74 ++++--- packages/types/src/bundles.ts | 1 + packages/types/src/index.ts | 1 + packages/types/src/user/common.ts | 5 + packages/types/src/user/index.ts | 3 + packages/types/src/user/mutations.ts | 6 + packages/types/src/user/service.ts | 36 ++++ packages/user/.gitignore | 6 + packages/user/README.md | 3 + .../integration-tests/__fixtures__/user.ts | 16 ++ .../__tests__/services/module/user.spec.ts | 197 ++++++++++++++++++ packages/user/integration-tests/setup-env.js | 6 + packages/user/integration-tests/setup.js | 3 + .../user/integration-tests/utils/config.ts | 6 + .../user/integration-tests/utils/database.ts | 18 ++ .../utils/get-init-module-config.ts | 33 +++ .../user/integration-tests/utils/index.ts | 2 + packages/user/jest.config.js | 22 ++ packages/user/mikro-orm.config.dev.ts | 8 + packages/user/package.json | 61 ++++++ packages/user/src/index.ts | 11 + packages/user/src/initialize/index.ts | 31 +++ packages/user/src/joiner-config.ts | 31 +++ packages/user/src/loaders/connection.ts | 36 ++++ packages/user/src/loaders/container.ts | 10 + packages/user/src/loaders/index.ts | 2 + .../src/migrations/.snapshot-medusa-user.json | 36 ++++ .../src/migrations/Migration20240201081925.ts | 13 ++ packages/user/src/models/index.ts | 1 + packages/user/src/models/user.ts | 25 +++ packages/user/src/module-definition.ts | 31 +++ packages/user/src/repositories/index.ts | 1 + packages/user/src/scripts/bin/run-seed.ts | 19 ++ packages/user/src/scripts/seed.ts | 58 ++++++ .../user/src/services/__tests__/index.spec.ts | 5 + packages/user/src/services/index.ts | 1 + packages/user/src/services/user-module.ts | 113 ++++++++++ packages/user/src/types/index.ts | 7 + packages/user/src/types/services/index.ts | 1 + packages/user/src/types/services/user.ts | 13 ++ packages/user/tsconfig.json | 50 +++++ packages/user/tsconfig.spec.json | 8 + yarn.lock | 27 +++ 43 files changed, 1008 insertions(+), 29 deletions(-) create mode 100644 packages/types/src/user/common.ts create mode 100644 packages/types/src/user/index.ts create mode 100644 packages/types/src/user/mutations.ts create mode 100644 packages/types/src/user/service.ts create mode 100644 packages/user/.gitignore create mode 100644 packages/user/README.md create mode 100644 packages/user/integration-tests/__fixtures__/user.ts create mode 100644 packages/user/integration-tests/__tests__/services/module/user.spec.ts create mode 100644 packages/user/integration-tests/setup-env.js create mode 100644 packages/user/integration-tests/setup.js create mode 100644 packages/user/integration-tests/utils/config.ts create mode 100644 packages/user/integration-tests/utils/database.ts create mode 100644 packages/user/integration-tests/utils/get-init-module-config.ts create mode 100644 packages/user/integration-tests/utils/index.ts create mode 100644 packages/user/jest.config.js create mode 100644 packages/user/mikro-orm.config.dev.ts create mode 100644 packages/user/package.json create mode 100644 packages/user/src/index.ts create mode 100644 packages/user/src/initialize/index.ts create mode 100644 packages/user/src/joiner-config.ts create mode 100644 packages/user/src/loaders/connection.ts create mode 100644 packages/user/src/loaders/container.ts create mode 100644 packages/user/src/loaders/index.ts create mode 100644 packages/user/src/migrations/.snapshot-medusa-user.json create mode 100644 packages/user/src/migrations/Migration20240201081925.ts create mode 100644 packages/user/src/models/index.ts create mode 100644 packages/user/src/models/user.ts create mode 100644 packages/user/src/module-definition.ts create mode 100644 packages/user/src/repositories/index.ts create mode 100644 packages/user/src/scripts/bin/run-seed.ts create mode 100644 packages/user/src/scripts/seed.ts create mode 100644 packages/user/src/services/__tests__/index.spec.ts create mode 100644 packages/user/src/services/index.ts create mode 100644 packages/user/src/services/user-module.ts create mode 100644 packages/user/src/types/index.ts create mode 100644 packages/user/src/types/services/index.ts create mode 100644 packages/user/src/types/services/user.ts create mode 100644 packages/user/tsconfig.json create mode 100644 packages/user/tsconfig.spec.json diff --git a/packages/modules-sdk/src/definitions.ts b/packages/modules-sdk/src/definitions.ts index c18cc548e1..4e58fa5768 100644 --- a/packages/modules-sdk/src/definitions.ts +++ b/packages/modules-sdk/src/definitions.ts @@ -7,55 +7,58 @@ import { import { upperCaseFirst } from "@medusajs/utils" export enum Modules { - LINK = "linkModules", - EVENT_BUS = "eventBus", - STOCK_LOCATION = "stockLocationService", - INVENTORY = "inventoryService", - CACHE = "cacheService", - PRODUCT = "productService", - PRICING = "pricingService", - PROMOTION = "promotion", AUTH = "auth", - WORKFLOW_ENGINE = "workflows", - SALES_CHANNEL = "salesChannel", + CACHE = "cacheService", CART = "cart", CUSTOMER = "customer", + EVENT_BUS = "eventBus", + INVENTORY = "inventoryService", + LINK = "linkModules", PAYMENT = "payment", + PRICING = "pricingService", + PRODUCT = "productService", + PROMOTION = "promotion", + SALES_CHANNEL = "salesChannel", + STOCK_LOCATION = "stockLocationService", + USER = "user", + WORKFLOW_ENGINE = "workflows", REGION = "region", } export enum ModuleRegistrationName { - EVENT_BUS = "eventBusModuleService", - STOCK_LOCATION = "stockLocationService", - INVENTORY = "inventoryService", - CACHE = "cacheService", - PRODUCT = "productModuleService", - PRICING = "pricingModuleService", - PROMOTION = "promotionModuleService", AUTH = "authModuleService", - WORKFLOW_ENGINE = "workflowsModuleService", - SALES_CHANNEL = "salesChannelModuleService", + CACHE = "cacheService", CART = "cartModuleService", CUSTOMER = "customerModuleService", + EVENT_BUS = "eventBusModuleService", + INVENTORY = "inventoryService", PAYMENT = "paymentModuleService", + PRICING = "pricingModuleService", + PRODUCT = "productModuleService", + PROMOTION = "promotionModuleService", + SALES_CHANNEL = "salesChannelModuleService", + STOCK_LOCATION = "stockLocationService", + USER = "userModuleService", + WORKFLOW_ENGINE = "workflowsModuleService", REGION = "regionModuleService", } export const MODULE_PACKAGE_NAMES = { - [Modules.LINK]: "@medusajs/link-modules", - [Modules.PRODUCT]: "@medusajs/product", - [Modules.EVENT_BUS]: "@medusajs/event-bus-local", - [Modules.STOCK_LOCATION]: "@medusajs/stock-location", - [Modules.INVENTORY]: "@medusajs/inventory", - [Modules.CACHE]: "@medusajs/cache-inmemory", - [Modules.PRICING]: "@medusajs/pricing", - [Modules.PROMOTION]: "@medusajs/promotion", [Modules.AUTH]: "@medusajs/auth", - [Modules.WORKFLOW_ENGINE]: "@medusajs/workflow-engine-inmemory", - [Modules.SALES_CHANNEL]: "@medusajs/sales-channel", + [Modules.CACHE]: "@medusajs/cache-inmemory", [Modules.CART]: "@medusajs/cart", [Modules.CUSTOMER]: "@medusajs/customer", + [Modules.EVENT_BUS]: "@medusajs/event-bus-local", + [Modules.INVENTORY]: "@medusajs/inventory", + [Modules.LINK]: "@medusajs/link-modules", [Modules.PAYMENT]: "@medusajs/payment", + [Modules.PRICING]: "@medusajs/pricing", + [Modules.PRODUCT]: "@medusajs/product", + [Modules.PROMOTION]: "@medusajs/promotion", + [Modules.SALES_CHANNEL]: "@medusajs/sales-channel", + [Modules.STOCK_LOCATION]: "@medusajs/stock-location", + [Modules.USER]: "@medusajs/user", + [Modules.WORKFLOW_ENGINE]: "@medusajs/workflow-engine-inmemory", [Modules.REGION]: "@medusajs/region", } @@ -231,6 +234,19 @@ export const ModulesDefinition: { [key: string | Modules]: ModuleDefinition } = resources: MODULE_RESOURCE_TYPE.SHARED, }, }, + [Modules.USER]: { + key: Modules.USER, + registrationName: ModuleRegistrationName.USER, + defaultPackage: false, + label: upperCaseFirst(ModuleRegistrationName.USER), + isRequired: false, + isQueryable: true, + dependencies: ["logger"], + defaultModuleDeclaration: { + scope: MODULE_SCOPE.INTERNAL, + resources: MODULE_RESOURCE_TYPE.SHARED, + }, + }, [Modules.REGION]: { key: Modules.REGION, registrationName: ModuleRegistrationName.REGION, diff --git a/packages/types/src/bundles.ts b/packages/types/src/bundles.ts index a57b9ef603..9928c1ca1c 100644 --- a/packages/types/src/bundles.ts +++ b/packages/types/src/bundles.ts @@ -17,5 +17,6 @@ export * as SalesChannelTypes from "./sales-channel" export * as SearchTypes from "./search" export * as StockLocationTypes from "./stock-location" export * as TransactionBaseTypes from "./transaction-base" +export * as UserTypes from "./user" export * as WorkflowTypes from "./workflow" diff --git a/packages/types/src/index.ts b/packages/types/src/index.ts index 2e347ce73e..93a1f99077 100644 --- a/packages/types/src/index.ts +++ b/packages/types/src/index.ts @@ -26,5 +26,6 @@ export * from "./search" export * from "./shared-context" export * from "./stock-location" export * from "./transaction-base" +export * from "./user" export * from "./workflow" diff --git a/packages/types/src/user/common.ts b/packages/types/src/user/common.ts new file mode 100644 index 0000000000..0d535d9008 --- /dev/null +++ b/packages/types/src/user/common.ts @@ -0,0 +1,5 @@ +export type UserDTO = { + id: string +} + +export type FilterableUserProps = {} diff --git a/packages/types/src/user/index.ts b/packages/types/src/user/index.ts new file mode 100644 index 0000000000..0c73656566 --- /dev/null +++ b/packages/types/src/user/index.ts @@ -0,0 +1,3 @@ +export * from "./common" +export * from "./mutations" +export * from "./service" diff --git a/packages/types/src/user/mutations.ts b/packages/types/src/user/mutations.ts new file mode 100644 index 0000000000..5e9ced22a3 --- /dev/null +++ b/packages/types/src/user/mutations.ts @@ -0,0 +1,6 @@ +export interface CreateUserDTO { + id?: string +} +export interface UpdateUserDTO { + id: string +} diff --git a/packages/types/src/user/service.ts b/packages/types/src/user/service.ts new file mode 100644 index 0000000000..5b8ec0bd52 --- /dev/null +++ b/packages/types/src/user/service.ts @@ -0,0 +1,36 @@ +import { CreateUserDTO, UpdateUserDTO } from "./mutations" +import { FilterableUserProps, UserDTO } from "./common" + +import { Context } from "../shared-context" +import { FindConfig } from "../common" +import { IModuleService } from "../modules-sdk" + +export interface IUserModuleService extends IModuleService { + retrieve( + id: string, + config?: FindConfig, + sharedContext?: Context + ): Promise + + list( + filters?: FilterableUserProps, + config?: FindConfig, + sharedContext?: Context + ): Promise + + listAndCount( + filters?: FilterableUserProps, + config?: FindConfig, + sharedContext?: Context + ): Promise<[UserDTO[], number]> + + create(data: CreateUserDTO[], sharedContext?: Context): Promise + + create(data: CreateUserDTO, sharedContext?: Context): Promise + + update(data: UpdateUserDTO[], sharedContext?: Context): Promise + + update(data: UpdateUserDTO, sharedContext?: Context): Promise + + delete(ids: string[], sharedContext?: Context): Promise +} diff --git a/packages/user/.gitignore b/packages/user/.gitignore new file mode 100644 index 0000000000..874c6c69d3 --- /dev/null +++ b/packages/user/.gitignore @@ -0,0 +1,6 @@ +/dist +node_modules +.DS_store +.env* +.env +*.sql diff --git a/packages/user/README.md b/packages/user/README.md new file mode 100644 index 0000000000..f9563ada28 --- /dev/null +++ b/packages/user/README.md @@ -0,0 +1,3 @@ +# User Module + +The User Module is Medusa’s user engine. diff --git a/packages/user/integration-tests/__fixtures__/user.ts b/packages/user/integration-tests/__fixtures__/user.ts new file mode 100644 index 0000000000..1e7439128c --- /dev/null +++ b/packages/user/integration-tests/__fixtures__/user.ts @@ -0,0 +1,16 @@ +import { SqlEntityManager } from "@mikro-orm/postgresql" +import { User } from "@models" + +export const createUsers = async ( + manager: SqlEntityManager, + userData = [{ id: "1" }] +) => { + const users: User[] = [] + + for (const user of userData) { + const usr = manager.create(User, user) + users.push(usr) + } + + await manager.persistAndFlush(users) +} diff --git a/packages/user/integration-tests/__tests__/services/module/user.spec.ts b/packages/user/integration-tests/__tests__/services/module/user.spec.ts new file mode 100644 index 0000000000..654c91cab7 --- /dev/null +++ b/packages/user/integration-tests/__tests__/services/module/user.spec.ts @@ -0,0 +1,197 @@ +import { IUserModuleService } from "@medusajs/types/dist/user" +import { MikroOrmWrapper } from "../../../utils" +import { Modules } from "@medusajs/modules-sdk" +import { SqlEntityManager } from "@mikro-orm/postgresql" +import { createUsers } from "../../../__fixtures__/user" +import { getInitModuleConfig } from "../../../utils/get-init-module-config" +import { initModules } from "medusa-test-utils" + +jest.setTimeout(30000) + +describe("UserModuleService - User", () => { + let service: IUserModuleService + let testManager: SqlEntityManager + let shutdownFunc: () => Promise + + beforeAll(async () => { + const initModulesConfig = getInitModuleConfig() + + const { medusaApp, shutdown } = await initModules(initModulesConfig) + + service = medusaApp.modules[Modules.USER] + + shutdownFunc = shutdown + }) + + beforeEach(async () => { + await MikroOrmWrapper.setupDatabase() + testManager = MikroOrmWrapper.forkManager() + + await createUsers(testManager) + }) + + afterEach(async () => { + await MikroOrmWrapper.clearDatabase() + }) + + afterAll(async () => { + await shutdownFunc() + }) + + describe("listUsers", () => { + it("should list users", async () => { + const users = await service.list() + const serialized = JSON.parse(JSON.stringify(users)) + + expect(serialized).toEqual([ + expect.objectContaining({ + id: "1", + }), + ]) + }) + + it("should list users by id", async () => { + const users = await service.list({ + id: ["1"], + }) + + expect(users).toEqual([ + expect.objectContaining({ + id: "1", + }), + ]) + }) + }) + + describe("listAndCountUsers", () => { + it("should list and count users", async () => { + const [users, count] = await service.listAndCount() + const serialized = JSON.parse(JSON.stringify(users)) + + expect(count).toEqual(1) + expect(serialized).toEqual([ + expect.objectContaining({ + id: "1", + }), + ]) + }) + + it("should listAndCount Users by id", async () => { + const [Users, count] = await service.listAndCount({ + id: "1", + }) + + expect(count).toEqual(1) + expect(Users).toEqual([ + expect.objectContaining({ + id: "1", + }), + ]) + }) + }) + + describe("retrieveUser", () => { + const id = "1" + + it("should return an user for the given id", async () => { + const user = await service.retrieve(id) + + expect(user).toEqual( + expect.objectContaining({ + id, + }) + ) + }) + + it("should throw an error when an user with the given id does not exist", async () => { + let error + + try { + await service.retrieve("does-not-exist") + } catch (e) { + error = e + } + + expect(error.message).toEqual( + "User with id: does-not-exist was not found" + ) + }) + + it("should throw an error when a userId is not provided", async () => { + let error + + try { + await service.retrieve(undefined as unknown as string) + } catch (e) { + error = e + } + + expect(error.message).toEqual("user - id must be defined") + }) + + it("should return user based on config select param", async () => { + const User = await service.retrieve(id, { + select: ["id"], + }) + + const serialized = JSON.parse(JSON.stringify(User)) + + expect(serialized).toEqual({ + id, + }) + }) + }) + + describe("deleteUser", () => { + const id = "1" + + it("should delete the Users given an id successfully", async () => { + await service.delete([id]) + + const users = await service.list({ + id: [id], + }) + + expect(users).toHaveLength(0) + }) + }) + + describe("updateUser", () => { + it("should throw an error when a id does not exist", async () => { + let error + + try { + await service.update([ + { + id: "does-not-exist", + }, + ]) + } catch (e) { + error = e + } + + expect(error.message).toEqual('User with id "does-not-exist" not found') + }) + }) + + describe("createUser", () => { + it("should create a User successfully", async () => { + await service.create([ + { + id: "2", + }, + ]) + + const [User, count] = await service.listAndCount({ + id: ["2"], + }) + + expect(count).toEqual(1) + expect(User[0]).toEqual( + expect.objectContaining({ + id: "2", + }) + ) + }) + }) +}) diff --git a/packages/user/integration-tests/setup-env.js b/packages/user/integration-tests/setup-env.js new file mode 100644 index 0000000000..ef21d71d85 --- /dev/null +++ b/packages/user/integration-tests/setup-env.js @@ -0,0 +1,6 @@ +if (typeof process.env.DB_TEMP_NAME === "undefined") { + const tempName = parseInt(process.env.JEST_WORKER_ID || "1") + process.env.DB_TEMP_NAME = `medusa-user-integration-${tempName}` +} + +process.env.MEDUSA_USER_DB_SCHEMA = "public" diff --git a/packages/user/integration-tests/setup.js b/packages/user/integration-tests/setup.js new file mode 100644 index 0000000000..43f99aab4a --- /dev/null +++ b/packages/user/integration-tests/setup.js @@ -0,0 +1,3 @@ +import { JestUtils } from "medusa-test-utils" + +JestUtils.afterAllHookDropDatabase() diff --git a/packages/user/integration-tests/utils/config.ts b/packages/user/integration-tests/utils/config.ts new file mode 100644 index 0000000000..d58b9ff622 --- /dev/null +++ b/packages/user/integration-tests/utils/config.ts @@ -0,0 +1,6 @@ +import { ModuleServiceInitializeOptions } from "@medusajs/types" + +export const databaseOptions: ModuleServiceInitializeOptions["database"] = { + schema: "public", + clientUrl: "medusa-user-test", +} diff --git a/packages/user/integration-tests/utils/database.ts b/packages/user/integration-tests/utils/database.ts new file mode 100644 index 0000000000..7e67163fc7 --- /dev/null +++ b/packages/user/integration-tests/utils/database.ts @@ -0,0 +1,18 @@ +import * as UserModels from "@models" + +import { TestDatabaseUtils } from "medusa-test-utils" + +const pathToMigrations = "../../src/migrations" +const mikroOrmEntities = UserModels as unknown as any[] + +export const MikroOrmWrapper = TestDatabaseUtils.getMikroOrmWrapper( + mikroOrmEntities, + pathToMigrations +) + +export const MikroOrmConfig = TestDatabaseUtils.getMikroOrmConfig( + mikroOrmEntities, + pathToMigrations +) + +export const DB_URL = TestDatabaseUtils.getDatabaseURL() diff --git a/packages/user/integration-tests/utils/get-init-module-config.ts b/packages/user/integration-tests/utils/get-init-module-config.ts new file mode 100644 index 0000000000..1150a17fa8 --- /dev/null +++ b/packages/user/integration-tests/utils/get-init-module-config.ts @@ -0,0 +1,33 @@ +import { Modules, ModulesDefinition } from "@medusajs/modules-sdk" + +import { DB_URL } from "./database" + +export function getInitModuleConfig() { + const moduleOptions = { + defaultAdapterOptions: { + database: { + clientUrl: DB_URL, + schema: process.env.MEDUSA_USER_DB_SCHEMA, + }, + }, + } + + const injectedDependencies = {} + + const modulesConfig_ = { + [Modules.USER]: { + definition: ModulesDefinition[Modules.USER], + options: moduleOptions, + }, + } + + return { + injectedDependencies, + modulesConfig: modulesConfig_, + databaseConfig: { + clientUrl: DB_URL, + schema: process.env.MEDUSA_USER_DB_SCHEMA, + }, + joinerConfig: [], + } +} diff --git a/packages/user/integration-tests/utils/index.ts b/packages/user/integration-tests/utils/index.ts new file mode 100644 index 0000000000..5ca5d1bdc0 --- /dev/null +++ b/packages/user/integration-tests/utils/index.ts @@ -0,0 +1,2 @@ +export * from "./config" +export * from "./database" diff --git a/packages/user/jest.config.js b/packages/user/jest.config.js new file mode 100644 index 0000000000..456054fe8a --- /dev/null +++ b/packages/user/jest.config.js @@ -0,0 +1,22 @@ +module.exports = { + moduleNameMapper: { + "^@models": "/src/models", + "^@services": "/src/services", + "^@repositories": "/src/repositories", + "^@types": "/src/types", + }, + transform: { + "^.+\\.[jt]s?$": [ + "ts-jest", + { + tsConfig: "tsconfig.spec.json", + isolatedModules: true, + }, + ], + }, + testEnvironment: `node`, + moduleFileExtensions: [`js`, `ts`], + modulePathIgnorePatterns: ["dist/"], + setupFiles: ["/integration-tests/setup-env.js"], + setupFilesAfterEnv: ["/integration-tests/setup.js"], +} diff --git a/packages/user/mikro-orm.config.dev.ts b/packages/user/mikro-orm.config.dev.ts new file mode 100644 index 0000000000..0e43e74c3a --- /dev/null +++ b/packages/user/mikro-orm.config.dev.ts @@ -0,0 +1,8 @@ +import * as entities from "./src/models" + +module.exports = { + entities: Object.values(entities), + schema: "public", + clientUrl: "postgres://postgres@localhost/medusa-user", + type: "postgresql", +} diff --git a/packages/user/package.json b/packages/user/package.json new file mode 100644 index 0000000000..ef3958eb83 --- /dev/null +++ b/packages/user/package.json @@ -0,0 +1,61 @@ +{ + "name": "@medusajs/user", + "version": "0.0.1", + "description": "Medusa Users module", + "main": "dist/index.js", + "types": "dist/index.d.ts", + "files": [ + "dist" + ], + "engines": { + "node": ">=16" + }, + "bin": { + "medusa-user-seed": "dist/scripts/bin/run-seed.js" + }, + "repository": { + "type": "git", + "url": "https://github.com/medusajs/medusa", + "directory": "packages/user" + }, + "publishConfig": { + "access": "public" + }, + "author": "Medusa", + "license": "MIT", + "scripts": { + "watch": "tsc --build --watch", + "watch:test": "tsc --build tsconfig.spec.json --watch", + "prepublishOnly": "cross-env NODE_ENV=production tsc --build && tsc-alias -p tsconfig.json", + "build": "rimraf dist && tsc --build && tsc-alias -p tsconfig.json", + "test": "jest --runInBand --bail --forceExit -- src/**/__tests__/**/*.ts", + "test:integration": "jest --runInBand --forceExit -- integration-tests/**/__tests__/**/*.ts", + "migration:generate": " MIKRO_ORM_CLI=./mikro-orm.config.dev.ts mikro-orm migration:generate", + "migration:initial": " MIKRO_ORM_CLI=./mikro-orm.config.dev.ts mikro-orm migration:create --initial", + "migration:create": " MIKRO_ORM_CLI=./mikro-orm.config.dev.ts mikro-orm migration:create", + "migration:up": " MIKRO_ORM_CLI=./mikro-orm.config.dev.ts mikro-orm migration:up", + "orm:cache:clear": " MIKRO_ORM_CLI=./mikro-orm.config.dev.ts mikro-orm cache:clear" + }, + "devDependencies": { + "@mikro-orm/cli": "5.9.7", + "cross-env": "^5.2.1", + "jest": "^29.6.3", + "medusa-test-utils": "^1.1.40", + "rimraf": "^3.0.2", + "ts-jest": "^29.1.1", + "ts-node": "^10.9.1", + "tsc-alias": "^1.8.6", + "typescript": "^5.1.6" + }, + "dependencies": { + "@medusajs/modules-sdk": "^1.12.7", + "@medusajs/types": "^1.11.11", + "@medusajs/utils": "^1.11.4", + "@mikro-orm/core": "5.9.7", + "@mikro-orm/migrations": "5.9.7", + "@mikro-orm/postgresql": "5.9.7", + "awilix": "^8.0.0", + "dotenv": "16.3.1", + "knex": "2.4.2" + } +} diff --git a/packages/user/src/index.ts b/packages/user/src/index.ts new file mode 100644 index 0000000000..98c26a5e9e --- /dev/null +++ b/packages/user/src/index.ts @@ -0,0 +1,11 @@ +import { + moduleDefinition, + revertMigration, + runMigrations, +} from "./module-definition" + +export default moduleDefinition +export { revertMigration, runMigrations } + +export * from "./initialize" +export * from "./loaders" diff --git a/packages/user/src/initialize/index.ts b/packages/user/src/initialize/index.ts new file mode 100644 index 0000000000..f9fddbaf44 --- /dev/null +++ b/packages/user/src/initialize/index.ts @@ -0,0 +1,31 @@ +import { + ExternalModuleDeclaration, + InternalModuleDeclaration, + MODULE_PACKAGE_NAMES, + MedusaModule, + Modules, +} from "@medusajs/modules-sdk" +import { IUserModuleService, ModulesSdkTypes } from "@medusajs/types" + +import { InitializeModuleInjectableDependencies } from "../types" +import { moduleDefinition } from "../module-definition" + +export const initialize = async ( + options?: + | ModulesSdkTypes.ModuleBootstrapDeclaration + | ModulesSdkTypes.ModuleServiceInitializeOptions + | ModulesSdkTypes.ModuleServiceInitializeCustomDataLayerOptions, + injectedDependencies?: InitializeModuleInjectableDependencies +): Promise => { + const loaded = await MedusaModule.bootstrap({ + moduleKey: Modules.USER, + defaultPath: MODULE_PACKAGE_NAMES[Modules.USER], + declaration: options as + | InternalModuleDeclaration + | ExternalModuleDeclaration, + injectedDependencies, + moduleExports: moduleDefinition, + }) + + return loaded[Modules.USER] +} diff --git a/packages/user/src/joiner-config.ts b/packages/user/src/joiner-config.ts new file mode 100644 index 0000000000..056a4c35b3 --- /dev/null +++ b/packages/user/src/joiner-config.ts @@ -0,0 +1,31 @@ +import { User } from "@models" +import { MapToConfig } from "@medusajs/utils" +import { ModuleJoinerConfig } from "@medusajs/types" +import { Modules } from "@medusajs/modules-sdk" + +export const LinkableKeys = { + user_id: User.name, +} + +const entityLinkableKeysMap: MapToConfig = {} +Object.entries(LinkableKeys).forEach(([key, value]) => { + entityLinkableKeysMap[value] ??= [] + entityLinkableKeysMap[value].push({ + mapTo: key, + valueFrom: key.split("_").pop()!, + }) +}) + +export const entityNameToLinkableKeysMap: MapToConfig = entityLinkableKeysMap + +export const joinerConfig: ModuleJoinerConfig = { + serviceName: Modules.USER, + primaryKeys: ["id"], + linkableKeys: LinkableKeys, + alias: { + name: ["user", "users"], + args: { + entity: User.name, + }, + }, +} diff --git a/packages/user/src/loaders/connection.ts b/packages/user/src/loaders/connection.ts new file mode 100644 index 0000000000..da26fa35a8 --- /dev/null +++ b/packages/user/src/loaders/connection.ts @@ -0,0 +1,36 @@ +import * as UserModels from "../models" + +import { + InternalModuleDeclaration, + LoaderOptions, + Modules, +} from "@medusajs/modules-sdk" + +import { EntitySchema } from "@mikro-orm/core" +import { ModulesSdkTypes } from "@medusajs/types" +import { ModulesSdkUtils } from "@medusajs/utils" + +export default async ( + { + options, + container, + logger, + }: LoaderOptions< + | ModulesSdkTypes.ModuleServiceInitializeOptions + | ModulesSdkTypes.ModuleServiceInitializeCustomDataLayerOptions + >, + moduleDeclaration?: InternalModuleDeclaration +): Promise => { + const entities = Object.values(UserModels) as unknown as EntitySchema[] + const pathToMigrations = __dirname + "/../migrations" + + await ModulesSdkUtils.mikroOrmConnectionLoader({ + moduleName: Modules.USER, + entities, + container, + options, + moduleDeclaration, + logger, + pathToMigrations, + }) +} diff --git a/packages/user/src/loaders/container.ts b/packages/user/src/loaders/container.ts new file mode 100644 index 0000000000..28ea110f2d --- /dev/null +++ b/packages/user/src/loaders/container.ts @@ -0,0 +1,10 @@ +import { ModulesSdkUtils } from "@medusajs/utils" +import * as ModuleModels from "@models" +import * as ModuleRepositories from "@repositories" +import * as ModuleServices from "@services" + +export default ModulesSdkUtils.moduleContainerLoaderFactory({ + moduleModels: ModuleModels, + moduleRepositories: ModuleRepositories, + moduleServices: ModuleServices, +}) diff --git a/packages/user/src/loaders/index.ts b/packages/user/src/loaders/index.ts new file mode 100644 index 0000000000..3614963d8c --- /dev/null +++ b/packages/user/src/loaders/index.ts @@ -0,0 +1,2 @@ +export * from "./connection" +export * from "./container" diff --git a/packages/user/src/migrations/.snapshot-medusa-user.json b/packages/user/src/migrations/.snapshot-medusa-user.json new file mode 100644 index 0000000000..27daf1f82b --- /dev/null +++ b/packages/user/src/migrations/.snapshot-medusa-user.json @@ -0,0 +1,36 @@ +{ + "namespaces": [ + "public" + ], + "name": "public", + "tables": [ + { + "columns": { + "id": { + "name": "id", + "type": "text", + "unsigned": false, + "autoincrement": false, + "primary": false, + "nullable": false, + "mappedType": "text" + } + }, + "name": "user", + "schema": "public", + "indexes": [ + { + "keyName": "user_pkey", + "columnNames": [ + "id" + ], + "composite": false, + "primary": true, + "unique": true + } + ], + "checks": [], + "foreignKeys": {} + } + ] +} diff --git a/packages/user/src/migrations/Migration20240201081925.ts b/packages/user/src/migrations/Migration20240201081925.ts new file mode 100644 index 0000000000..eac0e0f06f --- /dev/null +++ b/packages/user/src/migrations/Migration20240201081925.ts @@ -0,0 +1,13 @@ +import { Migration } from '@mikro-orm/migrations'; + +export class Migration20240201081925 extends Migration { + + async up(): Promise { + this.addSql('create table "user" ("id" text not null, constraint "user_pkey" primary key ("id"));'); + } + + async down(): Promise { + this.addSql('drop table if exists "user" cascade;'); + } + +} diff --git a/packages/user/src/models/index.ts b/packages/user/src/models/index.ts new file mode 100644 index 0000000000..028bc24218 --- /dev/null +++ b/packages/user/src/models/index.ts @@ -0,0 +1 @@ +export { default as User } from "./user" diff --git a/packages/user/src/models/user.ts b/packages/user/src/models/user.ts new file mode 100644 index 0000000000..7b1ad592f1 --- /dev/null +++ b/packages/user/src/models/user.ts @@ -0,0 +1,25 @@ +import { + BeforeCreate, + Entity, + OnInit, + PrimaryKey, +} from "@mikro-orm/core" + +import { generateEntityId } from "@medusajs/utils" + + +@Entity() +export default class User { + @PrimaryKey({ columnType: "text" }) + id!: string + + @BeforeCreate() + onCreate() { + this.id = generateEntityId(this.id, "user") + } + + @OnInit() + onInit() { + this.id = generateEntityId(this.id, "user") + } +} diff --git a/packages/user/src/module-definition.ts b/packages/user/src/module-definition.ts new file mode 100644 index 0000000000..01960256fb --- /dev/null +++ b/packages/user/src/module-definition.ts @@ -0,0 +1,31 @@ +import * as Models from "@models" + +import { UserModuleService } from "@services" +import { ModuleExports } from "@medusajs/types" +import { Modules } from "@medusajs/modules-sdk" +import { ModulesSdkUtils } from "@medusajs/utils" +import loadConnection from "./loaders/connection" +import loadContainer from "./loaders/container" + +const migrationScriptOptions = { + moduleName: Modules.USER, + models: Models, + pathToMigrations: __dirname + "/migrations", +} + +export const runMigrations = ModulesSdkUtils.buildMigrationScript( + migrationScriptOptions +) +export const revertMigration = ModulesSdkUtils.buildRevertMigrationScript( + migrationScriptOptions +) + +const service = UserModuleService +const loaders = [loadContainer, loadConnection] as any + +export const moduleDefinition: ModuleExports = { + service, + loaders, + runMigrations, + revertMigration, +} diff --git a/packages/user/src/repositories/index.ts b/packages/user/src/repositories/index.ts new file mode 100644 index 0000000000..147c9cc259 --- /dev/null +++ b/packages/user/src/repositories/index.ts @@ -0,0 +1 @@ +export { MikroOrmBaseRepository as BaseRepository } from "@medusajs/utils" diff --git a/packages/user/src/scripts/bin/run-seed.ts b/packages/user/src/scripts/bin/run-seed.ts new file mode 100644 index 0000000000..8e5f2c778b --- /dev/null +++ b/packages/user/src/scripts/bin/run-seed.ts @@ -0,0 +1,19 @@ +#!/usr/bin/env node + +import { EOL } from "os" +import { run } from "../seed" + +const args = process.argv +const path = args.pop() as string + +export default (async () => { + const { config } = await import("dotenv") + config() + if (!path) { + throw new Error( + `filePath is required.${EOL}Example: medusa-user-seed ` + ) + } + + await run({ path }) +})() diff --git a/packages/user/src/scripts/seed.ts b/packages/user/src/scripts/seed.ts new file mode 100644 index 0000000000..a226bcea6f --- /dev/null +++ b/packages/user/src/scripts/seed.ts @@ -0,0 +1,58 @@ +import * as UserModels from "@models" + +import { DALUtils, ModulesSdkUtils } from "@medusajs/utils" +import { LoaderOptions, Logger, ModulesSdkTypes } from "@medusajs/types" + +import { EOL } from "os" +import { EntitySchema } from "@mikro-orm/core" +import { Modules } from "@medusajs/modules-sdk" +import { resolve } from "path" + +export async function run({ + options, + logger, + path, +}: Partial< + Pick< + LoaderOptions, + "options" | "logger" + > +> & { + path: string +}) { + logger ??= console as unknown as Logger + + logger.info(`Loading seed data from ${path}...`) + + const { userData } = await import(resolve(process.cwd(), path)).catch((e) => { + logger?.error( + `Failed to load seed data from ${path}. Please, provide a relative path and check that you export the following: userData.${EOL}${e}` + ) + throw e + }) + + const dbData = ModulesSdkUtils.loadDatabaseConfig(Modules.USER, options)! + const entities = Object.values(UserModels) as unknown as EntitySchema[] + const pathToMigrations = __dirname + "/../migrations" + + const orm = await DALUtils.mikroOrmCreateConnection( + dbData, + entities, + pathToMigrations + ) + + const manager = orm.em.fork() + + try { + logger.info("Seeding user data..") + + // TODO: implement user seed data + // await createUsers(manager, usersData) + } catch (e) { + logger.error( + `Failed to insert the seed data in the PostgreSQL database ${dbData.clientUrl}.${EOL}${e}` + ) + } + + await orm.close(true) +} diff --git a/packages/user/src/services/__tests__/index.spec.ts b/packages/user/src/services/__tests__/index.spec.ts new file mode 100644 index 0000000000..728f6245c6 --- /dev/null +++ b/packages/user/src/services/__tests__/index.spec.ts @@ -0,0 +1,5 @@ +describe("Noop test", () => { + it("noop check", async () => { + expect(true).toBe(true) + }) +}) diff --git a/packages/user/src/services/index.ts b/packages/user/src/services/index.ts new file mode 100644 index 0000000000..fa745e078b --- /dev/null +++ b/packages/user/src/services/index.ts @@ -0,0 +1 @@ +export { default as UserModuleService } from "./user-module" diff --git a/packages/user/src/services/user-module.ts b/packages/user/src/services/user-module.ts new file mode 100644 index 0000000000..4baab519f8 --- /dev/null +++ b/packages/user/src/services/user-module.ts @@ -0,0 +1,113 @@ +import { + Context, + DAL, + InternalModuleDeclaration, + ModuleJoinerConfig, + UserTypes, + CreateUserDTO, + UpdateUserDTO, + UserDTO, + ModulesSdkTypes, +} from "@medusajs/types" +import { + InjectManager, + InjectTransactionManager, + MedusaContext, + ModulesSdkUtils, +} from "@medusajs/utils" +import { entityNameToLinkableKeysMap, joinerConfig } from "../joiner-config" + +import { User } from "@models" + +type InjectedDependencies = { + baseRepository: DAL.RepositoryService + userService: ModulesSdkTypes.InternalModuleService +} + +const generateMethodForModels = [] + +export default class UserModuleService + extends ModulesSdkUtils.abstractModuleServiceFactory< + InjectedDependencies, + UserDTO, + {} + >(User, generateMethodForModels, entityNameToLinkableKeysMap) + implements UserTypes.IUserModuleService +{ + __joinerConfig(): ModuleJoinerConfig { + return joinerConfig + } + + protected baseRepository_: DAL.RepositoryService + + protected readonly userService_: ModulesSdkTypes.InternalModuleService + + constructor( + { userService, baseRepository }: InjectedDependencies, + protected readonly moduleDeclaration: InternalModuleDeclaration + ) { + // @ts-ignore + super(...arguments) + + this.baseRepository_ = baseRepository + this.userService_ = userService + } + + create(data: CreateUserDTO[], sharedContext?: Context): Promise + create(data: CreateUserDTO, sharedContext?: Context): Promise + + @InjectManager("baseRepository_") + async create( + data: CreateUserDTO[] | CreateUserDTO, + @MedusaContext() sharedContext: Context = {} + ): Promise { + const input = Array.isArray(data) ? data : [data] + + const users = await this.create_(input, sharedContext) + + const serializedUsers = await this.baseRepository_.serialize< + UserTypes.UserDTO[] + >(users, { + populate: true, + }) + + return Array.isArray(data) ? serializedUsers : serializedUsers[0] + } + + @InjectTransactionManager("baseRepository_") + protected async create_( + data: CreateUserDTO[], + @MedusaContext() sharedContext: Context + ): Promise { + return await this.userService_.create(data, sharedContext) + } + + update(data: UpdateUserDTO[], sharedContext?: Context): Promise + update(data: UpdateUserDTO, sharedContext?: Context): Promise + + @InjectManager("baseRepository_") + async update( + data: UpdateUserDTO | UpdateUserDTO[], + @MedusaContext() sharedContext: Context = {} + ): Promise { + const input = Array.isArray(data) ? data : [data] + + const updatedUsers = await this.update_(input, sharedContext) + + const serializedUsers = await this.baseRepository_.serialize< + UserTypes.UserDTO[] + >(updatedUsers, { + populate: true, + }) + + return Array.isArray(data) ? serializedUsers : serializedUsers[0] + } + + @InjectTransactionManager("baseRepository_") + protected async update_( + data: UpdateUserDTO[], + @MedusaContext() sharedContext: Context + ): Promise { + return await this.userService_.update(data, sharedContext) + } +} diff --git a/packages/user/src/types/index.ts b/packages/user/src/types/index.ts new file mode 100644 index 0000000000..48641f932f --- /dev/null +++ b/packages/user/src/types/index.ts @@ -0,0 +1,7 @@ +import { Logger } from "@medusajs/types" + +export type InitializeModuleInjectableDependencies = { + logger?: Logger +} + +export * as ServiceTypes from "./services" diff --git a/packages/user/src/types/services/index.ts b/packages/user/src/types/services/index.ts new file mode 100644 index 0000000000..50c6bf22c6 --- /dev/null +++ b/packages/user/src/types/services/index.ts @@ -0,0 +1 @@ +export * from "./user" diff --git a/packages/user/src/types/services/user.ts b/packages/user/src/types/services/user.ts new file mode 100644 index 0000000000..63ad82acc9 --- /dev/null +++ b/packages/user/src/types/services/user.ts @@ -0,0 +1,13 @@ +export type UserDTO = { + id: string +} + +export type CreateUserDTO = { + id?: string +} + +export type UpdateUserDTO = { + id: string +} + +export type FilterableUserProps = {} diff --git a/packages/user/tsconfig.json b/packages/user/tsconfig.json new file mode 100644 index 0000000000..7fd528e0e3 --- /dev/null +++ b/packages/user/tsconfig.json @@ -0,0 +1,50 @@ +{ + "compilerOptions": { + "lib": [ + "es2020" + ], + "target": "es2020", + "outDir": "./dist", + "esModuleInterop": true, + "declaration": true, + "module": "commonjs", + "moduleResolution": "node", + "emitDecoratorMetadata": true, + "experimentalDecorators": true, + "sourceMap": false, + "noImplicitReturns": true, + "strictNullChecks": true, + "strictFunctionTypes": true, + "noImplicitThis": true, + "allowJs": true, + "skipLibCheck": true, + "downlevelIteration": true, + // to use ES5 specific tooling + "baseUrl": ".", + "resolveJsonModule": true, + "paths": { + "@models": [ + "./src/models" + ], + "@services": [ + "./src/services" + ], + "@repositories": [ + "./src/repositories" + ], + "@types": [ + "./src/types" + ] + } + }, + "include": [ + "src" + ], + "exclude": [ + "dist", + "./src/**/__tests__", + "./src/**/__mocks__", + "./src/**/__fixtures__", + "node_modules" + ] +} diff --git a/packages/user/tsconfig.spec.json b/packages/user/tsconfig.spec.json new file mode 100644 index 0000000000..48e47e8cbb --- /dev/null +++ b/packages/user/tsconfig.spec.json @@ -0,0 +1,8 @@ +{ + "extends": "./tsconfig.json", + "include": ["src", "integration-tests"], + "exclude": ["node_modules", "dist"], + "compilerOptions": { + "sourceMap": true + } +} diff --git a/yarn.lock b/yarn.lock index 54469bd595..3aca9234b3 100644 --- a/yarn.lock +++ b/yarn.lock @@ -8778,6 +8778,33 @@ __metadata: languageName: unknown linkType: soft +"@medusajs/user@workspace:packages/user": + version: 0.0.0-use.local + resolution: "@medusajs/user@workspace:packages/user" + dependencies: + "@medusajs/modules-sdk": ^1.12.7 + "@medusajs/types": ^1.11.11 + "@medusajs/utils": ^1.11.4 + "@mikro-orm/cli": 5.9.7 + "@mikro-orm/core": 5.9.7 + "@mikro-orm/migrations": 5.9.7 + "@mikro-orm/postgresql": 5.9.7 + awilix: ^8.0.0 + cross-env: ^5.2.1 + dotenv: 16.3.1 + jest: ^29.6.3 + knex: 2.4.2 + medusa-test-utils: ^1.1.40 + rimraf: ^3.0.2 + ts-jest: ^29.1.1 + ts-node: ^10.9.1 + tsc-alias: ^1.8.6 + typescript: ^5.1.6 + bin: + medusa-user-seed: dist/scripts/bin/run-seed.js + languageName: unknown + linkType: soft + "@medusajs/utils@^1.1.41, @medusajs/utils@^1.10.5, @medusajs/utils@^1.11.1, @medusajs/utils@^1.11.2, @medusajs/utils@^1.11.3, @medusajs/utils@^1.11.4, @medusajs/utils@^1.9.2, @medusajs/utils@^1.9.4, @medusajs/utils@workspace:^, @medusajs/utils@workspace:packages/utils": version: 0.0.0-use.local resolution: "@medusajs/utils@workspace:packages/utils"