@salesforce/core 5.0.1-v5-beta.0 → 5.1.0

package/lib/logger/cleanup.js

@@ -14,7 +14,7 @@ const logger_1 = require("./logger");
 /**
  * the odds of running are 1 in CLEAN_ODDS
  * ex: CLEAN_ODDS=100 implies 1 in 100
- * ex: CLEAN_ODDS=100 implies 1 in 1 (run every time)
+ * ex: CLEAN_ODDS=1 implies 1 in 1 (run every time)
  * */
 const CLEAN_ODDS = 100;
 const MAX_FILE_AGE_DAYS = 7;

package/lib/org/connection.js

@@ -149,7 +149,7 @@ class Connection extends jsforce_1.Connection {
             ...exports.SFDX_HTTP_HEADERS,
             ...lowercasedHeaders,
         };
-        this.logger.debug(`request: ${JSON.stringify(httpRequest)}`);
+        this.logger.getRawLogger().debug(httpRequest, 'request');
         return super.request(httpRequest, options);
     }
     /**

package/lib/org/org.js

@@ -94,14 +94,14 @@ class Org extends kit_1.AsyncOptionalCreatable {
         async: false,
         interval: kit_1.Duration.seconds(30),
     }) {
-        this.logger.debug(`CreateSandbox called with SandboxRequest: ${JSON.stringify(sandboxReq, undefined, 2)}`);
+        this.logger.debug(sandboxReq, 'CreateSandbox called with SandboxRequest');
         const createResult = await this.connection.tooling.create('SandboxInfo', sandboxReq);
-        this.logger.debug(`Return from calling tooling.create: ${JSON.stringify(createResult, undefined, 2)}`);
+        this.logger.debug(createResult, 'Return from calling tooling.create');
         if (Array.isArray(createResult) || !createResult.success) {
             throw messages.createError('sandboxInfoCreateFailed', [JSON.stringify(createResult)]);
         }
         const sandboxCreationProgress = await this.querySandboxProcessBySandboxInfoId(createResult.id);
-        this.logger.debug(`Return from calling singleRecordQuery with tooling: ${JSON.stringify(sandboxCreationProgress, undefined, 2)}`);
+        this.logger.debug(sandboxCreationProgress, 'Return from calling singleRecordQuery with tooling');
         const isAsync = !!options.async;
         if (isAsync) {
             // The user didn't want us to poll, so simply return the status
@@ -109,7 +109,7 @@ class Org extends kit_1.AsyncOptionalCreatable {
             return sandboxCreationProgress;
         }
         const [wait, pollInterval] = this.validateWaitOptions(options);
-        this.logger.debug(`create - pollStatusAndAuth sandboxProcessObj ${JSON.stringify(sandboxCreationProgress, undefined, 2)}, max wait time of ${wait.minutes} minutes`);
+        this.logger.debug(sandboxCreationProgress, `create - pollStatusAndAuth sandboxProcessObj, max wait time of ${wait.minutes} minutes`);
         return this.pollStatusAndAuth({
             sandboxProcessObj: sandboxCreationProgress,
             wait,
@@ -125,7 +125,7 @@ class Org extends kit_1.AsyncOptionalCreatable {
      */
     async cloneSandbox(sandboxReq, sourceSandboxName, options) {
         sandboxReq.SourceId = (await this.querySandboxProcessBySandboxName(sourceSandboxName)).SandboxInfoId;
-        this.logger.debug('Clone sandbox sourceId %s', sandboxReq.SourceId);
+        this.logger.debug(`Clone sandbox sourceId ${sandboxReq.SourceId}`);
         return this.createSandbox(sandboxReq, options);
     }
     /**
@@ -141,7 +141,7 @@ class Org extends kit_1.AsyncOptionalCreatable {
         async: false,
         interval: kit_1.Duration.seconds(30),
     }) {
-        this.logger.debug(`ResumeSandbox called with ResumeSandboxRequest: ${JSON.stringify(resumeSandboxRequest, undefined, 2)}`);
+        this.logger.debug(resumeSandboxRequest, 'ResumeSandbox called with ResumeSandboxRequest');
         let sandboxCreationProgress;
         // seed the sandboxCreationProgress via the resumeSandboxRequest options
         if (resumeSandboxRequest.SandboxName) {
@@ -155,7 +155,7 @@ class Org extends kit_1.AsyncOptionalCreatable {
                 resumeSandboxRequest.SandboxName ?? resumeSandboxRequest.SandboxProcessObjId,
             ]);
         }
-        this.logger.debug(`Return from calling singleRecordQuery with tooling: ${JSON.stringify(sandboxCreationProgress, undefined, 2)}`);
+        this.logger.debug(sandboxCreationProgress, 'Return from calling singleRecordQuery with tooling');
         if (!sandboxIsResumable(sandboxCreationProgress.Status)) {
             throw messages.createError('sandboxNotResumable', [
                 sandboxCreationProgress.SandboxName,
@@ -172,7 +172,7 @@ class Org extends kit_1.AsyncOptionalCreatable {
                 if (sandboxInfo) {
                     await lifecycleEvents_1.Lifecycle.getInstance().emit(SandboxEvents.EVENT_AUTH, sandboxInfo);
                     try {
-                        this.logger.debug(`sandbox signup complete with ${JSON.stringify(sandboxInfo, undefined, 2)}`);
+                        this.logger.debug(sandboxInfo, 'sandbox signup complete');
                         await this.writeSandboxAuthFile(sandboxCreationProgress, sandboxInfo);
                         return sandboxCreationProgress;
                     }
@@ -184,7 +184,7 @@ class Org extends kit_1.AsyncOptionalCreatable {
             await lifecycleEvents_1.Lifecycle.getInstance().emit(SandboxEvents.EVENT_ASYNC_RESULT, sandboxCreationProgress);
             throw messages.createError('sandboxCreateNotComplete');
         }
-        this.logger.debug(`resume - pollStatusAndAuth sandboxProcessObj ${JSON.stringify(sandboxCreationProgress, undefined, 2)}, max wait time of ${wait.minutes} minutes`);
+        this.logger.debug(sandboxCreationProgress, `resume - pollStatusAndAuth sandboxProcessObj, max wait time of ${wait.minutes} minutes`);
         return this.pollStatusAndAuth({
             sandboxProcessObj: sandboxCreationProgress,
             wait,
@@ -752,7 +752,7 @@ class Org extends kit_1.AsyncOptionalCreatable {
      */
     async init() {
         const stateAggregator = await stateAggregator_1.StateAggregator.getInstance();
-        this.logger = await logger_1.Logger.child('Org');
+        this.logger = (await logger_1.Logger.child('Org')).getRawLogger();
         this.configAggregator = this.options.aggregator ? this.options.aggregator : await configAggregator_1.ConfigAggregator.create();
         if (!this.options.connection) {
             if (this.options.aliasOrUsername == null) {
@@ -809,7 +809,7 @@ class Org extends kit_1.AsyncOptionalCreatable {
         interval: kit_1.Duration.seconds(30),
     }) {
         const [wait, pollInterval] = this.validateWaitOptions(options);
-        this.logger.debug(`AuthWithRetries sandboxProcessObj ${JSON.stringify(sandboxProcessObj, undefined, 2)}, max wait time of ${wait.minutes} minutes`);
+        this.logger.debug(sandboxProcessObj, `AuthWithRetries sandboxProcessObj, max wait time of ${wait.minutes} minutes`);
         return this.pollStatusAndAuth({
             sandboxProcessObj,
             wait,
@@ -824,10 +824,10 @@ class Org extends kit_1.AsyncOptionalCreatable {
      */
     async queryLatestSandboxProcessBySandboxName(sandboxNameIn) {
         const { tooling } = this.getConnection();
-        this.logger.debug('QueryLatestSandboxProcessBySandboxName called with SandboxName: %s ', sandboxNameIn);
+        this.logger.debug(`QueryLatestSandboxProcessBySandboxName called with SandboxName: ${sandboxNameIn}`);
         const queryStr = `SELECT Id, Status, SandboxName, SandboxInfoId, LicenseType, CreatedDate, CopyProgress, SandboxOrganization, SourceId, Description, EndDate FROM SandboxProcess WHERE SandboxName='${sandboxNameIn}' AND Status != 'D' ORDER BY CreatedDate DESC LIMIT 1`;
         const queryResult = await tooling.query(queryStr);
-        this.logger.debug('Return from calling queryToolingApi: %s ', queryResult);
+        this.logger.debug(queryResult, 'Return from calling queryToolingApi');
         if (queryResult?.records?.length === 1) {
             return queryResult.records[0];
         }
@@ -898,7 +898,7 @@ class Org extends kit_1.AsyncOptionalCreatable {
         }
         if (sandboxInfoId) {
             const deleteResult = await this.destroySandbox(prodOrg, sandboxInfoId);
-            this.logger.debug('Return from calling tooling.delete: ', deleteResult);
+            this.logger.debug(deleteResult, 'Return from calling tooling.delete');
         }
         // cleanup remaining artifacts
         await this.remove();
@@ -1015,10 +1015,11 @@ class Org extends kit_1.AsyncOptionalCreatable {
         await stateAggregator.sandboxes.remove(this.getOrgId());
     }
     async writeSandboxAuthFile(sandboxProcessObj, sandboxRes) {
-        this.logger.debug(`writeSandboxAuthFile sandboxProcessObj: ${JSON.stringify(sandboxProcessObj)}, sandboxRes: ${JSON.stringify(sandboxRes)}`);
+        this.logger.debug(sandboxProcessObj, 'writeSandboxAuthFile sandboxProcessObj');
+        this.logger.debug(sandboxRes, 'writeSandboxAuthFile sandboxRes');
         if (sandboxRes.authUserName) {
             const productionAuthFields = this.connection.getAuthInfoFields();
-            this.logger.debug('Result from getAuthInfoFields: AuthFields', productionAuthFields);
+            this.logger.debug(productionAuthFields, 'Result from getAuthInfoFields: AuthFields');
             // let's do headless auth via jwt (if we have privateKey) or web auth
             const oauth2Options = {
                 loginUrl: sandboxRes.loginUrl,
@@ -1039,7 +1040,11 @@ class Org extends kit_1.AsyncOptionalCreatable {
                 oauth2Options,
                 parentUsername: productionAuthFields.username,
             });
-            this.logger.debug('Creating AuthInfo for sandbox', sandboxRes.authUserName, productionAuthFields.username, oauth2Options);
+            this.logger.debug({
+                sandboxResAuthUsername: sandboxRes.authUserName,
+                productionAuthFieldsUsername: productionAuthFields.username,
+                ...oauth2Options,
+            }, 'Creating AuthInfo for sandbox');
             // save auth info for new sandbox
             await authInfo.save();
             const sandboxOrgId = authInfo.getFields().orgId;
@@ -1069,7 +1074,7 @@ class Org extends kit_1.AsyncOptionalCreatable {
         }
     }
     async pollStatusAndAuth(options) {
-        this.logger.debug('PollStatusAndAuth called with SandboxProcessObject', options.sandboxProcessObj, options.wait.minutes, options.pollInterval.seconds);
+        this.logger.debug(options, 'PollStatusAndAuth called with SandboxProcessObject');
         let remainingWait = options.wait;
         let waitingOnAuth = false;
         const pollingClient = await pollingClient_1.PollingClient.create({
@@ -1080,7 +1085,7 @@ class Org extends kit_1.AsyncOptionalCreatable {
                 if (sandboxInfo) {
                     await lifecycleEvents_1.Lifecycle.getInstance().emit(SandboxEvents.EVENT_AUTH, sandboxInfo);
                     try {
-                        this.logger.debug('sandbox signup complete with', sandboxInfo);
+                        this.logger.debug(sandboxInfo, 'sandbox signup complete with');
                         await this.writeSandboxAuthFile(sandboxProcessObj, sandboxInfo);
                         return { completed: true, payload: sandboxProcessObj };
                     }
@@ -1142,7 +1147,7 @@ class Org extends kit_1.AsyncOptionalCreatable {
                 sandboxName: sandboxProcessObj.SandboxName,
                 callbackUrl,
             };
-            this.logger.debug('Calling sandboxAuth with SandboxUserAuthRequest', sandboxReq);
+            this.logger.debug(sandboxReq, 'Calling sandboxAuth with SandboxUserAuthRequest');
             // eslint-disable-next-line no-underscore-dangle
             const url = `${this.connection.tooling._baseUrl()}/sandboxAuth`;
             const params = {
@@ -1152,7 +1157,7 @@ class Org extends kit_1.AsyncOptionalCreatable {
                 body: JSON.stringify(sandboxReq),
             };
             const result = await this.connection.tooling.request(params);
-            this.logger.debug('Result of calling sandboxAuth', result);
+            this.logger.debug(result, 'Result of calling sandboxAuth');
             return result;
         }
         catch (err) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@salesforce/core",
-  "version": "5.0.1-v5-beta.0",
+  "version": "5.1.0",
   "description": "Core libraries to interact with SFDX projects, orgs, and APIs.",
   "main": "lib/exported",
   "types": "lib/exported.d.ts",
@@ -75,9 +75,9 @@
     "chai-string": "^1.5.0",
     "eslint": "^8.44.0",
     "eslint-config-prettier": "^8.8.0",
-    "eslint-config-salesforce": "^2.0.1",
+    "eslint-config-salesforce": "^2.0.2",
     "eslint-config-salesforce-license": "^0.2.0",
-    "eslint-config-salesforce-typescript": "^1.1.1",
+    "eslint-config-salesforce-typescript": "^1.1.2",
     "eslint-plugin-header": "^3.1.1",
     "eslint-plugin-import": "^2.27.5",
     "eslint-plugin-jsdoc": "^43.2.0",