@sprucelabs/spruce-cli 17.1.55 → 18.1.0

package/src/__tests__/behavioral/SettingUpSchemasForModuleDistribution.test.ts

@@ -175,7 +175,7 @@ export default class SettingUpSchemasForModuleDistributionTest extends AbstractS
 
 		const schemas = schemaNames.map((name) => this[name])
 
-		await this.getEmitter().on('schema.did-fetch-schemas', async () => {
+		await this.emitter.on('schema.did-fetch-schemas', async () => {
 			return {
 				schemas,
 			}
@@ -228,7 +228,7 @@ export default class SettingUpSchemasForModuleDistributionTest extends AbstractS
 			schemas.push(this[name])
 		}
 
-		await this.getEmitter().on('schema.did-fetch-schemas', async () => {
+		await this.emitter.on('schema.did-fetch-schemas', async () => {
 			return {
 				schemas,
 			}
@@ -278,7 +278,7 @@ export default class SettingUpSchemasForModuleDistributionTest extends AbstractS
 			},
 		}
 
-		await this.getEmitter().on('schema.did-fetch-schemas', async () => {
+		await this.emitter.on('schema.did-fetch-schemas', async () => {
 			return {
 				schemas: [mySchema],
 			}
@@ -443,7 +443,7 @@ export default class SettingUpSchemasForModuleDistributionTest extends AbstractS
 			},
 		}
 
-		await this.getEmitter().on('schema.did-fetch-schemas', async () => {
+		await this.emitter.on('schema.did-fetch-schemas', async () => {
 			return {
 				schemas: [schema1, schema2],
 			}

package/src/__tests__/behavioral/WatchingSkillViews.test.ts

@@ -17,7 +17,7 @@ export default class WatchingSkillViewsTest extends AbstractSkillTest {
 
 	protected static async beforeEach() {
 		await super.beforeEach()
-		this.getFeatureInstaller().isInstalled = async () => true
+		this.featureInstaller.isInstalled = async () => true
 		SettingsService.prototype.isMarkedAsInstalled = () => true
 		BootAction.prototype.execute = this.oldBootExecute
 	}
@@ -155,7 +155,7 @@ export default class WatchingSkillViewsTest extends AbstractSkillTest {
 			code: 0,
 		})
 
-		const watchFeature = this.getFeatureInstaller().getFeature('watch')
+		const watchFeature = this.featureInstaller.getFeature('watch')
 		let wasStarted = false
 		let wasStopped = false
 
@@ -234,7 +234,7 @@ export default class WatchingSkillViewsTest extends AbstractSkillTest {
 	}
 
 	private static async emitFileChangeEvent() {
-		const emitter = this.getEmitter()
+		const emitter = this.emitter
 
 		await emitter.emit('watcher.did-detect-change', {
 			changes: [

package/src/__tests__/behavioral/errors/SettingUpErrors.test.ts

@@ -21,7 +21,7 @@ export default class SettingUpErrorTest extends AbstractErrorTest {
 	protected static async installsSchemasIfNotInstalled() {
 		await this.installErrorFeature('errors')
 
-		const installer = this.getFeatureInstaller()
+		const installer = this.featureInstaller
 
 		const isSchemaInstalled = await installer.isInstalled('schema')
 		assert.isTrue(isSchemaInstalled)

package/src/__tests__/behavioral/events/CreatingAListener.test.ts

@@ -1,4 +1,7 @@
-import { MercuryClientFactory } from '@sprucelabs/mercury-client'
+import {
+	MercuryClientFactory,
+	MercuryTestClient,
+} from '@sprucelabs/mercury-client'
 import { coreEventContracts } from '@sprucelabs/mercury-core-events'
 import { EventSignature, SpruceSchemas } from '@sprucelabs/mercury-types'
 import { buildSchema } from '@sprucelabs/schema'
@@ -14,7 +17,7 @@ import {
 	versionUtil,
 } from '@sprucelabs/spruce-skill-utils'
 import { eventFaker } from '@sprucelabs/spruce-test-fixtures'
-import { test, assert } from '@sprucelabs/test-utils'
+import { test, assert, generateId } from '@sprucelabs/test-utils'
 import { errorAssert } from '@sprucelabs/test-utils'
 import ListenAction, {
 	CORE_EVENT_NAMESPACE,
@@ -66,13 +69,7 @@ export default class CreatingAListenerTest extends AbstractEventTest {
 
 	@test()
 	protected static async generatesMapFile() {
-		const { results } = await this.installEventsAndCreateListener()
-
-		const match = testUtil.assertFileByNameInGeneratedFiles(
-			`listeners.ts`,
-			results.files
-		)
-
+		const match = await this.installEventsCreateListenerAndGetListenerMap()
 		await this.Service('typeChecker').check(match)
 	}
 
@@ -116,7 +113,6 @@ export default class CreatingAListenerTest extends AbstractEventTest {
 		assert.doesInclude(lastInvocation.options.label, 'namespace')
 
 		await this.ui.sendInput(MERCURY_API_NAMESPACE)
-
 		await this.waitForInput()
 
 		lastInvocation = this.ui.getLastInvocation()
@@ -128,12 +124,15 @@ export default class CreatingAListenerTest extends AbstractEventTest {
 
 	@test()
 	protected static async loadsContractsFilteringByDependencies() {
+		MercuryClientFactory.setIsTestMode(true)
+		MercuryTestClient.setShouldRequireLocalListeners(true)
+
 		let passedTarget: any
 		await this.fakeGetEventContracts((target) => {
 			passedTarget = target
 		})
 
-		const namespace = 'waka'
+		const namespace = generateId()
 		await this.installAddDependencyExecuteAndWaitForInput(namespace)
 
 		assert.isEqualDeep(passedTarget, {
@@ -151,6 +150,7 @@ export default class CreatingAListenerTest extends AbstractEventTest {
 	) {
 		await eventFaker.on('get-event-contracts::v2020_12_25', ({ target }) => {
 			cb?.(target)
+
 			return {
 				contracts: results ?? [...(coreEventContracts as any)],
 			}
@@ -326,18 +326,35 @@ export default class CreatingAListenerTest extends AbstractEventTest {
 		await this.Service('typeChecker').check(listenerPath)
 	}
 
+	@test()
+	protected static async hasIsGlobalCheck() {
+		const match = await this.installEventsCreateListenerAndGetListenerMap()
+		const contents = diskUtil.readFile(match)
+
+		assert.doesInclude(
+			contents,
+			"isGlobal: require('../../listeners/skill/will-boot.v2020_01_01.listener').isGlobal,"
+		)
+	}
+
 	private static async installAddDependencyExecuteAndWaitForInput(
 		namespace: string
 	) {
 		await this.installEventFeature('events')
-		MercuryClientFactory.setIsTestMode(true)
+
 		this.addDependency(namespace)
+
 		await this.executeAndWaitForInput()
 		return this.ui.getLastInvocation()
 	}
 
 	private static async executeAndWaitForInput() {
-		void this.listen.execute({})
+		void this.listen.execute({}).then((results) => {
+			if (results.errors) {
+				this.ui.setError(results.errors[0])
+			}
+		})
+
 		await this.waitForInput()
 	}
 
@@ -345,7 +362,7 @@ export default class CreatingAListenerTest extends AbstractEventTest {
 		const dependencies = this.Service('dependency')
 		dependencies.add({
 			id: namespace,
-			namespace: 'waka',
+			namespace,
 		})
 	}
 
@@ -412,4 +429,14 @@ export default class CreatingAListenerTest extends AbstractEventTest {
 			currentSkill,
 		}
 	}
+
+	private static async installEventsCreateListenerAndGetListenerMap() {
+		const { results } = await this.installEventsAndCreateListener()
+
+		const match = testUtil.assertFileByNameInGeneratedFiles(
+			`listeners.ts`,
+			results.files
+		)
+		return match
+	}
 }

package/src/__tests__/behavioral/events/EverythingInstalledInstaller.ts

@@ -0,0 +1,46 @@
+import { FeatureDependency } from '../../../features/AbstractFeature'
+import FeatureInstaller from '../../../features/FeatureInstaller'
+import {
+	FeatureCode,
+	FeatureInstallResponse,
+	FeatureMap,
+} from '../../../features/features.types'
+
+export default class EverythingInstalledInstaller implements FeatureInstaller {
+	private featureMap: Partial<FeatureMap> = {}
+
+	public mapFeature<C extends keyof FeatureMap>(
+		code: C,
+		feature: FeatureMap[C]
+	): void {
+		this.featureMap[code] = feature
+	}
+
+	public async install(): Promise<FeatureInstallResponse> {
+		return {}
+	}
+	public async getInstalledFeatures() {
+		return Object.values(this.featureMap)
+	}
+	public getFeatureDependencies(): FeatureDependency[] {
+		return []
+	}
+	public getAllCodes(): FeatureCode[] {
+		return Object.keys(this.featureMap) as FeatureCode[]
+	}
+
+	public async isInstalled(_code: keyof FeatureMap): Promise<boolean> {
+		return true
+	}
+	public markAsSkippedThisRun(_code: keyof FeatureMap): void {}
+	public markAsPermanentlySkipped(_code: keyof FeatureMap): void {}
+	public isMarkedAsSkipped(_code: keyof FeatureMap): boolean {
+		return false
+	}
+	public getFeature<C extends keyof FeatureMap>(code: C): FeatureMap[C] {
+		return this.featureMap[code]!
+	}
+	public async areInstalled(_codes: FeatureCode[]): Promise<boolean> {
+		return true
+	}
+}

package/src/__tests__/behavioral/onboard/StartingOnboarding.test.ts

@@ -1,10 +1,11 @@
 import { test, assert } from '@sprucelabs/test-utils'
 import CliGlobalEmitter, { globalContract } from '../../../GlobalEmitter'
+import CommandService from '../../../services/CommandService'
 import AbstractCliTest from '../../../tests/AbstractCliTest'
 
-class TheTestEmitter extends CliGlobalEmitter {
+class SpyEmitter extends CliGlobalEmitter {
 	public static TestEmitter() {
-		return new TheTestEmitter(globalContract)
+		return new SpyEmitter(globalContract)
 	}
 
 	public hasListeners(eventName: string) {
@@ -20,15 +21,19 @@ export default class StartingOnboardingTest extends AbstractCliTest {
 
 	@test()
 	protected static async addsCommandListeners() {
-		const testEmitter = TheTestEmitter.TestEmitter()
+		this.emitter = SpyEmitter.TestEmitter()
 
-		await this.Cli({ emitter: testEmitter })
+		await this.Cli()
 
-		assert.isTrue(testEmitter.hasListeners('feature.will-execute'))
+		assert.isTrue(
+			(this.emitter as SpyEmitter).hasListeners('feature.will-execute')
+		)
 	}
 
 	@test()
 	protected static async onboardingThroughSkillCreateThenShutsOff() {
+		CommandService.fakeCommand(/yarn/, { code: 0 })
+
 		const onboardAction = this.Action('onboard', 'onboard')
 		const onboardPromise = onboardAction.execute({})
 

package/src/__tests__/behavioral/tests/CreatingATest.test.ts

@@ -15,7 +15,7 @@ export default class CreatingBehavioralTestsTest extends AbstractTestTest {
 	protected static async requiresInstallIfFeatureNotInstalled() {
 		await this.installTests('testsInNodeModule')
 
-		const testFeature = this.getFeatureInstaller().getFeature('test')
+		const testFeature = this.featureInstaller.getFeature('test')
 		const candidates = await testFeature.buildParentClassCandidates()
 
 		assert.doesInclude(candidates, {

package/src/__tests__/behavioral/tests/SelectingAnAbstractTestClass.test.ts

@@ -117,10 +117,10 @@ export default class SelectingAnAbstractTestClassTest extends AbstractTestTest {
 
 		await this.installTests()
 
-		const testFeature = this.getFeatureInstaller().getFeature('test')
+		const testFeature = this.featureInstaller.getFeature('test')
 
 		for (const feat of featuresWithRegisteredTests) {
-			await this.getFeatureInstaller().install({
+			await this.featureInstaller.install({
 				features: [
 					{
 						//@ts-ignore
@@ -154,7 +154,7 @@ export default class SelectingAnAbstractTestClassTest extends AbstractTestTest {
 
 			assert.isTruthy(match)
 
-			let isInstalled = await this.getFeatureInstaller().isInstalled(
+			let isInstalled = await this.featureInstaller.isInstalled(
 				feat.featureCode as any
 			)
 			assert.isFalse(isInstalled)
@@ -163,7 +163,7 @@ export default class SelectingAnAbstractTestClassTest extends AbstractTestTest {
 
 			await promise
 
-			isInstalled = await this.getFeatureInstaller().isInstalled(
+			isInstalled = await this.featureInstaller.isInstalled(
 				feat.featureCode as any
 			)
 			assert.isTrue(isInstalled)

package/src/__tests__/behavioral/upgrading/UpdatingDependencies2.test.ts

@@ -19,7 +19,7 @@ export default class UpdateDependencies2Test extends AbstractCliTest {
 
 		this.Service('pkg').set({ path: 'dependencies.axios', value: '0.0.1' })
 
-		const skill = this.getFeatureInstaller().getFeature('skill')
+		const skill = this.featureInstaller.getFeature('skill')
 		skill.packageDependencies.push({
 			name: 'axios',
 			version: '0.21.3',
@@ -61,7 +61,7 @@ export default class UpdateDependencies2Test extends AbstractCliTest {
 		await this.action.execute({})
 
 		const pkg = this.Service('pkg')
-		const features = await this.getFeatureInstaller().getInstalledFeatures()
+		const features = await this.featureInstaller.getInstalledFeatures()
 
 		for (const feature of features) {
 			const featureDependencies = feature.packageDependencies as NpmPackage[]

package/src/__tests__/behavioral/upgrading/UpgradingANodeModule.test.ts

@@ -10,7 +10,7 @@ export default class UpgradingANodeModuleTest extends AbstractCliTest {
 
 		await this.FeatureFixture().installCachedFeatures('everythingInNode')
 
-		const featureInstaller = this.getFeatureInstaller()
+		const featureInstaller = this.featureInstaller
 		featureInstaller.markAsPermanentlySkipped('skill')
 	}
 
@@ -20,7 +20,7 @@ export default class UpgradingANodeModuleTest extends AbstractCliTest {
 		CommandService.fakeCommand(/yarn clean.build/gis, { code: 1 })
 		CommandService.fakeCommand(/yarn build.dev/gis, { code: 0 })
 
-		await this.getEmitter().on('feature.did-execute', () => {
+		await this.emitter.on('feature.did-execute', () => {
 			return {
 				errors: undefined,
 			}

package/src/__tests__/behavioral/upgrading/UpgradingASkill5.test.ts

@@ -48,7 +48,7 @@ export default class UpgradingASkill5Test extends AbstractCliTest {
 			})
 		}
 
-		const emitter = this.getEmitter()
+		const emitter = this.emitter
 
 		let wasHit = false
 
@@ -116,7 +116,7 @@ export default class UpgradingASkill5Test extends AbstractCliTest {
 		const settings = this.Settings()
 		settings.setListenerCache({ shouldBeDeleted: true })
 
-		const emitter = this.getEmitter()
+		const emitter = this.emitter
 		void emitter.on('feature.will-execute', () => {
 			throw new Error('Stop!')
 		})

package/src/__tests__/behavioral/upgrading/UpgradingWithListeners.test.ts

@@ -30,7 +30,7 @@ export default class UpgradingWithListeners extends AbstractCliTest {
 
 		let wasHit = false
 
-		await this.getEmitter().on(
+		await this.emitter.on(
 			'feature.will-execute',
 			async ({ featureCode, actionCode }) => {
 				if (featureCode === 'event' && actionCode === 'sync.listeners') {
@@ -39,7 +39,7 @@ export default class UpgradingWithListeners extends AbstractCliTest {
 			}
 		)
 
-		const results = await this.getEmitter().emit('feature.did-execute', {
+		const results = await this.emitter.emit('feature.did-execute', {
 			featureCode: 'node',
 			actionCode,
 			results: {},

package/src/__tests__/behavioral/views/CreatingASkillView.test.ts

@@ -24,7 +24,7 @@ export default class CreatingASkillViewTest extends AbstractSkillTest {
 
 	@test()
 	protected static async viewFieatureHasExpectedDependencies() {
-		const features = await this.getFeatureInstaller()
+		const features = await this.featureInstaller
 		const view = features.getFeature('view')
 		assert.isEqualDeep(view.dependencies, [
 			{

package/src/__tests__/behavioral/views/CreatingATheme.test.ts

@@ -51,7 +51,7 @@ export default class CreatingAThemeTest extends AbstractSkillTest {
 
 	@test()
 	protected static async doesNotSyncEventsIfAlreadySynced() {
-		const emitter = this.getEmitter()
+		const emitter = this.emitter
 		let hitCount = 0
 
 		diskUtil.deleteFile(this.getThemePath())

package/src/__tests__/behavioral/watchers/WatchingForChanges.test.ts

@@ -41,9 +41,8 @@ export default class WatchingForChangesTest extends AbstractCliTest {
 		shouldFire: boolean
 	) {
 		const cli = await this.installWatch()
-		const feature = cli.getFeature('watch')
 
-		await this.startWatching(feature)
+		const feature = cli.getFeature('watch')
 
 		let fireCount = 0
 
@@ -51,6 +50,8 @@ export default class WatchingForChangesTest extends AbstractCliTest {
 			fireCount++
 		})
 
+		await this.startWatching(feature)
+
 		diskUtil.writeFile(
 			this.resolvePath(path, 'test.ts'),
 			'console.log("hello world")'
@@ -110,39 +111,6 @@ export default class WatchingForChangesTest extends AbstractCliTest {
 		}
 	}
 
-	private static async stopWatching(feature: WatchFeature) {
-		await this.wait(3000)
-		await feature.stopWatching()
-		await this.wait(500)
-	}
-
-	private static async startWatching(feature: WatchFeature) {
-		void feature.startWatching({ delay: 2000, sourceDir: '.' })
-		await this.wait(500)
-	}
-
-	protected static async watchRunStop(
-		runner: () => Promise<GeneratedFileOrDir[]>
-	) {
-		const cli = await this.installWatch()
-		const feature = cli.getFeature('watch')
-
-		let payloadChanges: any = {}
-		void cli.on('watcher.did-detect-change', (payload) => {
-			payloadChanges = payload.changes
-		})
-
-		await this.startWatching(feature)
-
-		const expected: GeneratedFileOrDir[] = await runner()
-
-		await this.stopWatching(feature)
-
-		for (const e of expected) {
-			assert.doesInclude(payloadChanges, e)
-		}
-	}
-
 	@test()
 	protected static async canTrackAddingDir() {
 		await this.watchRunStop(async () => {
@@ -238,6 +206,38 @@ export default class WatchingForChangesTest extends AbstractCliTest {
 		})
 	}
 
+	private static async stopWatching(feature: WatchFeature) {
+		await this.wait(3000)
+		await feature.stopWatching()
+	}
+
+	private static async startWatching(feature: WatchFeature) {
+		void feature.startWatching({ delay: 200, sourceDir: '.' })
+		await this.wait(1000)
+	}
+
+	protected static async watchRunStop(
+		runner: () => Promise<GeneratedFileOrDir[]>
+	) {
+		const cli = await this.installWatch()
+		const feature = cli.getFeature('watch')
+
+		let payloadChanges: any = {}
+		void cli.on('watcher.did-detect-change', (payload) => {
+			payloadChanges = payload.changes
+		})
+
+		await this.startWatching(feature)
+
+		const expected: GeneratedFileOrDir[] = await runner()
+
+		await this.stopWatching(feature)
+
+		for (const e of expected) {
+			assert.doesInclude(payloadChanges, e)
+		}
+	}
+
 	private static async installWatch() {
 		const fixture = this.FeatureFixture()
 		const cli = await fixture.installFeatures([{ code: 'watch' }])

package/src/__tests__/implementation/ActionExecuter.test.ts

@@ -29,7 +29,7 @@ export default class FeatureCommandExecuterTest extends AbstractSchemaTest {
 
 		await this.wait(100)
 
-		const installer = this.getFeatureInstaller()
+		const installer = this.featureInstaller
 		let isInstalled = await installer.isInstalled('schema')
 
 		assert.isFalse(isInstalled)
@@ -98,7 +98,7 @@ export default class FeatureCommandExecuterTest extends AbstractSchemaTest {
 			},
 		})
 
-		const installer = this.getFeatureInstaller()
+		const installer = this.featureInstaller
 		const isInstalled = await installer.isInstalled('schema')
 
 		assert.isTrue(isInstalled)

package/src/__tests__/implementation/ActionExecuter2.test.ts

@@ -44,7 +44,7 @@ export default class FeatureCommandExecuterContTest extends AbstractSchemaTest {
 		let willExecuteHitCount = 0
 		let didExecuteHitCount = 0
 
-		const emitter = this.getEmitter()
+		const emitter = this.emitter
 
 		void emitter.on('feature.will-execute', (payload) => {
 			emittedWillEvent = true

package/src/__tests__/implementation/ActionExecuter4.test.ts

@@ -23,7 +23,7 @@ export default class ActionExecuter4Test extends AbstractCliTest {
 		msg: string,
 		willDid: 'will' | 'did' = 'will'
 	) {
-		await this.getEmitter().on(`feature.${willDid}-execute`, () => {
+		await this.emitter.on(`feature.${willDid}-execute`, () => {
 			throw new Error(msg)
 		})
 

package/src/__tests__/implementation/FeatureInstaller.test.ts

@@ -1,5 +1,6 @@
 import { test, assert } from '@sprucelabs/test-utils'
 import FeatureInstaller from '../../features/FeatureInstaller'
+import CommandService from '../../services/CommandService'
 import AbstractCliTest from '../../tests/AbstractCliTest'
 
 export default class FeatureInstallerTest extends AbstractCliTest {
@@ -7,7 +8,7 @@ export default class FeatureInstallerTest extends AbstractCliTest {
 
 	protected static async beforeEach() {
 		await super.beforeEach()
-		this.installer = this.getFeatureInstaller()
+		this.installer = this.featureInstaller
 	}
 
 	@test()
@@ -27,11 +28,17 @@ export default class FeatureInstallerTest extends AbstractCliTest {
 
 	@test()
 	protected static async afterPackageInstallIsCalledOncePerFeature() {
+		CommandService.fakeCommand(/yarn/, {
+			code: 0,
+		})
+
 		let hitCount = 0
+
 		//@ts-ignore
 		this.installer.featureMap.schema.afterPackageInstall = () => {
 			hitCount++
 		}
+
 		await this.installer.install({
 			features: [
 				{

package/src/__tests__/implementation/GlobalEmitter.ts

@@ -3,10 +3,8 @@ import AbstractCliTest from '../../tests/AbstractCliTest'
 
 export default class GlobalEmitterTest extends AbstractCliTest {
 	@test()
-	protected static async globalEmitterEmitsSEquentally() {
-		const emitter = this.getEmitter()
-
+	protected static async globalEmitterEmitsEquentally() {
 		//@ts-ignore
-		assert.isTrue(emitter.shouldEmitSequentally)
+		assert.isTrue(this.emitter.shouldEmitSequentally)
 	}
 }

package/src/__tests__/implementation/SettingUpANodeModule.test.ts

@@ -23,7 +23,7 @@ export default class SettingUpANodeModuleTest extends AbstractCliTest {
 
 	@test()
 	protected static async canTellIfNotInstalled() {
-		const installer = this.getFeatureInstaller()
+		const installer = this.featureInstaller
 		const isInstalled = await installer.isInstalled('node')
 		assert.isFalse(isInstalled)
 	}