Merge pull request #456 from algorandfoundation/fix/deploy-use-extra-pages

fix: use extra pages available when deploying

Author: neilcampbell

src/types/app-deployer.ts

@@ -364,7 +364,7 @@ export class AppDeployer {
     const existingAppRecord = await this._appManager.getById(existingApp.appId)
     const existingApproval = Buffer.from(existingAppRecord.approvalProgram).toString('base64')
     const existingClear = Buffer.from(existingAppRecord.clearStateProgram).toString('base64')
-    const existingExtraPages = calculateExtraProgramPages(existingAppRecord.approvalProgram, existingAppRecord.clearStateProgram)
+    const extraPages = existingAppRecord.extraProgramPages ?? 0
 
     const newApprovalBytes = Buffer.from(approvalProgram)
     const newClearBytes = Buffer.from(clearStateProgram)
@@ -380,7 +380,7 @@ export class AppDeployer {
       existingAppRecord.globalInts < (createParams.schema?.globalInts ?? 0) ||
       existingAppRecord.localByteSlices < (createParams.schema?.localByteSlices ?? 0) ||
       existingAppRecord.globalByteSlices < (createParams.schema?.globalByteSlices ?? 0) ||
-      existingExtraPages < newExtraPages
+      extraPages < newExtraPages
 
     if (isSchemaBreak) {
       Config.getLogger(sendParams?.suppressLog).warn(`Detected a breaking app schema change in app ${existingApp.appId}:`, {
@@ -389,7 +389,7 @@ export class AppDeployer {
           globalByteSlices: existingAppRecord.globalByteSlices,
           localInts: existingAppRecord.localInts,
           localByteSlices: existingAppRecord.localByteSlices,
-          extraProgramPages: existingExtraPages,
+          extraProgramPages: extraPages,
         },
         to: { ...createParams.schema, extraProgramPages: newExtraPages },
       })

src/types/app-factory-and-client.spec.ts

@@ -192,7 +192,7 @@ describe('ARC32: app-factory-and-app-client', () => {
     expect(app.return).toBe('arg_io')
   })
 
-  test('Deploy app - update detects extra pages as breaking change', async () => {
+  test('Deploy app - update detects extra page deficit as a breaking change', async () => {
     let appFactory = localnet.algorand.client.getAppFactory({
       appSpec: asJson(smallAppArc56Json),
       defaultSender: localnet.context.testAccount,
@@ -232,6 +232,37 @@ describe('ARC32: app-factory-and-app-client', () => {
     expect(appCreateResult.appId).not.toEqual(appAppendResult.appId)
   })
 
+  test('Deploy app - update detects extra page surplus as a non breaking change', async () => {
+    let appFactory = localnet.algorand.client.getAppFactory({
+      appSpec: asJson(smallAppArc56Json),
+      defaultSender: localnet.context.testAccount,
+    })
+
+    const { result: appCreateResult } = await appFactory.deploy({
+      updatable: true,
+      createParams: {
+        extraProgramPages: 1,
+      },
+    })
+
+    expect(appCreateResult.operationPerformed).toBe('create')
+
+    // Update the app to a larger program which needs more pages than the previous program
+    appFactory = localnet.algorand.client.getAppFactory({
+      appSpec: asJson(largeAppArc56Json),
+      defaultSender: localnet.context.testAccount,
+    })
+
+    const { result: appUpdateResult } = await appFactory.deploy({
+      updatable: true,
+      onSchemaBreak: OnSchemaBreak.Fail,
+      onUpdate: OnUpdate.UpdateApp,
+    })
+
+    expect(appUpdateResult.operationPerformed).toBe('update')
+    expect(appCreateResult.appId).toEqual(appUpdateResult.appId)
+  })
+
   test('Deploy app - replace', async () => {
     const { result: createdApp } = await factory.deploy({
       deployTimeParams: {