codeceptjs 4.0.0-beta.2 → 4.0.0-beta.20

package/lib/helper/ApiDataFactory.js

@@ -1,6 +1,6 @@
-import path from 'path';
-import Helper from '@codeceptjs/helper';
-import REST from './REST';
+import path from 'path'
+import Helper from '@codeceptjs/helper'
+import REST from './REST.js'
 
 /**
  * Helper for managing remote data using REST API.
@@ -50,7 +50,7 @@ import REST from './REST';
  *
  * module.exports = new Factory()
  *    // no need to set id, it will be set by REST API
- *    .attr('author', () => faker.name.findName())
+ *    .attr('author', () => faker.person.findName())
  *    .attr('title', () => faker.lorem.sentence())
  *    .attr('body', () => faker.lorem.paragraph());
  * ```
@@ -183,67 +183,83 @@ import REST from './REST';
  */
 class ApiDataFactory extends Helper {
   constructor(config) {
-    super(config);
+    super(config)
 
     const defaultConfig = {
       cleanup: true,
       REST: {},
       factories: {},
       returnId: false,
-    };
-    this.config = Object.assign(defaultConfig, this.config);
+    }
+    this.config = Object.assign(defaultConfig, this.config)
 
-    if (this.config.headers) this.config.REST.defaultHeaders = this.config.headers;
-    if (this.config.onRequest) this.config.REST.onRequest = this.config.onRequest;
-    this.restHelper = new REST(Object.assign(this.config.REST, { endpoint: this.config.endpoint }));
-    this.factories = this.config.factories;
+    if (this.config.headers) this.config.REST.defaultHeaders = this.config.headers
+    if (this.config.onRequest) this.config.REST.onRequest = this.config.onRequest
+    this.restHelper = new REST(Object.assign(this.config.REST, { endpoint: this.config.endpoint }))
+    this.factories = this.config.factories
 
     for (const factory in this.factories) {
-      const factoryConfig = this.factories[factory];
+      const factoryConfig = this.factories[factory]
       if (!factoryConfig.uri && !factoryConfig.create) {
         throw new Error(`Uri for factory "${factory}" is not defined. Please set "uri" parameter:
 
           "factories": {
             "${factory}": {
             "uri": ...
-        `);
+        `)
       }
 
-      if (!factoryConfig.create) factoryConfig.create = { post: factoryConfig.uri };
-      if (!factoryConfig.delete) factoryConfig.delete = { delete: `${factoryConfig.uri}/{id}` };
+      if (!factoryConfig.create) factoryConfig.create = { post: factoryConfig.uri }
+      if (!factoryConfig.delete) factoryConfig.delete = { delete: `${factoryConfig.uri}/{id}` }
 
-      this.factories[factory] = factoryConfig;
+      this.factories[factory] = factoryConfig
     }
 
-    this.created = {};
-    Object.keys(this.factories).forEach(f => this.created[f] = []);
+    this.created = {}
+    Object.keys(this.factories).forEach(f => (this.created[f] = []))
   }
 
   static _checkRequirements() {
     try {
-      require('axios');
-      require('rosie');
+      // In ESM, dependencies are already imported at the top
+      // The import will fail at module load time if dependencies are missing
+      return null
     } catch (e) {
-      return ['axios', 'rosie'];
+      return ['axios']
     }
   }
 
   _after() {
     if (!this.config.cleanup || this.config.cleanup === false) {
-      return Promise.resolve();
+      return Promise.resolve()
     }
-    const promises = [];
+    const promises = []
 
     // clean up all created items
     for (const factoryName in this.created) {
-      const createdItems = this.created[factoryName];
-      if (!createdItems.length) continue;
-      this.debug(`Deleting ${createdItems.length} ${factoryName}(s)`);
+      const createdItems = this.created[factoryName]
+      if (!createdItems.length) continue
+      this.debug(`Deleting ${createdItems.length} ${factoryName}(s)`)
       for (const id in createdItems) {
-        promises.push(this._requestDelete(factoryName, createdItems[id]));
+        const deletePromise = this._requestDelete(factoryName, createdItems[id])
+        if (deletePromise) {
+          promises.push(deletePromise.catch(err => {
+            this.debugSection('Delete Error', `Failed to delete ${factoryName} with id ${createdItems[id]}: ${err.message}`)
+            // Don't reject Promise.all, just log the error
+            return Promise.resolve()
+          }))
+        }
       }
     }
-    return Promise.all(promises);
+    return Promise.all(promises).then(() => {
+      // Clear the created items after successful cleanup
+      for (const factoryName in this.created) {
+        this.created[factoryName] = []
+      }
+      // Add a small delay to ensure file system changes propagate in Docker environments
+      // This helps avoid race conditions where GET requests after DELETE don't see the changes yet
+      return new Promise(resolve => setTimeout(resolve, 100))
+    })
   }
 
   /**
@@ -264,10 +280,10 @@ class ApiDataFactory extends Helper {
    * @param {*} [options] options for programmatically generate the attributes
    * @returns {Promise<*>}
    */
-  have(factory, params, options) {
-    const item = this._createItem(factory, params, options);
-    this.debug(`Creating ${factory} ${JSON.stringify(item)}`);
-    return this._requestCreate(factory, item);
+  async have(factory, params, options) {
+    const item = await this._createItem(factory, params, options)
+    this.debug(`Creating ${factory} ${JSON.stringify(item)}`)
+    return this._requestCreate(factory, item)
   }
 
   /**
@@ -290,27 +306,30 @@ class ApiDataFactory extends Helper {
    * @param {*} [options]
    */
   haveMultiple(factory, times, params, options) {
-    const promises = [];
+    const promises = []
     for (let i = 0; i < times; i++) {
-      promises.push(this.have(factory, params, options));
+      promises.push(this.have(factory, params, options))
     }
-    return Promise.all(promises);
+    return Promise.all(promises)
   }
 
-  _createItem(model, data, options) {
+  async _createItem(model, data, options) {
     if (!this.factories[model]) {
-      throw new Error(`Factory ${model} is not defined in config`);
+      throw new Error(`Factory ${model} is not defined in config`)
     }
-    let modulePath = this.factories[model].factory;
+    let modulePath = this.factories[model].factory
     try {
       try {
-        require.resolve(modulePath);
+        // Try to resolve the path as-is first
+        await import.meta.resolve(modulePath)
       } catch (e) {
-        modulePath = path.join(global.codecept_dir, modulePath);
+        // If not found, try relative to codecept_dir
+        modulePath = path.join(global.codecept_dir, modulePath)
       }
       // check if the new syntax `export default new Factory()` is used and loads the builder, otherwise loads the module that used old syntax `module.exports = new Factory()`.
-      const builder = require(modulePath).default || require(modulePath);
-      return builder.build(data, options);
+      const module = await import(modulePath)
+      const builder = module.default || module
+      return builder.build(data, options)
     } catch (err) {
       throw new Error(`Couldn't load factory file from ${modulePath}, check that
 
@@ -321,17 +340,17 @@ class ApiDataFactory extends Helper {
 points to valid factory file.
 Factory file should export an object with build method.
 
-Current file error: ${err.message}`);
+Current file error: ${err.message}`)
     }
   }
 
   _fetchId(body, factory) {
     if (this.config.factories[factory].fetchId) {
-      return this.config.factories[factory].fetchId(body);
+      return this.config.factories[factory].fetchId(body)
     }
-    if (body.id) return body.id;
-    if (body[factory] && body[factory].id) return body[factory].id;
-    return null;
+    if (body.id) return body.id
+    if (body[factory] && body[factory].id) return body[factory].id
+    return null
   }
 
   /**
@@ -342,27 +361,27 @@ Current file error: ${err.message}`);
    * @param {*} data
    */
   _requestCreate(factory, data) {
-    let request = createRequestFromFunction(this.factories[factory].create, data);
+    let request = createRequestFromFunction(this.factories[factory].create, data)
 
     if (!request) {
-      const method = Object.keys(this.factories[factory].create)[0];
-      const url = this.factories[factory].create[method];
+      const method = Object.keys(this.factories[factory].create)[0]
+      const url = this.factories[factory].create[method]
       request = {
         method,
         url,
         data,
-      };
+      }
     }
 
-    request.baseURL = this.config.endpoint;
+    request.baseURL = this.config.endpoint
 
-    return this.restHelper._executeRequest(request).then((resp) => {
-      const id = this._fetchId(resp.data, factory);
-      this.created[factory].push(id);
-      this.debugSection('Created', `Id: ${id}`);
-      if (this.config.returnId) return id;
-      return resp.data;
-    });
+    return this.restHelper._executeRequest(request).then(resp => {
+      const id = this._fetchId(resp.data, factory)
+      this.created[factory].push(id)
+      this.debugSection('Created', `Id: ${id}`)
+      if (this.config.returnId) return id
+      return resp.data
+    })
   }
 
   /**
@@ -373,37 +392,50 @@ Current file error: ${err.message}`);
    * @param {*} id
    */
   _requestDelete(factory, id) {
-    if (!this.factories[factory].delete) return;
-    let request = createRequestFromFunction(this.factories[factory].delete, id);
+    if (!this.factories[factory].delete) return
+    let request = createRequestFromFunction(this.factories[factory].delete, id)
 
     if (!request) {
-      const method = Object.keys(this.factories[factory].delete)[0];
+      const method = Object.keys(this.factories[factory].delete)[0]
 
-      const url = this.factories[factory].delete[method].replace('{id}', id);
+      const url = this.factories[factory].delete[method].replace('{id}', id)
 
       request = {
-        method,
+        method: method.toUpperCase(), // Ensure HTTP method is uppercase
         url,
-      };
+      }
     }
 
-    request.baseURL = this.config.endpoint;
+    // Ensure method is uppercase (some servers require uppercase HTTP methods)
+    if (request.method) {
+      request.method = request.method.toUpperCase()
+    }
+
+    request.baseURL = this.config.endpoint
 
     if (request.url.match(/^undefined/)) {
-      return this.debugSection('Please configure the delete request in your ApiDataFactory helper', 'delete: () => ({ method: \'DELETE\',  url: \'/api/users\' })');
+      return this.debugSection('Please configure the delete request in your ApiDataFactory helper', "delete: () => ({ method: 'DELETE',  url: '/api/users' })")
     }
 
-    return this.restHelper._executeRequest(request).then(() => {
-      const idx = this.created[factory].indexOf(id);
-      this.debugSection('Deleted Id', `Id: ${id}`);
-      this.created[factory].splice(idx, 1);
-    });
+    this.debugSection('Deleting', `${request.method} ${request.baseURL}${request.url} (ID: ${id})`)
+
+    return this.restHelper._executeRequest(request).then((resp) => {
+      const idx = this.created[factory].indexOf(id)
+      this.debugSection('Deleted Successfully', `${factory} ID: ${id}, Status: ${resp.status || 'OK'}`)
+      if (idx !== -1) {
+        this.created[factory].splice(idx, 1)
+      }
+      return resp
+    }).catch(err => {
+      this.debugSection('Delete Failed', `${factory} ID: ${id}, Error: ${err.message}`)
+      throw err
+    })
   }
 }
 
-export default ApiDataFactory;
+export { ApiDataFactory as default }
 
 function createRequestFromFunction(param, data) {
-  if (typeof param !== 'function') return;
-  return param(data);
+  if (typeof param !== 'function') return
+  return param(data)
 }