Skip to content

armgit / ente

Public Imported from GitHub
0

πŸ’š End-to-end encrypted cloud for everything.

Enforce structured HTTP errors in clients

Manav Rathi44d9f9796525
diff --git a/mobile/apps/photos/lib/emergency/emergency_service.dart b/mobile/apps/photos/lib/emergency/emergency_service.dart
index b29dfc274f..9f99381f9c 100644
--- a/mobile/apps/photos/lib/emergency/emergency_service.dart
+++ b/mobile/apps/photos/lib/emergency/emergency_service.dart
@@ -120,11 +120,9 @@ class EmergencyContactService {
);
return true;
} on DioException catch (e) {
- if (e.response?.statusCode == 400) {
- final message = e.response?.data?["message"] as String?;
- if (message != null && message.contains("active recovery session")) {
- return false;
- }
+ if (e.response?.statusCode == 400 &&
+ e.response?.data?["code"] == "ACTIVE_RECOVERY_SESSION") {
+ return false;
}
_logger.severe("failed to update recovery notice", e);
rethrow;
diff --git a/mobile/apps/photos/lib/gateways/collections/collection_share_gateway.dart b/mobile/apps/photos/lib/gateways/collections/collection_share_gateway.dart
index 0543de4974..bfe0038194 100644
--- a/mobile/apps/photos/lib/gateways/collections/collection_share_gateway.dart
+++ b/mobile/apps/photos/lib/gateways/collections/collection_share_gateway.dart
@@ -135,19 +135,18 @@ class CollectionShareGateway {
} on DioException catch (e) {
switch (e.response?.statusCode) {
case 401:
- throw PublicCollectionInfoUnauthorizedException();
+ throw PublicCollectionInfoUnavailableException();
case 410:
- throw PublicCollectionInfoExpiredException();
+ if (_hasErrorCode(e.response?.data, "LINK_EXPIRED")) {
+ throw PublicCollectionInfoExpiredException();
+ }
+ throw PublicCollectionInfoUnavailableException();
case 403:
if (_hasErrorCode(e.response?.data, _linkDeviceLimitExceededCode)) {
throw PublicCollectionDeviceLimitExceededException();
}
rethrow;
case 429:
- final errorMessage = _extractErrorMessage(e.response?.data);
- if (errorMessage?.toLowerCase().contains("device limit") ?? false) {
- throw PublicCollectionDeviceLimitExceededException();
- }
throw PublicCollectionRateLimitedException();
default:
rethrow;
@@ -189,16 +188,6 @@ List<CollectionShareResult> _parseBulkResults(dynamic data) =>
)
.toList();
-String? _extractErrorMessage(dynamic data) {
- if (data is Map<String, dynamic>) {
- return data["error"]?.toString();
- }
- if (data is Map) {
- return data["error"]?.toString();
- }
- return null;
-}
-
bool _hasErrorCode(dynamic data, String code) {
if (data is Map<String, dynamic>) {
return data["code"] == code;
@@ -209,7 +198,7 @@ bool _hasErrorCode(dynamic data, String code) {
return false;
}
-class PublicCollectionInfoUnauthorizedException implements Exception {}
+class PublicCollectionInfoUnavailableException implements Exception {}
class PublicCollectionInfoExpiredException implements Exception {}
diff --git a/mobile/apps/photos/lib/services/collections_service.dart b/mobile/apps/photos/lib/services/collections_service.dart
index 60bdf3f179..0b5aa2b847 100644
--- a/mobile/apps/photos/lib/services/collections_service.dart
+++ b/mobile/apps/photos/lib/services/collections_service.dart
@@ -1733,11 +1733,11 @@ class CollectionsService {
await showErrorDialog(
context,
context.strings.canNotOpenTitle,
- context.strings.linkRequestLimitExceeded,
+ context.strings.pleaseTryAgain,
);
return null;
- } on PublicCollectionInfoUnauthorizedException catch (e, s) {
- _logger.warning("Public collection link is unauthorized", e, s);
+ } on PublicCollectionInfoUnavailableException catch (e, s) {
+ _logger.warning("Public collection link is unavailable", e, s);
if (!context.mounted) return null;
await showErrorDialog(
context,
diff --git a/mobile/packages/legacy/lib/services/emergency_service.dart b/mobile/packages/legacy/lib/services/emergency_service.dart
index 64e259f5d4..8d702ef602 100644
--- a/mobile/packages/legacy/lib/services/emergency_service.dart
+++ b/mobile/packages/legacy/lib/services/emergency_service.dart
@@ -148,11 +148,9 @@ class EmergencyContactService {
);
return true;
} on DioException catch (e) {
- if (e.response?.statusCode == 400) {
- final message = e.response?.data?['message'] as String?;
- if (message != null && message.contains('active recovery session')) {
- return false;
- }
+ if (e.response?.statusCode == 400 &&
+ e.response?.data?['code'] == 'ACTIVE_RECOVERY_SESSION') {
+ return false;
}
_logger.severe('failed to update recovery notice', e);
rethrow;
diff --git a/rust/checks/binding-boundary/check.mjs b/rust/checks/dependency-boundaries/check.mjs
similarity index 79%
rename from rust/checks/binding-boundary/check.mjs
rename to rust/checks/dependency-boundaries/check.mjs
index 41891cb759..9052df6894 100644
--- a/rust/checks/binding-boundary/check.mjs
+++ b/rust/checks/dependency-boundaries/check.mjs
@@ -25,6 +25,24 @@ const domain = metadata.packages.filter((pkg) =>
pathFromRoot(pkg.manifest_path).startsWith("rust/crates/"),
);
+const httpOwners = new Set([
+ "rust/crates/core/Cargo.toml",
+ "rust/crates/assets/Cargo.toml",
+ "rust/crates/location-dataset/Cargo.toml",
+]);
+
+for (const pkg of metadata.packages) {
+ const manifest = pathFromRoot(pkg.manifest_path);
+ if (httpOwners.has(manifest)) continue;
+ for (const dependency of pkg.dependencies) {
+ if (dependency.name !== "reqwest" || dependency.kind === "dev") continue;
+ console.error(
+ `${manifest}: use ente-core::http instead of a production reqwest dependency`,
+ );
+ process.exitCode = 1;
+ }
+}
+
if (!domain.length) {
console.error(`${resolve(root, "rust/crates")}: found no domain crates`);
process.exitCode = 1;
diff --git a/rust/checks/binding-boundary/test.mjs b/rust/checks/dependency-boundaries/test.mjs
similarity index 70%
rename from rust/checks/binding-boundary/test.mjs
rename to rust/checks/dependency-boundaries/test.mjs
index 78c556208d..0f985167c6 100644
--- a/rust/checks/binding-boundary/test.mjs
+++ b/rust/checks/dependency-boundaries/test.mjs
@@ -49,6 +49,28 @@ result = run({ deleted: true });
assert.equal(result.status, 0, result.stderr);
assert.equal(result.stderr, "");
+for (const dependencyKind of [
+ "dependencies",
+ "build-dependencies",
+ `target.'cfg(target_arch = "wasm32")'.dependencies`,
+]) {
+ result = run({ framework: "reqwest", dependencyKind });
+ assert.equal(result.status, 1, result.stderr);
+ assert.match(result.stderr, /use ente-core::http instead of a production reqwest dependency/);
+}
+
+result = run({ framework: "reqwest" });
+assert.equal(result.status, 0, result.stderr);
+
+result = run({ framework: "reqwest", bindingDependencyKind: "dependencies" });
+assert.equal(result.status, 1, result.stderr);
+assert.match(result.stderr, /rust\/bindings\/wasm\/lib\/Cargo\.toml: use ente-core::http/);
+
+for (const domainName of ["core", "assets", "location-dataset"]) {
+ result = run({ framework: "reqwest", dependencyKind: "dependencies", domainName });
+ assert.equal(result.status, 0, result.stderr);
+}
+
function run({
source = "pub fn domain() {}\n",
framework,
@@ -56,14 +78,17 @@ function run({
empty = false,
unregistered = false,
deleted = false,
+ dependencyKind = "dev-dependencies",
+ domainName = "domain",
+ bindingDependencyKind,
} = {}) {
- const root = mkdtempSync(join(tmpdir(), "ente-rust-binding-"));
+ const root = mkdtempSync(join(tmpdir(), "ente-rust-dependencies-"));
try {
spawn("git", ["init", "-q"], root);
if (empty) {
write(root, "rust/Cargo.toml", '[workspace]\nresolver = "2"\n');
} else {
- const members = ["crates/domain", "bindings/wasm/lib"];
+ const members = [`crates/${domainName}`, "bindings/wasm/lib"];
if (framework) members.push("vendor/framework");
write(
root,
@@ -71,17 +96,22 @@ function run({
`[workspace]\nmembers = ${JSON.stringify(members)}\nresolver = "2"\n`,
);
const dependencies = framework
- ? `\n[dev-dependencies]\nbinding = { package = ${JSON.stringify(framework)}, path = "../../vendor/framework" }\n`
+ ? `\n[${dependencyKind}]\nbinding = { package = ${JSON.stringify(framework)}, path = "../../vendor/framework" }\n`
: binding
? '\n[dependencies]\nbinding = { package = "ente-binding", path = "../../bindings/wasm/lib" }\n'
: "";
write(
root,
- "rust/crates/domain/Cargo.toml",
- packageToml("domain", dependencies),
+ `rust/crates/${domainName}/Cargo.toml`,
+ packageToml(domainName, dependencies),
);
- write(root, "rust/crates/domain/src/lib.rs", source);
- write(root, "rust/bindings/wasm/lib/Cargo.toml", packageToml("ente-binding"));
+ write(root, `rust/crates/${domainName}/src/lib.rs`, source);
+ write(root, "rust/bindings/wasm/lib/Cargo.toml", packageToml(
+ "ente-binding",
+ bindingDependencyKind
+ ? `\n[${bindingDependencyKind}]\nhttp = { package = ${JSON.stringify(framework)}, path = "../../../vendor/framework" }\n`
+ : "",
+ ));
write(root, "rust/bindings/wasm/lib/src/lib.rs", "pub fn binding() {}\n");
if (framework) {
write(root, "rust/vendor/framework/Cargo.toml", packageToml(framework));
diff --git a/rust/crates/contacts/tests/contacts.rs b/rust/crates/contacts/tests/contacts.rs
index 39dcacd2b0..f19798f915 100644
--- a/rust/crates/contacts/tests/contacts.rs
+++ b/rust/crates/contacts/tests/contacts.rs
@@ -507,6 +507,11 @@ async fn run_legacy_kit_stage(endpoint: &str, owner: &mut legacy_kit::LegacyKitO
waiting_handle.session().status,
LegacyKitRecoveryStatus::Waiting
);
+ assert!(matches!(
+ ente_legacy::update_kit_recovery_notice(&owner.owner_session, &waiting_kit.kit.id, 168)
+ .await,
+ Err(ente_legacy::Error::ActiveRecoverySession)
+ ));
assert!(
waiting_handle.session().wait_till > 0,
"legacy kit waitTill should be remaining wait duration"
diff --git a/rust/crates/core/src/http.rs b/rust/crates/core/src/http.rs
index ecf2480f9e..37a6f6c81c 100644
--- a/rust/crates/core/src/http.rs
+++ b/rust/crates/core/src/http.rs
@@ -328,17 +328,9 @@ impl Response {
self.0.status().as_u16()
}
- pub fn header(&self, name: &str) -> Option<&str> {
- self.0.headers().get(name).and_then(|v| v.to_str().ok())
- }
-
- pub fn headers(&self) -> &reqwest::header::HeaderMap {
- self.0.headers()
- }
-
- pub fn error_for_status(self) -> Result<Self, Error> {
+ pub fn error_for_status(self) -> Result<SuccessResponse, Error> {
if self.0.status().is_success() {
- Ok(self)
+ Ok(SuccessResponse(self.0))
} else {
Err(Error::Http {
status: self.0.status().as_u16(),
@@ -347,13 +339,13 @@ impl Response {
}
}
- pub async fn error_for_code(self) -> Result<Self, Error> {
+ pub async fn error_for_code(self) -> Result<SuccessResponse, Error> {
if self.0.status().is_success() {
- return Ok(self);
+ return Ok(SuccessResponse(self.0));
}
let status = self.status();
let path = self.0.url().path().to_owned();
- match serde_json::from_slice::<ApiErrorEnvelope>(&self.bytes().await?) {
+ match serde_json::from_slice::<ApiErrorEnvelope>(&self.0.bytes().await?) {
Ok(envelope) => Err(Error::Api {
status,
path,
@@ -362,6 +354,15 @@ impl Response {
Err(_) => Err(Error::Http { status, path }),
}
}
+}
+
+#[derive(Debug)]
+pub struct SuccessResponse(reqwest::Response);
+
+impl SuccessResponse {
+ pub fn headers(&self) -> &reqwest::header::HeaderMap {
+ self.0.headers()
+ }
pub async fn json<T: DeserializeOwned>(self) -> Result<T, Error> {
serde_json::from_slice(&self.0.bytes().await?).map_err(|e| Error::Parse(ParseError(e)))
@@ -384,9 +385,9 @@ mod body_stream {
use bytes::Bytes;
use futures_core::Stream;
- use super::{Error, Response};
+ use super::{Error, SuccessResponse};
- impl Response {
+ impl SuccessResponse {
pub fn bytes_stream(self) -> impl Stream<Item = Result<Bytes, Error>> + Send {
BytesStream(Box::pin(self.0.bytes_stream()))
}
@@ -765,23 +766,6 @@ mod tests {
mock.assert_async().await;
}
- #[tokio::test]
- async fn status_and_header_read_directly() {
- let mut server = Server::new_async().await;
- server
- .mock("GET", "/maybe")
- .with_status(404)
- .with_header("x-request-id", "rid")
- .create_async()
- .await;
-
- let api = api(&server, None);
- let response = api.get("/maybe").send().await.unwrap();
- assert_eq!(response.status(), 404);
- assert_eq!(response.header("x-request-id"), Some("rid"));
- assert_eq!(response.header("x-absent"), None);
- }
-
#[tokio::test]
async fn bytes_stream_yields_the_body() {
let body: Vec<u8> = (0..100_000).map(|i| (i % 251) as u8).collect();
diff --git a/rust/crates/legacy/src/client/contact.rs b/rust/crates/legacy/src/client/contact.rs
index 5b093d5a57..f20e9933ef 100644
--- a/rust/crates/legacy/src/client/contact.rs
+++ b/rust/crates/legacy/src/client/contact.rs
@@ -1,11 +1,10 @@
use ente_accounts::auth::KeyAttributes;
use ente_core::crypto::{self, sealed};
-use ente_core::http;
use ente_core::{Session, b64};
use serde::{Deserialize, Serialize};
use sha2::{Digest, Sha256};
-use super::current_recovery_key;
+use super::{current_recovery_key, map_recovery_notice_error};
use crate::{Error, Result};
#[derive(Debug, Clone, Copy, Serialize, Deserialize, PartialEq, Eq)]
@@ -157,28 +156,18 @@ pub async fn update_recovery_notice(
emergency_contact_id: i64,
recovery_notice_in_days: i32,
) -> Result<()> {
- let path = "/emergency-contacts/update-recovery-notice";
- let response = session
+ session
.api
- .post(path)
+ .post("/emergency-contacts/update-recovery-notice")
.json(&LegacyUpdateRecoveryNoticeRequest {
emergency_contact_id,
recovery_notice_in_days,
})
.send()
- .await?;
- if response.status() == 400 {
- return if response.text().await?.contains("active recovery session") {
- Err(Error::ActiveRecoverySession)
- } else {
- Err(http::Error::Http {
- status: 400,
- path: path.into(),
- }
- .into())
- };
- }
- response.error_for_status()?;
+ .await?
+ .error_for_code()
+ .await
+ .map_err(map_recovery_notice_error)?;
Ok(())
}
diff --git a/rust/crates/legacy/src/client/kit/mod.rs b/rust/crates/legacy/src/client/kit/mod.rs
index 097345937b..a81f512d87 100644
--- a/rust/crates/legacy/src/client/kit/mod.rs
+++ b/rust/crates/legacy/src/client/kit/mod.rs
@@ -2,12 +2,11 @@ mod owner_blob;
use ente_accounts::auth::KeyAttributes;
use ente_core::crypto::{self, Key, SecretVec, secretbox};
-use ente_core::http;
use ente_core::{Session, b64};
use serde::{Deserialize, Serialize};
use uuid::Uuid;
-use super::current_recovery_key;
+use super::{current_recovery_key, map_recovery_notice_error};
use crate::kit::{
LEGACY_KIT_PAYLOAD_VERSION, LegacyKit, LegacyKitCreateResult, LegacyKitOwnerRecoverySession,
LegacyKitRecoveryInitiator, LegacyKitRecoverySession, LegacyKitShare, LegacyKitVariant,
@@ -98,28 +97,18 @@ pub async fn update_kit_recovery_notice(
notice_period_in_hours: i32,
) -> Result<()> {
validate_notice_period(notice_period_in_hours)?;
- let path = "/legacy-kits/update-recovery-notice";
- let response = session
+ session
.api
- .post(path)
+ .post("/legacy-kits/update-recovery-notice")
.json(&LegacyKitUpdateRecoveryNoticeRequest {
kit_id: kit_id.to_string(),
notice_period_in_hours,
})
.send()
- .await?;
- if response.status() == 400 {
- return if response.text().await?.contains("active recovery session") {
- Err(Error::ActiveRecoverySession)
- } else {
- Err(http::Error::Http {
- status: 400,
- path: path.into(),
- }
- .into())
- };
- }
- response.error_for_status()?;
+ .await?
+ .error_for_code()
+ .await
+ .map_err(map_recovery_notice_error)?;
Ok(())
}
diff --git a/rust/crates/legacy/src/client/mod.rs b/rust/crates/legacy/src/client/mod.rs
index db884eb66d..4cdc3f92fb 100644
--- a/rust/crates/legacy/src/client/mod.rs
+++ b/rust/crates/legacy/src/client/mod.rs
@@ -17,9 +17,18 @@ pub use recovery::{
};
use ente_accounts::auth::{self, KeyAttributes};
-use ente_core::{Session, crypto::SecretVec};
+use ente_core::{Session, crypto::SecretVec, http};
-use crate::Result;
+use crate::{Error, Result};
+
+fn map_recovery_notice_error(error: http::Error) -> Error {
+ match &error {
+ http::Error::Api { code, .. } if code == "ACTIVE_RECOVERY_SESSION" => {
+ Error::ActiveRecoverySession
+ }
+ _ => error.into(),
+ }
+}
fn current_recovery_key(session: &Session, key_attributes: &KeyAttributes) -> Result<SecretVec> {
let recovery_key = auth::get_recovery_key(&session.master_key, key_attributes)?;
diff --git a/rust/crates/legacy/src/kit/recovery.rs b/rust/crates/legacy/src/kit/recovery.rs
index 93819dac31..0e5f6b5fd9 100644
--- a/rust/crates/legacy/src/kit/recovery.rs
+++ b/rust/crates/legacy/src/kit/recovery.rs
@@ -3,7 +3,7 @@ use std::sync::Arc;
use ente_accounts::auth::{self, KeyAttributes, SrpSession};
use ente_core::b64;
use ente_core::crypto::{self, SecretString, SecretVec, sealed, secretbox};
-use ente_core::http::{Api, ApiConfig, Http, Response};
+use ente_core::http::{self, Api, ApiConfig, Http};
use serde::{Deserialize, Serialize};
use uuid::Uuid;
@@ -65,15 +65,16 @@ impl LegacyKitRecoveryClient {
let first_share = shares.first().ok_or_else(|| {
Error::InvalidInput("at least two legacy kit shares are required".into())
})?;
- let response = self
+ let challenge = self
.api
.post("/legacy-kits/recovery/challenge")
.json(&LegacyKitChallengeRequest {
kit_id: first_share.kit_id.clone(),
})
.send()
- .await?;
- let challenge = active_kit_response(response)?
+ .await?
+ .error_for_status()
+ .map_err(map_kit_error)?
.json::<LegacyKitChallengeResponse>()
.await?;
self.open_from_encrypted_challenge(shares, &challenge.encrypted_challenge, email)
@@ -120,8 +121,9 @@ impl LegacyKitRecoveryClient {
email,
})
.send()
- .await?;
- let response = active_kit_response(response)?
+ .await?
+ .error_for_status()
+ .map_err(map_kit_error)?
.json::<LegacyKitOpenRecoveryResponse>()
.await?;
Ok(LegacyKitRecoveryHandle {
@@ -230,11 +232,10 @@ impl LegacyKitRecoveryHandle {
}
}
-fn active_kit_response(response: Response) -> Result<Response> {
- if response.status() == 404 {
- Err(Error::LegacyKitInactive)
- } else {
- Ok(response.error_for_status()?)
+fn map_kit_error(error: http::Error) -> Error {
+ match error.status_code() {
+ Some(404) => Error::LegacyKitInactive,
+ _ => error.into(),
}
}
diff --git a/rust/scripts/lint.sh b/rust/scripts/lint.sh
index d8e4af53d7..b72185626e 100755
--- a/rust/scripts/lint.sh
+++ b/rust/scripts/lint.sh
@@ -8,8 +8,8 @@ python3 checks/cargo-versions/check.py ..
python3 checks/cargo-versions/test.py
python3 checks/cargo-workspace-dependencies/check.py ..
python3 checks/cargo-workspace-dependencies/test.py
-node checks/binding-boundary/check.mjs ..
-node checks/binding-boundary/test.mjs
+node checks/dependency-boundaries/check.mjs ..
+node checks/dependency-boundaries/test.mjs
cargo fmt --check
cargo clippy --locked --all-targets --features museum,ente-ml/ml-assets
cargo audit
diff --git a/server/ente/errors.go b/server/ente/errors.go
index 2c9fbabc1a..705efb8bd7 100644
--- a/server/ente/errors.go
+++ b/server/ente/errors.go
@@ -288,6 +288,9 @@ const (
LinkEditNotAllowed ErrorCode = "LINK_EDIT_NOT_ALLOWED"
LinkDeviceLimitExceeded ErrorCode = "LINK_DEVICE_LIMIT_EXCEEDED"
+ LinkExpired ErrorCode = "LINK_EXPIRED"
+ LinkDisabled ErrorCode = "LINK_DISABLED"
+ LinkUnavailable ErrorCode = "LINK_UNAVAILABLE"
ActiveRecoverySession ErrorCode = "ACTIVE_RECOVERY_SESSION"
)
diff --git a/server/pkg/middleware/collection_link.go b/server/pkg/middleware/collection_link.go
index 3cf4839371..16350466f3 100644
--- a/server/pkg/middleware/collection_link.go
+++ b/server/pkg/middleware/collection_link.go
@@ -76,13 +76,13 @@ func (m *CollectionLinkMiddleware) Authenticate(urlSanitizer func(_ *gin.Context
return
}
if publicCollectionSummary.IsDisabled {
- c.AbortWithStatusJSON(http.StatusGone, gin.H{"error": "disabled token"})
+ c.AbortWithStatusJSON(http.StatusGone, gin.H{"code": ente.LinkDisabled, "error": "disabled token"})
return
}
isFreeUser, err := m.validateOwnersSubscription(c, publicCollectionSummary.CollectionID)
if err != nil {
logrus.WithError(err).Warn("failed to verify active paid subscription")
- c.AbortWithStatusJSON(http.StatusGone, gin.H{"error": "no active subscription"})
+ c.AbortWithStatusJSON(http.StatusGone, gin.H{"code": ente.LinkUnavailable, "error": "no active subscription"})
return
}
if isFreeUser {
@@ -91,7 +91,7 @@ func (m *CollectionLinkMiddleware) Authenticate(urlSanitizer func(_ *gin.Context
if publicCollectionSummary.ValidTill > 0 && // expiry time is defined, 0 indicates no expiry
publicCollectionSummary.ValidTill < time.Microseconds() {
- c.AbortWithStatusJSON(http.StatusGone, gin.H{"error": "expired token"})
+ c.AbortWithStatusJSON(http.StatusGone, gin.H{"code": ente.LinkExpired, "error": "expired token"})
return
}
if publicCollectionSummary.PassHash != nil && *publicCollectionSummary.PassHash != "" {
@@ -127,7 +127,7 @@ func (m *CollectionLinkMiddleware) Authenticate(urlSanitizer func(_ *gin.Context
if publicCollectionSummary.ValidTill > 0 && // expiry time is defined, 0 indicates no expiry
publicCollectionSummary.ValidTill < time.Microseconds() {
- c.AbortWithStatusJSON(http.StatusGone, gin.H{"error": "expired token"})
+ c.AbortWithStatusJSON(http.StatusGone, gin.H{"code": ente.LinkExpired, "error": "expired token"})
return
}
diff --git a/server/pkg/middleware/file_link.go b/server/pkg/middleware/file_link.go
index ed7a2ad4de..8558b6b101 100644
--- a/server/pkg/middleware/file_link.go
+++ b/server/pkg/middleware/file_link.go
@@ -60,12 +60,12 @@ func (m *FileLinkMiddleware) Authenticate(urlSanitizer func(_ *gin.Context) stri
return
}
if fileLinkRow.IsDisabled {
- c.AbortWithStatusJSON(http.StatusGone, gin.H{"error": "disabled token"})
+ c.AbortWithStatusJSON(http.StatusGone, gin.H{"code": ente.LinkDisabled, "error": "disabled token"})
return
}
if fileLinkRow.ValidTill > 0 && // expiry time is defined, 0 indicates no expiry
fileLinkRow.ValidTill < time.Microseconds() {
- c.AbortWithStatusJSON(http.StatusGone, gin.H{"error": "expired token"})
+ c.AbortWithStatusJSON(http.StatusGone, gin.H{"code": ente.LinkExpired, "error": "expired token"})
return
}
if fileLinkRow.PassHash != nil && *fileLinkRow.PassHash != "" {
@@ -100,7 +100,7 @@ func (m *FileLinkMiddleware) Authenticate(urlSanitizer func(_ *gin.Context) stri
if fileLinkRow.ValidTill > 0 && // expiry time is defined, 0 indicates no expiry
fileLinkRow.ValidTill < time.Microseconds() {
- c.AbortWithStatusJSON(http.StatusGone, gin.H{"error": "expired token"})
+ c.AbortWithStatusJSON(http.StatusGone, gin.H{"code": ente.LinkExpired, "error": "expired token"})
return
}
diff --git a/server/pkg/middleware/file_link_test.go b/server/pkg/middleware/file_link_test.go
new file mode 100644
index 0000000000..81b8e0266e
--- /dev/null
+++ b/server/pkg/middleware/file_link_test.go
@@ -0,0 +1,50 @@
+package middleware
+
+import (
+ "net/http"
+ "net/http/httptest"
+ "testing"
+
+ "github.com/ente/museum/internal/testutil"
+ "github.com/ente/museum/pkg/repo/public"
+ "github.com/gin-gonic/gin"
+ "github.com/stretchr/testify/require"
+)
+
+func TestFileLinkGoneResponsePreservesLegacyError(t *testing.T) {
+ testutil.WithServerRoot(t)
+ db := testutil.RequireTestDB(t)
+
+ for _, tc := range []struct {
+ name string
+ disabled bool
+ body string
+ }{
+ {"expired", false, `{"code":"LINK_EXPIRED","error":"expired token"}`},
+ {"disabled", true, `{"code":"LINK_DISABLED","error":"disabled token"}`},
+ } {
+ t.Run(tc.name, func(t *testing.T) {
+ token := "pft_middleware_" + tc.name
+ _, err := db.Exec(`INSERT INTO public_file_tokens
+ (id, file_id, owner_id, app, access_token, is_disabled, valid_till)
+ VALUES ($1, 1, 1, 'photos', $1, $2, 1)`, token, tc.disabled)
+ require.NoError(t, err)
+ t.Cleanup(func() {
+ _, err := db.Exec("DELETE FROM public_file_tokens WHERE id = $1", token)
+ require.NoError(t, err)
+ })
+
+ middleware := &FileLinkMiddleware{FileLinkRepo: public.NewFileLinkRepo(db)}
+ router := gin.New()
+ router.GET("/file-link/info", middleware.Authenticate(func(c *gin.Context) string {
+ return c.FullPath()
+ }), func(c *gin.Context) { c.Status(http.StatusNoContent) })
+ req := httptest.NewRequest(http.MethodGet, "/file-link/info", nil)
+ req.Header.Set("X-Auth-Access-Token", token)
+ response := httptest.NewRecorder()
+ router.ServeHTTP(response, req)
+ require.Equal(t, http.StatusGone, response.Code)
+ require.JSONEq(t, tc.body, response.Body.String())
+ })
+ }
+}
diff --git a/server/pkg/middleware/memory_share.go b/server/pkg/middleware/memory_share.go
index 35d3f15d51..09f272716c 100644
--- a/server/pkg/middleware/memory_share.go
+++ b/server/pkg/middleware/memory_share.go
@@ -33,11 +33,11 @@ func (m *MemoryShareMiddleware) Authenticate(urlSanitizer func(_ *gin.Context) s
}
if share.IsDeleted {
- c.AbortWithStatusJSON(http.StatusGone, gin.H{"error": "memory share is deleted"})
+ c.AbortWithStatusJSON(http.StatusGone, gin.H{"code": ente.LinkDisabled, "error": "memory share is deleted"})
return
}
if ente.IsMemoryShareExpired(share.CreatedAt) {
- c.AbortWithStatusJSON(http.StatusGone, gin.H{"error": "expired token"})
+ c.AbortWithStatusJSON(http.StatusGone, gin.H{"code": ente.LinkExpired, "error": "expired token"})
return
}
diff --git a/web/apps/albums/src/public-album/page/PublicAlbumPage.tsx b/web/apps/albums/src/public-album/page/PublicAlbumPage.tsx
index b3eba6f7df..9d79e2f3d5 100644
--- a/web/apps/albums/src/public-album/page/PublicAlbumPage.tsx
+++ b/web/apps/albums/src/public-album/page/PublicAlbumPage.tsx
@@ -138,10 +138,6 @@ const loadJoinPublicAlbumRedirect = () =>
const publicAlbumAllFilesCollectionID = 0;
-const isDeviceLimitExceededError = async (e: unknown) =>
- isHTTPErrorWithStatus(e, 429) ||
- (await isMuseumHTTPError(e, 403, "LINK_DEVICE_LIMIT_EXCEEDED"));
-
const accessTokenFromURL = (url: URL) =>
url.searchParams.get("t") || url.pathname.split("/").find(Boolean);
@@ -437,7 +433,11 @@ export default function PublicAlbumPage() {
}
}
} catch (e) {
- const isDeviceLimitExceeded = await isDeviceLimitExceededError(e);
+ const isDeviceLimitExceeded = await isMuseumHTTPError(
+ e,
+ 403,
+ "LINK_DEVICE_LIMIT_EXCEEDED",
+ );
if (
isHTTPErrorWithStatus(e, 401) ||
isHTTPErrorWithStatus(e, 410) ||
diff --git a/web/apps/embed/src/pages/index.tsx b/web/apps/embed/src/pages/index.tsx
index 517c475b19..292d80b196 100644
--- a/web/apps/embed/src/pages/index.tsx
+++ b/web/apps/embed/src/pages/index.tsx
@@ -40,10 +40,6 @@ import {
verifyPublicAlbumPassword,
} from "../services/public-collection";
-const isDeviceLimitExceededError = async (e: unknown) =>
- isHTTPErrorWithStatus(e, 429) ||
- (await isMuseumHTTPError(e, 403, "LINK_DEVICE_LIMIT_EXCEEDED"));
-
const accessTokenFromURL = (url: URL) =>
url.searchParams.get("t") || url.pathname.split("/").find(Boolean);
@@ -118,7 +114,11 @@ export default function EmbedGallery() {
}
}
} catch (e) {
- const isDeviceLimitExceeded = await isDeviceLimitExceededError(e);
+ const isDeviceLimitExceeded = await isMuseumHTTPError(
+ e,
+ 403,
+ "LINK_DEVICE_LIMIT_EXCEEDED",
+ );
if (
isHTTPErrorWithStatus(e, 401) ||
isHTTPErrorWithStatus(e, 410) ||
diff --git a/web/apps/photos/src/pages/gallery.tsx b/web/apps/photos/src/pages/gallery.tsx
index 5adfd846c4..49975567bc 100644
--- a/web/apps/photos/src/pages/gallery.tsx
+++ b/web/apps/photos/src/pages/gallery.tsx
@@ -553,10 +553,7 @@ const Page: React.FC = () => {
log.error("Failed to join album", error);
showMiniDialog({
title: t("error"),
- message:
- t("album_join_failed") +
- ": " +
- (error as Error).message,
+ message: t("album_join_failed"),
});
}
}
diff --git a/web/apps/photos/src/services/join-album.ts b/web/apps/photos/src/services/join-album.ts
index e101edb52b..0672096ebd 100644
--- a/web/apps/photos/src/services/join-album.ts
+++ b/web/apps/photos/src/services/join-album.ts
@@ -1,6 +1,6 @@
import { savedKeyAttributes } from "ente-accounts/services/accounts-db";
import { boxSeal, fromB64 } from "ente-base/crypto";
-import { authenticatedRequestHeaders } from "ente-base/http";
+import { authenticatedRequestHeaders, ensureOk } from "ente-base/http";
import {
clearJoinAlbumContext,
getJoinAlbumContext,
@@ -33,23 +33,7 @@ const joinPublicAlbum = async (
body: JSON.stringify({ collectionID, encryptedKey }),
});
- if (!response.ok) {
- log.error("Album join API failed", {
- collectionID,
- status: response.status,
- });
- let errorMessage = `Failed to join album (status: ${response.status})`;
- try {
- const errorData = (await response.json()) as {
- message?: string;
- code?: string;
- };
- errorMessage = errorData.message ?? errorMessage;
- } catch {
- // Ignore parse error, use default message
- }
- throw new Error(errorMessage);
- }
+ ensureOk(response);
};
export const processPendingAlbumJoin = async (): Promise<number | null> => {
diff --git a/web/apps/share/src/hooks/use-collection-share.ts b/web/apps/share/src/hooks/use-collection-share.ts
index f61b132d4e..8ff9130e8a 100644
--- a/web/apps/share/src/hooks/use-collection-share.ts
+++ b/web/apps/share/src/hooks/use-collection-share.ts
@@ -4,6 +4,7 @@ import {
HTTPError,
isHTTP401Error,
isHTTPErrorWithStatus,
+ isMuseumHTTPError,
} from "ente-base/http";
import { apiOrigin } from "ente-base/origins";
import { extractCollectionKeyFromShareURL } from "ente-gallery/services/share";
@@ -112,40 +113,30 @@ const saveLinkDeviceToken = (
const collectionShareLoadError = async (
err: unknown,
): Promise<CollectionShareLoadError> => {
- if (err instanceof HTTPError && err.res.status === 410) {
- try {
- const payload = (await err.res.clone().json()) as {
- error?: string;
- };
- if (payload.error === "expired token") {
- return {
- title: "Link expired",
- message:
- "This link has either expired or has been disabled.",
- };
- }
- } catch {
- // Ignore payload parse failures and use the generic gone-state copy.
- }
+ if (await isMuseumHTTPError(err, 410, "LINK_EXPIRED")) {
+ return { title: "Link expired", message: "This link has expired." };
+ }
+ if (await isMuseumHTTPError(err, 403, "LINK_DEVICE_LIMIT_EXCEEDED")) {
return {
- title: "Link expired",
- message: "This link has either expired or has been disabled.",
+ title: "Too many viewers",
+ message:
+ "This link has reached its device limit. Ask the owner to increase the limit or try again later.",
};
}
if (isHTTPErrorWithStatus(err, 429)) {
return {
- title: "Too many viewers",
- message:
- "This link has reached its device limit. Ask the owner to increase the limit or try again later.",
+ title: "Too many requests",
+ message: "Please try again later.",
};
}
if (
isHTTP401Error(err) ||
isHTTPErrorWithStatus(err, 403) ||
- isHTTPErrorWithStatus(err, 404)
+ isHTTPErrorWithStatus(err, 404) ||
+ isHTTPErrorWithStatus(err, 410)
) {
return {
title: "Unable to open this collection",
@@ -187,7 +178,7 @@ const shouldPreserveLoadedStateOnSilentRefreshError = (err: unknown) => {
return true;
}
- return err.res.status >= 500;
+ return err.res.status === 429 || err.res.status >= 500;
};
export const useCollectionShare = (): UseCollectionShareResult => {
diff --git a/web/apps/share/src/services/file-share.ts b/web/apps/share/src/services/file-share.ts
index 6960b9252e..e8e253c9fe 100644
--- a/web/apps/share/src/services/file-share.ts
+++ b/web/apps/share/src/services/file-share.ts
@@ -9,6 +9,8 @@ import {
} from "ente-base/crypto";
import { fetchFileLinkFile } from "ente-base/file-download";
import {
+ HTTPError,
+ isMuseumHTTPError,
linkDeviceTokenFromResponse,
linkDeviceTokenRequestHeader,
} from "ente-base/http";
@@ -24,22 +26,6 @@ import type {
const deviceLimitExceededMessage =
"This link has been viewed on too many devices. Please contact the owner.";
-const isDeviceLimitExceededResponse = async (response: Response) => {
- if (response.status === 429) {
- return true;
- }
- if (response.status !== 403) {
- return false;
- }
-
- try {
- const payload = (await response.clone().json()) as { code?: string };
- return payload.code === "LINK_DEVICE_LIMIT_EXCEEDED";
- } catch {
- return false;
- }
-};
-
export const extractFileKeyFromURL = async (
url: URL,
): Promise<LinkKeyMaterial | null> => {
@@ -82,20 +68,21 @@ export const fetchFileInfo = async (
});
if (!response.ok) {
- if (await isDeviceLimitExceededResponse(response)) {
+ const error = new HTTPError(response);
+ if (await isMuseumHTTPError(error, 403, "LINK_DEVICE_LIMIT_EXCEEDED")) {
throw new Error(deviceLimitExceededMessage);
}
+ if (response.status === 429) {
+ throw new Error("Too many requests. Please try again later.");
+ }
if (response.status === 410) {
- let errorBody: { error?: string } | undefined;
- try {
- errorBody = (await response.json()) as { error?: string };
- } catch {
- // Ignore JSON parse errors and fall back to the generic message.
- }
- if (errorBody?.error === "expired token") {
+ if (await isMuseumHTTPError(error, 410, "LINK_EXPIRED")) {
throw new Error("This link has expired.");
}
- throw new Error("This link has been deleted by the owner.");
+ if (await isMuseumHTTPError(error, 410, "LINK_DISABLED")) {
+ throw new Error("This link has been deleted by the owner.");
+ }
+ throw new Error("This link is no longer available.");
}
throw new Error(`Failed to fetch file`);
}
@@ -403,7 +390,13 @@ export const downloadFile = async (
const response = await fetchFileLinkFile(accessToken);
if (!response.ok) {
- if (await isDeviceLimitExceededResponse(response)) {
+ if (
+ await isMuseumHTTPError(
+ new HTTPError(response),
+ 403,
+ "LINK_DEVICE_LIMIT_EXCEEDED",
+ )
+ ) {
throw new Error(deviceLimitExceededMessage);
}
throw new Error(`Failed to download file: ${response.statusText}`);
diff --git a/web/packages/base/http.ts b/web/packages/base/http.ts
index b11104691b..0381a90c04 100644
--- a/web/packages/base/http.ts
+++ b/web/packages/base/http.ts
@@ -97,7 +97,7 @@ export const isMuseumHTTPError = async (
try {
const payload = z
.object({ code: z.string() })
- .parse(await e.res.json());
+ .parse(await e.res.clone().json());
return payload.code == code;
} catch (e) {
log.warn("Ignoring error when parsing error payload", e);
diff --git a/web/packages/contacts/wasm.test.ts b/web/packages/contacts/wasm.test.ts
index ca688406b4..1a1547a2dd 100644
--- a/web/packages/contacts/wasm.test.ts
+++ b/web/packages/contacts/wasm.test.ts
@@ -157,6 +157,7 @@ describe("Legacy", () => {
othersRecoverySession: [{ ...recovery, status: "READY" }],
};
let updateBody: unknown;
+ let recoveryErrorBody: object = { code: "ACTIVE_RECOVERY_SESSION" };
mockFetch(async (request) => {
switch (new URL(request.url).pathname) {
case "/emergency-contacts/info":
@@ -168,10 +169,7 @@ describe("Legacy", () => {
updateBody = await request.json();
return new Response(null, { status: 204 });
case "/emergency-contacts/update-recovery-notice":
- return new Response(
- "Cannot update during an active recovery session",
- { status: 400 },
- );
+ return Response.json(recoveryErrorBody, { status: 400 });
default:
throw new Error(`Unexpected request: ${request.url}`);
}
@@ -195,6 +193,13 @@ describe("Legacy", () => {
await expect(
legacy.updateRecoveryNotice(session, 43, 30),
).rejects.toMatchObject({ name: "active_recovery_session" });
+ recoveryErrorBody = {
+ code: "BAD_REQUEST",
+ message: "Cannot update during an active recovery session",
+ };
+ await expect(
+ legacy.updateRecoveryNotice(session, 43, 30),
+ ).rejects.not.toMatchObject({ name: "active_recovery_session" });
recovery.createdAt = Number.MAX_SAFE_INTEGER + 1;
await expect(legacy.getInfo(session)).rejects.toBeInstanceOf(Error);
} finally {