List & retrieve /posts/<post_id>/autosaves endpoint (#865)

oguzkocer · web-flow · commit 53db86b1dc0f · 2025-09-01T10:05:20.000+12:00
diff --git a/scripts/setup-test-site.sh b/scripts/setup-test-site.sh
@@ -85,6 +85,20 @@ wp theme activate twentytwentyfour
 wp comment trash 22
 wp comment spam 23
 
+create_post_revision() {
+  local revision_number="$1"
+  local post_id="$2"
+
+  curl --silent --user "$ADMIN_USERNAME":"$ADMIN_PASSWORD" -H "Content-Type: application/json" -d "{\"content\":\"content_revision_$revision_number\", \"author\": $ADMIN_USER_ID}" "http://localhost/wp-json/wp/v2/posts/$post_id" > /dev/null
+}
+
+create_post_autosave() {
+  local autosave_number="$1"
+  local post_id="$2"
+
+  curl --silent --user "$ADMIN_USERNAME":"$ADMIN_PASSWORD" -H "Content-Type: application/json" -d "{\"content\":\"content_autosave_$autosave_number\", \"author\": $ADMIN_USER_ID}" "http://localhost/wp-json/wp/v2/posts/$post_id/autosaves"
+}
+
 create_test_credentials () {
   local SITE_URL
   local ADMIN_USERNAME
@@ -98,6 +112,8 @@ create_test_credentials () {
   local PASSWORD_PROTECTED_COMMENT_ID
   local PASSWORD_PROTECTED_COMMENT_AUTHOR
   local REVISIONED_POST_ID
+  local AUTOSAVED_POST_ID
+  local AUTOSAVE_ID_FOR_AUTOSAVED_POST_ID
   local FIRST_POST_DATE_GMT
   local WORDPRESS_VERSION
   local INTEGRATION_TEST_CUSTOM_TEMPLATE_ID
@@ -133,13 +149,26 @@ create_test_credentials () {
 
   echo "Setting up a post with 10 revisions for integration tests.."
   REVISIONED_POST_ID="$(wp post create --post_type=post --post_title=Revisioned_POST_FOR_INTEGRATION_TESTS --porcelain)"
+  # Create revisions
   for i in {1..10};
   do
-    curl --silent --user "$ADMIN_USERNAME":"$ADMIN_PASSWORD" -H "Content-Type: application/json" -d "{\"content\":\"content_revision_$i\", \"author\": $ADMIN_USER_ID}" "http://localhost/wp-json/wp/v2/posts/$REVISIONED_POST_ID" > /dev/null
+    create_post_revision "$i" "$REVISIONED_POST_ID"
   done
   # Generating revisions don't return an id, but since we just created the `REVISIONED_POST_ID`, we can use it to calculate the revision id
   REVISION_ID_FOR_REVISIONED_POST_ID=$((REVISIONED_POST_ID + 1))
 
+  echo "Setting up a post with autosave for integration tests.."
+  # Autosaves require special setup: WordPress only creates separate autosave revisions when
+  # the autosave is made by a different user than the post author. If the same user creates
+  # an autosave, WordPress just updates the original post instead of creating a revision.
+  # See: https://github.com/WordPress/WordPress/blob/c90da2b67323e36b0390a9efa95f2b4bbb3be31b/wp-includes/rest-api/endpoints/class-wp-rest-autosaves-controller.php#L235-L244
+  # Create post as author user to enable proper autosave behavior
+  AUTHOR_USER_ID="$(wp user get "$AUTHOR_USERNAME" --field=ID)"
+  AUTOSAVED_POST_ID="$(wp post create --post_type=post --post_title=Autosaved_POST_FOR_INTEGRATION_TESTS --post_author="$AUTHOR_USER_ID" --porcelain)"
+  # Create autosave as admin user (different from post author) and capture its ID
+  AUTOSAVE_RESPONSE="$(create_post_autosave "1" "$AUTOSAVED_POST_ID")"
+  AUTOSAVE_ID_FOR_AUTOSAVED_POST_ID="$(echo "$AUTOSAVE_RESPONSE" | jq -r '.id')"
+
   rm -rf /app/test_credentials.json
   jo -p \
     site_url="$SITE_URL" \
@@ -162,6 +191,8 @@ create_test_credentials () {
     integration_test_custom_template_id="$INTEGRATION_TEST_CUSTOM_TEMPLATE_ID" \
     revisioned_post_id="$REVISIONED_POST_ID" \
     revision_id_for_revisioned_post_id="$REVISION_ID_FOR_REVISIONED_POST_ID" \
+    autosaved_post_id="$AUTOSAVED_POST_ID" \
+    autosave_id_for_autosaved_post_id="$AUTOSAVE_ID_FOR_AUTOSAVED_POST_ID" \
     > /app/test_credentials.json
 }
 create_test_credentials
diff --git a/wp_api/src/api_client.rs b/wp_api/src/api_client.rs
@@ -10,6 +10,7 @@ use crate::{
             application_passwords_endpoint::{
                 ApplicationPasswordsRequestBuilder, ApplicationPasswordsRequestExecutor,
             },
+            autosaves_endpoint::{AutosavesRequestBuilder, AutosavesRequestExecutor},
             categories_endpoint::{CategoriesRequestBuilder, CategoriesRequestExecutor},
             comments_endpoint::{CommentsRequestBuilder, CommentsRequestExecutor},
             media_endpoint::{MediaRequestBuilder, MediaRequestExecutor},
@@ -54,6 +55,7 @@ impl UniffiWpApiRequestBuilder {
 
 pub struct WpApiRequestBuilder {
     application_passwords: Arc<ApplicationPasswordsRequestBuilder>,
+    autosaves: Arc<AutosavesRequestBuilder>,
     categories: Arc<CategoriesRequestBuilder>,
     comments: Arc<CommentsRequestBuilder>,
     media: Arc<MediaRequestBuilder>,
@@ -82,6 +84,7 @@ impl WpApiRequestBuilder {
             api_url_resolver,
             auth_provider;
             application_passwords,
+            autosaves,
             categories,
             comments,
             media,
@@ -120,6 +123,7 @@ impl UniffiWpApiClient {
 
 pub struct WpApiClient {
     application_passwords: Arc<ApplicationPasswordsRequestExecutor>,
+    autosaves: Arc<AutosavesRequestExecutor>,
     categories: Arc<CategoriesRequestExecutor>,
     comments: Arc<CommentsRequestExecutor>,
     media: Arc<MediaRequestExecutor>,
@@ -145,6 +149,7 @@ impl WpApiClient {
             api_url_resolver,
             delegate;
             application_passwords,
+            autosaves,
             categories,
             comments,
             media,
@@ -180,6 +185,7 @@ pub trait IsWpApiClientDelegate {
 }
 
 api_client_generate_endpoint_impl!(WpApi, application_passwords);
+api_client_generate_endpoint_impl!(WpApi, autosaves);
 api_client_generate_endpoint_impl!(WpApi, categories);
 api_client_generate_endpoint_impl!(WpApi, comments);
 api_client_generate_endpoint_impl!(WpApi, media);
diff --git a/wp_api/src/request/endpoint.rs b/wp_api/src/request/endpoint.rs
@@ -4,6 +4,7 @@ use strum_macros::EnumIter;
 use url::Url;
 
 pub mod application_passwords_endpoint;
+pub mod autosaves_endpoint;
 pub mod categories_endpoint;
 pub mod comments_endpoint;
 pub mod media_endpoint;
diff --git a/wp_api/src/request/endpoint/autosaves_endpoint.rs b/wp_api/src/request/endpoint/autosaves_endpoint.rs
@@ -0,0 +1,75 @@
+use super::{AsNamespace, DerivedRequest, WpNamespace};
+use crate::{post_revisions::PostRevisionId, posts::PostId};
+use wp_derive_request_builder::WpDerivedRequest;
+
+#[derive(WpDerivedRequest)]
+enum AutosavesRequest {
+    #[contextual_get(url = "/posts/<post_id>/autosaves", output = Vec<crate::post_revisions::SparsePostRevision>, filter_by = crate::post_revisions::SparsePostRevisionField)]
+    List,
+    #[contextual_get(url = "/posts/<post_id>/autosaves/<post_revision_id>", output = crate::post_revisions::SparsePostRevision, filter_by = crate::post_revisions::SparsePostRevisionField)]
+    Retrieve,
+}
+
+impl DerivedRequest for AutosavesRequest {
+    fn namespace() -> impl AsNamespace {
+        WpNamespace::WpV2
+    }
+}
+
+#[cfg(test)]
+mod tests {
+    use super::*;
+    use crate::request::endpoint::ApiUrlResolver;
+    use crate::{
+        posts::PostId,
+        request::endpoint::tests::{fixture_wp_org_site_api_url_resolver, validate_wp_v2_endpoint},
+    };
+    use rstest::*;
+    use std::sync::Arc;
+
+    #[rstest]
+    fn list_autosaves(endpoint: AutosavesRequestEndpoint) {
+        let post_id = PostId(777);
+        let expected_path = |context: &str| format!("/posts/{post_id}/autosaves?context={context}");
+        validate_wp_v2_endpoint(
+            endpoint.list_with_edit_context(&post_id),
+            &expected_path("edit"),
+        );
+        validate_wp_v2_endpoint(
+            endpoint.list_with_embed_context(&post_id),
+            &expected_path("embed"),
+        );
+        validate_wp_v2_endpoint(
+            endpoint.list_with_view_context(&post_id),
+            &expected_path("view"),
+        );
+    }
+
+    #[rstest]
+    fn retrieve_autosave(endpoint: AutosavesRequestEndpoint) {
+        let post_id = PostId(777);
+        let post_revision_id = PostRevisionId(888);
+        let expected_path = |context: &str| {
+            format!("/posts/{post_id}/autosaves/{post_revision_id}?context={context}")
+        };
+        validate_wp_v2_endpoint(
+            endpoint.retrieve_with_edit_context(&post_id, &post_revision_id),
+            &expected_path("edit"),
+        );
+        validate_wp_v2_endpoint(
+            endpoint.retrieve_with_embed_context(&post_id, &post_revision_id),
+            &expected_path("embed"),
+        );
+        validate_wp_v2_endpoint(
+            endpoint.retrieve_with_view_context(&post_id, &post_revision_id),
+            &expected_path("view"),
+        );
+    }
+
+    #[fixture]
+    fn endpoint(
+        fixture_wp_org_site_api_url_resolver: Arc<dyn ApiUrlResolver>,
+    ) -> AutosavesRequestEndpoint {
+        AutosavesRequestEndpoint::new(fixture_wp_org_site_api_url_resolver)
+    }
+}
diff --git a/wp_api_integration_tests/src/lib.rs b/wp_api_integration_tests/src/lib.rs
@@ -29,6 +29,8 @@ pub struct TestCredentials {
     pub integration_test_custom_template_id: &'static str,
     pub revisioned_post_id: i64,
     pub revision_id_for_revisioned_post_id: i64,
+    pub autosaved_post_id: i64,
+    pub autosave_id_for_autosaved_post_id: i64,
 }
 
 impl TestCredentials {
diff --git a/wp_api_integration_tests/tests/test_autosaves_immut.rs b/wp_api_integration_tests/tests/test_autosaves_immut.rs

Original file line number	Diff line number	Diff line change
`@@ -29,6 +29,8 @@ pub struct TestCredentials {`
`29`	`29`	`pub integration_test_custom_template_id: &'static str,`
`30`	`30`	`pub revisioned_post_id: i64,`
`31`	`31`	`pub revision_id_for_revisioned_post_id: i64,`
	`32`	`+ pub autosaved_post_id: i64,`
	`33`	`+ pub autosave_id_for_autosaved_post_id: i64,`
`32`	`34`	`}`
`33`	`35`
`34`	`36`	`impl TestCredentials {`