Feature/npmfakerrecipeprocessing #16

jdschleicher · 2025-04-02T11:12:33Z

Motivation and Context

As an attempt to remove barriers, limiting setup, and making it easy to work with production like development in development and QA environments, this update introduces a new node based "Faker" processor.

VS Code extensions bundle their own npm dependencies at build time. With https://github.com/faker-js/faker added to treecipe's package.json under dependencies, it gets included without any install steps needed outside of having VSCode installed of your machine to begin with.

What does this PR do?

Based upon the same YAML file approached used with snowfakery, this update introduces three capabilities to support a faker-js option to generating YAML recipe files and processing the generated faker recipes to production-like data:

New extension command to switch between snowfakery-cli and faker-js processors
FakerJSRecipeFakerService: based on inputs from field xml, provides expected syntax needed for faker-js recipe processor to work as expected
FakerJSRecipeProcessor: Given expected inputs within expected expression syntax indicators "${{ }}" , this processor will either evaluate the faker expression as expected or it will take additional expected outputs surrounding the syntax indicators and build structures to create an output that represents an accepted value structure for Salesforce field types ( Text, dependent picklist , multipicklist, and more )
In addition to the two new FakerJS files, the existing FakerRecipeService and FakerServiceProcessor files were renamed to be specific for snowfakery, "SnowfakeryFakerRecipeService" and "SnowfakeryServiceProcessor". This is to clearly describe file names containing expected handling logic for either snowfakery or faker-js.
Custom functions for date and datetime field types for FakerJSRecipeProcessor similar to Snowfakery.
Non-intrusive info box for inserting data sets (doesn't prevent anything from being done in VS Code and shows the status of the files being processed)
On Non-intrusive progress window, selecting "Cancel" button will initiate "Delete Previous Records" functionality that will delete any saved records of that run

IMPORTANT SYNTAX CONSIDERATIONS

when using custom date and datetime function, surround the values provided for the "to" and "from" arguments with either single or double quotes.
a. valid syntax of Custom functions
Use the "multiline" character to avoid yaml compile issues for fakerjs files as they require use of colon to pass in arguments to faker functions. This colon is a key character in YAML syntax and without the multiline pipe ("|") character used to ignore the colon within the faker expression, the YAML will not compile.

What this PR DOES NOT introduce:

Full snowfakery feature parity. Two examples are snowfakery's "variables" and "friends" features which are very helpful. Updates to support these features will be introduced shortly after this release.

Type of Change

Bug fix (non-breaking change which fixes an issue)
New feature (non-breaking change which adds functionality)
Breaking change (fix or feature that would cause existing functionality to change)
Documentation update
Other (please describe):

How Has This Been Tested?

Test Details

In order to introduce this functionality with confidence, a robust test suite was implemented to drive validation of the two essential FakerJS services:

FakerJSRecipeFakerService
FakerJSRecipeProcessor

For each service there are dedicated tests

Checklist

I have performed a self-review of my own code
I have commented my code, particularly in hard-to-understand areas
I have made corresponding changes to the documentation
My changes generate no new warnings
I have added tests that prove my fix is effective or that my feature works
New and existing unit tests pass locally with my changes

Changelog for branch: feature/npmfakerrecipeprocessing

Generated on: 2025-04-28

Summary

Total commits: 129
Files added: 16
Files modified: 17
Files deleted: 3
Files renamed: 76

Changes at a glance

Added Files

Added File	Commits	History
developmentSupportScripts/changeLogGenerator.ps1	5	View Full History
extensionDevelopmentScriptsAndArtifacts/treecipe/GeneratedRecipes/recipe-2025-01-03T15-45-06-fakerjs.yaml	6	View Full History
src/nodeDevelopmentSuppport/fakerjsRecipeParsing.ts	9	View Full History
src/nodeDevelopmentSuppport/fromFakerJSExpressionToCollectionsApiCall.ts	5	View Full History
src/nodeDevelopmentSuppport/tests/TestFullPathToStoreDatasetFiles/2025-04-22T10-16-54-collectionsApi-Example_Everything__c.json	1	View Full History
src/nodeDevelopmentSuppport/tests/TestFullPathToStoreDatasetFiles/2025-04-22T10-16-54-collectionsApi-Example_Everything__c.json-results.json	1	View Full History
src/nodeDevelopmentSuppport/tests/TestFullPathToStoreDatasetFiles/collectionsApi-Example_Everything__c.json	1	View Full History
src/nodeDevelopmentSuppport/tests/test.yaml	14	View Full History
src/treecipe/src/CollectionsApiService/ICollectionsApiJsonStructure.ts	2	View Full History
src/treecipe/src/FakerRecipeProcessor/FakerJSRecipeProcessor/FakerJSRecipeProcessor.ts	32	View Full History
src/treecipe/src/FakerRecipeProcessor/FakerJSRecipeProcessor/tests/FakerJSRecipeProcessor.test.ts	15	View Full History
src/treecipe/src/FakerRecipeProcessor/FakerJSRecipeProcessor/tests/mocks/FakerJSExpressionMocker.ts	5	View Full History
src/treecipe/src/FakerRecipeProcessor/IFakerRecipeProcessor.ts	5	View Full History
src/treecipe/src/FakerRecipeProcessor/SnowfakeryRecipeProcessor/SnowfakeryRecipeProcessor.ts	6	View Full History
src/treecipe/src/FakerRecipeProcessor/SnowfakeryRecipeProcessor/tests/SnowfakeryRecipeProcessor.test.ts	6	View Full History
src/treecipe/src/RecipeFakerService.ts/FakerJSRecipeFakerService/FakerJSRecipeFakerService.ts	14	View Full History

Modified Files

Modified File	Commits	History
.github/workflowScripts/checkJestTestCoverage.ps1	2	View Full History
jest.config.js	5	View Full History
package-lock.json	4	View Full History
package.json	7	View Full History
src/extension.ts	4	View Full History
src/treecipe/src/CollectionsApiService/CollectionsApiService.ts	4	View Full History
src/treecipe/src/CollectionsApiService/tests/CollectionsApiService.test.ts	5	View Full History
src/treecipe/src/ConfigurationService/ConfigurationService.ts	10	View Full History
src/treecipe/src/ConfigurationService/tests/ConfigurationService.test.ts	5	View Full History
src/treecipe/src/DirectoryProcessingService/tests/DirectoryProcessor.test.ts	4	View Full History
src/treecipe/src/ExtensionCommandService/ExtensionCommandService.ts	10	View Full History
src/treecipe/src/RecipeService/RecipeService.ts	2	View Full History
src/treecipe/src/RecipeService/tests/RecipeService.test.ts	7	View Full History
src/treecipe/src/RecipeService/tests/mocks/RecipeMockService.ts	6	View Full History
src/treecipe/src/VSCodeWorkspace/VSCodeWorkspaceService.ts	6	View Full History
src/treecipe/src/VSCodeWorkspace/tests/VSCodeWorkspaceService.test.ts	6	View Full History
tsconfig.json	4	View Full History

Deleted Files

Deleted File	Commits	History
src/treecipe/src/FakerService/NPMFakerService/NPMFakerService.ts	1	View Full History
src/treecipe/src/SnowfakeryIntegrationService/SnowfakeryIntegrationService.ts	4	View Full History
src/treecipe/src/SnowfakeryIntegrationService/tests/SnowfakeryIntegrationService.test.ts	1	View Full History

Renamed Files

…e is created without directory slashes from branch name

…s selected as faker service

jdschleicher added 30 commits March 20, 2025 06:03

removing comment

262b87d

initial setup for changing faker implemenation

6b57a3b

select faker service functionality

6cc14b1

major chagnes for faker integration interface setup

1382f28

wip for faker interface setup for processing recipe files

a0942da

changing service to FakerJS

2a6a4cb

wip refactoring for generic faker processign implementation

8e399ec

wip - completig interface definitions

c18b0b5

initial setup for testing fakerjs

69b60e4

gettting faker import to work as expected

268f4ee

wip for faker js commands

53ca311

adjustments for faker-js values

9cbabb7

adjustments to go back to compiling commonjs

7f34695

clean up

f9de2db

adding expected dollar sign

0c19e22

wip for testing

ab3d8b2

wip renaming

bbc1f33

recipe faker service renaming

1accdae

renaming snowfkaery service

008b246

workign dependent picklist logic

6150605

fix for collecionsapiservice test following refactoring

3a0f2f8

test adjustments for configuraiotn service

a2e845c

adjustments for workign vscodeworkspaceservice

48089d4

adjustmens for unit testclean up

143bc6f

updates for passing recipeprocessor tests

8375af3

wip for fakerjs evaluation

bbcacfd

adjustments for async setup

96811e7

wip for error handling

86d5e1c

adjustments for new expected syntax

0f5e948

continued update to surrounding syntax for faker

9901d31

jdschleicher added 26 commits April 22, 2025 05:56

first successful run

29b4028

tip - success

fefaf39

tip

ab15b0a

adjusting for formatting date time on today

8e33685

workign set 2

2bc7b2d

testing for set 3

5e08e0b

console logs

a5f8ff1

tip

d266494

adjustments to cap allowed min and max dates

0c00821

working whtiespace regex capture

12f1268

full yaml testing

bea607b

fixed unit test based on adjusted logic

2a3fdf4

adjustments for new faker version

a46b18d

adjustments to faker.person

86a85a4

explicitly compiling on node and jest types

da9a86a

getting rid of test files

13b8e0d

adjustment to file name creation for cdhangelog feature to ensure fil…

640bad2

…e is created without directory slashes from branch name

for expected ootb objects, move decimal points outside of faker result

0131c8b

testing setup for ensuring only fakerjs datasets show when faker-js i…

4ce28c0

…s selected as faker service

adjustments for test fix

5edf3ba

fixing formula field

ab3b938

wip

a9a12b5

removing boilerplate

9a08009

collections api serfvice progress indicator

fcc65ca

code coverage adjustment

0ee235e

removing double quotes around todo prompt

518af00

jdschleicher marked this pull request as ready for review April 28, 2025 10:34

adding delete-previous records on cancel

94fea56

jdschleicher merged commit 091e76e into main Apr 28, 2025
2 checks passed

jdschleicher mentioned this pull request Apr 29, 2025

Bug/fixing faker js dependency #24

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Feature/npmfakerrecipeprocessing #16

Feature/npmfakerrecipeprocessing #16

Uh oh!

jdschleicher commented Apr 2, 2025 •

edited

Loading

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

Feature/npmfakerrecipeprocessing #16

Feature/npmfakerrecipeprocessing #16

Uh oh!

Conversation

jdschleicher commented Apr 2, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Motivation and Context

What does this PR do?

IMPORTANT SYNTAX CONSIDERATIONS

Type of Change

How Has This Been Tested?

Test Details

Checklist

Changelog for branch: feature/npmfakerrecipeprocessing

Summary

Changes at a glance

Added Files

Modified Files

Deleted Files

Renamed Files

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

jdschleicher commented Apr 2, 2025 •

edited

Loading