Merge pull request #5244 from Shopify/01-21-rename_partnersurls_to_applicationurls

Rename PartnersURLs to ApplicationURLs

Author: isaacroldan

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

@@ -1,8 +1,8 @@
 import {
   FrontendURLOptions,
-  PartnersURLs,
+  ApplicationURLs,
   generateFrontendURL,
-  generatePartnersURLs,
+  generateApplicationURLs,
   getURLs,
   shouldOrPromptUpdateURLs,
   startTunnelPlugin,
@@ -249,7 +249,7 @@ async function handleUpdatingOfPartnerUrls(
   commandSpecifiedToUpdate: boolean,
   network: {
     proxyUrl: string
-    currentUrls: PartnersURLs
+    currentUrls: ApplicationURLs
   },
   localApp: AppLinkedInterface,
   cachedUpdateURLs: boolean | undefined,
@@ -261,7 +261,7 @@ async function handleUpdatingOfPartnerUrls(
   let shouldUpdateURLs = false
   if (frontendConfig ?? backendConfig) {
     if (commandSpecifiedToUpdate) {
-      const newURLs = generatePartnersURLs(
+      const newURLs = generateApplicationURLs(
         network.proxyUrl,
         webs.map(({configuration}) => configuration.auth_callback_path).find((path) => path),
         localApp.configuration.app_proxy,

packages/app/src/cli/services/dev/processes/setup-dev-processes.ts

@@ -15,7 +15,7 @@ import {OrganizationApp} from '../../../models/organization.js'
 import {DevOptions} from '../../dev.js'
 import {getProxyingWebServer} from '../../../utilities/app/http-reverse-proxy.js'
 import {buildAppURLForWeb} from '../../../utilities/app/app-url.js'
-import {PartnersURLs} from '../urls.js'
+import {ApplicationURLs} from '../urls.js'
 import {DeveloperPlatformClient} from '../../../utilities/developer-platform-client.js'
 import {AppEventWatcher} from '../app-events/app-event-watcher.js'
 import {reloadApp} from '../../../models/app/loader.js'
@@ -46,7 +46,7 @@ interface DevNetworkOptions {
   proxyUrl: string
   frontendPort: number
   backendPort: number
-  currentUrls: PartnersURLs
+  currentUrls: ApplicationURLs
 }
 
 export interface DevConfig {

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

@@ -2,9 +2,9 @@ import {
   updateURLs,
   shouldOrPromptUpdateURLs,
   generateFrontendURL,
-  generatePartnersURLs,
-  PartnersURLs,
-  validatePartnersURLs,
+  generateApplicationURLs,
+  ApplicationURLs,
+  validateApplicationURLs,
   FrontendURLOptions,
 } from './urls.js'
 import {
@@ -557,7 +557,7 @@ describe('generatePartnersURLs', () => {
   test('Returns the default values without an override', () => {
     const applicationUrl = 'http://my-base-url'
 
-    const got = generatePartnersURLs(applicationUrl)
+    const got = generateApplicationURLs(applicationUrl)
 
     expect(got).toMatchObject({
       applicationUrl,
@@ -573,7 +573,7 @@ describe('generatePartnersURLs', () => {
     const applicationUrl = 'http://my-base-url'
     const overridePath = '/my/custom/path'
 
-    const got = generatePartnersURLs(applicationUrl, overridePath)
+    const got = generateApplicationURLs(applicationUrl, overridePath)
 
     expect(got).toMatchObject({
       applicationUrl,
@@ -585,7 +585,7 @@ describe('generatePartnersURLs', () => {
     const applicationUrl = 'http://my-base-url'
     const overridePath = ['/my/custom/path1', '/my/custom/path2']
 
-    const got = generatePartnersURLs(applicationUrl, overridePath)
+    const got = generateApplicationURLs(applicationUrl, overridePath)
 
     expect(got).toMatchObject({
       applicationUrl,
@@ -596,7 +596,7 @@ describe('generatePartnersURLs', () => {
   test('Returns app proxy section when receiving proxy fields', () => {
     const applicationUrl = 'http://my-base-url'
 
-    const got = generatePartnersURLs(applicationUrl, [], {
+    const got = generateApplicationURLs(applicationUrl, [], {
       url: applicationUrl,
       subpath: 'subpath',
       prefix: 'prefix',
@@ -621,7 +621,7 @@ describe('generatePartnersURLs', () => {
     const applicationUrl = 'http://my-base-url'
     const proxyUrl = 'http://old-base-url/subpath'
 
-    const got = generatePartnersURLs(applicationUrl, [], {
+    const got = generateApplicationURLs(applicationUrl, [], {
       url: proxyUrl,
       subpath: 'subpath',
       prefix: 'prefix',
@@ -648,47 +648,47 @@ describe('validatePartnersURLs', () => {
     // Given
     const applicationUrl = 'http://example.com'
     const redirectUrlWhitelist = ['http://example.com/callback1', 'http://example.com/callback2']
-    const urls: PartnersURLs = {
+    const urls: ApplicationURLs = {
       applicationUrl,
       redirectUrlWhitelist,
       appProxy: {proxyUrl: applicationUrl, proxySubPath: '', proxySubPathPrefix: ''},
     }
 
     // When/Then
-    validatePartnersURLs(urls)
+    validateApplicationURLs(urls)
   })
 
   test('it raises an error when the application URL is not valid', () => {
     // Given
     const applicationUrl = 'wrong'
     const redirectUrlWhitelist = ['http://example.com/callback1', 'http://example.com/callback2']
-    const urls: PartnersURLs = {applicationUrl, redirectUrlWhitelist}
+    const urls: ApplicationURLs = {applicationUrl, redirectUrlWhitelist}
 
     // When/Then
-    expect(() => validatePartnersURLs(urls)).toThrow(/Invalid application URL/)
+    expect(() => validateApplicationURLs(urls)).toThrow(/Invalid application URL/)
   })
 
   test('it raises an error when the redirection URLs are not valid', () => {
     // Given
     const applicationUrl = 'http://example.com'
     const redirectUrlWhitelist = ['http://example.com/callback1', 'wrong']
-    const urls: PartnersURLs = {applicationUrl, redirectUrlWhitelist}
+    const urls: ApplicationURLs = {applicationUrl, redirectUrlWhitelist}
 
     // When/Then
-    expect(() => validatePartnersURLs(urls)).toThrow(/Invalid redirection URLs/)
+    expect(() => validateApplicationURLs(urls)).toThrow(/Invalid redirection URLs/)
   })
 
   test('it raises an error when the app proxy URL is not valid', () => {
     // Given
     const applicationUrl = 'http://example.com'
     const redirectUrlWhitelist = ['http://example.com/callback1', 'http://example.com/callback2']
-    const urls: PartnersURLs = {
+    const urls: ApplicationURLs = {
       applicationUrl,
       redirectUrlWhitelist,
       appProxy: {proxyUrl: 'wrong', proxySubPath: '', proxySubPathPrefix: ''},
     }
 
     // When/Then
-    expect(() => validatePartnersURLs(urls)).toThrow(/Invalid app proxy URL/)
+    expect(() => validateApplicationURLs(urls)).toThrow(/Invalid app proxy URL/)
   })
 })

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

@@ -22,7 +22,7 @@ interface AppProxy {
   proxySubPathPrefix: string
 }
 
-export interface PartnersURLs {
+export interface ApplicationURLs {
   applicationUrl: string
   redirectUrlWhitelist: string[]
   appProxy?: AppProxy
@@ -138,11 +138,11 @@ async function pollTunnelURL(tunnelClient: TunnelClient): Promise<string> {
   })
 }
 
-export function generatePartnersURLs(
+export function generateApplicationURLs(
   baseURL: string,
   authCallbackPath?: string | string[],
   proxyFields?: CurrentAppConfiguration['app_proxy'],
-): PartnersURLs {
+): ApplicationURLs {
   let redirectUrlWhitelist: string[]
   if (authCallbackPath && authCallbackPath.length > 0) {
     const authCallbackPaths = Array.isArray(authCallbackPath) ? authCallbackPath : [authCallbackPath]
@@ -185,7 +185,7 @@ function replaceHost(oldUrl: string, newUrl: string): string {
 }
 
 export async function updateURLs(
-  urls: PartnersURLs,
+  urls: ApplicationURLs,
   apiKey: string,
   developerPlatformClient: DeveloperPlatformClient,
   localApp?: AppConfigurationInterface,
@@ -218,8 +218,8 @@ export async function updateURLs(
   }
 }
 
-export async function getURLs(remoteAppConfig?: AppConfigurationUsedByCli): Promise<PartnersURLs> {
-  const result: PartnersURLs = {
+export async function getURLs(remoteAppConfig?: AppConfigurationUsedByCli): Promise<ApplicationURLs> {
+  const result: ApplicationURLs = {
     applicationUrl: remoteAppConfig?.application_url ?? '',
     redirectUrlWhitelist: remoteAppConfig?.auth?.redirect_urls ?? [],
   }
@@ -234,7 +234,7 @@ export async function getURLs(remoteAppConfig?: AppConfigurationUsedByCli): Prom
 }
 
 interface ShouldOrPromptUpdateURLsOptions {
-  currentURLs: PartnersURLs
+  currentURLs: ApplicationURLs
   appDirectory: string
   cachedUpdateURLs?: boolean
   newApp?: boolean
@@ -269,7 +269,7 @@ export async function shouldOrPromptUpdateURLs(options: ShouldOrPromptUpdateURLs
   return shouldUpdateURLs
 }
 
-export function validatePartnersURLs(urls: PartnersURLs): void {
+export function validateApplicationURLs(urls: ApplicationURLs): void {
   if (!isValidURL(urls.applicationUrl))
     throw new AbortError(`Invalid application URL: ${urls.applicationUrl}`, 'Valid format: "https://example.com"')