NetNewsWire/Technotes/SyncGotchas.markdown
Brent Simmons 3334c0dc58 Fix typo.
2019-04-29 14:46:08 -07:00

21 lines
1.1 KiB
Markdown
Raw Blame History

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

# Possible Gotchas To Be Aware Of When Working on Syncing
## Accounts and the local account
NetNewsWire was written to support multiple accounts.
However, there may be places where the code assumes the local account, when really it needs to refer to a specific account. These references should be checked.
However however, there are times when assuming the local account is actually correct — such as when importing the default feeds on the first run.
## Feed ID vs. Feed URL
With the local account, a feeds ID and its URL are the same thing.
With syncing systems, a feeds ID will often be completely different from its URL. (It might be a UUID, it might be a hash of something, it might be a database row ID.)
There are times when the code should refer to the ID and times when it should refer to the URL. Did we get it wrong sometimes? Possibly. Hopefully not, but possibly.
Also: if the syncing system uses an integer for a feeds ID, it should be converted to a string in NetNewsWire. This is what the database is expecting — because a string is the most flexible representation and can handle whatever the various systems use.