sf-debug-log 0.0.2

package/README.md

@@ -0,0 +1,145 @@
+# debug-log
+
+[![NPM](https://img.shields.io/npm/v/debug-log.svg?label=debug-log)](https://www.npmjs.com/package/debug-log) [![Downloads/week](https://img.shields.io/npm/dw/debug-log.svg)](https://npmjs.org/package/debug-log) [![License](https://img.shields.io/badge/License-BSD%203--Clause-brightgreen.svg)](https://raw.githubusercontent.com/salesforcecli/debug-log/main/LICENSE.txt)
+
+## Using the template
+
+This repository provides a template for creating a plugin for the Salesforce CLI. To convert this template to a working plugin:
+
+1. Please get in touch with the Platform CLI team. We want to help you develop your plugin.
+2. Generate your plugin:
+
+   ```
+   sf plugins install dev
+   sf dev generate plugin
+
+   git init -b main
+   git add . && git commit -m "chore: initial commit"
+   ```
+
+3. Create your plugin's repo in the salesforcecli github org
+4. When you're ready, replace the contents of this README with the information you want.
+
+## Learn about `sf` plugins
+
+Salesforce CLI plugins are based on the [oclif plugin framework](<(https://oclif.io/docs/introduction.html)>). Read the [plugin developer guide](https://developer.salesforce.com/docs/atlas.en-us.sfdx_cli_plugins.meta/sfdx_cli_plugins/cli_plugins_architecture_sf_cli.htm) to learn about Salesforce CLI plugin development.
+
+This repository contains a lot of additional scripts and tools to help with general Salesforce node development and enforce coding standards. You should familiarize yourself with some of the [node developer packages](#tooling) used by Salesforce.
+
+Additionally, there are some additional tests that the Salesforce CLI will enforce if this plugin is ever bundled with the CLI. These test are included by default under the `posttest` script and it is required to keep these tests active in your plugin if you plan to have it bundled.
+
+### Tooling
+
+- [@salesforce/core](https://github.com/forcedotcom/sfdx-core)
+- [@salesforce/kit](https://github.com/forcedotcom/kit)
+- [@salesforce/sf-plugins-core](https://github.com/salesforcecli/sf-plugins-core)
+- [@salesforce/ts-types](https://github.com/forcedotcom/ts-types)
+- [@salesforce/ts-sinon](https://github.com/forcedotcom/ts-sinon)
+- [@salesforce/dev-config](https://github.com/forcedotcom/dev-config)
+- [@salesforce/dev-scripts](https://github.com/forcedotcom/dev-scripts)
+
+### Hooks
+
+For cross clouds commands, e.g. `sf env list`, we utilize [oclif hooks](https://oclif.io/docs/hooks) to get the relevant information from installed plugins.
+
+This plugin includes sample hooks in the [src/hooks directory](src/hooks). You'll just need to add the appropriate logic. You can also delete any of the hooks if they aren't required for your plugin.
+
+# Everything past here is only a suggestion as to what should be in your specific plugin's description
+
+This plugin is bundled with the [Salesforce CLI](https://developer.salesforce.com/tools/sfdxcli). For more information on the CLI, read the [getting started guide](https://developer.salesforce.com/docs/atlas.en-us.sfdx_setup.meta/sfdx_setup/sfdx_setup_intro.htm).
+
+We always recommend using the latest version of these commands bundled with the CLI, however, you can install a specific version or tag if needed.
+
+## Install
+
+```bash
+sf plugins install debug-log@x.y.z
+```
+
+## Issues
+
+Please report any issues at https://github.com/forcedotcom/cli/issues
+
+## Contributing
+
+1. Please read our [Code of Conduct](CODE_OF_CONDUCT.md)
+2. Create a new issue before starting your project so that we can keep track of
+   what you are trying to add/fix. That way, we can also offer suggestions or
+   let you know if there is already an effort in progress.
+3. Fork this repository.
+4. [Build the plugin locally](#build)
+5. Create a _topic_ branch in your fork. Note, this step is recommended but technically not required if contributing using a fork.
+6. Edit the code in your fork.
+7. Write appropriate tests for your changes. Try to achieve at least 95% code coverage on any new code. No pull request will be accepted without unit tests.
+8. Sign CLA (see [CLA](#cla) below).
+9. Send us a pull request when you are done. We'll review your code, suggest any needed changes, and merge it in.
+
+### CLA
+
+External contributors will be required to sign a Contributor's License
+Agreement. You can do so by going to https://cla.salesforce.com/sign-cla.
+
+### Build
+
+To build the plugin locally, make sure to have yarn installed and run the following commands:
+
+```bash
+# Clone the repository
+git clone git@github.com:salesforcecli/debug-log
+
+# Install the dependencies and compile
+yarn && yarn build
+```
+
+To use your plugin, run using the local `./bin/dev` or `./bin/dev.cmd` file.
+
+```bash
+# Run using local run file.
+./bin/dev hello world
+```
+
+There should be no differences when running via the Salesforce CLI or using the local run file. However, it can be useful to link the plugin to do some additional testing or run your commands from anywhere on your machine.
+
+```bash
+# Link your plugin to the sf cli
+sf plugins link .
+# To verify
+sf plugins
+```
+
+## Commands
+
+<!-- commands -->
+
+- [`sf hello world`](#sf-hello-world)
+
+## `sf hello world`
+
+Say hello either to the world or someone you know.
+
+```
+USAGE
+  $ sf hello world [--json] [-n <value>]
+
+FLAGS
+  -n, --name=<value>  [default: World] The name of the person you'd like to say hello to.
+
+GLOBAL FLAGS
+  --json  Format output as json.
+
+DESCRIPTION
+  Say hello either to the world or someone you know.
+
+  Say hello either to the world or someone you know.
+
+EXAMPLES
+  Say hello to the world:
+
+    $ sf hello world
+
+  Say hello to someone you know:
+
+    $ sf hello world --name Astro
+```
+
+<!-- commandsstop -->

package/lib/commands/retrieve.d.ts

@@ -0,0 +1,17 @@
+import { SfCommand } from '@salesforce/sf-plugins-core';
+export type RetrieveResult = {
+    isSuccess: boolean;
+    error?: string;
+};
+export default class Retrieve extends SfCommand<RetrieveResult> {
+    static readonly summary: string;
+    static readonly description: string;
+    static readonly examples: string[];
+    static readonly flags: {
+        targetusername: import("@oclif/core/lib/interfaces").OptionFlag<import("@salesforce/core").Org, import("@oclif/core/lib/interfaces/parser").CustomOptions>;
+        user: import("@oclif/core/lib/interfaces").OptionFlag<string | undefined, import("@oclif/core/lib/interfaces/parser").CustomOptions>;
+        time: import("@oclif/core/lib/interfaces").OptionFlag<number, import("@oclif/core/lib/interfaces/parser").CustomOptions>;
+        folder: import("@oclif/core/lib/interfaces").OptionFlag<string, import("@oclif/core/lib/interfaces/parser").CustomOptions>;
+    };
+    run(): Promise<RetrieveResult>;
+}

package/lib/commands/retrieve.js

@@ -0,0 +1,101 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+/* eslint-disable @typescript-eslint/no-unsafe-assignment */
+const sf_plugins_core_1 = require("@salesforce/sf-plugins-core");
+const core_1 = require("@salesforce/core");
+const sanitize_filename_1 = __importDefault(require("sanitize-filename"));
+const utils_1 = require("../utils");
+core_1.Messages.importMessagesDirectory(__dirname);
+const messages = core_1.Messages.loadMessages('sf-debug-log', 'retrieve');
+class Retrieve extends sf_plugins_core_1.SfCommand {
+    async run() {
+        const { flags } = await this.parse(Retrieve);
+        const conn = flags.targetusername.getConnection();
+        let result;
+        try {
+            this.spinner.start('Retriving debug logs...');
+            const user = flags.user ? flags.user : conn.getUsername();
+            const userId = await (0, utils_1.getUserId)(conn, user);
+            const logs = await getLogs(conn, userId, flags.time);
+            await saveLogs(conn, logs, flags.folder);
+            this.spinner.stop();
+            return { isSuccess: true };
+        }
+        catch (err) {
+            result = {
+                isSuccess: false,
+                error: err instanceof Error ? err.message : String(err),
+            };
+            throw messages.createError('error.saveLogs', [result.error]);
+        }
+    }
+}
+Retrieve.summary = messages.getMessage('summary');
+Retrieve.description = messages.getMessage('description');
+Retrieve.examples = messages.getMessages('examples');
+Retrieve.flags = {
+    targetusername: sf_plugins_core_1.Flags.requiredOrg({
+        summary: messages.getMessage('flags.targetusername.summary'),
+        char: 'o',
+        required: true,
+    }),
+    user: sf_plugins_core_1.Flags.string({
+        summary: messages.getMessage('flags.user.summary'),
+        char: 'u',
+    }),
+    time: sf_plugins_core_1.Flags.integer({
+        summary: messages.getMessage('flags.time.summary'),
+        char: 't',
+        default: 60,
+    }),
+    folder: sf_plugins_core_1.Flags.directory({
+        summary: messages.getMessage('flags.folder.summary'),
+        char: 'd',
+        default: 'tools/debug/logs',
+    }),
+};
+exports.default = Retrieve;
+async function getLogs(conn, userId, time) {
+    const dateTime = new Date(Date.now());
+    dateTime.setMinutes(dateTime.getMinutes() - time);
+    const startTime = dateTime.toISOString();
+    const queryResult = await conn.query(`SELECT Id, LogUser.Name, LogLength, Request, Operation,
+                                Application, Status, DurationMilliseconds,
+                                SystemModstamp, RequestIdentifier
+                                FROM ApexLog
+                                WHERE SystemModstamp > ${startTime}
+                                AND LogUserId = '${userId}'
+                                ORDER BY SystemModstamp DESC`);
+    if (queryResult.records.length === 0) {
+        throw new Error('No debug logs found');
+    }
+    return queryResult.records;
+}
+async function saveLogs(conn, logs, directory) {
+    // Use Promise.all to parallelize the download and save operations
+    await Promise.all(logs.map(async (log) => {
+        const url = `${conn.instanceUrl}/apexdebug/traceDownload.apexp?id=${log.Id}`;
+        // eslint-disable-next-line @typescript-eslint/no-unsafe-argument
+        const date = new Date(log.SystemModstamp);
+        const hours = date.getHours();
+        const minutes = date.getMinutes();
+        const seconds = date.getSeconds();
+        // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access, @typescript-eslint/restrict-template-expressions
+        const fileName = `(${hours}-${minutes}-${seconds}) ${log.DurationMilliseconds}ms ${log.Request} ${log.Operation} ${log.Status}.log`;
+        // eslint-disable-next-line @typescript-eslint/no-unsafe-call
+        const sanitizedFileName = (0, sanitize_filename_1.default)(fileName);
+        // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access, @typescript-eslint/restrict-template-expressions
+        const filePath = `${directory}/${log.LogUser.Name}/${sanitizedFileName}`;
+        try {
+            const body = await conn.request(url);
+            await (0, utils_1.createFile)(filePath, body);
+        }
+        catch (err) {
+            throw new Error('Error saving debug logs');
+        }
+    }));
+}
+//# sourceMappingURL=retrieve.js.map

package/lib/commands/retrieve.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"retrieve.js","sourceRoot":"","sources":["../../src/commands/retrieve.ts"],"names":[],"mappings":";;;;;AAAA,4DAA4D;AAC5D,iEAA+D;AAC/D,2CAAwD;AAExD,0EAAyC;AACzC,oCAAiD;AAEjD,eAAQ,CAAC,uBAAuB,CAAC,SAAS,CAAC,CAAC;AAC5C,MAAM,QAAQ,GAAG,eAAQ,CAAC,YAAY,CAAC,cAAc,EAAE,UAAU,CAAC,CAAC;AAOnE,MAAqB,QAAS,SAAQ,2BAAyB;IA2BtD,KAAK,CAAC,GAAG;QACd,MAAM,EAAE,KAAK,EAAE,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;QAC7C,MAAM,IAAI,GAAe,KAAK,CAAC,cAAc,CAAC,aAAa,EAAE,CAAC;QAC9D,IAAI,MAAsB,CAAC;QAC3B,IAAI;YACF,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,yBAAyB,CAAC,CAAC;YAC9C,MAAM,IAAI,GAAG,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAE,IAAI,CAAC,WAAW,EAAa,CAAC;YACtE,MAAM,MAAM,GAAG,MAAM,IAAA,iBAAS,EAAC,IAAI,EAAE,IAAI,CAAC,CAAC;YAC3C,MAAM,IAAI,GAAG,MAAM,OAAO,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,CAAC,IAAI,CAAC,CAAC;YACrD,MAAM,QAAQ,CAAC,IAAI,EAAE,IAAI,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;YACzC,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,CAAC;YACpB,OAAO,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC;SAC5B;QAAC,OAAO,GAAG,EAAE;YACZ,MAAM,GAAG;gBACP,SAAS,EAAE,KAAK;gBAChB,KAAK,EAAE,GAAG,YAAY,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC;aACxD,CAAC;YACF,MAAM,QAAQ,CAAC,WAAW,CAAC,gBAAgB,EAAE,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC;SAC9D;IACH,CAAC;;AA7CsB,gBAAO,GAAG,QAAQ,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC;AACzC,oBAAW,GAAG,QAAQ,CAAC,UAAU,CAAC,aAAa,CAAC,CAAC;AACjD,iBAAQ,GAAG,QAAQ,CAAC,WAAW,CAAC,UAAU,CAAC,CAAC;AAE5C,cAAK,GAAG;IAC7B,cAAc,EAAE,uBAAK,CAAC,WAAW,CAAC;QAChC,OAAO,EAAE,QAAQ,CAAC,UAAU,CAAC,8BAA8B,CAAC;QAC5D,IAAI,EAAE,GAAG;QACT,QAAQ,EAAE,IAAI;KACf,CAAC;IACF,IAAI,EAAE,uBAAK,CAAC,MAAM,CAAC;QACjB,OAAO,EAAE,QAAQ,CAAC,UAAU,CAAC,oBAAoB,CAAC;QAClD,IAAI,EAAE,GAAG;KACV,CAAC;IACF,IAAI,EAAE,uBAAK,CAAC,OAAO,CAAC;QAClB,OAAO,EAAE,QAAQ,CAAC,UAAU,CAAC,oBAAoB,CAAC;QAClD,IAAI,EAAE,GAAG;QACT,OAAO,EAAE,EAAE;KACZ,CAAC;IACF,MAAM,EAAE,uBAAK,CAAC,SAAS,CAAC;QACtB,OAAO,EAAE,QAAQ,CAAC,UAAU,CAAC,sBAAsB,CAAC;QACpD,IAAI,EAAE,GAAG;QACT,OAAO,EAAE,kBAAkB;KAC5B,CAAC;CACH,CAAC;kBAzBiB,QAAQ;AAiD7B,KAAK,UAAU,OAAO,CAAC,IAAgB,EAAE,MAAc,EAAE,IAAY;IACnE,MAAM,QAAQ,GAAG,IAAI,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC,CAAC;IACtC,QAAQ,CAAC,UAAU,CAAC,QAAQ,CAAC,UAAU,EAAE,GAAG,IAAI,CAAC,CAAC;IAElD,MAAM,SAAS,GAAG,QAAQ,CAAC,WAAW,EAAE,CAAC;IACzC,MAAM,WAAW,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC;;;;yDAIkB,SAAS;mDACf,MAAM;6DACI,CAAC,CAAC;IAE7D,IAAI,WAAW,CAAC,OAAO,CAAC,MAAM,KAAK,CAAC,EAAE;QACpC,MAAM,IAAI,KAAK,CAAC,qBAAqB,CAAC,CAAC;KACxC;IAED,OAAO,WAAW,CAAC,OAAO,CAAC;AAC7B,CAAC;AAED,KAAK,UAAU,QAAQ,CAAC,IAAgB,EAAE,IAAc,EAAE,SAAiB;IACzE,kEAAkE;IAClE,MAAM,OAAO,CAAC,GAAG,CACf,IAAI,CAAC,GAAG,CAAC,KAAK,EAAE,GAAG,EAAE,EAAE;QACrB,MAAM,GAAG,GAAG,GAAG,IAAI,CAAC,WAAW,qCAAqC,GAAG,CAAC,EAAE,EAAE,CAAC;QAC7E,iEAAiE;QACjE,MAAM,IAAI,GAAG,IAAI,IAAI,CAAC,GAAG,CAAC,cAAc,CAAC,CAAC;QAC1C,MAAM,KAAK,GAAG,IAAI,CAAC,QAAQ,EAAE,CAAC;QAC9B,MAAM,OAAO,GAAG,IAAI,CAAC,UAAU,EAAE,CAAC;QAClC,MAAM,OAAO,GAAG,IAAI,CAAC,UAAU,EAAE,CAAC;QAClC,wHAAwH;QACxH,MAAM,QAAQ,GAAG,IAAI,KAAK,IAAI,OAAO,IAAI,OAAO,KAAK,GAAG,CAAC,oBAAoB,MAAM,GAAG,CAAC,OAAO,IAAI,GAAG,CAAC,SAAS,IAAI,GAAG,CAAC,MAAM,MAAM,CAAC;QACpI,6DAA6D;QAC7D,MAAM,iBAAiB,GAAG,IAAA,2BAAQ,EAAC,QAAQ,CAAC,CAAC;QAC7C,wHAAwH;QACxH,MAAM,QAAQ,GAAG,GAAG,SAAS,IAAI,GAAG,CAAC,OAAO,CAAC,IAAI,IAAI,iBAAiB,EAAE,CAAC;QACzE,IAAI;YACF,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;YACrC,MAAM,IAAA,kBAAU,EAAC,QAAQ,EAAE,IAAc,CAAC,CAAC;SAC5C;QAAC,OAAO,GAAG,EAAE;YACZ,MAAM,IAAI,KAAK,CAAC,yBAAyB,CAAC,CAAC;SAC5C;IACH,CAAC,CAAC,CACH,CAAC;AACJ,CAAC"}

package/lib/commands/trace/new.d.ts

@@ -0,0 +1,16 @@
+import { SfCommand } from '@salesforce/sf-plugins-core';
+export type TraceNewResult = {
+    isSuccess: boolean;
+    error?: string;
+};
+export default class TraceNew extends SfCommand<TraceNewResult> {
+    static readonly summary: string;
+    static readonly examples: string[];
+    static readonly flags: {
+        targetusername: import("@oclif/core/lib/interfaces").OptionFlag<import("@salesforce/core").Org, import("@oclif/core/lib/interfaces/parser").CustomOptions>;
+        user: import("@oclif/core/lib/interfaces").OptionFlag<string | undefined, import("@oclif/core/lib/interfaces/parser").CustomOptions>;
+        time: import("@oclif/core/lib/interfaces").OptionFlag<number, import("@oclif/core/lib/interfaces/parser").CustomOptions>;
+    };
+    run(): Promise<TraceNewResult>;
+    private selectDebugLevel;
+}

package/lib/commands/trace/new.js

@@ -0,0 +1,95 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const sf_plugins_core_1 = require("@salesforce/sf-plugins-core");
+const core_1 = require("@salesforce/core");
+const utils_1 = require("../../utils");
+const MILLISECONDS_PER_MINUTE = 60000;
+core_1.Messages.importMessagesDirectory(__dirname);
+const messages = core_1.Messages.loadMessages('sf-debug-log', 'trace.new');
+class TraceNew extends sf_plugins_core_1.SfCommand {
+    async run() {
+        const { flags } = await this.parse(TraceNew);
+        const conn = flags.targetusername.getConnection();
+        let result;
+        try {
+            this.spinner.start('Retriving debug levels...');
+            const user = flags.user ? flags.user : conn.getUsername();
+            const [userId, debugLevels] = await Promise.all([(0, utils_1.getUserId)(conn, user), getDebugLevels(conn)]);
+            this.spinner.stop();
+            const debuglevel = await this.selectDebugLevel(debugLevels);
+            this.spinner.start('Creating Trace Flag...');
+            result = await createTraceFlag(conn, userId, debuglevel, flags.time);
+            this.spinner.stop();
+        }
+        catch (err) {
+            result = {
+                isSuccess: false,
+                error: err instanceof Error ? err.message : String(err),
+            };
+        }
+        if (!result.isSuccess) {
+            throw messages.createError('error.createTraceFlag', [result.error]);
+        }
+        else {
+            this.log(`User Trace Flag successfully created for ${flags.user}`);
+        }
+        return result;
+    }
+    async selectDebugLevel(debugLevels) {
+        const debuglevel = await this.prompt({
+            type: 'list',
+            name: 'debugLevel',
+            message: 'Select Debug Level',
+            choices: debugLevels.map((debugLevel) => ({
+                loop: false,
+                // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment, @typescript-eslint/restrict-template-expressions
+                name: `${debugLevel.DeveloperName}    	(DB:${debugLevel.Database}   Callout:${debugLevel.Callout}   ApexCode:${debugLevel.ApexCode}   Validation:${debugLevel.Validation}  Workflow:${debugLevel.Workflow}    Profiling:${debugLevel.ApexProfiling}  Visualforce:${debugLevel.Visualforce}  System:${debugLevel.System}  Wave:${debugLevel.Wave}  Nba:${debugLevel.Nba})`,
+                value: debugLevel.Id,
+                // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
+                short: debugLevel.DeveloperName,
+            })),
+        });
+        return debuglevel.debugLevel;
+    }
+}
+TraceNew.summary = messages.getMessage('summary');
+TraceNew.examples = messages.getMessages('examples');
+TraceNew.flags = {
+    targetusername: sf_plugins_core_1.Flags.requiredOrg({
+        summary: messages.getMessage('flags.targetusername.summary'),
+        char: 'o',
+        required: true,
+    }),
+    user: sf_plugins_core_1.Flags.string({
+        summary: messages.getMessage('flags.user.summary'),
+        char: 'u',
+    }),
+    time: sf_plugins_core_1.Flags.integer({
+        summary: messages.getMessage('flags.time.summary'),
+        default: 60,
+    }),
+};
+exports.default = TraceNew;
+async function getDebugLevels(conn) {
+    const results = await conn.tooling.query('SELECT Id, DeveloperName, Workflow, Validation, Callout, ApexCode, ApexProfiling, Visualforce, System, Database, Wave, Nba FROM DebugLevel');
+    if (results?.records) {
+        return results.records;
+    }
+    else {
+        throw new Error('Error to retrieve Debug Levels');
+    }
+}
+async function createTraceFlag(conn, userId, debugLevelId, time) {
+    const result = await conn.tooling.sobject('TraceFlag').create({
+        TracedEntityId: userId,
+        DebugLevelId: debugLevelId,
+        StartDate: new Date(Date.now()).toISOString(),
+        logtype: 'USER_DEBUG',
+        ExpirationDate: new Date(Date.now() + time * MILLISECONDS_PER_MINUTE).toISOString(),
+    });
+    return {
+        isSuccess: result.success,
+        error: result.success ? undefined : result.errors[0].message,
+    };
+}
+//# sourceMappingURL=new.js.map

package/lib/commands/trace/new.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"new.js","sourceRoot":"","sources":["../../../src/commands/trace/new.ts"],"names":[],"mappings":";;AAAA,iEAA+D;AAC/D,2CAAwD;AAExD,uCAAwC;AAExC,MAAM,uBAAuB,GAAG,KAAK,CAAC;AAEtC,eAAQ,CAAC,uBAAuB,CAAC,SAAS,CAAC,CAAC;AAC5C,MAAM,QAAQ,GAAG,eAAQ,CAAC,YAAY,CAAC,cAAc,EAAE,WAAW,CAAC,CAAC;AAOpE,MAAqB,QAAS,SAAQ,2BAAyB;IAoBtD,KAAK,CAAC,GAAG;QACd,MAAM,EAAE,KAAK,EAAE,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;QAC7C,MAAM,IAAI,GAAe,KAAK,CAAC,cAAc,CAAC,aAAa,EAAE,CAAC;QAC9D,IAAI,MAAsB,CAAC;QAE3B,IAAI;YACF,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,2BAA2B,CAAC,CAAC;YAChD,MAAM,IAAI,GAAG,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAE,IAAI,CAAC,WAAW,EAAa,CAAC;YACtE,MAAM,CAAC,MAAM,EAAE,WAAW,CAAC,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC,CAAC,IAAA,iBAAS,EAAC,IAAI,EAAE,IAAI,CAAC,EAAE,cAAc,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;YAC/F,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,CAAC;YACpB,MAAM,UAAU,GAAG,MAAM,IAAI,CAAC,gBAAgB,CAAC,WAAW,CAAC,CAAC;YAC5D,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,wBAAwB,CAAC,CAAC;YAC7C,MAAM,GAAG,MAAM,eAAe,CAAC,IAAI,EAAE,MAAM,EAAE,UAAU,EAAE,KAAK,CAAC,IAAI,CAAC,CAAC;YACrE,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,CAAC;SACrB;QAAC,OAAO,GAAG,EAAE;YACZ,MAAM,GAAG;gBACP,SAAS,EAAE,KAAK;gBAChB,KAAK,EAAE,GAAG,YAAY,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC;aACxD,CAAC;SACH;QACD,IAAI,CAAC,MAAM,CAAC,SAAS,EAAE;YACrB,MAAM,QAAQ,CAAC,WAAW,CAAC,uBAAuB,EAAE,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC;SACrE;aAAM;YACL,IAAI,CAAC,GAAG,CAAC,4CAA4C,KAAK,CAAC,IAAI,EAAE,CAAC,CAAC;SACpE;QACD,OAAO,MAAM,CAAC;IAChB,CAAC;IAEO,KAAK,CAAC,gBAAgB,CAAC,WAAqB;QAClD,MAAM,UAAU,GAAG,MAAM,IAAI,CAAC,MAAM,CAAyB;YAC3D,IAAI,EAAE,MAAM;YACZ,IAAI,EAAE,YAAY;YAClB,OAAO,EAAE,oBAAoB;YAC7B,OAAO,EAAE,WAAW,CAAC,GAAG,CAAC,CAAC,UAAU,EAAE,EAAE,CAAC,CAAC;gBACxC,IAAI,EAAE,KAAK;gBACX,qHAAqH;gBACrH,IAAI,EAAE,GAAG,UAAU,CAAC,aAAa,YAAY,UAAU,CAAC,QAAQ,cAAc,UAAU,CAAC,OAAO,eAAe,UAAU,CAAC,QAAQ,iBAAiB,UAAU,CAAC,UAAU,cAAc,UAAU,CAAC,QAAQ,iBAAiB,UAAU,CAAC,aAAa,iBAAiB,UAAU,CAAC,WAAW,YAAY,UAAU,CAAC,MAAM,UAAU,UAAU,CAAC,IAAI,SAAS,UAAU,CAAC,GAAG,GAAG;gBACzW,KAAK,EAAE,UAAU,CAAC,EAAE;gBACpB,mEAAmE;gBACnE,KAAK,EAAE,UAAU,CAAC,aAAa;aAChC,CAAC,CAAC;SACJ,CAAC,CAAC;QAEH,OAAO,UAAU,CAAC,UAAU,CAAC;IAC/B,CAAC;;AA/DsB,gBAAO,GAAG,QAAQ,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC;AACzC,iBAAQ,GAAG,QAAQ,CAAC,WAAW,CAAC,UAAU,CAAC,CAAC;AAE5C,cAAK,GAAG;IAC7B,cAAc,EAAE,uBAAK,CAAC,WAAW,CAAC;QAChC,OAAO,EAAE,QAAQ,CAAC,UAAU,CAAC,8BAA8B,CAAC;QAC5D,IAAI,EAAE,GAAG;QACT,QAAQ,EAAE,IAAI;KACf,CAAC;IACF,IAAI,EAAE,uBAAK,CAAC,MAAM,CAAC;QACjB,OAAO,EAAE,QAAQ,CAAC,UAAU,CAAC,oBAAoB,CAAC;QAClD,IAAI,EAAE,GAAG;KACV,CAAC;IACF,IAAI,EAAE,uBAAK,CAAC,OAAO,CAAC;QAClB,OAAO,EAAE,QAAQ,CAAC,UAAU,CAAC,oBAAoB,CAAC;QAClD,OAAO,EAAE,EAAE;KACZ,CAAC;CACH,CAAC;kBAlBiB,QAAQ;AAmE7B,KAAK,UAAU,cAAc,CAAC,IAAgB;IAC5C,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,KAAK,CACtC,4IAA4I,CAC7I,CAAC;IACF,IAAI,OAAO,EAAE,OAAO,EAAE;QACpB,OAAO,OAAO,CAAC,OAAO,CAAC;KACxB;SAAM;QACL,MAAM,IAAI,KAAK,CAAC,gCAAgC,CAAC,CAAC;KACnD;AACH,CAAC;AAED,KAAK,UAAU,eAAe,CAC5B,IAAgB,EAChB,MAAc,EACd,YAAoB,EACpB,IAAY;IAEZ,MAAM,MAAM,GAAe,MAAM,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC,MAAM,CAAC;QACxE,cAAc,EAAE,MAAM;QACtB,YAAY,EAAE,YAAY;QAC1B,SAAS,EAAE,IAAI,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC,CAAC,WAAW,EAAE;QAC7C,OAAO,EAAE,YAAY;QACrB,cAAc,EAAE,IAAI,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE,GAAG,IAAI,GAAG,uBAAuB,CAAC,CAAC,WAAW,EAAE;KACpF,CAAC,CAAC;IACH,OAAO;QACL,SAAS,EAAE,MAAM,CAAC,OAAO;QACzB,KAAK,EAAE,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,OAAO;KAC7D,CAAC;AACJ,CAAC"}

package/lib/index.d.ts

@@ -0,0 +1,2 @@
+declare const _default: {};
+export = _default;

package/lib/index.js

@@ -0,0 +1,3 @@
+"use strict";
+module.exports = {};
+//# sourceMappingURL=index.js.map

package/lib/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AAAA,iBAAS,EAAE,CAAC"}

package/lib/utils.d.ts

@@ -0,0 +1,3 @@
+import { Connection } from '@salesforce/core';
+export declare function createFile(path: string, contents: string): Promise<void>;
+export declare function getUserId(connection: Connection, inputUser: string): Promise<string>;

package/lib/utils.js

@@ -0,0 +1,41 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getUserId = exports.createFile = void 0;
+const path_1 = require("path");
+const util_1 = require("util");
+const fs_1 = require("fs");
+const mkdirPromise = (0, util_1.promisify)(fs_1.mkdir);
+const writeFilePromise = (0, util_1.promisify)(fs_1.writeFile);
+async function createFile(path, contents) {
+    await mkdirPromise((0, path_1.dirname)(path), { recursive: true });
+    await writeFilePromise(path, contents);
+}
+exports.createFile = createFile;
+async function getUserId(connection, inputUser) {
+    let result;
+    if (isValidEmail(inputUser)) {
+        result = await connection.tooling.sobject('User').findOne({ Username: inputUser });
+    }
+    else if (isId(inputUser)) {
+        result = await connection.tooling.sobject('User').findOne({ Id: inputUser });
+    }
+    else {
+        result = await connection.tooling.sobject('User').findOne({ Name: inputUser });
+    }
+    if (result?.Id) {
+        return result.Id;
+    }
+    else {
+        throw new Error(`User ${inputUser} not found`);
+    }
+}
+exports.getUserId = getUserId;
+function isValidEmail(input) {
+    const emailRegex = /^[^\s@]+@[^\s@]+\.[^\s@]+$/;
+    return emailRegex.test(input);
+}
+function isId(input) {
+    const idRegex = /[a-zA-Z0-9]{15}|[a-zA-Z0-9]{18}/;
+    return idRegex.test(input);
+}
+//# sourceMappingURL=utils.js.map

package/lib/utils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.js","sourceRoot":"","sources":["../src/utils.ts"],"names":[],"mappings":";;;AAAA,+BAA+B;AAC/B,+BAAiC;AACjC,2BAAsC;AAGtC,MAAM,YAAY,GAAG,IAAA,gBAAS,EAAC,UAAK,CAAC,CAAC;AACtC,MAAM,gBAAgB,GAAG,IAAA,gBAAS,EAAC,cAAS,CAAC,CAAC;AAEvC,KAAK,UAAU,UAAU,CAAC,IAAY,EAAE,QAAgB;IAC7D,MAAM,YAAY,CAAC,IAAA,cAAO,EAAC,IAAI,CAAC,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;IACvD,MAAM,gBAAgB,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;AACzC,CAAC;AAHD,gCAGC;AAEM,KAAK,UAAU,SAAS,CAAC,UAAsB,EAAE,SAAiB;IACvE,IAAI,MAAM,CAAC;IACX,IAAI,YAAY,CAAC,SAAS,CAAC,EAAE;QAC3B,MAAM,GAAG,MAAM,UAAU,CAAC,OAAO,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,EAAE,QAAQ,EAAE,SAAS,EAAE,CAAC,CAAC;KACpF;SAAM,IAAI,IAAI,CAAC,SAAS,CAAC,EAAE;QAC1B,MAAM,GAAG,MAAM,UAAU,CAAC,OAAO,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,EAAE,EAAE,EAAE,SAAS,EAAE,CAAC,CAAC;KAC9E;SAAM;QACL,MAAM,GAAG,MAAM,UAAU,CAAC,OAAO,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,EAAE,IAAI,EAAE,SAAS,EAAE,CAAC,CAAC;KAChF;IACD,IAAI,MAAM,EAAE,EAAE,EAAE;QACd,OAAO,MAAM,CAAC,EAAE,CAAC;KAClB;SAAM;QACL,MAAM,IAAI,KAAK,CAAC,QAAQ,SAAS,YAAY,CAAC,CAAC;KAChD;AACH,CAAC;AAdD,8BAcC;AAED,SAAS,YAAY,CAAC,KAAa;IACjC,MAAM,UAAU,GAAG,4BAA4B,CAAC;IAChD,OAAO,UAAU,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;AAChC,CAAC;AAED,SAAS,IAAI,CAAC,KAAa;IACzB,MAAM,OAAO,GAAG,iCAAiC,CAAC;IAClD,OAAO,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;AAC7B,CAAC"}

package/messages/retrieve.md

@@ -0,0 +1,31 @@
+# summary
+
+Retrieve apex log files.
+
+# description
+
+Retrieves apex log files from the Salesforce platform.
+
+# flags.user.summary
+
+Username or alias to retrieve logs for.
+
+# flags.targetusername.summary
+
+Username or alias to retrieve logs for.
+
+# flags.time.summary
+
+Start time for the logs to retrieve.
+
+# flags.folder.summary
+
+Folder where the logs are stored.
+
+# error.saveLogs
+
+Failed to save logs: %s.
+
+# examples
+
+- <%= config.bin %> <%= command.id %>

package/messages/trace.new.md

@@ -0,0 +1,23 @@
+# summary
+
+Create a trace flag for a user.
+
+# flags.targetusername.summary
+
+A username or alias for the target org.
+
+# flags.user.summary
+
+The username of the user to create the trace flag for.
+
+# flags.time.summary
+
+The time for the trace flag.
+
+# error.createTraceFlag
+
+Create User Trace Flag failed: %s.
+
+# examples
+
+example

package/oclif.manifest.json

@@ -0,0 +1,105 @@
+{
+  "version": "0.0.2",
+  "commands": {
+    "retrieve": {
+      "id": "retrieve",
+      "summary": "Retrieve apex log files.",
+      "description": "Retrieves apex log files from the Salesforce platform.",
+      "strict": true,
+      "pluginName": "sf-debug-log",
+      "pluginAlias": "sf-debug-log",
+      "pluginType": "core",
+      "aliases": [],
+      "examples": [
+        "<%= config.bin %> <%= command.id %>"
+      ],
+      "flags": {
+        "json": {
+          "name": "json",
+          "type": "boolean",
+          "description": "Format output as json.",
+          "helpGroup": "GLOBAL",
+          "allowNo": false
+        },
+        "targetusername": {
+          "name": "targetusername",
+          "type": "option",
+          "char": "o",
+          "summary": "Username or alias to retrieve logs for.",
+          "required": true,
+          "multiple": false
+        },
+        "user": {
+          "name": "user",
+          "type": "option",
+          "char": "u",
+          "summary": "Username or alias to retrieve logs for.",
+          "multiple": false
+        },
+        "time": {
+          "name": "time",
+          "type": "option",
+          "char": "t",
+          "summary": "Start time for the logs to retrieve.",
+          "multiple": false,
+          "default": 60
+        },
+        "folder": {
+          "name": "folder",
+          "type": "option",
+          "char": "d",
+          "summary": "Folder where the logs are stored.",
+          "multiple": false,
+          "default": "tools/debug/logs"
+        }
+      },
+      "args": {},
+      "hasDynamicHelp": true
+    },
+    "trace:new": {
+      "id": "trace:new",
+      "summary": "Create a trace flag for a user.",
+      "strict": true,
+      "pluginName": "sf-debug-log",
+      "pluginAlias": "sf-debug-log",
+      "pluginType": "core",
+      "aliases": [],
+      "examples": [
+        "example"
+      ],
+      "flags": {
+        "json": {
+          "name": "json",
+          "type": "boolean",
+          "description": "Format output as json.",
+          "helpGroup": "GLOBAL",
+          "allowNo": false
+        },
+        "targetusername": {
+          "name": "targetusername",
+          "type": "option",
+          "char": "o",
+          "summary": "A username or alias for the target org.",
+          "required": true,
+          "multiple": false
+        },
+        "user": {
+          "name": "user",
+          "type": "option",
+          "char": "u",
+          "summary": "The username of the user to create the trace flag for.",
+          "multiple": false
+        },
+        "time": {
+          "name": "time",
+          "type": "option",
+          "summary": "The time for the trace flag.",
+          "multiple": false,
+          "default": 60
+        }
+      },
+      "args": {},
+      "hasDynamicHelp": true
+    }
+  }
+}

package/package.json

@@ -0,0 +1,198 @@
+{
+  "name": "sf-debug-log",
+  "description": "Manage Salesforce Debug Logs",
+  "version": "0.0.2",
+  "dependencies": {
+    "@oclif/core": "^2.11.8",
+    "@salesforce/core": "^5.2.0",
+    "@salesforce/kit": "^3.0.8",
+    "@salesforce/sf-plugins-core": "^3.1.14",
+    "sanitize-filename": "^1.6.3",
+    "tslib": "^2"
+  },
+  "devDependencies": {
+    "@salesforce/cli-plugins-testkit": "^4.3.0",
+    "@salesforce/dev-config": "^4.0.1",
+    "@salesforce/dev-scripts": "^5.7.0",
+    "@salesforce/prettier-config": "^0.0.3",
+    "@salesforce/ts-sinon": "^1.4.14",
+    "@swc/core": "^1.3.19",
+    "@types/inquirer": "^9.0.3",
+    "@typescript-eslint/eslint-plugin": "^5.59.8",
+    "@typescript-eslint/parser": "^5.62.0",
+    "chai": "^4.3.6",
+    "eslint": "^8.47.0",
+    "eslint-config-prettier": "^8.5.0",
+    "eslint-config-salesforce": "^2.0.2",
+    "eslint-config-salesforce-typescript": "^1.1.2",
+    "eslint-plugin-import": "2.28.1",
+    "eslint-plugin-jsdoc": "^46.4.6",
+    "eslint-plugin-sf-plugin": "^1.16.2",
+    "husky": "^7.0.4",
+    "mocha": "^9.2.2",
+    "nyc": "^15.1.0",
+    "oclif": "^3.9.1",
+    "prettier": "^2.8.8",
+    "pretty-quick": "^3.1.3",
+    "shx": "0.3.4",
+    "sinon": "10.0.0",
+    "ts-node": "^10.9.1",
+    "typescript": "^5.1.6",
+    "wireit": "^0.10.0"
+  },
+  "engines": {
+    "node": ">=16.0.0"
+  },
+  "files": [
+    "/lib",
+    "/messages",
+    "/oclif.manifest.json"
+  ],
+  "keywords": [
+    "force",
+    "salesforce",
+    "sfdx",
+    "salesforcedx",
+    "sfdx-plugin",
+    "sf-plugin",
+    "sf"
+  ],
+  "license": "BSD-3-Clause",
+  "main": "lib/index.js",
+  "oclif": {
+    "commands": "./lib/commands",
+    "bin": "sf",
+    "topicSeparator": " ",
+    "devPlugins": [
+      "@oclif/plugin-help"
+    ],
+    "topics": {
+      "trace": {
+        "description": "description for trace"
+      }
+    }
+  },
+  "scripts": {
+    "build": "wireit",
+    "clean": "sf-clean",
+    "clean-all": "sf-clean all",
+    "clean:lib": "shx rm -rf lib && shx rm -rf coverage && shx rm -rf .nyc_output && shx rm -f oclif.manifest.json",
+    "compile": "wireit",
+    "docs": "sf-docs",
+    "format": "wireit",
+    "lint": "wireit",
+    "postinstall": "yarn husky install",
+    "postpack": "shx rm -f oclif.manifest.json",
+    "prepack": "sf-prepack",
+    "test": "wireit",
+    "test:nuts": "nyc mocha \"**/*.nut.ts\" --slow 4500 --timeout 600000 --parallel",
+    "test:only": "wireit",
+    "version": "oclif readme"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "wireit": {
+    "build": {
+      "dependencies": [
+        "compile",
+        "lint"
+      ]
+    },
+    "compile": {
+      "command": "tsc -p . --pretty --incremental",
+      "files": [
+        "src/**/*.ts",
+        "**/tsconfig.json",
+        "messages/**"
+      ],
+      "output": [
+        "lib/**",
+        "*.tsbuildinfo"
+      ],
+      "clean": "if-file-deleted"
+    },
+    "format": {
+      "command": "prettier --write \"+(src|test|schemas)/**/*.+(ts|js|json)|command-snapshot.json\"",
+      "files": [
+        "src/**/*.ts",
+        "test/**/*.ts",
+        "schemas/**/*.json",
+        "command-snapshot.json",
+        ".prettier*"
+      ],
+      "output": []
+    },
+    "lint": {
+      "command": "eslint src test --color --cache --cache-location .eslintcache",
+      "files": [
+        "src/**/*.ts",
+        "test/**/*.ts",
+        "messages/**",
+        "**/.eslint*",
+        "**/tsconfig.json"
+      ],
+      "output": []
+    },
+    "test:compile": {
+      "command": "tsc -p \"./test\" --pretty",
+      "files": [
+        "test/**/*.ts",
+        "**/tsconfig.json"
+      ],
+      "output": []
+    },
+    "test": {
+      "dependencies": [
+        "test:compile",
+        "test:only",
+        "lint"
+      ]
+    },
+    "test:only": {
+      "command": "nyc mocha \"test/**/*.test.ts\"",
+      "env": {
+        "FORCE_COLOR": "2"
+      },
+      "files": [
+        "test/**/*.ts",
+        "src/**/*.ts",
+        "**/tsconfig.json",
+        ".mocha*",
+        "!*.nut.ts",
+        ".nycrc"
+      ],
+      "output": []
+    },
+    "test:command-reference": {
+      "command": "\"./bin/dev\" commandreference:generate --erroronwarnings",
+      "files": [
+        "src/**/*.ts",
+        "messages/**",
+        "package.json"
+      ],
+      "output": [
+        "tmp/root"
+      ]
+    },
+    "test:deprecation-policy": {
+      "command": "\"./bin/dev\" snapshot:compare",
+      "files": [
+        "src/**/*.ts"
+      ],
+      "output": [],
+      "dependencies": [
+        "compile"
+      ]
+    },
+    "test:json-schema": {
+      "command": "\"./bin/dev\" schema:compare",
+      "files": [
+        "src/**/*.ts",
+        "schemas"
+      ],
+      "output": []
+    }
+  },
+  "author": "Raffaele Preziosi"
+}