session-ios/SignalServiceKit/src/Util/OWSError.h

//
//  Copyright (c) 2018 Open Whisper Systems. All rights reserved.
//

NS_ASSUME_NONNULL_BEGIN

extern NSString *const OWSSignalServiceKitErrorDomain;

typedef NS_ENUM(NSInteger, OWSErrorCode) {
    OWSErrorCodeInvalidMethodParameters = 11,
    OWSErrorCodeUnableToProcessServerResponse = 12,
    OWSErrorCodeFailedToDecodeJson = 13,
    OWSErrorCodeFailedToEncodeJson = 14,
    OWSErrorCodeFailedToDecodeQR = 15,
    OWSErrorCodePrivacyVerificationFailure = 20,
    OWSErrorCodeUntrustedIdentity = 25,
    OWSErrorCodeFailedToSendOutgoingMessage = 30,
    OWSErrorCodeAssertionFailure = 31,
    OWSErrorCodeFailedToDecryptMessage = 100,
    OWSErrorCodeFailedToDecryptUDMessage = 101,
    OWSErrorCodeFailedToEncryptMessage = 110,
    OWSErrorCodeFailedToEncryptUDMessage = 111,
    OWSErrorCodeSignalServiceFailure = 1001,
    OWSErrorCodeSignalServiceRateLimited = 1010,
    OWSErrorCodeUserError = 2001,
    OWSErrorCodeNoSuchSignalRecipient = 777404,
    OWSErrorCodeMessageSendDisabledDueToPreKeyUpdateFailures = 777405,
    OWSErrorCodeMessageSendFailedToBlockList = 777406,
    OWSErrorCodeMessageSendNoValidRecipients = 777407,
    OWSErrorCodeContactsUpdaterRateLimit = 777408,
    OWSErrorCodeCouldNotWriteAttachmentData = 777409,
    OWSErrorCodeMessageDeletedBeforeSent = 777410,
    OWSErrorCodeDatabaseConversionFatalError = 777411,
    OWSErrorCodeMoveFileToSharedDataContainerError = 777412,
    OWSErrorCodeRegistrationMissing2FAPIN = 777413,
    OWSErrorCodeDebugLogUploadFailed = 777414,
    // A non-recoverable error occured while exporting a backup.
    OWSErrorCodeExportBackupFailed = 777415,
    // A possibly recoverable error occured while exporting a backup.
    OWSErrorCodeExportBackupError = 777416,
    // A non-recoverable error occured while importing a backup.
    OWSErrorCodeImportBackupFailed = 777417,
    // A possibly recoverable error occured while importing a backup.
    OWSErrorCodeImportBackupError = 777418,
    // A non-recoverable while importing or exporting a backup.
    OWSErrorCodeBackupFailure = 777419,
    OWSErrorCodeLocalAuthenticationError = 777420,
    OWSErrorCodeMessageRequestFailed = 777421,
    OWSErrorCodeMessageResponseFailed = 777422,
    OWSErrorCodeInvalidMessage = 777423,
    OWSErrorCodeProfileUpdateFailed = 777424,
    OWSErrorCodeAvatarWriteFailed = 777425,
    OWSErrorCodeAvatarUploadFailed = 777426,
};

extern NSString *const OWSErrorRecipientIdentifierKey;

extern NSError *OWSErrorWithCodeDescription(OWSErrorCode code, NSString *description);
extern NSError *OWSErrorMakeUntrustedIdentityError(NSString *description, NSString *recipientId);
extern NSError *OWSErrorMakeUnableToProcessServerResponseError(void);
extern NSError *OWSErrorMakeFailedToSendOutgoingMessageError(void);
extern NSError *OWSErrorMakeNoSuchSignalRecipientError(void);
extern NSError *OWSErrorMakeAssertionError(NSString *description);
extern NSError *OWSErrorMakeMessageSendDisabledDueToPreKeyUpdateFailuresError(void);
extern NSError *OWSErrorMakeMessageSendFailedDueToBlockListError(void);
extern NSError *OWSErrorMakeWriteAttachmentDataError(void);

NS_ASSUME_NONNULL_END
Narrow the scope of code run on SessionCipher queue And run all non-cipher code on the main thread. Note: Running encryption on the sessionCipher queue is more about serializing access to session mutations than it is about any performance gains. // FREEBIE 9 years ago			`//`
Copy DB setup / keying from Yap into conversion // FREEBIE 8 years ago			`// Copyright (c) 2018 Open Whisper Systems. All rights reserved.`
Narrow the scope of code run on SessionCipher queue And run all non-cipher code on the main thread. Note: Running encryption on the sessionCipher queue is more about serializing access to session mutations than it is about any performance gains. // FREEBIE 9 years ago			`//`
Don't crash when contact lookup is given nil contact // FREEBIE 9 years ago
			`NS_ASSUME_NONNULL_BEGIN`

			`extern NSString *const OWSSignalServiceKitErrorDomain;`

Device manager // FREEBIE 9 years ago			`typedef NS_ENUM(NSInteger, OWSErrorCode) {`
			`OWSErrorCodeInvalidMethodParameters = 11,`
			`OWSErrorCodeUnableToProcessServerResponse = 12,`
			`OWSErrorCodeFailedToDecodeJson = 13,`
New fingerprint format In coordination with Desktop and Android, iOS will be using all-numeric fingerprints, aka "Safety Numbers". Furthermore, the concept of verifying one identity and then the other has been removed. Instead we ask users to exchange a single number, or scan a single QR code. These credentials are built by combining the users identities. // FREEBIE 9 years ago			`OWSErrorCodeFailedToEncodeJson = 14,`
			`OWSErrorCodeFailedToDecodeQR = 15,`
Don't start expiration timer until message is sent. Started extracting a MessageSender class from TSMessagesManager+send for easier testability and in hopes of further slimming down that son of a gun. // FREEBIE 9 years ago			`OWSErrorCodePrivacyVerificationFailure = 20,`
identity change vs. share extension // FREEBIE 8 years ago			`OWSErrorCodeUntrustedIdentity = 25,`
Explain send failures for text and media messages Motivation ---------- We were often swallowing errors or yielding generic errors when it would be better to provide specific errors. We also didn't create an attachment when attachments failed to send, making it impossible to show the user what was happening with an in-progress or failed attachment. Primary Changes --------------- - Funnel all message sending through MessageSender, and remove message sending from MessagesManager. - Record most recent sending error so we can expose it in the UI - Can resend attachments. - Update message status for attachments, just like text messages - Extracted UploadingService from MessagesManager - Saving attachment stream before uploading gives uniform API for send vs. resend - update status for downloading transcript attachments - TSAttachments have a local id, separate from the server allocated id This allows us to save the attachment before the allocation request. Which is is good because: 1. can show feedback to user faster. 2. allows us to show an error when allocation fails. Code Cleanup ------------ - Replaced a lot of global singleton access with injected dependencies to make for easier testing. - Never save group meta messages. Rather than checking before (hopefully) every save, do it in the save method. - Don't use callbacks for sync code. - Handle errors on writing attachment data - Fix old long broken tests that weren't even running. =( - Removed dead code - Use constants vs define - Port flaky travis fixes from Signal-iOS // FREEBIE 9 years ago			`OWSErrorCodeFailedToSendOutgoingMessage = 30,`
Reusable UploadOperation based on extracted OWSOperation // FREEBIE 8 years ago			`OWSErrorCodeAssertionFailure = 31,`
Fix register w/o background fetch & stale push tokens * Separate account registration from push token registration * Provide better errors when validation fails (e.g. numbers don't match, numbers blank) * More logging during registration * Call success after setting phone number to avoid any future race condition This isn't currently causing problems, but it's unexpected that we'd mutate the state after calling a callback which might inuitively rely on that state. * Don't throw exception off thread when device keys 404's * Better async startup handling - move processing off main thread - reduce code duplication - don't wrap it in a transaction in the future case where we want to further access the DB // FREEBIE 9 years ago			`OWSErrorCodeFailedToDecryptMessage = 100,`
Respond to CR. 7 years ago			`OWSErrorCodeFailedToDecryptUDMessage = 101,`
Narrow the scope of code run on SessionCipher queue And run all non-cipher code on the main thread. Note: Running encryption on the sessionCipher queue is more about serializing access to session mutations than it is about any performance gains. // FREEBIE 9 years ago			`OWSErrorCodeFailedToEncryptMessage = 110,`
Respond to CR. 7 years ago			`OWSErrorCodeFailedToEncryptUDMessage = 111,`
provide custom copy for unauthorized messages This happens when someone has registered their number on another device. // FREEBIE 9 years ago			`OWSErrorCodeSignalServiceFailure = 1001,`
Rework concurrency in the signaling logic. // FREEBIE 9 years ago			`OWSErrorCodeSignalServiceRateLimited = 1010,`
Fix register w/o background fetch & stale push tokens * Separate account registration from push token registration * Provide better errors when validation fails (e.g. numbers don't match, numbers blank) * More logging during registration * Call success after setting phone number to avoid any future race condition This isn't currently causing problems, but it's unexpected that we'd mutate the state after calling a callback which might inuitively rely on that state. * Don't throw exception off thread when device keys 404's * Better async startup handling - move processing off main thread - reduce code duplication - don't wrap it in a transaction in the future case where we want to further access the DB // FREEBIE 9 years ago			`OWSErrorCodeUserError = 2001,`
Include reusable localized text in recipient-not-found error This way we can use it for calls as well. // FREEBIE 9 years ago			`OWSErrorCodeNoSuchSignalRecipient = 777404,`
Clean up prekey usage. // FREEBIE 9 years ago			`OWSErrorCodeMessageSendDisabledDueToPreKeyUpdateFailures = 777405,`
Block list is two words // FREEBIE 9 years ago			`OWSErrorCodeMessageSendFailedToBlockList = 777406,`
Respond to CR. // FREEBIE 9 years ago			`OWSErrorCodeMessageSendNoValidRecipients = 777407,`
Respond to CR. // FREEBIE 8 years ago			`OWSErrorCodeContactsUpdaterRateLimit = 777408,`
			`OWSErrorCodeCouldNotWriteAttachmentData = 777409,`
Don't resurrect zombies. 8 years ago			`OWSErrorCodeMessageDeletedBeforeSent = 777410,`
Improve the robustness of the migration logic. 8 years ago			`OWSErrorCodeDatabaseConversionFatalError = 777411,`
Add 2FA registration view. 8 years ago			`OWSErrorCodeMoveFileToSharedDataContainerError = 777412,`
Merge tag '2.21.0.1' 8 years ago			`OWSErrorCodeRegistrationMissing2FAPIN = 777413,`
Integrate with logs service. 8 years ago			`OWSErrorCodeDebugLogUploadFailed = 777414,`
Upload database and manifest files to CloudKit. 8 years ago			`// A non-recoverable error occured while exporting a backup.`
Export database for backup. 8 years ago			`OWSErrorCodeExportBackupFailed = 777415,`
Upload database and manifest files to CloudKit. 8 years ago			`// A possibly recoverable error occured while exporting a backup.`
			`OWSErrorCodeExportBackupError = 777416,`
Implement backup import logic. 8 years ago			`// A non-recoverable error occured while importing a backup.`
			`OWSErrorCodeImportBackupFailed = 777417,`
			`// A possibly recoverable error occured while importing a backup.`
			`OWSErrorCodeImportBackupError = 777418,`
Retry backup failures. 8 years ago			`// A non-recoverable while importing or exporting a backup.`
			`OWSErrorCodeBackupFailure = 777419,`
Add screen lock feature. 8 years ago			`OWSErrorCodeLocalAuthenticationError = 777420,`
Use websocket for sends. 8 years ago			`OWSErrorCodeMessageRequestFailed = 777421,`
			`OWSErrorCodeMessageResponseFailed = 777422,`
Organize attachments. 7 years ago			`OWSErrorCodeInvalidMessage = 777423,`
Respond to CR. 7 years ago			`OWSErrorCodeProfileUpdateFailed = 777424,`
Respond to CR. 7 years ago			`OWSErrorCodeAvatarWriteFailed = 777425,`
			`OWSErrorCodeAvatarUploadFailed = 777426,`
Device manager // FREEBIE 9 years ago			`};`

identity change vs. share extension // FREEBIE 8 years ago			`extern NSString *const OWSErrorRecipientIdentifierKey;`

Device manager // FREEBIE 9 years ago			`extern NSError OWSErrorWithCodeDescription(OWSErrorCode code, NSString description);`
identity change vs. share extension // FREEBIE 8 years ago			`extern NSError OWSErrorMakeUntrustedIdentityError(NSString description, NSString *recipientId);`
Proper function prototypes // FREEBIE 8 years ago			`extern NSError *OWSErrorMakeUnableToProcessServerResponseError(void);`
			`extern NSError *OWSErrorMakeFailedToSendOutgoingMessageError(void);`
			`extern NSError *OWSErrorMakeNoSuchSignalRecipientError(void);`
Reusable UploadOperation based on extracted OWSOperation // FREEBIE 8 years ago			`extern NSError OWSErrorMakeAssertionError(NSString description);`
Proper function prototypes // FREEBIE 8 years ago			`extern NSError *OWSErrorMakeMessageSendDisabledDueToPreKeyUpdateFailuresError(void);`
Respond to CR. 7 years ago			`extern NSError *OWSErrorMakeMessageSendFailedDueToBlockListError(void);`
Proper function prototypes // FREEBIE 8 years ago			`extern NSError *OWSErrorMakeWriteAttachmentDataError(void);`
Don't crash when contact lookup is given nil contact // FREEBIE 9 years ago
			`NS_ASSUME_NONNULL_END`