Nuxt.js module to use Vue-Apollo with Absinthe + Phoenix
Clone or download
Pull request Compare This branch is 2 commits ahead, 69 commits behind nuxt-community:master.
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github
lib
test
.editorconfig
.eslintrc.js
.gitignore
LICENSE
README.md
package-lock.json
package.json
yarn.lock

README.md

Apollo inside of NuxtJS, with Elixir Phoenix + Absinthe!

This is a fork of apollo-module designed to work with Absinthe. Since apollo-module uses vue-cli-plugin-apollo under the hood and it doesn't work with phoenix channels, this implementation doesn't rely on it.

Setup

Install apollo module:

npm install --save apollo-module-absinthe
# if you are using *.gql or *.graphql files add graphql-tag to your dependencies
npm install --save graphql-tag

Add apollo-module-absinthe to modules section of nuxt.config.js

- clientConfigs: `Object` Config passed to ApolloClient
  - default: `Path`
  - otherClient: `Path` (Optional)
{
  // Add apollo module
  modules: ['@nuxtjs/apollo'],

  // Give apollo module options
  apollo: {
    tokenName: 'yourApolloTokenName', // optional, default: apollo-token
    includeNodeModules: true, // optional, default: false (this includes graphql-tag for node_modules folder)
    // required
    clientConfigs: {
      default: '~/apollo/client-configs/default.js'
    }
  }
}
// apollo/client-configs/default.js
export default ctx => {
  return {
    wsEndpoint: "ws://localhost:4000/socket",
  };
};

Options

You can either (in a simple setup) just add an object as described above. If you need to overwrite cache or the default getAuth() function then use a path to your config file which returns the client config options.

clientConfigs Option: required

Sets up the apollo client endpoints. All available options for each endpoint you find here

Check out official vue-apollo-cli where possible usecases are presented.

clientConfigs.default Option: required

clientConfigs. Option: optional

tokenName String: optional, default: 'apollo-token'

Token name for the cookie which will be set in case of authentication. You can also provide an option tokenName in each of your clientConfigs to overwrite the default.

includeNodeModules Boolean: optional, default: false

In case you use *.gql files inside of node_module folder you can enable the graphql-tag/loader to parse the files for you.

Usage

Once the setup is completed you have a successfully enabled vue-apollo in your project. Checkout Official example and vue-apollo how to use vue-apollo inside your application code

Authentication

You have following methods for authentication available:

// set your graphql-token
this.$apolloHelpers.onLogin(
  token /* if not default you can pass in client as second argument */
);
// unset your graphql-token
this.$apolloHelpers.onLogout(/* if not default you can pass in client as second argument */);
// get your current token (we persist token in a cookie)
this.$apolloHelpers.getToken(/* you can provide named tokenName if not 'apollo-token' */);

Check out the full example

For permanent authorization tokens the setup just provide getAuth function for each of your endpoint configurations:

  apollo: {
    clientConfigs: {
      default: {
        httpEndpoint: 'https://graphql.datocms.com',
        getAuth: () => 'Bearer your_token_string'
      },
    }
  },

User login

methods:{
  async onSubmit () {
    const credentials = this.credentials
    try {
        const res = await this.$apollo.mutate({
            mutation: authenticateUserGql,
            variables: credentials
        }).then(({data}) => data && data.authenticateUser)
        await this.$apolloHelpers.onLogin(res.token)
    } catch (e) {
        console.error(e)
    }
  },
}

User logout

methods:{
  async onLogout () {
    await this.$apolloHelpers.onLogout()
  },
}

getToken

// middleware/isAuth.js
export default function({ app, error }) {
  const hasToken = !!app.$apolloHelpers.getToken();
  if (!hasToken) {
    error({ errorCode: 503, message: "You are not allowed to see this" });
  }
}

Examples to access the defaultClient of your apolloProvider

Vuex actions
export default {
  actions: {
    foo(store, payload) {
      let client = this.app.apolloProvider.defaultClient;
    },
  },
};
asyncData/fetch method of page component
export default {
  asyncData(context) {
    let client = context.app.apolloProvider.defaultClient;
  },
};
onServerInit
export default {
  nuxtServerInit(store, context) {
    let client = context.app.apolloProvider.defaultClient;
  },
};
access client or call mutations of any method inside of component
export default {
  methods: {
    foo() {
      // receive the associated Apollo client
      const client = this.$apollo.getClient();

      // most likely you would call mutations like following:
      this.$apollo.mutate({ mutation, variables });
    },
  },
};
query on any component
export default {
  apollo: {
    foo: {
      query: fooGql,
      variables() {
        return {
          myVar: this.myVar,
        };
      },
    },
  },
};

Add GQL file recognition on node_modules

  apollo: {
    clientConfigs: {
      default: '~/apollo/client-configs/default.js'
    },
    includeNodeModules: true
  }

Troubleshooting

Use of *.gql files

To use *gql|graphql files you need to add following dependency to your project:

  yarn add graphql-tag
  # alternative
  npm install graphql-tag

Proxies

CORS errors are most often resolved with proxies. If you see a Cross-Origin-Request error in your client side console look into setting up a proxy. Check out https://github.com/nuxt-community/proxy-module for quick and straight forward setup.

ctx.req.session - req is undefined

This is just a placeholder. You'll want to replace it with whatever storage mechanism you choose to store your token. Here is an example using local storage : https://github.com/Akryum/vue-apollo/issues/144

Contribute and wire up setup

Setup the required fields in .env file in root folder

// .env
HTTP_ENDPOINT=https://your-endpoint
WS_ENDPOINT=wss://your-endpoint

In index.vue the login process requires that the gql endpoint enables a mutation which returns a valid token:

mutation authenticateUser($email: String!, $password: String!) {
  authenticateUser(email: $email, password: $password) {
    token
    id
  }
}

If your gql backend is prepared start running nuxt as follow

# npm install
# npm run dev