[v6] Proper way to use model classes in commands

[e-e]

I have a command where I would like retrieve a collection of records using Lucid. It looks something like this:

export default class TestCommand extends BaseCommand {
  public static commandName = "test:command";
  static options: CommandOptions = {
    loadApp: true,
    staysAlive: false,
  };

  public async run() {
    const { default: MyModel } = await import("#models/my_model");
    
    const myModels = await MyModel.query().where("some", "condition");
  }
}

I'm getting the following error:

Cannot read properties of undefined (reading 'query')

I have also tried importing the model class at the top of the file like:

import MyModel from "#models/my_model";

which results in the same error.

Importing the model using either method and console.loging the imported value results in:

[class MyModel extends BaseModelImpl] {
 // ... the rest of the model details
}

Is there a different way I'm supposed to be importing model classes? I wasn't able to find any reference to this in the documentation.

[thetutlage]

Can you share your .adonisrc.ts file?

[e-e]

Not sure if this matters, but mine is adonisrc.ts (without the . prefix):

import { defineConfig } from "@adonisjs/core/app"

export default defineConfig({
  /*
  |--------------------------------------------------------------------------
  | Commands
  |--------------------------------------------------------------------------
  |
  | List of ace commands to register from packages. The application commands
  | will be scanned automatically from the "./commands" directory.
  |
  */
  commands: [
    () => import("@adonisjs/core/commands"),
    () => import("@adonisjs/lucid/commands"),
    () => import("@adonisjs/bouncer/commands"),
    () => import("@rlanz/bull-queue/commands"),
  ],
  /*
  |--------------------------------------------------------------------------
  | Preloads
  |--------------------------------------------------------------------------
  |
  | List of modules to import before starting the application.
  |
  */
  preloads: [
    () => import("./start/routes/index.js"),
    () => import("./start/kernel.js"),
    {
      file: () => import("./start/i18n.js"),
      environment: ["console", "repl", "web"],
    },
    () => import("#start/view"),
    () => import("#start/queue"),
    () => import("#start/services"),
  ],
  /*
  |--------------------------------------------------------------------------
  | Service providers
  |--------------------------------------------------------------------------
  |
  | List of service providers to import and register when booting the
  | application
  |
  */
  providers: [
    () => import("./providers/AppProvider.js"),
    () => import("@adonisjs/core/providers/app_provider"),
    () => import("@adonisjs/core/providers/hash_provider"),
    {
      file: () => import("@adonisjs/core/providers/repl_provider"),
      environment: ["repl", "test"],
    },
    () => import("@adonisjs/session/session_provider"),
    () => import("@adonisjs/core/providers/edge_provider"),
    () => import("@adonisjs/lucid/database_provider"),
    () => import("@adonisjs/auth/auth_provider"),
    () => import("@adonisjs/shield/shield_provider"),
    () => import("@adonisjs/redis/redis_provider"),
    () => import("@adonisjs/bouncer/bouncer_provider"),
    () => import("@adonisjs/static/static_provider"),
    () => import("@adonisjs/i18n/i18n_provider"),
    () => import("@adonisjs/vite/vite_provider"),
    () => import("@adonisjs/inertia/inertia_provider"),
    () => import("@adonisjs/core/providers/vinejs_provider"),
    () => import("@rlanz/bull-queue/queue_provider"),
  ],
  metaFiles: [
    {
      pattern: "public/**",
      reloadServer: false,
    },
    {
      pattern: "resources/views/**/*.edge",
      reloadServer: false,
    },
    {
      pattern: "client-modules/**",
      reloadServer: false,
    },
    {
      pattern: "resources/lang/**/*.(json|yaml)",
      reloadServer: false,
    },
    {
      pattern: "resources/lang/**/*.{json,yaml,yml}",
      reloadServer: false,
    },
  ],
  /*
  |--------------------------------------------------------------------------
  | Tests
  |--------------------------------------------------------------------------
  |
  | List of test suites to organize tests by their type. Feel free to remove
  | and add additional suites.
  |
  */
  tests: {
    suites: [
      {
        name: "app/functional",
        files: ["tests/app/functional/**/*.spec(.ts|.js)"],
        timeout: 60000,
      },
      {
        name: "app/unit",
        files: ["tests/app/unit/**/*.spec(.ts|.js)"],
        timeout: 60000,
      },
      {
        name: "client-modules",
        files: ["tests/client-modules/**/*.spec(.ts|.js)"],
        timeout: 60000,
      },
    ],
  },

  assetsBundler: false,
  unstable_assembler: {
    onBuildStarting: [() => import("@adonisjs/vite/build_hook")],
  },
});

[thetutlage]

Seems weird. It should work.

Can you please share a reproduction as a Github repo for this issue?

[Julien-R44]

It should be startApp, not loadApp

See https://docs.adonisjs.com/guides/ace-creating-commands#command-metadata

[e-e]

Wow, thank you! I think that must have been the v5 config property.