fix: remove stale connection files from directory export when connections are deleted (#1389)

* fix: remove stale connection files from directory export when connections are deleted

* test: remove redundant tests

* style: run prettier on connections test file

* fix: remove stale connection files from directory export when connections are deleted

* fix: preserve excluded connection files and remove stale files on directory dump

Author: harshithRai

src/context/directory/handlers/connections.ts

@@ -78,6 +78,15 @@ async function dump(context: DirectoryContext): Promise<void> {
   const connectionsFolder = path.join(context.filePath, constants.CONNECTIONS_DIRECTORY);
   fs.ensureDirSync(connectionsFolder);
 
+  // Track files that should remain after dump (written + excluded).
+  // Seed from exclude names directly so excluded connections' files are preserved
+  // regardless of whether the connection still exists on the tenant.
+  const expectedFiles = new Set<string>();
+  for (const name of excludedConnections) {
+    expectedFiles.add(`${sanitize(name)}.json`);
+    expectedFiles.add(`${sanitize(name)}.html`);
+  }
+
   // Convert enabled_clients from id to name
   connections.forEach((connection) => {
     let dumpedConnection = {
@@ -118,7 +127,19 @@ async function dump(context: DirectoryContext): Promise<void> {
 
     const connectionFile = path.join(connectionsFolder, `${connectionName}.json`);
     dumpJSON(connectionFile, dumpedConnection);
+    expectedFiles.add(`${connectionName}.json`);
+    if (dumpedConnection.strategy === 'email') expectedFiles.add(`${connectionName}.html`);
   });
+
+  // Remove files that belong to connections no longer present (and not excluded)
+  if (fs.existsSync(connectionsFolder)) {
+    for (const existing of fs.readdirSync(connectionsFolder)) {
+      const fullPath = path.join(connectionsFolder, existing);
+      if (fs.statSync(fullPath).isFile() && !expectedFiles.has(existing)) {
+        fs.removeSync(fullPath);
+      }
+    }
+  }
 }
 
 const connectionsHandler: DirectoryHandler<ParsedConnections> = {

src/context/directory/index.ts

@@ -112,6 +112,19 @@ export default class DirectoryContext {
       this.assets = auth0.assets;
     }
 
+    // Re-attach exclude/include config lost when assets was overwritten above
+    this.assets.exclude = {
+      rules: this.config.AUTH0_EXCLUDED_RULES || [],
+      clients: this.config.AUTH0_EXCLUDED_CLIENTS || [],
+      databases: this.config.AUTH0_EXCLUDED_DATABASES || [],
+      connections: this.config.AUTH0_EXCLUDED_CONNECTIONS || [],
+      resourceServers: this.config.AUTH0_EXCLUDED_RESOURCE_SERVERS || [],
+      defaults: this.config.AUTH0_EXCLUDED_DEFAULTS || [],
+    };
+    this.assets.include = {
+      connections: this.config.AUTH0_INCLUDED_CONNECTIONS || [],
+    };
+
     // Clean known read only fields
     this.assets = cleanAssets(this.assets, this.config);
 

test/context/directory/connections.test.js

@@ -243,4 +243,71 @@ describe('#directory context connections', () => {
     expect(fs.existsSync(path.join(connectionsFolder, 'includedConnection.json'))).to.equal(true);
     expect(fs.existsSync(path.join(connectionsFolder, 'excludedConnection.json'))).to.equal(false);
   });
+
+  it('should preserve pre-existing files for excluded connections on re-dump', async () => {
+    const dir = path.join(testDataDir, 'directory', 'connectionsDumpExclude');
+    cleanThenMkdir(dir);
+
+    // Simulate a prior export that wrote the excluded connection's file
+    const connectionsFolder = path.join(dir, constants.CONNECTIONS_DIRECTORY);
+    fs.ensureDirSync(connectionsFolder);
+    fs.writeFileSync(
+      path.join(connectionsFolder, 'excludedConnection.json'),
+      '{"name":"excludedConnection"}'
+    );
+
+    const context = new Context({ AUTH0_INPUT_FILE: dir }, mockMgmtClient());
+    context.assets.connections = [{ name: 'includedConnection', strategy: 'waad' }];
+    context.assets.exclude = { connections: ['excludedConnection'] };
+
+    await handler.dump(context);
+
+    expect(fs.existsSync(path.join(connectionsFolder, 'includedConnection.json'))).to.equal(true);
+    expect(fs.existsSync(path.join(connectionsFolder, 'excludedConnection.json'))).to.equal(true);
+  });
+
+  it('should remove stale connection files when connections are removed from source', async () => {
+    const dir = path.join(testDataDir, 'directory', 'connectionsStaleFiles');
+    cleanThenMkdir(dir);
+
+    // Simulate a previous export that created connection files
+    const connectionsFolder = path.join(dir, constants.CONNECTIONS_DIRECTORY);
+    fs.ensureDirSync(connectionsFolder);
+    fs.writeFileSync(path.join(connectionsFolder, 'facebook.json'), '{"name":"facebook"}');
+    fs.writeFileSync(path.join(connectionsFolder, 'github.json'), '{"name":"github"}');
+
+    const context = new Context({ AUTH0_INPUT_FILE: dir }, mockMgmtClient());
+    // Re-export with only one connection (facebook removed)
+    context.assets.connections = [{ name: 'github', strategy: 'github' }];
+
+    await handler.dump(context);
+
+    expect(fs.existsSync(path.join(connectionsFolder, 'github.json'))).to.equal(true);
+    expect(fs.existsSync(path.join(connectionsFolder, 'facebook.json'))).to.equal(false);
+  });
+
+  it('should remove all stale connection files when all connections are removed from source', async () => {
+    const dir = path.join(testDataDir, 'directory', 'connectionsAllStale');
+    cleanThenMkdir(dir);
+
+    // Simulate a previous export that created connection files
+    const connectionsFolder = path.join(dir, constants.CONNECTIONS_DIRECTORY);
+    fs.ensureDirSync(connectionsFolder);
+    fs.writeFileSync(path.join(connectionsFolder, 'facebook.json'), '{"name":"facebook"}');
+    fs.writeFileSync(path.join(connectionsFolder, 'github.json'), '{"name":"github"}');
+
+    const context = new Context({ AUTH0_INPUT_FILE: dir }, mockMgmtClient());
+    // Re-export with zero connections
+    context.assets.connections = [];
+
+    await handler.dump(context);
+
+    const remainingJsonFiles = fs.readdirSync(connectionsFolder).filter((f) => f.endsWith('.json'));
+    expect(remainingJsonFiles).to.deep.equal([]);
+
+    // Verify parse of now-empty directory returns [] not null (enabling deletions on import)
+    const parseContext = new Context({ AUTH0_INPUT_FILE: dir }, mockMgmtClient());
+    await parseContext.loadAssetsFromLocal();
+    expect(parseContext.assets.connections).to.deep.equal([]);
+  });
 });