Merge pull request #6463 from Shopify/jc.windows-on-arm-for-functions

Add support for Windows on ARM for Functions binaries

Author: jeffcharles

.changeset/silly-impalas-unite.md

@@ -0,0 +1,5 @@
+---
+'@shopify/app': patch
+---
+
+Add support for Windows on ARM cpus for Functions binaries

packages/app/src/cli/services/function/binaries.test.ts

@@ -19,6 +19,8 @@ const javy = javyBinary()
 const javyPlugin = javyPluginBinary()
 const functionRunner = functionRunnerBinary()
 
+const oldJavy = javyBinary('6.0.0')
+
 vi.mock('@shopify/cli-kit/node/http', async () => {
   const actualImports = await vi.importActual('@shopify/cli-kit/node/http')
   return {
@@ -30,7 +32,7 @@ vi.mock('@shopify/cli-kit/node/http', async () => {
 describe('javy', () => {
   test('properties are set correctly', () => {
     expect(javy.name).toBe('javy')
-    expect(javy.version).match(/^v\d\.\d\.\d$/)
+    expect(javy.version).match(/^\d\.\d\.\d$/)
     if (process.platform === 'win32') {
       expect(javy.path).toContain(`javy-${PREFERRED_JAVY_VERSION}.exe`)
     } else {
@@ -117,13 +119,23 @@ describe('javy', () => {
       expect(() => javy.downloadUrl('darwin', arch)).toThrowError('Unsupported architecture ppc')
     })
 
-    test('Unsupported combination throws an error', () => {
+    test('Supported combination on preferred Javy succeeds', () => {
+      // When
+      const url = javy.downloadUrl('win32', 'arm')
+
+      // Then
+      expect(url).toMatch(
+        /https:\/\/github.com\/bytecodealliance\/javy\/releases\/download\/v\d\.\d\.\d\/javy-arm-windows-v\d\.\d\.\d\.gz/,
+      )
+    })
+
+    test('Unsupported combination on old Javy throws an error', () => {
       // When
       const arch = 'arm'
       const platform = 'win32'
 
       // Then
-      expect(() => javy.downloadUrl(platform, arch)).toThrowError(
+      expect(() => oldJavy.downloadUrl(platform, arch)).toThrowError(
         'Unsupported platform/architecture combination win32/arm',
       )
     })
@@ -167,7 +179,7 @@ describe('javy', () => {
 describe('javy-plugin', () => {
   test('properties are set correctly', () => {
     expect(javyPlugin.name).toBe('shopify_functions_javy_v3')
-    expect(javyPlugin.version).match(/^v\d+$/)
+    expect(javyPlugin.version).match(/^\d+$/)
     expect(javyPlugin.path).toMatch(/(\/|\\)shopify_functions_javy_v3.wasm$/)
   })
 
@@ -199,7 +211,7 @@ describe('javy-plugin', () => {
 describe('functionRunner', () => {
   test('properties are set correctly', () => {
     expect(functionRunner.name).toBe('function-runner')
-    expect(functionRunner.version).match(/^v\d\.\d\.\d$/)
+    expect(functionRunner.version).match(/^\d\.\d\.\d$/)
     if (process.platform === 'win32') {
       expect(functionRunner.path).toContain(`function-runner-${PREFERRED_FUNCTION_RUNNER_VERSION}.exe`)
     } else {
@@ -285,17 +297,6 @@ describe('functionRunner', () => {
       // Then
       expect(() => functionRunner.downloadUrl('darwin', arch)).toThrowError('Unsupported architecture ppc')
     })
-
-    test('Unsupported combination throws an error', () => {
-      // When
-      const arch = 'arm'
-      const platform = 'win32'
-
-      // Then
-      expect(() => functionRunner.downloadUrl(platform, arch)).toThrowError(
-        'Unsupported platform/architecture combination win32/arm',
-      )
-    })
   })
 
   test('downloads function-runner', async () => {
@@ -351,7 +352,7 @@ describe('trampoline', () => {
 
   test('v1 properties are set correctly', () => {
     expect(v1Trampoline.name).toBe('shopify-function-trampoline')
-    expect(v1Trampoline.version).match(/v1.\d.\d$/)
+    expect(v1Trampoline.version).match(/1.\d.\d$/)
     if (process.platform === 'win32') {
       expect(v1Trampoline.path).toContain(`shopify-function-trampoline-${V1_TRAMPOLINE_VERSION}.exe`)
     } else {
@@ -361,7 +362,7 @@ describe('trampoline', () => {
 
   test('v2 properties are set correctly', () => {
     expect(v2Trampoline.name).toBe('shopify-function-trampoline')
-    expect(v2Trampoline.version).match(/v2.\d.\d$/)
+    expect(v2Trampoline.version).match(/2.\d.\d$/)
     if (process.platform === 'win32') {
       expect(v2Trampoline.path).toContain(`shopify-function-trampoline-${V2_TRAMPOLINE_VERSION}.exe`)
     } else {
@@ -375,7 +376,7 @@ describe('trampoline', () => {
 
     // Then
     const expectedUrlRegex = new RegExp(
-      `https://github.com/Shopify/shopify-function-wasm-api/releases/download/shopify_function_trampoline/${v2Trampoline.version}/shopify-function-trampoline-x86_64-macos-${v2Trampoline.version}.gz`,
+      `https://github.com/Shopify/shopify-function-wasm-api/releases/download/shopify_function_trampoline/v${v2Trampoline.version}/shopify-function-trampoline-x86_64-macos-v${v2Trampoline.version}.gz`,
     )
     expect(url).toMatch(expectedUrlRegex)
   })

packages/app/src/cli/services/function/binaries.ts

@@ -3,25 +3,26 @@ import {chmod, createFileWriteStream, fileExists, inTemporaryDirectory, mkdir, m
 import {outputDebug} from '@shopify/cli-kit/node/output'
 import {performActionWithRetryAfterRecovery} from '@shopify/cli-kit/common/retry'
 import {fetch} from '@shopify/cli-kit/node/http'
+import {versionSatisfies} from '@shopify/cli-kit/node/node-package-manager'
 import {PipelineSource} from 'stream'
 import {pipeline} from 'stream/promises'
 import stream from 'node:stream/promises'
 import fs from 'node:fs'
 import * as gzip from 'node:zlib'
 import {fileURLToPath} from 'node:url'
 
-export const PREFERRED_FUNCTION_RUNNER_VERSION = 'v9.1.0'
+export const PREFERRED_FUNCTION_RUNNER_VERSION = '9.1.1'
 
 // Javy dependencies.
-export const PREFERRED_JAVY_VERSION = 'v6.0.0'
+export const PREFERRED_JAVY_VERSION = '7.0.0'
 // The Javy plugin version should match the plugin version used in the
 // function-runner version specified above.
-export const PREFERRED_JAVY_PLUGIN_VERSION = 'v3'
+export const PREFERRED_JAVY_PLUGIN_VERSION = '3'
 
 const BINARYEN_VERSION = '123.0.0'
 
-export const V1_TRAMPOLINE_VERSION = 'v1.0.2'
-export const V2_TRAMPOLINE_VERSION = 'v2.0.0'
+export const V1_TRAMPOLINE_VERSION = '1.0.2'
+export const V2_TRAMPOLINE_VERSION = '2.0.1'
 
 interface DownloadableBinary {
   path: string
@@ -43,9 +44,9 @@ export interface BinaryDependencies {
 export function deriveJavaScriptBinaryDependencies(version: string): BinaryDependencies | null {
   if (version === '0' || version === '1') {
     return {
-      functionRunner: 'v7.0.1',
-      javy: 'v4.0.0',
-      javyPlugin: 'v1',
+      functionRunner: '7.0.1',
+      javy: '4.0.0',
+      javyPlugin: '1',
     }
   } else if (version === '2') {
     return {
@@ -67,11 +68,19 @@ class Executable implements DownloadableBinary {
   readonly path: string
   readonly release: string
   private readonly gitHubRepo: string
-
-  constructor(name: string, version: string, gitHubRepo: string, release = version) {
+  private readonly supportsWindowsOnArm: boolean
+
+  constructor(
+    name: string,
+    version: string,
+    gitHubRepo: string,
+    supportsWindowsOnArm: boolean,
+    release = `v${version}`,
+  ) {
     this.name = name
     this.version = version
     this.release = release
+    this.supportsWindowsOnArm = supportsWindowsOnArm
 
     let filename: string
     // add version to the filename
@@ -115,13 +124,15 @@ class Executable implements DownloadableBinary {
     }
 
     const archPlatform = `${arch}-${platform}`
-    // These are currently the same between both binaries _coincidentally_.
     const supportedTargets = ['arm-linux', 'arm-macos', 'x86_64-macos', 'x86_64-windows', 'x86_64-linux']
+    if (this.supportsWindowsOnArm) {
+      supportedTargets.push('arm-windows')
+    }
     if (!supportedTargets.includes(archPlatform)) {
       throw Error(`Unsupported platform/architecture combination ${processPlatform}/${processArch}`)
     }
 
-    return `https://github.com/${this.gitHubRepo}/releases/download/${this.release}/${this.name}-${archPlatform}-${this.version}.gz`
+    return `https://github.com/${this.gitHubRepo}/releases/download/${this.release}/${this.name}-${archPlatform}-v${this.version}.gz`
   }
 
   async processResponse(responseStream: PipelineSource<unknown>, outputStream: fs.WriteStream): Promise<void> {
@@ -135,13 +146,18 @@ class JavyPlugin implements DownloadableBinary {
   readonly path: string
 
   constructor(version: string) {
-    this.name = `shopify_functions_javy_${version}`
+    this.name = `shopify_functions_javy_v${version}`
     this.version = version
-    this.path = joinPath(dirname(fileURLToPath(import.meta.url)), '..', 'bin', `shopify_functions_javy_${version}.wasm`)
+    this.path = joinPath(
+      dirname(fileURLToPath(import.meta.url)),
+      '..',
+      'bin',
+      `shopify_functions_javy_v${version}.wasm`,
+    )
   }
 
   downloadUrl(_processPlatform: string, _processArch: string) {
-    return `https://cdn.shopify.com/shopifycloud/shopify-functions-javy-plugin/shopify_functions_javy_${this.version}.wasm`
+    return `https://cdn.shopify.com/shopifycloud/shopify-functions-javy-plugin/shopify_functions_javy_v${this.version}.wasm`
   }
 
   async processResponse(responseStream: PipelineSource<unknown>, outputStream: fs.WriteStream): Promise<void> {
@@ -172,15 +188,25 @@ class WasmOptExecutable implements DownloadableBinary {
 let _wasmOpt: DownloadableBinary
 
 export function javyBinary(version: string = PREFERRED_JAVY_VERSION) {
-  return new Executable('javy', version, 'bytecodealliance/javy') as DownloadableBinary
+  return new Executable(
+    'javy',
+    version,
+    'bytecodealliance/javy',
+    versionSatisfies(version, '>=7.0.0'),
+  ) as DownloadableBinary
 }
 
 export function javyPluginBinary(version: string = PREFERRED_JAVY_PLUGIN_VERSION) {
   return new JavyPlugin(version) as DownloadableBinary
 }
 
 export function functionRunnerBinary(version: string = PREFERRED_FUNCTION_RUNNER_VERSION) {
-  return new Executable('function-runner', version, 'Shopify/function-runner') as DownloadableBinary
+  return new Executable(
+    'function-runner',
+    version,
+    'Shopify/function-runner',
+    versionSatisfies(version, '>=9.1.1'),
+  ) as DownloadableBinary
 }
 
 export function wasmOptBinary() {
@@ -196,7 +222,8 @@ export function trampolineBinary(version: string) {
     'shopify-function-trampoline',
     version,
     'Shopify/shopify-function-wasm-api',
-    `shopify_function_trampoline/${version}`,
+    versionSatisfies(version, '>=2.0.1'),
+    `shopify_function_trampoline/v${version}`,
   )
 }