Revamp local dev to support websocket server for UI #1479
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,191 @@ | ||
| import { fetchAppInstallationData } from '@hubspot/local-dev-lib/api/localDevAuth'; | ||
|
Contributor
Author
There was a problem hiding this comment. This is a wrapper around the |
||
| import { | ||
| fetchPublicAppsForPortal, | ||
| fetchPublicAppProductionInstallCounts, | ||
| } from '@hubspot/local-dev-lib/api/appsDev'; | ||
| import { PublicApp } from '@hubspot/local-dev-lib/types/Apps'; | ||
| import { DevModeUnifiedInterface as UIEDevModeInterface } from '@hubspot/ui-extensions-dev-server'; | ||
| import { requestPorts } from '@hubspot/local-dev-lib/portManager'; | ||
|
|
||
| import { APP_DISTRIBUTION_TYPES } from '../../constants'; | ||
| import { EXIT_CODES } from '../../enums/exitCodes'; | ||
| import { isAppIRNode } from '../../projects/structure'; | ||
| import { uiLine } from '../../ui'; | ||
| import { logError } from '../../errorHandlers/index'; | ||
| import { installPublicAppPrompt } from '../../prompts/installPublicAppPrompt'; | ||
| import { confirmPrompt } from '../../prompts/promptUtils'; | ||
| import { AppIRNode } from '../../../types/ProjectComponents'; | ||
| import { lib } from '../../../lang/en'; | ||
| import { uiLogger } from '../../ui/logger'; | ||
| import { LocalDevState } from '../../../types/LocalDev'; | ||
| import LocalDevLogger from './LocalDevLogger'; | ||
|
|
||
| type AppDevModeInterfaceConstructorOptions = { | ||
| localDevState: LocalDevState; | ||
| localDevLogger: LocalDevLogger; | ||
| }; | ||
|
|
||
| class AppDevModeInterface { | ||
| localDevState: LocalDevState; | ||
| localDevLogger: LocalDevLogger; | ||
| _app?: AppIRNode | null; | ||
| marketplaceAppData?: PublicApp; | ||
| marketplaceAppInstalls?: number; | ||
|
|
||
| constructor(options: AppDevModeInterfaceConstructorOptions) { | ||
| this.localDevState = options.localDevState; | ||
| this.localDevLogger = options.localDevLogger; | ||
|
|
||
| if ( | ||
| !this.localDevState.targetProjectAccountId || | ||
| !this.localDevState.projectConfig || | ||
| !this.localDevState.projectDir | ||
| ) { | ||
| uiLogger.log(lib.LocalDevManager.failedToInitialize); | ||
| process.exit(EXIT_CODES.ERROR); | ||
| } | ||
| } | ||
|
|
||
| // Assumes only one app per project | ||
| private get app(): AppIRNode | null { | ||
| if (this._app === undefined) { | ||
| this._app = | ||
| Object.values(this.localDevState.projectNodes).find(isAppIRNode) || | ||
| null; | ||
| } | ||
| return this._app; | ||
| } | ||
|
|
||
| private async fetchMarketplaceAppData(): Promise<void> { | ||
| const { | ||
| data: { results: portalMarketplaceApps }, | ||
| } = await fetchPublicAppsForPortal( | ||
| this.localDevState.targetProjectAccountId | ||
| ); | ||
|
|
||
| const marketplaceAppData = portalMarketplaceApps.find( | ||
| ({ sourceId }) => sourceId === this.app?.uid | ||
| ); | ||
|
|
||
| if (!marketplaceAppData) { | ||
| return; | ||
| } | ||
|
|
||
| const { | ||
| data: { uniquePortalInstallCount }, | ||
| } = await fetchPublicAppProductionInstallCounts( | ||
| marketplaceAppData.id, | ||
| this.localDevState.targetProjectAccountId | ||
| ); | ||
|
|
||
| this.marketplaceAppData = marketplaceAppData; | ||
| this.marketplaceAppInstalls = uniquePortalInstallCount; | ||
| } | ||
|
|
||
| private async checkMarketplaceAppInstalls(): Promise<void> { | ||
| if (!this.marketplaceAppData || !this.marketplaceAppInstalls) { | ||
| return; | ||
| } | ||
| uiLine(); | ||
|
|
||
| uiLogger.warn( | ||
| lib.LocalDevManager.activeInstallWarning.installCount( | ||
| this.marketplaceAppData.name, | ||
| this.marketplaceAppInstalls | ||
| ) | ||
| ); | ||
| uiLogger.log(lib.LocalDevManager.activeInstallWarning.explanation); | ||
| uiLine(); | ||
|
|
||
| const proceed = await confirmPrompt( | ||
| lib.LocalDevManager.activeInstallWarning.confirmationPrompt, | ||
| { defaultAnswer: false } | ||
| ); | ||
|
|
||
| if (!proceed) { | ||
| process.exit(EXIT_CODES.SUCCESS); | ||
| } | ||
|
|
||
| this.localDevLogger.addUploadWarning( | ||
| lib.AppDevModeInterface.defaultMarketplaceAppWarning( | ||
| this.marketplaceAppInstalls | ||
| ) | ||
| ); | ||
| } | ||
|
|
||
| private async checkMarketplaceAppInstallation(): Promise<void> { | ||
| if (!this.app || !this.marketplaceAppData) { | ||
| return; | ||
| } | ||
|
|
||
| const { | ||
| data: { isInstalledWithScopeGroups, previouslyAuthorizedScopeGroups }, | ||
| } = await fetchAppInstallationData( | ||
| this.localDevState.targetTestingAccountId, | ||
| this.localDevState.projectId, | ||
| this.app.uid, | ||
| this.app.config.auth.requiredScopes, | ||
| this.app.config.auth.optionalScopes | ||
| ); | ||
| const isReinstall = previouslyAuthorizedScopeGroups.length > 0; | ||
|
|
||
| if (!isInstalledWithScopeGroups) { | ||
| await installPublicAppPrompt( | ||
| this.localDevState.env, | ||
| this.localDevState.targetTestingAccountId, | ||
| this.marketplaceAppData.clientId, | ||
| this.app.config.auth.requiredScopes, | ||
| this.app.config.auth.redirectUrls, | ||
| isReinstall | ||
| ); | ||
| } | ||
| } | ||
|
|
||
| // @ts-expect-error TODO: reconcile types between CLI and UIE Dev Server | ||
| // In the future, update UIE Dev Server to use LocalDevState | ||
| async setup(args): Promise<void> { | ||
| if (!this.app) { | ||
| return; | ||
| } | ||
|
|
||
| if (this.app?.config.distribution === APP_DISTRIBUTION_TYPES.MARKETPLACE) { | ||
| try { | ||
| await this.fetchMarketplaceAppData(); | ||
| await this.checkMarketplaceAppInstalls(); | ||
| await this.checkMarketplaceAppInstallation(); | ||
| } catch (e) { | ||
| logError(e); | ||
| } | ||
| } | ||
| return UIEDevModeInterface.setup(args); | ||
| } | ||
|
|
||
| async start() { | ||
| if (!this.app) { | ||
| return; | ||
| } | ||
|
|
||
| return UIEDevModeInterface.start({ | ||
| accountId: this.localDevState.targetTestingAccountId, | ||
| // @ts-expect-error TODO: reconcile types between CLI and UIE Dev Server | ||
| projectConfig: this.localDevState.projectConfig, | ||
| requestPorts, | ||
| }); | ||
| } | ||
| async fileChange(filePath: string, event: string) { | ||
| if (!this.app) { | ||
| return; | ||
| } | ||
|
|
||
| return UIEDevModeInterface.fileChange(filePath, event); | ||
| } | ||
| async cleanup() { | ||
| if (!this.app) { | ||
| return; | ||
| } | ||
|
|
||
| return UIEDevModeInterface.cleanup(); | ||
| } | ||
| } | ||
|
|
||
| export default AppDevModeInterface; | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LocalDevProcessrepresents the current local dev session (similar to the oldLocalDevManager). Everything that interacts with theLocalDevProcessnow lives outside of it and uses public methods to make necessary changes to the process.This includes
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'd add a note with that explanation directly into the code.