sqids/sqids-elixir

Official Elixir port of Sqids. Generate short unique IDs from numbers.

Sqids Specification

This is the main repository for Sqids specification. It is meant to be the guide for future ports of different languages.

The code is optimized for readability and clarity; individual implementations should optimize for performance as needed.

All unit tests should have matching results.

👩‍💻 Get started

npm install
npm test

The main Sqids library is in src/index.ts; unit tests are in src/tests.

Use the following to format & check changes:

npm run format
npm run lint

🚧 Improvements (over Hashids)

1. The user is not required to provide randomized input anymore (there's still support for custom IDs).
2. Better internal alphabet shuffling function.
3. With default alphabet - Hashids is using base 49 for encoding-only, whereas Sqids is using base 61.
4. Safer public IDs, with support for custom blocklist of words.
5. Separators are no longer limited to characters "c, s, f, h, u, i, t". Instead, it's one rotating separator assigned on the fly.
6. Simpler & smaller implementation: only "encode" & "decode" functions.

🔬 How it works

Sqids is basically a decimal to hexademical conversion, but with a few extra features. The alphabet is larger, it supports encoding several numbers into a single ID, and it makes sure generated IDs are URL-safe (no common profanity).

Here's how encoding works:

1. An offset index is chosen from the given input
2. Alphabet is split into two pieces using that offset and those two halfs are swapped
3. Alphabet is reversed
4. For each input number:
   1. The first character from the alphabet is reserved to be used as separator
   2. The rest of the alphabet is used to encode the number into an ID
   3. If this is not the last number in the input array, the separator character is appended
   4. The alphabet is shuffled
5. If the generated ID does not meet the minLength requirement:
   • The separator character is appended
   • If still does not meet requirement:
     • Another shuffle occurs
     • The separator character is again appended to the remaining id + however many characters needed to meet the requirement
6. If the blocklist function matches the generated ID:
   • offset index is incremented by 1, but never more than the length of the alphabet (in that case throw error)
   • Re-encode (repeat the whole procedure again)

Decoding is the same process but in reverse. A few things worth noting:

• If two separators are right next to each other within the ID, that's fine - it just means the rest of the ID are junk characters used to satisfy the minLength requirement
• The decoding function does not check if ID is valid/canonical, because we want blocked IDs to still be decodable (the user can check for this stuff themselves by re-encoding decoded numbers)

📦 How to port Sqids to another language?

Implementations of new languages are more than welcome! To start:

1. Make sure the language is not already implemented. At this point, if you see a Hashids implementation, but not a Sqids implementation: we could use your help on converting it.
2. The main spec is here: https://github.com/sqids/sqids-spec/blob/main/src/index.ts. It's ~300 lines of code and heavily commented. Comments are there for clarity, they don't have to exist in your own implementation.
3. Fork the repository/language you'd like to implement to your own Github account. If the repository/language does not exist under the Sqids Github account, open a new issue under the spec repo so we can create a blank repo first.
4. Implement the main library + unit tests + Github Actions (if applicable). You do not need to port tests in the internal folder; they are there to test the algorithm itself.
5. Add a README.md -- you can re-use any of the existing ones.
6. Please use the blocklist from https://github.com/sqids/sqids-blocklist. It will contain the most up-to-date list. Do not copy and paste the blocklist from other implementations, as they might not be up-to-date.
7. Create a pull request, so we can review & merge it.
8. If the repo has no active maintainers, we'll invite you to manage it (and maybe even merge your own PR).
9. Once the library is ready, we'll update the website.

📋 Notes

• The reason prefix character is used is to randomize sequential inputs (eg: [0, 1], [0, 2], [0, 3]). Without the extra prefix character embedded into the ID, the output would start with the same characters.
• Internal shuffle function does not use random input. It consistently produces the same output.
• If new words are blocked (or removed from the blocklist), the encode() function might produce new IDs, but the decode() function would still work for old/blocked IDs, plus new IDs. So, there's more than one ID that can be produced for same numbers.
• FAQ section is here: https://sqids.org/faq

🍻 License

Every official Sqids library is MIT-licensed.

sqids-elixir's Issues

Update Sqids Elixir webpage

https://sqids.org/elixir

Add a section to the readme about how you compare to hashids

It would be helpful to users who are familiar with the existing elixir hashid lib https://github.com/alco/hashids-elixir to know how you compare.

Should the Hex package be owned by the Sqids org?

At the moment, I'm the sole owner: https://hex.pm/packages/sqids

Not ideal as far as the bus factor goes.

Why no public `decode/2`?

Why decode!/2 does not have a public non-throwing counterpart?

Enable automatic updates to default blocklist

This is setup as a GHA workflow which is to run daily (schedule currently disabled) and invokes a shell script which runs the Elixir updater script itself, which automatically updates the dependency locks and the changelog upon there being any changes.

Upon that happening, a branch is pushed and a PR is opened.

All that's likely missing is setting up additional permissions in the repo settings.

I'd like to make this happen

Hi,

I'd like to contribute an Elixir implementation of sqids.

@4kimov

Limit ‘warnings_as_errors’ to test env

No need to break builds in Sqids dependents due to warnings that may show up in the future.

Enable dependabot

It's configured; all that's missing is enabling it in repo settings.

Publish 1.0.0 once changes to algorithm are no longer expected

Allow for compile time instantiation with ‘new!/1’

Like in Elixir’s hashids lib mentioned in the website. Params will rarely change, so this makes sense as a simpler alternative to generating code with use Sqids, when we wish to ease management of context.

In other words: support @sqids Sqids.new!(…) -like usage.

Assertion raises because ExUnit is missing

I've just tried integrating this into an app as I like the ID format, but it crashes in production due to the assert you are using from ExUnit. It would be great to have something in the docs about this, although I'd argue you shouldn't be using it in non-test code

This was the error:

    ** (UndefinedFunctionError) function ExUnit.Assertions.__equal__?/2 is undefined (module ExUnit.Assertions is not available)
        ExUnit.Assertions.__equal__?(22, nil)
        (sqids 0.1.2) lib/sqids/alphabet.ex:113: Sqids.Alphabet.index_of!/2
        (sqids 0.1.2) lib/sqids.ex:426: Sqids.decode_valid_id/2
        (sqids 0.1.2) lib/sqids.ex:165: Sqids.decode!/2

I'm using the compile time config