Merge pull request #59 from IBM/fix/long_name_lookups

Fix/long_name_lookups

Author: worksofliam

cli/package-lock.json

@@ -1,13 +1,14 @@
 import glob from 'glob';
 import path from 'path';
 import fs from 'fs/promises';
+import fss from 'fs';
 import Cache from "vscode-rpgle/language/models/cache";
 import { IncludeStatement } from "vscode-rpgle/language/parserTypes";
 import { infoOut, warningOut } from './cli';
 import { DefinitionType, File, Module, CLParser } from 'vscode-clle/language';
 import { DisplayFile as dds } from "vscode-displayfile/src/dspf";
 import Document from "vscode-db2i/src/language/sql/document";
-import { StatementType } from 'vscode-db2i/src/language/sql/types';
+import { ObjectRef, StatementType } from 'vscode-db2i/src/language/sql/types';
 import { rpgExtensions, clExtensions, ddsExtension, sqlExtensions, srvPgmExtensions, cmdExtensions } from './extensions';
 import Parser from "vscode-rpgle/language/parser";
 import { setupParser } from './parser';
@@ -148,6 +149,16 @@ export class Targets {
 			extension
 		};
 
+		// If this file is an SQL file, we need to look to see if it has a long name as we need to resolve all names here
+		if (sqlExtensions.includes(extension.toLowerCase())) {
+			const ref = this.sqlObjectDataFromPath(localPath);
+			if (ref) {
+				if (ref.object.system)  theObject.systemName = ref.object.system.toUpperCase();
+				if (ref.object.name) theObject.longName = ref.object.name;
+				// theObject.type = ref.type;
+			}
+		}
+
 		this.storeResolved(localPath, theObject);
 
 		return theObject;
@@ -224,7 +235,7 @@ export class Targets {
 	 * Resolves a search to an object. Use `systemName` parameter for short and long name.
 	 */
 	public searchForObject(lookFor: ILEObject) {
-		return this.getResolvedObjects().find(o => (o.systemName === lookFor.systemName || o.systemName === lookFor.longName) && o.type === lookFor.type);
+		return this.getResolvedObjects().find(o => (lookFor.systemName === o.systemName || (o.longName && lookFor.systemName === o.longName)) && o.type === lookFor.type);
 	}
 
 	public searchForAnyObject(lookFor: { name: string, types: ObjectType[] }) {
@@ -322,6 +333,7 @@ export class Targets {
 	}
 
 	public loadObjectsFromPaths(paths: string[]) {
+		// optimiseFileList(paths); //Ensure we load SQL files first
 		paths.forEach(p => this.resolvePathToObject(p));
 	}
 
@@ -1202,6 +1214,9 @@ export class Targets {
 				.forEach((ref: RpgLookup) => {
 					if (ignoredObjects.includes(ref.lookup)) return;
 
+					const previouslyScanned = target.deps.some((r => (ref.lookup === r.systemName || ref.lookup === r.longName?.toUpperCase()) && r.type === `FILE`));
+					if (previouslyScanned) return;
+
 					const resolvedObject = this.searchForObject({ systemName: ref.lookup, type: `FILE` });
 					if (resolvedObject) target.deps.push(resolvedObject)
 					else {
@@ -1221,7 +1236,7 @@ export class Targets {
 					line: ref.position ? ref.position.line : undefined
 				}))
 				.forEach((ref: RpgLookup) => {
-					const previouslyScanned = target.deps.some((r => r.systemName === ref.lookup && r.type === `FILE`));
+					const previouslyScanned = target.deps.some((r => (ref.lookup === r.systemName || ref.lookup === r.longName?.toUpperCase()) && r.type === `FILE`));
 					if (previouslyScanned) return;
 					const resolvedObject = this.searchForObject({ systemName: ref.lookup, type: `FILE` });
 					if (resolvedObject) target.deps.push(resolvedObject)
@@ -1585,6 +1600,50 @@ export class Targets {
 		return currentItem;
 	}
 
+	/**
+	 * This is used when loading in all objects.
+	 * SQL sources can have two object names: a system name and a long name
+	 * Sadly the long name is not typically part of the path name, so we need to
+	 * find the name inside of the source code.
+	 */
+	sqlObjectDataFromPath(fullPath: string): ObjectRef|undefined {
+		const relativePath = this.getRelative(fullPath);
+
+		if (fss.existsSync(fullPath)) {
+			const content = fss.readFileSync(fullPath, { encoding: `utf-8` });
+			const document = new Document(content);
+
+			const groups = document.getStatementGroups();
+
+			if (groups.length === 0) {
+				this.logger.fileLog(relativePath, {
+					message: `No SQL statements found in file.`,
+					type: `info`
+				});
+
+				return;
+			}
+
+			const createCount = groups.filter(g => g.statements[0].type === StatementType.Create).length;
+
+			if (createCount > 1) {
+				this.logger.fileLog(relativePath, {
+					message: `Includes multiple create statements. They should be in individual sources. This file will not be parsed.`,
+					type: `warning`,
+				});
+			}
+
+			const firstGroup = groups[0];
+			const create = firstGroup.statements.find(s => s.type === StatementType.Create);
+
+			if (create) {
+				const defs = create.getObjectReferences();
+				const mainDef = defs.find(d => d.createType);
+
+				return mainDef;
+			}
+		}
+	}
 }
 
 function trimQuotes(input: string, value = `'`) {

cli/src/targets.ts

@@ -0,0 +1,37 @@
+import { assert, beforeAll, describe, expect, test } from 'vitest';
+
+import { Targets } from '../src/targets'
+import path from 'path';
+import { MakeProject } from '../src/builders/make';
+import { getFiles } from '../src/utils';
+import { setupFixture } from './fixtures/projects';
+import { scanGlob } from '../src/extensions';
+import { writeFileSync } from 'fs';
+import { BobProject } from '../src';
+
+const cwd = setupFixture(`bob_long_names`);
+
+let files = getFiles(cwd, scanGlob);
+
+describe.skipIf(files.length === 0)(`long name test`, () => {
+  const targets = new Targets(cwd);
+  targets.setSuggestions({ renames: true, includes: true })
+
+  beforeAll(async () => {
+    targets.loadObjectsFromPaths(files);
+    const parsePromises = files.map(f => targets.parseFile(f));
+    await Promise.all(parsePromises);
+
+    expect(targets.getTargets().length).toBeGreaterThan(0);
+    targets.resolveBinder();
+  });
+
+  test(`Ensure objects are defined`, async () => {
+    expect(targets.getTargets().length).toBe(1);
+    expect(targets.getResolvedObjects(`FILE`).length).toBe(1);
+    expect(targets.binderRequired()).toBe(false);
+
+    const dspf = targets.searchForObject({ systemName: `ART301D`, type: `FILE` });
+    expect(dspf).toBeDefined();
+  });
+});

cli/test/bobLongNames.test.ts

@@ -0,0 +1,71 @@
+     A*%%TS  SD  20161129  155718  VTAQUIN     REL-V7R1M0  5770-WDS
+     A*%%EC
+     A                                      DSPSIZ(24 80 *DS3)
+     A                                      REF(*LIBL/ARTICLE)
+     A                                      INDARA
+     A                                      PRINT
+     A                                      ERRSFL
+     A                                      CA03(03)
+     A                                      CA12(12)
+     A          R SFL01                     SFL
+     A*%%TS  SD  20161129  105751  VTAQUIN     REL-V7R1M0  5770-WDS
+     A  33                                  SFLNXTCHG
+     A            OPT01          1Y 0B  8  3
+     A  34                                  DSPATR(RI)
+     A  34                                  DSPATR(PC)
+     A                                      EDTCDE(Z)
+     A            ARID      R        O  8  5REFFLD(ARID ARTICLE)
+     A            ARDESC    R        O  8 12REFFLD(FARTI/ARDESC *LIBL/ARTICLE)
+     A            ARTIFA    R        O  8 63REFFLD(FARTI/ARTIFA *LIBL/ARTICLE)
+     A            ARSALEPR  R        O  8 67REFFLD(FARTI/ARSALEPR *LIBL/ARTICLE)
+     A          R CTL01                     SFLCTL(SFL01)
+     A*%%TS  SD  20161129  155718  VTAQUIN     REL-V7R1M0  5770-WDS
+     A                                      SFLSIZ(0015)
+     A                                      SFLPAG(0014)
+     A N80                                  PAGEDOWN(25 'dynamic subfile')
+     A                                      CF04(04)
+     A                                      OVERLAY
+     A  31                                  SFLDSP
+     A  32                                  SFLDSPCTL
+     A  30                                  SFLCLR
+     A  80                                  SFLEND(*MORE)
+     A  35                                  SFLMSG('INVALID OPTION' 35)
+     A  36                                  SFLMSG('ONLY ONE SELECTION' 36)
+     A            RRB01          4S 0H      SFLRCDNBR
+     A                                  1 32'Select an Article'
+     A                                      DSPATR(HI)
+     A                                  4  3'Make a selection. Press Enter'
+     A                                      COLOR(BLU)
+     A                                  5  5'1=Select'
+     A                                      COLOR(BLU)
+     A                                  7  2'Opt'
+     A                                      DSPATR(HI)
+     A                                  7  6'Code'
+     A                                      DSPATR(HI)
+     A                                  1  2'ART301'
+     A                                      COLOR(BLU)
+     A                                  2  3'Desc contains  . . . :'
+     A                                  3  3'Family . . . . . . . :'
+     A            SRCHDESC      10A  B  2 27
+     A                                  7 12'Description'
+     A                                      DSPATR(HI)
+     A                                  7 63'Fam'
+     A                                      DSPATR(HI)
+     A                                  7 68'Price'
+     A                                      DSPATR(HI)
+     A            SRCHFAM   R        B  3 27REFFLD(FARTI/ARTIFA *LIBL/ARTICLE)
+     A                                  1 70DATE
+     A                                      EDTCDE(Y)
+     A                                      COLOR(BLU)
+     A                                  2 70TIME
+     A                                      COLOR(BLU)
+     A            FAMDESC       20A  O  3 33
+     A          R KEY01
+     A*%%TS  SD  20161129  155218  VTAQUIN     REL-V7R1M0  5770-WDS
+     A                                      OVERLAY
+     A                                 23  2'F3=Exit'
+     A                                      COLOR(BLU)
+     A                                 23 29'F12=Cancel'
+     A                                      COLOR(BLU)
+     A                                 23 14'F4=Prompt'
+     A                                      COLOR(BLU)

cli/test/fixtures/bob_long_names/ART301D-Function_Select_an_article.DSPF

@@ -0,0 +1,52 @@
+**free
+
+ctl-opt nomain;
+
+dcl-proc getLiveBalance;
+  dcl-pi *n likeDs(liveResultT);
+    type char(1) const;
+    cusno int(10) const;
+  end-pi;
+
+  dcl-ds liveResult likeds(liveResultT);
+
+  dcl-f trans qualified usropn usage(*input);
+  dcl-ds transaction likerec(trans.transfmt);
+
+  liveResult.total = 0;
+  liveResult.count = 0;
+
+  select;
+    when (type = RLA);
+      // This RLA check is a bit of a hack.
+      // In the future, we might want to use
+      // a keyed field or an LF to look for
+      // the card by customer id instead of
+      // manually scanning the file.
+
+      // The larger the file, the longer this will take
+
+      OPEN trans;
+      
+      read trans.transfmt transaction;
+      dow not %eof;
+        if (transaction.TCUS = cusno);
+          liveResult.total += transaction.TAMT;
+          liveResult.count += 1;
+        endif;
+        read trans.transfmt transaction;
+      enddo;
+
+      CLOSE trans;
+      
+    when (type = SQL);
+      EXEC SQL
+        SELECT count(*), coalesce(sum(TAMT), 0)
+        INTO :liveResult.count, :liveResult.total
+        FROM TRANSACTION
+        WHERE TCUS = :cusno;
+  endsl;
+
+  return liveResult;
+
+end-proc;

cli/test/fixtures/sql_long_names/rpgle/db.sqlrpgle

@@ -0,0 +1,9 @@
+-- https://www.ibm.com/docs/en/i/7.3?topic=tables-employee-table-employee
+
+CREATE OR REPLACE TABLE TRANSACTION FOR SYSTEM NAME TRANS
+      (TRID        integer not null GENERATED ALWAYS AS IDENTITY (START WITH 1 INCREMENT BY 1),
+       TDESC       VARCHAR(50)     NOT NULL,
+       TCUS        integer         NOT NULL, -- reference to customers
+       TAMT        numeric(10,2)   NOT NULL default 0,
+       TWHEN       TIMESTAMP       NOT NULL DEFAULT CURRENT_TIMESTAMP,
+       PRIMARY KEY (TRID)) RCDFMT TRANSFMT;

cli/test/fixtures/sql_long_names/sql/trans.table

@@ -0,0 +1,56 @@
+import { assert, beforeAll, describe, expect, test } from 'vitest';
+
+import { Targets } from '../src/targets'
+import path from 'path';
+import { MakeProject } from '../src/builders/make';
+import { getFiles } from '../src/utils';
+import { setupFixture } from './fixtures/projects';
+import { scanGlob } from '../src/extensions';
+
+const cwd = setupFixture(`sql_long_names`);
+
+// This issue was occuring when you had two files with the same name, but different extensions.
+
+let files = getFiles(cwd, scanGlob);
+
+describe.skipIf(files.length === 0)(`sql long name lookup`, () => {
+  const targets = new Targets(cwd);
+  targets.setSuggestions({ renames: true, includes: true })
+
+  beforeAll(async () => {
+    targets.loadObjectsFromPaths(files);
+    const parsePromises = files.map(f => targets.parseFile(f));
+    await Promise.all(parsePromises);
+
+    expect(targets.getTargets().length).toBeGreaterThan(0);
+    targets.resolveBinder();
+  });
+
+  test(`Ensure objects are defined`, async () => {
+    expect(targets.getTargets().length).toBe(2);
+    expect(targets.getResolvedObjects(`FILE`).length).toBe(1);
+    expect(targets.getResolvedObjects(`MODULE`).length).toBe(1);
+    expect(targets.binderRequired()).toBe(false);
+
+    const trans = targets.searchForObject({ systemName: `TRANS`, type: `FILE` });
+    expect(trans).toBeDefined();
+
+    const transaction = targets.searchForObject({ systemName: `TRANSACTION`, type: `FILE` });
+    expect(transaction).toBeDefined();
+
+    expect(trans).toMatchObject(transaction);
+
+    const moduleLogs = targets.logger.getLogsFor(trans.relativePath);
+    expect(moduleLogs).toBeUndefined();
+  });
+
+  test(`Ensure deps are correct`, async () => {
+    const trans = targets.getTarget({ systemName: `DB`, type: `MODULE` });
+    expect(trans).toBeDefined();
+
+    expect(trans.deps.length).toBe(1);
+    expect(trans.deps[0].systemName).toBe(`TRANS`);
+    expect(trans.deps[0].longName).toBe(`TRANSACTION`);
+  });
+
+});