Switch update_apps_cdn_build_metadata to the dedicated a8c-cdn/builds endpoint

iangmaia · claude · iangmaia · commit 5ca786686c50 · 2026-06-11T19:06:58.000+02:00
Standard WP REST API writes are now blocked for CDN builds; the new
/wpcom/v2/sites/{site_id}/a8c-cdn/builds/{post_id} endpoint accepts
string-based values, removing the need for visibility term ID lookups.

Co-Authored-By: Claude Fable 5 &lt;noreply@anthropic.com&gt;
diff --git a/.bundle/config b/.bundle/config
@@ -3,3 +3,4 @@ BUNDLE_PATH: "vendor/bundle"
 BUNDLE_FORCE_RUBY_PLATFORM: "true"
 BUNDLE_SPECIFIC_PLATFORM: "false"
 BUNDLE_JOBS: "16"
+BUNDLE_BUILD__NOKOGIRI: "--with-cflags=-Wno-default-const-init-field-unsafe"
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -10,7 +10,7 @@ _None_
 
 ### New Features
 
-- Added new `update_apps_cdn_build_metadata` action to update metadata (e.g. visibility) of one or more existing builds on the Apps CDN without re-uploading the files. Accepts an array of `post_ids` and performs the visibility term lookup only once. This enables a two-phase release flow: upload builds as Internal first, then flip to External at publish time. [#701]
+- Added new `update_apps_cdn_build_metadata` action to update metadata (e.g. visibility) of one or more existing builds on the Apps CDN without re-uploading the files, via the dedicated `/wpcom/v2/sites/{site_id}/a8c-cdn/builds/{post_id}` endpoint. Accepts an array of `post_ids`. This enables a two-phase release flow: upload builds as Internal first, then flip to External at publish time. [#701]
 
 ### Bug Fixes
 
diff --git a/lib/fastlane/plugin/wpmreleasetoolkit/actions/common/update_apps_cdn_build_metadata.rb b/lib/fastlane/plugin/wpmreleasetoolkit/actions/common/update_apps_cdn_build_metadata.rb
@@ -12,14 +12,11 @@ def self.run(params)
         post_ids = params[:post_ids]
         UI.message("Updating Apps CDN build metadata for #{post_ids.size} post(s): #{post_ids.join(', ')}...")
 
-        # Build the base JSON body for the WP REST API v2
+        # Build the JSON body for the dedicated Apps CDN builds endpoint, which accepts
+        # the same string-based format as the upload flow (e.g. `visibility: 'Internal'`)
         body = {}
-        body['status'] = params[:post_status] if params[:post_status]
-
-        if params[:visibility]
-          term_id = lookup_visibility_term_id(site_id: params[:site_id], api_token: params[:api_token], visibility: params[:visibility])
-          body['visibility'] = [term_id]
-        end
+        body['post_status'] = params[:post_status] if params[:post_status]
+        body['visibility'] = params[:visibility].to_s.capitalize if params[:visibility]
 
         UI.user_error!('No metadata to update. Provide at least one of: visibility, post_status') if body.empty?
 
@@ -31,16 +28,17 @@ def self.run(params)
         results
       end
 
-      # Update a single CDN build post with the given body via the WP REST API v2.
+      # Update a single CDN build post with the given body via the dedicated
+      # `/wpcom/v2/sites/{site_id}/a8c-cdn/builds/{post_id}` endpoint.
       #
       # @param site_id [String] the WordPress.com site ID
       # @param api_token [String] the WordPress.com API bearer token
-      # @param post_id [Integer] the ID of the post to update
+      # @param post_id [Integer] the ID of the build post to update
       # @param body [Hash] the JSON body to send in the POST request
       # @return [Integer] the ID of the updated post
       # @raise [FastlaneCore::Interface::FastlaneError] if the API returns a non-success response
       def self.update_single_post(site_id:, api_token:, post_id:, body:)
-        uri = Helper::AppsCdnHelper.wp_v2_url(site_id: site_id, path: "a8c_cdn_build/#{post_id}")
+        uri = Helper::AppsCdnHelper.wpcom_v2_url(site_id: site_id, path: "a8c-cdn/builds/#{post_id}")
 
         request = Net::HTTP::Post.new(uri.request_uri)
         request.body = JSON.generate(body)
@@ -69,37 +67,6 @@ def self.update_single_post(site_id:, api_token:, post_id:, body:)
         end
       end
 
-      # Look up the taxonomy term ID for a visibility value (e.g. :internal -> 1316).
-      #
-      # @param site_id [String] the WordPress.com site ID
-      # @param api_token [String] the WordPress.com API bearer token
-      # @param visibility [Symbol] the visibility to look up (:internal or :external)
-      # @return [Integer] the taxonomy term ID for the given visibility
-      # @raise [FastlaneCore::Interface::FastlaneError] if no term is found or the API returns a non-success response
-      def self.lookup_visibility_term_id(site_id:, api_token:, visibility:)
-        slug = visibility.to_s.downcase
-        uri = Helper::AppsCdnHelper.wp_v2_url(site_id: site_id, path: "visibility?slug=#{slug}")
-
-        request = Net::HTTP::Get.new(uri.request_uri)
-        request['Accept'] = 'application/json'
-        request['Authorization'] = "Bearer #{api_token}"
-
-        response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
-          http.open_timeout = 10
-          http.read_timeout = 30
-          http.request(request)
-        end
-
-        case response
-        when Net::HTTPSuccess
-          terms = JSON.parse(response.body)
-          UI.user_error!("No visibility term found for '#{slug}'") if terms.empty?
-          terms.first['id']
-        else
-          UI.user_error!("Failed to look up visibility term '#{slug}': #{response.code} #{response.message}")
-        end
-      end
-
       def self.description
         'Updates metadata of one or more existing builds on the Apps CDN'
       end
@@ -115,8 +82,8 @@ def self.return_value
       def self.details
         <<~DETAILS
           Updates metadata (such as post status or visibility) for one or more existing build posts on a WordPress blog
-          that has the Apps CDN plugin enabled, using the WordPress.com REST API (WP v2).
-          When updating visibility for multiple posts, the visibility term ID is looked up only once.
+          that has the Apps CDN plugin enabled, using the dedicated `/wpcom/v2/sites/{site_id}/a8c-cdn/builds/{post_id}`
+          endpoint. Standard WP REST API writes are blocked for builds, so this endpoint is the only way to update them.
           See PCYsg-15tP-p2 internal a8c documentation for details about the Apps CDN plugin.
         DETAILS
       end
diff --git a/lib/fastlane/plugin/wpmreleasetoolkit/helper/apps_cdn_helper.rb b/lib/fastlane/plugin/wpmreleasetoolkit/helper/apps_cdn_helper.rb
@@ -22,13 +22,13 @@ def self.rest_v1_1_url(site_id:, path:)
         URI.parse("#{API_BASE_URL}/rest/v1.1/sites/#{site_id}/#{path}")
       end
 
-      # Builds a WordPress.com WP REST API v2 URI scoped to a site.
+      # Builds a WordPress.com REST API wpcom/v2 URI scoped to a site.
       #
       # @param site_id [String] the WordPress.com site ID
-      # @param path [String] the API path relative to the site (e.g. 'a8c_cdn_build/123')
+      # @param path [String] the API path relative to the site (e.g. 'a8c-cdn/builds/123')
       # @return [URI] the parsed full API URI
-      def self.wp_v2_url(site_id:, path:)
-        URI.parse("#{API_BASE_URL}/wp/v2/sites/#{site_id}/#{path}")
+      def self.wpcom_v2_url(site_id:, path:)
+        URI.parse("#{API_BASE_URL}/wpcom/v2/sites/#{site_id}/#{path}")
       end
 
       # Returns a proc that validates a visibility parameter value against {VALID_VISIBILITIES}.
diff --git a/spec/update_apps_cdn_build_metadata_spec.rb b/spec/update_apps_cdn_build_metadata_spec.rb
@@ -7,21 +7,17 @@
   let(:test_site_id) { '12345678' }
   let(:test_post_id) { 98_765 }
   let(:second_post_id) { 54_321 }
-  let(:api_url) { "https://public-api.wordpress.com/wp/v2/sites/#{test_site_id}/a8c_cdn_build/#{test_post_id}" }
-  let(:second_api_url) { "https://public-api.wordpress.com/wp/v2/sites/#{test_site_id}/a8c_cdn_build/#{second_post_id}" }
-  let(:visibility_term_url) { "https://public-api.wordpress.com/wp/v2/sites/#{test_site_id}/visibility" }
+  let(:api_url) { "https://public-api.wordpress.com/wpcom/v2/sites/#{test_site_id}/a8c-cdn/builds/#{test_post_id}" }
+  let(:second_api_url) { "https://public-api.wordpress.com/wpcom/v2/sites/#{test_site_id}/a8c-cdn/builds/#{second_post_id}" }
   let(:test_api_token) { 'test_api_token' }
 
-  let(:external_term_id) { 21_293 }
-  let(:internal_term_id) { 1_316 }
-
   let(:stub_success_response) do
     {
       id: test_post_id,
-      title: { rendered: 'WordPress.com Studio 1.7.5' },
-      status: 'publish',
-      visibility: [external_term_id],
-      class_list: ['visibility-external']
+      post_status: 'publish',
+      release_notes: 'Release 1.7.5',
+      visibility: 'External',
+      product: 'WordPress.com Studio'
     }.to_json
   end
 
@@ -31,14 +27,6 @@
 
   describe 'updating visibility' do
     it 'successfully updates the visibility to external' do
-      stub_request(:get, visibility_term_url)
-        .with(query: { 'slug' => 'external' })
-        .to_return(
-          status: 200,
-          body: [{ 'id' => external_term_id, 'name' => 'External', 'slug' => 'external' }].to_json,
-          headers: { 'Content-Type' => 'application/json' }
-        )
-
       stub_request(:post, api_url)
         .to_return(
           status: 200,
@@ -62,25 +50,17 @@
           expect(req.headers['Authorization']).to eq("Bearer #{test_api_token}")
           expect(req.headers['Content-Type']).to eq('application/json')
           body = JSON.parse(req.body)
-          expect(body['visibility']).to eq([external_term_id])
+          expect(body['visibility']).to eq('External')
           true
         end
       )
     end
 
     it 'successfully updates the visibility to internal' do
-      stub_request(:get, visibility_term_url)
-        .with(query: { 'slug' => 'internal' })
-        .to_return(
-          status: 200,
-          body: [{ 'id' => internal_term_id, 'name' => 'Internal', 'slug' => 'internal' }].to_json,
-          headers: { 'Content-Type' => 'application/json' }
-        )
-
       internal_response = {
         id: test_post_id,
-        visibility: [internal_term_id],
-        class_list: ['visibility-internal']
+        post_status: 'publish',
+        visibility: 'Internal'
       }.to_json
 
       stub_request(:post, api_url)
@@ -102,23 +82,15 @@
       expect(WebMock).to(
         have_requested(:post, api_url).with do |req|
           body = JSON.parse(req.body)
-          expect(body['visibility']).to eq([internal_term_id])
+          expect(body['visibility']).to eq('Internal')
           true
         end
       )
     end
   end
 
   describe 'batch updating multiple posts' do
-    it 'updates all posts with a single visibility term lookup' do
-      stub_request(:get, visibility_term_url)
-        .with(query: { 'slug' => 'external' })
-        .to_return(
-          status: 200,
-          body: [{ 'id' => external_term_id, 'name' => 'External', 'slug' => 'external' }].to_json,
-          headers: { 'Content-Type' => 'application/json' }
-        )
-
+    it 'updates each post with a single request' do
       stub_request(:post, api_url)
         .to_return(
           status: 200,
@@ -143,8 +115,6 @@
       expect(results.size).to eq(2)
       expect(results).to eq([test_post_id, second_post_id])
 
-      # Visibility term lookup should have been called only once
-      expect(WebMock).to have_requested(:get, visibility_term_url).with(query: { 'slug' => 'external' }).once
       expect(WebMock).to have_requested(:post, api_url).once
       expect(WebMock).to have_requested(:post, second_api_url).once
     end
@@ -155,7 +125,7 @@
       stub_request(:post, api_url)
         .to_return(
           status: 200,
-          body: { id: test_post_id, status: 'draft' }.to_json,
+          body: { id: test_post_id, post_status: 'draft' }.to_json,
           headers: { 'Content-Type' => 'application/json' }
         )
 
@@ -171,7 +141,7 @@
       expect(WebMock).to(
         have_requested(:post, api_url).with do |req|
           body = JSON.parse(req.body)
-          expect(body['status']).to eq('draft')
+          expect(body['post_status']).to eq('draft')
           true
         end
       )
@@ -180,14 +150,6 @@
 
   describe 'updating multiple fields' do
     it 'successfully updates both visibility and post_status' do
-      stub_request(:get, visibility_term_url)
-        .with(query: { 'slug' => 'external' })
-        .to_return(
-          status: 200,
-          body: [{ 'id' => external_term_id, 'name' => 'External', 'slug' => 'external' }].to_json,
-          headers: { 'Content-Type' => 'application/json' }
-        )
-
       stub_request(:post, api_url)
         .to_return(
           status: 200,
@@ -208,8 +170,8 @@
       expect(WebMock).to(
         have_requested(:post, api_url).with do |req|
           body = JSON.parse(req.body)
-          expect(body['visibility']).to eq([external_term_id])
-          expect(body['status']).to eq('publish')
+          expect(body['visibility']).to eq('External')
+          expect(body['post_status']).to eq('publish')
           true
         end
       )
@@ -221,7 +183,7 @@
       stub_request(:post, api_url)
         .to_return(
           status: 403,
-          body: { code: 'rest_forbidden', message: 'You are not authorized.' }.to_json,
+          body: { code: 'rest_forbidden', message: 'You do not have permission to update builds.' }.to_json,
           headers: { 'Content-Type' => 'application/json' }
         )
 
@@ -235,41 +197,40 @@
       end.to raise_error(FastlaneCore::Interface::FastlaneError, "Update of Apps CDN build metadata failed for post #{test_post_id}")
     end
 
-    it 'handles server errors properly' do
+    it 'handles a non-existent build post properly' do
       stub_request(:post, api_url)
         .to_return(
-          status: 500,
-          body: 'Internal Server Error',
-          headers: { 'Content-Type' => 'text/plain' }
+          status: 404,
+          body: { code: 'rest_build_not_found', message: 'Build not found.' }.to_json,
+          headers: { 'Content-Type' => 'application/json' }
         )
 
       expect do
         run_described_fastlane_action(
           site_id: test_site_id,
           api_token: test_api_token,
           post_ids: [test_post_id],
-          post_status: 'publish'
+          visibility: :external
         )
       end.to raise_error(FastlaneCore::Interface::FastlaneError, "Update of Apps CDN build metadata failed for post #{test_post_id}")
     end
 
-    it 'handles visibility term lookup failure' do
-      stub_request(:get, visibility_term_url)
-        .with(query: { 'slug' => 'external' })
+    it 'handles server errors properly' do
+      stub_request(:post, api_url)
         .to_return(
-          status: 200,
-          body: [].to_json,
-          headers: { 'Content-Type' => 'application/json' }
+          status: 500,
+          body: 'Internal Server Error',
+          headers: { 'Content-Type' => 'text/plain' }
         )
 
       expect do
         run_described_fastlane_action(
           site_id: test_site_id,
           api_token: test_api_token,
           post_ids: [test_post_id],
-          visibility: :external
+          post_status: 'publish'
         )
-      end.to raise_error(FastlaneCore::Interface::FastlaneError, "No visibility term found for 'external'")
+      end.to raise_error(FastlaneCore::Interface::FastlaneError, "Update of Apps CDN build metadata failed for post #{test_post_id}")
     end
   end
 
