13.0.0+ session_storage documentation wrong

[matthewlein]

Overview/summary

I was looking forward to the next release to fix some important but, but I see its been done in a breaking release with some significant session storage changes...

In trying to update, I now get errors about session storage, but the documentation is all unchanged.

1. The current documentation for session_storage appears to be outdated (I think this option no longer exists?)
   

   shopify-api-ruby/README.md

   Line 55 in fca16f1

   session_storage: ShopifyAPI::Auth::FileSessionStorage.new, # See more details below

2. The Setup a Session Store section appears to be outdated and references things that no longer exist.

3. The linked session storage also appears to be outdated. https://github.com/Shopify/shopify-api-ruby/blob/fca16f181f528216a98edf8a4db8c572e2d82e7d/docs/usage/session_storage.md

4. if shopify_app is now required to do sessions, can you document how that works completely? Ideally also including people that just run this as a CLI or script kind of thing as mentioned in Warning about Sessions?? #1084

is shopify_app now a hard dependency? If so, I'd like to see more documentation on that.

Personally, I'm using the shopify gem in a private app to run code just for our store. I don't need anything that shopify_app provides, so for me, this is not a good change. I was perfectly fine using the filesystem based session storage, I'd rather not make a new table and introduce all the session data there for no reason. Is there a way to do that?

[matthewlein]

@nelsonwittwer I've seen you on all the session storage PRs, are you the best one to document this?

[nelsonwittwer]

I'll update the documentation, thanks for bringing this up!

There is no dependency on shopify_app, no. I'll clarify this in the docs when I update them here. The responsibility of session storage was something we wanted removed from scope of all of our api libraries as that responsibility typically is fulfilled by the web framework middleware, in this case Rails. The API libraries are meant to facilitate creating a session and making requests with those sessions to our APIs.

Totally see how this impacts your use case with only wanting file session storage. If you are interested in preserving this functionality, we'd be happy to promote a new gem that used the code that was dropped with the latest version if you or anyone else in the community wanted to take point on that :)

[srgoldman]

@nelsonwittwer Can you elaborate a bit more on how session storage is used for a pure api client? If session storage is removed from Context.setup, how would it get defined without shopify_app? What role does it play in this scenario?

[macwilko]

[ ShopifyAPI | WARN ] The use of SessionStorage in the API library has been deprecated. The ShopifyAPI will no longer have responsibility for session persistence. Upgrading to `shopify_app` 21.3 will allow you to remove session_storage from the API library Context configuration.

Is there a way to silence this? I don't use shopify_app gem, and I do use Session Storage with shopify_api

[zzooeeyy]

Hello everyone!

I have updated our documentation to answer your questions:

• [ShopifyAPI] - OAuth
  • This page explains how you can start OAuth flow with our API client, and make API requests with sessions
• [ShopifyApp] - Sessions
  • This page explains how session storage is handled in our ShopifyApp gem. Totally optionally as a way for session storage, but could be useful if you do need such abilities.

I'll close this ticket now, please feel free to create more issues if you have other question/concerns!

Thanks!