Merge pull request #798 from OpenFn/better-compiler-exports

compiler: don't extract common exports
OpenFn · Oct 22, 2024 · 71edb8b · 71edb8b
2 parents 9186fa8 + 7fc53b4
commit 71edb8b
Show file tree

Hide file tree

Showing 4 changed files with 40 additions and 49 deletions.
diff --git a/.changeset/spicy-parents-guess.md b/.changeset/spicy-parents-guess.md
@@ -0,0 +1,5 @@
+---
+'@openfn/compiler': minor
+---
+
+Be more accurate in calculating exports from an adaptor"
diff --git a/packages/cli/src/compile/compile.ts b/packages/cli/src/compile/compile.ts
@@ -123,11 +123,7 @@ export const loadTransformOptions = async (
       const path = await resolveSpecifierPath(adaptorInput, opts.repoDir, log);
       if (path) {
         try {
-          exports = await preloadAdaptorExports(
-            path,
-            opts.useAdaptorsMonorepo,
-            log
-          );
+          exports = await preloadAdaptorExports(path, log);
         } catch (e) {
           log.error(`Failed to load adaptor typedefs from path ${path}`);
           log.error(e);

diff --git a/packages/compiler/src/util.ts b/packages/compiler/src/util.ts
@@ -1,5 +1,5 @@
 import { readFileSync } from 'node:fs';
-import { readFile, readdir } from 'node:fs/promises';
+import { readFile } from 'node:fs/promises';
 import path from 'node:path';
 import { Project, describeDts } from '@openfn/describe-package';
 import type { Logger } from '@openfn/logger';
@@ -24,7 +24,6 @@ export const isRelativeSpecifier = (specifier: string) =>
 // But we may relax this  later.
 export const preloadAdaptorExports = async (
   pathToModule: string,
-  useMonorepo?: boolean,
   log?: Logger
 ) => {
   const project = new Project();
@@ -37,31 +36,11 @@ export const preloadAdaptorExports = async (
     if (pkg.types) {
       const functionDefs = {} as Record<string, true>;
 
-      // load common definitions into the project
-      if (pkg.name !== '@openfn/language-common') {
-        try {
-          const common = await findExports(
-            path.resolve(
-              pathToModule,
-              useMonorepo ? '../common' : '../language-common'
-            ),
-            'types/index.d.ts',
-            project
-          );
-          if (common) {
-            common.forEach(({ name }) => {
-              functionDefs[name] = true;
-            });
-          }
-        } catch (e) {
-          log?.debug('Failed to load types from language common');
-          log?.debug(e);
-        }
-      }
-
       const adaptor = await findExports(pathToModule, pkg.types, project);
       adaptor.forEach(({ name }) => {
-        functionDefs[name] = true;
+        if (name !== 'default') {
+          functionDefs[name] = true;
+        }
       });
 
       return Object.keys(functionDefs);
@@ -82,20 +61,35 @@ const findExports = async (
   types: string,
   project: Project
 ) => {
-  const typesRoot = path.dirname(types);
-  const files = await readdir(`${moduleRoot}/${typesRoot}`);
-  const dtsFiles = files.filter((f) => f.endsWith('.d.ts'));
-  const result = [];
-  for (const f of dtsFiles) {
-    const relPath = `${typesRoot}/${f}`;
-    const contents = await readFile(`${moduleRoot}/${relPath}`, 'utf8');
-    project.createFile(contents, relPath);
+  const results = [];
+
+  const contents = await readFile(`${moduleRoot}/${types}`, 'utf8');
+  project.createFile(contents, types);
 
-    result.push(
-      ...describeDts(project, relPath, {
-        includePrivate: true,
-      })
-    );
+  results.push(
+    ...describeDts(project, types, {
+      includePrivate: true,
+    })
+  );
+
+  // Ensure that everything in adaptor.d.ts is exported
+  // This is kinda cheating but it's quite safe for the time being
+  const typesRoot = path.dirname(types);
+  for (const dts of ['adaptor', 'Adaptor']) {
+    try {
+      const adaptorPath = `${moduleRoot}/${typesRoot}/${dts}.d.ts`;
+      const contents = await readFile(adaptorPath, 'utf8');
+      project.createFile(contents, adaptorPath);
+      results.push(
+        ...describeDts(project, adaptorPath, {
+          includePrivate: true,
+        })
+      );
+      break;
+    } catch (e) {
+      // no problem if this throws - likely the file doesn't exist
+    }
   }
-  return result;
+
+  return results;
 };
diff --git a/packages/engine-multi/src/api/compile.ts b/packages/engine-multi/src/api/compile.ts
@@ -58,11 +58,7 @@ const compileJob = async (
     for (const adaptor of adaptors) {
       // TODO I probably don't want to log this stuff
       const pathToAdaptor = await getModulePath(adaptor, repoDir, logger);
-      const exports = await preloadAdaptorExports(
-        pathToAdaptor!,
-        false,
-        logger
-      );
+      const exports = await preloadAdaptorExports(pathToAdaptor!, logger);
       adaptorConfig.push({
         name: stripVersionSpecifier(adaptor),
         exports,