Merge pull request #6317 from Shopify/08-26-remove_spin_code

Remove spin code

Author: plvaldes

bin/docs/build-dev-docs.sh

@@ -15,14 +15,3 @@ eval $COMPILE_DOCS
 eval $COMPILE_STATIC_PAGES
 eval $COMPILE_CATEGORY_PAGES
 echo "DONE"
-
-if [ -n "$SPIN" ]; then
-  if [ -n "$SPIN_SHOPIFY_DEV_SERVICE_FQDN" ]; then
-    cp ./docs-shopify.dev/static/generated/* ~/src/github.com/Shopify/shopify-dev/db/data/docs/templated_apis/shopify-cli/v3/
-    cp ./docs-shopify.dev/static/screenshots/* ~/src/github.com/Shopify/shopify-dev/app/assets/images/templated-apis-screenshots/shopify-cli/v3/
-  else
-    echo "If you include shopify-dev in your Spin constellation, this will automatically copy ./docs-shopify.dev/generated to shopify-dev"
-  fi
-else
-  echo "Not copying docs to shopify-dev because we're not in Spin"
-fi

bin/get-graphql-schemas.js

@@ -165,32 +165,6 @@ async function fetchFiles() {
   }
 }
 
-/**
- * @returns {Promise<void>}
- */
-async function fetchFilesFromSpin() {
-  for (const schema of schemas) {
-    const owner = schema.owner
-    const repoName = schema.repo
-
-    const remotePath = `~/src/github.com/${owner}/${repoName}/${schema.pathToFile}`
-    const localPath = schema.localPath
-    try {
-      await runCommand('spin', ['copy', `${process.env.SPIN_INSTANCE}:${remotePath}`, localPath])
-    } catch(e) {
-      if (e.message.match(/scp.*No such file or directory/)) {
-        // Assume we need to just fetch the file from GitHub
-        console.log(`Cannot find file for ${schema.repo} in Spin, fetching from GitHub instead...`)
-        await withOctokit(schema.owner, async (octokit) => {
-          await fetchFileForSchema(schema, octokit)
-        })
-      } else {
-        throw e
-      }
-    }
-  }
-}
-
 /**
  * @returns {Promise<void>}
  */
@@ -206,8 +180,6 @@ async function fetchFilesFromLocal() {
 
 if (process.env.SHOPIFY_SERVICE_ENV === 'local') {
   fetchFilesFromLocal()
-} else if (process.env.SHOPIFY_SERVICE_ENV === 'spin') {
-  fetchFilesFromSpin()
 } else {
   fetchFiles()
 }

bin/spin

@@ -55,9 +55,6 @@ commands:
   type-check:
     desc: 'Type-check the project'
     run: pnpm run type-check:affected
-  spin:
-    desc: 'Run commands in spin context'
-    run: bin/spin
 
 check:
   type-check: pnpm nx affected --target=type-check

dev.yml

@@ -3,11 +3,9 @@ import {testUIExtension} from '../../../../models/app/app.test-data.js'
 import {ExtensionInstance} from '../../../../models/extensions/extension-instance.js'
 import {ExtensionsPayloadStoreOptions} from '../payload/store.js'
 import {describe, expect, test, vi} from 'vitest'
-import {isSpinEnvironment} from '@shopify/cli-kit/node/context/spin'
 
 vi.mock('@shopify/cli-kit/node/context/local')
 vi.mock('@shopify/cli-kit/node/system')
-vi.mock('@shopify/cli-kit/node/context/spin')
 
 describe('getRedirectURL()', () => {
   test('returns a URL with a URL param', async () => {
@@ -134,8 +132,7 @@ describe('getExtensionPointRedirectUrl()', () => {
     )
   })
 
-  test('returns customer account URL on shopify.com if the target is a customer account target and env is not spin', () => {
-    vi.mocked(isSpinEnvironment).mockReturnValue(false)
+  test('returns customer account URL on shopify.com if the target is a customer account target', () => {
     const extension = {
       devUUID: '123abc',
     } as ExtensionInstance
@@ -154,28 +151,7 @@ describe('getExtensionPointRedirectUrl()', () => {
     )
   })
 
-  test('returns customer account URL on a spin shopify domain if it is in a spin env', () => {
-    vi.mocked(isSpinEnvironment).mockReturnValue(true)
-    const extension = {
-      devUUID: '123abc',
-    } as ExtensionInstance
-
-    const options = {
-      storeFqdn: 'shop1.shopify.spin-instance.us.spin.dev',
-      storeId: '123456789',
-      url: 'https://localhost:8081',
-      id: 123,
-    } as unknown as ExtensionsPayloadStoreOptions
-
-    const result = getExtensionPointRedirectUrl('customer-account.page.render', extension, options)
-
-    expect(result).toBe(
-      'https://shopify.spin-instance.us.spin.dev/123456789/account/extensions-development?origin=https%3A%2F%2Flocalhost%3A8081%2Fextensions&extensionId=123abc&source=CUSTOMER_ACCOUNT_EXTENSION&appId=123&target=customer-account.page.render',
-    )
-  })
-
-  test('returns customer account URL on shopify.com if the extension point uses legacy customer account target and env is not spin', () => {
-    vi.mocked(isSpinEnvironment).mockReturnValue(false)
+  test('returns customer account URL on shopify.com if the extension point uses legacy customer account target', () => {
     const extension = {
       devUUID: '123abc',
     } as ExtensionInstance

packages/app/src/cli/services/dev/extension/server/utilities.test.ts

@@ -3,7 +3,6 @@ import {getUIExtensionResourceURL} from '../../../../utilities/extensions/config
 import {getExtensionPointTargetSurface} from '../utilities.js'
 import {ExtensionsPayloadStoreOptions} from '../payload/store.js'
 import {createError, H3Error, ServerResponse, sendError as h3SendError} from 'h3'
-import {isSpinEnvironment} from '@shopify/cli-kit/node/context/spin'
 
 export function getRedirectUrl(extension: ExtensionInstance, options: ExtensionsPayloadStoreOptions): string {
   const {url: resourceUrl} = getUIExtensionResourceURL(extension.type, options)
@@ -85,8 +84,7 @@ function getCustomerAccountsRedirectUrl(
 ): URL {
   const origin = `${options.url}/extensions`
   const storeId = options.storeId
-  const [_, ...storeDomainParts] = options.storeFqdn.split('.')
-  const customerAccountHost = isSpinEnvironment() ? storeDomainParts.join('.') : 'shopify.com'
+  const customerAccountHost = 'shopify.com'
   const rawUrl = new URL(`https://${customerAccountHost}/${storeId}/account/extensions-development`)
 
   rawUrl.searchParams.append('origin', origin)

packages/app/src/cli/services/dev/extension/server/utilities.ts

@@ -3,7 +3,6 @@ import {frontAndBackendConfig} from './utils.js'
 import {Web, WebType} from '../../../models/app/app.js'
 import {isWebType} from '../../../models/app/loader.js'
 import {AbortSignal} from '@shopify/cli-kit/node/abort'
-import {isSpinEnvironment, spinFqdn} from '@shopify/cli-kit/node/context/spin'
 import {getAvailableTCPPort} from '@shopify/cli-kit/node/tcp'
 import {exec} from '@shopify/cli-kit/node/system'
 import {isVerbose} from '@shopify/cli-kit/node/context/local'
@@ -50,7 +49,7 @@ export async function setupWebProcesses({
   const {frontendConfig} = frontAndBackendConfig(webs)
 
   const hmrServerPort = frontendConfig?.configuration.hmr_server ? await getAvailableTCPPort() : undefined
-  const shopCustomDomain = isSpinEnvironment() ? `shopify.${await spinFqdn()}` : undefined
+  const shopCustomDomain = undefined
 
   const webProcessSetups = webs.map(async (web) => {
     const port = await getWebProcessPort({web, frontendPort, backendPort})

packages/app/src/cli/services/dev/processes/web.ts

@@ -7,15 +7,12 @@ import {
 } from '../../prompts/dev.js'
 import {testDeveloperPlatformClient} from '../../models/app/app.test-data.js'
 import {ClientName} from '../../utilities/developer-platform-client.js'
-import {beforeEach, describe, expect, vi, test} from 'vitest'
-import {isSpinEnvironment} from '@shopify/cli-kit/node/context/spin'
-import {firstPartyDev} from '@shopify/cli-kit/node/context/local'
+import {describe, expect, vi, test} from 'vitest'
 
 vi.mock('../../prompts/dev')
 vi.mock('./fetch')
 vi.mock('@shopify/cli-kit/node/context/local')
 vi.mock('@shopify/cli-kit/node/system')
-vi.mock('@shopify/cli-kit/node/context/spin')
 
 const ORG1: Organization = {
   id: '1',
@@ -54,10 +51,6 @@ const STORE3: OrganizationStore = {
 
 const defaultShowDomainOnPrompt = false
 
-beforeEach(() => {
-  vi.mocked(isSpinEnvironment).mockReturnValue(false)
-})
-
 describe('selectStore', async () => {
   test('prompts user to select', async () => {
     // Given
@@ -145,27 +138,6 @@ describe('selectStore', async () => {
     expect(confirmConversionToTransferDisabledStorePrompt).toHaveBeenCalled()
   })
 
-  test('not prompts user to convert store to non-transferable if selection is invalid inside spin instance and first party', async () => {
-    // Given
-    vi.mocked(selectStorePrompt).mockResolvedValueOnce(STORE2)
-    vi.mocked(isSpinEnvironment).mockReturnValue(true)
-    vi.mocked(firstPartyDev).mockReturnValue(true)
-    const developerPlatformClient = testDeveloperPlatformClient({clientName: ClientName.Partners})
-
-    // When
-    const got = await selectStore({stores: [STORE1, STORE2], hasMorePages: false}, ORG1, developerPlatformClient)
-
-    // Then
-    expect(got).toEqual(STORE2)
-    expect(developerPlatformClient.convertToTransferDisabledStore).not.toHaveBeenCalled()
-    expect(selectStorePrompt).toHaveBeenCalledWith(
-      expect.objectContaining({
-        stores: [STORE1, STORE2],
-        showDomainOnPrompt: defaultShowDomainOnPrompt,
-      }),
-    )
-  })
-
   test('throws if store is non convertible', async () => {
     // Given
     vi.mocked(selectStorePrompt).mockResolvedValueOnce(STORE3)

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

@@ -130,11 +130,6 @@ export async function convertToTransferDisabledStoreIfNeeded(
   developerPlatformClient: DeveloperPlatformClient,
   conversionMode: 'prompt-first' | 'never',
 ): Promise<boolean> {
-  /**
-   * It's not possible to convert stores to dev ones in spin environments. Should be created directly as development.
-   * Against production (!isSpinEnvironment()), this allows you to reference other shops in a TOML file even if some of
-   * the dev experience isn't completely supported.
-   */
   if (store.transferDisabled || firstPartyDev()) return true
 
   if (!store.transferDisabled && !store.convertableToPartnerTest) {

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

@@ -19,8 +19,7 @@ import {setManyAppConfigValues} from '../app/patch-app-configuration-file.js'
 import {AppLinkedInterface} from '../../models/app/app.js'
 import {beforeEach, describe, expect, vi, test} from 'vitest'
 import {AbortError} from '@shopify/cli-kit/node/error'
-import {checkPortAvailability, getAvailableTCPPort} from '@shopify/cli-kit/node/tcp'
-import {isSpin, spinFqdn, appPort, appHost, fetchSpinPort} from '@shopify/cli-kit/node/context/spin'
+import {getAvailableTCPPort} from '@shopify/cli-kit/node/tcp'
 import {codespacePortForwardingDomain, codespaceURL, gitpodURL, isUnitTest} from '@shopify/cli-kit/node/context/local'
 import {renderConfirmationPrompt, renderSelectPrompt} from '@shopify/cli-kit/node/ui'
 import {terminalSupportsPrompting} from '@shopify/cli-kit/node/system'
@@ -32,7 +31,6 @@ vi.mock('../app/patch-app-configuration-file.js', () => {
   }
 })
 vi.mock('@shopify/cli-kit/node/tcp')
-vi.mock('@shopify/cli-kit/node/context/spin')
 vi.mock('@shopify/cli-kit/node/context/local')
 vi.mock('@shopify/cli-kit/node/plugins')
 vi.mock('@shopify/cli-kit/node/ui')
@@ -487,96 +485,6 @@ describe('generateFrontendURL', () => {
     expect(setCachedAppInfo).not.toBeCalled()
     expect(renderSelectPrompt).not.toBeCalled()
   })
-
-  test('Returns a cli spin url if we are in a spin environment running the cli manually', async () => {
-    // Given
-    vi.mocked(isSpin).mockReturnValue(true)
-    vi.mocked(spinFqdn).mockResolvedValue('spin.domain.dev')
-    vi.mocked(appPort).mockReturnValue(undefined)
-    vi.mocked(fetchSpinPort).mockResolvedValue(4040)
-
-    // When
-    const got = await generateFrontendURL(defaultOptions)
-
-    // Then
-    expect(got).toEqual({
-      frontendUrl: 'https://cli.spin.domain.dev',
-      frontendPort: 4040,
-      usingLocalhost: false,
-    })
-    expect(setCachedAppInfo).not.toBeCalled()
-    expect(renderSelectPrompt).not.toBeCalled()
-  })
-
-  test('Returns a 1p app spin url if we are in a spin environment running the cli as service', async () => {
-    // Given
-    vi.mocked(isSpin).mockReturnValue(true)
-    vi.mocked(appPort).mockReturnValue(1234)
-    vi.mocked(appHost).mockReturnValue('1p-app-host.spin.domain.dev')
-    vi.mocked(checkPortAvailability).mockResolvedValue(true)
-
-    // When
-    const got = await generateFrontendURL(defaultOptions)
-
-    // Then
-    expect(got).toEqual({
-      frontendUrl: 'https://1p-app-host.spin.domain.dev',
-      frontendPort: 1234,
-      usingLocalhost: false,
-    })
-    expect(setCachedAppInfo).not.toBeCalled()
-    expect(renderSelectPrompt).not.toBeCalled()
-  })
-
-  test('Returns a cli spin url if we are in a spin environment running the cli manually with a 1p app backend running as service', async () => {
-    // Given
-    vi.mocked(isSpin).mockReturnValue(true)
-    vi.mocked(appPort).mockReturnValue(1234)
-    vi.mocked(spinFqdn).mockResolvedValue('spin.domain.dev')
-    vi.mocked(checkPortAvailability).mockResolvedValue(false)
-    vi.mocked(fetchSpinPort).mockResolvedValue(4040)
-
-    // When
-    const got = await generateFrontendURL(defaultOptions)
-
-    // Then
-    expect(got).toEqual({
-      frontendUrl: 'https://cli.spin.domain.dev',
-      frontendPort: 4040,
-      usingLocalhost: false,
-    })
-    expect(setCachedAppInfo).not.toBeCalled()
-    expect(renderSelectPrompt).not.toBeCalled()
-  })
-
-  test('Returns an error if we are in a spin environment with a 1p app backend is running as service and the partners port is not configured', async () => {
-    // Given
-    vi.mocked(isSpin).mockReturnValue(true)
-    vi.mocked(appPort).mockReturnValue(1234)
-    vi.mocked(spinFqdn).mockResolvedValue('spin.domain.dev')
-    vi.mocked(checkPortAvailability).mockResolvedValue(false)
-    vi.mocked(fetchSpinPort).mockResolvedValue(undefined)
-
-    // When
-    const got = generateFrontendURL(defaultOptions)
-
-    // Then
-    await expect(got).rejects.toThrow(
-      'Error building cli url in spin, cli as service port: 1234, manual cli port: undefined',
-    )
-  })
-
-  test('Returns a custom tunnel url if we are in a spin environment but a custom tunnel option is active', async () => {
-    // Given
-    vi.mocked(isSpin).mockReturnValue(true)
-    const options = {...defaultOptions, tunnelUrl: 'https://my-tunnel-provider.io:4242'}
-
-    // When
-    const got = await generateFrontendURL(options)
-
-    // Then
-    expect(got).toEqual({frontendUrl: 'https://my-tunnel-provider.io', frontendPort: 4242, usingLocalhost: false})
-  })
 })
 
 describe('generatePartnersURLs', () => {