CORS y Vite

Solución a los problemas de CORS en local y desplegando con Netlify.

You can read this article also in English.

Últimamente he estado trabajando en un proyecto personal que entre otras cosas utiliza un servicio de SERP mediante una API. En principio creé este proyecto con Vite y Vue 3 para probar las novedades que trae respecto a la versión anterior. Sin embargo, por el camino me estoy encontrando con una serie de diferencias que me parece interesante comentar. En el artículo de hoy hablaremos de CORS, Proxies con Vite y redirecciones con Netlify.

Introducción

Antes de meternos en profundidad, dejo un pequeño resumen de las características del proyecto:

  • Vue 3
  • Vite como servidor de desarrollo/bundler
  • Axios como cliente HTTP
  • Netlify como hosting/sistema de despliegue

Para crear un proyecto de prueba (no voy a entrar en detalle) es necesario ejecutar los siguientes comandos:

yarn create vite
// framework: vue
// variant: vue-ts
cd vite-project
yarn
yarn add axios
yarn dev

Como siempre, al llamar a la URL de dev (en nuestro caso localhost:3000) aparece la típica landing de Hello World. Ya en el propio fichero app.vue podemos añadir un método de ejemplo para realizar una petición de tipo Get con Axios a nuestra API de ejemplo:

const searchFromApi = async (query: string) => {
  return axios.get("[https://apiservice.com](https://apiservice.com)/search", {
    params: query,
  })
}

// Calls with this.searchFromApi(query)

Sin embargo, al probarlo en nuestro entorno de desarrollo aparece el siguiente error en la consola del navegador y la petición no se realiza:

Ejemplo de error CORS

Ejemplo de error CORS

Esto es debido a que nuestro servidor trata de realizar la petición a la API, pero dentro de nuestro dominio, ya que para realizar una petición a un dominio diferente, es necesario fijar unas reglas especiales para que la petición pueda “salir” de nuestro entorno de desarrollo. Bien, esto es debido al CORS.

Los problemas de CORS son fáciles de identificar; pero no son tan fáciles de analizar, ya que no son posibles de trazar con el inspector del navegador. A su vez, no se suele conocer muy bien el funcionamiento de CORS, por lo que buscar soluciones en los diferentes frameworks y sistemas de hosting JAMstack se vuelve muy complicado.

¿Qué es un error de CORS?

Las siglas CORS provienen de Intercambio de Recursos de Origen Cruzado y por el nombre te harás una idea de por dónde van los tiros cuando aparece un error de este tipo, dado que estamos intentando obtener información de una API. Un error CORS es cualquier error generado por el navegador que esté relacionada con la carga de recursos de un origen desconocido (hipotéticamente).

Para ser un poco más específicos, todas las invocaciones a API que utilizan XMLHttpRequest o Fetch y fuentes web que utilizan @font-face utilizan CORS (entre otros), y son susceptibles de generar errores CORS

Fuente: [https://developer.mozilla.org/es/docs/Web/HTTP/CORS](https://developer.mozilla.org/es/docs/Web/HTTP/CORS)

Fuente: https://developer.mozilla.org

Por razones de seguridad, los navegadores restringen las solicitudes de origen cruzado que se inician en un script, como es nuestro caso. Para solucionar esto, hay una serie de reglas que se pueden añadir tanto la cabecera de la petición como en el servidor para dar legitimidad a la petición. En nuestro caso, necesitamos dar legitimidad a la URL https://apiservice.com mediante una regla de tipo Access-Control-Allow-Origin:

Access-Control-Allow-Origin: https://apiservice.com //Allows only this URL
Access-Control-Allow-Origin: * //Allows all URLs

Bonus: Llamadas con Preflight

Si el navegador estima que la petición realizada puede no ser segura, automáticamente realizará el proceso de preflight, en la que evaluará si la petición CORS es segura. Un ejemplo de llamada con preflight es cualquier petición simple de tipo application/json, algo muy utilizado en las llamadas a API. En la mayoría de casos se solucionará definiendo el content-type de la petición en las opciones de Axios.

const res = await axios.get('[https://apiservice.com](https://apiservice.com)/search', {
  headers: {
    'Content-Type': 'application/json;charset=UTF-8',
    'Access-Control-Allow-Origin': '*' // Could work and fix the previous problem, but not in all APIs
  },

Otras peticiones en las que se realizará automáticamente el proceso de preflight son las llamadas con credenciales, cookies, cabeceras no permitidas, o peticiones de tipo PUT, PATCH y DELETE.

¿Cómo solucionarlo?

Para solucionar este problema tanto Vue-cli como Vite es necesario fijar un Proxy en los ficheros de configuración de Vue-cli o Vite para dar legitimidad a las peticiones y “decir” al navegador que esa petición tiene que realizarla fuera del servidor dev y que es una petición correcta y auténtica.

Para una aplicación creada con vue-cli es necesario añadir una configuración similar a la que sigue en el fichero vue.config.js

devServer: {
    proxy: {
      "/api": {
        ws: true,
        changeOrigin: true,
        target: "https://apiservice.com"
      }
    }
  }
Configuración de Proxy con vue-cli. Fichero vue.config.js

Para nuestro caso, en el que utilizamos Vite, la configuración del proxy sería similar al siguiente código:

import vue from "@vitejs/plugin-vue"
import { defineConfig } from "vite"

export default defineConfig({
  server: {
    proxy: {
      "/api": {
        target: "https://apiservice.com",
        changeOrigin: true,
        secure: false,
        rewrite: (path) => path.replace(/^\/api/, ""),
      },
    },
  },
  plugins: [vue()],
})
Configuración de Proxy con Vite. Fichero vite.config.ts

Tras añadir nuestro proxy en el fichero de configuración ya podemos ejecutar nuestro servidor de desarrollo y llamar a nuestra API con Axios:

const searchFromApi = async (query: string) => {
  return axios.get("/api/search", {
    params: query,
  })
}

Como se puede ver, la llamada a la API se realiza utilizando como url la referencia hecha en el fichero vite.config.ts y no la url de la API.

Con estas modificaciones en las llamadas y la configuración del proxy, ya estamos listos para desarrollar nuestra aplicación llamando a cualquier API usando Axios sin problemas de CORS.

Configuración de Netlify

Esto no acaba aquí. Hemos solucionado nuestros problemas de CORS para desarrollar en nuestro servidor local, pero ¿Qué pasa al desplegar nuestra aplicación en Netlify?

El despliegue es correcto y parece funcionar correctamente, pero no se realiza la petición a la API. Tampoco aparecen errores de consola, por lo que no queda claro qué está pasando. Esto es debido a que hay que realizar un proceso similar a la ejecución en local y permitir la ejecución de la URL mediante una regla de redirección. De lo contrario se llamará desde la URL desde la que se está ejecutando la aplicación.

En Netlify este tipo de modificaciones se realiza mediante un fichero _redirects. En el caso de una aplicación de Vue 3 debe estar en la raíz del proyecto, mientras que en un proyecto de Vite debe ubicarse dentro de la carpeta public.

/api/_ https://apiservice.com/:splat 200
/_ /index.html 200
/\* /index.html 404

El orden de las redirecciones es importante, primero deben ir las reglas de redirección a las diferentes APIs o servicios y después el resto de redirecciones a index.html

Con esto ya podemos hacer commit y push del fichero, desplegarlo en Netlify y disfrutar de nuestra aplicación :)

Es cierto que otra opción sería haciendo uso de Netlify functions, pero complicaría bastante el desarrollo para lo que estamos haciendo, ya que habría que modificar el proxy para que ejecutara la función en local también y llamar a netlify en nuestro comando de Yarn o NPM previamente a Vite. En este caso no me parece necesario, pero seguro que hay otros casos en los que sí es una buena solución.

Recursos

https://stackoverflow.com/questions/67986822/api-from-proxy-not-working-after-deploying-on-netlify

https://medium.com/@kamry.bowman/circumventing-cors-with-netlify-functions-nodejs-65aa6ec69a65

https://developer.mozilla.org/es/docs/Web/HTTP/CORS

https://vitejs.dev/config/#server-proxy

https://cli.vuejs.org/config/#devserver-proxy

Photo by Anders Jildén on Unsplash

Devletter

I send out an email when I create or post something new. 🚀
(content in 🇪🇸 )