Skip to content

Commit

Permalink
refactor: reorganize scratch org files
Browse files Browse the repository at this point in the history
  • Loading branch information
mshanemc committed May 7, 2024
1 parent cf5cd4e commit db58775
Show file tree
Hide file tree
Showing 17 changed files with 72 additions and 72 deletions.
10 changes: 5 additions & 5 deletions src/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -96,16 +96,16 @@ export {
ScratchOrgCreateResult,
scratchOrgCreate,
scratchOrgResume,
} from './org/scratchOrgCreate';
} from './org/scratch/scratchOrgCreate';

export { ScratchOrgInfo } from './org/scratchOrgTypes';
export { ScratchOrgInfo } from './org/scratch/types';
export {
ScratchOrgLifecycleEvent,
scratchOrgLifecycleEventName,
scratchOrgLifecycleStages,
} from './org/scratchOrgLifecycleEvents';
export { ScratchOrgCache } from './org/scratchOrgCache';
export { default as ScratchOrgSettingsGenerator } from './org/scratchOrgSettingsGenerator';
} from './org/scratch/lifecycle';
export { ScratchOrgCache } from './org/scratch/scratchOrgCache';
export { default as ScratchOrgSettingsGenerator } from './org/scratch/settingsGenerator';

// Utility sub-modules
export * from './util/sfdc';
2 changes: 1 addition & 1 deletion src/org/org.ts
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ import { PollingClient } from '../status/pollingClient';
import { StatusResult } from '../status/types';
import { Connection, SingleRecordQueryErrors } from './connection';
import { AuthFields, AuthInfo } from './authInfo';
import { scratchOrgCreate, ScratchOrgCreateOptions, ScratchOrgCreateResult } from './scratchOrgCreate';
import { scratchOrgCreate, ScratchOrgCreateOptions, ScratchOrgCreateResult } from './scratch/scratchOrgCreate';
import { OrgConfigProperties } from './orgConfigProperties';

Messages.importMessagesDirectory(__dirname);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,12 +6,12 @@
*/

import { Optional } from '@salesforce/ts-types';
import { Messages } from '../messages';
import { SfError } from '../sfError';
import { Logger } from '../logger/logger';
import { ScratchOrgInfo } from './scratchOrgTypes';
import { Messages } from '../../messages';
import { SfError } from '../../sfError';
import { Logger } from '../../logger/logger';
import { ScratchOrgInfo } from './types';
import { ScratchOrgCache } from './scratchOrgCache';
import { emit } from './scratchOrgLifecycleEvents';
import { emit } from './lifecycle';

const WORKSPACE_CONFIG_FILENAME = 'sfdx-project.json';

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
import { isString } from '@salesforce/ts-types';

// Local
import { Messages } from '../messages';
import { Messages } from '../../messages';
Messages.importMessagesDirectory(__dirname);
const messages = Messages.loadMessages('@salesforce/core', 'scratchOrgFeatureDeprecation');
const FEATURE_TYPES = {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,9 @@
* 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 { Lifecycle } from '../lifecycleEvents';
import { AuthFields } from './authInfo';
import { ScratchOrgInfo } from './scratchOrgTypes';
import { Lifecycle } from '../../lifecycleEvents';
import { AuthFields } from '../authInfo';
import { ScratchOrgInfo } from './types';

export const scratchOrgLifecycleEventName = 'scratchOrgLifecycleEvent';
export const scratchOrgLifecycleStages = [
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,8 @@
*/
import { Duration } from '@salesforce/kit';
import { JsonMap } from '@salesforce/ts-types';
import { Global } from '../global';
import { TTLConfig } from '../config/ttlConfig';
import { Global } from '../../global';
import { TTLConfig } from '../../config/ttlConfig';

export type CachedOptions = {
hubUsername: string;
Expand Down
24 changes: 12 additions & 12 deletions src/org/scratchOrgCreate.ts → src/org/scratch/scratchOrgCreate.ts
Original file line number Diff line number Diff line change
Expand Up @@ -6,13 +6,14 @@
*/
import { Duration, toBoolean } from '@salesforce/kit';
import { ensureString } from '@salesforce/ts-types';
import { Messages } from '../messages';
import { Logger } from '../logger/logger';
import { ConfigAggregator } from '../config/configAggregator';
import { OrgConfigProperties } from '../org/orgConfigProperties';
import { SfProject } from '../sfProject';
import { StateAggregator } from '../stateAggregator/stateAggregator';
import { Org } from './org';
import { Messages } from '../../messages';
import { Logger } from '../../logger/logger';
import { ConfigAggregator } from '../../config/configAggregator';
import { OrgConfigProperties } from '../orgConfigProperties';
import { SfProject } from '../../sfProject';
import { StateAggregator } from '../../stateAggregator/stateAggregator';
import { Org } from '../org';
import { AuthFields, AuthInfo } from '../authInfo';
import {
authorizeScratchOrg,
requestScratchOrgCreation,
Expand All @@ -21,13 +22,12 @@ import {
resolveUrl,
queryScratchOrgInfo,
} from './scratchOrgInfoApi';
import { ScratchOrgInfo } from './scratchOrgTypes';
import SettingsGenerator from './scratchOrgSettingsGenerator';
import { ScratchOrgInfo } from './types';
import SettingsGenerator from './settingsGenerator';
import { generateScratchOrgInfo, getScratchOrgInfoPayload } from './scratchOrgInfoGenerator';
import { AuthFields, AuthInfo } from './authInfo';
import { emit, emitPostOrgCreate } from './scratchOrgLifecycleEvents';
import { emit, emitPostOrgCreate } from './lifecycle';
import { ScratchOrgCache } from './scratchOrgCache';
import { validateScratchOrgInfoForResume } from './scratchOrgErrorCodes';
import { validateScratchOrgInfoForResume } from './errorCodes';

Messages.importMessagesDirectory(__dirname);
const messages = Messages.loadMessages('@salesforce/core', 'scratchOrgCreate');
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,22 +10,22 @@ import { env, Duration, upperFirst, omit } from '@salesforce/kit';
import { AnyJson } from '@salesforce/ts-types';
import { OAuth2Config, SaveResult } from '@jsforce/jsforce-node';
import { retryDecorator, RetryError } from 'ts-retry-promise';
import { JwtOAuth2Config } from '../org/authInfo';
import { Logger } from '../logger/logger';
import { Messages } from '../messages';
import { SfError } from '../sfError';
import { SfdcUrl } from '../util/sfdcUrl';
import { StatusResult } from '../status/types';
import { PollingClient } from '../status/pollingClient';
import { MyDomainResolver } from '../status/myDomainResolver';
import { Lifecycle } from '../lifecycleEvents';
import mapKeys from '../util/mapKeys';
import { AuthInfo } from './authInfo';
import { Org } from './org';
import { checkScratchOrgInfoForErrors } from './scratchOrgErrorCodes';
import SettingsGenerator from './scratchOrgSettingsGenerator';
import { ScratchOrgInfo } from './scratchOrgTypes';
import { emit } from './scratchOrgLifecycleEvents';
import { JwtOAuth2Config } from '../authInfo';
import { Logger } from '../../logger/logger';
import { Messages } from '../../messages';
import { SfError } from '../../sfError';
import { SfdcUrl } from '../../util/sfdcUrl';
import { StatusResult } from '../../status/types';
import { PollingClient } from '../../status/pollingClient';
import { MyDomainResolver } from '../../status/myDomainResolver';
import { Lifecycle } from '../../lifecycleEvents';
import mapKeys from '../../util/mapKeys';
import { AuthInfo } from '../authInfo';
import { Org } from '../org';
import { checkScratchOrgInfoForErrors } from './errorCodes';
import SettingsGenerator from './settingsGenerator';
import { ScratchOrgInfo } from './types';
import { emit } from './lifecycle';

// preserving because it extends a class
// eslint-disable-next-line @typescript-eslint/consistent-type-definitions
Expand Down
4 changes: 2 additions & 2 deletions src/org/scratch/scratchOrgInfoGenerator.ts
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,8 @@ import { SfError } from '../../sfError';
import { Org } from '../org';
import { DEFAULT_CONNECTED_APP_INFO } from '../authInfo';
import { queryAncestorFromHighest, packageHasAncestorVersion, queryIdFromAncestorVersion } from './ancestorQueries';
import { ScratchOrgInfo } from './scratchOrgTypes';
import { ScratchOrgFeatureDeprecation } from './scratchOrgFeatureDeprecation';
import { ScratchOrgInfo } from './types';
import { ScratchOrgFeatureDeprecation } from './featureDeprecation';

Messages.importMessagesDirectory(__dirname);
export const messages = Messages.loadMessages('@salesforce/core', 'scratchOrgInfoGenerator');
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,17 +9,17 @@ import * as path from 'node:path';
import { isEmpty, env, upperFirst, Duration } from '@salesforce/kit';
import { ensureObject, JsonMap } from '@salesforce/ts-types';
import * as js2xmlparser from 'js2xmlparser';
import { Logger } from '../logger/logger';
import { SfError } from '../sfError';
import { StructuredWriter } from '../util/structuredWriter';
import { StatusResult } from '../status/types';
import { PollingClient } from '../status/pollingClient';
import { ZipWriter } from '../util/zipWriter';
import { DirectoryWriter } from '../util/directoryWriter';
import { Lifecycle } from '../lifecycleEvents';
import { Messages } from '../messages';
import { ScratchOrgInfo, ObjectSetting } from './scratchOrgTypes';
import { Org } from './org';
import { Logger } from '../../logger/logger';
import { SfError } from '../../sfError';
import { StructuredWriter } from '../../util/structuredWriter';
import { StatusResult } from '../../status/types';
import { PollingClient } from '../../status/pollingClient';
import { ZipWriter } from '../../util/zipWriter';
import { DirectoryWriter } from '../../util/directoryWriter';
import { Lifecycle } from '../../lifecycleEvents';
import { Messages } from '../../messages';
import { Org } from '../org';
import { ScratchOrgInfo, ObjectSetting } from './types';

Messages.importMessagesDirectory(__dirname);

Expand Down
File renamed without changes.
4 changes: 2 additions & 2 deletions test/unit/org/scratchOrgCreateTest.ts
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,8 @@ import { Connection } from '@jsforce/jsforce-node';
import { Org } from '../../../src/org/org';
import { AuthInfo } from '../../../src/org/authInfo';
import { SfProject, SfProjectJson } from '../../../src/sfProject';
import { scratchOrgCreate, ScratchOrgCreateOptions, scratchOrgResume } from '../../../src/org/scratchOrgCreate';
import { ScratchOrgCache } from '../../../src/org/scratchOrgCache';
import { scratchOrgCreate, ScratchOrgCreateOptions, scratchOrgResume } from '../../../src/org/scratch/scratchOrgCreate';
import { ScratchOrgCache } from '../../../src/org/scratch/scratchOrgCache';

const packageId = '05iB0000000cWwnIAE';
const packageVersionSubscriberId = '04tB0000000cWwnIAE';
Expand Down
4 changes: 2 additions & 2 deletions test/unit/org/scratchOrgErrorCodesTest.ts
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,8 @@
*/
import { expect } from 'chai';
import { SfError } from '../../../src/sfError';
import { ScratchOrgInfo } from '../../../src/org/scratchOrgTypes';
import { checkScratchOrgInfoForErrors } from '../../../src/org/scratchOrgErrorCodes';
import { ScratchOrgInfo } from '../../../src/org/scratch/types';
import { checkScratchOrgInfoForErrors } from '../../../src/org/scratch/errorCodes';
import { shouldThrow } from '../../../src/testSetup';

const testUsername = 'foo';
Expand Down
2 changes: 1 addition & 1 deletion test/unit/org/scratchOrgFeatureDeprecationTest.ts
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
*/

import { expect } from 'chai';
import { ScratchOrgFeatureDeprecation } from '../../../src/org/scratchOrgFeatureDeprecation';
import { ScratchOrgFeatureDeprecation } from '../../../src/org/scratch/featureDeprecation';

describe('scratchOrgFeatureDeprecation', () => {
const FEATURE_TYPES = {
Expand Down
8 changes: 4 additions & 4 deletions test/unit/org/scratchOrgInfoApiTest.ts
Original file line number Diff line number Diff line change
Expand Up @@ -15,17 +15,17 @@ import { Connection } from '../../../src/org/connection';
import { AuthInfo } from '../../../src/org/authInfo';
import { shouldThrow } from '../../../src/testSetup';
import { MyDomainResolver } from '../../../src/status/myDomainResolver';
import SettingsGenerator from '../../../src/org/scratchOrgSettingsGenerator';
import * as mockForStandaloneFunctions from '../../../src/org/scratchOrgInfoApi';
import SettingsGenerator from '../../../src/org/scratch/settingsGenerator';
import * as mockForStandaloneFunctions from '../../../src/org/scratch/scratchOrgInfoApi';
import {
authorizeScratchOrg,
deploySettings,
JsForceError,
pollForScratchOrgInfo,
requestScratchOrgCreation,
resolveUrl,
} from '../../../src/org/scratchOrgInfoApi';
import { ScratchOrgInfo } from '../../../src/org/scratchOrgTypes';
} from '../../../src/org/scratch/scratchOrgInfoApi';
import { ScratchOrgInfo } from '../../../src/org/scratch/types';
import { Messages } from '../../../src/messages';
import { SfError } from '../../../src/sfError';

Expand Down
2 changes: 1 addition & 1 deletion test/unit/org/scratchOrgInfoGeneratorTest.ts
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ import {
getAncestorIds,
generateScratchOrgInfo,
getScratchOrgInfoPayload,
} from '../../../src/org/scratchOrgInfoGenerator';
} from '../../../src/org/scratch/scratchOrgInfoGenerator';
import { SfProjectJson } from '../../../src/sfProject';
import { Messages } from '../../../src/messages';

Expand Down
8 changes: 4 additions & 4 deletions test/unit/org/scratchOrgSettingsGeneratorTest.ts
Original file line number Diff line number Diff line change
Expand Up @@ -12,11 +12,11 @@ import { Org } from '../../../src/org/org';
import { Connection } from '../../../src/org/connection';
import { validateApiVersion } from '../../../src/util/sfdc';
import { ZipWriter } from '../../../src/util/zipWriter';
import { ScratchOrgInfo } from '../../../src/org/scratchOrgTypes';
import { ScratchOrgInfo } from '../../../src/org/scratch/types';
import SettingsGenerator, {
createObjectFileContent,
createRecordTypeAndBusinessProcessFileContent,
} from '../../../src/org/scratchOrgSettingsGenerator';
} from '../../../src/org/scratch/settingsGenerator';
import { MockTestOrgData, shouldThrow } from '../../../src/testSetup';

const TEMPLATE_SCRATCH_ORG_INFO: ScratchOrgInfo = {
Expand Down Expand Up @@ -399,7 +399,7 @@ describe('scratchOrgSettingsGenerator', () => {
sandbox.restore();
});

it('tries to deploy the settings to the org pools untill succeded', async () => {
it('tries to deploy the settings to the org pools until succeeded', async () => {
const scratchDef = {
...TEMPLATE_SCRATCH_ORG_INFO,
settings: {
Expand Down Expand Up @@ -505,7 +505,7 @@ describe('scratchOrgSettingsGenerator', () => {
sandbox.restore();
});

it('tries to deploy the settings to the org pools untill timeouts', async () => {
it('tries to deploy the settings to the org pools until timeouts', async () => {
const timeout = 10 * 60 * 1000; // 10 minutes
const frequency = 1000;
const settings = new SettingsGenerator();
Expand Down

0 comments on commit db58775

Please sign in to comment.