Merge pull request #1100 from Shopify/cli-kit-refactor-environment-3

[cli-kit] refactor environment module part 3

Author: isaacroldan

packages/app/src/cli/models/app/loader.ts

@@ -6,7 +6,7 @@ import {UIExtensionInstance, UIExtensionSpec} from '../extensions/ui.js'
 import {ThemeExtensionInstance, ThemeExtensionSpec} from '../extensions/theme.js'
 import {ThemeExtensionSchema, TypeSchema} from '../extensions/schemas.js'
 import {FunctionInstance, FunctionSpec} from '../extensions/functions.js'
-import {error, file, path, schema, output, environment} from '@shopify/cli-kit'
+import {error, file, path, schema, output} from '@shopify/cli-kit'
 import {readAndParseDotEnv, DotEnvFile} from '@shopify/cli-kit/node/dot-env'
 import {
   getDependencies,
@@ -19,6 +19,7 @@ import {getArrayRejectingUndefined} from '@shopify/cli-kit/common/array'
 import {camelize} from '@shopify/cli-kit/common/string'
 import {hashString} from '@shopify/cli-kit/node/crypto'
 import {decodeToml} from '@shopify/cli-kit/node/toml'
+import {isShopify} from '@shopify/cli-kit/node/environment/local'
 
 const defaultExtensionDirectory = 'extensions/*'
 
@@ -263,12 +264,12 @@ class AppLoader {
       const specification = this.findSpecificationForType(type) as UIExtensionSpec | undefined
 
       if (!specification) {
-        const isShopify = await environment.local.isShopify()
+        const isShopifolk = await isShopify()
         const shopifolkMessage = '\nYou might need to enable some beta flags on your Organization or App'
         this.abortOrReport(
           output.content`Unknown extension type ${output.token.yellow(type)} in ${output.token.path(
             configurationPath,
-          )}. ${isShopify ? shopifolkMessage : ''}`,
+          )}. ${isShopifolk ? shopifolkMessage : ''}`,
           undefined,
           configurationPath,
         )

packages/app/src/cli/models/extensions/specifications.ts

@@ -6,10 +6,11 @@ import {
   loadUIExtensionSpecificiationsFromPlugins,
   loadFunctionSpecificationsFromPlugins,
 } from '../../private/plugins/extension.js'
-import {path, environment} from '@shopify/cli-kit'
+import {path} from '@shopify/cli-kit'
 import {platformAndArch} from '@shopify/cli-kit/node/os'
 import {memoize} from '@shopify/cli-kit/common/function'
 import {Config} from '@oclif/core'
+import {isShopify} from '@shopify/cli-kit/node/environment/local'
 import {fileURLToPath} from 'url'
 
 export async function loadUIExtensionSpecifications(config: Config): Promise<UIExtensionSpec[]> {
@@ -29,7 +30,7 @@ export async function loadLocalUIExtensionsSpecifications(): Promise<UIExtension
 }
 
 export async function loadLocalFunctionSpecifications(): Promise<FunctionSpec[]> {
-  const isShopifyUser = await environment.local.isShopify()
+  const isShopifyUser = await isShopify()
   return (await memoizedLoadSpecs('function-specifications')).filter((spec) => !spec.gated || isShopifyUser)
 }
 

packages/app/src/cli/prompts/generate/extension.test.ts

@@ -5,23 +5,13 @@ import {
   loadLocalUIExtensionsSpecifications,
 } from '../../models/extensions/specifications.js'
 import {describe, it, expect, vi, beforeEach} from 'vitest'
-import {environment} from '@shopify/cli-kit'
-
-vi.mock('@shopify/cli-kit', async () => {
-  const cliKit: any = await vi.importActual('@shopify/cli-kit')
-  return {
-    ...cliKit,
-    environment: {
-      local: {
-        isShopify: vi.fn(),
-        isUnitTest: vi.fn(() => true),
-      },
-    },
-  }
-})
+import {isShopify, isUnitTest} from '@shopify/cli-kit/node/environment/local'
+
+vi.mock('@shopify/cli-kit/node/environment/local')
 
 beforeEach(() => {
-  vi.mocked(environment.local.isShopify).mockResolvedValue(true)
+  vi.mocked(isShopify).mockResolvedValue(true)
+  vi.mocked(isUnitTest).mockResolvedValue(true)
 })
 
 describe('extension prompt', async () => {

packages/app/src/cli/services/dependencies.ts

@@ -1,6 +1,7 @@
 import {AppInterface} from '../models/app/app.js'
-import {ui, environment} from '@shopify/cli-kit'
+import {ui} from '@shopify/cli-kit'
 import {installNPMDependenciesRecursively} from '@shopify/cli-kit/node/node-package-manager'
+import {isUnitTest} from '@shopify/cli-kit/node/environment/local'
 
 /**
  * Given an app, it installs its NPM dependencies by traversing
@@ -24,7 +25,7 @@ export async function installAppDependencies(app: AppInterface) {
         },
       },
     ],
-    {rendererSilent: environment.local.isUnitTest()},
+    {rendererSilent: isUnitTest()},
   )
   await list.run()
   await app.updateDependencies()

packages/app/src/cli/services/deploy.ts

@@ -15,7 +15,8 @@ import {Extension} from '../models/app/extensions.js'
 import {validateExtensions} from '../validators/extensions.js'
 import {OrganizationApp} from '../models/organization.js'
 import {AllAppExtensionRegistrationsQuerySchema} from '../api/graphql/all_app_extension_registrations.js'
-import {path, output, file, environment} from '@shopify/cli-kit'
+import {path, output, file} from '@shopify/cli-kit'
+import {useThemeBundling} from '@shopify/cli-kit/node/environment/local'
 
 interface DeployOptions {
   /** The app to be built and uploaded */
@@ -55,7 +56,7 @@ export const deploy = async (options: DeployOptions) => {
       }
     }),
   )
-  if (environment.local.useThemeBundling()) {
+  if (useThemeBundling()) {
     const themeExtensions = await Promise.all(
       options.app.extensions.theme.map(async (extension) => {
         return {
@@ -93,7 +94,7 @@ export const deploy = async (options: DeployOptions) => {
         validationErrors = await uploadUIExtensionsBundle({apiKey, bundlePath, extensions, token})
       }
 
-      if (!environment.local.useThemeBundling()) {
+      if (!useThemeBundling()) {
         await uploadThemeExtensions(options.app.extensions.theme, {apiKey, identifiers, token})
       }
       identifiers = await uploadFunctionExtensions(app.extensions.function, {identifiers, token})

packages/app/src/cli/services/dev/select-store.test.ts

@@ -3,10 +3,10 @@ import {fetchAllDevStores} from './fetch.js'
 import {Organization, OrganizationStore} from '../../models/organization.js'
 import {reloadStoreListPrompt, selectStorePrompt} from '../../prompts/dev.js'
 import {beforeEach, describe, expect, it, vi} from 'vitest'
-import {environment} from '@shopify/cli-kit'
 import {partnersRequest} from '@shopify/cli-kit/node/api/partners'
 import {ensureAuthenticatedPartners} from '@shopify/cli-kit/node/session'
 import {isSpinEnvironment} from '@shopify/cli-kit/node/environment/spin'
+import {firstPartyDev} from '@shopify/cli-kit/node/environment/local'
 
 const ORG1: Organization = {id: '1', businessName: 'org1', appsNext: true}
 const STORE1: OrganizationStore = {
@@ -39,6 +39,7 @@ const STORE3: OrganizationStore = {
 beforeEach(() => {
   vi.mock('../../prompts/dev')
   vi.mock('./fetch')
+  vi.mock('@shopify/cli-kit/node/environment/local')
   vi.mock('@shopify/cli-kit/node/system')
   vi.mock('@shopify/cli-kit/node/api/partners')
   vi.mock('@shopify/cli-kit/node/session')
@@ -52,15 +53,6 @@ beforeEach(() => {
       http: {
         fetch: vi.fn(),
       },
-      environment: {
-        local: {
-          firstPartyDev: vi.fn(),
-          isUnitTest: vi.fn(() => true),
-        },
-        fqdn: {
-          partnersFqdn: vi.fn(),
-        },
-      },
     }
   })
 })
@@ -95,7 +87,7 @@ describe('selectStore', async () => {
     // Given
     vi.mocked(selectStorePrompt).mockResolvedValueOnce(STORE2)
     vi.mocked(isSpinEnvironment).mockReturnValue(true)
-    vi.mocked(environment.local.firstPartyDev).mockReturnValue(true)
+    vi.mocked(firstPartyDev).mockReturnValue(true)
 
     // When
     const got = await selectStore([STORE1, STORE2], ORG1, 'token')

packages/app/src/cli/services/dev/select-store.ts

@@ -6,11 +6,12 @@ import {
   ConvertDevToTestStoreSchema,
   ConvertDevToTestStoreVariables,
 } from '../../api/graphql/convert_dev_to_test_store.js'
-import {error, output, ui, environment} from '@shopify/cli-kit'
+import {error, output, ui} from '@shopify/cli-kit'
 import {partnersRequest} from '@shopify/cli-kit/node/api/partners'
 import {sleep} from '@shopify/cli-kit/node/system'
 import {isSpinEnvironment} from '@shopify/cli-kit/node/environment/spin'
 import {partnersFqdn} from '@shopify/cli-kit/node/environment/fqdn'
+import {firstPartyDev, isUnitTest} from '@shopify/cli-kit/node/environment/local'
 
 const CreateStoreLink = async (orgId: string) => {
   const url = `https://${await partnersFqdn()}/${orgId}/stores/new?store_type=dev_store`
@@ -82,7 +83,7 @@ async function waitForCreatedStore(orgId: string, token: string): Promise<Organi
         },
       },
     ],
-    {rendererSilent: environment.local.isUnitTest()},
+    {rendererSilent: isUnitTest()},
   )
   await list.run()
 
@@ -107,7 +108,7 @@ export async function convertToTestStoreIfNeeded(
   /**
    * Is not possible to convert stores to dev ones in spin environmets. Should be created directly as development.
    */
-  if (isSpinEnvironment() && environment.local.firstPartyDev()) return
+  if (isSpinEnvironment() && firstPartyDev()) return
   if (!store.transferDisabled && !store.convertableToPartnerTest) {
     throw new error.Abort(
       `The store you specified (${store.shopDomain}) is not a dev store`,

packages/app/src/cli/services/dev/urls.test.ts

@@ -12,14 +12,15 @@ import {testApp} from '../../models/app/app.test-data.js'
 import {UpdateURLsQuery} from '../../api/graphql/update_urls.js'
 import {GetURLsQuery} from '../../api/graphql/get_urls.js'
 import {beforeEach, describe, expect, it, vi} from 'vitest'
-import {environment, error, outputMocker, plugins, store, ui} from '@shopify/cli-kit'
+import {error, outputMocker, plugins, store, ui} from '@shopify/cli-kit'
 import {Config} from '@oclif/core'
 import {err, ok} from '@shopify/cli-kit/node/result'
 import {AbortSilentError, BugError} from '@shopify/cli-kit/node/error'
 import {getAvailableTCPPort} from '@shopify/cli-kit/node/tcp'
 import {partnersRequest} from '@shopify/cli-kit/node/api/partners'
 import {ensureAuthenticatedPartners} from '@shopify/cli-kit/node/session'
 import {isSpin, spinFqdn} from '@shopify/cli-kit/node/environment/spin'
+import {codespaceURL, gitpodURL, isUnitTest} from '@shopify/cli-kit/node/environment/local'
 
 beforeEach(() => {
   vi.mock('@shopify/cli-kit/node/tcp')
@@ -28,6 +29,8 @@ beforeEach(() => {
   vi.mock('@shopify/cli-kit/node/session')
   vi.mocked(ensureAuthenticatedPartners).mockResolvedValue('token')
   vi.mock('@shopify/cli-kit/node/environment/spin')
+  vi.mock('@shopify/cli-kit/node/environment/local')
+  vi.mocked(isUnitTest).mockReturnValue(true)
   vi.mock('@shopify/cli-kit', async () => {
     const cliKit: any = await vi.importActual('@shopify/cli-kit')
     return {
@@ -42,12 +45,6 @@ beforeEach(() => {
       store: {
         setAppInfo: vi.fn(),
       },
-      environment: {
-        local: {
-          codespaceURL: vi.fn(),
-          gitpodURL: vi.fn(),
-        },
-      },
     }
   })
 })
@@ -468,7 +465,7 @@ describe('generateFrontendURL', () => {
 
   it('Returns a gitpod url if we are in a gitpod environment', async () => {
     // Given
-    vi.mocked(environment.local.gitpodURL).mockReturnValue('https://gitpod.url.fqdn.com')
+    vi.mocked(gitpodURL).mockReturnValue('https://gitpod.url.fqdn.com')
     const options = {
       app: testApp({hasUIExtensions: () => false}),
       tunnel: false,
@@ -487,7 +484,7 @@ describe('generateFrontendURL', () => {
 
   it('Returns a codespace url if we are in a codespace environment', async () => {
     // Given
-    vi.mocked(environment.local.codespaceURL).mockReturnValue('codespace.url.fqdn.com')
+    vi.mocked(codespaceURL).mockReturnValue('codespace.url.fqdn.com')
     const options = {
       app: testApp({hasUIExtensions: () => false}),
       tunnel: false,

packages/app/src/cli/services/dev/urls.ts

@@ -2,13 +2,14 @@ import {updateURLsPrompt} from '../../prompts/dev.js'
 import {AppInterface} from '../../models/app/app.js'
 import {UpdateURLsQuery, UpdateURLsQuerySchema, UpdateURLsQueryVariables} from '../../api/graphql/update_urls.js'
 import {GetURLsQuery, GetURLsQuerySchema, GetURLsQueryVariables} from '../../api/graphql/get_urls.js'
-import {environment, output, plugins, store} from '@shopify/cli-kit'
+import {output, plugins, store} from '@shopify/cli-kit'
 import {AbortError, AbortSilentError, BugError} from '@shopify/cli-kit/node/error'
 import {Config} from '@oclif/core'
 import {getAvailableTCPPort} from '@shopify/cli-kit/node/tcp'
 import {isValidURL} from '@shopify/cli-kit/common/url'
 import {partnersRequest} from '@shopify/cli-kit/node/api/partners'
 import {isSpin, spinFqdn} from '@shopify/cli-kit/node/environment/spin'
+import {codespaceURL, gitpodURL} from '@shopify/cli-kit/node/environment/local'
 
 export interface PartnersURLs {
   applicationUrl: string
@@ -54,13 +55,13 @@ export async function generateFrontendURL(options: FrontendURLOptions): Promise<
 
   const needsTunnel = (hasExtensions || options.tunnel || options.cachedTunnelPlugin) && !options.noTunnel
 
-  if (environment.local.codespaceURL()) {
-    frontendUrl = `https://${environment.local.codespaceURL()}-${frontendPort}.githubpreview.dev`
+  if (codespaceURL()) {
+    frontendUrl = `https://${codespaceURL()}-${frontendPort}.githubpreview.dev`
     return {frontendUrl, frontendPort, usingLocalhost}
   }
 
-  if (environment.local.gitpodURL()) {
-    const defaultUrl = environment.local.gitpodURL()?.replace('https://', '')
+  if (gitpodURL()) {
+    const defaultUrl = gitpodURL()?.replace('https://', '')
     frontendUrl = `https://${frontendPort}-${defaultUrl}`
     return {frontendUrl, frontendPort, usingLocalhost}
   }

packages/app/src/cli/services/environment.ts

@@ -19,11 +19,12 @@ import {Organization, OrganizationApp, OrganizationStore} from '../models/organi
 import metadata from '../metadata.js'
 import {ThemeExtension} from '../models/app/extensions.js'
 import {loadAppName} from '../models/app/loader.js'
-import {error as kitError, output, store, ui, environment, error} from '@shopify/cli-kit'
+import {error as kitError, output, store, ui, error} from '@shopify/cli-kit'
 import {getPackageManager, PackageManager} from '@shopify/cli-kit/node/node-package-manager'
 import {tryParseInt} from '@shopify/cli-kit/common/string'
 import {ensureAuthenticatedPartners} from '@shopify/cli-kit/node/session'
 import {partnersFqdn} from '@shopify/cli-kit/node/environment/fqdn'
+import {isUnitTest} from '@shopify/cli-kit/node/environment/local'
 
 export const InvalidApiKeyErrorMessage = (apiKey: string) => {
   return {
@@ -369,7 +370,7 @@ async function fetchOrgsAppsAndStores(orgId: string, token: string): Promise<Fet
         },
       },
     ],
-    {rendererSilent: environment.local.isUnitTest()},
+    {rendererSilent: isUnitTest()},
   )
   await list.run()
   return data