feat!: ga new tree commands #975

mshanemc · 2024-06-27T16:03:24Z

What does this PR do?

GA the new tree commands
See the plan at https://github.com/salesforcecli/plugin-data/blob/main/NewTreeCommandsPlan.md

update the plan
do the steps on the plan

unrelated

the data resume command was incorrectly marked deprecated, pointing people to use the old force: command. 🤷🏻‍♂️

why aren't there UT for the new commands?

they're simple (the functions they call have the UT)
NUTs are better for org import/export with an org, fs, and os issues

What issues does this PR fix or reference?

forcedotcom/cli#2738
@W-16113657@

git2gus · 2024-06-27T16:08:46Z

This issue has been linked to a new work item: W-16113657

WillieRuemmele · 2024-06-27T17:01:54Z

messages/tree.export.md

@@ -30,7 +30,7 @@ Directory in which to generate the JSON files; default is current directory.

 - Export records retrieved with the specified SOQL query into a single JSON file in the current directory; the command uses your default org:

-  <%= config.bin %> <%= command.id %> --query "SELECT Id, Name, (SELECT Name, Address__c FROM Properties__r) FROM Broker__c"


bump dev-scripts to avoid linting the .md files?

aww, it's on current dev-scripts. I don't know why that's still happening. Maybe something in vscode ext?

WillieRuemmele · 2024-06-27T17:12:32Z

src/commands/data/import/tree.ts

  };

-  public async run(): Promise<ImportResult[] | JsonMap> {


why are we changing so much of these commands for the GA? shouldn't this PR just be changing command files/states/warnings?

the command that was src/commands/data/import/tree.ts moved to src/commands/data/import/legacy/tree.ts and the command that was src/commands/data/import/beta/tree.ts moved here.

git doesn't know we swapped the files so it tries to diff this file

jshackell-sfdc · 2024-06-27T18:57:30Z

FYI, I created a separate PR with my messages updates. I thought I was gonna have more comments, which is why I separated it out, but it turned out to be rather small: #976

WillieRuemmele · 2024-06-27T19:41:36Z

src/commands/data/export/legacy/tree.ts

@@ -46,15 +47,19 @@ export default class Export extends SfCommand<DataPlanPart[] | SObjectTreeFileCo
  };

  public async run(): Promise<DataPlanPart[] | SObjectTreeFileContents> {
+    this.info(
+      'Try the the new "sf data export beta tree" command.  It support SOQL queries with up to 5 levels of objects!'


if they run the legacy command, you'll get a suggestion for a beta command, it should just b e"data export tree" right

➜ ../../oss/plugin-data/bin/run.js data export legacy tree --query "SELECT ID FROM Account" Try the the new "sf data export beta tree" command. It support SOQL queries with up to 5 levels of objects!

even then,

➜ ../../oss/plugin-data/bin/run.js data export beta tree --query "SELECT ID FROM Account" › Error: command data:export:beta:tree not found

I'm just going to remove that. at this point, you're intentionally choosing this old command to avoid the new one.

also, you found that I had the "beta" alias wrong on the new commands.

WillieRuemmele

the beta deprecation is accurate, but there's no information on the legacy commands

 ➜  ../../oss/plugin-data/bin/run.js data export beta tree --query "SELECT ID FROM Account"
Warning: The "data export beta tree" command has been deprecated. Use "data export tree" instead.
wrote 1 records to Account.json
➜  dreamhouse-lwc git:(main) ✗  hub:(GLOBAL - DevHub) scratch:(test-enhclzordbdi@example.com)
 ➜  ../../oss/plugin-data/bin/run.js data export tree --query "SELECT ID FROM Account" 
wrote 1 records to Account.json
➜  dreamhouse-lwc git:(main) ✗  hub:(GLOBAL - DevHub) scratch:(test-enhclzordbdi@example.com)
 ➜  ../../oss/plugin-data/bin/run.js data export legacy tree --query "SELECT ID FROM Account"       
Wrote 1 records to Account.json

mshanemc · 2024-07-01T20:16:10Z

the beta deprecation is accurate, but there's no information on the legacy commands

 ➜  ../../oss/plugin-data/bin/run.js data export beta tree --query "SELECT ID FROM Account"
Warning: The "data export beta tree" command has been deprecated. Use "data export tree" instead.
wrote 1 records to Account.json
➜  dreamhouse-lwc git:(main) ✗  hub:(GLOBAL - DevHub) scratch:(test-enhclzordbdi@example.com)
 ➜  ../../oss/plugin-data/bin/run.js data export tree --query "SELECT ID FROM Account" 
wrote 1 records to Account.json
➜  dreamhouse-lwc git:(main) ✗  hub:(GLOBAL - DevHub) scratch:(test-enhclzordbdi@example.com)
 ➜  ../../oss/plugin-data/bin/run.js data export legacy tree --query "SELECT ID FROM Account"       
Wrote 1 records to Account.json

good catch...looks like we need both state = deprecated AND deprecationOptions for the warning to show.

WillieRuemmele · 2024-07-01T21:43:15Z

QA Notes

✅ : warning on legacy
✅ : no message on 'data export tree'
✅ : deprecation on 'beta' command
✅ : --json

💡 : could improve, ok since it matches current behavior - I didn't have required information in the Account.json file

 ➜  ../../oss/plugin-data/bin/run.js data import tree --files Account.json -o test-ddwy6vblev4p@example.com
Error (ERROR_HTTP_400): {"hasErrors":true,"results":[{"referenceId":"AccountRef1","errors":[{"statusCode":"REQUIRED_FIELD_MISSING","message":"Required fields are missing: [Name]","fields":["Name"]}]}]}

✅ : no note to try beta on standard command
✅ : beta is deprecated
✅ : legacy mentions deprecation day
✅ : --json consistent (for my use case)

mshanemc added 2 commits June 27, 2024 10:59

feat!: ga the new data tree commands

4e342d9

test: fix relative path references

179e044

mshanemc requested a review from a team as a code owner June 27, 2024 16:03

mshanemc changed the title ~~Sm/ga-data-commands~~ feat!: ga new tree commands Jun 27, 2024

test: nuts for new commands use their permanent name

c9e3356

mshanemc added the feature label Jun 27, 2024

WillieRuemmele requested changes Jun 27, 2024

View reviewed changes

test: don't use the old weird files format for importing

58e9758

WillieRuemmele reviewed Jun 27, 2024

View reviewed changes

mshanemc and others added 5 commits June 27, 2024 15:28

test: works ok without existing save/resolve refs

52d1199

fix: prevent undefined in template literal

ca61218

docs: fix aliases, message from old command

7a21c8d

chore: correct snapshots for alias fix

5ed1ae8

fix: update messages (#976)

7a23811

mshanemc requested a review from WillieRuemmele June 28, 2024 14:47

WillieRuemmele reviewed Jul 1, 2024

View reviewed changes

fix: deprecation shows on legacy tree commands

1c7013e

mshanemc requested a review from WillieRuemmele July 1, 2024 20:43

WillieRuemmele approved these changes Jul 1, 2024

View reviewed changes

WillieRuemmele merged commit cb49efc into main Jul 1, 2024
10 checks passed

WillieRuemmele deleted the sm/ga-data-commands branch July 1, 2024 21:43

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat!: ga new tree commands #975

feat!: ga new tree commands #975

mshanemc commented Jun 27, 2024 •

edited

Loading

git2gus bot commented Jun 27, 2024

WillieRuemmele Jun 27, 2024

mshanemc Jun 27, 2024

WillieRuemmele Jun 27, 2024

mshanemc Jun 27, 2024

jshackell-sfdc commented Jun 27, 2024

WillieRuemmele Jun 27, 2024

WillieRuemmele Jun 27, 2024

mshanemc Jun 27, 2024

mshanemc Jun 27, 2024

WillieRuemmele left a comment

mshanemc commented Jul 1, 2024

WillieRuemmele commented Jul 1, 2024

		@@ -30,7 +30,7 @@ Directory in which to generate the JSON files; default is current directory.

		- Export records retrieved with the specified SOQL query into a single JSON file in the current directory; the command uses your default org:

		<%= config.bin %> <%= command.id %> --query "SELECT Id, Name, (SELECT Name, Address__c FROM Properties__r) FROM Broker__c"

feat!: ga new tree commands #975

feat!: ga new tree commands #975

Conversation

mshanemc commented Jun 27, 2024 • edited Loading

What does this PR do?

why aren't there UT for the new commands?

What issues does this PR fix or reference?

git2gus bot commented Jun 27, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jshackell-sfdc commented Jun 27, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

WillieRuemmele left a comment

Choose a reason for hiding this comment

mshanemc commented Jul 1, 2024

WillieRuemmele commented Jul 1, 2024

QA Notes

mshanemc commented Jun 27, 2024 •

edited

Loading