Update documentation on endpoint paths starting with /

[spras]

Environment

• Operating System: Darwin
• Node Version: v20.10.0
• Nuxt Version: 3.12.2
• CLI Version: 3.12.0
• Nitro Version: 2.9.6
• Package Manager: [email protected]
• Builder: -
• User Config: debug, ssr, devtools, runtimeConfig, modules, css, vuetify, auth, features, app, components, hooks, build
• Runtime Modules: [email protected], @nuxt/test-utils/[email protected], @nuxtjs/[email protected], @sidebase/[email protected], @vueuse/[email protected]
• Build Modules: -

Reproduction

here is my nuxt.config.ts

  auth: {
    baseURL: process.env.CUSTOM_API_URL + "/",
    globalAppMiddleware: {
      isEnabled: true,
    },
    session: {
      enableRefreshPeriodically: false,
      enableRefreshOnWindowFocus: true,
    },
    provider: {
      type: "local",
      token: {
        maxAgeInSeconds: 18000,
        sameSiteAttribute: "strict",
        secureCookieAttribute: true,
      },
      endpoints: {
        getSession: { path: "/api/session", method: "get" },
      },
      pages: {
        login: "/connexion",
      },
    },
  },

Describe the bug

I'm currently testing upgrade from 0.7.2 to 0.8.0-rc

This break my config : local provider and auth.baseURL defined to a custom base url ex : https://example.com/

Login is posted to the nuxt base URL , not to my custom base url

As a workaround I had to redefine all the endpoints and removing the / prefix .

endpoints: { 
       signIn: { path: 'login', method: 'post' },        
       signOut: { path: 'logout', method: 'post' },        
       signUp: { path: 'register', method: 'post' },        
       getSession: { path: 'session', method: 'get' }    
}

Perhaps it has to become the default values ?

It seems to be linked to the modifications for this issue #742 ,
https://github.com/sidebase/nuxt-auth/pull/750/files , joinPathToApiURL function

Additional context

No response

Logs

No response

[phoenix-ru]

Hi @spras, it looks correct to me that you redefine your endpoints because of the custom base url.
Using / prefix for endpoints always means to use Nuxt's internal routing - this is intended.

This behaviour was mostly inspired by how URL's are resolved in the browser. For example, assuming you are on https://example.com/subpage and you have <a href="/another">, you will be navigated to https://example.com/another.
I wanted to replicate it, but in the context of Nuxt. Our module assumes that URLs starting with / are local to Nuxt, therefore it avoids extra overhead of crossing the domain boundary.

The fact that using { path: 'login' } satisfies your usecase should be considered a bug rather than a desired result. Similar to browser navigation analogy, I would expect the navigation to be same-level (e.g. { path: 'three' } switching from /one/two to /one/three). But since I don't foresee anyone ever wanting same-level navigation, it is how it is.

I would suggest you to use fully-specified URLs in path configs, because your usecase (I assume) involves going away from Nuxt to an external custom URL.

[Ray0907]

I faced the similar issue. Here is my nuxt.config file. Ensure that the origin ends with a ‘/’. This worked for me.

auth: {
		provider: {
			type: 'authjs',
		},
		origin: '/prefix/',
	},

[spras]

@phoenix-ru your explaination make sense , it'OK for me. I think documentation should be more detailed and explicit on it.

[phoenix-ru]

Thank you for the feedback @spras, we will adjust the documentation accordingly