Old version of shopify-api

[ChaseWNorton]

Issue summary

Is this repo even maintained anymore? We need to set a depreciated notice if not. Write a short description of the issue here ↓

Expected behavior

What do you think should happen?

Actual behavior

What actually happens?

Tip: include an error message (in a <details></details> tag) if your issue is related to an error

Steps to reproduce the problem

Reduced test case

The best way to get your bug fixed is to provide a reduced test case.

---

Checklist

• [ ] Please delete the labels section before submitting your issue
• [ ] I have described this issue in a way that is actionable (if possible)

[paulomarg]

Hi @ChaseWNorton, thanks for raising this. We're actually in the process of deprecating this repo, since most of the support it adds isn't needed any more - mostly code to work around ITP checks and 3rd party cookies which are no longer allowed for apps.

Going forward, our sample app is going to be borrowing the verifyRequest middleware from this package, and replacing it with direct calls to the shopify-api library (v2).

We'll mark it as deprecated as soon as we release those changes!

[limeforadime]

Hi @ChaseWNorton, thanks for raising this. We're actually in the process of deprecating this repo, since most of the support it adds isn't needed any more - mostly code to work around ITP checks and 3rd party cookies which are no longer allowed for apps.

Going forward, our sample app is going to be borrowing the verifyRequest middleware from this package, and replacing it with direct calls to the shopify-api library (v2).

We'll mark it as deprecated as soon as we release those changes!

I appreciate the update! I've actually been debugging this for about an hour before I found this reply and realized there were breaking changes.

Maybe put a small disclaimer in this package's Readme mentioning that this package is planned to be deprecated? If I had known it was soon to be deprecated I wouldn't have bothered using this package and would have instead used the official shopify-api package.

[TheSecurityDev]

I have created an improved version of this library which fixes this and other issues. You can find it at https://github.com/TheSecurityDev/simple-koa-shopify-auth.

Or via NPM: https://www.npmjs.com/package/simple-koa-shopify-auth.

[limeforadime]

I have created an improved version of this library which fixes this and other issues. You can find it at https://www.npmjs.com/package/simple-koa-shopify-auth.

Very cool! Thanks for making this! Will check it out.

[redochka]

@TheSecurityDev When using simple-koa-shopify-auth the session is not created, as if my CustomSessionStorage is never called. It was working fine before switching to simple-koa-shopify-auth

Shopify.Context.initialize({
    API_KEY        : process.env.SHOPIFY_API_KEY,
    API_SECRET_KEY : process.env.SHOPIFY_API_SECRET,
    SCOPES         : process.env.SCOPES.split(","),
    HOST_NAME      : process.env.HOST.replace(/https:\/\//, ""),
    API_VERSION    : ApiVersion.October20,
    IS_EMBEDDED_APP: true,
    // This should be replaced with your preferred storage strategy
    // SESSION_STORAGE: new Shopify.Session.MemorySessionStorage(),
    SESSION_STORAGE: new Shopify.Session.CustomSessionStorage(
      sessionStorage.storeCallback,
      sessionStorage.loadCallback,
      sessionStorage.deleteCallback
    )
  });

Any clue?

[rahilwazir]

@redochka It's a change in Shopify Node API rather than simple-koa-shopify-auth.

In your loadCallback method of the session storage when you successfully retrieve the session object, initiate the session with Shopify.Session.Session instance and return the instance to loadCallback method.

import Shopify from "@shopify/shopify-api";
...
...
loadCallback = async (id) => {
  try {
    ...
    ...
      const sessionData = JSON.parse(data);
      const session = new Shopify.Session.Session(
        id,
        sessionData.shop,
        sessionData.state,
        sessionData.isOnline
      );
      session.scope = sessionData.scope;
      session.accessToken = sessionData.accessToken;
      session.expires = sessionData.expires;
      return session;
    }

    return undefined;
  } catch (err) {
    throw new Error(err);
  }
};

Edit: The latest version should have fixed it. @TheSecurityDev can confirm.

[redochka]

@rahilwazir my loadCallback is not called. So the code that you suggested will not get a chance to run

[TheSecurityDev]

@TheSecurityDev When using simple-koa-shopify-auth the session is not created, as if my CustomSessionStorage is never called. It was working fine before switching to simple-koa-shopify-auth

Shopify.Context.initialize({
    API_KEY        : process.env.SHOPIFY_API_KEY,
    API_SECRET_KEY : process.env.SHOPIFY_API_SECRET,
    SCOPES         : process.env.SCOPES.split(","),
    HOST_NAME      : process.env.HOST.replace(/https:\/\//, ""),
    API_VERSION    : ApiVersion.October20,
    IS_EMBEDDED_APP: true,
    // This should be replaced with your preferred storage strategy
    // SESSION_STORAGE: new Shopify.Session.MemorySessionStorage(),
    SESSION_STORAGE: new Shopify.Session.CustomSessionStorage(
      sessionStorage.storeCallback,
      sessionStorage.loadCallback,
      sessionStorage.deleteCallback
    )
  });

Any clue?

Make sure you are using the latest version of the library (v1.0.4), and make sure you are using Shopify Node API library V2.

If it still doesn't work, open an issue in the repository and I'll try to help you further.

[redochka]

@TheSecurityDev yes latest version of the library is used

"simple-koa-shopify-auth": "^1.0.4",
"@shopify/shopify-api": "^2.0.0",

I opened an issue Thanks

[nzmitch]

in your yarn.lock or package-lock.json upgrade the dependencies version yourself

Delete your node_modules folder and reinstall your packages after.

[github-actions[bot]]

Note that this repo is no longer maintained and this issue will not be reviewed. Prefer the official JavaScript API library. If you still want to use Koa, see simple-koa-shopify-auth for a potential community solution.