Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

reusable api as class instead of singleton #68

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

reusable api as class instead of singleton #68

wants to merge 1 commit into from

Conversation

cornerman
Copy link
Contributor

@cornerman cornerman commented Feb 13, 2024 •
edited

This makes the api part of AuthN reusable. AuthN itself would remain a singleton.

It actually does increase bundle size as @cainlevy already predicted.

First, I just added the API class using normal member methods, and I got the following results:

./lib/index.js → ./dist/keratin-authn.js...
┌──────────────────────────────────────────┐
│                                          │
│   Destination: ./dist/keratin-authn.js   │
│   Bundle Size:  15.39 KB                 │
│   Minified Size:  8.35 KB                │
│   Gzipped Size:  2.4 KB                  │
│                                          │
└──────────────────────────────────────────┘
./lib/index.js → ./dist/keratin-authn.min.js...
┌──────────────────────────────────────────────┐
│                                              │
│   Destination: ./dist/keratin-authn.min.js   │
│   Bundle Size:  7.4 KB                       │
│   Minified Size:  7.46 KB                    │
│   Gzipped Size:  2.34 KB                     │
│                                              │
└──────────────────────────────────────────────┘
./lib/index.js → ./dist/keratin-authn.module.js...
┌─────────────────────────────────────────────────┐
│                                                 │
│   Destination: ./dist/keratin-authn.module.js   │
│   Bundle Size:  14.9 KB                         │
│   Minified Size:  7.91 KB                       │
│   Gzipped Size:  2.3 KB                         │
│                                                 │
└─────────────────────────────────────────────────┘
created ./dist/keratin-authn.module.js in 55ms

Then I realized that the methods of API will break if we export them just like this, because of the this binding, so i used arrow functions:

./lib/index.js → ./dist/keratin-authn.js...
┌──────────────────────────────────────────┐
│                                          │
│   Destination: ./dist/keratin-authn.js   │
│   Bundle Size:  15.53 KB                 │
│   Minified Size:  8.19 KB                │
│   Gzipped Size:  2.4 KB                  │
│                                          │
└──────────────────────────────────────────┘
./lib/index.js → ./dist/keratin-authn.min.js...
┌──────────────────────────────────────────────┐
│                                              │
│   Destination: ./dist/keratin-authn.min.js   │
│   Bundle Size:  7.23 KB                      │
│   Minified Size:  7.29 KB                    │
│   Gzipped Size:  2.33 KB                     │
│                                              │
└──────────────────────────────────────────────┘
./lib/index.js → ./dist/keratin-authn.module.js...
┌─────────────────────────────────────────────────┐
│                                                 │
│   Destination: ./dist/keratin-authn.module.js   │
│   Bundle Size:  15.04 KB                        │
│   Minified Size:  7.74 KB                       │
│   Gzipped Size:  2.29 KB                        │
│                                                 │
└─────────────────────────────────────────────────┘

Then I thought, we could maybe safe some more bytes with arrow functions in the SessionManager:

./lib/index.js → ./dist/keratin-authn.js...
┌──────────────────────────────────────────┐
│                                          │
│   Destination: ./dist/keratin-authn.js   │
│   Bundle Size:  15.68 KB                 │
│   Minified Size:  7.97 KB                │
│   Gzipped Size:  2.38 KB                 │
│                                          │
└──────────────────────────────────────────┘
./lib/index.js → ./dist/keratin-authn.min.js...
┌──────────────────────────────────────────────┐
│                                              │
│   Destination: ./dist/keratin-authn.min.js   │
│   Bundle Size:  7.04 KB                      │
│   Minified Size:  7.1 KB                     │
│   Gzipped Size:  2.32 KB                     │
│                                              │
└──────────────────────────────────────────────┘
./lib/index.js → ./dist/keratin-authn.module.js...
┌─────────────────────────────────────────────────┐
│                                                 │
│   Destination: ./dist/keratin-authn.module.js   │
│   Bundle Size:  15.19 KB                        │
│   Minified Size:  7.53 KB                       │
│   Gzipped Size:  2.27 KB                        │
│                                                 │
└─────────────────────────────────────────────────┘

The current main is still a bit smaller though:

./lib/index.js → ./dist/keratin-authn.js...
┌──────────────────────────────────────────┐
│                                          │
│   Destination: ./dist/keratin-authn.js   │
│   Bundle Size:  14.15 KB                 │
│   Minified Size:  7.69 KB                │
│   Gzipped Size:  2.3 KB                  │
│                                          │
└──────────────────────────────────────────┘
./lib/index.js → ./dist/keratin-authn.min.js...
┌──────────────────────────────────────────────┐
│                                              │
│   Destination: ./dist/keratin-authn.min.js   │
│   Bundle Size:  6.39 KB                      │
│   Minified Size:  6.44 KB                    │
│   Gzipped Size:  2.15 KB                     │
│                                              │
└──────────────────────────────────────────────┘
./lib/index.js → ./dist/keratin-authn.module.js...
┌─────────────────────────────────────────────────┐
│                                                 │
│   Destination: ./dist/keratin-authn.module.js   │
│   Bundle Size:  13.65 KB                        │
│   Minified Size:  7.24 KB                       │
│   Gzipped Size:  2.2 KB                         │
│                                                 │
└─────────────────────────────────────────────────┘

fixes #67

@cornerman cornerman marked this pull request as draft February 13, 2024 00:26
cainlevy
cainlevy reviewed Feb 20, 2024
View reviewed changes
Copy link
Member

@cainlevy cainlevy left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this looks reasonable. my memory was of a bigger difference, maybe due to the inclusion of backwards compatibility shims.

@cornerman cornerman marked this pull request as ready for review February 27, 2024 12:35
@cornerman
Copy link
Contributor Author

@cainlevy Anything speaks against merging this? Let me know, if we need to update something here.

cainlevy
cainlevy requested changes May 29, 2024
View reviewed changes
Copy link
Member

@cainlevy cainlevy left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the bump. I'm ✅ on the bundle size changes. Would you look at some update to the README about how to use the library without relying on the global instance? I'd like to take a quick look at that before merging.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@cainlevy cainlevy cainlevy requested changes

Requested changes must be addressed to merge this pull request.

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Non-singleton authn
2 participants
@cornerman @cainlevy