Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Replace dependency faker with @faker-js/faker ^9.4.0 #2743

Merged
merged 7 commits into from
Feb 6, 2025
Merged

Replace dependency faker with @faker-js/faker ^9.4.0 #2743

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
f4af47d
Replace dependency faker with @faker-js/faker ^5.5.3
renovate[bot] Jan 10, 2025
2f0ef34
refactor: upgrade breaking changes from @faker-js/faker version v9
manuelblum Feb 5, 2025
fd2d567
revert fixture.console changed imports from mikroorm
manuelblum Feb 5, 2025
35083bf
remove duplicated dependency
manuelblum Feb 6, 2025
0129462
add productFixtures
manuelblum Feb 6, 2025
b14482b
refactor: update deprecated faker.address to faker.location
manuelblum Feb 6, 2025
cb2f7e2
fix: fixtures
manuelblum Feb 6, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 2 additions & 4 deletions demo/api/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@
"dependencies": {
"@apollo/server": "^4.11.3",
"@comet/cms-api": "workspace:*",
"@faker-js/faker": "^9.4.0",
"@kubernetes/client-node": "^0.22.3",
"@mikro-orm/cli": "^6.4.5",
"@mikro-orm/core": "^6.4.5",
Expand All @@ -51,7 +52,6 @@
"compression": "^1.7.5",
"cookie-parser": "^1.4.7",
"express": "^4.21.2",
"faker": "^5.5.3",
"graphql": "^16.6.0",
"graphql-scalars": "^1.24.1",
"helmet": "^4.6.0",
Expand All @@ -65,13 +65,11 @@
},
"devDependencies": {
"@comet/eslint-config": "workspace:*",
"@faker-js/faker": "^7.6.0",
"@nestjs/cli": "^10.4.9",
"@nestjs/schematics": "^10.2.3",
"@types/compression": "^1.7.5",
"@types/cookie-parser": "^1.4.8",
"@types/express": "^4.17.21",
"@types/faker": "^5.5.9",
"@types/node": "^22.13.1",
"@types/response-time": "^2.3.8",
"chokidar-cli": "^3.0.0",
Expand All @@ -81,7 +79,7 @@
"prettier": "^3.4.2",
"ts-node": "^10.9.2",
"tsconfig-paths": "^3.15.0",
"typescript": "^4.9.5"
"typescript": "^5.7.3"
},
"mikro-orm": {
"configPaths": [
Expand Down
12 changes: 6 additions & 6 deletions demo/api/src/db/fixtures/fixtures.console.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
import { BlobStorageBackendService, DependenciesService, PageTreeNodeInterface, PageTreeNodeVisibility, PageTreeService } from "@comet/cms-api";
import { faker } from "@faker-js/faker";
import { InjectRepository } from "@mikro-orm/nestjs";
import { CreateRequestContext, EntityManager, EntityRepository, MikroORM } from "@mikro-orm/postgresql";
import { Inject, Injectable } from "@nestjs/common";
Expand All @@ -13,7 +14,6 @@ import { Page } from "@src/documents/pages/entities/page.entity";
import { PageTreeNodeScope } from "@src/page-tree/dto/page-tree-node-scope";
import { PageTreeNodeCategory } from "@src/page-tree/page-tree-node-category";
import { UserGroup } from "@src/user-groups/user-group";
import faker from "faker";
import { Command, Console } from "nestjs-console";
import slugify from "slugify";

Expand Down Expand Up @@ -230,19 +230,19 @@ export class FixturesConsole {
const NUMBER_OF_DOMAINS_WITH_LORUM_IPSUM_CONTENT = 0; // Increase number to generate lorum ipsum fixtures

for (let domainNum = 0; domainNum < NUMBER_OF_DOMAINS_WITH_LORUM_IPSUM_CONTENT; domainNum++) {
const domain = domainNum === 0 ? "secondary" : `${faker.random.word().toLowerCase()}.com`;
const domain = domainNum === 0 ? "secondary" : `${faker.lorem.word().toLowerCase()}.com`;
let pagesCount = 0;
const pages = [];
for (let level = 0; level < 10; level++) {
const pagesForLevel: PageTreeNodeInterface[] = [];

for (let i = 0; i < faker.datatype.number({ min: 100, max: 200 }); i++) {
for (let i = 0; i < faker.number.int({ min: 100, max: 200 }); i++) {
const name = faker.lorem.sentence();
const page = await this.pageTreeService.createNode(
{
name: name,
slug: slugify(name),
parentId: level > 0 ? faker.random.arrayElement(pages[level - 1]).id : undefined,
parentId: level > 0 ? faker.helpers.arrayElement(pages[level - 1]).id : undefined,
attachedDocument: { type: "Page" },
// @ts-expect-error Typing of PageTreeService is wrong https://github.com/vivid-planet/comet/pull/1515#issue-2042001589
userGroup: UserGroup.All,
Expand All @@ -258,7 +258,7 @@ export class FixturesConsole {

const pageInput = getDefaultPageInput();

const pageId = faker.datatype.uuid();
const pageId = faker.string.uuid();

await this.entityManager.persistAndFlush(
this.pagesRepository.create({
Expand All @@ -272,7 +272,7 @@ export class FixturesConsole {

await this.pageTreeService.updateNodeVisibility(
page.id,
faker.random.arrayElement([
faker.helpers.arrayElement([
PageTreeNodeVisibility.Published,
PageTreeNodeVisibility.Unpublished,
PageTreeNodeVisibility.Archived,
Expand Down
6 changes: 3 additions & 3 deletions demo/api/src/db/fixtures/generators/blocks/blocks.generator.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
import { type BlocksBlockFixturesGeneratorMap, type ExtractBlockInput, type ExtractBlockInputFactoryProps, type FileInterface } from "@comet/cms-api";
import { faker } from "@faker-js/faker";
import { type Config } from "@src/config/config";
import { generateImageBlock } from "@src/db/fixtures/generators/blocks/image.generator";
import { PageContentBlock } from "@src/documents/pages/blocks/page-content.block";
import faker from "faker";

import { generateRichtextBlock } from "./richtext.generator";
import { generateSpaceBlock } from "./space.generator";
Expand All @@ -19,8 +19,8 @@ export const generateBlocksBlock = (
},
): ExtractBlockInput<typeof PageContentBlock> => {
const blocks: ExtractBlockInputFactoryProps<typeof PageContentBlock>["blocks"] = [];
for (let i = 0; i < faker.datatype.number(20); i++) {
const [type, generator] = faker.random.arrayElement(Object.entries(blockCfg));
for (let i = 0; i < faker.number.int(20); i++) {
const [type, generator] = faker.helpers.arrayElement(Object.entries(blockCfg));
if (generator) {
blocks.push({
key: String(i),
Expand Down
10 changes: 5 additions & 5 deletions demo/api/src/db/fixtures/generators/blocks/image.generator.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
import { type DamImageBlock, type ExtractBlockInputFactoryProps, type FileInterface, FocalPoint, type ImageCropAreaInput } from "@comet/cms-api";
import faker from "faker";
import { faker } from "@faker-js/faker";

export const generateImageBlock = (
imageFiles: FileInterface[] | FileInterface,
cropArea?: ImageCropAreaInput,
): ExtractBlockInputFactoryProps<typeof DamImageBlock> => {
const imageFile = Array.isArray(imageFiles) ? faker.random.arrayElement(imageFiles) : imageFiles;
const imageFile = Array.isArray(imageFiles) ? faker.helpers.arrayElement(imageFiles) : imageFiles;
const type = imageFile.mimetype == "image/svg+xml" ? "svgImage" : "pixelImage";
// eslint-disable-next-line @typescript-eslint/no-explicit-any
const props: any = {
Expand All @@ -26,7 +26,7 @@ export const generateImageBlock = (
};

export const calculateDefaultCropInput = ({ image }: FileInterface): ImageCropAreaInput => {
const focalPoint = faker.random.arrayElement([
const focalPoint = faker.helpers.arrayElement([
FocalPoint.SMART,
FocalPoint.CENTER,
FocalPoint.NORTHEAST,
Expand All @@ -39,7 +39,7 @@ export const calculateDefaultCropInput = ({ image }: FileInterface): ImageCropAr
focalPoint,
x: focalPoint !== FocalPoint.SMART ? 0 : undefined,
y: focalPoint !== FocalPoint.SMART ? 0 : undefined,
height: focalPoint !== FocalPoint.SMART ? faker.datatype.number({ min: 20, max: 100 }) : undefined,
width: focalPoint !== FocalPoint.SMART ? faker.datatype.number({ min: 20, max: 100 }) : undefined,
height: focalPoint !== FocalPoint.SMART ? faker.number.int({ min: 20, max: 100 }) : undefined,
width: focalPoint !== FocalPoint.SMART ? faker.number.int({ min: 20, max: 100 }) : undefined,
};
};
6 changes: 3 additions & 3 deletions demo/api/src/db/fixtures/generators/blocks/text-image.generator.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
import { type ExtractBlockInputFactoryProps, type FileInterface, ImagePosition } from "@comet/cms-api";
import { faker } from "@faker-js/faker";
import { type TextImageBlock } from "@src/common/blocks/text-image.block";
import { type Config } from "@src/config/config";
import faker from "faker";

import { generateImageBlock } from "./image.generator";
import { generateRichtextBlock } from "./richtext.generator";
Expand All @@ -13,7 +13,7 @@ export const generateTextImageBlock = (
return {
text: generateRichtextBlock(),
image: generateImageBlock(imageFiles),
imagePosition: faker.random.arrayElement([ImagePosition.Left, ImagePosition.Right]),
imageAspectRatio: faker.random.arrayElement(config.dam.allowedImageAspectRatios),
imagePosition: faker.helpers.arrayElement([ImagePosition.Left, ImagePosition.Right]),
imageAspectRatio: faker.helpers.arrayElement(config.dam.allowedImageAspectRatios),
};
};
2 changes: 1 addition & 1 deletion demo/api/src/db/fixtures/generators/folder.fixture.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
import { type FolderInterface, type FoldersService } from "@comet/cms-api";
import faker from "faker";
import { faker } from "@faker-js/faker";

export class FolderFixture {
constructor(private foldersService: FoldersService) {}
Expand Down
4 changes: 2 additions & 2 deletions demo/api/src/db/fixtures/generators/many-images-test-page-fixture.service.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
import { PageTreeNodeVisibility, PageTreeService } from "@comet/cms-api";
import { faker } from "@faker-js/faker";
import { InjectRepository } from "@mikro-orm/nestjs";
import { EntityManager, EntityRepository } from "@mikro-orm/postgresql";
import { Injectable } from "@nestjs/common";
Expand All @@ -10,7 +11,6 @@ import { Page } from "@src/documents/pages/entities/page.entity";
import { PageTreeNodeScope } from "@src/page-tree/dto/page-tree-node-scope";
import { PageTreeNodeCategory } from "@src/page-tree/page-tree-node-category";
import { UserGroup } from "@src/user-groups/user-group";
import faker from "faker";

import { generateImageBlock } from "./blocks/image.generator";
import { generateSeoBlock } from "./blocks/seo.generator";
Expand Down Expand Up @@ -68,7 +68,7 @@ export class ManyImagesTestPageFixtureService {
pageInput.seo = generateSeoBlock();
pageInput.content = PageContentBlock.blockInputFactory({
blocks: imageBlocks.map((c) => ({
key: faker.datatype.uuid(),
key: faker.string.uuid(),
visible: true,
type: "image",
props: c,
Expand Down
40 changes: 20 additions & 20 deletions demo/api/src/db/fixtures/generators/products-fixture.service.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,30 +24,30 @@ export class ProductsFixtureService {

for (let i = 0; i < 10; i++) {
const manufacturer = this.manufacturersRepository.create({
id: faker.datatype.uuid(),
id: faker.string.uuid(),
name: faker.company.name(),
address: {
street: faker.address.street(),
streetNumber: Number(faker.address.buildingNumber()),
zip: Number(faker.address.zipCode("####")),
country: faker.address.country(),
street: faker.location.street(),
streetNumber: Number(faker.location.buildingNumber()),
zip: Number(faker.location.zipCode("####")),
country: faker.location.country(),
alternativeAddress: {
street: faker.address.street(),
streetNumber: Number(faker.address.buildingNumber()),
zip: Number(faker.address.zipCode("####")),
country: faker.address.country(),
street: faker.location.street(),
streetNumber: Number(faker.location.buildingNumber()),
zip: Number(faker.location.zipCode("####")),
country: faker.location.country(),
},
},
addressAsEmbeddable: {
street: faker.address.street(),
streetNumber: Number(faker.address.buildingNumber()),
zip: Number(faker.address.zipCode("####")),
country: faker.address.country(),
street: faker.location.street(),
streetNumber: Number(faker.location.buildingNumber()),
zip: Number(faker.location.zipCode("####")),
country: faker.location.country(),
alternativeAddress: {
street: faker.address.street(),
streetNumber: Number(faker.address.buildingNumber()),
zip: Number(faker.address.zipCode("####")),
country: faker.address.country(),
street: faker.location.street(),
streetNumber: Number(faker.location.buildingNumber()),
zip: Number(faker.location.zipCode("####")),
country: faker.location.country(),
},
},
});
Expand All @@ -61,16 +61,16 @@ export class ProductsFixtureService {
const title = faker.commerce.productName();

const product = this.productsRepository.create({
id: faker.datatype.uuid(),
id: faker.string.uuid(),
title: faker.commerce.productName(),
status: faker.helpers.arrayElement([ProductStatus.Published, ProductStatus.Unpublished]),
slug: faker.helpers.slugify(title),
description: faker.commerce.productDescription(),
type: faker.helpers.arrayElement([ProductType.Cap, ProductType.Shirt, ProductType.Tie]),
additionalTypes: [],
price: faker.datatype.number(),
price: faker.number.float({ min: 0, max: 1000, fractionDigits: 2 }),
inStock: faker.datatype.boolean(),
soldCount: faker.datatype.number(),
soldCount: faker.number.int({ min: 0, max: 100 }),
availableSince: faker.date.past(),
image: DamImageBlock.blockInputFactory({ attachedBlocks: [] }).transformToBlockData(),
manufacturer: faker.helpers.arrayElement(manufacturers),
Expand Down
Loading