[Bug?]: Wrong CurrentUser type from all-currentUser.d.ts

[rowin1125]

What's not working?

The currentUser type in the api seems all good, however type from useAuth() in the web is not the same as the ThenArg<ReturnType<typeof getCurrentUser>>.

My tsconfig from the web.
note: I changed strict to true

{
  "compilerOptions": {
    "strict": true,
    "forceConsistentCasingInFileNames": true,
    "noEmit": true,
    "allowJs": true,
    "esModuleInterop": true,
    "target": "esnext",
    "module": "esnext",
    "moduleResolution": "node",
    "baseUrl": "./",
    "rootDirs": [
      "./src",
      "../.redwood/types/mirror/web/src",
      "../api/src",
      "../.redwood/types/mirror/api/src"
    ],
    "paths": {
      "src/*": [
        "./src/*",
        "../.redwood/types/mirror/web/src/*",
        "../api/src/*",
        "../.redwood/types/mirror/api/src/*"
      ],
      "types/*": ["./types/*", "../types/*"],
      "@redwoodjs/testing": ["../node_modules/@redwoodjs/testing/web"]
    },
    "typeRoots": ["../node_modules/@types", "./node_modules/@types"],
    "types": ["jest", "@testing-library/jest-dom"],
    "jsx": "preserve"
  },
  "include": [
    "src",
    "../.redwood/types/includes/all-*",
    "../.redwood/types/includes/web-*",
    "./types",
  ]
}

The `all-currentUser.d.ts

// This file was generated by RedwoodJS
import '@redwoodjs/api'
import '@redwoodjs/auth'

import { getCurrentUser } from '../../../api/src/lib/auth'

type ThenArg<T> = T extends PromiseLike<infer U> ? U : T
export type InferredCurrentUser = ThenArg<ReturnType<typeof getCurrentUser>>

type UndefinedRoles = {
  /**
   * ⚠️ Heads-Up: This is undefined unless roles key is returned from {@link getCurrentUser()}
   *
   * You may take a look at https://redwoodjs.com/docs/tutorial/chapter7/rbac for a tutorial on
   * how to add fully-fledged RBAC (Role-based Access Control) to your database model.
   */
  roles?: unknown | unknown[]
}

type Overwrite<T, U> = Omit<T, keyof U> & U

declare module '@redwoodjs/graphql-server' {
  interface GlobalContext {
    currentUser?: Overwrite<UndefinedRoles, InferredCurrentUser>
  }
}

declare module '@redwoodjs/auth' {
  interface CurrentUser extends InferredCurrentUser {}
}

If I hover over InferredCurrentUser i see the following information:

type InferredCurrentUser = {
    id: string;
    email: string;
    verified: boolean;
    roles: Role;
} | null

When looking at the AuthProvider.d.ts I can see that the currentUser type is defined in this file:

export interface CurrentUser {
    roles?: Array<string> | string;
}

How do we reproduce the bug?

You can clone this repo here. Im using docker to run the postgres db so in order to run the project you have to add these keys to your .env file:

DATABASE_URL="postgresql://rowin:password@localhost:5432/teamstasts_development?connection_limit=1"
TEST_DATABASE_URL="postgresql://rowin:password@localhost:5432/teamstasts_test?connection_limit=1"

# Used to encrypt/decrypt session cookies. Change this value and re-deploy to log out all users of your app at once.
SESSION_SECRET=<YOUR SECRET>

API_URL="/.redwood/functions"
SENDINBLUE_SMTP_KEYS=<TOKEN> # -> Should not be required

Now run yarn rw dev and if you visit for example Homepage.tsx line 10 you will see the currentUser object and the type which isn't correct.

What's your environment? (If it applies)

System:
    OS: Linux 5.13 Ubuntu 21.10 21.10 (Impish Indri)
    Shell: 5.8 - /usr/bin/zsh
  Binaries:
    Node: 16.14.2 - /tmp/xfs-4f764c8e/node
    Yarn: 3.2.1 - /tmp/xfs-4f764c8e/yarn
  Databases:
    SQLite: 3.38.2 - /home/linuxbrew/.linuxbrew/bin/sqlite3
  npmPackages:
    @redwoodjs/core: 2.1.0 => 2.1.0

Are you interested in working on this?

• I'm interested in working on this

[dac09]

@rowin1125 thanks for raising this. I don't believe we've shipped strict mode support just yet, where we've solved some of these issues.

You are welcome to try it in canary however, by running yarn rw upgrade -t canary - but please note there may be breaking changes that will affect you in Canary.

[Philzen]

Related to

• [RFC]: Harmonize and extend code completion hints on currentUser-object on web & api side #5866

… in particular requirement no. 3 i believe, which refers to the disjoint of CurrentUser in web vs. api