feat: use-most-recent cache

Author: iowillhoit

config/config.json

@@ -1,5 +1,6 @@
 {
  "Account": {
+    "numRecords": 10,
     "fields": [
       {
         "name": "Name",
@@ -143,6 +144,7 @@
     "formats": []
   },
   "Contact": {
+    "numRecords": 10,
     "fields": [
       {
         "name": "AccountId",
@@ -351,6 +353,7 @@
     "formats": []
   },
   "Opportunity": {
+    "numRecords": 10,
     "fields": [
       {
         "name": "Amount",

src/commands/data-seeding/generate.ts

@@ -11,6 +11,7 @@ import { Duration } from '@salesforce/kit';
 import { initiateDataSeed, pollSeedStatus, PollSeedResponse } from '../../utils/api.js';
 import { getSeedGenerateMso, getSeedGenerateStage as getStage } from '../../utils/mso.js';
 import { DataSeedingGenerateResult } from '../../utils/types.js';
+import { GenerateRequestCache } from '../../utils/cache.js';
 
 Messages.importMessagesDirectoryFromMetaUrl(import.meta.url);
 const messages = Messages.loadMessages('@salesforce/plugin-data-seeding', 'data-seeding.generate');
@@ -59,6 +60,8 @@ export default class DataSeedingGenerate extends SfCommand<DataSeedingGenerateRe
 
     if (!jobId) throw new Error('Failed to receive job id');
 
+    await (await GenerateRequestCache.create()).createCacheEntry(jobId);
+
     const buildResponse = (response: PollSeedResponse): DataSeedingGenerateResult => ({
       dataSeedingJob: 'generate',
       jobId,

src/commands/data-seeding/report.ts

@@ -10,6 +10,7 @@ import { Messages, SfError } from '@salesforce/core';
 import { pollSeedStatus } from '../../utils/api.js';
 import { getSeedGenerateMso, getSeedGenerateStage as getStage } from '../../utils/mso.js';
 import { DataSeedingReportResult } from '../../utils/types.js';
+import { GenerateRequestCache } from '../../utils/cache.js';
 
 Messages.importMessagesDirectoryFromMetaUrl(import.meta.url);
 const messages = Messages.loadMessages('@salesforce/plugin-data-seeding', 'data-seeding.report');
@@ -26,19 +27,21 @@ export default class DataSeedingReport extends SfCommand<DataSeedingReportResult
     'job-id': Flags.string({
       summary: messages.getMessage('flags.job-id.summary'),
       char: 'i',
-      exclusive: ['use-most-recent'],
+      exactlyOne: ['job-id', 'use-most-recent'],
     }),
     'use-most-recent': Flags.boolean({
       summary: messages.getMessage('flags.use-most-recent.summary'),
       char: 'r',
-      exclusive: ['job-id'],
+      exactlyOne: ['job-id', 'use-most-recent'],
     }),
   };
 
   public async run(): Promise<DataSeedingReportResult> {
     const { flags } = await this.parse(DataSeedingReport);
 
-    const jobId = flags['job-id'] ?? 'getMostRecentJobIdFromCache()';
+    const jobId = flags['job-id'] ?? (await GenerateRequestCache.create()).resolveFromCache().jobId;
+
+    if (!jobId) throw new SfError('No job ID provided or found in cache');
 
     const response = await pollSeedStatus(jobId);
 

src/utils/cache.ts

@@ -0,0 +1,64 @@
+/*
+ * Copyright (c) 2023, salesforce.com, inc.
+ * All rights reserved.
+ * Licensed under the BSD 3-Clause license.
+ * For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
+ */
+
+import { TTLConfig, Global, SfError } from '@salesforce/core';
+import { Duration } from '@salesforce/kit';
+
+export type SeedingOptions = {
+  jobId: string;
+};
+
+export type SeedingCacheConfig = {
+  jobId: string;
+};
+
+export abstract class DataSeedingRequestCache extends TTLConfig<TTLConfig.Options, SeedingCacheConfig> {
+  public static getDefaultOptions(): TTLConfig.Options {
+    return {
+      isGlobal: true,
+      isState: true,
+      filename: DataSeedingRequestCache.getFileName(),
+      stateFolder: Global.SF_STATE_FOLDER,
+      ttl: Duration.days(14),
+    };
+  }
+
+  public async createCacheEntry(jobId: string): Promise<void> {
+    if (!jobId) throw new SfError('Job ID is required to create a cache entry');
+
+    this.set(jobId, { jobId });
+    await this.write();
+  }
+
+  public resolveFromCache(): SeedingOptions {
+    const key = this.getLatestKey();
+    if (!key) throw new SfError('Could not find a job ID to resume');
+
+    const { jobId } = this.get(key);
+    return { jobId };
+  }
+}
+
+export class GenerateRequestCache extends DataSeedingRequestCache {
+  public static getDefaultOptions(): TTLConfig.Options {
+    return {
+      isGlobal: true,
+      isState: true,
+      filename: 'data-seeding-generate-request-cache.json',
+      stateFolder: Global.SF_STATE_FOLDER,
+      ttl: Duration.days(14),
+    };
+  }
+
+  public static async unset(key: string): Promise<void> {
+    const cache = await GenerateRequestCache.create();
+    cache.unset(key);
+    await cache.write();
+  }
+}
+
+