Remove ngrok plugin and references

chintalp0910 · Jul 10, 2023 · 6e0d872 · 6e0d872
1 parent 45f52b1
commit 6e0d872
Show file tree

Hide file tree

Showing 37 changed files with 35 additions and 1,386 deletions.
diff --git a/.changeset/config.json b/.changeset/config.json
@@ -10,7 +10,6 @@
     "@shopify/cli-kit",
     "@shopify/theme",
     "@shopify/ui-extensions-dev-console-app",
-    "@shopify/plugin-ngrok",
     "@shopify/plugin-cloudflare",
     "@shopify/plugin-did-you-mean"
   ]],

diff --git a/.changeset/nervous-gorillas-jam.md b/.changeset/nervous-gorillas-jam.md
@@ -0,0 +1,8 @@
+---
+'@shopify/plugin-cloudflare': minor
+'@shopify/create-app': minor
+'@shopify/app': minor
+'@shopify/cli': minor
+---
+
+Remove ngrok plugin
diff --git a/docs/README.md b/docs/README.md
@@ -32,14 +32,6 @@ The [`@shopify/cli-kit`](https://www.npmjs.com/package/@shopify/cli-kit) NPM pac
 - [Using UI Kit](cli-kit/ui-kit/readme.md)
 - [Contributing to UI Kit](cli-kit/ui-kit/contributing.md)
 
-## Plugins
-
-[Plugins](./cli/plugins.md) are NPM packages that extend, customize, and augment core CLI functionality. Some plugins are developed by Shopify (included in the list below), and we refer to them as official plugins, while external developers develop others. If you want to develop a plugin, we recommend checking out the resources in the development section below.
-
-### List of official plugins
-
-* [Ngrok tunnel](./plugins/ngrok.md)
-
 ## Decision Record
 
 The following pages document the rationale behind some decisions that we made:

diff --git a/docs/cli/plugins.md b/docs/cli/plugins.md
diff --git a/docs/plugins/ngrok.md b/docs/plugins/ngrok.md
diff --git a/packages/app/oclif.manifest.json b/packages/app/oclif.manifest.json
@@ -285,22 +285,6 @@
             "tunnel"
           ]
         },
-        "tunnel": {
-          "name": "tunnel",
-          "type": "option",
-          "description": "Select the tunnel provider",
-          "hidden": false,
-          "multiple": false,
-          "options": [
-            "cloudflare",
-            "ngrok"
-          ],
-          "exclusive": [
-            "tunnel-url",
-            "no-tunnel"
-          ],
-          "default": "cloudflare"
-        },
         "theme": {
           "name": "theme",
           "type": "option",

diff --git a/packages/app/package.json b/packages/app/package.json
@@ -46,7 +46,6 @@
     "@shopify/cli-kit": "3.47.0",
     "@shopify/function-runner": "4.1.0",
     "@shopify/plugin-cloudflare": "3.47.0",
-    "@shopify/plugin-ngrok": "3.47.0",
     "abort-controller": "3.0.0",
     "chokidar": "3.5.3",
     "diff": "5.1.0",
@@ -91,7 +90,6 @@
       "sensitive_command_metadata": "./dist/cli/hooks/sensitive_metadata"
     },
     "plugins": [
-      "@shopify/plugin-ngrok",
       "@shopify/plugin-cloudflare"
     ]
   }

diff --git a/packages/app/src/cli/api/graphql/find_org_basic.ts b/packages/app/src/cli/api/graphql/find_org_basic.ts
@@ -7,9 +7,6 @@ export const FindOrganizationBasicQuery = gql`
         id
         businessName
         website
-        betas {
-          cliTunnelAlternative
-        }
       }
     }
   }
@@ -21,9 +18,6 @@ export interface FindOrganizationBasicQuerySchema {
       id: string
       businessName: string
       website: string
-      betas: {
-        cliTunnelAlternative?: boolean
-      }
     }[]
   }
 }
diff --git a/packages/app/src/cli/commands/app/dev.ts b/packages/app/src/cli/commands/app/dev.ts
@@ -77,14 +77,6 @@ export default class Dev extends Command {
       default: false,
       exclusive: ['tunnel-url', 'tunnel'],
     }),
-    tunnel: Flags.string({
-      hidden: false,
-      description: 'Select the tunnel provider',
-      env: 'SHOPIFY_FLAG_TUNNEL',
-      default: 'cloudflare',
-      options: ['cloudflare', 'ngrok'],
-      exclusive: ['tunnel-url', 'no-tunnel'],
-    }),
     theme: Flags.string({
       hidden: false,
       char: 't',
@@ -128,7 +120,6 @@ export default class Dev extends Command {
       subscriptionProductUrl: flags['subscription-product-url'],
       checkoutCartUrl: flags['checkout-cart-url'],
       tunnelUrl: flags['tunnel-url'],
-      tunnelProvider: flags.tunnel,
       noTunnel: flags['no-tunnel'],
       theme: flags.theme,
       themeExtensionPort: flags['theme-app-extension-port'],

diff --git a/packages/app/src/cli/models/extensions/specifications/ui_extension.test.ts b/packages/app/src/cli/models/extensions/specifications/ui_extension.test.ts
@@ -149,7 +149,7 @@ Please check the configuration in ${tomlPath}`),
         })
 
         // When
-        const host = 'http://1234.ngrok.io'
+        const host = 'http://1234.cloudflare.io'
         const previewMessage = await uiExtension.previewMessage(host, 'not_used')
 
         // Then

diff --git a/packages/app/src/cli/models/organization.ts b/packages/app/src/cli/models/organization.ts
@@ -2,9 +2,6 @@ export interface Organization {
   id: string
   businessName: string
   website?: string
-  betas?: {
-    cliTunnelAlternative?: boolean
-  }
 }
 
 export interface MinimalOrganizationApp {

diff --git a/packages/app/src/cli/prompts/dev.test.ts b/packages/app/src/cli/prompts/dev.test.ts
@@ -24,12 +24,10 @@ vi.mock('@shopify/cli-kit/node/ui')
 const ORG1: Organization = {
   id: '1',
   businessName: 'org1',
-  betas: {},
 }
 const ORG2: Organization = {
   id: '2',
   businessName: 'org2',
-  betas: {},
 }
 const APP1 = testOrganizationApp({apiKey: 'key1'})
 const APP2 = testOrganizationApp({

diff --git a/packages/app/src/cli/services/context.test.ts b/packages/app/src/cli/services/context.test.ts
@@ -100,13 +100,11 @@ const APP_WITH_UNIFIED_APP_DEPLOYMENTS_BETA: OrganizationApp = {
 const ORG1: Organization = {
   id: '1',
   businessName: 'org1',
-  betas: {cliTunnelAlternative: false},
   website: '',
 }
 const ORG2: Organization = {
   id: '2',
   businessName: 'org2',
-  betas: {cliTunnelAlternative: true},
   website: '',
 }
 
@@ -307,7 +305,6 @@ describe('ensureDevContext', async () => {
         remoteApp: {...APP2, apiSecret: 'secret2'},
         storeFqdn: STORE1.shopDomain,
         remoteAppUpdated: true,
-        useCloudflareTunnels: true,
         updateURLs: true,
         config: CACHED1_WITH_CONFIG.configFile,
         deploymentMode: 'legacy',
@@ -485,7 +482,6 @@ dev_store_url = "domain1"
       remoteApp: {...APP1, apiSecret: 'secret1'},
       storeFqdn: STORE1.shopDomain,
       remoteAppUpdated: true,
-      useCloudflareTunnels: true,
       updateURLs: undefined,
       deploymentMode: 'legacy',
     })
@@ -518,32 +514,12 @@ dev_store_url = "domain1"
       remoteApp: {...APP1, apiSecret: 'secret1'},
       storeFqdn: STORE1.shopDomain,
       remoteAppUpdated: true,
-      useCloudflareTunnels: true,
       updateURLs: undefined,
       deploymentMode: 'legacy',
       config: CACHED1_WITH_CONFIG.configFile,
     })
   })
 
-  test('returns useCloudflareTunnels false if the beta is enabled in partners', async () => {
-    // Given
-    vi.mocked(getAppInfo).mockReturnValue(undefined)
-    vi.mocked(fetchOrgFromId).mockResolvedValueOnce(ORG2)
-
-    // When
-    const got = await ensureDevContext(INPUT, 'token')
-
-    // Then
-    expect(got).toEqual({
-      remoteApp: {...APP1, apiSecret: 'secret1'},
-      storeFqdn: STORE1.shopDomain,
-      remoteAppUpdated: true,
-      useCloudflareTunnels: false,
-      updateURLs: undefined,
-      deploymentMode: 'legacy',
-    })
-  })
-
   test('returns selected data and updates internal state, with cached state', async () => {
     // Given
     vi.mocked(getAppInfo).mockReturnValue({...CACHED1, previousAppId: APP1.apiKey})
@@ -558,7 +534,6 @@ dev_store_url = "domain1"
       remoteApp: {...APP1, apiSecret: 'secret1'},
       storeFqdn: STORE1.shopDomain,
       remoteAppUpdated: false,
-      useCloudflareTunnels: true,
       updateURLs: undefined,
       deploymentMode: 'legacy',
     })
@@ -608,7 +583,6 @@ dev_store_url = "domain1"
       remoteApp: {...APP2, apiSecret: 'secret2'},
       storeFqdn: STORE1.shopDomain,
       remoteAppUpdated: true,
-      useCloudflareTunnels: true,
       updateURLs: undefined,
       deploymentMode: 'legacy',
     })
@@ -666,7 +640,6 @@ dev_store_url = "domain1"
       remoteApp: {...APP_WITH_UNIFIED_APP_DEPLOYMENTS_BETA, apiSecret: 'secret2'},
       storeFqdn: STORE1.shopDomain,
       remoteAppUpdated: true,
-      useCloudflareTunnels: false,
       updateURLs: undefined,
       deploymentMode: 'unified',
     })
@@ -692,7 +665,6 @@ dev_store_url = "domain1"
       remoteApp: {...APP_WITH_UNIFIED_APP_DEPLOYMENTS_BETA, apiSecret: 'secret2'},
       storeFqdn: STORE1.shopDomain,
       remoteAppUpdated: true,
-      useCloudflareTunnels: false,
       updateURLs: undefined,
       deploymentMode: 'unified',
     })

diff --git a/packages/app/src/cli/services/context.ts b/packages/app/src/cli/services/context.ts
@@ -68,7 +68,6 @@ interface DevContextOutput {
   remoteAppUpdated: boolean
   storeFqdn: string
   updateURLs: boolean | undefined
-  useCloudflareTunnels: boolean
   config?: string
   deploymentMode: DeploymentMode
 }
@@ -160,7 +159,6 @@ export async function ensureDevContext(options: DevContextOptions, token: string
 
   let {app: selectedApp, store: selectedStore} = await fetchDevDataFromOptions(options, orgId, token)
   const organization = await fetchOrgFromId(orgId, token)
-  const useCloudflareTunnels = organization.betas?.cliTunnelAlternative !== true
 
   if (!selectedApp || !selectedStore) {
     // if we have selected an app or a dev store from a command flag, we keep them
@@ -217,7 +215,7 @@ export async function ensureDevContext(options: DevContextOptions, token: string
 
   await enableDeveloperPreview(selectedApp, token)
   const deploymentMode = selectedApp.betas?.unifiedAppDeployment ? 'unified' : 'legacy'
-  const result = buildOutput(selectedApp, selectedStore, useCloudflareTunnels, deploymentMode, cachedInfo)
+  const result = buildOutput(selectedApp, selectedStore, deploymentMode, cachedInfo)
   await logMetadataForLoadedDevContext(result)
   return result
 }
@@ -243,7 +241,6 @@ const storeFromFqdn = async (storeFqdn: string, orgId: string, token: string): P
 function buildOutput(
   app: OrganizationApp,
   store: OrganizationStore,
-  useCloudflareTunnels: boolean,
   deploymentMode: DeploymentMode,
   cachedInfo?: CachedAppInfo,
 ): DevContextOutput {
@@ -255,7 +252,6 @@ function buildOutput(
     remoteAppUpdated: app.apiKey !== cachedInfo?.previousAppId,
     storeFqdn: store.shopDomain,
     updateURLs: cachedInfo?.updateURLs,
-    useCloudflareTunnels,
     config: cachedInfo?.configFile,
     deploymentMode,
   }

diff --git a/packages/app/src/cli/services/dev.ts b/packages/app/src/cli/services/dev.ts
@@ -68,7 +68,6 @@ export interface DevOptions {
   subscriptionProductUrl?: string
   checkoutCartUrl?: string
   tunnelUrl?: string
-  tunnelProvider: string
   noTunnel: boolean
   theme?: string
   themeExtensionPort?: number
@@ -81,7 +80,7 @@ async function dev(options: DevOptions) {
 
   let tunnelClient: TunnelClient | undefined
   if (!options.tunnelUrl && !options.noTunnel) {
-    tunnelClient = await startTunnelPlugin(options.commandConfig, tunnelPort, options.tunnelProvider)
+    tunnelClient = await startTunnelPlugin(options.commandConfig, tunnelPort, 'cloudflare')
   }
 
   const token = await ensureAuthenticatedPartners()
@@ -90,17 +89,10 @@ async function dev(options: DevOptions) {
     remoteApp,
     remoteAppUpdated,
     updateURLs: cachedUpdateURLs,
-    useCloudflareTunnels,
     config,
     deploymentMode,
   } = await ensureDevContext(options, token)
 
-  if (!options.tunnelUrl && !options.noTunnel && !useCloudflareTunnels && options.tunnelProvider === 'cloudflare') {
-    // If we can't use cloudflare, stop the previous optimistic tunnel and start a new one
-    tunnelClient?.stopTunnel()
-    tunnelClient = await startTunnelPlugin(options.commandConfig, tunnelPort, 'ngrok')
-  }
-
   const apiKey = remoteApp.apiKey
   const specifications = await fetchSpecifications({token, apiKey, config: options.commandConfig})
 

diff --git a/packages/app/src/cli/services/dev/fetch.test.ts b/packages/app/src/cli/services/dev/fetch.test.ts
@@ -47,7 +47,6 @@ const FETCH_ORG_RESPONSE_VALUE = {
       {
         id: ORG1.id,
         businessName: ORG1.businessName,
-        betas: ORG1.betas,
         apps: {nodes: [APP1, APP2], pageInfo: {hasNextPage: false}},
         stores: {nodes: [STORE1]},
       },
@@ -60,7 +59,6 @@ const FETCH_STORE_RESPONSE_VALUE = {
       {
         id: ORG1.id,
         businessName: ORG1.businessName,
-        betas: ORG1.betas,
         website: ORG1.website,
         stores: {nodes: [STORE1]},
       },
-Original file line number
+Diff line change
@@ Expand Up / @@ -149,7 +149,7 @@ Please check the configuration in ${tomlPath}`), @@
             })
             // When
-            const host = 'http://1234.ngrok.io'
+            const host = 'http://1234.cloudflare.io'
             const previewMessage = await uiExtension.previewMessage(host, 'not_used')
             // Then
@@ Expand Down @@