fix: identify sandboxes during authentication #862
Conversation
src/org/authInfo.ts
Outdated
| logger.debug(`error updating auth file for: ${orgAuthInfo.getUsername()}`, err); | ||
| } | ||
|
|
||
| try { |
There was a problem hiding this comment.
would anything bad happen if you failed to update the AuthFile but then updated the SandboxConfig?
There was a problem hiding this comment.
Good question. That's most likely a bad state though so probably just abort the mission (return;) if there's an error updating the auth file. I'll make that change.
src/org/authInfo.ts
Outdated
| const stateAggregator = await StateAggregator.getInstance(); | ||
| stateAggregator.sandboxes.set(fields.orgId, sfSandbox); | ||
| logger.debug(`writing sandbox auth file for: ${orgAuthInfo.getUsername()} with ID: ${fields.orgId}`); | ||
| await stateAggregator.sandboxes.write(fields.orgId); |
There was a problem hiding this comment.
this seems safe from the ConfigFile bugs because it should only ever hit one of these.
Just be sure that the auth command is calling this identifyPossibleScratchOrgs NOT in parallel with anything else that might be touching the authFile.
There was a problem hiding this comment.
I checked all places I could find and nothing was done in parallel so hopefully it's ok.
|
|
||
| // TODO: return if url is not sandbox-like to avoid constantly asking about production orgs | ||
| // TODO: someday we make this easier by asking the org if it is a scratch org | ||
|
|
||
| const hubAuthInfos = await AuthInfo.getDevHubAuthInfos(); | ||
| // Get a list of org auths that are known not to be devhubs, scratch orgs, or sandboxes. | ||
| const possibleProdOrgs = await AuthInfo.listAllAuthorizations( |
There was a problem hiding this comment.
since it's possible that a DevHub is also a ProdOrg, you could include DevHubs in the filter.
Then instead of having to queryScratchOrg each DevHub and then catch to ask about sandbox, you could ask about everything on the first round.
src/org/authInfo.ts
Outdated
| sandboxProcessId: sbxProcess.Id, | ||
| sandboxInfoId: sbxProcess.SandboxInfoId, | ||
| timestamp: new Date().toISOString(), | ||
| } as SandboxFields; |
There was a problem hiding this comment.
is the SandboxFields type wrong that timestamp isn't part of it? Can that be fixed, or at least leave a comment about why the type assertion is necessary?
|
QA Notes: scratchcreate a scratch org the normal way, then get password 📓 Differences between a scratch org auth'd this way and the one created from the devHub
Not scratch or sandboxlogout, re-auth to an existing prod org, inspect auth file. sboxTBD create sbox the normal way |
|
QA notes: merged based on demos |
What does this PR do?
Enhances
AuthInfo.identifyPossibleScratchOrgs()to also identify sandboxes.Adds another public method to
Orgto allow querying theSandboxProcesssObject by org ID.What issues does this PR fix or reference?
@W-11831532@
QA suggestions:
Create a sandbox from the UI. Auth to it from the CLI. Check the auth file for the org and that a sandbox specific file was created in the global dir. Attempting to delete the sandbox should work, since it can now be properly identified as a sandbox during authentication.