refactor(internet): rename userName method to username

[suyashgulati]

Aims to resolve #3023

As the team has decided to user username as a convention over the current userName method name.
This PR refactors the code to use username instead.

[netlify]

✅ Deploy Preview for fakerjs ready!

Name	Link
🔨 Latest commit	afe723e
🔍 Latest deploy log	https://app.netlify.com/sites/fakerjs/deploys/670afc6b9ef8e000082d5fc2
😎 Deploy Preview	https://deploy-preview-3130.fakerjs.dev
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

---

To edit notification comments on pull requests, go to your Netlify site configuration.

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 99.96%. Comparing base (e271d4a) to head (afe723e).
Report is 1 commits behind head on next.

Additional details and impacted files

@@           Coverage Diff            @@
##             next    #3130    +/-   ##
========================================
  Coverage   99.96%   99.96%            
========================================
  Files        2798     2798            
  Lines      227793   227806    +13     
  Branches      955      577   -378     
========================================
+ Hits       227709   227737    +28     
+ Misses         84       69    -15     

Files with missing lines	Coverage Δ
src/modules/git/index.ts	100.00% <100.00%> (ø)
src/modules/internet/index.ts	100.00% <100.00%> (ø)

... and 2 files with indirect coverage changes

[suyashgulati]

I wasn't aware the old one needs to be deprecated, I expected it to be refactor issue.
I will make changes.
thanks @matthewmayer

[suyashgulati]

@matthewmayer I have made the changes and deprecated the userName
But if I am using testing both new and deprecated code I am not able to pass the preflight locally.

Its showing cannot use deprecated code.
Can you suggest what do to in that case?

[xDivisionByZerox]

The error messages are correct as eslint is warning you about the usage of deprecated code. In this specific case, it is obviously ok, since you just maked this method as deprecated. We have this rule to make sure that we are no longer using the deprecated method in any of the live source code.

For the test files you can use a comment to disable the check on the next line. An example would currently be in the image module test where avatarLegacy was deprecated:

faker/test/modules/image.spec.ts

Lines 116 to 124 in c15b488

	it('should return a random avatar url from cloudflare-ipfs', () => {
	// eslint-disable-next-line @typescript-eslint/no-deprecated
	const avatarUrl = faker.image.avatarLegacy();
	expect(avatarUrl).toBeTypeOf('string');
	expect(avatarUrl).toMatch(
	/^https:\/\/cloudflare-ipfs\.com\/ipfs\/Qmd3W5DuhgHirLHGVixi6V76LhCkZUz6pnFt5AJBiyvHye\/avatar\/\d{1,4}\.jpg$/
	);
	});

[suyashgulati]

Issue: Unit Tests are failing at checking the deprecated tag on new username method
RCA: I found out we are creating a new ephemeral files to execute examples from the js doc in test/scripts/apidocs/verify-jsdoc-tags.spec.ts being written here

As userName and username have same name but different case the execution file for username is not getting created reason being MacOS and windows have case insensitive file systems.
Because of that when running examples for username it picks up examples of userName instead and shows the deprecated console.warn.
Reference: nodejs/help#2116

Please suggest a way around this.

[matthewmayer]

Great detective work!

[ST-DDT]

You can use the following as a workaround:

faker/test/scripts/apidocs/verify-jsdoc-tags.spec.ts

Line 33 in 6e72712

function resolvePathToMethodFile(

function resolvePathToMethodFile(
  moduleName: string,
  methodName: string,
  signature: number
): string {
  const dir = resolveDirToModule(moduleName);

  // TODO @ST-DDT 2024-09-23: Remove this in v10
  if (methodName === 'userName') {
    methodName = 'userName2';
  }

  return resolve(dir, `${methodName}_${signature}.ts`);
}

[matthewmayer]

I noticed on
https://deploy-preview-3130.fakerjs.dev/api/

both username and userName link to https://deploy-preview-3130.fakerjs.dev/api/internet.html#username (as the hash fragments are lowercased)

[xDivisionByZerox]

I noticed on deploy-preview-3130.fakerjs.dev/api

both username and userName link to deploy-preview-3130.fakerjs.dev/api/internet.html#username (as the hash fragments are lowercased)

For me it two different ones:

• username: https://deploy-preview-3130.fakerjs.dev/api/internet.html#username
• userName: https://deploy-preview-3130.fakerjs.dev/api/internet.html#username-1

Am I missing something?

[matthewmayer]

The links from the https://deploy-preview-3130.fakerjs.dev/api/ page both go to the same place.

[ST-DDT]

The links from the https://deploy-preview-3130.fakerjs.dev/api/ page both go to the same place.

I pushed a fix that should solve that issue.

[ST-DDT]

Dear @suyashgulati,

Thank you for your patience and contributions so far. We wanted to provide you with a brief update.

We are pleased to inform you that we have addressed all the known bugs in version 9.0. We will now take a short break and resume work around October 7, 2024, to begin merging new features for v9.1, including yours.

In the meantime, we hope you have a great time, and we sincerely appreciate your ongoing support and contributions.

Best regards,
your FakerJS Team

[ST-DDT]

Thanks for your contribution.
This change will be included in the next faker release v9.1.0.