Generate binder source from module or service program #2485

janfh · 2025-01-25T20:08:43Z

Fixes #2484

Changes

New command and object browser option to generate binder source from module or service program
New functions in IBMiContent for retrieving module exports using DSPMOD *OUTFILE and service program exports using the PROGRAM_EXPORT_IMPORT_INFO view
Generates binder source in a new editor

How to test this PR

Examples:

Locate a module and a service program in object browser
Right click and select "Generate binder source"
Verify binder source generated in editor

Checklist

have tested my change
have created one or more test cases
updated relevant documentation

… browser

worksofliam · 2025-01-25T20:38:13Z

Honestly I love the idea!

There is some overlap with the FS extension (look up vscode-ibmi-fs on our org), but since it hasn't been released yet and isn't anywhere near being released, I believe it could live here until then.

Thoughts @sebjulliand?

worksofliam · 2025-01-27T14:55:20Z

@janfh What are the chances you can write new test cases for the new APIs you added? Perhaps against objects in QSYS2?

janfh · 2025-01-27T16:13:11Z

@janfh What are the chances you can write new test cases for the new APIs you added? Perhaps against objects in QSYS2?

Sure :) But I'm not sure if there is any *MODULE to to test "getModuleExport". Do you know of any?

worksofliam · 2025-01-27T16:26:36Z

@janfh You're right, I don't know of many modules to test with in either QSYS, QSYS2, or SYSTOOLS. If you have to skip one API, that's ok. But if you're feeling adventurous, perhaps your test could create a module with a simple export.

janfh · 2025-01-27T19:29:28Z

@worksofliam : I have added a test for each of the two new methods in IBMiContent

src/ui/views/objectBrowser.ts

worksofliam

Overall a nice change, but sadly I have a test case not passing and also am making a recommendation to the parameter type on your new method.

src/ui/views/objectBrowser.ts

src/api/tests/suites/content.test.ts

worksofliam

Sorry - meant to press request changes.

janfh · 2025-01-28T16:15:09Z

Sorry - meant to press request changes.

Thanks for the feedback :)

sebjulliand

Nice feature, thanks @janfh !
I just have a few style/simplification suggestions related to the code. Thanks!

sebjulliand · 2025-02-02T10:38:03Z

src/api/tests/suites/content.test.ts

+    const config = connection.getConfig();
+    const tempLib = config!.tempLibrary;
+    const id: string = `${Tools.makeid().toUpperCase()}`;
+    const source: string = `/tmp/vscodetemp-${id}.clle`;


I'd suggest to use connection.withTempDirectory here to handle the creation/cleanup of temporary IFS files (see above). You don't have to bother with DEL afterwards.

sebjulliand · 2025-02-02T10:39:15Z

src/api/tests/suites/content.test.ts

+    await connection!.runCommand({
+      command: `DLTMOD MODULE(${tempLib}/${id})`,
+      environment: 'ile'
+    });


This should be put in a try/finally{} block, to make sure objects are cleaned up unconditionally.

sebjulliand · 2025-02-02T10:39:26Z

src/api/tests/suites/content.test.ts

+    await connection!.runCommand({
+      command: `DLTSRVPGM SRVPGM(${tempLib}/${id})`,
+      environment: 'ile'
+    });
+    await connection!.runCommand({
+      command: `DLTMOD MODULE(${tempLib}/${id})`,
+      environment: 'ile'
+    });


This should be put in a try/finally{} block, to make sure objects are cleaned up unconditionally.

sebjulliand · 2025-02-02T10:40:04Z

src/api/tests/suites/content.test.ts

+    const config = connection.getConfig();
+    const tempLib = config!.tempLibrary;
+    const id: string = `${Tools.makeid().toUpperCase()}`;
+    const source: string = `/tmp/vscodetemp-${id}.clle`;


Same as above, try using connection.withTempDirectory for this.

sebjulliand · 2025-02-02T10:41:48Z

package.json

+				},
+				{
+					"command": "code-for-ibmi.generateBinderSource",
+					"when": "view == objectBrowser && viewItem =~ /^object.(module|srvpgm).*/",


You may want to escape the dot here, since you'll be looking at an actual dot (and not any character).

Suggested change

"when": "view == objectBrowser && viewItem =~ /^object.(module|srvpgm).*/",

"when": "view == objectBrowser && viewItem =~ /^object\.(module|srvpgm).*/",

sebjulliand · 2025-02-02T10:57:33Z

src/api/IBMiContent.ts

+    if (results.length) {
+      return results.map(result => ({
+        program_library: result.PROGRAM_LIBRARY,
+        program_name: result.PROGRAM_NAME,
+        object_type: result.OBJECT_TYPE,
+        symbol_name: result.SYMBOL_NAME,
+        symbol_usage: result.SYMBOL_USAGE,
+        argument_optimization: result.ARGUMENT_OPTIMIZATION,
+        data_item_size: result.DATA_ITEM_SIZE
+      } as ProgramExportImportInfo));
+    } else {
+      return [];
+    }


No need to check the array's length. Directly return the map operation. Map on an empty array is an empty array, so you'll be good anyway.

Suggested change

if (results.length) {

return results.map(result => ({

program_library: result.PROGRAM_LIBRARY,

program_name: result.PROGRAM_NAME,

object_type: result.OBJECT_TYPE,

symbol_name: result.SYMBOL_NAME,

symbol_usage: result.SYMBOL_USAGE,

argument_optimization: result.ARGUMENT_OPTIMIZATION,

data_item_size: result.DATA_ITEM_SIZE

} as ProgramExportImportInfo));

} else {

return [];

}

return results.map(result => ({

program_library: result.PROGRAM_LIBRARY,

program_name: result.PROGRAM_NAME,

object_type: result.OBJECT_TYPE,

symbol_name: result.SYMBOL_NAME,

symbol_usage: result.SYMBOL_USAGE,

argument_optimization: result.ARGUMENT_OPTIMIZATION,

data_item_size: result.DATA_ITEM_SIZE

} as ProgramExportImportInfo));

sebjulliand · 2025-02-02T10:59:21Z

src/api/IBMiContent.ts

+    if (results.length) {
+      return results.map(result => ({
+        module_library: result.MODULE_LIBRARY,
+        module_name: result.MODULE_NAME,
+        module_attr: result.MODULE_ATTR,
+        symbol_name: result.SYMBOL_NAME,
+        symbol_type: result.SYMBOL_TYPE,
+        argument_optimization: result.ARGUMENT_OPTIMIZATION
+      } as ModuleExport));
+    }
+    return [];


Same as above, return the map directly. Runnin map on an empty array won't hurt.

sebjulliand · 2025-02-02T11:01:06Z

src/api/types.ts

+export interface ProgramExportImportInfo {
+  program_library: string, 
+  program_name: string, 
+  object_type: string, 
+  symbol_name: string, 
+  symbol_usage: string,
+  argument_optimization: string,
+  data_item_size: number
+}
+
+export interface ModuleExport {
+  module_library: string, 
+  module_name: string, 
+  module_attr: string, 
+  symbol_name: string, 
+  symbol_type: string,
+  argument_optimization: string,
+}


Prefer camel case for variable names, to keep it consistent with the others.

Suggested change

export interface ProgramExportImportInfo {

program_library: string,

program_name: string,

object_type: string,

symbol_name: string,

symbol_usage: string,

argument_optimization: string,

data_item_size: number

}

export interface ModuleExport {

module_library: string,

module_name: string,

module_attr: string,

symbol_name: string,

symbol_type: string,

argument_optimization: string,

}

export interface ProgramExportImportInfo {

programLibrary: string

programName: string

objectType: string

symbolName: string

symbolUsage: string

argumentOptimization: string

dataItemSize: number

}

export interface ModuleExport {

moduleLibrary: string

moduleName: string

moduleAttr: string

symbolName: string

symbolType: string

argumentOptimization: string

}

sebjulliand · 2025-02-02T11:15:57Z

Honestly I love the idea!

There is some overlap with the FS extension (look up vscode-ibmi-fs on our org), but since it hasn't been released yet and isn't anywhere near being released, I believe it could live here until then.

Thoughts @sebjulliand?

We'll definitely have to keep in mind to move it to FS in due time, since it's really an action targeted at objects 😄

janfh added 2 commits January 24, 2025 23:43

feat: generate binder source for program or service program in object…

1f270d5

… browser

feat: generate binder source from module in object browser

a246fdb

janfh changed the title ~~Feature/binder source~~ Generate binder source from module or service program Jan 25, 2025

janfh added 2 commits January 25, 2025 22:06

fix: hide "generate binder source" from command palette

ec48ab9

fix: cleanup code

dbd4bd5

worksofliam requested review from worksofliam and sebjulliand January 27, 2025 14:25

janfh added 2 commits January 27, 2025 19:55

test: added test for IBMiContent.getModuleExport

25dda90

test: added test for IBMiContent.getProgramExportImportInfo

bc749b3

worksofliam reviewed Jan 28, 2025

View reviewed changes

src/ui/views/objectBrowser.ts Outdated Show resolved Hide resolved

worksofliam approved these changes Jan 28, 2025

View reviewed changes

src/ui/views/objectBrowser.ts Show resolved Hide resolved

src/api/tests/suites/content.test.ts Outdated Show resolved Hide resolved

src/api/tests/suites/content.test.ts Outdated Show resolved Hide resolved

worksofliam requested changes Jan 28, 2025

View reviewed changes

janfh added 2 commits January 28, 2025 17:41

fix: library, name and type instead of IBMiObject

4090f47

fix: create module/srvpgm in getProgramExportImportInfo test

63d4827

janfh requested a review from worksofliam January 28, 2025 16:59

Merge branch 'codefori:master' into feature/binder_source

567ef22

sebjulliand requested changes Feb 2, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Generate binder source from module or service program #2485

Generate binder source from module or service program #2485

janfh commented Jan 25, 2025 •

edited

Loading

worksofliam commented Jan 25, 2025

worksofliam commented Jan 27, 2025

janfh commented Jan 27, 2025

worksofliam commented Jan 27, 2025

janfh commented Jan 27, 2025

worksofliam left a comment

worksofliam left a comment

janfh commented Jan 28, 2025

sebjulliand left a comment

sebjulliand Feb 2, 2025

sebjulliand Feb 2, 2025

sebjulliand Feb 2, 2025

sebjulliand Feb 2, 2025

sebjulliand Feb 2, 2025

sebjulliand Feb 2, 2025

sebjulliand Feb 2, 2025

sebjulliand Feb 2, 2025

sebjulliand commented Feb 2, 2025

	"when": "view == objectBrowser && viewItem =~ /^object.(module\|srvpgm).*/",
	"when": "view == objectBrowser && viewItem =~ /^object\.(module\|srvpgm).*/",

Generate binder source from module or service program #2485

Are you sure you want to change the base?

Generate binder source from module or service program #2485

Conversation

janfh commented Jan 25, 2025 • edited Loading

Changes

How to test this PR

Checklist

worksofliam commented Jan 25, 2025

worksofliam commented Jan 27, 2025

janfh commented Jan 27, 2025

worksofliam commented Jan 27, 2025

janfh commented Jan 27, 2025

worksofliam left a comment

Choose a reason for hiding this comment

worksofliam left a comment

Choose a reason for hiding this comment

janfh commented Jan 28, 2025

sebjulliand left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

sebjulliand commented Feb 2, 2025

janfh commented Jan 25, 2025 •

edited

Loading