Drift generator file formatting issue

[pasaneramusugoda]

First of all, I would like to thank you for the wonderful package that you provided. It helps us to implement complex relational data structures for our systems.

I would like to bring your attention to one of the issues I'm facing right now.

[WARNING] drift_dev on lib/database/app_database.dart:
Could not format generated source. The generated code is probably invalid, and this is most likely a bug in drift_dev.

Since it's a warning, I continue to run the code. Then I received the following:

lib/database/app_database.g.dart:1039:166: Error: Expected ',' before this.
Query? get query => (attachedDatabase.selectOnly(stockInRequests)..addColumns($columns)).join([ innerJoin(products,products.id.equalsExp(stockInRequests.productId)) innerJoin(divisions,divisions.id.equalsExp(stockInRequests.divisionId)) innerJoin(warehouses,warehouses.id.equalsExp(stockInRequests.warehouseId)) leftOuterJoin(stocks,stocks.stockInRequestId.equalsExp(stockInRequests.id)) leftOuterJoin(reasons,reasons.id.equalsExp(stockInRequests.reasonId)) ]) ..orderBy([ OrderingTerm(expression: stockInUpdatedDate,mode: OrderingMode.desc) ]);
                                                                                          ^^^^^^^^^
lib/database/app_database.g.dart:1039:238: Error: Expected ',' before this.
Query? get query => (attachedDatabase.selectOnly(stockInRequests)..addColumns($columns)).join([ innerJoin(products,products.id.equalsExp(stockInRequests.productId)) innerJoin(divisions,divisions.id.equalsExp(stockInRequests.divisionId)) innerJoin(warehouses,warehouses.id.equalsExp(stockInRequests.warehouseId)) leftOuterJoin(stocks,stocks.stockInRequestId.equalsExp(stockInRequests.id)) leftOuterJoin(reasons,reasons.id.equalsExp(stockInRequests.reasonId)) ]) ..orderBy([ OrderingTerm(expression: stockInUpdatedDate,mode: OrderingMode.desc) ]);
                                                                                          ^^^^^^^^^
lib/database/app_database.g.dart:1039:313: Error: Expected ',' before this.
Query? get query => (attachedDatabase.selectOnly(stockInRequests)..addColumns($columns)).join([ innerJoin(products,products.id.equalsExp(stockInRequests.productId)) innerJoin(divisions,divisions.id.equalsExp(stockInRequests.divisionId)) innerJoin(warehouses,warehouses.id.equalsExp(stockInRequests.warehouseId)) leftOuterJoin(stocks,stocks.stockInRequestId.equalsExp(stockInRequests.id)) leftOuterJoin(reasons,reasons.id.equalsExp(stockInRequests.reasonId)) ]) ..orderBy([ OrderingTerm(expression: stockInUpdatedDate,mode: OrderingMode.desc) ]);
                                                                                          ^^^^^^^^^^^^^
lib/database/app_database.g.dart:1039:389: Error: Expected ',' before this.
Query? get query => (attachedDatabase.selectOnly(stockInRequests)..addColumns($columns)).join([ innerJoin(products,products.id.equalsExp(stockInRequests.productId)) innerJoin(divisions,divisions.id.equalsExp(stockInRequests.divisionId)) innerJoin(warehouses,warehouses.id.equalsExp(stockInRequests.warehouseId)) leftOuterJoin(stocks,stocks.stockInRequestId.equalsExp(stockInRequests.id)) leftOuterJoin(reasons,reasons.id.equalsExp(stockInRequests.reasonId)) ]) ..orderBy([ OrderingTerm(expression: stockInUpdatedDate,mode: OrderingMode.desc) ]);
                                                                                          ^^^^^^^^^^^^^

What I have noticed is the comma separator is missing after each join statement.

For the moment I'm manually adding missing commas to the generated file.

Would like to know any fixes or where to look to debug the code to fix and make a PR.

View Class for your reference:
abstract class StockInTblView extends View {
  //region tables
  Stocks get stocks;

  StockInRequests get stockInRequests;

  Products get products;

  Warehouses get warehouses;

  Divisions get divisions;

  Reasons get reasons;

  //endregion tables

  //region columns
  Expression<int> get productId => products.id;

  Expression<String> get productCode => products.code;

  Expression<String> get productDescription => products.description;

  Expression<int> get stockId => stocks.id;

  Expression<DateTime> get stockCreatedDate => stocks.createdDate;

  Expression<DateTime> get stockUpdatedDate => stocks.updatedDate;

  Expression<int> get stockInRequestId => stockInRequests.id;

  Expression<int> get stockInRequestedQty => stockInRequests.qty;

  Expression<DateTime> get stockInRequestDate => stockInRequests.createdDate;

  Expression<DateTime> get stockInReceivedDate => stockInRequests.receivedDate;

  Expression<DateTime> get stockInUpdatedDate => stockInRequests.updatedDate;

  Expression<int> get warehouseId => warehouses.id;

  Expression<String> get warehouseCode => warehouses.code;

  Expression<String> get warehouseName => warehouses.name;

  Expression<int> get divisionId => divisions.id;

  Expression<String> get divisionCode => divisions.code;

  Expression<String> get divisionName => divisions.name;

  Expression<String> get reason => reasons.reason;

  //endregion columns

  @override
  Query as() => select([
        stockInRequestId,
        warehouseId,
        divisionId,
        stockId,
        productId,
        productCode,
        productDescription,
        warehouseCode,
        warehouseName,
        divisionCode,
        divisionName,
        stocks.imageUrl,
        stocks.isDamaged,
        stocks.reasonId,
        reason,
        stocks.remark,
        stockInRequestedQty,
        stockInRequestDate,
        stockInReceivedDate,
        stockInUpdatedDate,
        stockCreatedDate,
        stockUpdatedDate,
      ]).from(stockInRequests).join([
        innerJoin(
          products,
          products.id.equalsExp(stockInRequests.productId),
        ),
        innerJoin(
          divisions,
          divisions.id.equalsExp(stockInRequests.divisionId),
        ),
        innerJoin(
          warehouses,
          warehouses.id.equalsExp(stockInRequests.warehouseId),
        ),
        leftOuterJoin(
          stocks,
          stocks.stockInRequestId.equalsExp(stockInRequests.id),
        ),
        leftOuterJoin(
          reasons,
          reasons.id.equalsExp(stockInRequests.reasonId),
        ),
      ])
        ..orderBy([
          OrderingTerm(
            expression: stockInUpdatedDate,
            mode: OrderingMode.desc,
          ),
        ]);
}

[simolus3]

First of all, I would like to thank you for the wonderful package that you provided. It helps us to implement complex relational data structures for our systems.

I'm happy to hear that, thanks!

Would like to know any fixes

It looks like you can apply a workaround by calling join multiple times and never putting more than one item in the list:

.from(stockInRequests).join([
        innerJoin(
          products,
          products.id.equalsExp(stockInRequests.productId),
        ),
]).join([
        innerJoin(
          divisions,
          divisions.id.equalsExp(stockInRequests.divisionId),
        ),
]).join
 ...

where to look to debug the code to fix and make a PR.

A contribution would be great! The mistake appears to be the way drift reads Dart code for writing it later. We apply some transformations so that we're able to manage imports later. This transformation drops some commas though. We'd probably have to override visitListLiteral and visitSetOrMapLiteral in a similar way to this:

drift/drift_dev/lib/src/analysis/results/dart.dart

Lines 480 to 494 in 2582109

	@override
	void visitArgumentList(ArgumentList node) {
	// Workaround to the analyzer not including commas: https://github.com/dart-lang/sdk/blob/20ad5db3ab3f2ae49f9668b75331e51c84267011/pkg/analyzer/lib/src/dart/ast/ast.dart#L389
	_builder.addText('(');
	var first = true;
	for (final arg in node.arguments) {
	if (!first) _builder.addText(',');
	visitNode(arg);
	first = false;
	}
	_builder.addText(')');
	}